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