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