1 /****************************************************************************
2 * RRDtool 1.2.6 Copyright by Tobi Oetiker, 1997-2005
3 ****************************************************************************
4 * rrd_graph_helper.c commandline parser functions
5 * this code initially written by Alex van den Bogaerdt
6 ****************************************************************************/
10 #define dprintf if (gdp->debug) printf
12 /* Define prototypes for the parsing methods.
14 char *line - pointer to base of input source
15 unsigned int eaten - index to next input character (INPUT/OUTPUT)
16 graph_desc_t *gdp - pointer to a graph description
17 image_desc_t *im - pointer to an image description
20 int rrd_parse_find_gf (char *, unsigned int *, graph_desc_t *);
21 int rrd_parse_legend (char *, unsigned int *, graph_desc_t *);
22 int rrd_parse_color (char *, graph_desc_t *);
23 int rrd_parse_CF (char *, unsigned int *, graph_desc_t *, enum cf_en *);
24 int rrd_parse_print (char *, unsigned int *, graph_desc_t *, image_desc_t *);
25 int rrd_parse_shift (char *, unsigned int *, graph_desc_t *, image_desc_t *);
26 int rrd_parse_xport (char *, unsigned int *, graph_desc_t *, image_desc_t *);
27 int rrd_parse_PVHLAST (char *, unsigned int *, graph_desc_t *, image_desc_t *);
28 int rrd_parse_vname (char *, unsigned int *, graph_desc_t *, image_desc_t *);
29 int rrd_parse_def (char *, unsigned int *, graph_desc_t *, image_desc_t *);
30 int rrd_parse_vdef (char *, unsigned int *, graph_desc_t *, image_desc_t *);
31 int rrd_parse_cdef (char *, unsigned int *, graph_desc_t *, image_desc_t *);
36 rrd_parse_find_gf(char *line, unsigned int *eaten, graph_desc_t *gdp) {
37 char funcname[11],c1=0;
40 /* start an argument with DEBUG to be able to see how it is parsed */
41 sscanf(&line[*eaten], "DEBUG%n", &i);
46 dprintf("Scanning line '%s'\n",&line[*eaten]);
48 sscanf(&line[*eaten], "%10[A-Z]%n%c", funcname, &i, &c1);
50 rrd_set_error("Could not make sense out of '%s'",line);
53 if ((int)(gdp->gf=gf_conv(funcname)) == -1) {
54 rrd_set_error("'%s' is not a valid function name", funcname);
57 dprintf("- found function name '%s'\n",funcname);
60 if (gdp->gf == GF_LINE) {
63 dprintf("- - using default width of 1\n");
67 if (sscanf(&line[*eaten],"%lf%n:",&width,&i)) {
68 if (width < 0 || isnan(width) || isinf(width) ) {
69 rrd_set_error("LINE width is %lf. It must be finite and >= 0 though",width);
73 dprintf("- - using width %f\n",width);
75 rrd_set_error("LINE width: %s",line);
81 rrd_set_error("Malformed %s command: %s",funcname,line);
90 rrd_parse_legend(char *line, unsigned int *eaten, graph_desc_t *gdp) {
93 if (line[*eaten]=='\0' || line[*eaten]==':') {
94 dprintf("- no (or: empty) legend found\n");
98 i=scan_for_col(&line[*eaten],FMT_LEG_LEN,gdp->legend);
102 if (line[*eaten]!='\0' && line[*eaten]!=':') {
103 rrd_set_error("Legend too long");
111 rrd_parse_color(char *string, graph_desc_t *gdp) {
112 unsigned int r=0,g=0,b=0,a=0,i;
114 /* matches the following formats:
122 while (string[i] && isxdigit(string[i])) i++;
123 if (string[i] != '\0') return 1; /* garbage follows hexdigits */
127 sscanf(string, "%1x%1x%1x%1x",&r,&g,&b,&a);
136 sscanf(string, "%02x%02x%02x%02x",&r,&g,&b,&a);
140 return 1; /* wrong number of digits */
142 gdp->col = r<<24|g<<16|b<<8|a;
147 rrd_parse_CF(char *line, unsigned int *eaten, graph_desc_t *gdp, enum cf_en *cf) {
148 char symname[CF_NAM_SIZE];
151 sscanf(&line[*eaten], CF_NAM_FMT "%n", symname,&i);
152 if ((!i)||((line[(*eaten)+i]!='\0')&&(line[(*eaten)+i]!=':'))) {
153 rrd_set_error("Cannot parse CF in '%s'",line);
157 dprintf("- using CF '%s'\n",symname);
159 if ((int)(*cf = cf_conv(symname))==-1) {
160 rrd_set_error("Unknown CF '%s' in '%s'",symname,line);
164 if (line[*eaten]!='\0') (*eaten)++;
168 /* Parsing old-style xPRINT and new-style xPRINT */
170 rrd_parse_print(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
171 /* vname:CF:format in case of DEF-based vname
172 ** vname:CF:format in case of CDEF-based vname
173 ** vname:format in case of VDEF-based vname
175 char tmpstr[MAX_VNAME_LEN+1];
178 sscanf(&line[*eaten], DEF_NAM_FMT ":%n", tmpstr,&i);
180 rrd_set_error("Could not parse line '%s'",line);
184 dprintf("- Found candidate vname '%s'\n",tmpstr);
186 if ((gdp->vidx=find_var(im,tmpstr))<0) {
187 rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line);
190 switch (im->gdes[gdp->vidx].gf) {
193 dprintf("- vname is of type DEF or CDEF, looking for CF\n");
194 if (rrd_parse_CF(line,eaten,gdp,&gdp->cf)) return 1;
197 dprintf("- vname is of type VDEF\n");
200 rrd_set_error("Encountered unknown type variable '%s'",tmpstr);
204 if (rrd_parse_legend(line,eaten,gdp)) return 1;
205 /* for *PRINT the legend itself gets rendered later. We only
206 get the format at this juncture */
207 strcpy(gdp->format,gdp->legend);
213 rrd_parse_shift(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
214 char *l = strdup(line + *eaten), *p;
219 rrd_set_error("Invalid SHIFT syntax");
224 if ((gdp->vidx=find_var(im,l))<0) {
225 rrd_set_error("Not a valid vname: %s in line %s",l,line);
229 /* constant will parse; otherwise, must be VDEF reference */
230 if (sscanf(p, "%ld", &gdp->shval) != 1) {
233 if ((gdp->shidx=find_var(im, p))<0) {
234 rrd_set_error("invalid offset vname: %s", p);
238 vdp = &im->gdes[gdp->shidx];
239 if (vdp->gf != GF_VDEF) {
240 rrd_set_error("offset must specify value or VDEF");
247 *eaten = strlen(line);
256 rrd_parse_xport(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
257 char *l = strdup(line + *eaten), *p;
266 if ((gdp->vidx=find_var(im, l))==-1){
267 rrd_set_error("unknown variable '%s'",l);
271 if (strlen(p) >= FMT_LEG_LEN)
272 *(p + FMT_LEG_LEN) = '\0';
274 strcpy(gdp->legend, p);
275 *eaten = strlen(line);
283 /* Parsing of PART, VRULE, HRULE, LINE, AREA, STACK and TICK
284 ** is done in one function.
286 ** Stacking PART, VRULE, HRULE or TICK is not allowed.
288 ** If a number (which is valid to enter) is more than a
289 ** certain amount of characters, it is caught as an error.
290 ** While this is arguable, so is entering fixed numbers
291 ** with more than MAX_VNAME_LEN significant digits.
294 rrd_parse_PVHLAST(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
297 char tmpstr[MAX_VNAME_LEN + 10]; /* vname#RRGGBBAA\0 */
299 dprintf("- parsing '%s'\n",&line[*eaten]);
301 /* have simpler code in the drawing section */
302 if ( gdp->gf == GF_STACK ){
306 i=scan_for_col(&line[*eaten],MAX_VNAME_LEN+9,tmpstr);
307 if (line[*eaten+i]!='\0' && line[*eaten+i]!=':') {
308 rrd_set_error("Cannot parse line '%s'",line);
312 j=i; while (j>0 && tmpstr[j]!='#') j--;
318 dprintf("- examining value '%s'\n",tmpstr);
320 if (gdp->gf == GF_VRULE) {
321 sscanf(tmpstr,"%li%n",&gdp->xrule,&k);
322 if (k) dprintf("- found time: %li\n",gdp->xrule);
324 sscanf(tmpstr,"%lf%n",&gdp->yrule,&k);
325 if (k) dprintf("- found number: %f\n",gdp->yrule);
328 if ((gdp->vidx=find_var(im,tmpstr))<0) {
329 rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line);
332 dprintf("- found vname: '%s' vidx %li\n",tmpstr,gdp->vidx);
337 dprintf("- examining color '%s'\n",&tmpstr[j]);
338 if (rrd_parse_color(&tmpstr[j],gdp)) {
339 rrd_set_error("Could not parse color in '%s'",&tmpstr[j]);
342 dprintf("- parsed color 0x%08x\n",(unsigned int)gdp->col);
345 dprintf("- no color present in '%s'\n",tmpstr);
348 (*eaten) += i; /* after vname#color */
349 if (line[*eaten]!='\0') {
350 (*eaten)++; /* after colon */
353 if (gdp->gf == GF_TICK) {
354 dprintf("- parsing '%s'\n",&line[*eaten]);
355 dprintf("- looking for optional TICK number\n");
357 sscanf(&line[*eaten],"%lf%n",&gdp->yrule,&j);
359 if (line[*eaten+j]!='\0' && line[*eaten+j]!=':') {
360 rrd_set_error("Cannot parse TICK fraction '%s'",line);
363 dprintf("- found number %f\n",gdp->yrule);
364 if (gdp->yrule > 1.0 || gdp->yrule < -1.0) {
365 rrd_set_error("Tick factor should be <= 1.0");
370 dprintf("- not found, defaulting to 0.1\n");
373 if (line[*eaten] == '\0') {
374 dprintf("- done parsing line\n");
376 } else { if (line[*eaten] == ':') {
379 rrd_set_error("Can't make sense of that TICK line");
385 dprintf("- parsing '%s'\n",&line[*eaten]);
387 /* Legend is next. A legend without a color is an error.
388 ** Stacking an item without having a legend is OK however
389 ** then an empty legend should be specified.
390 ** LINE:val#color:STACK means legend is string "STACK"
391 ** LINE:val#color::STACK means no legend, and do STACK
392 ** LINE:val:STACK is an error (legend but no color)
393 ** LINE:val::STACK means no legend, and do STACK
397 char *linecp = strdup(line);
398 dprintf("- looking for optional legend\n");
400 dprintf("- examining '%s'\n",&line[*eaten]);
401 if (linecp[*eaten] != '\0' && linecp[*eaten] != ':') {
402 /* If the legend is not empty, it has to be prefixed with "m ". This then gets
403 * replaced by the color box later on. */
410 if (rrd_parse_legend(linecp, eaten, gdp)) err=1;
415 dprintf("- found legend '%s'\n", &gdp->legend[2]);
417 dprintf("- skipping empty legend\n");
418 if (line[*eaten] != '\0' && line[*eaten] != ':') {
419 rrd_set_error("Legend set but no color: %s",&line[*eaten]);
423 if (line[*eaten]=='\0') {
424 dprintf("- done parsing line\n");
427 (*eaten)++; /* after colon */
429 /* PART, HRULE, VRULE and TICK cannot be stacked. */
430 if ( (gdp->gf == GF_HRULE)
431 || (gdp->gf == GF_VRULE)
433 || (gdp->gf == GF_PART)
435 || (gdp->gf == GF_TICK)
438 dprintf("- parsing '%s'\n",&line[*eaten]);
439 if (line[*eaten]!='\0') {
440 dprintf("- still more, should be STACK\n");
441 j=scan_for_col(&line[*eaten],5,tmpstr);
442 if (line[*eaten+j]!='\0' && line[*eaten+j]!=':') {
444 rrd_set_error("Garbage found where STACK expected");
447 if (!strcmp("STACK",tmpstr)) {
448 dprintf("- found STACK\n");
452 rrd_set_error("Garbage found where STACK expected");
456 if (line[*eaten]=='\0') {
457 dprintf("- done parsing line\n");
461 dprintf("- parsing '%s'\n",&line[*eaten]);
467 rrd_parse_vname(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
468 char tmpstr[MAX_VNAME_LEN + 10];
471 sscanf(&line[*eaten], DEF_NAM_FMT "=%n", tmpstr,&i);
473 rrd_set_error("Cannot parse vname from '%s'",line);
476 dprintf("- found candidate '%s'\n",tmpstr);
478 if ((gdp->vidx=find_var(im,tmpstr))>=0) {
479 rrd_set_error("Attempting to reuse '%s'",im->gdes[gdp->vidx].vname);
482 strcpy(gdp->vname,tmpstr);
483 dprintf("- created vname '%s' vidx %lu\n", gdp->vname,im->gdes_c-1);
489 rrd_parse_def(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
491 char command[7]; /* step, start, end, reduce */
493 struct rrd_time_value start_tv,end_tv;
494 time_t start_tmp=0,end_tmp=0;
495 char *parsetime_error=NULL;
497 start_tv.type = end_tv.type=ABSOLUTE_TIME;
498 start_tv.offset = end_tv.offset=0;
499 localtime_r(&gdp->start, &start_tv.tm);
500 localtime_r(&gdp->end, &end_tv.tm);
502 dprintf("- parsing '%s'\n",&line[*eaten]);
503 dprintf("- from line '%s'\n",line);
505 if (rrd_parse_vname(line,eaten,gdp,im)) return 1;
506 i=scan_for_col(&line[*eaten],254,gdp->rrd);
507 if (line[*eaten+i]!=':') {
508 rrd_set_error("Problems reading database name");
512 dprintf("- using file '%s'\n",gdp->rrd);
515 sscanf(&line[*eaten], DS_NAM_FMT ":%n", gdp->ds_nam,&i);
517 rrd_set_error("Cannot parse DS in '%s'",line);
521 dprintf("- using DS '%s'\n",gdp->ds_nam);
523 if (rrd_parse_CF(line,eaten,gdp,&gdp->cf)) return 1;
524 gdp->cf_reduce = gdp->cf;
526 if (line[*eaten]=='\0') return 0;
529 dprintf("- optional parameter follows: %s\n", &line[*eaten]);
531 sscanf(&line[*eaten], "%6[a-z]=%n", command, &i);
533 rrd_set_error("Parse error in '%s'",line);
537 dprintf("- processing '%s'\n",command);
538 if (!strcmp("reduce",command)) {
539 if (rrd_parse_CF(line,eaten,gdp,&gdp->cf_reduce)) return 1;
540 if (line[*eaten] != '\0')
542 } else if (!strcmp("step",command)) {
544 sscanf(&line[*eaten],"%lu%n",&gdp->step,&i);
546 dprintf("- using step %lu\n",gdp->step);
547 } else if (!strcmp("start",command)) {
548 i=scan_for_col(&line[*eaten],255,tmpstr);
550 if ((parsetime_error = parsetime(tmpstr, &start_tv))) {
551 rrd_set_error( "start time: %s", parsetime_error );
554 dprintf("- done parsing: '%s'\n",&line[*eaten]);
555 } else if (!strcmp("end",command)) {
556 i=scan_for_col(&line[*eaten],255,tmpstr);
558 if ((parsetime_error = parsetime(tmpstr, &end_tv))) {
559 rrd_set_error( "end time: %s", parsetime_error );
562 dprintf("- done parsing: '%s'\n",&line[*eaten]);
564 rrd_set_error("Parse error in '%s'",line);
567 if (line[*eaten]=='\0') break;
568 if (line[*eaten]!=':') {
569 dprintf("- Expected to see end of string but got '%s'\n",\
571 rrd_set_error("Parse error in '%s'",line);
576 if (proc_start_end(&start_tv,&end_tv,&start_tmp,&end_tmp) == -1){
577 /* error string is set in parsetime.c */
580 if (start_tmp < 3600*24*365*10) {
581 rrd_set_error("the first entry to fetch should be "
582 "after 1980 (%ld)",start_tmp);
586 if (end_tmp < start_tmp) {
587 rrd_set_error("start (%ld) should be less than end (%ld)",
592 gdp->start = start_tmp;
595 dprintf("- start time %lu\n",gdp->start);
596 dprintf("- end time %lu\n",gdp->end);
602 rrd_parse_vdef(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
603 char tmpstr[MAX_VNAME_LEN+1]; /* vname\0 */
606 dprintf("- parsing '%s'\n",&line[*eaten]);
607 if (rrd_parse_vname(line,eaten,gdp,im)) return 1;
609 sscanf(&line[*eaten], DEF_NAM_FMT ",%n", tmpstr,&i);
611 rrd_set_error("Cannot parse line '%s'",line);
614 if ((gdp->vidx=find_var(im,tmpstr))<0) {
615 rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line);
618 if ( im->gdes[gdp->vidx].gf != GF_DEF
619 && im->gdes[gdp->vidx].gf != GF_CDEF) {
620 rrd_set_error("variable '%s' not DEF nor "
621 "CDEF in VDEF '%s'", tmpstr,gdp->vname);
624 dprintf("- found vname: '%s' vidx %li\n",tmpstr,gdp->vidx);
627 dprintf("- calling vdef_parse with param '%s'\n",&line[*eaten]);
628 vdef_parse(gdp,&line[*eaten]);
629 while (line[*eaten]!='\0'&&line[*eaten]!=':')
636 rrd_parse_cdef(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
637 dprintf("- parsing '%s'\n",&line[*eaten]);
638 if (rrd_parse_vname(line,eaten,gdp,im)) return 1;
639 if ((gdp->rpnp = rpn_parse(
644 rrd_set_error("invalid rpn expression in: %s",&line[*eaten]);
647 while (line[*eaten]!='\0'&&line[*eaten]!=':')
653 rrd_graph_script(int argc, char *argv[], image_desc_t *im, int optno) {
656 for (i=optind+optno;i<argc;i++) {
658 unsigned int eaten=0;
660 if (gdes_alloc(im)) return; /* the error string is already set */
661 gdp = &im->gdes[im->gdes_c-1];
666 if (rrd_parse_find_gf(argv[i],&eaten,gdp)) return;
669 case GF_SHIFT: /* vname:value */
670 if (rrd_parse_shift(argv[i],&eaten,gdp,im)) return;
673 if (rrd_parse_xport(argv[i],&eaten,gdp,im)) return;
675 case GF_PRINT: /* vname:CF:format -or- vname:format */
676 case GF_GPRINT: /* vname:CF:format -or- vname:format */
677 if (rrd_parse_print(argv[i],&eaten,gdp,im)) return;
679 case GF_COMMENT: /* text */
680 if (rrd_parse_legend(argv[i],&eaten,gdp)) return;
682 case GF_STACK: /* vname-or-value[#color[:legend]] */
684 case GF_PART: /* value[#color[:legend]] */
686 case GF_VRULE: /* value#color[:legend] */
687 case GF_HRULE: /* value#color[:legend] */
688 case GF_LINE: /* vname-or-value[#color[:legend]][:STACK] */
689 case GF_AREA: /* vname-or-value[#color[:legend]][:STACK] */
690 case GF_TICK: /* vname#color[:num[:legend]] */
691 if (rrd_parse_PVHLAST(argv[i],&eaten,gdp,im)) return;
693 /* data acquisition */
694 case GF_DEF: /* vname=x:DS:CF:[:step=#][:start=#][:end=#] */
695 if (rrd_parse_def(argv[i],&eaten,gdp,im)) return;
697 case GF_CDEF: /* vname=rpn-expression */
698 if (rrd_parse_cdef(argv[i],&eaten,gdp,im)) return;
700 case GF_VDEF: /* vname=rpn-expression */
701 if (rrd_parse_vdef(argv[i],&eaten,gdp,im)) return;
705 dprintf("used %i out of %i chars\n",eaten,strlen(argv[i]));
706 dprintf("parsed line: '%s'\n",argv[i]);
707 dprintf("remaining: '%s'\n",&argv[i][eaten]);
708 if (eaten >= strlen(argv[i]))
709 dprintf("Command finished successfully\n");
711 if (eaten < strlen(argv[i])) {
712 rrd_set_error("Garbage '%s' after command:\n%s",
713 &argv[i][eaten],argv[i]);