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