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