1 /****************************************************************************
2 * RRDtool 1.0.28 Copyright Tobias Oetiker, 1997 - 2000
3 ****************************************************************************
4 * rrd_rpncalc.c RPN calculator functions
5 ****************************************************************************/
8 #include "rrd_rpncalc.h"
11 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
12 char **result_str, unsigned short *offset);
13 int tzoffset(time_t); /* used to implement LTIME */
15 short rpn_compact(rpnp_t *rpnp, rpn_cdefds_t **rpnc, short *count)
19 /* count the number of rpn nodes */
20 while(rpnp[*count].op != OP_END) (*count)++;
21 if (++(*count) > DS_CDEF_MAX_RPN_NODES) {
22 rrd_set_error("Maximum %d RPN nodes permitted",
23 DS_CDEF_MAX_RPN_NODES);
28 *rpnc = (rpn_cdefds_t *) calloc(*count,sizeof(rpn_cdefds_t));
29 for (i = 0; rpnp[i].op != OP_END; i++)
31 (*rpnc)[i].op = (char) rpnp[i].op;
32 if (rpnp[i].op == OP_NUMBER) {
33 /* rpnp.val is a double, rpnc.val is a short */
34 double temp = floor(rpnp[i].val);
35 if (temp < SHRT_MIN || temp > SHRT_MAX) {
37 "constants must be integers in the interval (%d, %d)",
42 (*rpnc)[i].val = (short) temp;
43 } else if (rpnp[i].op == OP_VARIABLE) {
44 (*rpnc)[i].val = (short) rpnp[i].ptr;
47 /* terminate the sequence */
48 (*rpnc)[(*count) - 1].op = OP_END;
52 rpnp_t * rpn_expand(rpn_cdefds_t *rpnc)
57 /* DS_CDEF_MAX_RPN_NODES is small, so at the expense of some wasted
58 * memory we avoid any reallocs */
59 rpnp = (rpnp_t *) calloc(DS_CDEF_MAX_RPN_NODES,sizeof(rpnp_t));
60 if (rpnp == NULL) return NULL;
61 for (i = 0; rpnc[i].op != OP_END; ++i)
63 rpnp[i].op = (long) rpnc[i].op;
64 if (rpnp[i].op == OP_NUMBER) {
65 rpnp[i].val = (double) rpnc[i].val;
66 } else if (rpnp[i].op == OP_VARIABLE) {
67 rpnp[i].ptr = (long) rpnc[i].val;
70 /* terminate the sequence */
75 /* rpn_compact2str: convert a compact sequence of RPN operator nodes back
76 * into a CDEF string. This function is used by rrd_dump.
78 * rpnc: an array of compact RPN operator nodes
79 * rrd: a pointer an rrd header (only the ds_cnt and ds_def elements need
80 * to be valid) for lookup of data source names by index
81 * str: out string, memory is allocated by the function, must be freed by the
83 void rpn_compact2str(rpn_cdefds_t *rpnc,ds_def_t *ds_def,char **str)
85 unsigned short i,offset = 0;
86 char buffer[7]; /* short as a string */
88 for (i = 0; rpnc[i].op != OP_END; i++)
90 if (i > 0) (*str)[offset++] = ',';
92 #define add_op(VV,VVV) \
93 if (addop2str(rpnc[i].op, VV, VVV, str, &offset) == 1) continue;
95 if (rpnc[i].op == OP_NUMBER) {
96 /* convert a short into a string */
98 _itoa(rpnc[i].val,buffer,10);
100 sprintf(buffer,"%d",rpnc[i].val);
102 add_op(OP_NUMBER,buffer)
105 if (rpnc[i].op == OP_VARIABLE) {
106 char *ds_name = ds_def[rpnc[i].val].ds_nam;
107 add_op(OP_VARIABLE, ds_name)
111 #define add_op(VV,VVV) \
112 if (addop2str(rpnc[i].op, VV, #VVV, str, &offset) == 1) continue;
122 add_op(OP_FLOOR,FLOOR)
136 add_op(OP_LIMIT,LIMIT)
139 add_op(OP_NEGINF,NEGINF)
143 add_op(OP_LTIME,LTIME)
148 (*str)[offset] = '\0';
152 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
153 char **result_str, unsigned short *offset)
157 op_len = strlen(op_str);
158 *result_str = (char *) rrd_realloc(*result_str,
159 (op_len + 1 + *offset)*sizeof(char));
160 if (*result_str == NULL) {
161 rrd_set_error("failed to alloc memory in addop2str");
164 strncpy(&((*result_str)[*offset]),op_str,op_len);
171 void parseCDEF_DS(char *def,rrd_t *rrd, int ds_idx)
174 rpn_cdefds_t *rpnc = NULL;
177 rpnp = rpn_parse((void*) rrd, def, &lookup_DS);
179 rrd_set_error("failed to parse computed data source %s", def);
182 /* Check for OP nodes not permitted in COMPUTE DS.
183 * Moved this check from within rpn_compact() because it really is
184 * COMPUTE DS specific. This is less efficient, but creation doesn't
185 * occur too often. */
186 for (i = 0; rpnp[i].op != OP_END; i++) {
187 if (rpnp[i].op == OP_TIME || rpnp[i].op == OP_LTIME ||
188 rpnp[i].op == OP_PREV)
191 "operators time, ltime and prev not supported with DS COMPUTE");
196 if (rpn_compact(rpnp,&rpnc,&count) == -1) {
200 /* copy the compact rpn representation over the ds_def par array */
201 memcpy((void*) &(rrd -> ds_def[ds_idx].par[DS_cdef]),
202 (void*) rpnc, count*sizeof(rpn_cdefds_t));
207 /* lookup a data source name in the rrd struct and return the index,
208 * should use ds_match() here except:
209 * (1) need a void * pointer to the rrd
210 * (2) error handling is left to the caller
212 long lookup_DS(void *rrd_vptr,char *ds_name)
217 rrd = (rrd_t *) rrd_vptr;
219 for (i = 0; i < rrd -> stat_head -> ds_cnt; ++i)
221 if(strcmp(ds_name,rrd -> ds_def[i].ds_nam) == 0)
224 /* the caller handles a bad data source name in the rpn string */
228 /* rpn_parse : parse a string and generate a rpnp array; modified
229 * str2rpn() originally included in rrd_graph.c
231 * key_hash: a transparent argument passed to lookup(); conceptually this
232 * is a hash object for lookup of a numeric key given a variable name
233 * expr: the string RPN expression, including variable names
234 * lookup(): a function that retrieves a numeric key given a variable name
237 rpn_parse(void *key_hash,char *expr,long (*lookup)(void *,char*)){
246 if ((rpnp = (rpnp_t *) rrd_realloc(rpnp, (++steps + 2)*
247 sizeof(rpnp_t)))==NULL){
251 else if((sscanf(expr,"%lf%n",&rpnp[steps].val,&pos) == 1) && (expr[pos] == ',')){
252 rpnp[steps].op = OP_NUMBER;
256 #define match_op(VV,VVV) \
257 else if (strncmp(expr, #VVV, strlen(#VVV))==0){ \
258 rpnp[steps].op = VV; \
259 expr+=strlen(#VVV); \
270 match_op(OP_FLOOR,FLOOR)
271 match_op(OP_CEIL,CEIL)
284 match_op(OP_LIMIT,LIMIT)
285 /* order is important here ! .. match longest first */
286 match_op(OP_UNKN,UNKN)
288 match_op(OP_NEGINF,NEGINF)
289 match_op(OP_PREV,PREV)
292 match_op(OP_LTIME,LTIME)
293 match_op(OP_TIME,TIME)
298 else if ((sscanf(expr,"%29[_A-Za-z0-9]%n",
300 && ((rpnp[steps].ptr = (*lookup)(key_hash,vname)) != -1)){
301 rpnp[steps].op = OP_VARIABLE;
318 rpnp[steps+1].op = OP_END;
323 rpnstack_init(rpnstack_t *rpnstack)
325 rpnstack -> s = NULL;
326 rpnstack -> dc_stacksize = 0;
327 rpnstack -> dc_stackblock = 100;
331 rpnstack_free(rpnstack_t *rpnstack)
333 if (rpnstack -> s != NULL)
335 rpnstack -> dc_stacksize = 0;
338 /* rpn_calc: run the RPN calculator; also performs variable substitution;
339 * moved and modified from data_calc() originally included in rrd_graph.c
341 * rpnp : an array of RPN operators (including variable references)
342 * rpnstack : the initialized stack
343 * data_idx : when data_idx is a multiple of rpnp.step, the rpnp.data pointer
344 * is advanced by rpnp.ds_cnt; used only for variable substitution
345 * output : an array of output values; OP_PREV assumes this array contains
346 * the "previous" value at index position output_idx-1; the definition of
347 * "previous" depends on the calling environment
348 * output_idx : an index into the output array in which to store the output
349 * of the RPN calculator
350 * returns: -1 if the computation failed (also calls rrd_set_error)
354 rpn_calc(rpnp_t *rpnp, rpnstack_t *rpnstack, long data_idx,
355 rrd_value_t *output, int output_idx)
360 /* process each op from the rpn in turn */
361 for (rpi=0; rpnp[rpi].op != OP_END; rpi++){
362 /* allocate or grow the stack */
363 if (stptr + 5 > rpnstack -> dc_stacksize){
364 /* could move this to a separate function */
365 rpnstack -> dc_stacksize += rpnstack -> dc_stackblock;
366 rpnstack -> s = rrd_realloc(rpnstack -> s,
367 (rpnstack -> dc_stacksize)*sizeof(*(rpnstack -> s)));
368 if (rpnstack -> s == NULL){
369 rrd_set_error("RPN stack overflow");
373 switch (rpnp[rpi].op){
375 rpnstack -> s[++stptr] = rpnp[rpi].val;
378 /* Sanity check: VDEFs shouldn't make it here */
379 if (rpnp[rpi].ds_cnt == 0) {
380 rrd_set_error("VDEF made it into rpn_calc... aborting");
383 /* make sure we pull the correct value from
384 * the *.data array. Adjust the pointer into
385 * the array acordingly. Advance the ptr one
386 * row in the rra (skip over non-relevant
389 if (data_idx % rpnp[rpi].step == 0){
390 rpnp[rpi].data += rpnp[rpi].ds_cnt;
392 rpnstack -> s[++stptr] = *(rpnp[rpi].data);
396 if ((output_idx-1) <= 0) {
397 rpnstack -> s[++stptr] = DNAN;
399 rpnstack -> s[++stptr] = output[output_idx-1];
403 rpnstack -> s[++stptr] = DNAN;
406 rpnstack -> s[++stptr] = DINF;
409 rpnstack -> s[++stptr] = -DINF;
412 rpnstack -> s[++stptr] = (double)time(NULL);
415 /* HACK: this relies on the data_idx being the time,
416 * which the within-function scope is unaware of */
417 rpnstack -> s[++stptr] = (double) data_idx;
420 rpnstack -> s[++stptr] = (double) tzoffset(data_idx) + (double)data_idx;
424 rrd_set_error("RPN stack underflow");
427 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
428 + rpnstack -> s[stptr];
433 rrd_set_error("RPN stack underflow");
436 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] - rpnstack -> s[stptr];
441 rrd_set_error("RPN stack underflow");
444 rpnstack -> s[stptr-1] = (rpnstack -> s[stptr-1]) * (rpnstack -> s[stptr]);
449 rrd_set_error("RPN stack underflow");
452 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] / rpnstack -> s[stptr];
457 rrd_set_error("RPN stack underflow");
460 rpnstack -> s[stptr-1] = fmod(rpnstack -> s[stptr-1],rpnstack -> s[stptr]);
465 rrd_set_error("RPN stack underflow");
468 rpnstack -> s[stptr] = sin(rpnstack -> s[stptr]);
472 rrd_set_error("RPN stack underflow");
475 rpnstack -> s[stptr] = cos(rpnstack -> s[stptr]);
479 rrd_set_error("RPN stack underflow");
482 rpnstack -> s[stptr] = ceil(rpnstack -> s[stptr]);
486 rrd_set_error("RPN stack underflow");
489 rpnstack -> s[stptr] = floor(rpnstack -> s[stptr]);
493 rrd_set_error("RPN stack underflow");
496 rpnstack -> s[stptr] = log(rpnstack -> s[stptr]);
500 rrd_set_error("RPN stack underflow");
503 rpnstack -> s[stptr+1] = rpnstack -> s[stptr];
508 rrd_set_error("RPN stack underflow");
515 rrd_set_error("RPN stack underflow");
519 dummy = rpnstack -> s[stptr] ;
520 rpnstack -> s[stptr] = rpnstack -> s[stptr-1];
521 rpnstack -> s[stptr-1] = dummy;
526 rrd_set_error("RPN stack underflow");
529 rpnstack -> s[stptr] = exp(rpnstack -> s[stptr]);
533 rrd_set_error("RPN stack underflow");
536 if (isnan(rpnstack -> s[stptr-1]))
538 else if (isnan(rpnstack -> s[stptr]))
539 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
541 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] < rpnstack -> s[stptr] ? 1.0 : 0.0;
546 rrd_set_error("RPN stack underflow");
549 if (isnan(rpnstack -> s[stptr-1]))
551 else if (isnan(rpnstack -> s[stptr]))
552 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
554 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] <= rpnstack -> s[stptr] ? 1.0 : 0.0;
559 rrd_set_error("RPN stack underflow");
562 if (isnan(rpnstack -> s[stptr-1]))
564 else if (isnan(rpnstack -> s[stptr]))
565 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
567 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] > rpnstack -> s[stptr] ? 1.0 : 0.0;
572 rrd_set_error("RPN stack underflow");
575 if (isnan(rpnstack -> s[stptr-1]))
577 else if (isnan(rpnstack -> s[stptr]))
578 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
580 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >= rpnstack -> s[stptr] ? 1.0 : 0.0;
585 rrd_set_error("RPN stack underflow");
588 if (isnan(rpnstack -> s[stptr-1]))
590 else if (isnan(rpnstack -> s[stptr]))
591 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
593 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] == rpnstack -> s[stptr] ? 1.0 : 0.0;
598 rrd_set_error("RPN stack underflow");
601 rpnstack->s[stptr-2] = rpnstack->s[stptr-2] != 0.0 ? rpnstack->s[stptr-1] : rpnstack->s[stptr];
607 rrd_set_error("RPN stack underflow");
610 if (isnan(rpnstack->s[stptr-1]))
612 else if (isnan(rpnstack->s[stptr]))
613 rpnstack->s[stptr-1] = rpnstack->s[stptr];
614 else if (rpnstack->s[stptr-1] > rpnstack->s[stptr])
615 rpnstack->s[stptr-1] = rpnstack->s[stptr];
620 rrd_set_error("RPN stack underflow");
623 if (isnan(rpnstack->s[stptr-1]))
625 else if (isnan(rpnstack->s[stptr]))
626 rpnstack->s[stptr-1] = rpnstack->s[stptr];
627 else if (rpnstack->s[stptr-1] < rpnstack->s[stptr])
628 rpnstack->s[stptr-1] = rpnstack->s[stptr];
633 rrd_set_error("RPN stack underflow");
637 if (isnan(rpnstack->s[stptr-2]))
639 else if (isnan(rpnstack->s[stptr-1]))
640 rpnstack->s[stptr-2] = rpnstack->s[stptr-1];
641 else if (isnan(rpnstack->s[stptr]))
642 rpnstack->s[stptr-2] = rpnstack->s[stptr];
643 else if (rpnstack->s[stptr-2] < rpnstack->s[stptr-1])
644 rpnstack->s[stptr-2] = DNAN;
645 else if (rpnstack->s[stptr-2] > rpnstack->s[stptr])
646 rpnstack->s[stptr-2] = DNAN;
651 rrd_set_error("RPN stack underflow");
654 rpnstack->s[stptr] = isnan(rpnstack->s[stptr]) ? 1.0 : 0.0;
661 rrd_set_error("RPN final stack size != 1");
665 output[output_idx] = rpnstack->s[0];
669 /* figure out what the local timezone offset for any point in
670 time was. Return it in seconds */
672 tzoffset( time_t now ){
673 int gm_sec, gm_min, gm_hour, gm_yday, gm_year,
674 l_sec, l_min, l_hour, l_yday, l_year;
680 gm_hour = t->tm_hour;
681 gm_yday = t->tm_yday;
682 gm_year = t->tm_year;
689 off = (l_sec-gm_sec)+(l_min-gm_min)*60+(l_hour-gm_hour)*3600;
690 if ( l_yday > gm_yday || l_year > gm_year){
692 } else if ( l_yday < gm_yday || l_year < gm_year){