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