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