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