src/rrd_tool.c

   1 /*****************************************************************************
   2  * RRDtool 1.1.x  Copyright Tobias Oetiker, 1997 - 2002
   3  *****************************************************************************
   4  * rrd_tool.c  Startup wrapper
   5  *****************************************************************************/
   6
   7 #include "rrd_tool.h"
   8 #include "rrd_xport.h"
   9
  10 void PrintUsage(char *cmd);
  11 int CountArgs(char *aLine);
  12 int CreateArgs(char *, char *, int, char **);
  13 int HandleInputLine(int, char **, FILE*);
  14 #define TRUE            1
  15 #define FALSE           0
  16 #define MAX_LENGTH      10000
  17
  18
  19 void PrintUsage(char *cmd)
  20 {
  21
  22     char help_main[] =
  23            "RRDtool 1.1.x  Copyright 1997-2001 by Tobias Oetiker <tobi@oetiker.ch>\n\n"
  24            "Usage: rrdtool [options] command command_options\n\n";
  25
  26     char help_list[] =
  27            "Valid commands: create, update, graph, dump, restore,\n"
  28            "\t\tlast, info, fetch, tune, resize, xport\n\n";
  29
  30     char help_create[] =
  31            "* create - create a new RRD\n\n"
  32            "\trrdtool create filename [--start|-b start time]\n"
  33            "\t\t[--step|-s step]\n"
  34            "\t\t[DS:ds-name:DST:dst arguments]\n"
  35            "\t\t[RRA:CF:cf arguments]\n\n";
  36
  37     char help_dump[] =
  38            "* dump - dump an RRD to XML\n\n"
  39            "\trrdtool dump filename.rrd >filename.xml\n\n";
  40
  41     char help_info[] =
  42            "* info - returns the configuration and status of the RRD\n\n"
  43            "\trrdtool info filename.rrd\n\n";
  44
  45     char help_restore[] =
  46            "* restore - restore an RRD file from its XML form\n\n"
  47            "\trrdtool restore [--range-check|-r] filename.xml filename.rrd\n\n";
  48
  49     char help_last[] =
  50            "* last - show last update time for RRD\n\n"
  51            "\trrdtool last filename.rrd\n\n";
  52
  53     char help_update[] =
  54            "* update - update an RRD\n\n"
  55            "\trrdtool update filename\n"
  56            "\t\t--template|-t ds-name:ds-name:...\n"
  57            "\t\ttime|N:value[:value...]\n\n"
  58            "\t\tat-time@value[:value...]\n\n"
  59            "\t\t[ time:value[:value...] ..]\n\n";
  60
  61     char help_fetch[] =
  62            "* fetch - fetch data out of an RRD\n\n"
  63            "\trrdtool fetch filename.rrd CF\n"
  64            "\t\t[--resolution|-r resolution]\n"
  65            "\t\t[--start|-s start] [--end|-e end]\n\n";
  66
  67     char help_graph[] =
  68            "* graph - generate a graph from one or several RRD\n\n"
  69            "\trrdtool graph filename [-s|--start seconds] [-e|--end seconds]\n"
  70            "\t\t[-x|--x-grid x-axis grid and label]\n"
  71            "\t\t[--alt-y-grid]\n"
  72            "\t\t[-y|--y-grid y-axis grid and label]\n"
  73            "\t\t[-v|--vertical-label string] [-w|--width pixels]\n"
  74            "\t\t[-h|--height pixels] [-o|--logarithmic]\n"
  75            "\t\t[-u|--upper-limit value] [-z|--lazy]\n"
  76            "\t\t[-l|--lower-limit value] [-r|--rigid]\n"
  77            "\t\t[-g|--no-legend]\n"
  78            "\t\t[--font FONTTAG:size:font]\n"
  79            "\t\t[--zoom factor]\n"
  80            "\t\t[--alt-autoscale]\n"
  81            "\t\t[--alt-autoscale-max]\n"
  82            "\t\t[--units-exponent value]\n"
  83            "\t\t[--step seconds]\n"
  84            "\t\t[-f|--imginfo printfstr]\n"
  85            "\t\t[-a|--imgformat PNG]\n"
  86            "\t\t[-c|--color COLORTAG#rrggbb[aa]] [-t|--title string]\n"
  87            "\t\t[DEF:vname=rrd:ds-name:CF]\n"
  88            "\t\t[CDEF:vname=rpn-expression]\n"
  89            "\t\t[PRINT:vname:CF:format]\n"
  90            "\t\t[GPRINT:vname:CF:format]\n"
  91            "\t\t[HRULE:value#rrggbb[aa][:legend]]\n"
  92            "\t\t[VRULE:value#rrggbb[aa][:legend]]\n"
  93            "\t\t[LINE{1|2|3}:vname[#rrggbb[aa][:legend]]]\n"
  94            "\t\t[AREA:vname[#rrggbb[aa][:legend]]]\n"
  95            "\t\t[STACK:vname[#rrggbb[aa][:legend]]]\n\n";
  96
  97     char help_tune[] =
  98            " * tune -  Modify some basic properties of an RRD\n\n"
  99            "\trrdtool tune filename\n"
 100            "\t\t[--heartbeat|-h ds-name:heartbeat]\n"
 101            "\t\t[--data-source-type|-d ds-name:DST]\n"
 102            "\t\t[--data-source-rename|-r old-name:new-name]\n"
 103            "\t\t[--minimum|-i ds-name:min] [--maximum|-a ds-name:max]\n"
 104            "\t\t[--deltapos scale-value] [--deltaneg scale-value]\n"
 105            "\t\t[--failure-threshold integer]\n"
 106            "\t\t[--window-length integer]\n"
 107            "\t\t[--alpha adaptation-parameter]\n"
 108            "\t\t[--beta adaptation-parameter]\n"
 109            "\t\t[--gamma adaptation-parameter]\n"
 110            "\t\t[--gamma-deviation adaptation-parameter]\n"
 111            "\t\t[--aberrant-reset ds-name]\n\n";
 112
 113     char help_resize[] =
 114            " * resize - alter the lenght of one of the RRAs in an RRD\n\n"
 115            "\trrdtool resize filename rranum GROW|SHRINK rows\n\n";
 116
 117     char help_xport[] =
 118            "* xport - generate XML dump from one or several RRD\n\n"
 119            "\trrdtool xport [-s|--start seconds] [-e|--end seconds]\n"
 120            "\t\t[-m|--maxrows rows]\n"
 121            "\t\t[--step seconds]\n"
 122            "\t\t[DEF:vname=rrd:ds-name:CF]\n"
 123            "\t\t[CDEF:vname=rpn-expression]\n"
 124            "\t\t[XPORT:vname:legend]\n\n";
 125
 126     char help_lic[] =
 127            "RRDtool is distributed under the Terms of the GNU General\n"
 128            "Public License Version 2. (www.gnu.org/copyleft/gpl.html)\n\n"
 129
 130            "For more information read the RRD manpages\n\n";
 131
 132     enum { C_NONE, C_CREATE, C_DUMP, C_INFO, C_RESTORE, C_LAST,
 133            C_UPDATE, C_FETCH, C_GRAPH, C_TUNE, C_RESIZE, C_XPORT };
 134
 135     int help_cmd = C_NONE;
 136
 137     if (cmd)
 138         {
 139             if (!strcmp(cmd,"create"))
 140                 help_cmd = C_CREATE;
 141             else if (!strcmp(cmd,"dump"))
 142                 help_cmd = C_DUMP;
 143             else if (!strcmp(cmd,"info"))
 144                 help_cmd = C_INFO;
 145             else if (!strcmp(cmd,"restore"))
 146                 help_cmd = C_RESTORE;
 147             else if (!strcmp(cmd,"last"))
 148                 help_cmd = C_LAST;
 149             else if (!strcmp(cmd,"update"))
 150                 help_cmd = C_UPDATE;
 151             else if (!strcmp(cmd,"fetch"))
 152                 help_cmd = C_FETCH;
 153             else if (!strcmp(cmd,"graph"))
 154                 help_cmd = C_GRAPH;
 155             else if (!strcmp(cmd,"tune"))
 156                 help_cmd = C_TUNE;
 157             else if (!strcmp(cmd,"resize"))
 158                 help_cmd = C_RESIZE;
 159             else if (!strcmp(cmd,"xport"))
 160                 help_cmd = C_XPORT;
 161         }
 162     fputs(help_main, stdout);
 163     switch (help_cmd)
 164         {
 165             case C_NONE:
 166                 fputs(help_list, stdout);
 167                 break;
 168             case C_CREATE:
 169                 fputs(help_create, stdout);
 170                 break;
 171             case C_DUMP:
 172                 fputs(help_dump, stdout);
 173                 break;
 174             case C_INFO:
 175                 fputs(help_info, stdout);
 176                 break;
 177             case C_RESTORE:
 178                 fputs(help_restore, stdout);
 179                 break;
 180             case C_LAST:
 181                 fputs(help_last, stdout);
 182                 break;
 183             case C_UPDATE:
 184                 fputs(help_update, stdout);
 185                 break;
 186             case C_FETCH:
 187                 fputs(help_fetch, stdout);
 188                 break;
 189             case C_GRAPH:
 190                 fputs(help_graph, stdout);
 191                 break;
 192             case C_TUNE:
 193                 fputs(help_tune, stdout);
 194                 break;
 195             case C_RESIZE:
 196                 fputs(help_resize, stdout);
 197                 break;
 198             case C_XPORT:
 199                 fputs(help_xport, stdout);
 200                 break;
 201         }
 202     fputs(help_lic, stdout);
 203 }
 204
 205
 206 int main(int argc, char *argv[])
 207 {
 208     char **myargv;
 209     char aLine[MAX_LENGTH];
 210 #ifdef MUST_DISABLE_SIGFPE
 211     signal(SIGFPE,SIG_IGN);
 212 #endif
 213 #ifdef MUST_DISABLE_FPMASK
 214     fpsetmask(0);
 215 #endif
 216     if (argc == 1)
 217         {
 218             PrintUsage("");
 219             return 0;
 220         }
 221
 222     if ((argc == 2) && !strcmp("-",argv[1]))
 223         {
 224 #if HAVE_GETRUSAGE
 225           struct rusage  myusage;
 226           struct timeval starttime;
 227           struct timeval currenttime;
 228           struct timezone tz;
 229
 230             tz.tz_minuteswest =0;
 231             tz.tz_dsttime=0;
 232             gettimeofday(&starttime,&tz);
 233 #endif
 234
 235             while (fgets(aLine, sizeof(aLine)-1, stdin)){
 236                 if ((argc = CountArgs(aLine)) == 0)  {
 237                     fprintf(stderr,"ERROR: not enough arguments\n");
 238                 }
 239                 if ((myargv = (char **) malloc((argc+1) *
 240                                                sizeof(char *))) == NULL)   {
 241                     perror("malloc");
 242                     return -1;
 243                 }
 244                 if ((argc=CreateArgs(argv[0], aLine, argc, myargv)) < 0) {
 245                     fprintf(stderr, "ERROR: creating arguments\n");
 246                     return -1;
 247                 }
 248
 249                 if (HandleInputLine(argc, myargv, stdout))
 250                     return -1;
 251                 free(myargv);
 252
 253 #if HAVE_GETRUSAGE
 254                 getrusage(RUSAGE_SELF,&myusage);
 255                 gettimeofday(&currenttime,&tz);
 256                 printf("OK u:%1.2f s:%1.2f r:%1.2f\n",
 257                        (double)myusage.ru_utime.tv_sec+
 258                        (double)myusage.ru_utime.tv_usec/1000000.0,
 259                        (double)myusage.ru_stime.tv_sec+
 260                        (double)myusage.ru_stime.tv_usec/1000000.0,
 261                        (double)(currenttime.tv_sec-starttime.tv_sec)
 262                        +(double)(currenttime.tv_usec-starttime.tv_usec)
 263                        /1000000.0);
 264 #else
 265                 printf("OK\n");
 266 #endif
 267                 fflush(stdout); /* this is important for pipes to work */
 268             }
 269         }
 270     else if (argc == 2)
 271         {
 272                 PrintUsage(argv[1]);
 273                 exit(0);
 274         }
 275     else
 276         HandleInputLine(argc, argv, stderr);
 277     return 0;
 278 }
 279
 280 int HandleInputLine(int argc, char **argv, FILE* out)
 281 {
 282     optind=0; /* reset gnu getopt */
 283     opterr=0; /* no error messages */
 284
 285     if (argc < 3
 286         || strcmp("help", argv[1]) == 0
 287         || strcmp("--help", argv[1]) == 0
 288         || strcmp("-help", argv[1]) == 0
 289         || strcmp("-?", argv[1]) == 0
 290         || strcmp("-h", argv[1]) == 0 ) {
 291         PrintUsage("");
 292         return 0;
 293     }
 294
 295     if (strcmp("create", argv[1]) == 0)
 296         rrd_create(argc-1, &argv[1]);
 297     else if (strcmp("dump", argv[1]) == 0)
 298         rrd_dump(argc-1, &argv[1]);
 299     else if (strcmp("info", argv[1]) == 0){
 300         info_t *data,*save;
 301         data=rrd_info(argc-1, &argv[1]);
 302         while (data) {
 303             save=data;
 304             printf ("%s = ", data->key);
 305             free(data->key);
 306
 307             switch (data->type) {
 308             case RD_I_VAL:
 309                 if (isnan (data->value.u_val))
 310                     printf("NaN");
 311                 else
 312                     printf ("%0.10e", data->value.u_val);
 313                 break;
 314             case RD_I_CNT:
 315                 printf ("%lu", data->value.u_cnt);
 316                 break;
 317             case RD_I_STR:
 318                 printf ("\"%s\"", data->value.u_str);
 319                 free(data->value.u_str);
 320                 break;
 321             }
 322             data = data->next;
 323             free(save);
 324             printf ("\n");
 325         }
 326         free(data);
 327     }
 328
 329     else if (strcmp("--version", argv[1]) == 0 ||
 330              strcmp("version", argv[1]) == 0 ||
 331              strcmp("v", argv[1]) == 0 ||
 332              strcmp("-v", argv[1]) == 0  ||
 333              strcmp("-version", argv[1]) == 0  )
 334         printf("RRDtool 1.1.x  Copyright (C) 1997-2001 by Tobias Oetiker <tobi@oetiker.ch>\n");
 335     else if (strcmp("restore", argv[1]) == 0)
 336         rrd_restore(argc-1, &argv[1]);
 337     else if (strcmp("resize", argv[1]) == 0)
 338         rrd_resize(argc-1, &argv[1]);
 339     else if (strcmp("last", argv[1]) == 0)
 340         printf("%ld\n",rrd_last(argc-1, &argv[1]));
 341     else if (strcmp("update", argv[1]) == 0)
 342         rrd_update(argc-1, &argv[1]);
 343     else if (strcmp("fetch", argv[1]) == 0) {
 344         time_t        start,end;
 345         unsigned long step, ds_cnt,i,ii;
 346         rrd_value_t   *data,*datai;
 347         char          **ds_namv;
 348         if (rrd_fetch(argc-1, &argv[1],&start,&end,&step,&ds_cnt,&ds_namv,&data) != -1) {
 349             datai=data;
 350             printf("           ");
 351             for (i = 0; i<ds_cnt;i++)
 352                 printf("%14s",ds_namv[i]);
 353             printf ("\n\n");
 354             for (i = start+step; i <= end; i += step){
 355                 printf("%10lu:", i);
 356                 for (ii = 0; ii < ds_cnt; ii++)
 357                     printf(" %0.10e", *(datai++));
 358                 printf("\n");
 359             }
 360             for (i=0;i<ds_cnt;i++)
 361                   free(ds_namv[i]);
 362             free(ds_namv);
 363             free (data);
 364         }
 365     } else if (strcmp("xport", argv[1]) == 0) {
 366         int xxsize;
 367         int i = 0, j = 0;
 368         time_t        start,end;
 369         unsigned long step, col_cnt,row_cnt;
 370         rrd_value_t   *data,*ptr;
 371         char          **legend_v;
 372         if(rrd_xport(argc-1, &argv[1], &xxsize,&start,&end,&step,&col_cnt,&legend_v,&data) != -1) {
 373           row_cnt = (end-start)/step;
 374           ptr = data;
 375           printf("<?xml version=\"1.0\" encoding=\"%s\"?>\n\n", XML_ENCODING);
 376           printf("<%s>\n", ROOT_TAG);
 377           printf("  <%s>\n", META_TAG);
 378           printf("    <%s>%lu</%s>\n", META_START_TAG, start+step, META_START_TAG);
 379           printf("    <%s>%lu</%s>\n", META_STEP_TAG, step, META_STEP_TAG);
 380           printf("    <%s>%lu</%s>\n", META_END_TAG, end, META_END_TAG);
 381           printf("    <%s>%lu</%s>\n", META_ROWS_TAG, row_cnt, META_ROWS_TAG);
 382           printf("    <%s>%lu</%s>\n", META_COLS_TAG, col_cnt, META_COLS_TAG);
 383           printf("    <%s>\n", LEGEND_TAG);
 384           for (j = 0; j < col_cnt; j++) {
 385             char *entry = NULL;
 386             entry = legend_v[j];
 387             printf("      <%s>%s</%s>\n", LEGEND_ENTRY_TAG, entry, LEGEND_ENTRY_TAG);
 388             free(entry);
 389           }
 390           free(legend_v);
 391           printf("    </%s>\n", LEGEND_TAG);
 392           printf("  </%s>\n", META_TAG);
 393           printf("  <%s>\n", DATA_TAG);
 394           for (i = start+step; i <= end; i += step) {
 395             printf ("    <%s>", DATA_ROW_TAG);
 396             printf ("<%s>%lu</%s>", COL_TIME_TAG, i, COL_TIME_TAG);
 397             for (j = 0; j < col_cnt; j++) {
 398               rrd_value_t newval = DNAN;
 399               newval = *ptr;
 400               if(isnan(newval)){
 401                 printf("<%s>NaN</%s>", COL_DATA_TAG, COL_DATA_TAG);
 402               } else {
 403                 printf("<%s>%0.10e</%s>", COL_DATA_TAG, newval, COL_DATA_TAG);
 404               };
 405               ptr++;
 406             }
 407             printf("</%s>\n", DATA_ROW_TAG);
 408           }
 409           free(data);
 410           printf("  </%s>\n", DATA_TAG);
 411           printf("</%s>\n", ROOT_TAG);
 412         }
 413     }
 414     else if (strcmp("graph", argv[1]) == 0) {
 415         char **calcpr;
 416         const char *imgfile = argv[2]; /* rrd_graph changes argv pointer */
 417         int xsize, ysize;
 418         int i;
 419         if( rrd_graph(argc-1, &argv[1], &calcpr, &xsize, &ysize) != -1 ) {
 420             if (strcmp(imgfile,"-") != 0)
 421                 printf ("%dx%d\n",xsize,ysize);
 422             if (calcpr) {
 423                 for(i=0;calcpr[i];i++){
 424                     if (strcmp(imgfile,"-") != 0)
 425                         printf("%s\n",calcpr[i]);
 426                     free(calcpr[i]);
 427                 }
 428                 free(calcpr);
 429             }
 430         }
 431
 432     } else if (strcmp("tune", argv[1]) == 0)
 433                 rrd_tune(argc-1, &argv[1]);
 434     else {
 435                 rrd_set_error("unknown function '%s'",argv[1]);
 436     }
 437     if (rrd_test_error()) {
 438         fprintf(out, "ERROR: %s\n",rrd_get_error());
 439         rrd_clear_error();
 440     }
 441     return(0);
 442 }
 443
 444 int CountArgs(char *aLine)
 445 {
 446     int i=0;
 447     int aCount = 0;
 448     int inarg = 0;
 449     while (aLine[i] == ' ') i++;
 450     while (aLine[i] != 0){
 451         if((aLine[i]== ' ') && inarg){
 452             inarg = 0;
 453         }
 454         if((aLine[i]!= ' ') && ! inarg){
 455             inarg = 1;
 456             aCount++;
 457         }
 458         i++;
 459     }
 460     return aCount;
 461 }
 462
 463 /*
 464  * CreateArgs - take a string (aLine) and tokenize
 465  */
 466 int CreateArgs(char *pName, char *aLine, int argc, char **argv)
 467 {
 468     char        *getP, *putP;
 469     char        **pargv = argv;
 470     char        Quote = 0;
 471     int inArg = 0;
 472     int len;
 473
 474     len = strlen(aLine);
 475     /* remove trailing space and newlines */
 476     while (len && aLine[len] <= ' ') {
 477         aLine[len] = 0 ; len--;
 478     }
 479     /* sikp leading blanks */
 480     while (*aLine && *aLine <= ' ') aLine++;
 481
 482     pargv[0] = pName;
 483     argc = 1;
 484     getP = aLine;
 485     putP = aLine;
 486     while (*getP){
 487         switch (*getP) {
 488         case ' ':
 489             if (Quote){
 490                 *(putP++)=*getP;
 491             } else
 492                 if(inArg) {
 493                     *(putP++) = 0;
 494                     inArg = 0;
 495                 }
 496             break;
 497         case '"':
 498         case '\'':
 499             if (Quote != 0) {
 500                 if (Quote == *getP)
 501                     Quote = 0;
 502                 else {
 503                     *(putP++)=*getP;
 504                 }
 505             } else {
 506                 if(!inArg){
 507                     pargv[argc++] = putP;
 508                     inArg=1;
 509                 }
 510                 Quote = *getP;
 511             }
 512             break;
 513         default:
 514             if(!inArg){
 515                 pargv[argc++] = putP;
 516                 inArg=1;
 517             }
 518             *(putP++)=*getP;
 519             break;
 520         }
 521         getP++;
 522     }
 523
 524     *putP = '\0';
 525
 526     if (Quote)
 527         return -1;
 528     else
 529         return argc;
 530 }
 531
 532