1 /****************************************************************************
2 * RRDtool 1.2.23 Copyright by Tobi Oetiker, 1997-2007
3 ****************************************************************************
4 * rrd_rpncalc.c RPN calculator functions
5 ****************************************************************************/
8 #include "rrd_rpncalc.h"
17 unsigned short *offset);
19 time_t); /* used to implement LTIME */
29 /* count the number of rpn nodes */
30 while (rpnp[*count].op != OP_END)
32 if (++(*count) > DS_CDEF_MAX_RPN_NODES) {
33 rrd_set_error("Maximum %d RPN nodes permitted",
34 DS_CDEF_MAX_RPN_NODES);
39 *rpnc = (rpn_cdefds_t *) calloc(*count, sizeof(rpn_cdefds_t));
40 for (i = 0; rpnp[i].op != OP_END; i++) {
41 (*rpnc)[i].op = (char) rpnp[i].op;
42 if (rpnp[i].op == OP_NUMBER) {
43 /* rpnp.val is a double, rpnc.val is a short */
44 double temp = floor(rpnp[i].val);
46 if (temp < SHRT_MIN || temp > SHRT_MAX) {
48 ("constants must be integers in the interval (%d, %d)",
53 (*rpnc)[i].val = (short) temp;
54 } else if (rpnp[i].op == OP_VARIABLE || rpnp[i].op == OP_PREV_OTHER) {
55 (*rpnc)[i].val = (short) rpnp[i].ptr;
58 /* terminate the sequence */
59 (*rpnc)[(*count) - 1].op = OP_END;
69 /* DS_CDEF_MAX_RPN_NODES is small, so at the expense of some wasted
70 * memory we avoid any reallocs */
71 rpnp = (rpnp_t *) calloc(DS_CDEF_MAX_RPN_NODES, sizeof(rpnp_t));
74 for (i = 0; rpnc[i].op != OP_END; ++i) {
75 rpnp[i].op = (long) rpnc[i].op;
76 if (rpnp[i].op == OP_NUMBER) {
77 rpnp[i].val = (double) rpnc[i].val;
78 } else if (rpnp[i].op == OP_VARIABLE || rpnp[i].op == OP_PREV_OTHER) {
79 rpnp[i].ptr = (long) rpnc[i].val;
82 /* terminate the sequence */
87 /* rpn_compact2str: convert a compact sequence of RPN operator nodes back
88 * into a CDEF string. This function is used by rrd_dump.
90 * rpnc: an array of compact RPN operator nodes
91 * ds_def: a pointer to the data source definition section of an RRD header
92 * for lookup of data source names by index
93 * str: out string, memory is allocated by the function, must be freed by the
100 unsigned short i, offset = 0;
101 char buffer[7]; /* short as a string */
103 for (i = 0; rpnc[i].op != OP_END; i++) {
105 (*str)[offset++] = ',';
107 #define add_op(VV,VVV) \
108 if (addop2str(rpnc[i].op, VV, VVV, str, &offset) == 1) continue;
110 if (rpnc[i].op == OP_NUMBER) {
111 /* convert a short into a string */
112 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
113 _itoa(rpnc[i].val, buffer, 10);
115 sprintf(buffer, "%d", rpnc[i].val);
117 add_op(OP_NUMBER, buffer)
120 if (rpnc[i].op == OP_VARIABLE) {
121 char *ds_name = ds_def[rpnc[i].val].ds_nam;
123 add_op(OP_VARIABLE, ds_name)
126 if (rpnc[i].op == OP_PREV_OTHER) {
127 char *ds_name = ds_def[rpnc[i].val].ds_nam;
129 add_op(OP_VARIABLE, ds_name)
133 #define add_op(VV,VVV) \
134 if (addop2str(rpnc[i].op, VV, #VVV, str, &offset) == 1) continue;
144 add_op(OP_FLOOR, FLOOR)
145 add_op(OP_CEIL, CEIL)
158 add_op(OP_LIMIT, LIMIT)
159 add_op(OP_UNKN, UNKN)
161 add_op(OP_NEGINF, NEGINF)
163 add_op(OP_PREV, PREV)
165 add_op(OP_ISINF, ISINF)
167 add_op(OP_LTIME, LTIME)
168 add_op(OP_TIME, TIME)
169 add_op(OP_ATAN2, ATAN2)
170 add_op(OP_ATAN, ATAN)
171 add_op(OP_SQRT, SQRT)
172 add_op(OP_SORT, SORT)
174 add_op(OP_TREND, TREND)
175 add_op(OP_TRENDNAN, TRENDNAN)
176 add_op(OP_RAD2DEG, RAD2DEG)
177 add_op(OP_DEG2RAD, DEG2RAD)
182 (*str)[offset] = '\0';
191 unsigned short *offset)
196 op_len = strlen(op_str);
197 *result_str = (char *) rrd_realloc(*result_str,
199 *offset) * sizeof(char));
200 if (*result_str == NULL) {
201 rrd_set_error("failed to alloc memory in addop2str");
204 strncpy(&((*result_str)[*offset]), op_str, op_len);
217 rpn_cdefds_t *rpnc = NULL;
220 rpnp = rpn_parse((void *) rrd, def, &lookup_DS);
222 rrd_set_error("failed to parse computed data source");
225 /* Check for OP nodes not permitted in COMPUTE DS.
226 * Moved this check from within rpn_compact() because it really is
227 * COMPUTE DS specific. This is less efficient, but creation doesn't
228 * occur too often. */
229 for (i = 0; rpnp[i].op != OP_END; i++) {
230 if (rpnp[i].op == OP_TIME || rpnp[i].op == OP_LTIME ||
231 rpnp[i].op == OP_PREV || rpnp[i].op == OP_COUNT) {
233 ("operators time, ltime, prev and count not supported with DS COMPUTE");
238 if (rpn_compact(rpnp, &rpnc, &count) == -1) {
242 /* copy the compact rpn representation over the ds_def par array */
243 memcpy((void *) &(rrd->ds_def[ds_idx].par[DS_cdef]),
244 (void *) rpnc, count * sizeof(rpn_cdefds_t));
249 /* lookup a data source name in the rrd struct and return the index,
250 * should use ds_match() here except:
251 * (1) need a void * pointer to the rrd
252 * (2) error handling is left to the caller
261 rrd = (rrd_t *) rrd_vptr;
263 for (i = 0; i < rrd->stat_head->ds_cnt; ++i) {
264 if (strcmp(ds_name, rrd->ds_def[i].ds_nam) == 0)
267 /* the caller handles a bad data source name in the rpn string */
271 /* rpn_parse : parse a string and generate a rpnp array; modified
272 * str2rpn() originally included in rrd_graph.c
274 * key_hash: a transparent argument passed to lookup(); conceptually this
275 * is a hash object for lookup of a numeric key given a variable name
276 * expr: the string RPN expression, including variable names
277 * lookup(): a function that retrieves a numeric key given a variable name
281 const char *const expr_const,
282 long (*lookup) (void *,
289 char vname[MAX_VNAME_LEN + 10];
292 expr = (char *) expr_const;
295 if ((rpnp = (rpnp_t *) rrd_realloc(rpnp, (++steps + 2) *
296 sizeof(rpnp_t))) == NULL) {
300 else if ((sscanf(expr, "%lf%n", &rpnp[steps].val, &pos) == 1)
301 && (expr[pos] == ',')) {
302 rpnp[steps].op = OP_NUMBER;
305 #define match_op(VV,VVV) \
306 else if (strncmp(expr, #VVV, strlen(#VVV))==0 && ( expr[strlen(#VVV)] == ',' || expr[strlen(#VVV)] == '\0' )){ \
307 rpnp[steps].op = VV; \
308 expr+=strlen(#VVV); \
312 #define match_op_param(VV,VVV) \
313 else if (sscanf(expr, #VVV "(" DEF_NAM_FMT ")",vname) == 1) { \
315 if ((length = strlen(#VVV)+strlen(vname)+2, \
316 expr[length] == ',' || expr[length] == '\0') ) { \
317 rpnp[steps].op = VV; \
318 rpnp[steps].ptr = (*lookup)(key_hash,vname); \
319 if (rpnp[steps].ptr < 0) { \
322 } else expr+=length; \
331 match_op(OP_SIN, SIN)
332 match_op(OP_COS, COS)
333 match_op(OP_LOG, LOG)
334 match_op(OP_FLOOR, FLOOR)
335 match_op(OP_CEIL, CEIL)
336 match_op(OP_EXP, EXP)
337 match_op(OP_DUP, DUP)
338 match_op(OP_EXC, EXC)
339 match_op(OP_POP, POP)
340 match_op(OP_LTIME, LTIME)
347 match_op(OP_MIN, MIN)
348 match_op(OP_MAX, MAX)
349 match_op(OP_LIMIT, LIMIT)
350 /* order is important here ! .. match longest first */
351 match_op(OP_UNKN, UNKN)
353 match_op(OP_NEGINF, NEGINF)
355 match_op(OP_COUNT, COUNT)
356 match_op_param(OP_PREV_OTHER, PREV)
357 match_op(OP_PREV, PREV)
358 match_op(OP_INF, INF)
359 match_op(OP_ISINF, ISINF)
360 match_op(OP_NOW, NOW)
361 match_op(OP_TIME, TIME)
362 match_op(OP_ATAN2, ATAN2)
363 match_op(OP_ATAN, ATAN)
364 match_op(OP_SQRT, SQRT)
365 match_op(OP_SORT, SORT)
366 match_op(OP_REV, REV)
367 match_op(OP_TREND, TREND)
368 match_op(OP_TRENDNAN, TRENDNAN)
369 match_op(OP_RAD2DEG, RAD2DEG)
370 match_op(OP_DEG2RAD, DEG2RAD)
371 match_op(OP_AVG, AVG)
372 match_op(OP_ABS, ABS)
374 else if ((sscanf(expr, DEF_NAM_FMT "%n", vname, &pos) == 1)
375 && ((rpnp[steps].ptr = (*lookup) (key_hash, vname)) !=
377 rpnp[steps].op = OP_VARIABLE;
394 rpnp[steps + 1].op = OP_END;
399 rpnstack_t *rpnstack)
402 rpnstack->dc_stacksize = 0;
403 rpnstack->dc_stackblock = 100;
407 rpnstack_t *rpnstack)
409 if (rpnstack->s != NULL)
411 rpnstack->dc_stacksize = 0;
414 static int rpn_compare_double(
418 double diff = *((const double *) x) - *((const double *) y);
420 return (diff < 0) ? -1 : (diff > 0) ? 1 : 0;
423 /* rpn_calc: run the RPN calculator; also performs variable substitution;
424 * moved and modified from data_calc() originally included in rrd_graph.c
426 * rpnp : an array of RPN operators (including variable references)
427 * rpnstack : the initialized stack
428 * data_idx : when data_idx is a multiple of rpnp.step, the rpnp.data pointer
429 * is advanced by rpnp.ds_cnt; used only for variable substitution
430 * output : an array of output values; OP_PREV assumes this array contains
431 * the "previous" value at index position output_idx-1; the definition of
432 * "previous" depends on the calling environment
433 * output_idx : an index into the output array in which to store the output
434 * of the RPN calculator
435 * returns: -1 if the computation failed (also calls rrd_set_error)
440 rpnstack_t *rpnstack,
448 /* process each op from the rpn in turn */
449 for (rpi = 0; rpnp[rpi].op != OP_END; rpi++) {
450 /* allocate or grow the stack */
451 if (stptr + 5 > rpnstack->dc_stacksize) {
452 /* could move this to a separate function */
453 rpnstack->dc_stacksize += rpnstack->dc_stackblock;
454 rpnstack->s = rrd_realloc(rpnstack->s,
455 (rpnstack->dc_stacksize) *
456 sizeof(*(rpnstack->s)));
457 if (rpnstack->s == NULL) {
458 rrd_set_error("RPN stack overflow");
462 #define stackunderflow(MINSIZE) \
464 rrd_set_error("RPN stack underflow"); \
468 switch (rpnp[rpi].op) {
470 rpnstack->s[++stptr] = rpnp[rpi].val;
474 /* Sanity check: VDEFs shouldn't make it here */
475 if (rpnp[rpi].ds_cnt == 0) {
476 rrd_set_error("VDEF made it into rpn_calc... aborting");
479 /* make sure we pull the correct value from
480 * the *.data array. Adjust the pointer into
481 * the array acordingly. Advance the ptr one
482 * row in the rra (skip over non-relevant
485 if (rpnp[rpi].op == OP_VARIABLE) {
486 rpnstack->s[++stptr] = *(rpnp[rpi].data);
488 if ((output_idx) <= 0) {
489 rpnstack->s[++stptr] = DNAN;
491 rpnstack->s[++stptr] =
492 *(rpnp[rpi].data - rpnp[rpi].ds_cnt);
496 if (data_idx % rpnp[rpi].step == 0) {
497 rpnp[rpi].data += rpnp[rpi].ds_cnt;
502 rpnstack->s[++stptr] = (output_idx + 1); /* Note: Counter starts at 1 */
505 if ((output_idx) <= 0) {
506 rpnstack->s[++stptr] = DNAN;
508 rpnstack->s[++stptr] = output[output_idx - 1];
512 rpnstack->s[++stptr] = DNAN;
515 rpnstack->s[++stptr] = DINF;
518 rpnstack->s[++stptr] = -DINF;
521 rpnstack->s[++stptr] = (double) time(NULL);
524 /* HACK: this relies on the data_idx being the time,
525 ** which the within-function scope is unaware of */
526 rpnstack->s[++stptr] = (double) data_idx;
529 rpnstack->s[++stptr] =
530 (double) tzoffset(data_idx) + (double) data_idx;
534 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1]
535 + rpnstack->s[stptr];
540 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1]
541 - rpnstack->s[stptr];
546 rpnstack->s[stptr - 1] = (rpnstack->s[stptr - 1])
547 * (rpnstack->s[stptr]);
552 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1]
553 / rpnstack->s[stptr];
558 rpnstack->s[stptr - 1] = fmod(rpnstack->s[stptr - 1]
559 , rpnstack->s[stptr]);
564 rpnstack->s[stptr] = sin(rpnstack->s[stptr]);
568 rpnstack->s[stptr] = atan(rpnstack->s[stptr]);
572 rpnstack->s[stptr] = 57.29577951 * rpnstack->s[stptr];
576 rpnstack->s[stptr] = 0.0174532952 * rpnstack->s[stptr];
580 rpnstack->s[stptr - 1] = atan2(rpnstack->s[stptr - 1],
586 rpnstack->s[stptr] = cos(rpnstack->s[stptr]);
590 rpnstack->s[stptr] = ceil(rpnstack->s[stptr]);
594 rpnstack->s[stptr] = floor(rpnstack->s[stptr]);
598 rpnstack->s[stptr] = log(rpnstack->s[stptr]);
602 rpnstack->s[stptr + 1] = rpnstack->s[stptr];
614 dummy = rpnstack->s[stptr];
615 rpnstack->s[stptr] = rpnstack->s[stptr - 1];
616 rpnstack->s[stptr - 1] = dummy;
621 rpnstack->s[stptr] = exp(rpnstack->s[stptr]);
625 if (isnan(rpnstack->s[stptr - 1]));
626 else if (isnan(rpnstack->s[stptr]))
627 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
629 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1] <
630 rpnstack->s[stptr] ? 1.0 : 0.0;
635 if (isnan(rpnstack->s[stptr - 1]));
636 else if (isnan(rpnstack->s[stptr]))
637 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
639 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1] <=
640 rpnstack->s[stptr] ? 1.0 : 0.0;
645 if (isnan(rpnstack->s[stptr - 1]));
646 else if (isnan(rpnstack->s[stptr]))
647 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
649 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1] >
650 rpnstack->s[stptr] ? 1.0 : 0.0;
655 if (isnan(rpnstack->s[stptr - 1]));
656 else if (isnan(rpnstack->s[stptr]))
657 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
659 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1] >=
660 rpnstack->s[stptr] ? 1.0 : 0.0;
665 if (isnan(rpnstack->s[stptr - 1]));
666 else if (isnan(rpnstack->s[stptr]))
667 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
669 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1] ==
670 rpnstack->s[stptr] ? 0.0 : 1.0;
675 if (isnan(rpnstack->s[stptr - 1]));
676 else if (isnan(rpnstack->s[stptr]))
677 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
679 rpnstack->s[stptr - 1] = rpnstack->s[stptr - 1] ==
680 rpnstack->s[stptr] ? 1.0 : 0.0;
685 rpnstack->s[stptr - 2] = rpnstack->s[stptr - 2] != 0.0 ?
686 rpnstack->s[stptr - 1] : rpnstack->s[stptr];
692 if (isnan(rpnstack->s[stptr - 1]));
693 else if (isnan(rpnstack->s[stptr]))
694 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
695 else if (rpnstack->s[stptr - 1] > rpnstack->s[stptr])
696 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
701 if (isnan(rpnstack->s[stptr - 1]));
702 else if (isnan(rpnstack->s[stptr]))
703 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
704 else if (rpnstack->s[stptr - 1] < rpnstack->s[stptr])
705 rpnstack->s[stptr - 1] = rpnstack->s[stptr];
710 if (isnan(rpnstack->s[stptr - 2]));
711 else if (isnan(rpnstack->s[stptr - 1]))
712 rpnstack->s[stptr - 2] = rpnstack->s[stptr - 1];
713 else if (isnan(rpnstack->s[stptr]))
714 rpnstack->s[stptr - 2] = rpnstack->s[stptr];
715 else if (rpnstack->s[stptr - 2] < rpnstack->s[stptr - 1])
716 rpnstack->s[stptr - 2] = DNAN;
717 else if (rpnstack->s[stptr - 2] > rpnstack->s[stptr])
718 rpnstack->s[stptr - 2] = DNAN;
723 rpnstack->s[stptr] = isnan(rpnstack->s[stptr]) ? 1.0 : 0.0;
727 rpnstack->s[stptr] = isinf(rpnstack->s[stptr]) ? 1.0 : 0.0;
731 rpnstack->s[stptr] = sqrt(rpnstack->s[stptr]);
736 int spn = (int) rpnstack->s[stptr--];
738 stackunderflow(spn - 1);
739 qsort(rpnstack->s + stptr - spn + 1, spn, sizeof(double),
746 int spn = (int) rpnstack->s[stptr--];
749 stackunderflow(spn - 1);
751 p = rpnstack->s + stptr - spn + 1;
752 q = rpnstack->s + stptr;
764 if ((rpi < 2) || (rpnp[rpi - 2].op != OP_VARIABLE)) {
765 rrd_set_error("malformed trend arguments");
768 time_t dur = (time_t) rpnstack->s[stptr];
769 time_t step = (time_t) rpnp[rpi - 2].step;
771 if (output_idx > (int) ceil((float) dur / (float) step)) {
772 int ignorenan = (rpnp[rpi].op == OP_TREND);
779 rpnp[rpi - 2].data[rpnp[rpi - 2].ds_cnt * i--];
780 if (ignorenan || !isnan(val)) {
788 rpnstack->s[--stptr] =
789 (count == 0) ? DNAN : (accum / count);
791 rpnstack->s[--stptr] = DNAN;
797 int i = (int) rpnstack->s[stptr--];
801 stackunderflow(i - 1);
803 double val = rpnstack->s[stptr--];
812 /* now push the result back on stack */
814 rpnstack->s[++stptr] = sum / count;
816 rpnstack->s[++stptr] = DNAN;
822 rpnstack->s[stptr] = fabs(rpnstack->s[stptr]);
827 #undef stackunderflow
830 rrd_set_error("RPN final stack size != 1");
834 output[output_idx] = rpnstack->s[0];
838 /* figure out what the local timezone offset for any point in
839 time was. Return it in seconds */
843 int gm_sec, gm_min, gm_hour, gm_yday, gm_year,
844 l_sec, l_min, l_hour, l_yday, l_year;
854 localtime_r(&now, &t);
861 (l_sec - gm_sec) + (l_min - gm_min) * 60 + (l_hour - gm_hour) * 3600;
862 if (l_yday > gm_yday || l_year > gm_year) {
864 } else if (l_yday < gm_yday || l_year < gm_year) {