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