5c97b80a15805ee43b7d219377f72923647263b1
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_GRAD, 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 int never; /* boolean, indicate that when value mean never */
120 } vdef_t;
122 typedef struct xlab_t {
123 long minsec; /* minimum sec per pix */
124 long length; /* number of secs on the image */
125 enum tmt_en gridtm; /* grid interval in what ? */
126 long gridst; /* how many whats per grid */
127 enum tmt_en mgridtm; /* label interval in what ? */
128 long mgridst; /* how many whats per label */
129 enum tmt_en labtm; /* label interval in what ? */
130 long labst; /* how many whats per label */
131 long precis; /* label precision -> label placement */
132 char *stst; /* strftime string */
133 } xlab_t;
135 typedef struct ygrid_scale_t { /* y axis grid scaling info */
136 double gridstep;
137 int labfact;
138 char labfmt[64];
139 } ygrid_scale_t;
141 /* sensible y label intervals ...*/
143 typedef struct ylab_t {
144 double grid; /* grid spacing */
145 int lfac[4]; /* associated label spacing */
146 } ylab_t;
148 /* this structure describes the elements which can make up a graph.
149 because they are quite diverse, not all elements will use all the
150 possible parts of the structure. */
151 #ifdef HAVE_SNPRINTF
152 #define FMT_LEG_LEN 200
153 #else
154 #define FMT_LEG_LEN 2000
155 #endif
157 typedef struct graph_desc_t {
158 enum gf_en gf; /* graphing function */
159 int stack; /* boolean */
160 int debug; /* boolean */
161 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
162 long vidx; /* gdes reference */
163 char rrd[1024]; /* name of the rrd_file containing data */
164 char ds_nam[DS_NAM_SIZE]; /* data source name */
165 long ds; /* data source number */
166 char daemon[256];
167 enum cf_en cf; /* consolidation function */
168 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
169 struct gfx_color_t col, col2; /* graph color */
170 double gradheight;
171 char format[FMT_LEG_LEN + 5]; /* format for PRINT AND GPRINT */
172 char legend[FMT_LEG_LEN + 5]; /* legend */
173 int strftm; /* should the VDEF legend be formated with strftime */
174 double leg_x, leg_y; /* location of legend */
175 double yrule; /* value for y rule line and for VDEF */
176 time_t xrule; /* time for x rule line and for VDEF */
177 vdef_t vf; /* instruction for VDEF function */
178 rpnp_t *rpnp; /* instructions for CDEF function */
180 /* SHIFT implementation */
181 int shidx; /* gdes reference for offset (-1 --> constant) */
182 time_t shval; /* offset if shidx is -1 */
183 time_t shift; /* current shift applied */
185 /* description of data fetched for the graph element */
186 time_t start, end; /* timestaps for first and last data element */
187 time_t start_orig, end_orig; /* timestaps for first and last data element */
188 unsigned long step; /* time between samples */
189 unsigned long step_orig; /* time between samples */
190 unsigned long ds_cnt; /* how many data sources are there in the fetch */
191 long data_first; /* first pointer to this data */
192 char **ds_namv; /* name of datasources in the fetch. */
193 rrd_value_t *data; /* the raw data drawn from the rrd */
194 rrd_value_t *p_data; /* processed data, xsize elments */
195 double linewidth; /* linewideth */
197 /* dashed line stuff */
198 int dash; /* boolean, draw dashed line? */
199 double *p_dashes; /* pointer do dash array which keeps the lengths of dashes */
200 int ndash; /* number of dash segments */
201 double offset; /* dash offset along the line */
203 enum txa_en txtalign; /* change default alignment strategy for text */
204 } graph_desc_t;
206 typedef struct image_desc_t {
208 /* configuration of graph */
210 char graphfile[MAXPATH]; /* filename for graphic */
211 long xsize, ysize; /* graph area size in pixels */
212 struct gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
213 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
214 char ylegend[210]; /* legend along the yaxis */
215 char title[210]; /* title for graph */
216 char watermark[110]; /* watermark for graph */
217 int draw_x_grid; /* no x-grid at all */
218 int draw_y_grid; /* no y-grid at all */
219 unsigned int draw_3d_border; /* size of border in pixels, 0 for off */
220 unsigned int dynamic_labels; /* pick the label shape according to the line drawn */
221 double grid_dash_on, grid_dash_off;
222 xlab_t xlab_user; /* user defined labeling for xaxis */
223 char xlab_form[210]; /* format for the label on the xaxis */
224 double second_axis_scale; /* relative to the first axis (0 to disable) */
225 double second_axis_shift; /* how much is it shifted vs the first axis */
226 char second_axis_legend[210]; /* label to put on the seond axis */
227 char second_axis_format[210]; /* format for the numbers on the scond axis */
229 double ygridstep; /* user defined step for y grid */
230 int ylabfact; /* every how many y grid shall a label be written ? */
231 double tabwidth; /* tabwdith */
232 time_t start, end; /* what time does the graph cover */
233 unsigned long step; /* any preference for the default step ? */
234 rrd_value_t minval, maxval; /* extreme values in the data */
235 int rigid; /* do not expand range even with
236 values outside */
237 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
238 int gridfit; /* adjust y-axis range etc so all
239 grindlines falls in integer pixel values */
240 char *imginfo; /* construct an <IMG ... tag and return
241 as first retval */
242 enum gfx_if_en imgformat; /* image format */
243 char *daemon_addr; /* rrdcached connection string */
244 int lazy; /* only update the image if there is
245 reasonable probablility that the
246 existing one is out of date */
247 int slopemode; /* connect the dots of the curve directly, not using a stair */
248 enum legend_pos legendposition; /* the position of the legend: north, west, south or east */
249 enum legend_direction legenddirection; /* The direction of the legend topdown or bottomup */
250 int logarithmic; /* scale the yaxis logarithmic */
251 double force_scale_min; /* Force a scale--min */
252 double force_scale_max; /* Force a scale--max */
254 /* status information */
255 int with_markup;
256 long xorigin, yorigin; /* where is (0,0) of the graph */
257 long xOriginTitle, yOriginTitle; /* where is the origin of the title */
258 long xOriginLegendY, yOriginLegendY; /* where is the origin of the y legend */
259 long xOriginLegendY2, yOriginLegendY2; /* where is the origin of the second y legend */
260 long xOriginLegend, yOriginLegend; /* where is the origin of the legend */
261 long ximg, yimg; /* total size of the image */
262 long legendwidth, legendheight; /* the calculated height and width of the legend */
263 size_t rendered_image_size;
264 double zoom;
265 double magfact; /* numerical magnitude */
266 long base; /* 1000 or 1024 depending on what we graph */
267 char symbol; /* magnitude symbol for y-axis */
268 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
269 int unitsexponent; /* 10*exponent for units on y-asis */
270 int unitslength; /* width of the yaxis labels */
271 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
273 int extra_flags; /* flags for boolean options */
274 /* data elements */
276 unsigned char *rendered_image;
277 long prt_c; /* number of print elements */
278 long gdes_c; /* number of graphics elements */
279 graph_desc_t *gdes; /* points to an array of graph elements */
280 cairo_surface_t *surface; /* graphics library */
281 cairo_t *cr; /* drawin context */
282 cairo_font_options_t *font_options; /* cairo font options */
283 cairo_antialias_t graph_antialias; /* antialiasing for the graph */
284 PangoLayout *layout; /* the pango layout we use for writing fonts */
285 rrd_info_t *grinfo; /* root pointer to extra graph info */
286 rrd_info_t *grinfo_current; /* pointing to current entry */
287 } image_desc_t;
289 /* Prototypes */
290 int xtr(
291 image_desc_t *,
292 time_t);
293 double ytr(
294 image_desc_t *,
295 double);
296 enum gf_en gf_conv(
297 char *);
298 enum gfx_if_en if_conv(
299 char *);
300 enum tmt_en tmt_conv(
301 char *);
302 enum grc_en grc_conv(
303 char *);
304 enum text_prop_en text_prop_conv(
305 char *);
306 int im_free(
307 image_desc_t *);
308 void auto_scale(
309 image_desc_t *,
310 double *,
311 char **,
312 double *);
313 void si_unit(
314 image_desc_t *);
315 void expand_range(
316 image_desc_t *);
317 void apply_gridfit(
318 image_desc_t *);
319 void reduce_data(
320 enum cf_en,
321 unsigned long,
322 time_t *,
323 time_t *,
324 unsigned long *,
325 unsigned long *,
326 rrd_value_t **);
327 int data_fetch(
328 image_desc_t *);
329 long find_var(
330 image_desc_t *,
331 char *);
332 long find_var_wrapper(
333 void *arg1,
334 char *key);
335 long lcd(
336 long *);
337 int data_calc(
338 image_desc_t *);
339 int data_proc(
340 image_desc_t *);
341 time_t find_first_time(
342 time_t,
343 enum tmt_en,
344 long);
345 time_t find_next_time(
346 time_t,
347 enum tmt_en,
348 long);
349 int print_calc(
350 image_desc_t *);
351 int leg_place(
352 image_desc_t *,
353 int);
354 int calc_horizontal_grid(
355 image_desc_t *);
356 int draw_horizontal_grid(
357 image_desc_t *);
358 int horizontal_log_grid(
359 image_desc_t *);
360 void vertical_grid(
361 image_desc_t *);
362 void axis_paint(
363 image_desc_t *);
364 void grid_paint(
365 image_desc_t *);
366 int lazy_check(
367 image_desc_t *);
368 int graph_paint(
369 image_desc_t *);
371 int gdes_alloc(
372 image_desc_t *);
373 int scan_for_col(
374 const char *const,
375 int,
376 char *const);
377 void rrd_graph_init(
378 image_desc_t *);
380 void time_clean(
381 char *result,
382 char *format);
384 void rrd_graph_options(
385 int,
386 char **,
387 image_desc_t *);
388 void rrd_graph_script(
389 int,
390 char **,
391 image_desc_t *,
392 int);
393 int rrd_graph_color(
394 image_desc_t *,
395 char *,
396 char *,
397 int);
398 int bad_format(
399 char *);
400 int vdef_parse(
401 struct graph_desc_t *,
402 const char *const);
403 int vdef_calc(
404 image_desc_t *,
405 int);
406 int vdef_percent_compar(
407 const void *,
408 const void *);
409 int graph_size_location(
410 image_desc_t *,
411 int);
414 /* create a new line */
415 void gfx_line(
416 image_desc_t *im,
417 double X0,
418 double Y0,
419 double X1,
420 double Y1,
421 double width,
422 gfx_color_t color);
424 void gfx_dashed_line(
425 image_desc_t *im,
426 double X0,
427 double Y0,
428 double X1,
429 double Y1,
430 double width,
431 gfx_color_t color,
432 double dash_on,
433 double dash_off);
435 /* create a new area */
436 void gfx_new_area(
437 image_desc_t *im,
438 double X0,
439 double Y0,
440 double X1,
441 double Y1,
442 double X2,
443 double Y2,
444 gfx_color_t color);
446 /* add a point to a line or to an area */
447 void gfx_add_point(
448 image_desc_t *im,
449 double x,
450 double y);
452 /* create a rect that has a gradient from color1 to color2 in height pixels
453 * height > 0:
454 * gradient starts at top and goes down a fixed number of pixels (fire style)
455 * height < 0:
456 * gradient starts at bottom and goes up a fixed number of pixels (constant style)
457 * height == 0:
458 * gradient is stretched between two points
459 */
460 void gfx_add_rect_fadey(
461 image_desc_t *im,
462 double x1,double y1,
463 double x2,double y2,
464 double py,
465 gfx_color_t color1,
466 gfx_color_t color2,
467 double height);
471 /* close current path so it ends at the same point as it started */
472 void gfx_close_path(
473 image_desc_t *im);
476 /* create a text node */
477 void gfx_text(
478 image_desc_t *im,
479 double x,
480 double y,
481 gfx_color_t color,
482 PangoFontDescription *font_desc,
483 double tabwidth,
484 double angle,
485 enum gfx_h_align_en h_align,
486 enum gfx_v_align_en v_align,
487 const char *text);
489 /* measure width of a text string */
490 double gfx_get_text_width(
491 image_desc_t *im,
492 double start,
493 PangoFontDescription *font_desc,
494 double tabwidth,
495 char *text);
498 /* convert color */
499 gfx_color_t gfx_hex_to_col(
500 long unsigned int);
502 void gfx_line_fit(
503 image_desc_t *im,
504 double *x,
505 double *y);
507 void gfx_area_fit(
508 image_desc_t *im,
509 double *x,
510 double *y);
512 #endif
514 void grinfo_push(
515 image_desc_t *im,
516 char *key,
517 rrd_info_type_t type, rrd_infoval_t value);