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