1 #ifndef _RRD_GRAPH_H
2 #define _RRD_GRAPH_H
4 #include "rrd_tool.h"
5 #include "rrd_rpncalc.h"
6 #include "rrd_gfx.h"
8 #define MAX_VNAME_LEN 255
9 #define DEF_NAM_FMT "%255[-_A-Za-z0-9]"
11 #define ALTYGRID 0x01 /* use alternative y grid algorithm */
12 #define ALTAUTOSCALE 0x02 /* use alternative algorithm to find lower and upper bounds */
13 #define ALTAUTOSCALE_MIN 0x04 /* use alternative algorithm to find lower bounds */
14 #define ALTAUTOSCALE_MAX 0x08 /* use alternative algorithm to find upper bounds */
15 #define NOLEGEND 0x10 /* use no legend */
16 #define NOMINOR 0x20 /* Turn off minor gridlines */
17 #define ONLY_GRAPH 0x40 /* use only graph */
18 #define FORCE_RULES_LEGEND 0x80 /* force printing of HRULE and VRULE legend */
20 #define FORCE_UNITS 0x100 /* mask for all FORCE_UNITS_* flags */
21 #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) */
23 enum tmt_en { TMT_SECOND = 0, TMT_MINUTE, TMT_HOUR, TMT_DAY,
24 TMT_WEEK, TMT_MONTH, TMT_YEAR
25 };
27 enum grc_en { GRC_CANVAS = 0, GRC_BACK, GRC_SHADEA, GRC_SHADEB,
28 GRC_GRID, GRC_MGRID, GRC_FONT, GRC_ARROW, GRC_AXIS, GRC_FRAME, __GRC_END__
29 };
31 #define MGRIDWIDTH 0.6
32 #define GRIDWIDTH 0.4
34 enum gf_en { GF_PRINT = 0, GF_GPRINT, GF_COMMENT, GF_HRULE, GF_VRULE, GF_LINE,
35 GF_AREA, GF_STACK, GF_TICK,
36 GF_DEF, GF_CDEF, GF_VDEF, GF_SHIFT,
37 #ifdef WITH_PIECHART
38 GF_PART,
39 #endif
40 GF_XPORT
41 };
43 enum vdef_op_en {
44 VDEF_MAXIMUM = 0 /* like the MAX in (G)PRINT */
45 , VDEF_MINIMUM /* like the MIN in (G)PRINT */
46 , VDEF_AVERAGE /* like the AVERAGE in (G)PRINT */
47 , VDEF_PERCENT /* Nth percentile */
48 , VDEF_TOTAL /* average multiplied by time */
49 , VDEF_FIRST /* first non-unknown value and time */
50 , VDEF_LAST /* last non-unknown value and time */
51 , VDEF_LSLSLOPE /* least squares line slope */
52 , VDEF_LSLINT /* least squares line y_intercept */
53 , VDEF_LSLCORREL /* least squares line correlation coefficient */
54 };
55 enum text_prop_en { TEXT_PROP_DEFAULT = 0, /* default settings */
56 TEXT_PROP_TITLE, /* properties for the title */
57 TEXT_PROP_AXIS, /* for the numbers next to the axis */
58 TEXT_PROP_UNIT, /* for the vertical unit description */
59 TEXT_PROP_LEGEND, /* fot the legend below the graph */
60 TEXT_PROP_LAST
61 };
63 typedef struct text_prop_t {
64 double size;
65 char font[1024];
66 } text_prop_t;
69 typedef struct vdef_t {
70 enum vdef_op_en op;
71 double param; /* parameter for function, if applicable */
72 double val; /* resulting value */
73 time_t when; /* timestamp, if applicable */
74 } vdef_t;
76 typedef struct xlab_t {
77 long minsec; /* minimum sec per pix */
78 long length; /* number of secs on the image */
79 enum tmt_en gridtm; /* grid interval in what ? */
80 long gridst; /* how many whats per grid */
81 enum tmt_en mgridtm; /* label interval in what ? */
82 long mgridst; /* how many whats per label */
83 enum tmt_en labtm; /* label interval in what ? */
84 long labst; /* how many whats per label */
85 long precis; /* label precision -> label placement */
86 char *stst; /* strftime string */
87 } xlab_t;
89 typedef struct ygrid_scale_t { /* y axis grid scaling info */
90 double gridstep;
91 int labfact;
92 char labfmt[64];
93 } ygrid_scale_t;
95 /* sensible y label intervals ...*/
97 typedef struct ylab_t {
98 double grid; /* grid spacing */
99 int lfac[4]; /* associated label spacing */
100 } ylab_t;
103 /* this structure describes the elements which can make up a graph.
104 because they are quite diverse, not all elements will use all the
105 possible parts of the structure. */
106 #ifdef HAVE_SNPRINTF
107 #define FMT_LEG_LEN 200
108 #else
109 #define FMT_LEG_LEN 2000
110 #endif
112 typedef struct graph_desc_t {
113 enum gf_en gf; /* graphing function */
114 int stack; /* boolean */
115 int debug; /* boolean */
116 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
117 long vidx; /* gdes reference */
118 char rrd[1024]; /* name of the rrd_file containing data */
119 char ds_nam[DS_NAM_SIZE]; /* data source name */
120 long ds; /* data source number */
121 enum cf_en cf; /* consolidation function */
122 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
123 gfx_color_t col; /* graph color */
124 char format[FMT_LEG_LEN + 5]; /* format for PRINT AND GPRINT */
125 char legend[FMT_LEG_LEN + 5]; /* legend */
126 int strftm; /* should the VDEF legend be formated with strftime */
127 double leg_x, leg_y; /* location of legend */
128 double yrule; /* value for y rule line and for VDEF */
129 time_t xrule; /* time for x rule line and for VDEF */
130 vdef_t vf; /* instruction for VDEF function */
131 rpnp_t *rpnp; /* instructions for CDEF function */
133 /* SHIFT implementation */
134 int shidx; /* gdes reference for offset (-1 --> constant) */
135 time_t shval; /* offset if shidx is -1 */
136 time_t shift; /* current shift applied */
138 /* description of data fetched for the graph element */
139 time_t start, end; /* timestaps for first and last data element */
140 time_t start_orig, end_orig; /* timestaps for first and last data element */
141 unsigned long step; /* time between samples */
142 unsigned long step_orig; /* time between samples */
143 unsigned long ds_cnt; /* how many data sources are there in the fetch */
144 long data_first; /* first pointer to this data */
145 char **ds_namv; /* name of datasources in the fetch. */
146 rrd_value_t *data; /* the raw data drawn from the rrd */
147 rrd_value_t *p_data; /* processed data, xsize elments */
148 double linewidth; /* linewideth */
149 } graph_desc_t;
151 typedef struct image_desc_t {
153 /* configuration of graph */
155 char graphfile[MAXPATH]; /* filename for graphic */
156 FILE *graphhandle; /* FILE to use if filename is "-" */
157 long xsize, ysize; /* graph area size in pixels */
158 #ifdef WITH_PIECHART
159 long piesize; /* size of the piechart */
160 #endif
161 gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
162 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
163 char ylegend[210]; /* legend along the yaxis */
164 char title[210]; /* title for graph */
165 char watermark[110]; /* watermark for graph */
166 int draw_x_grid; /* no x-grid at all */
167 int draw_y_grid; /* no x-grid at all */
168 double grid_dash_on, grid_dash_off;
169 xlab_t xlab_user; /* user defined labeling for xaxis */
170 char xlab_form[210]; /* format for the label on the xaxis */
172 double ygridstep; /* user defined step for y grid */
173 int ylabfact; /* every how many y grid shall a label be written ? */
174 double tabwidth; /* tabwdith */
175 time_t start, end; /* what time does the graph cover */
176 unsigned long step; /* any preference for the default step ? */
177 rrd_value_t minval, maxval; /* extreme values in the data */
178 int rigid; /* do not expand range even with
179 values outside */
180 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
181 int gridfit; /* adjust y-axis range etc so all
182 grindlines falls in integer pixel values */
183 char *imginfo; /* construct an <IMG ... tag and return
184 as first retval */
185 int lazy; /* only update the image if there is
186 reasonable probablility that the
187 existing one is out of date */
188 int slopemode; /* connect the dots of the curve directly, not using a stair */
189 int logarithmic; /* scale the yaxis logarithmic */
191 /* status information */
193 long xorigin, yorigin; /* where is (0,0) of the graph */
194 #ifdef WITH_PIECHART
195 long pie_x, pie_y; /* where is the centerpoint */
196 #endif
197 long ximg, yimg; /* total size of the image */
198 double magfact; /* numerical magnitude */
199 long base; /* 1000 or 1024 depending on what we graph */
200 char symbol; /* magnitude symbol for y-axis */
201 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
202 int unitsexponent; /* 10*exponent for units on y-asis */
203 int unitslength; /* width of the yaxis labels */
204 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
206 int extra_flags; /* flags for boolean options */
207 /* data elements */
209 long prt_c; /* number of print elements */
210 long gdes_c; /* number of graphics elements */
211 graph_desc_t *gdes; /* points to an array of graph elements */
212 gfx_canvas_t *canvas; /* graphics library */
213 } image_desc_t;
215 /* Prototypes */
216 int xtr(
217 image_desc_t *,
218 time_t);
219 double ytr(
220 image_desc_t *,
221 double);
222 enum gf_en gf_conv(
223 char *);
224 enum gfx_if_en if_conv(
225 char *);
226 enum tmt_en tmt_conv(
227 char *);
228 enum grc_en grc_conv(
229 char *);
230 enum text_prop_en text_prop_conv(
231 char *);
232 int im_free(
233 image_desc_t *);
234 void auto_scale(
235 image_desc_t *,
236 double *,
237 char **,
238 double *);
239 void si_unit(
240 image_desc_t *);
241 void expand_range(
242 image_desc_t *);
243 void apply_gridfit(
244 image_desc_t *);
245 void reduce_data(
246 enum cf_en,
247 unsigned long,
248 time_t *,
249 time_t *,
250 unsigned long *,
251 unsigned long *,
252 rrd_value_t **);
253 int data_fetch(
254 image_desc_t *);
255 long find_var(
256 image_desc_t *,
257 char *);
258 long find_var_wrapper(
259 void *arg1,
260 char *key);
261 long lcd(
262 long *);
263 int data_calc(
264 image_desc_t *);
265 int data_proc(
266 image_desc_t *);
267 time_t find_first_time(
268 time_t,
269 enum tmt_en,
270 long);
271 time_t find_next_time(
272 time_t,
273 enum tmt_en,
274 long);
275 int print_calc(
276 image_desc_t *,
277 char ***);
278 int leg_place(
279 image_desc_t *);
280 int calc_horizontal_grid(
281 image_desc_t *);
282 int draw_horizontal_grid(
283 image_desc_t *);
284 int horizontal_log_grid(
285 image_desc_t *);
286 void vertical_grid(
287 image_desc_t *);
288 void axis_paint(
289 image_desc_t *);
290 void grid_paint(
291 image_desc_t *);
292 int lazy_check(
293 image_desc_t *);
294 int graph_paint(
295 image_desc_t *,
296 char ***);
298 #ifdef WITH_PIECHART
299 void pie_part(
300 image_desc_t *,
301 gfx_color_t,
302 double,
303 double,
304 double,
305 double,
306 double);
307 #endif
308 int gdes_alloc(
309 image_desc_t *);
310 int scan_for_col(
311 const char *const,
312 int,
313 char *const);
314 int rrd_graph(
315 int,
316 char **,
317 char ***,
318 int *,
319 int *,
320 FILE *,
321 double *,
322 double *);
323 void rrd_graph_init(
324 image_desc_t *);
325 void rrd_graph_options(
326 int,
327 char **,
328 image_desc_t *);
329 void rrd_graph_script(
330 int,
331 char **,
332 image_desc_t *,
333 int);
334 int rrd_graph_color(
335 image_desc_t *,
336 char *,
337 char *,
338 int);
339 int bad_format(
340 char *);
341 int vdef_parse(
342 struct graph_desc_t *,
343 const char *const);
344 int vdef_calc(
345 image_desc_t *,
346 int);
347 int vdef_percent_compar(
348 const void *,
349 const void *);
350 int graph_size_location(
351 image_desc_t *,
352 int
353 #ifdef WITH_PIECHART
354 ,
355 int
356 #endif
357 );
359 #endif