1 /****************************************************************************
2 * RRDtool 1.2.19 Copyright by Tobi Oetiker, 1997-2007
3 ****************************************************************************
4 * rrd_rpncalc.c RPN calculator functions
5 ****************************************************************************/
8 #include "rrd_rpncalc.h"
12 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
13 char **result_str, unsigned short *offset);
14 int tzoffset(time_t); /* used to implement LTIME */
16 short rpn_compact(rpnp_t *rpnp, rpn_cdefds_t **rpnc, short *count)
20 /* count the number of rpn nodes */
21 while(rpnp[*count].op != OP_END) (*count)++;
22 if (++(*count) > DS_CDEF_MAX_RPN_NODES) {
23 rrd_set_error("Maximum %d RPN nodes permitted",
24 DS_CDEF_MAX_RPN_NODES);
29 *rpnc = (rpn_cdefds_t *) calloc(*count,sizeof(rpn_cdefds_t));
30 for (i = 0; rpnp[i].op != OP_END; i++)
32 (*rpnc)[i].op = (char) rpnp[i].op;
33 if (rpnp[i].op == OP_NUMBER) {
34 /* rpnp.val is a double, rpnc.val is a short */
35 double temp = floor(rpnp[i].val);
36 if (temp < SHRT_MIN || temp > SHRT_MAX) {
38 "constants must be integers in the interval (%d, %d)",
43 (*rpnc)[i].val = (short) temp;
44 } else if (rpnp[i].op == OP_VARIABLE ||
45 rpnp[i].op == OP_PREV_OTHER) {
46 (*rpnc)[i].val = (short) rpnp[i].ptr;
49 /* terminate the sequence */
50 (*rpnc)[(*count) - 1].op = OP_END;
54 rpnp_t * rpn_expand(rpn_cdefds_t *rpnc)
59 /* DS_CDEF_MAX_RPN_NODES is small, so at the expense of some wasted
60 * memory we avoid any reallocs */
61 rpnp = (rpnp_t *) calloc(DS_CDEF_MAX_RPN_NODES,sizeof(rpnp_t));
62 if (rpnp == NULL) return NULL;
63 for (i = 0; rpnc[i].op != OP_END; ++i)
65 rpnp[i].op = (long) rpnc[i].op;
66 if (rpnp[i].op == OP_NUMBER) {
67 rpnp[i].val = (double) rpnc[i].val;
68 } else if (rpnp[i].op == OP_VARIABLE ||
69 rpnp[i].op == OP_PREV_OTHER) {
70 rpnp[i].ptr = (long) rpnc[i].val;
73 /* terminate the sequence */
78 /* rpn_compact2str: convert a compact sequence of RPN operator nodes back
79 * into a CDEF string. This function is used by rrd_dump.
81 * rpnc: an array of compact RPN operator nodes
82 * ds_def: a pointer to the data source definition section of an RRD header
83 * for lookup of data source names by index
84 * str: out string, memory is allocated by the function, must be freed by the
86 void rpn_compact2str(rpn_cdefds_t *rpnc,ds_def_t *ds_def,char **str)
88 unsigned short i,offset = 0;
89 char buffer[7]; /* short as a string */
91 for (i = 0; rpnc[i].op != OP_END; i++)
93 if (i > 0) (*str)[offset++] = ',';
95 #define add_op(VV,VVV) \
96 if (addop2str(rpnc[i].op, VV, VVV, str, &offset) == 1) continue;
98 if (rpnc[i].op == OP_NUMBER) {
99 /* convert a short into a string */
100 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
101 _itoa(rpnc[i].val,buffer,10);
103 sprintf(buffer,"%d",rpnc[i].val);
105 add_op(OP_NUMBER,buffer)
108 if (rpnc[i].op == OP_VARIABLE) {
109 char *ds_name = ds_def[rpnc[i].val].ds_nam;
110 add_op(OP_VARIABLE, ds_name)
113 if (rpnc[i].op == OP_PREV_OTHER) {
114 char *ds_name = ds_def[rpnc[i].val].ds_nam;
115 add_op(OP_VARIABLE, ds_name)
120 #define add_op(VV,VVV) \
121 if (addop2str(rpnc[i].op, VV, #VVV, str, &offset) == 1) continue;
131 add_op(OP_FLOOR,FLOOR)
145 add_op(OP_LIMIT,LIMIT)
148 add_op(OP_NEGINF,NEGINF)
152 add_op(OP_ISINF,ISINF)
154 add_op(OP_LTIME,LTIME)
156 add_op(OP_ATAN2,ATAN2)
161 add_op(OP_TREND,TREND)
162 add_op(OP_RAD2DEG,RAD2DEG)
163 add_op(OP_DEG2RAD,DEG2RAD)
168 (*str)[offset] = '\0';
172 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
173 char **result_str, unsigned short *offset)
177 op_len = strlen(op_str);
178 *result_str = (char *) rrd_realloc(*result_str,
179 (op_len + 1 + *offset)*sizeof(char));
180 if (*result_str == NULL) {
181 rrd_set_error("failed to alloc memory in addop2str");
184 strncpy(&((*result_str)[*offset]),op_str,op_len);
191 void parseCDEF_DS(char *def,rrd_t *rrd, int ds_idx)
194 rpn_cdefds_t *rpnc = NULL;
197 rpnp = rpn_parse((void*) rrd, def, &lookup_DS);
199 rrd_set_error("failed to parse computed data source");
202 /* Check for OP nodes not permitted in COMPUTE DS.
203 * Moved this check from within rpn_compact() because it really is
204 * COMPUTE DS specific. This is less efficient, but creation doesn't
205 * occur too often. */
206 for (i = 0; rpnp[i].op != OP_END; i++) {
207 if (rpnp[i].op == OP_TIME || rpnp[i].op == OP_LTIME ||
208 rpnp[i].op == OP_PREV || rpnp[i].op == OP_COUNT)
211 "operators time, ltime, prev and count not supported with DS COMPUTE");
216 if (rpn_compact(rpnp,&rpnc,&count) == -1) {
220 /* copy the compact rpn representation over the ds_def par array */
221 memcpy((void*) &(rrd -> ds_def[ds_idx].par[DS_cdef]),
222 (void*) rpnc, count*sizeof(rpn_cdefds_t));
227 /* lookup a data source name in the rrd struct and return the index,
228 * should use ds_match() here except:
229 * (1) need a void * pointer to the rrd
230 * (2) error handling is left to the caller
232 long lookup_DS(void *rrd_vptr,char *ds_name)
237 rrd = (rrd_t *) rrd_vptr;
239 for (i = 0; i < rrd -> stat_head -> ds_cnt; ++i)
241 if(strcmp(ds_name,rrd -> ds_def[i].ds_nam) == 0)
244 /* the caller handles a bad data source name in the rpn string */
248 /* rpn_parse : parse a string and generate a rpnp array; modified
249 * str2rpn() originally included in rrd_graph.c
251 * key_hash: a transparent argument passed to lookup(); conceptually this
252 * is a hash object for lookup of a numeric key given a variable name
253 * expr: the string RPN expression, including variable names
254 * lookup(): a function that retrieves a numeric key given a variable name
257 rpn_parse(void *key_hash,const char *const expr_const,long (*lookup)(void *,char*)){
262 char vname[MAX_VNAME_LEN+10];
265 expr=(char *)expr_const;
268 if ((rpnp = (rpnp_t *) rrd_realloc(rpnp, (++steps + 2)*
269 sizeof(rpnp_t)))==NULL){
273 else if((sscanf(expr,"%lf%n",&rpnp[steps].val,&pos) == 1) && (expr[pos] == ',')){
274 rpnp[steps].op = OP_NUMBER;
278 #define match_op(VV,VVV) \
279 else if (strncmp(expr, #VVV, strlen(#VVV))==0 && ( expr[strlen(#VVV)] == ',' || expr[strlen(#VVV)] == '\0' )){ \
280 rpnp[steps].op = VV; \
281 expr+=strlen(#VVV); \
285 #define match_op_param(VV,VVV) \
286 else if (sscanf(expr, #VVV "(" DEF_NAM_FMT ")",vname) == 1) { \
288 if ((length = strlen(#VVV)+strlen(vname)+2, \
289 expr[length] == ',' || expr[length] == '\0') ) { \
290 rpnp[steps].op = VV; \
291 rpnp[steps].ptr = (*lookup)(key_hash,vname); \
292 if (rpnp[steps].ptr < 0) { \
295 } else expr+=length; \
307 match_op(OP_FLOOR,FLOOR)
308 match_op(OP_CEIL,CEIL)
313 match_op(OP_LTIME,LTIME)
322 match_op(OP_LIMIT,LIMIT)
323 /* order is important here ! .. match longest first */
324 match_op(OP_UNKN,UNKN)
326 match_op(OP_NEGINF,NEGINF)
328 match_op(OP_COUNT,COUNT)
329 match_op_param(OP_PREV_OTHER,PREV)
330 match_op(OP_PREV,PREV)
332 match_op(OP_ISINF,ISINF)
334 match_op(OP_TIME,TIME)
335 match_op(OP_ATAN2,ATAN2)
336 match_op(OP_ATAN,ATAN)
337 match_op(OP_SQRT,SQRT)
338 match_op(OP_SORT,SORT)
340 match_op(OP_TREND,TREND)
341 match_op(OP_RAD2DEG,RAD2DEG)
342 match_op(OP_DEG2RAD,DEG2RAD)
348 else if ((sscanf(expr, DEF_NAM_FMT "%n",
350 && ((rpnp[steps].ptr = (*lookup)(key_hash,vname)) != -1)){
351 rpnp[steps].op = OP_VARIABLE;
368 rpnp[steps+1].op = OP_END;
373 rpnstack_init(rpnstack_t *rpnstack)
375 rpnstack -> s = NULL;
376 rpnstack -> dc_stacksize = 0;
377 rpnstack -> dc_stackblock = 100;
381 rpnstack_free(rpnstack_t *rpnstack)
383 if (rpnstack -> s != NULL)
385 rpnstack -> dc_stacksize = 0;
389 rpn_compare_double(const void *x, const void *y)
391 double diff = *((const double *)x) - *((const double *)y);
393 return (diff < 0) ? -1 : (diff > 0) ? 1 : 0;
396 /* rpn_calc: run the RPN calculator; also performs variable substitution;
397 * moved and modified from data_calc() originally included in rrd_graph.c
399 * rpnp : an array of RPN operators (including variable references)
400 * rpnstack : the initialized stack
401 * data_idx : when data_idx is a multiple of rpnp.step, the rpnp.data pointer
402 * is advanced by rpnp.ds_cnt; used only for variable substitution
403 * output : an array of output values; OP_PREV assumes this array contains
404 * the "previous" value at index position output_idx-1; the definition of
405 * "previous" depends on the calling environment
406 * output_idx : an index into the output array in which to store the output
407 * of the RPN calculator
408 * returns: -1 if the computation failed (also calls rrd_set_error)
412 rpn_calc(rpnp_t *rpnp, rpnstack_t *rpnstack, long data_idx,
413 rrd_value_t *output, int output_idx)
418 /* process each op from the rpn in turn */
419 for (rpi=0; rpnp[rpi].op != OP_END; rpi++){
420 /* allocate or grow the stack */
421 if (stptr + 5 > rpnstack -> dc_stacksize){
422 /* could move this to a separate function */
423 rpnstack -> dc_stacksize += rpnstack -> dc_stackblock;
424 rpnstack -> s = rrd_realloc(rpnstack -> s,
425 (rpnstack -> dc_stacksize)*sizeof(*(rpnstack -> s)));
426 if (rpnstack -> s == NULL){
427 rrd_set_error("RPN stack overflow");
432 #define stackunderflow(MINSIZE) \
434 rrd_set_error("RPN stack underflow"); \
438 switch (rpnp[rpi].op){
440 rpnstack -> s[++stptr] = rpnp[rpi].val;
444 /* Sanity check: VDEFs shouldn't make it here */
445 if (rpnp[rpi].ds_cnt == 0) {
446 rrd_set_error("VDEF made it into rpn_calc... aborting");
449 /* make sure we pull the correct value from
450 * the *.data array. Adjust the pointer into
451 * the array acordingly. Advance the ptr one
452 * row in the rra (skip over non-relevant
455 if (rpnp[rpi].op == OP_VARIABLE) {
456 rpnstack -> s[++stptr] = *(rpnp[rpi].data);
458 if ((output_idx) <= 0) {
459 rpnstack -> s[++stptr] = DNAN;
461 rpnstack -> s[++stptr] = *(rpnp[rpi].data-rpnp[rpi].ds_cnt);
465 if (data_idx % rpnp[rpi].step == 0){
466 rpnp[rpi].data += rpnp[rpi].ds_cnt;
471 rpnstack -> s[++stptr] = (output_idx+1); /* Note: Counter starts at 1 */
474 if ((output_idx) <= 0) {
475 rpnstack -> s[++stptr] = DNAN;
477 rpnstack -> s[++stptr] = output[output_idx-1];
481 rpnstack -> s[++stptr] = DNAN;
484 rpnstack -> s[++stptr] = DINF;
487 rpnstack -> s[++stptr] = -DINF;
490 rpnstack -> s[++stptr] = (double)time(NULL);
493 /* HACK: this relies on the data_idx being the time,
494 ** which the within-function scope is unaware of */
495 rpnstack -> s[++stptr] = (double) data_idx;
498 rpnstack -> s[++stptr] =
499 (double) tzoffset(data_idx) + (double)data_idx;
503 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
504 + rpnstack -> s[stptr];
509 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
510 - rpnstack -> s[stptr];
515 rpnstack -> s[stptr-1] = (rpnstack -> s[stptr-1])
516 * (rpnstack -> s[stptr]);
521 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
522 / rpnstack -> s[stptr];
527 rpnstack -> s[stptr-1]= fmod( rpnstack -> s[stptr-1]
528 ,rpnstack -> s[stptr]);
533 rpnstack -> s[stptr] = sin(rpnstack -> s[stptr]);
537 rpnstack -> s[stptr] = atan(rpnstack -> s[stptr]);
541 rpnstack -> s[stptr] = 57.29577951 * rpnstack -> s[stptr];
545 rpnstack -> s[stptr] = 0.0174532952 * rpnstack -> s[stptr];
549 rpnstack -> s[stptr-1]= atan2(
550 rpnstack -> s[stptr-1],
551 rpnstack -> s[stptr]);
556 rpnstack -> s[stptr] = cos(rpnstack -> s[stptr]);
560 rpnstack -> s[stptr] = ceil(rpnstack -> s[stptr]);
564 rpnstack -> s[stptr] = floor(rpnstack -> s[stptr]);
568 rpnstack -> s[stptr] = log(rpnstack -> s[stptr]);
572 rpnstack -> s[stptr+1] = rpnstack -> s[stptr];
583 dummy = rpnstack -> s[stptr] ;
584 rpnstack -> s[stptr] = rpnstack -> s[stptr-1];
585 rpnstack -> s[stptr-1] = dummy;
590 rpnstack -> s[stptr] = exp(rpnstack -> s[stptr]);
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 if (isnan(rpnstack -> s[stptr-1]))
607 else if (isnan(rpnstack -> s[stptr]))
608 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
610 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] <=
611 rpnstack -> s[stptr] ? 1.0 : 0.0;
616 if (isnan(rpnstack -> s[stptr-1]))
618 else if (isnan(rpnstack -> s[stptr]))
619 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
621 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >
622 rpnstack -> s[stptr] ? 1.0 : 0.0;
627 if (isnan(rpnstack -> s[stptr-1]))
629 else if (isnan(rpnstack -> s[stptr]))
630 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
632 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >=
633 rpnstack -> s[stptr] ? 1.0 : 0.0;
638 if (isnan(rpnstack -> s[stptr-1]))
640 else if (isnan(rpnstack -> s[stptr]))
641 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
643 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
644 rpnstack -> s[stptr] ? 0.0 : 1.0;
649 if (isnan(rpnstack -> s[stptr-1]))
651 else if (isnan(rpnstack -> s[stptr]))
652 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
654 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
655 rpnstack -> s[stptr] ? 1.0 : 0.0;
660 rpnstack->s[stptr-2] = rpnstack->s[stptr-2] != 0.0 ?
661 rpnstack->s[stptr-1] : rpnstack->s[stptr];
667 if (isnan(rpnstack->s[stptr-1]))
669 else if (isnan(rpnstack->s[stptr]))
670 rpnstack->s[stptr-1] = rpnstack->s[stptr];
671 else if (rpnstack->s[stptr-1] > rpnstack->s[stptr])
672 rpnstack->s[stptr-1] = rpnstack->s[stptr];
677 if (isnan(rpnstack->s[stptr-1]))
679 else if (isnan(rpnstack->s[stptr]))
680 rpnstack->s[stptr-1] = rpnstack->s[stptr];
681 else if (rpnstack->s[stptr-1] < rpnstack->s[stptr])
682 rpnstack->s[stptr-1] = rpnstack->s[stptr];
687 if (isnan(rpnstack->s[stptr-2]))
689 else if (isnan(rpnstack->s[stptr-1]))
690 rpnstack->s[stptr-2] = rpnstack->s[stptr-1];
691 else if (isnan(rpnstack->s[stptr]))
692 rpnstack->s[stptr-2] = rpnstack->s[stptr];
693 else if (rpnstack->s[stptr-2] < rpnstack->s[stptr-1])
694 rpnstack->s[stptr-2] = DNAN;
695 else if (rpnstack->s[stptr-2] > rpnstack->s[stptr])
696 rpnstack->s[stptr-2] = DNAN;
701 rpnstack->s[stptr] = isnan(rpnstack->s[stptr]) ? 1.0 : 0.0;
705 rpnstack->s[stptr] = isinf(rpnstack->s[stptr]) ? 1.0 : 0.0;
709 rpnstack -> s[stptr] = sqrt(rpnstack -> s[stptr]);
714 int spn = (int)rpnstack -> s[stptr--];
716 stackunderflow(spn-1);
717 qsort(rpnstack -> s + stptr-spn+1, spn, sizeof(double),
724 int spn = (int)rpnstack -> s[stptr--];
727 stackunderflow(spn-1);
729 p = rpnstack -> s + stptr-spn+1;
730 q = rpnstack -> s + stptr;
741 if ((rpi < 2) || (rpnp[rpi-2].op != OP_VARIABLE)) {
742 rrd_set_error("malformed trend arguments");
745 time_t dur = (time_t)rpnstack -> s[stptr];
746 time_t step = (time_t)rpnp[rpi-2].step;
748 if (output_idx > (int)ceil((float)dur / (float)step)) {
753 accum += rpnp[rpi-2].data[rpnp[rpi-2].ds_cnt * i--];
757 rpnstack -> s[--stptr] = (accum / -i);
759 rpnstack -> s[--stptr] = DNAN;
765 int i=(int)rpnstack -> s[stptr--];
770 double val=rpnstack -> s[stptr--];
772 if (isnan(val)) { continue; }
776 /* now push the result back on stack */
778 rpnstack -> s[++stptr]=sum/count;
780 rpnstack -> s[++stptr]=DNAN;
786 rpnstack -> s[stptr] = fabs(rpnstack -> s[stptr]);
791 #undef stackunderflow
794 rrd_set_error("RPN final stack size != 1");
798 output[output_idx] = rpnstack->s[0];
802 /* figure out what the local timezone offset for any point in
803 time was. Return it in seconds */
805 tzoffset( time_t now ){
806 int gm_sec, gm_min, gm_hour, gm_yday, gm_year,
807 l_sec, l_min, l_hour, l_yday, l_year;
816 localtime_r(&now, &t);
822 off = (l_sec-gm_sec)+(l_min-gm_min)*60+(l_hour-gm_hour)*3600;
823 if ( l_yday > gm_yday || l_year > gm_year){
825 } else if ( l_yday < gm_yday || l_year < gm_year){