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 #define MAX_VNAME_LEN 255
  18 #define DEF_NAM_FMT "%255[-_A-Za-z0-9]"
  19
  20 #define ALTYGRID         0x01   /* use alternative y grid algorithm */
  21 #define ALTAUTOSCALE     0x02   /* use alternative algorithm to find lower and upper bounds */
  22 #define ALTAUTOSCALE_MIN 0x04   /* use alternative algorithm to find lower bounds */
  23 #define ALTAUTOSCALE_MAX 0x08   /* use alternative algorithm to find upper bounds */
  24 #define NOLEGEND         0x10   /* use no legend */
  25 #define NOMINOR          0x20   /* Turn off minor gridlines */
  26 #define ONLY_GRAPH       0x40   /* use only graph */
  27 #define FORCE_RULES_LEGEND 0x80 /* force printing of HRULE and VRULE legend */
  28
  29 #define FORCE_UNITS 0x100   /* mask for all FORCE_UNITS_* flags */
  30 #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) */
  31
  32 #define FULL_SIZE_MODE     0x200    /* -width and -height indicate the total size of the image */
  33
  34 enum tmt_en { TMT_SECOND = 0, TMT_MINUTE, TMT_HOUR, TMT_DAY,
  35     TMT_WEEK, TMT_MONTH, TMT_YEAR
  36 };
  37
  38 enum grc_en { GRC_CANVAS = 0, GRC_BACK, GRC_SHADEA, GRC_SHADEB,
  39     GRC_GRID, GRC_MGRID, GRC_FONT, GRC_ARROW, GRC_AXIS, GRC_FRAME, __GRC_END__
  40 };
  41
  42 #define MGRIDWIDTH 0.6
  43 #define GRIDWIDTH  0.4
  44
  45 enum gf_en { GF_PRINT = 0, GF_GPRINT, GF_COMMENT, GF_HRULE, GF_VRULE, GF_LINE,
  46     GF_AREA, GF_STACK, GF_TICK, GF_TEXTALIGN,
  47     GF_DEF, GF_CDEF, GF_VDEF, GF_SHIFT,
  48     GF_XPORT
  49 };
  50
  51 enum txa_en { TXA_LEFT = 0, TXA_RIGHT, TXA_CENTER, TXA_JUSTIFIED };
  52
  53 enum vdef_op_en {
  54     VDEF_MAXIMUM = 0    /* like the MAX in (G)PRINT */
  55         , VDEF_MINIMUM  /* like the MIN in (G)PRINT */
  56         , VDEF_AVERAGE  /* like the AVERAGE in (G)PRINT */
  57         , VDEF_STDEV    /* the standard deviation */
  58         , VDEF_PERCENT  /* Nth percentile */
  59         , VDEF_TOTAL    /* average multiplied by time */
  60         , VDEF_FIRST    /* first non-unknown value and time */
  61         , VDEF_LAST     /* last  non-unknown value and time */
  62         , VDEF_LSLSLOPE /* least squares line slope */
  63         , VDEF_LSLINT   /* least squares line y_intercept */
  64         , VDEF_LSLCORREL    /* least squares line correlation coefficient */
  65 };
  66 enum text_prop_en { TEXT_PROP_DEFAULT = 0,  /* default settings */
  67     TEXT_PROP_TITLE,    /* properties for the title */
  68     TEXT_PROP_AXIS,     /* for the numbers next to the axis */
  69     TEXT_PROP_UNIT,     /* for the vertical unit description */
  70     TEXT_PROP_LEGEND,   /* fot the legend below 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 } text_prop_t;
  93
  94
  95 typedef struct vdef_t {
  96     enum vdef_op_en op;
  97     double    param;    /* parameter for function, if applicable */
  98     double    val;      /* resulting value */
  99     time_t    when;     /* timestamp, if applicable */
 100 } vdef_t;
 101
 102 typedef struct xlab_t {
 103     long      minsec;   /* minimum sec per pix */
 104     long      length;   /* number of secs on the image */
 105     enum tmt_en gridtm; /* grid interval in what ? */
 106     long      gridst;   /* how many whats per grid */
 107     enum tmt_en mgridtm;    /* label interval in what ? */
 108     long      mgridst;  /* how many whats per label */
 109     enum tmt_en labtm;  /* label interval in what ? */
 110     long      labst;    /* how many whats per label */
 111     long      precis;   /* label precision -> label placement */
 112     char     *stst;     /* strftime string */
 113 } xlab_t;
 114
 115 typedef struct ygrid_scale_t {  /* y axis grid scaling info */
 116     double    gridstep;
 117     int       labfact;
 118     char      labfmt[64];
 119 } ygrid_scale_t;
 120
 121 /* sensible y label intervals ...*/
 122
 123 typedef struct ylab_t {
 124     double    grid;     /* grid spacing */
 125     int       lfac[4];  /* associated label spacing */
 126 } ylab_t;
 127
 128 /* this structure describes the elements which can make up a graph.
 129    because they are quite diverse, not all elements will use all the
 130    possible parts of the structure. */
 131 #ifdef HAVE_SNPRINTF
 132 #define FMT_LEG_LEN 200
 133 #else
 134 #define FMT_LEG_LEN 2000
 135 #endif
 136
 137 typedef struct graph_desc_t {
 138     enum gf_en gf;      /* graphing function */
 139     int       stack;    /* boolean */
 140     int       debug;    /* boolean */
 141     char      vname[MAX_VNAME_LEN + 1]; /* name of the variable */
 142     long      vidx;     /* gdes reference */
 143     char      rrd[1024];    /* name of the rrd_file containing data */
 144     char      ds_nam[DS_NAM_SIZE];  /* data source name */
 145     long      ds;       /* data source number */
 146     enum cf_en cf;      /* consolidation function */
 147     enum cf_en cf_reduce;   /* consolidation function for reduce_data() */
 148     struct gfx_color_t col; /* graph color */
 149     char      format[FMT_LEG_LEN + 5];  /* format for PRINT AND GPRINT */
 150     char      legend[FMT_LEG_LEN + 5];  /* legend */
 151     int       strftm;   /* should the VDEF legend be formated with strftime */
 152     double    leg_x, leg_y; /* location of legend */
 153     double    yrule;    /* value for y rule line and for VDEF */
 154     time_t    xrule;    /* time for x rule line and for VDEF */
 155     vdef_t    vf;       /* instruction for VDEF function */
 156     rpnp_t   *rpnp;     /* instructions for CDEF function */
 157
 158     /* SHIFT implementation */
 159     int       shidx;    /* gdes reference for offset (-1 --> constant) */
 160     time_t    shval;    /* offset if shidx is -1 */
 161     time_t    shift;    /* current shift applied */
 162
 163     /* description of data fetched for the graph element */
 164     time_t    start, end;   /* timestaps for first and last data element */
 165     time_t    start_orig, end_orig; /* timestaps for first and last data element */
 166     unsigned long step; /* time between samples */
 167     unsigned long step_orig;    /* time between samples */
 168     unsigned long ds_cnt;   /* how many data sources are there in the fetch */
 169     long      data_first;   /* first pointer to this data */
 170     char    **ds_namv;  /* name of datasources  in the fetch. */
 171     rrd_value_t *data;  /* the raw data drawn from the rrd */
 172     rrd_value_t *p_data;    /* processed data, xsize elments */
 173     double    linewidth;    /* linewideth */
 174
 175     /* dashed line stuff */
 176     int       dash;     /* boolean, draw dashed line? */
 177     double   *p_dashes; /* pointer do dash array which keeps the lengths of dashes */
 178     int       ndash;    /* number of dash segments */
 179     double    offset;   /* dash offset along the line */
 180
 181     enum txa_en txtalign;   /* change default alignment strategy for text */
 182 } graph_desc_t;
 183
 184 typedef struct image_desc_t {
 185
 186     /* configuration of graph */
 187
 188     char      graphfile[MAXPATH];   /* filename for graphic */
 189     FILE     *graphhandle;  /* FILE to use if filename is "-" */
 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
 222     /* status information */
 223
 224     long      xorigin, yorigin; /* where is (0,0) of the graph */
 225     long      ximg, yimg;   /* total size of the image */
 226     size_t    rendered_image_size;
 227     double    zoom;
 228     double    magfact;  /* numerical magnitude */
 229     long      base;     /* 1000 or 1024 depending on what we graph */
 230     char      symbol;   /* magnitude symbol for y-axis */
 231     float     viewfactor;   /* how should the numbers on the y-axis be scaled for viewing ? */
 232     int       unitsexponent;    /* 10*exponent for units on y-asis */
 233     int       unitslength;  /* width of the yaxis labels */
 234     int       forceleftspace;   /* do not kill the space to the left of the y-axis if there is no grid */
 235
 236     int       extra_flags;  /* flags for boolean options */
 237     /* data elements */
 238
 239     unsigned char *rendered_image;
 240     long      prt_c;    /* number of print elements */
 241     long      gdes_c;   /* number of graphics elements */
 242     graph_desc_t *gdes; /* points to an array of graph elements */
 243     cairo_surface_t *surface;   /* graphics library */
 244     cairo_t  *cr;       /* drawin context */
 245     cairo_font_options_t *font_options; /* cairo font options */
 246     cairo_antialias_t graph_antialias;  /* antialiasing for the graph */
 247 } image_desc_t;
 248
 249 /* Prototypes */
 250 int       xtr(
 251     image_desc_t *,
 252     time_t);
 253 double    ytr(
 254     image_desc_t *,
 255     double);
 256 enum gf_en gf_conv(
 257     char *);
 258 enum gfx_if_en if_conv(
 259     char *);
 260 enum tmt_en tmt_conv(
 261     char *);
 262 enum grc_en grc_conv(
 263     char *);
 264 enum text_prop_en text_prop_conv(
 265     char *);
 266 int       im_free(
 267     image_desc_t *);
 268 void      auto_scale(
 269     image_desc_t *,
 270     double *,
 271     char **,
 272     double *);
 273 void      si_unit(
 274     image_desc_t *);
 275 void      expand_range(
 276     image_desc_t *);
 277 void      apply_gridfit(
 278     image_desc_t *);
 279 void      reduce_data(
 280     enum cf_en,
 281     unsigned long,
 282     time_t *,
 283     time_t *,
 284     unsigned long *,
 285     unsigned long *,
 286     rrd_value_t **);
 287 int       data_fetch(
 288     image_desc_t *);
 289 long      find_var(
 290     image_desc_t *,
 291     char *);
 292 long      find_var_wrapper(
 293     void *arg1,
 294     char *key);
 295 long      lcd(
 296     long *);
 297 int       data_calc(
 298     image_desc_t *);
 299 int       data_proc(
 300     image_desc_t *);
 301 time_t    find_first_time(
 302     time_t,
 303     enum tmt_en,
 304     long);
 305 time_t    find_next_time(
 306     time_t,
 307     enum tmt_en,
 308     long);
 309 int       print_calc(
 310     image_desc_t *,
 311     char ***);
 312 int       leg_place(
 313     image_desc_t *,
 314     int *);
 315 int       calc_horizontal_grid(
 316     image_desc_t *);
 317 int       draw_horizontal_grid(
 318     image_desc_t *);
 319 int       horizontal_log_grid(
 320     image_desc_t *);
 321 void      vertical_grid(
 322     image_desc_t *);
 323 void      axis_paint(
 324     image_desc_t *);
 325 void      grid_paint(
 326     image_desc_t *);
 327 int       lazy_check(
 328     image_desc_t *);
 329 int       graph_paint(
 330     image_desc_t *,
 331     char ***);
 332
 333 int       gdes_alloc(
 334     image_desc_t *);
 335 int       scan_for_col(
 336     const char *const,
 337     int,
 338     char *const);
 339 int       rrd_graph(
 340     int,
 341     char **,
 342     char ***,
 343     int *,
 344     int *,
 345     FILE *,
 346     double *,
 347     double *);
 348 void      rrd_graph_init(
 349     image_desc_t *);
 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
 381 /* create a new line */
 382 void      gfx_line(
 383     image_desc_t *im,
 384     double X0,
 385     double Y0,
 386     double X1,
 387     double Y1,
 388     double width,
 389     gfx_color_t color);
 390
 391 void      gfx_dashed_line(
 392     image_desc_t *im,
 393     double X0,
 394     double Y0,
 395     double X1,
 396     double Y1,
 397     double width,
 398     gfx_color_t color,
 399     double dash_on,
 400     double dash_off);
 401
 402 /* create a new area */
 403 void      gfx_new_area(
 404     image_desc_t *im,
 405     double X0,
 406     double Y0,
 407     double X1,
 408     double Y1,
 409     double X2,
 410     double Y2,
 411     gfx_color_t color);
 412
 413 /* add a point to a line or to an area */
 414 void      gfx_add_point(
 415     image_desc_t *im,
 416     double x,
 417     double y);
 418
 419 /* close current path so it ends at the same point as it started */
 420 void      gfx_close_path(
 421     image_desc_t *im);
 422
 423
 424 /* create a text node */
 425 void      gfx_text(
 426     image_desc_t *im,
 427     double x,
 428     double y,
 429     gfx_color_t color,
 430     char *font,
 431     double size,
 432     double tabwidth,
 433     double angle,
 434     enum gfx_h_align_en h_align,
 435     enum gfx_v_align_en v_align,
 436     const char *text);
 437
 438 /* measure width of a text string */
 439 double    gfx_get_text_width(
 440     image_desc_t *im,
 441     double start,
 442     char *font,
 443     double size,
 444     double tabwidth,
 445     char *text);
 446
 447
 448 /* convert color */
 449 gfx_color_t gfx_hex_to_col(
 450     long unsigned int);
 451
 452 void      gfx_line_fit(
 453     image_desc_t *im,
 454     double *x,
 455     double *y);
 456
 457 void      gfx_area_fit(
 458     image_desc_t *im,
 459     double *x,
 460     double *y);
 461
 462 #endif