e7f8231350df4856cf3adbb910f62de9d6a0136e
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 IF_XML=128, IF_CSV=129, IF_TSV=130, IF_SSV=131, IF_JSON=132,
97 IF_XMLENUM=133, IF_JSONTIME=134
98 };
99 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
100 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
101 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
103 /* cairo color components */
104 typedef struct gfx_color_t {
105 double red;
106 double green;
107 double blue;
108 double alpha;
109 } gfx_color_t;
112 typedef struct text_prop_t {
113 double size;
114 char font[1024];
115 PangoFontDescription *font_desc;
116 } text_prop_t;
119 typedef struct vdef_t {
120 enum vdef_op_en op;
121 double param; /* parameter for function, if applicable */
122 double val; /* resulting value */
123 time_t when; /* timestamp, if applicable */
124 int never; /* boolean, indicate that when value mean never */
125 } vdef_t;
127 typedef struct xlab_t {
128 long minsec; /* minimum sec per pix */
129 long length; /* number of secs on the image */
130 enum tmt_en gridtm; /* grid interval in what ? */
131 long gridst; /* how many whats per grid */
132 enum tmt_en mgridtm; /* label interval in what ? */
133 long mgridst; /* how many whats per label */
134 enum tmt_en labtm; /* label interval in what ? */
135 long labst; /* how many whats per label */
136 long precis; /* label precision -> label placement */
137 char *stst; /* strftime string */
138 } xlab_t;
140 typedef struct ygrid_scale_t { /* y axis grid scaling info */
141 double gridstep;
142 int labfact;
143 char labfmt[64];
144 } ygrid_scale_t;
146 /* sensible y label intervals ...*/
148 typedef struct ylab_t {
149 double grid; /* grid spacing */
150 int lfac[4]; /* associated label spacing */
151 } ylab_t;
153 /* this structure describes the elements which can make up a graph.
154 because they are quite diverse, not all elements will use all the
155 possible parts of the structure. */
156 #ifdef HAVE_SNPRINTF
157 #define FMT_LEG_LEN 200
158 #else
159 #define FMT_LEG_LEN 2000
160 #endif
162 typedef struct graph_desc_t {
163 enum gf_en gf; /* graphing function */
164 int stack; /* boolean */
165 int debug; /* boolean */
166 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
167 long vidx; /* gdes reference */
168 char rrd[1024]; /* name of the rrd_file containing data */
169 char ds_nam[DS_NAM_SIZE]; /* data source name */
170 long ds; /* data source number */
171 char daemon[256];
172 enum cf_en cf; /* consolidation function */
173 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
174 struct gfx_color_t col, col2; /* graph color */
175 double gradheight;
176 char format[FMT_LEG_LEN + 5]; /* format for PRINT AND GPRINT */
177 char legend[FMT_LEG_LEN + 5]; /* legend */
178 int strftm; /* should the VDEF legend be formated with strftime */
179 double leg_x, leg_y; /* location of legend */
180 double yrule; /* value for y rule line and for VDEF */
181 time_t xrule; /* time for x rule line and for VDEF */
182 vdef_t vf; /* instruction for VDEF function */
183 rpnp_t *rpnp; /* instructions for CDEF function */
185 /* SHIFT implementation */
186 int shidx; /* gdes reference for offset (-1 --> constant) */
187 time_t shval; /* offset if shidx is -1 */
188 time_t shift; /* current shift applied */
190 /* description of data fetched for the graph element */
191 time_t start, end; /* timestaps for first and last data element */
192 time_t start_orig, end_orig; /* timestaps for first and last data element */
193 unsigned long step; /* time between samples */
194 unsigned long step_orig; /* time between samples */
195 unsigned long ds_cnt; /* how many data sources are there in the fetch */
196 long data_first; /* first pointer to this data */
197 char **ds_namv; /* name of datasources in the fetch. */
198 rrd_value_t *data; /* the raw data drawn from the rrd */
199 rrd_value_t *p_data; /* processed data, xsize elments */
200 double linewidth; /* linewideth */
202 /* dashed line stuff */
203 int dash; /* boolean, draw dashed line? */
204 double *p_dashes; /* pointer do dash array which keeps the lengths of dashes */
205 int ndash; /* number of dash segments */
206 double offset; /* dash offset along the line */
208 enum txa_en txtalign; /* change default alignment strategy for text */
209 } graph_desc_t;
211 typedef struct image_desc_t {
213 /* configuration of graph */
215 char graphfile[MAXPATH]; /* filename for graphic */
216 long xsize, ysize; /* graph area size in pixels */
217 struct gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
218 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
219 char ylegend[210]; /* legend along the yaxis */
220 char title[210]; /* title for graph */
221 char watermark[110]; /* watermark for graph */
222 int draw_x_grid; /* no x-grid at all */
223 int draw_y_grid; /* no y-grid at all */
224 unsigned int draw_3d_border; /* size of border in pixels, 0 for off */
225 unsigned int dynamic_labels; /* pick the label shape according to the line drawn */
226 double grid_dash_on, grid_dash_off;
227 xlab_t xlab_user; /* user defined labeling for xaxis */
228 char xlab_form[210]; /* format for the label on the xaxis */
229 double second_axis_scale; /* relative to the first axis (0 to disable) */
230 double second_axis_shift; /* how much is it shifted vs the first axis */
231 char second_axis_legend[210]; /* label to put on the seond axis */
232 char second_axis_format[210]; /* format for the numbers on the scond axis */
234 double ygridstep; /* user defined step for y grid */
235 int ylabfact; /* every how many y grid shall a label be written ? */
236 double tabwidth; /* tabwdith */
237 time_t start, end; /* what time does the graph cover */
238 unsigned long step; /* any preference for the default step ? */
239 rrd_value_t minval, maxval; /* extreme values in the data */
240 int rigid; /* do not expand range even with
241 values outside */
242 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
243 int gridfit; /* adjust y-axis range etc so all
244 grindlines falls in integer pixel values */
245 char *imginfo; /* construct an <IMG ... tag and return
246 as first retval */
247 enum gfx_if_en imgformat; /* image format */
248 char *daemon_addr; /* rrdcached connection string */
249 int lazy; /* only update the image if there is
250 reasonable probablility that the
251 existing one is out of date */
252 int slopemode; /* connect the dots of the curve directly, not using a stair */
253 enum legend_pos legendposition; /* the position of the legend: north, west, south or east */
254 enum legend_direction legenddirection; /* The direction of the legend topdown or bottomup */
255 int logarithmic; /* scale the yaxis logarithmic */
256 double force_scale_min; /* Force a scale--min */
257 double force_scale_max; /* Force a scale--max */
259 /* status information */
260 int with_markup;
261 long xorigin, yorigin; /* where is (0,0) of the graph */
262 long xOriginTitle, yOriginTitle; /* where is the origin of the title */
263 long xOriginLegendY, yOriginLegendY; /* where is the origin of the y legend */
264 long xOriginLegendY2, yOriginLegendY2; /* where is the origin of the second y legend */
265 long xOriginLegend, yOriginLegend; /* where is the origin of the legend */
266 long ximg, yimg; /* total size of the image */
267 long legendwidth, legendheight; /* the calculated height and width of the legend */
268 size_t rendered_image_size;
269 double zoom;
270 double magfact; /* numerical magnitude */
271 long base; /* 1000 or 1024 depending on what we graph */
272 char symbol; /* magnitude symbol for y-axis */
273 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
274 int unitsexponent; /* 10*exponent for units on y-asis */
275 int unitslength; /* width of the yaxis labels */
276 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
278 int extra_flags; /* flags for boolean options */
279 /* data elements */
281 unsigned char *rendered_image;
282 long prt_c; /* number of print elements */
283 long gdes_c; /* number of graphics elements */
284 graph_desc_t *gdes; /* points to an array of graph elements */
285 cairo_surface_t *surface; /* graphics library */
286 cairo_t *cr; /* drawin context */
287 cairo_font_options_t *font_options; /* cairo font options */
288 cairo_antialias_t graph_antialias; /* antialiasing for the graph */
289 PangoLayout *layout; /* the pango layout we use for writing fonts */
290 rrd_info_t *grinfo; /* root pointer to extra graph info */
291 rrd_info_t *grinfo_current; /* pointing to current entry */
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 time_clean(
386 char *result,
387 char *format);
389 void rrd_graph_options(
390 int,
391 char **,
392 image_desc_t *);
393 void rrd_graph_script(
394 int,
395 char **,
396 image_desc_t *,
397 int);
398 int rrd_graph_color(
399 image_desc_t *,
400 char *,
401 char *,
402 int);
403 int bad_format(
404 char *);
405 int vdef_parse(
406 struct graph_desc_t *,
407 const char *const);
408 int vdef_calc(
409 image_desc_t *,
410 int);
411 int vdef_percent_compar(
412 const void *,
413 const void *);
414 int graph_size_location(
415 image_desc_t *,
416 int);
419 /* create a new line */
420 void gfx_line(
421 image_desc_t *im,
422 double X0,
423 double Y0,
424 double X1,
425 double Y1,
426 double width,
427 gfx_color_t color);
429 void gfx_dashed_line(
430 image_desc_t *im,
431 double X0,
432 double Y0,
433 double X1,
434 double Y1,
435 double width,
436 gfx_color_t color,
437 double dash_on,
438 double dash_off);
440 /* create a new area */
441 void gfx_new_area(
442 image_desc_t *im,
443 double X0,
444 double Y0,
445 double X1,
446 double Y1,
447 double X2,
448 double Y2,
449 gfx_color_t color);
451 /* add a point to a line or to an area */
452 void gfx_add_point(
453 image_desc_t *im,
454 double x,
455 double y);
457 /* create a rect that has a gradient from color1 to color2 in height pixels
458 * height > 0:
459 * gradient starts at top and goes down a fixed number of pixels (fire style)
460 * height < 0:
461 * gradient starts at bottom and goes up a fixed number of pixels (constant style)
462 * height == 0:
463 * gradient is stretched between two points
464 */
465 void gfx_add_rect_fadey(
466 image_desc_t *im,
467 double x1,double y1,
468 double x2,double y2,
469 double py,
470 gfx_color_t color1,
471 gfx_color_t color2,
472 double height);
476 /* close current path so it ends at the same point as it started */
477 void gfx_close_path(
478 image_desc_t *im);
481 /* create a text node */
482 void gfx_text(
483 image_desc_t *im,
484 double x,
485 double y,
486 gfx_color_t color,
487 PangoFontDescription *font_desc,
488 double tabwidth,
489 double angle,
490 enum gfx_h_align_en h_align,
491 enum gfx_v_align_en v_align,
492 const char *text);
494 /* measure width of a text string */
495 double gfx_get_text_width(
496 image_desc_t *im,
497 double start,
498 PangoFontDescription *font_desc,
499 double tabwidth,
500 char *text);
503 /* convert color */
504 gfx_color_t gfx_hex_to_col(
505 long unsigned int);
507 void gfx_line_fit(
508 image_desc_t *im,
509 double *x,
510 double *y);
512 void gfx_area_fit(
513 image_desc_t *im,
514 double *x,
515 double *y);
517 #endif
519 void grinfo_push(
520 image_desc_t *im,
521 char *key,
522 rrd_info_type_t type, rrd_infoval_t value);