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 #define gdes_fetch_key(x) sprintf_alloc("%s:%d:%d:%d:%d",x.rrd,x.cf,x.cf_reduce,x.start_orig,x.end_orig,x.step_orig)
51 enum tmt_en { TMT_SECOND = 0, TMT_MINUTE, TMT_HOUR, TMT_DAY,
52 TMT_WEEK, TMT_MONTH, TMT_YEAR
53 };
55 enum grc_en { GRC_CANVAS = 0, GRC_BACK, GRC_SHADEA, GRC_SHADEB,
56 GRC_GRID, GRC_MGRID, GRC_FONT, GRC_ARROW, GRC_AXIS, GRC_FRAME, __GRC_END__
57 };
59 #define MGRIDWIDTH 0.6
60 #define GRIDWIDTH 0.4
62 enum gf_en { GF_PRINT = 0, GF_GPRINT, GF_COMMENT, GF_HRULE, GF_VRULE, GF_LINE,
63 GF_AREA, GF_STACK, GF_TICK, GF_TEXTALIGN,
64 GF_DEF, GF_CDEF, GF_VDEF, GF_SHIFT,
65 GF_XPORT
66 };
68 enum txa_en { TXA_LEFT = 0, TXA_RIGHT, TXA_CENTER, TXA_JUSTIFIED };
70 enum vdef_op_en {
71 VDEF_MAXIMUM = 0 /* like the MAX in (G)PRINT */
72 , VDEF_MINIMUM /* like the MIN in (G)PRINT */
73 , VDEF_AVERAGE /* like the AVERAGE in (G)PRINT */
74 , VDEF_STDEV /* the standard deviation */
75 , VDEF_PERCENT /* Nth percentile */
76 , VDEF_TOTAL /* average multiplied by time */
77 , VDEF_FIRST /* first non-unknown value and time */
78 , VDEF_LAST /* last non-unknown value and time */
79 , VDEF_LSLSLOPE /* least squares line slope */
80 , VDEF_LSLINT /* least squares line y_intercept */
81 , VDEF_LSLCORREL /* least squares line correlation coefficient */
82 , VDEF_PERCENTNAN /* Nth percentile ignoring NAN*/
83 };
84 enum text_prop_en {
85 TEXT_PROP_DEFAULT = 0, /* default settings */
86 TEXT_PROP_TITLE, /* properties for the title */
87 TEXT_PROP_AXIS, /* for the numbers next to the axis */
88 TEXT_PROP_UNIT, /* for the vertical unit description */
89 TEXT_PROP_LEGEND, /* for the legend below the graph */
90 TEXT_PROP_WATERMARK, /* for the little text to the side of the graph */
91 TEXT_PROP_LAST
92 };
94 enum legend_pos{ NORTH = 0, WEST, SOUTH, EAST };
95 enum legend_direction { TOP_DOWN = 0, BOTTOM_UP };
97 enum gfx_if_en { IF_PNG = 0, IF_SVG, IF_EPS, IF_PDF };
98 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
99 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
100 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
102 /* cairo color components */
103 typedef struct gfx_color_t {
104 double red;
105 double green;
106 double blue;
107 double alpha;
108 } gfx_color_t;
111 typedef struct text_prop_t {
112 double size;
113 char font[1024];
114 PangoFontDescription *font_desc;
115 } text_prop_t;
118 typedef struct vdef_t {
119 enum vdef_op_en op;
120 double param; /* parameter for function, if applicable */
121 double val; /* resulting value */
122 time_t when; /* timestamp, if applicable */
123 } vdef_t;
125 typedef struct xlab_t {
126 long minsec; /* minimum sec per pix */
127 long length; /* number of secs on the image */
128 enum tmt_en gridtm; /* grid interval in what ? */
129 long gridst; /* how many whats per grid */
130 enum tmt_en mgridtm; /* label interval in what ? */
131 long mgridst; /* how many whats per label */
132 enum tmt_en labtm; /* label interval in what ? */
133 long labst; /* how many whats per label */
134 long precis; /* label precision -> label placement */
135 char *stst; /* strftime string */
136 } xlab_t;
138 typedef struct ygrid_scale_t { /* y axis grid scaling info */
139 double gridstep;
140 int labfact;
141 char labfmt[64];
142 } ygrid_scale_t;
144 /* sensible y label intervals ...*/
146 typedef struct ylab_t {
147 double grid; /* grid spacing */
148 int lfac[4]; /* associated label spacing */
149 } ylab_t;
151 /* this structure describes the elements which can make up a graph.
152 because they are quite diverse, not all elements will use all the
153 possible parts of the structure. */
154 #ifdef HAVE_SNPRINTF
155 #define FMT_LEG_LEN 200
156 #else
157 #define FMT_LEG_LEN 2000
158 #endif
160 typedef struct graph_desc_t {
161 enum gf_en gf; /* graphing function */
162 int stack; /* boolean */
163 int debug; /* boolean */
164 int skipscale; /* boolean */
165 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
166 long vidx; /* gdes reference */
167 char rrd[1024]; /* name of the rrd_file containing data */
168 char ds_nam[DS_NAM_SIZE]; /* data source name */
169 long ds; /* data source number */
170 enum cf_en cf; /* consolidation function */
171 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
172 struct gfx_color_t col; /* graph color */
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 */
206 enum txa_en txtalign; /* change default alignment strategy for text */
207 } graph_desc_t;
209 typedef struct image_desc_t {
211 /* configuration of graph */
213 char graphfile[MAXPATH]; /* filename for graphic */
214 long xsize, ysize; /* graph area size in pixels */
215 struct gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
216 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
217 char ylegend[210]; /* legend along the yaxis */
218 char title[210]; /* title for graph */
219 char watermark[110]; /* watermark for graph */
220 int draw_x_grid; /* no x-grid at all */
221 int draw_y_grid; /* no y-grid at all */
222 unsigned int draw_3d_border; /* size of border in pixels, 0 for off */
223 unsigned int dynamic_labels; /* pick the label shape according to the line drawn */
224 double grid_dash_on, grid_dash_off;
225 xlab_t xlab_user; /* user defined labeling for xaxis */
226 char xlab_form[210]; /* format for the label on the xaxis */
227 double second_axis_scale; /* relative to the first axis (0 to disable) */
228 double second_axis_shift; /* how much is it shifted vs the first axis */
229 char second_axis_legend[210]; /* label to put on the seond axis */
230 char second_axis_format[210]; /* format for the numbers on the scond axis */
232 double ygridstep; /* user defined step for y grid */
233 int ylabfact; /* every how many y grid shall a label be written ? */
234 double tabwidth; /* tabwdith */
235 time_t start, end; /* what time does the graph cover */
236 unsigned long step; /* any preference for the default step ? */
237 rrd_value_t minval, maxval; /* extreme values in the data */
238 int rigid; /* do not expand range even with
239 values outside */
240 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
241 int gridfit; /* adjust y-axis range etc so all
242 grindlines falls in integer pixel values */
243 char *imginfo; /* construct an <IMG ... tag and return
244 as first retval */
245 enum gfx_if_en imgformat; /* image format */
246 char *daemon_addr; /* rrdcached connection string */
247 int lazy; /* only update the image if there is
248 reasonable probablility that the
249 existing one is out of date */
250 int slopemode; /* connect the dots of the curve directly, not using a stair */
251 enum legend_pos legendposition; /* the position of the legend: north, west, south or east */
252 enum legend_direction legenddirection; /* The direction of the legend topdown or bottomup */
253 int logarithmic; /* scale the yaxis logarithmic */
254 double force_scale_min; /* Force a scale--min */
255 double force_scale_max; /* Force a scale--max */
257 /* status information */
258 int with_markup;
259 long xorigin, yorigin; /* where is (0,0) of the graph */
260 long xOriginTitle, yOriginTitle; /* where is the origin of the title */
261 long xOriginLegendY, yOriginLegendY; /* where is the origin of the y legend */
262 long xOriginLegendY2, yOriginLegendY2; /* where is the origin of the second y legend */
263 long xOriginLegend, yOriginLegend; /* where is the origin of the legend */
264 long ximg, yimg; /* total size of the image */
265 long legendwidth, legendheight; /* the calculated height and width of the legend */
266 size_t rendered_image_size;
267 double zoom;
268 double magfact; /* numerical magnitude */
269 long base; /* 1000 or 1024 depending on what we graph */
270 char symbol; /* magnitude symbol for y-axis */
271 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
272 int unitsexponent; /* 10*exponent for units on y-asis */
273 int unitslength; /* width of the yaxis labels */
274 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
276 int extra_flags; /* flags for boolean options */
277 /* data elements */
279 unsigned char *rendered_image;
280 long prt_c; /* number of print elements */
281 long gdes_c; /* number of graphics elements */
282 graph_desc_t *gdes; /* points to an array of graph elements */
283 cairo_surface_t *surface; /* graphics library */
284 cairo_t *cr; /* drawin context */
285 cairo_font_options_t *font_options; /* cairo font options */
286 cairo_antialias_t graph_antialias; /* antialiasing for the graph */
287 PangoLayout *layout; /* the pango layout we use for writing fonts */
288 rrd_info_t *grinfo; /* root pointer to extra graph info */
289 rrd_info_t *grinfo_current; /* pointing to current entry */
290 GHashTable* gdef_map; /* a map of all *def gdef entries for quick access */
291 GHashTable* rrd_map; /* a map of all rrd files in use for gdef entries */
292 } image_desc_t;
294 /* Prototypes */
295 int xtr(
296 image_desc_t *,
297 time_t);
298 double ytr(
299 image_desc_t *,
300 double);
301 enum gf_en gf_conv(
302 char *);
303 enum gfx_if_en if_conv(
304 char *);
305 enum tmt_en tmt_conv(
306 char *);
307 enum grc_en grc_conv(
308 char *);
309 enum text_prop_en text_prop_conv(
310 char *);
311 int im_free(
312 image_desc_t *);
313 void auto_scale(
314 image_desc_t *,
315 double *,
316 char **,
317 double *);
318 void si_unit(
319 image_desc_t *);
320 void expand_range(
321 image_desc_t *);
322 void apply_gridfit(
323 image_desc_t *);
324 void reduce_data(
325 enum cf_en,
326 unsigned long,
327 time_t *,
328 time_t *,
329 unsigned long *,
330 unsigned long *,
331 rrd_value_t **);
332 int data_fetch(
333 image_desc_t *);
334 long find_var(
335 image_desc_t *,
336 char *);
337 long find_var_wrapper(
338 void *arg1,
339 char *key);
340 long lcd(
341 long *);
342 int data_calc(
343 image_desc_t *);
344 int data_proc(
345 image_desc_t *);
346 time_t find_first_time(
347 time_t,
348 enum tmt_en,
349 long);
350 time_t find_next_time(
351 time_t,
352 enum tmt_en,
353 long);
354 int print_calc(
355 image_desc_t *);
356 int leg_place(
357 image_desc_t *,
358 int);
359 int calc_horizontal_grid(
360 image_desc_t *);
361 int draw_horizontal_grid(
362 image_desc_t *);
363 int horizontal_log_grid(
364 image_desc_t *);
365 void vertical_grid(
366 image_desc_t *);
367 void axis_paint(
368 image_desc_t *);
369 void grid_paint(
370 image_desc_t *);
371 int lazy_check(
372 image_desc_t *);
373 int graph_paint(
374 image_desc_t *);
376 int gdes_alloc(
377 image_desc_t *);
378 int scan_for_col(
379 const char *const,
380 int,
381 char *const);
382 void rrd_graph_init(
383 image_desc_t *);
385 void rrd_graph_options(
386 int,
387 char **,
388 image_desc_t *);
389 void rrd_graph_script(
390 int,
391 char **,
392 image_desc_t *,
393 int);
394 int rrd_graph_color(
395 image_desc_t *,
396 char *,
397 char *,
398 int);
399 int bad_format(
400 char *);
401 int vdef_parse(
402 struct graph_desc_t *,
403 const char *const);
404 int vdef_calc(
405 image_desc_t *,
406 int);
407 int vdef_percent_compar(
408 const void *,
409 const void *);
410 int graph_size_location(
411 image_desc_t *,
412 int);
415 /* create a new line */
416 void gfx_line(
417 image_desc_t *im,
418 double X0,
419 double Y0,
420 double X1,
421 double Y1,
422 double width,
423 gfx_color_t color);
425 void gfx_dashed_line(
426 image_desc_t *im,
427 double X0,
428 double Y0,
429 double X1,
430 double Y1,
431 double width,
432 gfx_color_t color,
433 double dash_on,
434 double dash_off);
436 /* create a new area */
437 void gfx_new_area(
438 image_desc_t *im,
439 double X0,
440 double Y0,
441 double X1,
442 double Y1,
443 double X2,
444 double Y2,
445 gfx_color_t color);
447 /* add a point to a line or to an area */
448 void gfx_add_point(
449 image_desc_t *im,
450 double x,
451 double y);
453 /* close current path so it ends at the same point as it started */
454 void gfx_close_path(
455 image_desc_t *im);
458 /* create a text node */
459 void gfx_text(
460 image_desc_t *im,
461 double x,
462 double y,
463 gfx_color_t color,
464 PangoFontDescription *font_desc,
465 double tabwidth,
466 double angle,
467 enum gfx_h_align_en h_align,
468 enum gfx_v_align_en v_align,
469 const char *text);
471 /* measure width of a text string */
472 double gfx_get_text_width(
473 image_desc_t *im,
474 double start,
475 PangoFontDescription *font_desc,
476 double tabwidth,
477 char *text);
480 /* convert color */
481 gfx_color_t gfx_hex_to_col(
482 long unsigned int);
484 void gfx_line_fit(
485 image_desc_t *im,
486 double *x,
487 double *y);
489 void gfx_area_fit(
490 image_desc_t *im,
491 double *x,
492 double *y);
494 #endif
496 void grinfo_push(
497 image_desc_t *im,
498 char *key,
499 rrd_info_type_t type, rrd_infoval_t value);