1 /****************************************************************************
2 * RRDtool 1.0.28 Copyright Tobias Oetiker, 1997 - 2002
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 rpnp[i].op == OP_PREV_OTHER) {
45 (*rpnc)[i].val = (short) rpnp[i].ptr;
48 /* terminate the sequence */
49 (*rpnc)[(*count) - 1].op = OP_END;
53 rpnp_t * rpn_expand(rpn_cdefds_t *rpnc)
58 /* DS_CDEF_MAX_RPN_NODES is small, so at the expense of some wasted
59 * memory we avoid any reallocs */
60 rpnp = (rpnp_t *) calloc(DS_CDEF_MAX_RPN_NODES,sizeof(rpnp_t));
61 if (rpnp == NULL) return NULL;
62 for (i = 0; rpnc[i].op != OP_END; ++i)
64 rpnp[i].op = (long) rpnc[i].op;
65 if (rpnp[i].op == OP_NUMBER) {
66 rpnp[i].val = (double) rpnc[i].val;
67 } else if (rpnp[i].op == OP_VARIABLE ||
68 rpnp[i].op == OP_PREV_OTHER) {
69 rpnp[i].ptr = (long) rpnc[i].val;
72 /* terminate the sequence */
77 /* rpn_compact2str: convert a compact sequence of RPN operator nodes back
78 * into a CDEF string. This function is used by rrd_dump.
80 * rpnc: an array of compact RPN operator nodes
81 * ds_def: a pointer to the data source definition section of an RRD header
82 * for lookup of data source names by index
83 * str: out string, memory is allocated by the function, must be freed by the
85 void rpn_compact2str(rpn_cdefds_t *rpnc,ds_def_t *ds_def,char **str)
87 unsigned short i,offset = 0;
88 char buffer[7]; /* short as a string */
90 for (i = 0; rpnc[i].op != OP_END; i++)
92 if (i > 0) (*str)[offset++] = ',';
94 #define add_op(VV,VVV) \
95 if (addop2str(rpnc[i].op, VV, VVV, str, &offset) == 1) continue;
97 if (rpnc[i].op == OP_NUMBER) {
98 /* convert a short into a string */
100 _itoa(rpnc[i].val,buffer,10);
102 sprintf(buffer,"%d",rpnc[i].val);
104 add_op(OP_NUMBER,buffer)
107 if (rpnc[i].op == OP_VARIABLE) {
108 char *ds_name = ds_def[rpnc[i].val].ds_nam;
109 add_op(OP_VARIABLE, ds_name)
112 if (rpnc[i].op == OP_PREV_OTHER) {
113 char *ds_name = ds_def[rpnc[i].val].ds_nam;
114 add_op(OP_VARIABLE, ds_name)
119 #define add_op(VV,VVV) \
120 if (addop2str(rpnc[i].op, VV, #VVV, str, &offset) == 1) continue;
130 add_op(OP_FLOOR,FLOOR)
144 add_op(OP_LIMIT,LIMIT)
147 add_op(OP_NEGINF,NEGINF)
151 add_op(OP_ISINF,ISINF)
153 add_op(OP_LTIME,LTIME)
158 (*str)[offset] = '\0';
162 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
163 char **result_str, unsigned short *offset)
167 op_len = strlen(op_str);
168 *result_str = (char *) rrd_realloc(*result_str,
169 (op_len + 1 + *offset)*sizeof(char));
170 if (*result_str == NULL) {
171 rrd_set_error("failed to alloc memory in addop2str");
174 strncpy(&((*result_str)[*offset]),op_str,op_len);
181 void parseCDEF_DS(char *def,rrd_t *rrd, int ds_idx)
184 rpn_cdefds_t *rpnc = NULL;
187 rpnp = rpn_parse((void*) rrd, def, &lookup_DS);
189 rrd_set_error("failed to parse computed data source %s", def);
192 /* Check for OP nodes not permitted in COMPUTE DS.
193 * Moved this check from within rpn_compact() because it really is
194 * COMPUTE DS specific. This is less efficient, but creation doesn't
195 * occur too often. */
196 for (i = 0; rpnp[i].op != OP_END; i++) {
197 if (rpnp[i].op == OP_TIME || rpnp[i].op == OP_LTIME ||
198 rpnp[i].op == OP_PREV)
201 "operators time, ltime and prev not supported with DS COMPUTE");
206 if (rpn_compact(rpnp,&rpnc,&count) == -1) {
210 /* copy the compact rpn representation over the ds_def par array */
211 memcpy((void*) &(rrd -> ds_def[ds_idx].par[DS_cdef]),
212 (void*) rpnc, count*sizeof(rpn_cdefds_t));
217 /* lookup a data source name in the rrd struct and return the index,
218 * should use ds_match() here except:
219 * (1) need a void * pointer to the rrd
220 * (2) error handling is left to the caller
222 long lookup_DS(void *rrd_vptr,char *ds_name)
227 rrd = (rrd_t *) rrd_vptr;
229 for (i = 0; i < rrd -> stat_head -> ds_cnt; ++i)
231 if(strcmp(ds_name,rrd -> ds_def[i].ds_nam) == 0)
234 /* the caller handles a bad data source name in the rpn string */
238 /* rpn_parse : parse a string and generate a rpnp array; modified
239 * str2rpn() originally included in rrd_graph.c
241 * key_hash: a transparent argument passed to lookup(); conceptually this
242 * is a hash object for lookup of a numeric key given a variable name
243 * expr: the string RPN expression, including variable names
244 * lookup(): a function that retrieves a numeric key given a variable name
247 rpn_parse(void *key_hash,char *expr,long (*lookup)(void *,char*)){
256 if ((rpnp = (rpnp_t *) rrd_realloc(rpnp, (++steps + 2)*
257 sizeof(rpnp_t)))==NULL){
261 else if((sscanf(expr,"%lf%n",&rpnp[steps].val,&pos) == 1) && (expr[pos] == ',')){
262 rpnp[steps].op = OP_NUMBER;
266 #define match_op(VV,VVV) \
267 else if (strncmp(expr, #VVV, strlen(#VVV))==0){ \
268 rpnp[steps].op = VV; \
269 expr+=strlen(#VVV); \
273 #define match_op_param(VV,VVV) \
274 else if (sscanf(expr, #VVV "(%[a-z0-9]s)",vname) == 1) { \
276 if ((length = strlen(#VVV)+strlen(vname)+2, \
277 expr[length] == ',' || expr[length] == '\0') ) { \
278 rpnp[steps].op = VV; \
279 rpnp[steps].ptr = (*lookup)(key_hash,vname); \
280 if (rpnp[steps].ptr < 0) { \
283 } else expr+=length; \
295 match_op(OP_FLOOR,FLOOR)
296 match_op(OP_CEIL,CEIL)
309 match_op(OP_LIMIT,LIMIT)
310 /* order is important here ! .. match longest first */
311 match_op(OP_UNKN,UNKN)
313 match_op(OP_NEGINF,NEGINF)
315 match_op_param(OP_PREV_OTHER,PREV)
316 match_op(OP_PREV,PREV)
318 match_op(OP_ISINF,ISINF)
320 match_op(OP_LTIME,LTIME)
321 match_op(OP_TIME,TIME)
326 else if ((sscanf(expr,"%29[_A-Za-z0-9]%n",
328 && ((rpnp[steps].ptr = (*lookup)(key_hash,vname)) != -1)){
329 rpnp[steps].op = OP_VARIABLE;
346 rpnp[steps+1].op = OP_END;
351 rpnstack_init(rpnstack_t *rpnstack)
353 rpnstack -> s = NULL;
354 rpnstack -> dc_stacksize = 0;
355 rpnstack -> dc_stackblock = 100;
359 rpnstack_free(rpnstack_t *rpnstack)
361 if (rpnstack -> s != NULL)
363 rpnstack -> dc_stacksize = 0;
366 /* rpn_calc: run the RPN calculator; also performs variable substitution;
367 * moved and modified from data_calc() originally included in rrd_graph.c
369 * rpnp : an array of RPN operators (including variable references)
370 * rpnstack : the initialized stack
371 * data_idx : when data_idx is a multiple of rpnp.step, the rpnp.data pointer
372 * is advanced by rpnp.ds_cnt; used only for variable substitution
373 * output : an array of output values; OP_PREV assumes this array contains
374 * the "previous" value at index position output_idx-1; the definition of
375 * "previous" depends on the calling environment
376 * output_idx : an index into the output array in which to store the output
377 * of the RPN calculator
378 * returns: -1 if the computation failed (also calls rrd_set_error)
382 rpn_calc(rpnp_t *rpnp, rpnstack_t *rpnstack, long data_idx,
383 rrd_value_t *output, int output_idx)
388 /* process each op from the rpn in turn */
389 for (rpi=0; rpnp[rpi].op != OP_END; rpi++){
390 /* allocate or grow the stack */
391 if (stptr + 5 > rpnstack -> dc_stacksize){
392 /* could move this to a separate function */
393 rpnstack -> dc_stacksize += rpnstack -> dc_stackblock;
394 rpnstack -> s = rrd_realloc(rpnstack -> s,
395 (rpnstack -> dc_stacksize)*sizeof(*(rpnstack -> s)));
396 if (rpnstack -> s == NULL){
397 rrd_set_error("RPN stack overflow");
402 #define stackunderflow(MINSIZE) \
404 rrd_set_error("RPN stack underflow"); \
408 switch (rpnp[rpi].op){
410 rpnstack -> s[++stptr] = rpnp[rpi].val;
413 /* Sanity check: VDEFs shouldn't make it here */
414 if (rpnp[rpi].ds_cnt == 0) {
415 rrd_set_error("VDEF made it into rpn_calc... aborting");
418 /* make sure we pull the correct value from
419 * the *.data array. Adjust the pointer into
420 * the array acordingly. Advance the ptr one
421 * row in the rra (skip over non-relevant
424 rpnstack -> s[++stptr] = *(rpnp[rpi].data);
425 if (data_idx % rpnp[rpi].step == 0){
426 rpnp[rpi].data += rpnp[rpi].ds_cnt;
431 if ((output_idx-1) <= 0) {
432 rpnstack -> s[++stptr] = DNAN;
434 rpnstack -> s[++stptr] = output[output_idx-1];
438 if ((output_idx-1) <= 0) {
439 rpnstack -> s[++stptr] = DNAN;
441 rpnstack -> s[++stptr] = rpnp[rpnp[rpi].ptr].data[output_idx-1];
445 rpnstack -> s[++stptr] = DNAN;
448 rpnstack -> s[++stptr] = DINF;
451 rpnstack -> s[++stptr] = -DINF;
454 rpnstack -> s[++stptr] = (double)time(NULL);
457 /* HACK: this relies on the data_idx being the time,
458 ** which the within-function scope is unaware of */
459 rpnstack -> s[++stptr] = (double) data_idx;
462 rpnstack -> s[++stptr] =
463 (double) tzoffset(data_idx) + (double)data_idx;
467 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
468 + rpnstack -> s[stptr];
473 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
474 - rpnstack -> s[stptr];
479 rpnstack -> s[stptr-1] = (rpnstack -> s[stptr-1])
480 * (rpnstack -> s[stptr]);
485 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
486 / rpnstack -> s[stptr];
491 rpnstack -> s[stptr-1]= fmod( rpnstack -> s[stptr-1]
492 ,rpnstack -> s[stptr]);
497 rpnstack -> s[stptr] = sin(rpnstack -> s[stptr]);
501 rpnstack -> s[stptr] = cos(rpnstack -> s[stptr]);
505 rpnstack -> s[stptr] = ceil(rpnstack -> s[stptr]);
509 rpnstack -> s[stptr] = floor(rpnstack -> s[stptr]);
513 rpnstack -> s[stptr] = log(rpnstack -> s[stptr]);
517 rpnstack -> s[stptr+1] = rpnstack -> s[stptr];
528 dummy = rpnstack -> s[stptr] ;
529 rpnstack -> s[stptr] = rpnstack -> s[stptr-1];
530 rpnstack -> s[stptr-1] = dummy;
535 rpnstack -> s[stptr] = exp(rpnstack -> s[stptr]);
539 if (isnan(rpnstack -> s[stptr-1]))
541 else if (isnan(rpnstack -> s[stptr]))
542 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
544 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] <
545 rpnstack -> s[stptr] ? 1.0 : 0.0;
550 if (isnan(rpnstack -> s[stptr-1]))
552 else if (isnan(rpnstack -> s[stptr]))
553 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
555 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] <=
556 rpnstack -> s[stptr] ? 1.0 : 0.0;
561 if (isnan(rpnstack -> s[stptr-1]))
563 else if (isnan(rpnstack -> s[stptr]))
564 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
566 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >
567 rpnstack -> s[stptr] ? 1.0 : 0.0;
572 if (isnan(rpnstack -> s[stptr-1]))
574 else if (isnan(rpnstack -> s[stptr]))
575 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
577 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >=
578 rpnstack -> s[stptr] ? 1.0 : 0.0;
583 if (isnan(rpnstack -> s[stptr-1]))
585 else if (isnan(rpnstack -> s[stptr]))
586 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
588 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
589 rpnstack -> s[stptr] ? 0.0 : 1.0;
594 if (isnan(rpnstack -> s[stptr-1]))
596 else if (isnan(rpnstack -> s[stptr]))
597 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
599 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
600 rpnstack -> s[stptr] ? 1.0 : 0.0;
605 rpnstack->s[stptr-2] = rpnstack->s[stptr-2] != 0.0 ?
606 rpnstack->s[stptr-1] : rpnstack->s[stptr];
612 if (isnan(rpnstack->s[stptr-1]))
614 else if (isnan(rpnstack->s[stptr]))
615 rpnstack->s[stptr-1] = rpnstack->s[stptr];
616 else if (rpnstack->s[stptr-1] > rpnstack->s[stptr])
617 rpnstack->s[stptr-1] = rpnstack->s[stptr];
622 if (isnan(rpnstack->s[stptr-1]))
624 else if (isnan(rpnstack->s[stptr]))
625 rpnstack->s[stptr-1] = rpnstack->s[stptr];
626 else if (rpnstack->s[stptr-1] < rpnstack->s[stptr])
627 rpnstack->s[stptr-1] = rpnstack->s[stptr];
632 if (isnan(rpnstack->s[stptr-2]))
634 else if (isnan(rpnstack->s[stptr-1]))
635 rpnstack->s[stptr-2] = rpnstack->s[stptr-1];
636 else if (isnan(rpnstack->s[stptr]))
637 rpnstack->s[stptr-2] = rpnstack->s[stptr];
638 else if (rpnstack->s[stptr-2] < rpnstack->s[stptr-1])
639 rpnstack->s[stptr-2] = DNAN;
640 else if (rpnstack->s[stptr-2] > rpnstack->s[stptr])
641 rpnstack->s[stptr-2] = DNAN;
646 rpnstack->s[stptr] = isnan(rpnstack->s[stptr]) ? 1.0 : 0.0;
650 rpnstack->s[stptr] = isinf(rpnstack->s[stptr]) ? 1.0 : 0.0;
655 #undef stackunderflow
658 rrd_set_error("RPN final stack size != 1");
662 output[output_idx] = rpnstack->s[0];
666 /* figure out what the local timezone offset for any point in
667 time was. Return it in seconds */
669 tzoffset( time_t now ){
670 int gm_sec, gm_min, gm_hour, gm_yday, gm_year,
671 l_sec, l_min, l_hour, l_yday, l_year;
677 gm_hour = t->tm_hour;
678 gm_yday = t->tm_yday;
679 gm_year = t->tm_year;
686 off = (l_sec-gm_sec)+(l_min-gm_min)*60+(l_hour-gm_hour)*3600;
687 if ( l_yday > gm_yday || l_year > gm_year){
689 } else if ( l_yday < gm_yday || l_year < gm_year){