1 #include "rrd_tool.h"
2 #include "rrd_rpncalc.h"
3 #include "rrd_gfx.h"
5 #define MAX_VNAME_LEN 29
6 #define DEF_NAM_FMT "%29[_A-Za-z0-9]"
8 #define ALTYGRID 0x01 /* use alternative y grid algorithm */
9 #define ALTAUTOSCALE 0x02 /* use alternative algorithm to find lower and upper bounds */
10 #define ALTAUTOSCALE_MAX 0x04 /* use alternative algorithm to find upper bounds */
11 #define NOLEGEND 0x08 /* use no legend */
14 enum tmt_en {TMT_SECOND=0,TMT_MINUTE,TMT_HOUR,TMT_DAY,
15 TMT_WEEK,TMT_MONTH,TMT_YEAR};
17 enum grc_en {GRC_CANVAS=0,GRC_BACK,GRC_SHADEA,GRC_SHADEB,
18 GRC_GRID,GRC_MGRID,GRC_FONT,GRC_FRAME,GRC_ARROW,__GRC_END__};
20 #define MGRIDWIDTH 0.6
21 #define GRIDWIDTH 0.4
23 enum gf_en {GF_PRINT=0,GF_GPRINT,GF_COMMENT,GF_HRULE,GF_VRULE,GF_LINE,
24 GF_AREA,GF_STACK,GF_TICK,
25 GF_DEF, GF_CDEF, GF_VDEF};
27 enum if_en {IF_GIF=0,IF_PNG=1};
29 enum vdef_op_en {
30 VDEF_MAXIMUM /* like the MAX in (G)PRINT */
31 ,VDEF_MINIMUM /* like the MIN in (G)PRINT */
32 ,VDEF_AVERAGE /* like the AVERAGE in (G)PRINT */
33 ,VDEF_PERCENT /* Nth percentile */
34 ,VDEF_TOTAL /* average multiplied by time */
35 ,VDEF_FIRST /* first non-unknown value and time */
36 ,VDEF_LAST /* last non-unknown value and time */
37 };
38 enum text_prop_en { TEXT_PROP_DEFAULT=0, /* default settings */
39 TEXT_PROP_TITLE, /* properties for the title */
40 TEXT_PROP_AXIS, /* for the numbers next to the axis */
41 TEXT_PROP_UNIT, /* for the vertical unit description */
42 TEXT_PROP_LEGEND, /* fot the legend below the graph */
43 TEXT_PROP_LAST };
45 typedef struct text_prop_t {
46 double size;
47 char * font;
48 } text_prop_t;
51 typedef struct vdef_t {
52 enum vdef_op_en op;
53 double param; /* parameter for function, if applicable */
54 double val; /* resulting value */
55 time_t when; /* timestamp, if applicable */
56 } vdef_t;
58 typedef struct xlab_t {
59 long minsec; /* minimum sec per pix */
60 enum tmt_en gridtm; /* grid interval in what ?*/
61 long gridst; /* how many whats per grid*/
62 enum tmt_en mgridtm; /* label interval in what ?*/
63 long mgridst; /* how many whats per label*/
64 enum tmt_en labtm; /* label interval in what ?*/
65 long labst; /* how many whats per label*/
66 long precis; /* label precision -> label placement*/
67 char *stst; /* strftime string*/
68 } xlab_t;
70 /* sensible y label intervals ...*/
72 typedef struct ylab_t {
73 double grid; /* grid spacing */
74 int lfac[4]; /* associated label spacing*/
75 } ylab_t;
78 /* this structure describes the elements which can make up a graph.
79 because they are quite diverse, not all elements will use all the
80 possible parts of the structure. */
81 #ifdef HAVE_SNPRINTF
82 #define FMT_LEG_LEN 200
83 #else
84 #define FMT_LEG_LEN 2000
85 #endif
87 typedef struct graph_desc_t {
88 enum gf_en gf; /* graphing function */
89 char vname[MAX_VNAME_LEN+1]; /* name of the variable */
90 long vidx; /* gdes reference */
91 char rrd[255]; /* name of the rrd_file containing data */
92 char ds_nam[DS_NAM_SIZE]; /* data source name */
93 long ds; /* data source number */
94 enum cf_en cf; /* consolidation function */
95 gfx_color_t col; /* graph color */
96 char format[FMT_LEG_LEN+5]; /* format for PRINT AND GPRINT */
97 char legend[FMT_LEG_LEN+5]; /* legend*/
98 double leg_x,leg_y; /* location of legend */
99 double yrule; /* value for y rule line and for VDEF */
100 time_t xrule; /* time for x rule line and for VDEF */
101 vdef_t vf; /* instruction for VDEF function */
102 rpnp_t *rpnp; /* instructions for CDEF function */
104 /* description of data fetched for the graph element */
105 time_t start,end; /* timestaps for first and last data element */
106 unsigned long step; /* time between samples */
107 unsigned long ds_cnt; /* how many data sources are there in the fetch */
108 long data_first; /* first pointer to this data */
109 char **ds_namv; /* name of datasources in the fetch. */
110 rrd_value_t *data; /* the raw data drawn from the rrd */
111 rrd_value_t *p_data; /* processed data, xsize elments */
112 double linewidth; /* linewideth */
113 } graph_desc_t;
115 typedef struct image_desc_t {
117 /* configuration of graph */
119 char graphfile[MAXPATH]; /* filename for graphic */
120 long xsize,ysize; /* graph area size in pixels */
121 double zoom; /* zoom for graph */
122 gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
123 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
124 char ylegend[200]; /* legend along the yaxis */
125 char title[200]; /* title for graph */
126 int draw_x_grid; /* no x-grid at all */
127 int draw_y_grid; /* no x-grid at all */
128 xlab_t xlab_user; /* user defined labeling for xaxis */
129 char xlab_form[200]; /* format for the label on the xaxis */
131 double ygridstep; /* user defined step for y grid */
132 int ylabfact; /* every how many y grid shall a label be written ? */
133 double tabwidth; /* tabwdith */
134 time_t start,end; /* what time does the graph cover */
135 unsigned long step; /* any preference for the default step ? */
136 rrd_value_t minval,maxval; /* extreme values in the data */
137 int rigid; /* do not expand range even with
138 values outside */
139 char* imginfo; /* construct an <IMG ... tag and return
140 as first retval */
141 int lazy; /* only update the gif if there is reasonable
142 probablility that the existing one is out of date */
143 int logarithmic; /* scale the yaxis logarithmic */
144 enum if_en imgformat; /* image format */
146 /* status information */
148 long xorigin,yorigin;/* where is (0,0) of the graph */
149 long xgif,ygif; /* total size of the gif */
150 int interlaced; /* will the graph be interlaced? */
151 double magfact; /* numerical magnitude*/
152 long base; /* 1000 or 1024 depending on what we graph */
153 char symbol; /* magnitude symbol for y-axis */
154 int unitsexponent; /* 10*exponent for units on y-asis */
155 int extra_flags; /* flags for boolean options */
156 /* data elements */
158 long prt_c; /* number of print elements */
159 long gdes_c; /* number of graphics elements */
160 graph_desc_t *gdes; /* points to an array of graph elements */
162 } image_desc_t;
164 /* Prototypes */
165 int xtr(image_desc_t *,time_t);
166 int ytr(image_desc_t *, double);
167 enum gf_en gf_conv(char *);
168 enum if_en if_conv(char *);
169 enum tmt_en tmt_conv(char *);
170 enum grc_en grc_conv(char *);
171 enum grc_en text_prop_conv(char *);
172 int im_free(image_desc_t *);
173 void auto_scale( image_desc_t *, double *, char **, double *);
174 void si_unit( image_desc_t *);
175 void expand_range(image_desc_t *);
176 void reduce_data( enum cf_en, unsigned long, time_t *, time_t *, unsigned long *, unsigned long *, rrd_value_t **);
177 int data_fetch( image_desc_t *);
178 long find_var(image_desc_t *, char *);
179 long find_var_wrapper(void *arg1, char *key);
180 long lcd(long *);
181 int data_calc( image_desc_t *);
182 int data_proc( image_desc_t *);
183 time_t find_first_time( time_t, enum tmt_en, long);
184 time_t find_next_time( time_t, enum tmt_en, long);
185 int print_calc(image_desc_t *, char ***);
186 int leg_place(image_desc_t *);
187 int horizontal_grid(gfx_canvas_t *,image_desc_t *);
188 int horizontal_log_grid(gfx_canvas_t *, image_desc_t *);
189 void vertical_grid(gfx_canvas_t *, image_desc_t *);
190 void axis_paint( image_desc_t *, gfx_canvas_t *);
191 void grid_paint( image_desc_t *, gfx_canvas_t *);
192 int lazy_check(image_desc_t *);
193 int graph_paint(image_desc_t *, char ***);
194 int gdes_alloc(image_desc_t *);
195 int scan_for_col(char *, int, char *);
196 int rrd_graph(int, char **, char ***, int *, int *);
197 void rrd_graph_init(image_desc_t *);
198 void rrd_graph_options(int, char **, image_desc_t *);
199 void rrd_graph_script(int, char **, image_desc_t *);
200 int rrd_graph_check_vname(image_desc_t *, char *, char *);
201 int rrd_graph_check_CF(image_desc_t *, char *, char *);
202 int rrd_graph_color(image_desc_t *, char *, char *, int);
203 int rrd_graph_legend(graph_desc_t *, char *);
204 int bad_format(char *);
205 int vdef_parse(struct graph_desc_t *,char *);
206 int vdef_calc(image_desc_t *, int);
207 int vdef_percent_compar(const void *,const void *);