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_GRAD, 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                  IF_XML=128, IF_CSV=129, IF_TSV=130, IF_SSV=131, IF_JSON=132,
  97                  IF_XMLENUM=133, IF_JSONTIME=134
  98 };
  99 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
 100 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
 101 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
 102
 103 enum gfx_type_en {GTYPE_TIME=0,GTYPE_XY=1};
 104
 105 /* cairo color components */
 106 typedef struct gfx_color_t {
 107     double    red;
 108     double    green;
 109     double    blue;
 110     double    alpha;
 111 } gfx_color_t;
 112
 113
 114 typedef struct text_prop_t {
 115     double    size;
 116     char      font[1024];
 117     PangoFontDescription *font_desc;
 118 } text_prop_t;
 119
 120
 121 typedef struct vdef_t {
 122     enum vdef_op_en op;
 123     double    param;    /* parameter for function, if applicable */
 124     double    val;      /* resulting value */
 125     time_t    when;     /* timestamp, if applicable */
 126     int       never;    /* boolean, indicate that when value mean never */
 127 } vdef_t;
 128
 129 typedef struct xlab_t {
 130     long      minsec;   /* minimum sec per pix */
 131     long      length;   /* number of secs on the image */
 132     enum tmt_en gridtm; /* grid interval in what ? */
 133     long      gridst;   /* how many whats per grid */
 134     enum tmt_en mgridtm;    /* label interval in what ? */
 135     long      mgridst;  /* how many whats per label */
 136     enum tmt_en labtm;  /* label interval in what ? */
 137     long      labst;    /* how many whats per label */
 138     long      precis;   /* label precision -> label placement */
 139     char     *stst;     /* strftime string */
 140 } xlab_t;
 141
 142 typedef struct ygrid_scale_t {  /* y axis grid scaling info */
 143     double    gridstep;
 144     int       labfact;
 145     char      labfmt[64];
 146 } ygrid_scale_t;
 147
 148 /* sensible y label intervals ...*/
 149
 150 typedef struct ylab_t {
 151     double    grid;     /* grid spacing */
 152     int       lfac[4];  /* associated label spacing */
 153 } ylab_t;
 154
 155 /* this structure describes the elements which can make up a graph.
 156    because they are quite diverse, not all elements will use all the
 157    possible parts of the structure. */
 158 #ifdef HAVE_SNPRINTF
 159 #define FMT_LEG_LEN 200
 160 #else
 161 #define FMT_LEG_LEN 2000
 162 #endif
 163
 164 typedef struct graph_desc_t {
 165     enum gf_en gf;      /* graphing function */
 166     int       stack;    /* boolean */
 167     int       debug;    /* boolean */
 168     char      vname[MAX_VNAME_LEN + 1]; /* name of the variable */
 169     long      vidx;     /* gdes reference */
 170     char      rrd[1024];    /* name of the rrd_file containing data */
 171     char      ds_nam[DS_NAM_SIZE];  /* data source name */
 172     long      ds;       /* data source number */
 173     char      daemon[256];
 174     enum cf_en cf;      /* consolidation function */
 175     enum cf_en cf_reduce;   /* consolidation function for reduce_data() */
 176     struct gfx_color_t col, col2; /* graph color */
 177         double    gradheight;
 178     char      format[FMT_LEG_LEN + 5];  /* format for PRINT AND GPRINT */
 179     char      legend[FMT_LEG_LEN + 5];  /* legend */
 180     int       strftm;   /* should the VDEF legend be formated with strftime */
 181     double    leg_x, leg_y; /* location of legend */
 182     double    yrule;    /* value for y rule line and for VDEF */
 183     time_t    xrule;    /* time for x rule line and for VDEF */
 184     vdef_t    vf;       /* instruction for VDEF function */
 185     rpnp_t   *rpnp;     /* instructions for CDEF function */
 186
 187     /* SHIFT implementation */
 188     int       shidx;    /* gdes reference for offset (-1 --> constant) */
 189     time_t    shval;    /* offset if shidx is -1 */
 190     time_t    shift;    /* current shift applied */
 191
 192     /* description of data fetched for the graph element */
 193     time_t    start, end;   /* timestaps for first and last data element */
 194     time_t    start_orig, end_orig; /* timestaps for first and last data element */
 195     unsigned long step; /* time between samples */
 196     unsigned long step_orig;    /* time between samples */
 197     unsigned long ds_cnt;   /* how many data sources are there in the fetch */
 198     long      data_first;   /* first pointer to this data */
 199     char    **ds_namv;  /* name of datasources  in the fetch. */
 200     rrd_value_t *data;  /* the raw data drawn from the rrd */
 201     rrd_value_t *p_data;    /* processed data, xsize elments */
 202     double    linewidth;    /* linewideth */
 203
 204     /* dashed line stuff */
 205     int       dash;     /* boolean, draw dashed line? */
 206     double   *p_dashes; /* pointer do dash array which keeps the lengths of dashes */
 207     int       ndash;    /* number of dash segments */
 208     double    offset;   /* dash offset along the line */
 209
 210     enum txa_en txtalign;   /* change default alignment strategy for text */
 211 } graph_desc_t;
 212
 213 typedef struct image_desc_t {
 214
 215     /* configuration of graph */
 216     char      graphfile[MAXPATH];   /* filename for graphic */
 217     enum      gfx_type_en graph_type; /* type of the graph */
 218     long      xsize, ysize; /* graph area size in pixels */
 219     struct gfx_color_t graph_col[__GRC_END__];  /* real colors for the graph */
 220     text_prop_t text_prop[TEXT_PROP_LAST];  /* text properties */
 221     char      ylegend[210]; /* legend along the yaxis */
 222     char      title[210];   /* title for graph */
 223     char      watermark[110];   /* watermark for graph */
 224     int       draw_x_grid;  /* no x-grid at all */
 225     int       draw_y_grid;  /* no y-grid at all */
 226     unsigned int draw_3d_border; /* size of border in pixels, 0 for off */
 227     unsigned int dynamic_labels; /* pick the label shape according to the line drawn */
 228     double    grid_dash_on, grid_dash_off;
 229     xlab_t    xlab_user;    /* user defined labeling for xaxis */
 230     char      xlab_form[210];   /* format for the label on the xaxis */
 231     double    second_axis_scale; /* relative to the first axis (0 to disable) */
 232     double    second_axis_shift; /* how much is it shifted vs the first axis */
 233     char      second_axis_legend[210]; /* label to put on the seond axis */
 234     char      second_axis_format[210]; /* format for the numbers on the scond axis */
 235
 236     double    ygridstep;    /* user defined step for y grid */
 237     int       ylabfact; /* every how many y grid shall a label be written ? */
 238     double    tabwidth; /* tabwdith */
 239     time_t    start, end;   /* what time does the graph cover */
 240     unsigned long step; /* any preference for the default step ? */
 241     rrd_value_t minval, maxval; /* extreme values in the data */
 242     int       rigid;    /* do not expand range even with
 243                            values outside */
 244     ygrid_scale_t ygrid_scale;  /* calculated y axis grid info */
 245     int       gridfit;  /* adjust y-axis range etc so all
 246                            grindlines falls in integer pixel values */
 247     char     *imginfo;  /* construct an <IMG ... tag and return
 248                            as first retval */
 249     enum gfx_if_en imgformat;   /* image format */
 250     char     *daemon_addr;  /* rrdcached connection string */
 251     int       lazy;     /* only update the image if there is
 252                            reasonable probablility that the
 253                            existing one is out of date */
 254     int       slopemode;    /* connect the dots of the curve directly, not using a stair */
 255     enum legend_pos legendposition; /* the position of the legend: north, west, south or east */
 256     enum legend_direction legenddirection; /* The direction of the legend topdown or bottomup */
 257     int       logarithmic;  /* scale the yaxis logarithmic */
 258     double    force_scale_min;  /* Force a scale--min */
 259     double    force_scale_max;  /* Force a scale--max */
 260
 261     /* status information */
 262     int       with_markup;
 263     long      xorigin, yorigin; /* where is (0,0) of the graph */
 264     long      xOriginTitle, yOriginTitle; /* where is the origin of the title */
 265     long      xOriginLegendY, yOriginLegendY; /* where is the origin of the y legend */
 266     long      xOriginLegendY2, yOriginLegendY2; /* where is the origin of the second y legend */
 267     long      xOriginLegend, yOriginLegend; /* where is the origin of the legend */
 268     long      ximg, yimg;   /* total size of the image */
 269     long      legendwidth, legendheight; /* the calculated height and width of the legend */
 270     size_t    rendered_image_size;
 271     double    zoom;
 272     double    magfact;  /* numerical magnitude */
 273     long      base;     /* 1000 or 1024 depending on what we graph */
 274     char      symbol;   /* magnitude symbol for y-axis */
 275     float     viewfactor;   /* how should the numbers on the y-axis be scaled for viewing ? */
 276     int       unitsexponent;    /* 10*exponent for units on y-asis */
 277     int       unitslength;  /* width of the yaxis labels */
 278     int       forceleftspace;   /* do not kill the space to the left of the y-axis if there is no grid */
 279
 280     int       extra_flags;  /* flags for boolean options */
 281     /* data elements */
 282
 283     unsigned char *rendered_image;
 284     long      prt_c;    /* number of print elements */
 285     long      gdes_c;   /* number of graphics elements */
 286     graph_desc_t *gdes; /* points to an array of graph elements */
 287     cairo_surface_t *surface;   /* graphics library */
 288     cairo_t  *cr;       /* drawin context */
 289     cairo_font_options_t *font_options; /* cairo font options */
 290     cairo_antialias_t graph_antialias;  /* antialiasing for the graph */
 291     PangoLayout *layout; /* the pango layout we use for writing fonts */
 292     rrd_info_t *grinfo; /* root pointer to extra graph info */
 293     rrd_info_t *grinfo_current; /* pointing to current entry */
 294 } image_desc_t;
 295
 296 /* Prototypes */
 297 int       xtr(
 298     image_desc_t *,
 299     time_t);
 300 double    ytr(
 301     image_desc_t *,
 302     double);
 303 enum gf_en gf_conv(
 304     char *);
 305 enum gfx_if_en if_conv(
 306     char *);
 307 enum gfx_type_en type_conv(
 308     char *);
 309 enum tmt_en tmt_conv(
 310     char *);
 311 enum grc_en grc_conv(
 312     char *);
 313 enum text_prop_en text_prop_conv(
 314     char *);
 315 int       im_free(
 316     image_desc_t *);
 317 void      auto_scale(
 318     image_desc_t *,
 319     double *,
 320     char **,
 321     double *);
 322 void      si_unit(
 323     image_desc_t *);
 324 void      expand_range(
 325     image_desc_t *);
 326 void      apply_gridfit(
 327     image_desc_t *);
 328 void      reduce_data(
 329     enum cf_en,
 330     unsigned long,
 331     time_t *,
 332     time_t *,
 333     unsigned long *,
 334     unsigned long *,
 335     rrd_value_t **);
 336 int       data_fetch(
 337     image_desc_t *);
 338 long      find_var(
 339     image_desc_t *,
 340     char *);
 341 long      find_var_wrapper(
 342     void *arg1,
 343     char *key);
 344 long      lcd(
 345     long *);
 346 int       data_calc(
 347     image_desc_t *);
 348 int       data_proc(
 349     image_desc_t *);
 350 time_t    find_first_time(
 351     time_t,
 352     enum tmt_en,
 353     long);
 354 time_t    find_next_time(
 355     time_t,
 356     enum tmt_en,
 357     long);
 358 int       print_calc(
 359     image_desc_t *);
 360 int       leg_place(
 361     image_desc_t *,
 362     int);
 363 int       calc_horizontal_grid(
 364     image_desc_t *);
 365 int       draw_horizontal_grid(
 366     image_desc_t *);
 367 int       horizontal_log_grid(
 368     image_desc_t *);
 369 void      vertical_grid(
 370     image_desc_t *);
 371 void      axis_paint(
 372     image_desc_t *);
 373 void      grid_paint(
 374     image_desc_t *);
 375 int       lazy_check(
 376     image_desc_t *);
 377 int       graph_paint(
 378     image_desc_t *);
 379 int       graph_paint_timestring(
 380     image_desc_t *,int);
 381 int       graph_paint_xy(
 382     image_desc_t *,int);
 383 int       rrd_graph_xport(
 384     image_desc_t *);
 385
 386 int       graph_cairo_setup(
 387     image_desc_t *);
 388 int       graph_cairo_finish(
 389     image_desc_t *);
 390
 391 int       gdes_alloc(
 392     image_desc_t *);
 393 int       scan_for_col(
 394     const char *const,
 395     int,
 396     char *const);
 397 void      rrd_graph_init(
 398     image_desc_t *);
 399
 400 void      time_clean(
 401     char *result,
 402     char *format);
 403
 404 void      rrd_graph_options(
 405     int,
 406     char **,
 407     image_desc_t *);
 408 void      rrd_graph_script(
 409     int,
 410     char **,
 411     image_desc_t *,
 412     int);
 413 int       rrd_graph_color(
 414     image_desc_t *,
 415     char *,
 416     char *,
 417     int);
 418 int       bad_format(
 419     char *);
 420 int       vdef_parse(
 421     struct graph_desc_t *,
 422     const char *const);
 423 int       vdef_calc(
 424     image_desc_t *,
 425     int);
 426 int       vdef_percent_compar(
 427     const void *,
 428     const void *);
 429 int       graph_size_location(
 430     image_desc_t *,
 431     int);
 432
 433
 434 /* create a new line */
 435 void      gfx_line(
 436     image_desc_t *im,
 437     double X0,
 438     double Y0,
 439     double X1,
 440     double Y1,
 441     double width,
 442     gfx_color_t color);
 443
 444 void      gfx_dashed_line(
 445     image_desc_t *im,
 446     double X0,
 447     double Y0,
 448     double X1,
 449     double Y1,
 450     double width,
 451     gfx_color_t color,
 452     double dash_on,
 453     double dash_off);
 454
 455 /* create a new area */
 456 void      gfx_new_area(
 457     image_desc_t *im,
 458     double X0,
 459     double Y0,
 460     double X1,
 461     double Y1,
 462     double X2,
 463     double Y2,
 464     gfx_color_t color);
 465
 466 /* add a point to a line or to an area */
 467 void      gfx_add_point(
 468     image_desc_t *im,
 469     double x,
 470     double y);
 471
 472 /* create a rect that has a gradient from color1 to color2 in height pixels
 473  * height > 0:
 474  *              gradient starts at top and goes down a fixed number of pixels (fire style)
 475  * height < 0:
 476  *              gradient starts at bottom and goes up a fixed number of pixels (constant style)
 477  * height == 0:
 478  *              gradient is stretched between two points
 479  */
 480 void gfx_add_rect_fadey(
 481     image_desc_t *im,
 482     double x1,double y1,
 483     double x2,double y2,
 484         double py,
 485     gfx_color_t color1,
 486         gfx_color_t color2,
 487         double height);
 488
 489
 490
 491 /* close current path so it ends at the same point as it started */
 492 void      gfx_close_path(
 493     image_desc_t *im);
 494
 495
 496 /* create a text node */
 497 void      gfx_text(
 498     image_desc_t *im,
 499     double x,
 500     double y,
 501     gfx_color_t color,
 502     PangoFontDescription *font_desc,
 503     double tabwidth,
 504     double angle,
 505     enum gfx_h_align_en h_align,
 506     enum gfx_v_align_en v_align,
 507     const char *text);
 508
 509 /* measure width of a text string */
 510 double    gfx_get_text_width(
 511     image_desc_t *im,
 512     double start,
 513     PangoFontDescription *font_desc,
 514     double tabwidth,
 515     char *text);
 516
 517
 518 /* convert color */
 519 gfx_color_t gfx_hex_to_col(
 520     long unsigned int);
 521
 522 void      gfx_line_fit(
 523     image_desc_t *im,
 524     double *x,
 525     double *y);
 526
 527 void      gfx_area_fit(
 528     image_desc_t *im,
 529     double *x,
 530     double *y);
 531
 532 #endif
 533
 534 void      grinfo_push(
 535     image_desc_t *im,
 536     char *key,
 537     rrd_info_type_t type,    rrd_infoval_t value);
 538
 539