X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=src%2Frrd_graph_helper.c;h=508ccbebc53d0b4da8d92e6a19833967b278855e;hp=d325bf0ae538f6dd45799a2804b65bcc8abdbc3d;hb=c112f7c06e534ce7a5a4e25b6f7f742aeb051850;hpb=47fb0693421e20cd23730a24c724cc44c38c145b diff --git a/src/rrd_graph_helper.c b/src/rrd_graph_helper.c index d325bf0..508ccbe 100644 --- a/src/rrd_graph_helper.c +++ b/src/rrd_graph_helper.c @@ -1,81 +1,627 @@ -/********************************************************** - *** Several generic helper functions for rrd_graph.c *** - **********************************************************/ +/**************************************************************************** + * RRDtool 1.2rc3 Copyright by Tobi Oetiker, 1997-2005 + **************************************************************************** + * rrd_graph_helper.c commandline parser functions + * this code was probably writtenn by Alex van den Bogaerdt + ****************************************************************************/ #include "rrd_graph.h" -#include "rrd_graph_helper.h" - -/********************************************************** - *** Helper functions for parsing command file *** - **********************************************************/ - -/* Parse a VNAME followed by an equal sign ( CDEF:VNAME= ) - * - * Input: pointer to argv - * Input: pointer to im structure - * Input: pointer to error string - * Output: number of chars eaten (0 means error) - * - * Usage: n=parse_vname( &argv[i][argstart],&im, "VDEF"); - * if (n==0) { error } else { argstart+=n }; - */ + +#define dprintf if (gdp->debug) printf + +/* Define prototypes for the parsing methods. + Inputs: + char *line - pointer to base of input source + unsigned int eaten - index to next input character (INPUT/OUTPUT) + graph_desc_t *gdp - pointer to a graph description + image_desc_t *im - pointer to an image description +*/ + +int rrd_parse_find_gf (char *, unsigned int *, graph_desc_t *); +int rrd_parse_legend (char *, unsigned int *, graph_desc_t *); +int rrd_parse_color (char *, graph_desc_t *); +int rrd_parse_CF (char *, unsigned int *, graph_desc_t *, enum cf_en *); +int rrd_parse_print (char *, unsigned int *, graph_desc_t *, image_desc_t *); +int rrd_parse_shift (char *, unsigned int *, graph_desc_t *, image_desc_t *); +int rrd_parse_xport (char *, unsigned int *, graph_desc_t *, image_desc_t *); +int rrd_parse_PVHLAST (char *, unsigned int *, graph_desc_t *, image_desc_t *); +int rrd_parse_vname (char *, unsigned int *, graph_desc_t *, image_desc_t *); +int rrd_parse_def (char *, unsigned int *, graph_desc_t *, image_desc_t *); +int rrd_parse_vdef (char *, unsigned int *, graph_desc_t *, image_desc_t *); +int rrd_parse_cdef (char *, unsigned int *, graph_desc_t *, image_desc_t *); + + + int -parse_vname1(cptr,im,err) -char * cptr; -image_desc_t * im; -char * err; -{ - int n=0,vidx; - - sscanf(cptr, DEF_NAM_FMT "=%n",im->gdes[im->gdes_c-1].vname,&n); - - /* Check if the sequence matches, including the - * terminating equal sign */ - if (n==0) { - im_free(im); - rrd_set_error("Can't parse VNAME in %s: '%s'",err,cptr); - return 0; +rrd_parse_find_gf(char *line, unsigned int *eaten, graph_desc_t *gdp) { + char funcname[11],c1=0,c2=0; + int i=0; + + sscanf(&line[*eaten], "DEBUG%n", &i); + if (i) { + gdp->debug=1; + (*eaten)+=i; + i=0; + dprintf("Scanning line '%s'\n",&line[*eaten]); } + sscanf(&line[*eaten], "%10[A-Z]%n%c%c", funcname, &i, &c1, &c2); + if (!i) { + rrd_set_error("Could not make sense out of '%s'",line); + return 1; + } + if ((int)(gdp->gf=gf_conv(funcname)) == -1) { + rrd_set_error("'%s' is not a valid function name", funcname); + return 1; + } + if (gdp->gf == GF_LINE) { + if (c1 < '1' || c1 > '3' || c2 != ':') { + rrd_set_error("Malformed LINE command: %s",line); + return 1; + } + gdp->linewidth=c1-'0'; + i++; + } else { + if (c1 != ':') { + rrd_set_error("Malformed %s command: %s",funcname,line); + return 1; + } + } + *eaten+=++i; + return 0; +} - /* Check if this is an unused variable */ - vidx=find_var(im,im->gdes[im->gdes_c-1].vname); - if (vidx!=-1) { - switch(im->gdes[vidx].gf) { - case GF_DEF: - rrd_set_error("Duplicate variable in %s: '%s' defined as DEF", - err,im->gdes[im->gdes_c-1].vname); - break; - case GF_CDEF: - rrd_set_error("Duplicate variable in %s: '%s' defined as CDEF", - err,im->gdes[im->gdes_c-1].vname); - break; - case GF_VDEF: - rrd_set_error("Duplicate variable in %s: '%s' defined as VDEF", - err,im->gdes[im->gdes_c-1].vname); - break; - default: - rrd_set_error("Duplicate variable in %s: '%s' defined", - err,im->gdes[im->gdes_c-1].vname); - break; - }; - im_free(im); +int +rrd_parse_legend(char *line, unsigned int *eaten, graph_desc_t *gdp) { + int i; + + dprintf("- examining '%s'\n",&line[*eaten]); + + i=scan_for_col(&line[*eaten],FMT_LEG_LEN,gdp->legend); + + *eaten += i; + if (line[*eaten]!='\0' && line[*eaten]!=':') { + rrd_set_error("Legend too long"); + return 1; + } else { + dprintf("- found legend '%s'\n", gdp->legend); return 0; } +} + +int +rrd_parse_color(char *string, graph_desc_t *gdp) { + unsigned int r=0,g=0,b=0,a=0; + int i1=0,i2=0,i3=0; + + if (string[0] != '#') return 1; + sscanf(string, "#%02x%02x%02x%n%02x%n%*s%n", + &r,&g,&b,&i1,&a,&i2,&i3); + + if (i3) return 1; /* garbage after color */ + if (!i2) a=0xFF; + if (!i1) return 1; /* no color after '#' */ + gdp->col = r<<24|g<<16|b<<8|a; + return 0; +} + +int +rrd_parse_CF(char *line, unsigned int *eaten, graph_desc_t *gdp, enum cf_en *cf) { + char symname[CF_NAM_SIZE]; + int i=0; + + sscanf(&line[*eaten], CF_NAM_FMT "%n", symname,&i); + if ((!i)||((line[*eaten+i]!='\0')&&(line[*eaten+i]!=':'))) { + rrd_set_error("Cannot parse CF in '%s'",line); + return 1; + } + (*eaten)+=i; + dprintf("- using CF '%s'\n",symname); + + if ((int)(*cf = cf_conv(symname))==-1) { + rrd_set_error("Unknown CF '%s' in '%s'",symname,line); + return 1; + } + + if (line[*eaten]!='\0') (*eaten)++; + return 0; +} + +/* Parsing old-style xPRINT and new-style xPRINT */ +int +rrd_parse_print(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + /* vname:CF:format in case of DEF-based vname + ** vname:CF:format in case of CDEF-based vname + ** vname:format in case of VDEF-based vname + */ + char tmpstr[MAX_VNAME_LEN+1]; + int i=0; + + sscanf(&line[*eaten], DEF_NAM_FMT ":%n", tmpstr,&i); + if (!i) { + rrd_set_error("Could not parse line '%s'",line); + return 1; + } + (*eaten)+=i; + dprintf("- Found candidate vname '%s'\n",tmpstr); + + if ((gdp->vidx=find_var(im,tmpstr))<0) { + rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line); + return 1; + } + switch (im->gdes[gdp->vidx].gf) { + case GF_DEF: + case GF_CDEF: + dprintf("- vname is of type DEF or CDEF, looking for CF\n"); + if (rrd_parse_CF(line,eaten,gdp,&gdp->cf)) return 1; + break; + case GF_VDEF: + dprintf("- vname is of type VDEF\n"); + break; + default: + rrd_set_error("Encountered unknown type variable '%s'",tmpstr); + return 1; + } + + if (rrd_parse_legend(line,eaten,gdp)) return 1; + /* for *PRINT the legend itself gets renderd later. We only + get the format at this juncture */ + strcpy(gdp->format,gdp->legend); + gdp->legend[0]='\0'; + return 0; +} + +int +rrd_parse_shift(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + char *l = strdup(line + *eaten), *p; + int rc = 1; + + p = strchr(l, ':'); + if (p == NULL) { + rrd_set_error("Invalid SHIFT syntax"); + goto out; + } + *p++ = '\0'; + + if ((gdp->vidx=find_var(im,l))<0) { + rrd_set_error("Not a valid vname: %s in line %s",l,line); + goto out; + } + + /* constant will parse; otherwise, must be VDEF reference */ + if (sscanf(p, "%ld", &gdp->shval) != 1) { + graph_desc_t *vdp; + + if ((gdp->shidx=find_var(im, p))<0) { + rrd_set_error("invalid offset vname: %s", p); + goto out; + } + + vdp = &im->gdes[gdp->shidx]; + if (vdp->gf != GF_VDEF) { + rrd_set_error("offset must specify value or VDEF"); + goto out; + } + } else { + gdp->shidx = -1; + } + + *eaten = strlen(line); + rc = 0; + + out: + free(l); + return rc; +} + +int +rrd_parse_xport(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + char *l = strdup(line + *eaten), *p; + int rc = 1; + + p = strchr(l, ':'); + if (p != NULL) + *p++ = '\0'; + else + p = ""; + + if ((gdp->vidx=find_var(im, l))==-1){ + rrd_set_error("unknown variable '%s'",l); + goto out; + } + + if (strlen(p) >= FMT_LEG_LEN) + *(p + FMT_LEG_LEN) = '\0'; + + strcpy(gdp->legend, p); + *eaten = strlen(line); + rc = 0; + + out: + free(l); + return rc; +} + +/* Parsing of PART, VRULE, HRULE, LINE, AREA, STACK and TICK +** is done in one function. Stacking STACK is silently ignored +** as it is redundant. Stacking PART, VRULE, HRULE or TICK is +** not allowed. The check for color doesn't need to be so strict +** anymore, the user can specify the color '#00000000' and +** effectively circumvent this check, so why bother. +** +** If a number (which is valid to enter) is more than a +** certain amount of characters, it is caught as an error. +** While this is arguable, so is entering fixed numbers +** with more than MAX_VNAME_LEN significant digits. +*/ +int +rrd_parse_PVHLAST(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + int i,j; + int colorfound=0; + char tmpstr[MAX_VNAME_LEN + 10]; /* vname#RRGGBBAA\0 */ + + dprintf("- parsing '%s'\n",&line[*eaten]); + dprintf("- from line '%s'\n",line); + + i=scan_for_col(&line[*eaten],MAX_VNAME_LEN+9,tmpstr); + if (line[*eaten+i]!='\0' && line[*eaten+i]!=':') { + rrd_set_error("Cannot parse line '%s'",line); + return 1; + } + + j=i; while (j>0 && tmpstr[j]!='#') j--; + + if (tmpstr[j]=='#') { + if (rrd_parse_color(&tmpstr[j],gdp)) { + rrd_set_error("Could not parse color in '%s'",tmpstr[j]); + return 1; + } + tmpstr[j]='\0'; + dprintf("- parsed color 0x%08x\n",(unsigned int)gdp->col); + colorfound=1; + } - /* VNAME must start with a character other than numeric */ - if (isdigit(im->gdes[im->gdes_c-1].vname[0])) { - rrd_set_error("Variable in %s starts with a digit: '%s'", - err,im->gdes[im->gdes_c-1].vname); - im_free(im); + dprintf("- examining '%s'\n",tmpstr); + j=0; + if (gdp->gf == GF_VRULE) { + sscanf(tmpstr,"%li%n",&gdp->xrule,&j); + if (j) dprintf("- found time: %li\n",gdp->xrule); + } else { + sscanf(tmpstr,"%lf%n",&gdp->yrule,&j); + if (j) dprintf("- found number: %f\n",gdp->yrule); + } + if (!j) { + if ((gdp->vidx=find_var(im,tmpstr))<0) { + rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line); + return 1; + } + dprintf("- found vname: '%s' vidx %li\n",tmpstr,gdp->vidx); + } + /* "*eaten" is still pointing to the original location, + ** "*eaten +i" is pointing to the character after the color + ** or to the terminating '\0' in which case we're finished. + */ + if (line[*eaten+i]=='\0') { + *eaten+=i; return 0; - }; + } + *eaten+=++i; - /* Reserved words checking. Not at the moment. */ + /* If a color is specified and the only remaining part is + ** ":STACK" then it is assumed to be the legend. An empty + ** legend can be specified as expected. This means the + ** following can be done: LINE1:x#FF0000FF::STACK + */ + if (colorfound) { /* no legend if no color */ + if (gdp->gf == GF_TICK) { + dprintf("- looking for optional number\n"); + sscanf(&line[*eaten],"%lf%n",&gdp->yrule,&j); + if (j) { + dprintf("- found number %f\n",gdp->yrule); + (*eaten)+=j; + if (gdp->yrule > 1.0 || gdp->yrule < -1.0) { + rrd_set_error("Tick factor should be <= 1.0"); + return 1; + } + if (line[*eaten] == ':') + (*eaten)++; + } else { + dprintf("- not found, defaulting to 0.1\n"); + gdp->yrule=0.1; + return 0; + } + } + dprintf("- looking for optional legend\n"); + dprintf("- in '%s'\n",&line[*eaten]); + /* the legend for a graph item must start with "m " the first + m will then be over drawn with a color box. Since there + is ample space I overwrite the first few characters of the line + with the material that I want to see in the legend */ + if (line[*eaten] != '\0' && line[*eaten] != ':'){ + *eaten = *eaten - 2; + line[*eaten] = 'm'; + line[*eaten+1] = ' '; + } + if (rrd_parse_legend(line, eaten, gdp)) return 1; + } + + /* PART, HRULE, VRULE and TICK cannot be stacked. We're finished */ + if ( (gdp->gf == GF_HRULE) + || (gdp->gf == GF_VRULE) +#ifdef WITH_PIECHART + || (gdp->gf == GF_PART) +#endif + || (gdp->gf == GF_TICK) + ) return 0; - return n; + if (line[*eaten]!='\0') { + dprintf("- still more, should be STACK\n"); + (*eaten)++; + j=scan_for_col(&line[*eaten],5,tmpstr); + if (line[*eaten+j]!='\0') { + rrd_set_error("Garbage found where STACK expected"); + return 1; + } + if (!strcmp("STACK",tmpstr)) { + dprintf("- found STACK\n"); + gdp->stack=1; + (*eaten)+=5; + } else { + rrd_set_error("Garbage found where STACK expected"); + return 1; + } + } + return 0; } -/********************************************************** - *** *** - **********************************************************/ +int +rrd_parse_vname(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + char tmpstr[MAX_VNAME_LEN + 10]; + int i=0; + + sscanf(&line[*eaten], DEF_NAM_FMT "=%n", tmpstr,&i); + if (!i) { + rrd_set_error("Cannot parse vname from '%s'",line); + return 1; + } + dprintf("- found candidate '%s'\n",tmpstr); + + if ((gdp->vidx=find_var(im,tmpstr))>=0) { + rrd_set_error("Attempting to reuse '%s'",im->gdes[gdp->vidx].vname); + return 1; + } + strcpy(gdp->vname,tmpstr); + dprintf("- created vname '%s' vidx %lu\n", gdp->vname,im->gdes_c-1); + (*eaten)+=i; + return 0; +} + +int +rrd_parse_def(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + int i=0; + char command[7]; /* step, start, end, reduce */ + char tmpstr[256]; + struct rrd_time_value start_tv,end_tv; + time_t start_tmp=0,end_tmp=0; + char *parsetime_error=NULL; + + start_tv.type = end_tv.type=ABSOLUTE_TIME; + start_tv.offset = end_tv.offset=0; + localtime_r(&gdp->start, &start_tv.tm); + localtime_r(&gdp->end, &end_tv.tm); + + dprintf("- parsing '%s'\n",&line[*eaten]); + dprintf("- from line '%s'\n",line); + + if (rrd_parse_vname(line,eaten,gdp,im)) return 1; + i=scan_for_col(&line[*eaten],254,gdp->rrd); + if (line[*eaten+i]!=':') { + rrd_set_error("Problems reading database name"); + return 1; + } + (*eaten)+=++i; + dprintf("- using file '%s'\n",gdp->rrd); + + i=0; + sscanf(&line[*eaten], DS_NAM_FMT ":%n", gdp->ds_nam,&i); + if (!i) { + rrd_set_error("Cannot parse DS in '%s'",line); + return 1; + } + (*eaten)+=i; + dprintf("- using DS '%s'\n",gdp->ds_nam); + + if (rrd_parse_CF(line,eaten,gdp,&gdp->cf)) return 1; + gdp->cf_reduce = gdp->cf; + + if (line[*eaten]=='\0') return 0; + while (1) { + dprintf("- optional parameter follows: %s\n", &line[*eaten]); + i=0; + sscanf(&line[*eaten], "%6[a-z]=%n", command, &i); + if (!i) { + rrd_set_error("Parse error in '%s'",line); + return 1; + } + (*eaten)+=i; + dprintf("- processing '%s'\n",command); + if (!strcmp("reduce",command)) { + if (rrd_parse_CF(line,eaten,gdp,&gdp->cf_reduce)) return 1; + if (line[*eaten] != '\0') + (*eaten)--; + } else if (!strcmp("step",command)) { + i=0; + sscanf(&line[*eaten],"%lu%n",&gdp->step,&i); + (*eaten)+=i; + dprintf("- using step %lu\n",gdp->step); + } else if (!strcmp("start",command)) { + i=scan_for_col(&line[*eaten],255,tmpstr); + (*eaten)+=i; + if ((parsetime_error = parsetime(tmpstr, &start_tv))) { + rrd_set_error( "start time: %s", parsetime_error ); + return 1; + } + dprintf("- done parsing: '%s'\n",&line[*eaten]); + } else if (!strcmp("end",command)) { + i=scan_for_col(&line[*eaten],255,tmpstr); + (*eaten)+=i; + if ((parsetime_error = parsetime(tmpstr, &end_tv))) { + rrd_set_error( "end time: %s", parsetime_error ); + return 1; + } + dprintf("- done parsing: '%s'\n",&line[*eaten]); + } else { + rrd_set_error("Parse error in '%s'",line); + return 1; + } + if (line[*eaten]=='\0') break; + if (line[*eaten]!=':') { + dprintf("- Expected to see end of string but got '%s'\n",\ + &line[*eaten]); + rrd_set_error("Parse error in '%s'",line); + return 1; + } + (*eaten)++; + } + if (proc_start_end(&start_tv,&end_tv,&start_tmp,&end_tmp) == -1){ + /* error string is set in parsetime.c */ + return 1; + } + if (start_tmp < 3600*24*365*10) { + rrd_set_error("the first entry to fetch should be " + "after 1980 (%ld)",start_tmp); + return 1; + } + + if (end_tmp < start_tmp) { + rrd_set_error("start (%ld) should be less than end (%ld)", + start_tmp, end_tmp); + return 1; + } + + gdp->start = start_tmp; + gdp->end = end_tmp; + + dprintf("- start time %lu\n",gdp->start); + dprintf("- end time %lu\n",gdp->end); + + return 0; +} + +int +rrd_parse_vdef(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + char tmpstr[MAX_VNAME_LEN+1]; /* vname\0 */ + int i=0; + + dprintf("- parsing '%s'\n",&line[*eaten]); + if (rrd_parse_vname(line,eaten,gdp,im)) return 1; + + sscanf(&line[*eaten], DEF_NAM_FMT ",%n", tmpstr,&i); + if (!i) { + rrd_set_error("Cannot parse line '%s'",line); + return 1; + } + if ((gdp->vidx=find_var(im,tmpstr))<0) { + rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line); + return 1; + } + if ( im->gdes[gdp->vidx].gf != GF_DEF + && im->gdes[gdp->vidx].gf != GF_CDEF) { + rrd_set_error("variable '%s' not DEF nor " + "CDEF in VDEF '%s'", tmpstr,gdp->vname); + return 1; + } + dprintf("- found vname: '%s' vidx %li\n",tmpstr,gdp->vidx); + (*eaten)+=i; + + dprintf("- calling vdef_parse with param '%s'\n",&line[*eaten]); + vdef_parse(gdp,&line[*eaten]); + while (line[*eaten]!='\0'&&line[*eaten]!=':') + (*eaten)++; + + return 0; +} + +int +rrd_parse_cdef(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) { + dprintf("- parsing '%s'\n",&line[*eaten]); + if (rrd_parse_vname(line,eaten,gdp,im)) return 1; + if ((gdp->rpnp = rpn_parse( + (void *)im, + &line[*eaten], + &find_var_wrapper) + )==NULL) { + rrd_set_error("invalid rpn expression in: %s",&line[*eaten]); + return 1; + }; + while (line[*eaten]!='\0'&&line[*eaten]!=':') + (*eaten)++; + return 0; +} + +void +rrd_graph_script(int argc, char *argv[], image_desc_t *im, int optno) { + int i; + + for (i=optind+optno;igdes[im->gdes_c-1]; +#ifdef DEBUG + gdp->debug = 1; +#endif + + if (rrd_parse_find_gf(argv[i],&eaten,gdp)) return; + + switch (gdp->gf) { + case GF_SHIFT: /* vname:value */ + if (rrd_parse_shift(argv[i],&eaten,gdp,im)) return; + break; + case GF_XPORT: + if (rrd_parse_xport(argv[i],&eaten,gdp,im)) return; + break; + case GF_PRINT: /* vname:CF:format -or- vname:format */ + case GF_GPRINT: /* vname:CF:format -or- vname:format */ + if (rrd_parse_print(argv[i],&eaten,gdp,im)) return; + break; + case GF_COMMENT: /* text */ + if (rrd_parse_legend(argv[i],&eaten,gdp)) return; + break; +#ifdef WITH_PIECHART + case GF_PART: /* value[#color[:legend]] */ +#endif + case GF_VRULE: /* value#color[:legend] */ + case GF_HRULE: /* value#color[:legend] */ + case GF_LINE: /* vname-or-value[#color[:legend]][:STACK] */ + case GF_AREA: /* vname-or-value[#color[:legend]][:STACK] */ + case GF_STACK: /* vname-or-value[#color[:legend]] */ + case GF_TICK: /* vname#color[:num[:legend]] */ + if (rrd_parse_PVHLAST(argv[i],&eaten,gdp,im)) return; + break; + /* data acquisition */ + case GF_DEF: /* vname=x:DS:CF:[:step=#][:start=#][:end=#] */ + if (rrd_parse_def(argv[i],&eaten,gdp,im)) return; + break; + case GF_CDEF: /* vname=rpn-expression */ + if (rrd_parse_cdef(argv[i],&eaten,gdp,im)) return; + break; + case GF_VDEF: /* vname=rpn-expression */ + if (rrd_parse_vdef(argv[i],&eaten,gdp,im)) return; + break; + } + if (gdp->debug) { + dprintf("used %i out of %i chars\n",eaten,strlen(argv[i])); + dprintf("parsed line: '%s'\n",argv[i]); + dprintf("remaining: '%s'\n",&argv[i][eaten]); + if (eaten >= strlen(argv[i])) + dprintf("Command finished successfully\n"); + } + if (eaten < strlen(argv[i])) { + rrd_set_error("Garbage '%s' after command:\n%s", + &argv[i][eaten],argv[i]); + return; + } + } +}