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