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