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