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