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