src/rrd_graph.h

   1 #ifndef _RRD_GRAPH_H
   2 #define _RRD_GRAPH_H
   3
   4 #define y0 cairo_y0
   5 #define y1 cairo_y1
   6 #define index cairo_index
   7
   8 #include <cairo.h>
   9 #include <cairo-pdf.h>
  10 #include <cairo-svg.h>
  11 #include <cairo-ps.h>
  12 #include <pango/pangocairo.h>
  13
  14 #include "rrd_tool.h"
  15 #include "rrd_rpncalc.h"
  16
  17 #define MAX_VNAME_LEN 255
  18 #define DEF_NAM_FMT "%255[-_A-Za-z0-9]"
  19
  20 #define ALTYGRID         0x01   /* use alternative y grid algorithm */
  21 #define ALTAUTOSCALE     0x02   /* use alternative algorithm to find lower and upper bounds */
  22 #define ALTAUTOSCALE_MIN 0x04   /* use alternative algorithm to find lower bounds */
  23 #define ALTAUTOSCALE_MAX 0x08   /* use alternative algorithm to find upper bounds */
  24 #define NOLEGEND         0x10   /* use no legend */
  25 #define NOMINOR          0x20   /* Turn off minor gridlines */
  26 #define ONLY_GRAPH       0x40   /* use only graph */
  27 #define FORCE_RULES_LEGEND 0x80 /* force printing of HRULE and VRULE legend */
  28
  29 #define FORCE_UNITS 0x100   /* mask for all FORCE_UNITS_* flags */
  30 #define FORCE_UNITS_SI 0x100    /* force use of SI units in Y axis (no effect in linear graph, SI instead of E in log graph) */
  31
  32 #define FULL_SIZE_MODE     0x200    /* -width and -height indicate the total size of the image */
  33
  34 enum tmt_en { TMT_SECOND = 0, TMT_MINUTE, TMT_HOUR, TMT_DAY,
  35     TMT_WEEK, TMT_MONTH, TMT_YEAR
  36 };
  37
  38 enum grc_en { GRC_CANVAS = 0, GRC_BACK, GRC_SHADEA, GRC_SHADEB,
  39     GRC_GRID, GRC_MGRID, GRC_FONT, GRC_ARROW, GRC_AXIS, GRC_FRAME, __GRC_END__
  40 };
  41
  42 #define MGRIDWIDTH 0.6
  43 #define GRIDWIDTH  0.4
  44
  45 enum gf_en { GF_PRINT = 0, GF_GPRINT, GF_COMMENT, GF_HRULE, GF_VRULE, GF_LINE,
  46     GF_AREA, GF_STACK, GF_TICK, GF_TEXTALIGN,
  47     GF_DEF, GF_CDEF, GF_VDEF, GF_SHIFT,
  48     GF_XPORT
  49 };
  50
  51 enum txa_en { TXA_LEFT = 0, TXA_RIGHT, TXA_CENTER, TXA_JUSTIFIED };
  52
  53 enum vdef_op_en {
  54     VDEF_MAXIMUM = 0    /* like the MAX in (G)PRINT */
  55         , VDEF_MINIMUM  /* like the MIN in (G)PRINT */
  56         , VDEF_AVERAGE  /* like the AVERAGE in (G)PRINT */
  57         , VDEF_PERCENT  /* Nth percentile */
  58         , VDEF_TOTAL    /* average multiplied by time */
  59         , VDEF_FIRST    /* first non-unknown value and time */
  60         , VDEF_LAST     /* last  non-unknown value and time */
  61         , VDEF_LSLSLOPE /* least squares line slope */
  62         , VDEF_LSLINT   /* least squares line y_intercept */
  63         , VDEF_LSLCORREL    /* least squares line correlation coefficient */
  64 };
  65 enum text_prop_en { TEXT_PROP_DEFAULT = 0,  /* default settings */
  66     TEXT_PROP_TITLE,    /* properties for the title */
  67     TEXT_PROP_AXIS,     /* for the numbers next to the axis */
  68     TEXT_PROP_UNIT,     /* for the vertical unit description */
  69     TEXT_PROP_LEGEND,   /* fot the legend below the graph */
  70     TEXT_PROP_LAST
  71 };
  72
  73
  74 enum gfx_if_en { IF_PNG = 0, IF_SVG, IF_EPS, IF_PDF };
  75 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
  76 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
  77 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
  78
  79 /* cairo color components */
  80 typedef struct gfx_color_t {
  81     double    red;
  82     double    green;
  83     double    blue;
  84     double    alpha;
  85 } gfx_color_t;
  86
  87
  88 typedef struct text_prop_t {
  89     double    size;
  90     char      font[1024];
  91 } text_prop_t;
  92
  93
  94 typedef struct vdef_t {
  95     enum vdef_op_en op;
  96     double    param;    /* parameter for function, if applicable */
  97     double    val;      /* resulting value */
  98     time_t    when;     /* timestamp, if applicable */
  99 } vdef_t;
 100
 101 typedef struct xlab_t {
 102     long      minsec;   /* minimum sec per pix */
 103     long      length;   /* number of secs on the image */
 104     enum tmt_en gridtm; /* grid interval in what ? */
 105     long      gridst;   /* how many whats per grid */
 106     enum tmt_en mgridtm;    /* label interval in what ? */
 107     long      mgridst;  /* how many whats per label */
 108     enum tmt_en labtm;  /* label interval in what ? */
 109     long      labst;    /* how many whats per label */
 110     long      precis;   /* label precision -> label placement */
 111     char     *stst;     /* strftime string */
 112 } xlab_t;
 113
 114 typedef struct ygrid_scale_t {  /* y axis grid scaling info */
 115     double    gridstep;
 116     int       labfact;
 117     char      labfmt[64];
 118 } ygrid_scale_t;
 119
 120 /* sensible y label intervals ...*/
 121
 122 typedef struct ylab_t {
 123     double    grid;     /* grid spacing */
 124     int       lfac[4];  /* associated label spacing */
 125 } ylab_t;
 126
 127 /* this structure describes the elements which can make up a graph.
 128    because they are quite diverse, not all elements will use all the
 129    possible parts of the structure. */
 130 #ifdef HAVE_SNPRINTF
 131 #define FMT_LEG_LEN 200
 132 #else
 133 #define FMT_LEG_LEN 2000
 134 #endif
 135
 136 typedef struct graph_desc_t {
 137     enum gf_en gf;      /* graphing function */
 138     int       stack;    /* boolean */
 139     int       debug;    /* boolean */
 140     char      vname[MAX_VNAME_LEN + 1]; /* name of the variable */
 141     long      vidx;     /* gdes reference */
 142     char      rrd[1024];    /* name of the rrd_file containing data */
 143     char      ds_nam[DS_NAM_SIZE];  /* data source name */
 144     long      ds;       /* data source number */
 145     enum cf_en cf;      /* consolidation function */
 146     enum cf_en cf_reduce;   /* consolidation function for reduce_data() */
 147     struct gfx_color_t col; /* graph color */
 148     char      format[FMT_LEG_LEN + 5];  /* format for PRINT AND GPRINT */
 149     char      legend[FMT_LEG_LEN + 5];  /* legend */
 150     int       strftm;   /* should the VDEF legend be formated with strftime */
 151     double    leg_x, leg_y; /* location of legend */
 152     double    yrule;    /* value for y rule line and for VDEF */
 153     time_t    xrule;    /* time for x rule line and for VDEF */
 154     vdef_t    vf;       /* instruction for VDEF function */
 155     rpnp_t   *rpnp;     /* instructions for CDEF function */
 156
 157     /* SHIFT implementation */
 158     int       shidx;    /* gdes reference for offset (-1 --> constant) */
 159     time_t    shval;    /* offset if shidx is -1 */
 160     time_t    shift;    /* current shift applied */
 161
 162     /* description of data fetched for the graph element */
 163     time_t    start, end;   /* timestaps for first and last data element */
 164     time_t    start_orig, end_orig; /* timestaps for first and last data element */
 165     unsigned long step; /* time between samples */
 166     unsigned long step_orig;    /* time between samples */
 167     unsigned long ds_cnt;   /* how many data sources are there in the fetch */
 168     long      data_first;   /* first pointer to this data */
 169     char    **ds_namv;  /* name of datasources  in the fetch. */
 170     rrd_value_t *data;  /* the raw data drawn from the rrd */
 171     rrd_value_t *p_data;    /* processed data, xsize elments */
 172     double    linewidth;    /* linewideth */
 173     enum txa_en txtalign;   /* change default alignment strategy for text */
 174 } graph_desc_t;
 175
 176 typedef struct image_desc_t {
 177
 178     /* configuration of graph */
 179
 180     char      graphfile[MAXPATH];   /* filename for graphic */
 181     FILE     *graphhandle;  /* FILE to use if filename is "-" */
 182     long      xsize, ysize; /* graph area size in pixels */
 183     struct gfx_color_t graph_col[__GRC_END__];  /* real colors for the graph */
 184     text_prop_t text_prop[TEXT_PROP_LAST];  /* text properties */
 185     char      ylegend[210]; /* legend along the yaxis */
 186     char      title[210];   /* title for graph */
 187     char      watermark[110];   /* watermark for graph */
 188     int       draw_x_grid;  /* no x-grid at all */
 189     int       draw_y_grid;  /* no x-grid at all */
 190     double    grid_dash_on, grid_dash_off;
 191     xlab_t    xlab_user;    /* user defined labeling for xaxis */
 192     char      xlab_form[210];   /* format for the label on the xaxis */
 193
 194     double    ygridstep;    /* user defined step for y grid */
 195     int       ylabfact; /* every how many y grid shall a label be written ? */
 196     double    tabwidth; /* tabwdith */
 197     time_t    start, end;   /* what time does the graph cover */
 198     unsigned long step; /* any preference for the default step ? */
 199     rrd_value_t minval, maxval; /* extreme values in the data */
 200     int       rigid;    /* do not expand range even with
 201                            values outside */
 202     ygrid_scale_t ygrid_scale;  /* calculated y axis grid info */
 203     int       gridfit;  /* adjust y-axis range etc so all
 204                            grindlines falls in integer pixel values */
 205     char     *imginfo;  /* construct an <IMG ... tag and return
 206                            as first retval */
 207     enum gfx_if_en imgformat;   /* image format */
 208     int       lazy;     /* only update the image if there is
 209                            reasonable probablility that the
 210                            existing one is out of date */
 211     int       slopemode;    /* connect the dots of the curve directly, not using a stair */
 212     int       logarithmic;  /* scale the yaxis logarithmic */
 213
 214     /* status information */
 215
 216     long      xorigin, yorigin; /* where is (0,0) of the graph */
 217     long      ximg, yimg;   /* total size of the image */
 218     double    zoom;
 219     double    magfact;  /* numerical magnitude */
 220     long      base;     /* 1000 or 1024 depending on what we graph */
 221     char      symbol;   /* magnitude symbol for y-axis */
 222     float     viewfactor;   /* how should the numbers on the y-axis be scaled for viewing ? */
 223     int       unitsexponent;    /* 10*exponent for units on y-asis */
 224     int       unitslength;  /* width of the yaxis labels */
 225     int       forceleftspace;   /* do not kill the space to the left of the y-axis if there is no grid */
 226
 227     int       extra_flags;  /* flags for boolean options */
 228     /* data elements */
 229
 230     long      prt_c;    /* number of print elements */
 231     long      gdes_c;   /* number of graphics elements */
 232     graph_desc_t *gdes; /* points to an array of graph elements */
 233     cairo_surface_t *surface;   /* graphics library */
 234     cairo_t  *cr;       /* drawin context */
 235     cairo_font_options_t *font_options; /* cairo font options */
 236     cairo_antialias_t graph_antialias;  /* antialiasing for the graph */
 237 } image_desc_t;
 238
 239 /* Prototypes */
 240 int       xtr(
 241     image_desc_t *,
 242     time_t);
 243 double    ytr(
 244     image_desc_t *,
 245     double);
 246 enum gf_en gf_conv(
 247     char *);
 248 enum gfx_if_en if_conv(
 249     char *);
 250 enum tmt_en tmt_conv(
 251     char *);
 252 enum grc_en grc_conv(
 253     char *);
 254 enum text_prop_en text_prop_conv(
 255     char *);
 256 int       im_free(
 257     image_desc_t *);
 258 void      auto_scale(
 259     image_desc_t *,
 260     double *,
 261     char **,
 262     double *);
 263 void      si_unit(
 264     image_desc_t *);
 265 void      expand_range(
 266     image_desc_t *);
 267 void      apply_gridfit(
 268     image_desc_t *);
 269 void      reduce_data(
 270     enum cf_en,
 271     unsigned long,
 272     time_t *,
 273     time_t *,
 274     unsigned long *,
 275     unsigned long *,
 276     rrd_value_t **);
 277 int       data_fetch(
 278     image_desc_t *);
 279 long      find_var(
 280     image_desc_t *,
 281     char *);
 282 long      find_var_wrapper(
 283     void *arg1,
 284     char *key);
 285 long      lcd(
 286     long *);
 287 int       data_calc(
 288     image_desc_t *);
 289 int       data_proc(
 290     image_desc_t *);
 291 time_t    find_first_time(
 292     time_t,
 293     enum tmt_en,
 294     long);
 295 time_t    find_next_time(
 296     time_t,
 297     enum tmt_en,
 298     long);
 299 int       print_calc(
 300     image_desc_t *,
 301     char ***);
 302 int       leg_place(
 303     image_desc_t *,
 304     int *);
 305 int       calc_horizontal_grid(
 306     image_desc_t *);
 307 int       draw_horizontal_grid(
 308     image_desc_t *);
 309 int       horizontal_log_grid(
 310     image_desc_t *);
 311 void      vertical_grid(
 312     image_desc_t *);
 313 void      axis_paint(
 314     image_desc_t *);
 315 void      grid_paint(
 316     image_desc_t *);
 317 int       lazy_check(
 318     image_desc_t *);
 319 int       graph_paint(
 320     image_desc_t *,
 321     char ***);
 322
 323 int       gdes_alloc(
 324     image_desc_t *);
 325 int       scan_for_col(
 326     const char *const,
 327     int,
 328     char *const);
 329 int       rrd_graph(
 330     int,
 331     char **,
 332     char ***,
 333     int *,
 334     int *,
 335     FILE *,
 336     double *,
 337     double *);
 338 void      rrd_graph_init(
 339     image_desc_t *);
 340 void      rrd_graph_options(
 341     int,
 342     char **,
 343     image_desc_t *);
 344 void      rrd_graph_script(
 345     int,
 346     char **,
 347     image_desc_t *,
 348     int);
 349 int       rrd_graph_color(
 350     image_desc_t *,
 351     char *,
 352     char *,
 353     int);
 354 int       bad_format(
 355     char *);
 356 int       vdef_parse(
 357     struct graph_desc_t *,
 358     const char *const);
 359 int       vdef_calc(
 360     image_desc_t *,
 361     int);
 362 int       vdef_percent_compar(
 363     const void *,
 364     const void *);
 365 int       graph_size_location(
 366     image_desc_t *,
 367     int
 368     );
 369
 370
 371 /* create a new line */
 372 void      gfx_line(
 373     image_desc_t *im,
 374     double X0,
 375     double Y0,
 376     double X1,
 377     double Y1,
 378     double width,
 379     gfx_color_t color);
 380
 381 void      gfx_dashed_line(
 382     image_desc_t *im,
 383     double X0,
 384     double Y0,
 385     double X1,
 386     double Y1,
 387     double width,
 388     gfx_color_t color,
 389     double dash_on,
 390     double dash_off);
 391
 392 /* create a new area */
 393 void      gfx_new_area(
 394     image_desc_t *im,
 395     double X0,
 396     double Y0,
 397     double X1,
 398     double Y1,
 399     double X2,
 400     double Y2,
 401     gfx_color_t color);
 402
 403 /* add a point to a line or to an area */
 404 void      gfx_add_point(
 405     image_desc_t *im,
 406     double x,
 407     double y);
 408
 409 /* close current path so it ends at the same point as it started */
 410 void      gfx_close_path(
 411     image_desc_t *im);
 412
 413
 414 /* create a text node */
 415 void      gfx_text(
 416     image_desc_t *im,
 417     double x,
 418     double y,
 419     gfx_color_t color,
 420     char *font,
 421     double size,
 422     double tabwidth,
 423     double angle,
 424     enum gfx_h_align_en h_align,
 425     enum gfx_v_align_en v_align,
 426     const char *text);
 427
 428 /* measure width of a text string */
 429 double    gfx_get_text_width(
 430     image_desc_t *im,
 431     double start,
 432     char *font,
 433     double size,
 434     double tabwidth,
 435     char *text);
 436
 437
 438 /* convert color */
 439 gfx_color_t gfx_hex_to_col(
 440     long unsigned int);
 441
 442 void      gfx_line_fit(
 443     image_desc_t *im,
 444     double *x,
 445     double *y);
 446
 447 void      gfx_area_fit(
 448     image_desc_t *im,
 449     double *x,
 450     double *y);
 451
 452 #endif