1 /****************************************************************************
2 * RRDtool 1.2rc6 Copyright by Tobi Oetiker, 1997-2005
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)
160 add_op(OP_TREND,TREND)
163 (*str)[offset] = '\0';
167 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
168 char **result_str, unsigned short *offset)
172 op_len = strlen(op_str);
173 *result_str = (char *) rrd_realloc(*result_str,
174 (op_len + 1 + *offset)*sizeof(char));
175 if (*result_str == NULL) {
176 rrd_set_error("failed to alloc memory in addop2str");
179 strncpy(&((*result_str)[*offset]),op_str,op_len);
186 void parseCDEF_DS(char *def,rrd_t *rrd, int ds_idx)
189 rpn_cdefds_t *rpnc = NULL;
192 rpnp = rpn_parse((void*) rrd, def, &lookup_DS);
194 rrd_set_error("failed to parse computed data source %s", def);
197 /* Check for OP nodes not permitted in COMPUTE DS.
198 * Moved this check from within rpn_compact() because it really is
199 * COMPUTE DS specific. This is less efficient, but creation doesn't
200 * occur too often. */
201 for (i = 0; rpnp[i].op != OP_END; i++) {
202 if (rpnp[i].op == OP_TIME || rpnp[i].op == OP_LTIME ||
203 rpnp[i].op == OP_PREV || rpnp[i].op == OP_COUNT)
206 "operators time, ltime, prev and count not supported with DS COMPUTE");
211 if (rpn_compact(rpnp,&rpnc,&count) == -1) {
215 /* copy the compact rpn representation over the ds_def par array */
216 memcpy((void*) &(rrd -> ds_def[ds_idx].par[DS_cdef]),
217 (void*) rpnc, count*sizeof(rpn_cdefds_t));
222 /* lookup a data source name in the rrd struct and return the index,
223 * should use ds_match() here except:
224 * (1) need a void * pointer to the rrd
225 * (2) error handling is left to the caller
227 long lookup_DS(void *rrd_vptr,char *ds_name)
232 rrd = (rrd_t *) rrd_vptr;
234 for (i = 0; i < rrd -> stat_head -> ds_cnt; ++i)
236 if(strcmp(ds_name,rrd -> ds_def[i].ds_nam) == 0)
239 /* the caller handles a bad data source name in the rpn string */
243 /* rpn_parse : parse a string and generate a rpnp array; modified
244 * str2rpn() originally included in rrd_graph.c
246 * key_hash: a transparent argument passed to lookup(); conceptually this
247 * is a hash object for lookup of a numeric key given a variable name
248 * expr: the string RPN expression, including variable names
249 * lookup(): a function that retrieves a numeric key given a variable name
252 rpn_parse(void *key_hash,char *expr,long (*lookup)(void *,char*)){
261 if ((rpnp = (rpnp_t *) rrd_realloc(rpnp, (++steps + 2)*
262 sizeof(rpnp_t)))==NULL){
266 else if((sscanf(expr,"%lf%n",&rpnp[steps].val,&pos) == 1) && (expr[pos] == ',')){
267 rpnp[steps].op = OP_NUMBER;
271 #define match_op(VV,VVV) \
272 else if (strncmp(expr, #VVV, strlen(#VVV))==0){ \
273 rpnp[steps].op = VV; \
274 expr+=strlen(#VVV); \
278 #define match_op_param(VV,VVV) \
279 else if (sscanf(expr, #VVV "(" DEF_NAM_FMT ")",vname) == 1) { \
281 if ((length = strlen(#VVV)+strlen(vname)+2, \
282 expr[length] == ',' || expr[length] == '\0') ) { \
283 rpnp[steps].op = VV; \
284 rpnp[steps].ptr = (*lookup)(key_hash,vname); \
285 if (rpnp[steps].ptr < 0) { \
288 } else expr+=length; \
300 match_op(OP_FLOOR,FLOOR)
301 match_op(OP_CEIL,CEIL)
306 match_op(OP_LTIME,LTIME)
315 match_op(OP_LIMIT,LIMIT)
316 /* order is important here ! .. match longest first */
317 match_op(OP_UNKN,UNKN)
319 match_op(OP_NEGINF,NEGINF)
321 match_op(OP_COUNT,COUNT)
322 match_op_param(OP_PREV_OTHER,PREV)
323 match_op(OP_PREV,PREV)
325 match_op(OP_ISINF,ISINF)
327 match_op(OP_TIME,TIME)
328 match_op(OP_ATAN,ATAN)
329 match_op(OP_SQRT,SQRT)
330 match_op(OP_SORT,SORT)
332 match_op(OP_TREND,TREND)
336 else if ((sscanf(expr, DEF_NAM_FMT "%n",
338 && ((rpnp[steps].ptr = (*lookup)(key_hash,vname)) != -1)){
339 rpnp[steps].op = OP_VARIABLE;
356 rpnp[steps+1].op = OP_END;
361 rpnstack_init(rpnstack_t *rpnstack)
363 rpnstack -> s = NULL;
364 rpnstack -> dc_stacksize = 0;
365 rpnstack -> dc_stackblock = 100;
369 rpnstack_free(rpnstack_t *rpnstack)
371 if (rpnstack -> s != NULL)
373 rpnstack -> dc_stacksize = 0;
377 rpn_compare_double(const void *x, const void *y)
379 double diff = *((const double *)x) - *((const double *)y);
381 return (diff < 0) ? -1 : (diff > 0) ? 1 : 0;
384 /* rpn_calc: run the RPN calculator; also performs variable substitution;
385 * moved and modified from data_calc() originally included in rrd_graph.c
387 * rpnp : an array of RPN operators (including variable references)
388 * rpnstack : the initialized stack
389 * data_idx : when data_idx is a multiple of rpnp.step, the rpnp.data pointer
390 * is advanced by rpnp.ds_cnt; used only for variable substitution
391 * output : an array of output values; OP_PREV assumes this array contains
392 * the "previous" value at index position output_idx-1; the definition of
393 * "previous" depends on the calling environment
394 * output_idx : an index into the output array in which to store the output
395 * of the RPN calculator
396 * returns: -1 if the computation failed (also calls rrd_set_error)
400 rpn_calc(rpnp_t *rpnp, rpnstack_t *rpnstack, long data_idx,
401 rrd_value_t *output, int output_idx)
406 /* process each op from the rpn in turn */
407 for (rpi=0; rpnp[rpi].op != OP_END; rpi++){
408 /* allocate or grow the stack */
409 if (stptr + 5 > rpnstack -> dc_stacksize){
410 /* could move this to a separate function */
411 rpnstack -> dc_stacksize += rpnstack -> dc_stackblock;
412 rpnstack -> s = rrd_realloc(rpnstack -> s,
413 (rpnstack -> dc_stacksize)*sizeof(*(rpnstack -> s)));
414 if (rpnstack -> s == NULL){
415 rrd_set_error("RPN stack overflow");
420 #define stackunderflow(MINSIZE) \
422 rrd_set_error("RPN stack underflow"); \
426 switch (rpnp[rpi].op){
428 rpnstack -> s[++stptr] = rpnp[rpi].val;
431 /* Sanity check: VDEFs shouldn't make it here */
432 if (rpnp[rpi].ds_cnt == 0) {
433 rrd_set_error("VDEF made it into rpn_calc... aborting");
436 /* make sure we pull the correct value from
437 * the *.data array. Adjust the pointer into
438 * the array acordingly. Advance the ptr one
439 * row in the rra (skip over non-relevant
442 rpnstack -> s[++stptr] = *(rpnp[rpi].data);
443 if (data_idx % rpnp[rpi].step == 0){
444 rpnp[rpi].data += rpnp[rpi].ds_cnt;
449 rpnstack -> s[++stptr] = (output_idx+1); /* Note: Counter starts at 1 */
452 if ((output_idx) <= 0) {
453 rpnstack -> s[++stptr] = DNAN;
455 rpnstack -> s[++stptr] = output[output_idx-1];
459 if ((output_idx) <= 0) {
460 rpnstack -> s[++stptr] = DNAN;
462 rpnstack -> s[++stptr] = rpnp[rpnp[rpi].ptr].data[output_idx-1];
466 rpnstack -> s[++stptr] = DNAN;
469 rpnstack -> s[++stptr] = DINF;
472 rpnstack -> s[++stptr] = -DINF;
475 rpnstack -> s[++stptr] = (double)time(NULL);
478 /* HACK: this relies on the data_idx being the time,
479 ** which the within-function scope is unaware of */
480 rpnstack -> s[++stptr] = (double) data_idx;
483 rpnstack -> s[++stptr] =
484 (double) tzoffset(data_idx) + (double)data_idx;
488 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
489 + rpnstack -> s[stptr];
494 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
495 - rpnstack -> s[stptr];
500 rpnstack -> s[stptr-1] = (rpnstack -> s[stptr-1])
501 * (rpnstack -> s[stptr]);
506 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
507 / rpnstack -> s[stptr];
512 rpnstack -> s[stptr-1]= fmod( rpnstack -> s[stptr-1]
513 ,rpnstack -> s[stptr]);
518 rpnstack -> s[stptr] = sin(rpnstack -> s[stptr]);
522 rpnstack -> s[stptr] = atan(rpnstack -> s[stptr]);
526 rpnstack -> s[stptr] = cos(rpnstack -> s[stptr]);
530 rpnstack -> s[stptr] = ceil(rpnstack -> s[stptr]);
534 rpnstack -> s[stptr] = floor(rpnstack -> s[stptr]);
538 rpnstack -> s[stptr] = log(rpnstack -> s[stptr]);
542 rpnstack -> s[stptr+1] = rpnstack -> s[stptr];
553 dummy = rpnstack -> s[stptr] ;
554 rpnstack -> s[stptr] = rpnstack -> s[stptr-1];
555 rpnstack -> s[stptr-1] = dummy;
560 rpnstack -> s[stptr] = exp(rpnstack -> s[stptr]);
564 if (isnan(rpnstack -> s[stptr-1]))
566 else if (isnan(rpnstack -> s[stptr]))
567 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
569 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] <
570 rpnstack -> s[stptr] ? 1.0 : 0.0;
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] <=
581 rpnstack -> s[stptr] ? 1.0 : 0.0;
586 if (isnan(rpnstack -> s[stptr-1]))
588 else if (isnan(rpnstack -> s[stptr]))
589 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
591 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >
592 rpnstack -> s[stptr] ? 1.0 : 0.0;
597 if (isnan(rpnstack -> s[stptr-1]))
599 else if (isnan(rpnstack -> s[stptr]))
600 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
602 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >=
603 rpnstack -> s[stptr] ? 1.0 : 0.0;
608 if (isnan(rpnstack -> s[stptr-1]))
610 else if (isnan(rpnstack -> s[stptr]))
611 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
613 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
614 rpnstack -> s[stptr] ? 0.0 : 1.0;
619 if (isnan(rpnstack -> s[stptr-1]))
621 else if (isnan(rpnstack -> s[stptr]))
622 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
624 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
625 rpnstack -> s[stptr] ? 1.0 : 0.0;
630 rpnstack->s[stptr-2] = rpnstack->s[stptr-2] != 0.0 ?
631 rpnstack->s[stptr-1] : rpnstack->s[stptr];
637 if (isnan(rpnstack->s[stptr-1]))
639 else if (isnan(rpnstack->s[stptr]))
640 rpnstack->s[stptr-1] = rpnstack->s[stptr];
641 else if (rpnstack->s[stptr-1] > rpnstack->s[stptr])
642 rpnstack->s[stptr-1] = rpnstack->s[stptr];
647 if (isnan(rpnstack->s[stptr-1]))
649 else if (isnan(rpnstack->s[stptr]))
650 rpnstack->s[stptr-1] = rpnstack->s[stptr];
651 else if (rpnstack->s[stptr-1] < rpnstack->s[stptr])
652 rpnstack->s[stptr-1] = rpnstack->s[stptr];
657 if (isnan(rpnstack->s[stptr-2]))
659 else if (isnan(rpnstack->s[stptr-1]))
660 rpnstack->s[stptr-2] = rpnstack->s[stptr-1];
661 else if (isnan(rpnstack->s[stptr]))
662 rpnstack->s[stptr-2] = rpnstack->s[stptr];
663 else if (rpnstack->s[stptr-2] < rpnstack->s[stptr-1])
664 rpnstack->s[stptr-2] = DNAN;
665 else if (rpnstack->s[stptr-2] > rpnstack->s[stptr])
666 rpnstack->s[stptr-2] = DNAN;
671 rpnstack->s[stptr] = isnan(rpnstack->s[stptr]) ? 1.0 : 0.0;
675 rpnstack->s[stptr] = isinf(rpnstack->s[stptr]) ? 1.0 : 0.0;
679 rpnstack -> s[stptr] = sqrt(rpnstack -> s[stptr]);
684 int spn = (int)rpnstack -> s[stptr--];
686 stackunderflow(spn-1);
687 qsort(rpnstack -> s + stptr-spn+1, spn, sizeof(double),
694 int spn = (int)rpnstack -> s[stptr--];
697 stackunderflow(spn-1);
699 p = rpnstack -> s + stptr-spn+1;
700 q = rpnstack -> s + stptr;
711 if ((rpi < 2) || (rpnp[rpi-2].op != OP_VARIABLE)) {
712 rrd_set_error("malformed trend arguments");
715 time_t dur = (time_t)rpnstack -> s[stptr];
716 time_t step = (time_t)rpnp[rpi-2].step;
718 if (output_idx > (int)ceil((float)dur / (float)step)) {
723 accum += rpnp[rpi-2].data[rpnp[rpi-2].ds_cnt * i--];
727 rpnstack -> s[--stptr] = (accum / -i);
729 rpnstack -> s[--stptr] = DNAN;
735 #undef stackunderflow
738 rrd_set_error("RPN final stack size != 1");
742 output[output_idx] = rpnstack->s[0];
746 /* figure out what the local timezone offset for any point in
747 time was. Return it in seconds */
749 tzoffset( time_t now ){
750 int gm_sec, gm_min, gm_hour, gm_yday, gm_year,
751 l_sec, l_min, l_hour, l_yday, l_year;
760 localtime_r(&now, &t);
766 off = (l_sec-gm_sec)+(l_min-gm_min)*60+(l_hour-gm_hour)*3600;
767 if ( l_yday > gm_yday || l_year > gm_year){
769 } else if ( l_yday < gm_yday || l_year < gm_year){