src/rrd_graph.h

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