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