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"
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 */
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 (*str)[offset] = '\0';
164 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
165 char **result_str, unsigned short *offset)
169 op_len = strlen(op_str);
170 *result_str = (char *) rrd_realloc(*result_str,
171 (op_len + 1 + *offset)*sizeof(char));
172 if (*result_str == NULL) {
173 rrd_set_error("failed to alloc memory in addop2str");
176 strncpy(&((*result_str)[*offset]),op_str,op_len);
183 void parseCDEF_DS(char *def,rrd_t *rrd, int ds_idx)
186 rpn_cdefds_t *rpnc = NULL;
189 rpnp = rpn_parse((void*) rrd, def, &lookup_DS);
191 rrd_set_error("failed to parse computed data source %s", def);
194 /* Check for OP nodes not permitted in COMPUTE DS.
195 * Moved this check from within rpn_compact() because it really is
196 * COMPUTE DS specific. This is less efficient, but creation doesn't
197 * occur too often. */
198 for (i = 0; rpnp[i].op != OP_END; i++) {
199 if (rpnp[i].op == OP_TIME || rpnp[i].op == OP_LTIME ||
200 rpnp[i].op == OP_PREV || rpnp[i].op == OP_COUNT)
203 "operators time, ltime, prev and count not supported with DS COMPUTE");
208 if (rpn_compact(rpnp,&rpnc,&count) == -1) {
212 /* copy the compact rpn representation over the ds_def par array */
213 memcpy((void*) &(rrd -> ds_def[ds_idx].par[DS_cdef]),
214 (void*) rpnc, count*sizeof(rpn_cdefds_t));
219 /* lookup a data source name in the rrd struct and return the index,
220 * should use ds_match() here except:
221 * (1) need a void * pointer to the rrd
222 * (2) error handling is left to the caller
224 long lookup_DS(void *rrd_vptr,char *ds_name)
229 rrd = (rrd_t *) rrd_vptr;
231 for (i = 0; i < rrd -> stat_head -> ds_cnt; ++i)
233 if(strcmp(ds_name,rrd -> ds_def[i].ds_nam) == 0)
236 /* the caller handles a bad data source name in the rpn string */
240 /* rpn_parse : parse a string and generate a rpnp array; modified
241 * str2rpn() originally included in rrd_graph.c
243 * key_hash: a transparent argument passed to lookup(); conceptually this
244 * is a hash object for lookup of a numeric key given a variable name
245 * expr: the string RPN expression, including variable names
246 * lookup(): a function that retrieves a numeric key given a variable name
249 rpn_parse(void *key_hash,char *expr,long (*lookup)(void *,char*)){
258 if ((rpnp = (rpnp_t *) rrd_realloc(rpnp, (++steps + 2)*
259 sizeof(rpnp_t)))==NULL){
263 else if((sscanf(expr,"%lf%n",&rpnp[steps].val,&pos) == 1) && (expr[pos] == ',')){
264 rpnp[steps].op = OP_NUMBER;
268 #define match_op(VV,VVV) \
269 else if (strncmp(expr, #VVV, strlen(#VVV))==0){ \
270 rpnp[steps].op = VV; \
271 expr+=strlen(#VVV); \
275 #define match_op_param(VV,VVV) \
276 else if (sscanf(expr, #VVV "(" DEF_NAM_FMT ")",vname) == 1) { \
278 if ((length = strlen(#VVV)+strlen(vname)+2, \
279 expr[length] == ',' || expr[length] == '\0') ) { \
280 rpnp[steps].op = VV; \
281 rpnp[steps].ptr = (*lookup)(key_hash,vname); \
282 if (rpnp[steps].ptr < 0) { \
285 } else expr+=length; \
297 match_op(OP_FLOOR,FLOOR)
298 match_op(OP_CEIL,CEIL)
303 match_op(OP_LTIME,LTIME)
312 match_op(OP_LIMIT,LIMIT)
313 /* order is important here ! .. match longest first */
314 match_op(OP_UNKN,UNKN)
316 match_op(OP_NEGINF,NEGINF)
318 match_op(OP_COUNT,COUNT)
319 match_op_param(OP_PREV_OTHER,PREV)
320 match_op(OP_PREV,PREV)
322 match_op(OP_ISINF,ISINF)
324 match_op(OP_TIME,TIME)
325 match_op(OP_ATAN,ATAN)
330 else if ((sscanf(expr, DEF_NAM_FMT "%n",
332 && ((rpnp[steps].ptr = (*lookup)(key_hash,vname)) != -1)){
333 rpnp[steps].op = OP_VARIABLE;
350 rpnp[steps+1].op = OP_END;
355 rpnstack_init(rpnstack_t *rpnstack)
357 rpnstack -> s = NULL;
358 rpnstack -> dc_stacksize = 0;
359 rpnstack -> dc_stackblock = 100;
363 rpnstack_free(rpnstack_t *rpnstack)
365 if (rpnstack -> s != NULL)
367 rpnstack -> dc_stacksize = 0;
370 /* rpn_calc: run the RPN calculator; also performs variable substitution;
371 * moved and modified from data_calc() originally included in rrd_graph.c
373 * rpnp : an array of RPN operators (including variable references)
374 * rpnstack : the initialized stack
375 * data_idx : when data_idx is a multiple of rpnp.step, the rpnp.data pointer
376 * is advanced by rpnp.ds_cnt; used only for variable substitution
377 * output : an array of output values; OP_PREV assumes this array contains
378 * the "previous" value at index position output_idx-1; the definition of
379 * "previous" depends on the calling environment
380 * output_idx : an index into the output array in which to store the output
381 * of the RPN calculator
382 * returns: -1 if the computation failed (also calls rrd_set_error)
386 rpn_calc(rpnp_t *rpnp, rpnstack_t *rpnstack, long data_idx,
387 rrd_value_t *output, int output_idx)
392 /* process each op from the rpn in turn */
393 for (rpi=0; rpnp[rpi].op != OP_END; rpi++){
394 /* allocate or grow the stack */
395 if (stptr + 5 > rpnstack -> dc_stacksize){
396 /* could move this to a separate function */
397 rpnstack -> dc_stacksize += rpnstack -> dc_stackblock;
398 rpnstack -> s = rrd_realloc(rpnstack -> s,
399 (rpnstack -> dc_stacksize)*sizeof(*(rpnstack -> s)));
400 if (rpnstack -> s == NULL){
401 rrd_set_error("RPN stack overflow");
406 #define stackunderflow(MINSIZE) \
408 rrd_set_error("RPN stack underflow"); \
412 switch (rpnp[rpi].op){
414 rpnstack -> s[++stptr] = rpnp[rpi].val;
417 /* Sanity check: VDEFs shouldn't make it here */
418 if (rpnp[rpi].ds_cnt == 0) {
419 rrd_set_error("VDEF made it into rpn_calc... aborting");
422 /* make sure we pull the correct value from
423 * the *.data array. Adjust the pointer into
424 * the array acordingly. Advance the ptr one
425 * row in the rra (skip over non-relevant
428 rpnstack -> s[++stptr] = *(rpnp[rpi].data);
429 if (data_idx % rpnp[rpi].step == 0){
430 rpnp[rpi].data += rpnp[rpi].ds_cnt;
435 rpnstack -> s[++stptr] = (output_idx+1); /* Note: Counter starts at 1 */
438 if ((output_idx) <= 0) {
439 rpnstack -> s[++stptr] = DNAN;
441 rpnstack -> s[++stptr] = output[output_idx-1];
445 if ((output_idx) <= 0) {
446 rpnstack -> s[++stptr] = DNAN;
448 rpnstack -> s[++stptr] = rpnp[rpnp[rpi].ptr].data[output_idx-1];
452 rpnstack -> s[++stptr] = DNAN;
455 rpnstack -> s[++stptr] = DINF;
458 rpnstack -> s[++stptr] = -DINF;
461 rpnstack -> s[++stptr] = (double)time(NULL);
464 /* HACK: this relies on the data_idx being the time,
465 ** which the within-function scope is unaware of */
466 rpnstack -> s[++stptr] = (double) data_idx;
469 rpnstack -> s[++stptr] =
470 (double) tzoffset(data_idx) + (double)data_idx;
474 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
475 + rpnstack -> s[stptr];
480 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
481 - rpnstack -> s[stptr];
486 rpnstack -> s[stptr-1] = (rpnstack -> s[stptr-1])
487 * (rpnstack -> s[stptr]);
492 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
493 / rpnstack -> s[stptr];
498 rpnstack -> s[stptr-1]= fmod( rpnstack -> s[stptr-1]
499 ,rpnstack -> s[stptr]);
504 rpnstack -> s[stptr] = sin(rpnstack -> s[stptr]);
508 rpnstack -> s[stptr] = atan(rpnstack -> s[stptr]);
512 rpnstack -> s[stptr] = cos(rpnstack -> s[stptr]);
516 rpnstack -> s[stptr] = ceil(rpnstack -> s[stptr]);
520 rpnstack -> s[stptr] = floor(rpnstack -> s[stptr]);
524 rpnstack -> s[stptr] = log(rpnstack -> s[stptr]);
528 rpnstack -> s[stptr+1] = rpnstack -> s[stptr];
539 dummy = rpnstack -> s[stptr] ;
540 rpnstack -> s[stptr] = rpnstack -> s[stptr-1];
541 rpnstack -> s[stptr-1] = dummy;
546 rpnstack -> s[stptr] = exp(rpnstack -> s[stptr]);
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] ? 1.0 : 0.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] ? 0.0 : 1.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 rpnstack->s[stptr-2] = rpnstack->s[stptr-2] != 0.0 ?
617 rpnstack->s[stptr-1] : rpnstack->s[stptr];
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 if (isnan(rpnstack->s[stptr-1]))
635 else if (isnan(rpnstack->s[stptr]))
636 rpnstack->s[stptr-1] = rpnstack->s[stptr];
637 else if (rpnstack->s[stptr-1] < rpnstack->s[stptr])
638 rpnstack->s[stptr-1] = rpnstack->s[stptr];
643 if (isnan(rpnstack->s[stptr-2]))
645 else if (isnan(rpnstack->s[stptr-1]))
646 rpnstack->s[stptr-2] = rpnstack->s[stptr-1];
647 else if (isnan(rpnstack->s[stptr]))
648 rpnstack->s[stptr-2] = rpnstack->s[stptr];
649 else if (rpnstack->s[stptr-2] < rpnstack->s[stptr-1])
650 rpnstack->s[stptr-2] = DNAN;
651 else if (rpnstack->s[stptr-2] > rpnstack->s[stptr])
652 rpnstack->s[stptr-2] = DNAN;
657 rpnstack->s[stptr] = isnan(rpnstack->s[stptr]) ? 1.0 : 0.0;
661 rpnstack->s[stptr] = isinf(rpnstack->s[stptr]) ? 1.0 : 0.0;
666 #undef stackunderflow
669 rrd_set_error("RPN final stack size != 1");
673 output[output_idx] = rpnstack->s[0];
677 /* figure out what the local timezone offset for any point in
678 time was. Return it in seconds */
680 tzoffset( time_t now ){
681 int gm_sec, gm_min, gm_hour, gm_yday, gm_year,
682 l_sec, l_min, l_hour, l_yday, l_year;
691 localtime_r(&now, &t);
697 off = (l_sec-gm_sec)+(l_min-gm_min)*60+(l_hour-gm_hour)*3600;
698 if ( l_yday > gm_yday || l_year > gm_year){
700 } else if ( l_yday < gm_yday || l_year < gm_year){