src/rrd_fetch.c

   1 /*****************************************************************************
   2  * RRDtool 1.3.2  Copyright by Tobi Oetiker, 1997-2008
   3  *****************************************************************************
   4  * rrd_fetch.c  read date from an rrd to use for further processing
   5  *****************************************************************************
   6  * $Id$
   7  * $Log$
   8  * Revision 1.8  2004/05/18 18:53:03  oetiker
   9  * big spell checking patch -- slif@bellsouth.net
  10  *
  11  * Revision 1.7  2003/11/11 19:46:21  oetiker
  12  * replaced time_value with rrd_time_value as MacOS X introduced a struct of that name in their standard headers
  13  *
  14  * Revision 1.6  2003/01/16 23:27:54  oetiker
  15  * fix border condition in rra selection of rrd_fetch
  16  * -- Stanislav Sinyagin <ssinyagin@yahoo.com>
  17  *
  18  * Revision 1.5  2002/06/23 22:29:40  alex
  19  * Added "step=1800" and such to "DEF"
  20  * Cleaned some of the signed vs. unsigned problems
  21  *
  22  * Revision 1.4  2002/02/01 20:34:49  oetiker
  23  * fixed version number and date/time
  24  *
  25  * Revision 1.3  2001/12/24 06:51:49  alex
  26  * A patch of size 44Kbytes... in short:
  27  *
  28  * Found and repaired the off-by-one error in rrd_fetch_fn().
  29  * As a result I had to remove the hacks in rrd_fetch_fn(),
  30  * rrd_tool.c, vdef_calc(), data_calc(), data_proc() and
  31  * reduce_data().  There may be other places which I didn't
  32  * find so be careful.
  33  *
  34  * Enhanced debugging in rrd_fetch_fn(), it shows the RRA selection
  35  * process.
  36  *
  37  * Added the ability to print VDEF timestamps.  At the moment it
  38  * is a hack, I needed it now to fix the off-by-one error.
  39  * If the format string is "%c" (and nothing else!), the time
  40  * will be printed by both ctime() and as a long int.
  41  *
  42  * Moved some code around (slightly altering it) from rrd_graph()
  43  *   initializing     now in rrd_graph_init()
  44  *   options parsing  now in rrd_graph_options()
  45  *   script parsing   now in rrd_graph_script()
  46  *
  47  * Revision 1.2  2001/12/17 12:48:43  oetiker
  48  * fix overflow error ...
  49  *
  50  * Revision 1.1.1.1  2001/02/25 22:25:05  oetiker
  51  * checkin
  52  *
  53  *****************************************************************************/
  54
  55 #include "rrd_tool.h"
  56 #include "rrd_client.h"
  57
  58 #include "rrd_is_thread_safe.h"
  59 /*#define DEBUG*/
  60
  61 int rrd_fetch(
  62     int argc,
  63     char **argv,
  64     time_t *start,
  65     time_t *end,        /* which time frame do you want ?
  66                          * will be changed to represent reality */
  67     unsigned long *step,    /* which stepsize do you want?
  68                              * will be changed to represent reality */
  69     unsigned long *ds_cnt,  /* number of data sources in file */
  70     char ***ds_namv,    /* names of data sources */
  71     rrd_value_t **data)
  72 {                       /* two dimensional array containing the data */
  73     long      step_tmp = 1;
  74     time_t    start_tmp = 0, end_tmp = 0;
  75     const char *cf;
  76     char *opt_daemon = NULL;
  77     int status;
  78
  79     rrd_time_value_t start_tv, end_tv;
  80     char     *parsetime_error = NULL;
  81     struct option long_options[] = {
  82         {"resolution", required_argument, 0, 'r'},
  83         {"start", required_argument, 0, 's'},
  84         {"end", required_argument, 0, 'e'},
  85         {"daemon", required_argument, 0, 'd'},
  86         {0, 0, 0, 0}
  87     };
  88
  89     optind = 0;
  90     opterr = 0;         /* initialize getopt */
  91
  92     /* init start and end time */
  93     rrd_parsetime("end-24h", &start_tv);
  94     rrd_parsetime("now", &end_tv);
  95
  96     while (1) {
  97         int       option_index = 0;
  98         int       opt;
  99
 100         opt = getopt_long(argc, argv, "r:s:e:d:", long_options, &option_index);
 101
 102         if (opt == EOF)
 103             break;
 104
 105         switch (opt) {
 106         case 's':
 107             if ((parsetime_error = rrd_parsetime(optarg, &start_tv))) {
 108                 rrd_set_error("start time: %s", parsetime_error);
 109                 return -1;
 110             }
 111             break;
 112         case 'e':
 113             if ((parsetime_error = rrd_parsetime(optarg, &end_tv))) {
 114                 rrd_set_error("end time: %s", parsetime_error);
 115                 return -1;
 116             }
 117             break;
 118         case 'r':
 119             step_tmp = atol(optarg);
 120             break;
 121
 122         case 'd':
 123             if (opt_daemon != NULL)
 124                     free (opt_daemon);
 125             opt_daemon = strdup (optarg);
 126             if (opt_daemon == NULL)
 127             {
 128                 rrd_set_error ("strdup failed.");
 129                 return (-1);
 130             }
 131             break;
 132
 133         case '?':
 134             rrd_set_error("unknown option '-%c'", optopt);
 135             return (-1);
 136         }
 137     }
 138
 139
 140     if (rrd_proc_start_end(&start_tv, &end_tv, &start_tmp, &end_tmp) == -1) {
 141         return -1;
 142     }
 143
 144
 145     if (start_tmp < 3600 * 24 * 365 * 10) {
 146         rrd_set_error("the first entry to fetch should be after 1980");
 147         return (-1);
 148     }
 149
 150     if (end_tmp < start_tmp) {
 151         rrd_set_error("start (%ld) should be less than end (%ld)", start_tmp,
 152                       end_tmp);
 153         return (-1);
 154     }
 155
 156     *start = start_tmp;
 157     *end = end_tmp;
 158
 159     if (step_tmp < 1) {
 160         rrd_set_error("step must be >= 1 second");
 161         return -1;
 162     }
 163     *step = step_tmp;
 164
 165     if (optind + 1 >= argc) {
 166         rrd_set_error("not enough arguments");
 167         return -1;
 168     }
 169
 170     if (opt_daemon == NULL)
 171     {
 172         char *temp;
 173
 174         temp = getenv (ENV_RRDCACHED_ADDRESS);
 175         if (temp != NULL)
 176         {
 177             opt_daemon = strdup (temp);
 178             if (opt_daemon == NULL)
 179             {
 180                 rrd_set_error("strdup failed.");
 181                 return (-1);
 182             }
 183         }
 184     }
 185
 186     if (opt_daemon != NULL)
 187     {
 188         status = rrdc_connect (opt_daemon);
 189         if (status != 0)
 190         {
 191             rrd_set_error ("rrdc_connect failed with status %i.", status);
 192             return (-1);
 193         }
 194
 195         status = rrdc_flush (argv[optind]);
 196         if (status != 0)
 197         {
 198             rrd_set_error ("rrdc_flush (%s) failed with status %i.",
 199                     argv[optind], status);
 200             return (-1);
 201         }
 202
 203         rrdc_disconnect ();
 204     } /* if (opt_daemon) */
 205
 206     cf = argv[optind + 1];
 207
 208     status = rrd_fetch_r(argv[optind], cf, start, end, step,
 209             ds_cnt, ds_namv, data);
 210     if (status != 0)
 211         return (-1);
 212     return (0);
 213 }
 214
 215 int rrd_fetch_r(
 216     const char *filename,   /* name of the rrd */
 217     const char *cf,     /* which consolidation function ? */
 218     time_t *start,
 219     time_t *end,        /* which time frame do you want ?
 220                          * will be changed to represent reality */
 221     unsigned long *step,    /* which stepsize do you want?
 222                              * will be changed to represent reality */
 223     unsigned long *ds_cnt,  /* number of data sources in file */
 224     char ***ds_namv,    /* names of data_sources */
 225     rrd_value_t **data)
 226 {                       /* two dimensional array containing the data */
 227     enum cf_en cf_idx;
 228
 229     if ((int) (cf_idx = cf_conv(cf)) == -1) {
 230         return -1;
 231     }
 232
 233     return (rrd_fetch_fn
 234             (filename, cf_idx, start, end, step, ds_cnt, ds_namv, data));
 235 } /* int rrd_fetch_r */
 236
 237 int rrd_fetch_fn(
 238     const char *filename,   /* name of the rrd */
 239     enum cf_en cf_idx,  /* which consolidation function ? */
 240     time_t *start,
 241     time_t *end,        /* which time frame do you want ?
 242                          * will be changed to represent reality */
 243     unsigned long *step,    /* which stepsize do you want?
 244                              * will be changed to represent reality */
 245     unsigned long *ds_cnt,  /* number of data sources in file */
 246     char ***ds_namv,    /* names of data_sources */
 247     rrd_value_t **data)
 248 {                       /* two dimensional array containing the data */
 249     long      i, ii;
 250     time_t    cal_start, cal_end, rra_start_time, rra_end_time;
 251     long      best_full_rra = 0, best_part_rra = 0, chosen_rra =
 252         0, rra_pointer = 0;
 253     long      best_full_step_diff = 0, best_part_step_diff =
 254         0, tmp_step_diff = 0, tmp_match = 0, best_match = 0;
 255     long      full_match, rra_base;
 256     long      start_offset, end_offset;
 257     int       first_full = 1;
 258     int       first_part = 1;
 259     rrd_t     rrd;
 260     rrd_file_t *rrd_file;
 261     rrd_value_t *data_ptr;
 262     unsigned long rows;
 263
 264 #ifdef DEBUG
 265     fprintf(stderr, "Entered rrd_fetch_fn() searching for the best match\n");
 266     fprintf(stderr, "Looking for: start %10lu end %10lu step %5lu\n",
 267             *start, *end, *step);
 268 #endif
 269
 270     rrd_file = rrd_open(filename, &rrd, RRD_READONLY);
 271     if (rrd_file == NULL)
 272         goto err_free;
 273
 274     /* when was the really last update of this file ? */
 275
 276     if (((*ds_namv) =
 277          (char **) malloc(rrd.stat_head->ds_cnt * sizeof(char *))) == NULL) {
 278         rrd_set_error("malloc fetch ds_namv array");
 279         goto err_close;
 280     }
 281
 282     for (i = 0; (unsigned long) i < rrd.stat_head->ds_cnt; i++) {
 283         if ((((*ds_namv)[i]) = malloc(sizeof(char) * DS_NAM_SIZE)) == NULL) {
 284             rrd_set_error("malloc fetch ds_namv entry");
 285             goto err_free_ds_namv;
 286         }
 287         strncpy((*ds_namv)[i], rrd.ds_def[i].ds_nam, DS_NAM_SIZE - 1);
 288         (*ds_namv)[i][DS_NAM_SIZE - 1] = '\0';
 289
 290     }
 291
 292     /* find the rra which best matches the requirements */
 293     for (i = 0; (unsigned) i < rrd.stat_head->rra_cnt; i++) {
 294         if (cf_conv(rrd.rra_def[i].cf_nam) == cf_idx) {
 295
 296             cal_end = (rrd.live_head->last_up - (rrd.live_head->last_up
 297                                                  % (rrd.rra_def[i].pdp_cnt
 298                                                     *
 299                                                     rrd.stat_head->
 300                                                     pdp_step)));
 301             cal_start =
 302                 (cal_end -
 303                  (rrd.rra_def[i].pdp_cnt * rrd.rra_def[i].row_cnt *
 304                   rrd.stat_head->pdp_step));
 305
 306             full_match = *end - *start;
 307 #ifdef DEBUG
 308             fprintf(stderr, "Considering: start %10lu end %10lu step %5lu ",
 309                     cal_start, cal_end,
 310                     rrd.stat_head->pdp_step * rrd.rra_def[i].pdp_cnt);
 311 #endif
 312             /* we need step difference in either full or partial case */
 313             tmp_step_diff = labs(*step - (rrd.stat_head->pdp_step
 314                                           * rrd.rra_def[i].pdp_cnt));
 315             /* best full match */
 316             if (cal_start <= *start) {
 317                 if (first_full || (tmp_step_diff < best_full_step_diff)) {
 318                     first_full = 0;
 319                     best_full_step_diff = tmp_step_diff;
 320                     best_full_rra = i;
 321 #ifdef DEBUG
 322                     fprintf(stderr, "best full match so far\n");
 323                 } else {
 324                     fprintf(stderr, "full match, not best\n");
 325 #endif
 326                 }
 327
 328             } else {
 329                 /* best partial match */
 330                 tmp_match = full_match;
 331                 if (cal_start > *start)
 332                     tmp_match -= (cal_start - *start);
 333                 if (first_part ||
 334                     (best_match < tmp_match) ||
 335                     (best_match == tmp_match &&
 336                      tmp_step_diff < best_part_step_diff)) {
 337 #ifdef DEBUG
 338                     fprintf(stderr, "best partial so far\n");
 339 #endif
 340                     first_part = 0;
 341                     best_match = tmp_match;
 342                     best_part_step_diff = tmp_step_diff;
 343                     best_part_rra = i;
 344                 } else {
 345 #ifdef DEBUG
 346                     fprintf(stderr, "partial match, not best\n");
 347 #endif
 348                 }
 349             }
 350         }
 351     }
 352
 353     /* lets see how the matching went. */
 354     if (first_full == 0)
 355         chosen_rra = best_full_rra;
 356     else if (first_part == 0)
 357         chosen_rra = best_part_rra;
 358     else {
 359         rrd_set_error
 360             ("the RRD does not contain an RRA matching the chosen CF");
 361         goto err_free_all_ds_namv;
 362     }
 363
 364     /* set the wish parameters to their real values */
 365     *step = rrd.stat_head->pdp_step * rrd.rra_def[chosen_rra].pdp_cnt;
 366     *start -= (*start % *step);
 367     *end += (*step - *end % *step);
 368     rows = (*end - *start) / *step + 1;
 369
 370 #ifdef DEBUG
 371     fprintf(stderr,
 372             "We found:    start %10lu end %10lu step %5lu rows  %lu\n",
 373             *start, *end, *step, rows);
 374 #endif
 375
 376 /* Start and end are now multiples of the step size.  The amount of
 377 ** steps we want is (end-start)/step and *not* an extra one.
 378 ** Reasoning:  if step is s and we want to graph from t to t+s,
 379 ** we need exactly ((t+s)-t)/s rows.  The row to collect from the
 380 ** database is the one with time stamp (t+s) which means t to t+s.
 381 */
 382     *ds_cnt = rrd.stat_head->ds_cnt;
 383     if (((*data) = malloc(*ds_cnt * rows * sizeof(rrd_value_t))) == NULL) {
 384         rrd_set_error("malloc fetch data area");
 385         goto err_free_all_ds_namv;
 386     }
 387
 388     data_ptr = (*data);
 389
 390     /* find base address of rra */
 391     rra_base = rrd_file->header_len;
 392     for (i = 0; i < chosen_rra; i++)
 393         rra_base += (*ds_cnt * rrd.rra_def[i].row_cnt * sizeof(rrd_value_t));
 394
 395     /* find start and end offset */
 396     rra_end_time = (rrd.live_head->last_up
 397                     - (rrd.live_head->last_up % *step));
 398     rra_start_time = (rra_end_time
 399                       - (*step * (rrd.rra_def[chosen_rra].row_cnt - 1)));
 400     /* here's an error by one if we don't be careful */
 401     start_offset = (long) (*start + *step - rra_start_time) / (long) *step;
 402     end_offset = (long) (rra_end_time - *end) / (long) *step;
 403 #ifdef DEBUG
 404     fprintf(stderr,
 405             "rra_start %lu, rra_end %lu, start_off %li, end_off %li\n",
 406             rra_start_time, rra_end_time, start_offset, end_offset);
 407 #endif
 408
 409     /* fill the gap at the start if needs be */
 410
 411     if (start_offset <= 0)
 412         rra_pointer = rrd.rra_ptr[chosen_rra].cur_row + 1;
 413     else
 414         rra_pointer = rrd.rra_ptr[chosen_rra].cur_row + 1 + start_offset;
 415
 416     if (rrd_seek(rrd_file, (rra_base + (rra_pointer * (*ds_cnt)
 417                                         * sizeof(rrd_value_t))),
 418                  SEEK_SET) != 0) {
 419         rrd_set_error("seek error in RRA");
 420         goto err_free_data;
 421     }
 422 #ifdef DEBUG
 423     fprintf(stderr, "First Seek: rra_base %lu rra_pointer %lu\n",
 424             rra_base, rra_pointer);
 425 #endif
 426     /* step trough the array */
 427
 428     for (i = start_offset;
 429          i < (signed) rrd.rra_def[chosen_rra].row_cnt - end_offset; i++) {
 430         /* no valid data yet */
 431         if (i < 0) {
 432 #ifdef DEBUG
 433             fprintf(stderr, "pre fetch %li -- ", i);
 434 #endif
 435             for (ii = 0; (unsigned) ii < *ds_cnt; ii++) {
 436                 *(data_ptr++) = DNAN;
 437 #ifdef DEBUG
 438                 fprintf(stderr, "%10.2f ", *(data_ptr - 1));
 439 #endif
 440             }
 441         }
 442         /* past the valid data area */
 443         else if (i >= (signed) rrd.rra_def[chosen_rra].row_cnt) {
 444 #ifdef DEBUG
 445             fprintf(stderr, "past fetch %li -- ", i);
 446 #endif
 447             for (ii = 0; (unsigned) ii < *ds_cnt; ii++) {
 448                 *(data_ptr++) = DNAN;
 449 #ifdef DEBUG
 450                 fprintf(stderr, "%10.2f ", *(data_ptr - 1));
 451 #endif
 452             }
 453         } else {
 454             /* OK we are inside the valid area but the pointer has to
 455              * be wrapped*/
 456             if (rra_pointer >= (signed) rrd.rra_def[chosen_rra].row_cnt) {
 457                 rra_pointer -= rrd.rra_def[chosen_rra].row_cnt;
 458                 if (rrd_seek(rrd_file, (rra_base + rra_pointer * (*ds_cnt)
 459                                         * sizeof(rrd_value_t)),
 460                              SEEK_SET) != 0) {
 461                     rrd_set_error("wrap seek in RRA did fail");
 462                     goto err_free_data;
 463                 }
 464 #ifdef DEBUG
 465                 fprintf(stderr, "wrap seek ...\n");
 466 #endif
 467             }
 468
 469             if (rrd_read(rrd_file, data_ptr, sizeof(rrd_value_t) * (*ds_cnt))
 470                 != (ssize_t) (sizeof(rrd_value_t) * (*ds_cnt))) {
 471                 rrd_set_error("fetching cdp from rra");
 472                 goto err_free_data;
 473             }
 474 #ifdef DEBUG
 475             fprintf(stderr, "post fetch %li -- ", i);
 476             for (ii = 0; ii < *ds_cnt; ii++)
 477                 fprintf(stderr, "%10.2f ", *(data_ptr + ii));
 478 #endif
 479             data_ptr += *ds_cnt;
 480             rra_pointer++;
 481         }
 482 #ifdef DEBUG
 483         fprintf(stderr, "\n");
 484 #endif
 485
 486     }
 487
 488     rrd_close(rrd_file);
 489     return (0);
 490   err_free_data:
 491     free(*data);
 492     *data = NULL;
 493   err_free_all_ds_namv:
 494     for (i = 0; (unsigned long) i < rrd.stat_head->ds_cnt; ++i)
 495         free((*ds_namv)[i]);
 496   err_free_ds_namv:
 497     free(*ds_namv);
 498   err_close:
 499     rrd_close(rrd_file);
 500   err_free:
 501     rrd_free(&rrd);
 502     return (-1);
 503 }