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