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