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