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)
159 (*str)[offset] = '\0';
163 short addop2str(enum op_en op, enum op_en op_type, char *op_str,
164 char **result_str, unsigned short *offset)
168 op_len = strlen(op_str);
169 *result_str = (char *) rrd_realloc(*result_str,
170 (op_len + 1 + *offset)*sizeof(char));
171 if (*result_str == NULL) {
172 rrd_set_error("failed to alloc memory in addop2str");
175 strncpy(&((*result_str)[*offset]),op_str,op_len);
182 void parseCDEF_DS(char *def,rrd_t *rrd, int ds_idx)
185 rpn_cdefds_t *rpnc = NULL;
188 rpnp = rpn_parse((void*) rrd, def, &lookup_DS);
190 rrd_set_error("failed to parse computed data source %s", def);
193 /* Check for OP nodes not permitted in COMPUTE DS.
194 * Moved this check from within rpn_compact() because it really is
195 * COMPUTE DS specific. This is less efficient, but creation doesn't
196 * occur too often. */
197 for (i = 0; rpnp[i].op != OP_END; i++) {
198 if (rpnp[i].op == OP_TIME || rpnp[i].op == OP_LTIME ||
199 rpnp[i].op == OP_PREV)
202 "operators time, ltime and prev not supported with DS COMPUTE");
207 if (rpn_compact(rpnp,&rpnc,&count) == -1) {
211 /* copy the compact rpn representation over the ds_def par array */
212 memcpy((void*) &(rrd -> ds_def[ds_idx].par[DS_cdef]),
213 (void*) rpnc, count*sizeof(rpn_cdefds_t));
218 /* lookup a data source name in the rrd struct and return the index,
219 * should use ds_match() here except:
220 * (1) need a void * pointer to the rrd
221 * (2) error handling is left to the caller
223 long lookup_DS(void *rrd_vptr,char *ds_name)
228 rrd = (rrd_t *) rrd_vptr;
230 for (i = 0; i < rrd -> stat_head -> ds_cnt; ++i)
232 if(strcmp(ds_name,rrd -> ds_def[i].ds_nam) == 0)
235 /* the caller handles a bad data source name in the rpn string */
239 /* rpn_parse : parse a string and generate a rpnp array; modified
240 * str2rpn() originally included in rrd_graph.c
242 * key_hash: a transparent argument passed to lookup(); conceptually this
243 * is a hash object for lookup of a numeric key given a variable name
244 * expr: the string RPN expression, including variable names
245 * lookup(): a function that retrieves a numeric key given a variable name
248 rpn_parse(void *key_hash,char *expr,long (*lookup)(void *,char*)){
257 if ((rpnp = (rpnp_t *) rrd_realloc(rpnp, (++steps + 2)*
258 sizeof(rpnp_t)))==NULL){
262 else if((sscanf(expr,"%lf%n",&rpnp[steps].val,&pos) == 1) && (expr[pos] == ',')){
263 rpnp[steps].op = OP_NUMBER;
267 #define match_op(VV,VVV) \
268 else if (strncmp(expr, #VVV, strlen(#VVV))==0){ \
269 rpnp[steps].op = VV; \
270 expr+=strlen(#VVV); \
274 #define match_op_param(VV,VVV) \
275 else if (sscanf(expr, #VVV "(" DEF_NAM_FMT ")",vname) == 1) { \
277 if ((length = strlen(#VVV)+strlen(vname)+2, \
278 expr[length] == ',' || expr[length] == '\0') ) { \
279 rpnp[steps].op = VV; \
280 rpnp[steps].ptr = (*lookup)(key_hash,vname); \
281 if (rpnp[steps].ptr < 0) { \
284 } else expr+=length; \
296 match_op(OP_FLOOR,FLOOR)
297 match_op(OP_CEIL,CEIL)
310 match_op(OP_LIMIT,LIMIT)
311 /* order is important here ! .. match longest first */
312 match_op(OP_UNKN,UNKN)
314 match_op(OP_NEGINF,NEGINF)
316 match_op_param(OP_PREV_OTHER,PREV)
317 match_op(OP_PREV,PREV)
319 match_op(OP_ISINF,ISINF)
321 match_op(OP_LTIME,LTIME)
322 match_op(OP_TIME,TIME)
327 else if ((sscanf(expr, DEF_NAM_FMT "%n",
329 && ((rpnp[steps].ptr = (*lookup)(key_hash,vname)) != -1)){
330 rpnp[steps].op = OP_VARIABLE;
347 rpnp[steps+1].op = OP_END;
352 rpnstack_init(rpnstack_t *rpnstack)
354 rpnstack -> s = NULL;
355 rpnstack -> dc_stacksize = 0;
356 rpnstack -> dc_stackblock = 100;
360 rpnstack_free(rpnstack_t *rpnstack)
362 if (rpnstack -> s != NULL)
364 rpnstack -> dc_stacksize = 0;
367 /* rpn_calc: run the RPN calculator; also performs variable substitution;
368 * moved and modified from data_calc() originally included in rrd_graph.c
370 * rpnp : an array of RPN operators (including variable references)
371 * rpnstack : the initialized stack
372 * data_idx : when data_idx is a multiple of rpnp.step, the rpnp.data pointer
373 * is advanced by rpnp.ds_cnt; used only for variable substitution
374 * output : an array of output values; OP_PREV assumes this array contains
375 * the "previous" value at index position output_idx-1; the definition of
376 * "previous" depends on the calling environment
377 * output_idx : an index into the output array in which to store the output
378 * of the RPN calculator
379 * returns: -1 if the computation failed (also calls rrd_set_error)
383 rpn_calc(rpnp_t *rpnp, rpnstack_t *rpnstack, long data_idx,
384 rrd_value_t *output, int output_idx)
389 /* process each op from the rpn in turn */
390 for (rpi=0; rpnp[rpi].op != OP_END; rpi++){
391 /* allocate or grow the stack */
392 if (stptr + 5 > rpnstack -> dc_stacksize){
393 /* could move this to a separate function */
394 rpnstack -> dc_stacksize += rpnstack -> dc_stackblock;
395 rpnstack -> s = rrd_realloc(rpnstack -> s,
396 (rpnstack -> dc_stacksize)*sizeof(*(rpnstack -> s)));
397 if (rpnstack -> s == NULL){
398 rrd_set_error("RPN stack overflow");
403 #define stackunderflow(MINSIZE) \
405 rrd_set_error("RPN stack underflow"); \
409 switch (rpnp[rpi].op){
411 rpnstack -> s[++stptr] = rpnp[rpi].val;
414 /* Sanity check: VDEFs shouldn't make it here */
415 if (rpnp[rpi].ds_cnt == 0) {
416 rrd_set_error("VDEF made it into rpn_calc... aborting");
419 /* make sure we pull the correct value from
420 * the *.data array. Adjust the pointer into
421 * the array acordingly. Advance the ptr one
422 * row in the rra (skip over non-relevant
425 rpnstack -> s[++stptr] = *(rpnp[rpi].data);
426 if (data_idx % rpnp[rpi].step == 0){
427 rpnp[rpi].data += rpnp[rpi].ds_cnt;
432 if ((output_idx-1) <= 0) {
433 rpnstack -> s[++stptr] = DNAN;
435 rpnstack -> s[++stptr] = output[output_idx-1];
439 if ((output_idx-1) <= 0) {
440 rpnstack -> s[++stptr] = DNAN;
442 rpnstack -> s[++stptr] = rpnp[rpnp[rpi].ptr].data[output_idx-1];
446 rpnstack -> s[++stptr] = DNAN;
449 rpnstack -> s[++stptr] = DINF;
452 rpnstack -> s[++stptr] = -DINF;
455 rpnstack -> s[++stptr] = (double)time(NULL);
458 /* HACK: this relies on the data_idx being the time,
459 ** which the within-function scope is unaware of */
460 rpnstack -> s[++stptr] = (double) data_idx;
463 rpnstack -> s[++stptr] =
464 (double) tzoffset(data_idx) + (double)data_idx;
468 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1]
469 + rpnstack -> s[stptr];
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]= fmod( rpnstack -> s[stptr-1]
493 ,rpnstack -> s[stptr]);
498 rpnstack -> s[stptr] = sin(rpnstack -> s[stptr]);
502 rpnstack -> s[stptr] = cos(rpnstack -> s[stptr]);
506 rpnstack -> s[stptr] = ceil(rpnstack -> s[stptr]);
510 rpnstack -> s[stptr] = floor(rpnstack -> s[stptr]);
514 rpnstack -> s[stptr] = log(rpnstack -> s[stptr]);
518 rpnstack -> s[stptr+1] = rpnstack -> s[stptr];
529 dummy = rpnstack -> s[stptr] ;
530 rpnstack -> s[stptr] = rpnstack -> s[stptr-1];
531 rpnstack -> s[stptr-1] = dummy;
536 rpnstack -> s[stptr] = exp(rpnstack -> s[stptr]);
540 if (isnan(rpnstack -> s[stptr-1]))
542 else if (isnan(rpnstack -> s[stptr]))
543 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
545 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] <
546 rpnstack -> s[stptr] ? 1.0 : 0.0;
551 if (isnan(rpnstack -> s[stptr-1]))
553 else if (isnan(rpnstack -> s[stptr]))
554 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
556 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] <=
557 rpnstack -> s[stptr] ? 1.0 : 0.0;
562 if (isnan(rpnstack -> s[stptr-1]))
564 else if (isnan(rpnstack -> s[stptr]))
565 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
567 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >
568 rpnstack -> s[stptr] ? 1.0 : 0.0;
573 if (isnan(rpnstack -> s[stptr-1]))
575 else if (isnan(rpnstack -> s[stptr]))
576 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
578 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] >=
579 rpnstack -> s[stptr] ? 1.0 : 0.0;
584 if (isnan(rpnstack -> s[stptr-1]))
586 else if (isnan(rpnstack -> s[stptr]))
587 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
589 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
590 rpnstack -> s[stptr] ? 0.0 : 1.0;
595 if (isnan(rpnstack -> s[stptr-1]))
597 else if (isnan(rpnstack -> s[stptr]))
598 rpnstack -> s[stptr-1] = rpnstack -> s[stptr];
600 rpnstack -> s[stptr-1] = rpnstack -> s[stptr-1] ==
601 rpnstack -> s[stptr] ? 1.0 : 0.0;
606 rpnstack->s[stptr-2] = rpnstack->s[stptr-2] != 0.0 ?
607 rpnstack->s[stptr-1] : rpnstack->s[stptr];
613 if (isnan(rpnstack->s[stptr-1]))
615 else if (isnan(rpnstack->s[stptr]))
616 rpnstack->s[stptr-1] = rpnstack->s[stptr];
617 else if (rpnstack->s[stptr-1] > rpnstack->s[stptr])
618 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-2]))
635 else if (isnan(rpnstack->s[stptr-1]))
636 rpnstack->s[stptr-2] = rpnstack->s[stptr-1];
637 else if (isnan(rpnstack->s[stptr]))
638 rpnstack->s[stptr-2] = rpnstack->s[stptr];
639 else if (rpnstack->s[stptr-2] < rpnstack->s[stptr-1])
640 rpnstack->s[stptr-2] = DNAN;
641 else if (rpnstack->s[stptr-2] > rpnstack->s[stptr])
642 rpnstack->s[stptr-2] = DNAN;
647 rpnstack->s[stptr] = isnan(rpnstack->s[stptr]) ? 1.0 : 0.0;
651 rpnstack->s[stptr] = isinf(rpnstack->s[stptr]) ? 1.0 : 0.0;
656 #undef stackunderflow
659 rrd_set_error("RPN final stack size != 1");
663 output[output_idx] = rpnstack->s[0];
667 /* figure out what the local timezone offset for any point in
668 time was. Return it in seconds */
670 tzoffset( time_t now ){
671 int gm_sec, gm_min, gm_hour, gm_yday, gm_year,
672 l_sec, l_min, l_hour, l_yday, l_year;
681 localtime_r(&now, &t);
687 off = (l_sec-gm_sec)+(l_min-gm_min)*60+(l_hour-gm_hour)*3600;
688 if ( l_yday > gm_yday || l_year > gm_year){
690 } else if ( l_yday < gm_yday || l_year < gm_year){