1 /*****************************************************************************
2 * RRDtool 1.4.3 Copyright by Tobi Oetiker, 1997-2010
3 *****************************************************************************
4 * rrd_fetch.c read date from an rrd to use for further processing
5 *****************************************************************************
8 * Revision 1.8 2004/05/18 18:53:03 oetiker
9 * big spell checking patch -- slif@bellsouth.net
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
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>
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
22 * Revision 1.4 2002/02/01 20:34:49 oetiker
23 * fixed version number and date/time
25 * Revision 1.3 2001/12/24 06:51:49 alex
26 * A patch of size 44Kbytes... in short:
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
34 * Enhanced debugging in rrd_fetch_fn(), it shows the RRA selection
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.
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()
47 * Revision 1.2 2001/12/17 12:48:43 oetiker
48 * fix overflow error ...
50 * Revision 1.1.1.1 2001/02/25 22:25:05 oetiker
53 *****************************************************************************/
56 #include "rrd_client.h"
58 #include "rrd_is_thread_safe.h"
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 */
72 { /* two dimensional array containing the data */
74 time_t start_tmp = 0, end_tmp = 0;
76 char *opt_daemon = NULL;
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'},
90 opterr = 0; /* initialize getopt */
92 /* init start and end time */
93 rrd_parsetime("end-24h", &start_tv);
94 rrd_parsetime("now", &end_tv);
100 opt = getopt_long(argc, argv, "r:s:e:d:", long_options, &option_index);
107 if ((parsetime_error = rrd_parsetime(optarg, &start_tv))) {
108 rrd_set_error("start time: %s", parsetime_error);
113 if ((parsetime_error = rrd_parsetime(optarg, &end_tv))) {
114 rrd_set_error("end time: %s", parsetime_error);
119 step_tmp = atol(optarg);
123 if (opt_daemon != NULL)
125 opt_daemon = strdup (optarg);
126 if (opt_daemon == NULL)
128 rrd_set_error ("strdup failed.");
134 rrd_set_error("unknown option '-%c'", optopt);
140 if (rrd_proc_start_end(&start_tv, &end_tv, &start_tmp, &end_tmp) == -1) {
145 if (start_tmp < 3600 * 24 * 365 * 10) {
146 rrd_set_error("the first entry to fetch should be after 1980");
150 if (end_tmp < start_tmp) {
151 rrd_set_error("start (%ld) should be less than end (%ld)", start_tmp,
160 rrd_set_error("step must be >= 1 second");
165 if (optind + 1 >= argc) {
166 rrd_set_error("Usage: rrdtool %s <file> <CF> [options]", argv[0]);
170 cf = argv[optind + 1];
172 rrdc_connect (opt_daemon);
173 if (rrdc_is_connected (opt_daemon))
174 status = rrdc_fetch (argv[optind], cf, start, end, step,
175 ds_cnt, ds_namv, data);
178 status = rrd_fetch_r(argv[optind], cf, start, end, step,
179 ds_cnt, ds_namv, data);
187 const char *filename, /* name of the rrd */
188 const char *cf, /* which consolidation function ? */
190 time_t *end, /* which time frame do you want ?
191 * will be changed to represent reality */
192 unsigned long *step, /* which stepsize do you want?
193 * will be changed to represent reality */
194 unsigned long *ds_cnt, /* number of data sources in file */
195 char ***ds_namv, /* names of data_sources */
197 { /* two dimensional array containing the data */
200 if ((int) (cf_idx = cf_conv(cf)) == -1) {
205 (filename, cf_idx, start, end, step, ds_cnt, ds_namv, data));
206 } /* int rrd_fetch_r */
209 const char *filename, /* name of the rrd */
210 enum cf_en cf_idx, /* which consolidation function ? */
212 time_t *end, /* which time frame do you want ?
213 * will be changed to represent reality */
214 unsigned long *step, /* which stepsize do you want?
215 * will be changed to represent reality */
216 unsigned long *ds_cnt, /* number of data sources in file */
217 char ***ds_namv, /* names of data_sources */
219 { /* two dimensional array containing the data */
221 time_t cal_start, cal_end, rra_start_time, rra_end_time;
222 long best_full_rra = 0, best_part_rra = 0, chosen_rra =
224 long best_full_step_diff = 0, best_part_step_diff =
225 0, tmp_step_diff = 0, tmp_match = 0, best_match = 0;
226 long full_match, rra_base;
227 off_t start_offset, end_offset;
231 rrd_file_t *rrd_file;
232 rrd_value_t *data_ptr;
236 fprintf(stderr, "Entered rrd_fetch_fn() searching for the best match\n");
237 fprintf(stderr, "Looking for: start %10lu end %10lu step %5lu\n",
238 *start, *end, *step);
242 /* handle libdbi datasources */
243 if (strncmp("sql//",filename,5)==0) {
244 return rrd_fetch_fn_libdbi(filename,cf_idx,start,end,step,ds_cnt,ds_namv,data);
249 rrd_file = rrd_open(filename, &rrd, RRD_READONLY);
250 if (rrd_file == NULL)
253 /* when was the really last update of this file ? */
256 (char **) malloc(rrd.stat_head->ds_cnt * sizeof(char *))) == NULL) {
257 rrd_set_error("malloc fetch ds_namv array");
261 for (i = 0; (unsigned long) i < rrd.stat_head->ds_cnt; i++) {
262 if ((((*ds_namv)[i]) = (char*)malloc(sizeof(char) * DS_NAM_SIZE)) == NULL) {
263 rrd_set_error("malloc fetch ds_namv entry");
264 goto err_free_ds_namv;
266 strncpy((*ds_namv)[i], rrd.ds_def[i].ds_nam, DS_NAM_SIZE - 1);
267 (*ds_namv)[i][DS_NAM_SIZE - 1] = '\0';
271 /* find the rra which best matches the requirements */
272 for (i = 0; (unsigned) i < rrd.stat_head->rra_cnt; i++) {
273 enum cf_en rratype=cf_conv(rrd.rra_def[i].cf_nam);
274 /* handle this RRA */
276 /* if we found a direct match */
279 /*if we found a DS with interval 1
280 and CF (requested,available) are MIN,MAX,AVERAGE,LAST
283 /* only if we are on interval 1 */
284 (rrd.rra_def[i].pdp_cnt==1)
286 /* and requested CF is MIN,MAX,AVERAGE,LAST */
287 (cf_idx == CF_MINIMUM)
288 ||(cf_idx == CF_MAXIMUM)
289 ||(cf_idx == CF_AVERAGE)
290 ||(cf_idx == CF_LAST)
293 /* and found CF is MIN,MAX,AVERAGE,LAST */
294 (rratype == CF_MINIMUM)
295 ||(rratype == CF_MAXIMUM)
296 ||(rratype == CF_AVERAGE)
297 ||(rratype == CF_LAST)
302 cal_end = (rrd.live_head->last_up - (rrd.live_head->last_up
303 % (rrd.rra_def[i].pdp_cnt
309 (rrd.rra_def[i].pdp_cnt * rrd.rra_def[i].row_cnt *
310 rrd.stat_head->pdp_step));
312 full_match = *end - *start;
314 fprintf(stderr, "Considering: start %10lu end %10lu step %5lu ",
316 rrd.stat_head->pdp_step * rrd.rra_def[i].pdp_cnt);
318 /* we need step difference in either full or partial case */
319 tmp_step_diff = labs(*step - (rrd.stat_head->pdp_step
320 * rrd.rra_def[i].pdp_cnt));
321 /* best full match */
322 if (cal_start <= *start) {
323 if (first_full || (tmp_step_diff < best_full_step_diff)) {
325 best_full_step_diff = tmp_step_diff;
328 fprintf(stderr, "best full match so far\n");
330 fprintf(stderr, "full match, not best\n");
335 /* best partial match */
336 tmp_match = full_match;
337 if (cal_start > *start)
338 tmp_match -= (cal_start - *start);
340 (best_match < tmp_match) ||
341 (best_match == tmp_match &&
342 tmp_step_diff < best_part_step_diff)) {
344 fprintf(stderr, "best partial so far\n");
347 best_match = tmp_match;
348 best_part_step_diff = tmp_step_diff;
352 fprintf(stderr, "partial match, not best\n");
359 /* lets see how the matching went. */
361 chosen_rra = best_full_rra;
362 else if (first_part == 0)
363 chosen_rra = best_part_rra;
366 ("the RRD does not contain an RRA matching the chosen CF");
367 goto err_free_all_ds_namv;
370 /* set the wish parameters to their real values */
371 *step = rrd.stat_head->pdp_step * rrd.rra_def[chosen_rra].pdp_cnt;
372 *start -= (*start % *step);
373 *end += (*step - *end % *step);
374 rows = (*end - *start) / *step + 1;
378 "We found: start %10lu end %10lu step %5lu rows %lu\n",
379 *start, *end, *step, rows);
382 /* Start and end are now multiples of the step size. The amount of
383 ** steps we want is (end-start)/step and *not* an extra one.
384 ** Reasoning: if step is s and we want to graph from t to t+s,
385 ** we need exactly ((t+s)-t)/s rows. The row to collect from the
386 ** database is the one with time stamp (t+s) which means t to t+s.
388 *ds_cnt = rrd.stat_head->ds_cnt;
389 if (((*data) = (rrd_value_t*)malloc(*ds_cnt * rows * sizeof(rrd_value_t))) == NULL) {
390 rrd_set_error("malloc fetch data area");
391 goto err_free_all_ds_namv;
396 /* find base address of rra */
397 rra_base = rrd_file->header_len;
398 for (i = 0; i < chosen_rra; i++)
399 rra_base += (*ds_cnt * rrd.rra_def[i].row_cnt * sizeof(rrd_value_t));
401 /* find start and end offset */
402 rra_end_time = (rrd.live_head->last_up
403 - (rrd.live_head->last_up % *step));
404 rra_start_time = (rra_end_time
405 - (*step * (rrd.rra_def[chosen_rra].row_cnt - 1)));
406 /* here's an error by one if we don't be careful */
407 start_offset = (long) (*start + *step - rra_start_time) / (long) *step;
408 end_offset = (long) (rra_end_time - *end) / (long) *step;
411 "rra_start %lu, rra_end %lu, start_off %li, end_off %li\n",
412 rra_start_time, rra_end_time, start_offset, end_offset);
414 /* only seek if the start time is before the end time */
415 if (*start <= rra_end_time && *end >= rra_start_time - (off_t)*step ){
416 if (start_offset <= 0)
417 rra_pointer = rrd.rra_ptr[chosen_rra].cur_row + 1;
419 rra_pointer = rrd.rra_ptr[chosen_rra].cur_row + 1 + start_offset;
421 rra_pointer = rra_pointer % (signed) rrd.rra_def[chosen_rra].row_cnt;
423 if (rrd_seek(rrd_file, (rra_base + (rra_pointer * (*ds_cnt)
424 * sizeof(rrd_value_t))),
426 rrd_set_error("seek error in RRA");
430 fprintf(stderr, "First Seek: rra_base %lu rra_pointer %lu\n",
431 rra_base, rra_pointer);
435 /* step trough the array */
437 for (i = start_offset;
438 i < (signed) rrd.rra_def[chosen_rra].row_cnt - end_offset; i++) {
439 /* no valid data yet */
442 fprintf(stderr, "pre fetch %li -- ", i);
444 for (ii = 0; (unsigned) ii < *ds_cnt; ii++) {
445 *(data_ptr++) = DNAN;
447 fprintf(stderr, "%10.2f ", *(data_ptr - 1));
451 /* past the valid data area */
452 else if (i >= (signed) rrd.rra_def[chosen_rra].row_cnt) {
454 fprintf(stderr, "past fetch %li -- ", i);
456 for (ii = 0; (unsigned) ii < *ds_cnt; ii++) {
457 *(data_ptr++) = DNAN;
459 fprintf(stderr, "%10.2f ", *(data_ptr - 1));
463 /* OK we are inside the valid area but the pointer has to
465 if (rra_pointer >= (signed) rrd.rra_def[chosen_rra].row_cnt) {
466 rra_pointer -= rrd.rra_def[chosen_rra].row_cnt;
467 if (rrd_seek(rrd_file, (rra_base + rra_pointer * (*ds_cnt)
468 * sizeof(rrd_value_t)),
470 rrd_set_error("wrap seek in RRA did fail");
474 fprintf(stderr, "wrap seek ...\n");
478 if (rrd_read(rrd_file, data_ptr, sizeof(rrd_value_t) * (*ds_cnt))
479 != (ssize_t) (sizeof(rrd_value_t) * (*ds_cnt))) {
480 rrd_set_error("fetching cdp from rra");
484 fprintf(stderr, "post fetch %li -- ", i);
485 for (ii = 0; ii < *ds_cnt; ii++)
486 fprintf(stderr, "%10.2f ", *(data_ptr + ii));
492 fprintf(stderr, "\n");
503 err_free_all_ds_namv:
504 for (i = 0; (unsigned long) i < rrd.stat_head->ds_cnt; ++i)