1 /*****************************************************************************
2 * RRDtool 1.2.99907080300 Copyright by Tobi Oetiker, 1997-2007
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 *****************************************************************************/
55 #include "rrd_tool.h"
57 #include "rrd_is_thread_safe.h"
58 /*#define DEBUG*/
60 int rrd_fetch(
61 int argc,
62 char **argv,
63 time_t *start,
64 time_t *end, /* which time frame do you want ?
65 * will be changed to represent reality */
66 unsigned long *step, /* which stepsize do you want?
67 * will be changed to represent reality */
68 unsigned long *ds_cnt, /* number of data sources in file */
69 char ***ds_namv, /* names of data sources */
70 rrd_value_t **data)
71 { /* two dimensional array containing the data */
72 long step_tmp = 1;
73 time_t start_tmp = 0, end_tmp = 0;
74 const char *cf;
76 struct rrd_time_value start_tv, end_tv;
77 char *parsetime_error = NULL;
78 struct option long_options[] = {
79 {"resolution", required_argument, 0, 'r'},
80 {"start", required_argument, 0, 's'},
81 {"end", required_argument, 0, 'e'},
82 {0, 0, 0, 0}
83 };
85 optind = 0;
86 opterr = 0; /* initialize getopt */
88 /* init start and end time */
89 parsetime("end-24h", &start_tv);
90 parsetime("now", &end_tv);
92 while (1) {
93 int option_index = 0;
94 int opt;
96 opt = getopt_long(argc, argv, "r:s:e:", long_options, &option_index);
98 if (opt == EOF)
99 break;
101 switch (opt) {
102 case 's':
103 if ((parsetime_error = parsetime(optarg, &start_tv))) {
104 rrd_set_error("start time: %s", parsetime_error);
105 return -1;
106 }
107 break;
108 case 'e':
109 if ((parsetime_error = parsetime(optarg, &end_tv))) {
110 rrd_set_error("end time: %s", parsetime_error);
111 return -1;
112 }
113 break;
114 case 'r':
115 step_tmp = atol(optarg);
116 break;
117 case '?':
118 rrd_set_error("unknown option '-%c'", optopt);
119 return (-1);
120 }
121 }
124 if (proc_start_end(&start_tv, &end_tv, &start_tmp, &end_tmp) == -1) {
125 return -1;
126 }
129 if (start_tmp < 3600 * 24 * 365 * 10) {
130 rrd_set_error("the first entry to fetch should be after 1980");
131 return (-1);
132 }
134 if (end_tmp < start_tmp) {
135 rrd_set_error("start (%ld) should be less than end (%ld)", start_tmp,
136 end_tmp);
137 return (-1);
138 }
140 *start = start_tmp;
141 *end = end_tmp;
143 if (step_tmp < 1) {
144 rrd_set_error("step must be >= 1 second");
145 return -1;
146 }
147 *step = step_tmp;
149 if (optind + 1 >= argc) {
150 rrd_set_error("not enough arguments");
151 return -1;
152 }
154 cf = argv[optind + 1];
156 if (rrd_fetch_r(argv[optind], cf, start, end, step, ds_cnt, ds_namv, data)
157 != 0)
158 return (-1);
159 return (0);
160 }
162 int rrd_fetch_r(
163 const char *filename, /* name of the rrd */
164 const char *cf, /* which consolidation function ? */
165 time_t *start,
166 time_t *end, /* which time frame do you want ?
167 * will be changed to represent reality */
168 unsigned long *step, /* which stepsize do you want?
169 * will be changed to represent reality */
170 unsigned long *ds_cnt, /* number of data sources in file */
171 char ***ds_namv, /* names of data_sources */
172 rrd_value_t **data)
173 { /* two dimensional array containing the data */
174 enum cf_en cf_idx;
176 if ((int) (cf_idx = cf_conv(cf)) == -1) {
177 return -1;
178 }
180 return (rrd_fetch_fn
181 (filename, cf_idx, start, end, step, ds_cnt, ds_namv, data));
182 }
184 int rrd_fetch_fn(
185 const char *filename, /* name of the rrd */
186 enum cf_en cf_idx, /* which consolidation function ? */
187 time_t *start,
188 time_t *end, /* which time frame do you want ?
189 * will be changed to represent reality */
190 unsigned long *step, /* which stepsize do you want?
191 * will be changed to represent reality */
192 unsigned long *ds_cnt, /* number of data sources in file */
193 char ***ds_namv, /* names of data_sources */
194 rrd_value_t **data)
195 { /* two dimensional array containing the data */
196 long i, ii;
197 time_t cal_start, cal_end, rra_start_time, rra_end_time;
198 long best_full_rra = 0, best_part_rra = 0, chosen_rra =
199 0, rra_pointer = 0;
200 long best_full_step_diff = 0, best_part_step_diff =
201 0, tmp_step_diff = 0, tmp_match = 0, best_match = 0;
202 long full_match, rra_base;
203 long start_offset, end_offset;
204 int first_full = 1;
205 int first_part = 1;
206 rrd_t rrd;
207 rrd_file_t *rrd_file;
208 rrd_value_t *data_ptr;
209 unsigned long rows;
211 #ifdef DEBUG
212 fprintf(stderr, "Entered rrd_fetch_fn() searching for the best match\n");
213 fprintf(stderr, "Looking for: start %10lu end %10lu step %5lu\n",
214 *start, *end, *step);
215 #endif
217 rrd_file = rrd_open(filename, &rrd, RRD_READONLY);
218 if (rrd_file == NULL)
219 goto err_free;
221 /* when was the really last update of this file ? */
223 if (((*ds_namv) =
224 (char **) malloc(rrd.stat_head->ds_cnt * sizeof(char *))) == NULL) {
225 rrd_set_error("malloc fetch ds_namv array");
226 goto err_close;
227 }
229 for (i = 0; (unsigned long) i < rrd.stat_head->ds_cnt; i++) {
230 if ((((*ds_namv)[i]) = malloc(sizeof(char) * DS_NAM_SIZE)) == NULL) {
231 rrd_set_error("malloc fetch ds_namv entry");
232 goto err_free_ds_namv;
233 }
234 strncpy((*ds_namv)[i], rrd.ds_def[i].ds_nam, DS_NAM_SIZE - 1);
235 (*ds_namv)[i][DS_NAM_SIZE - 1] = '\0';
237 }
239 /* find the rra which best matches the requirements */
240 for (i = 0; (unsigned) i < rrd.stat_head->rra_cnt; i++) {
241 if (cf_conv(rrd.rra_def[i].cf_nam) == cf_idx) {
243 cal_end = (rrd.live_head->last_up - (rrd.live_head->last_up
244 % (rrd.rra_def[i].pdp_cnt
245 *
246 rrd.stat_head->
247 pdp_step)));
248 cal_start =
249 (cal_end -
250 (rrd.rra_def[i].pdp_cnt * rrd.rra_def[i].row_cnt *
251 rrd.stat_head->pdp_step));
253 full_match = *end - *start;
254 #ifdef DEBUG
255 fprintf(stderr, "Considering: start %10lu end %10lu step %5lu ",
256 cal_start, cal_end,
257 rrd.stat_head->pdp_step * rrd.rra_def[i].pdp_cnt);
258 #endif
259 /* we need step difference in either full or partial case */
260 tmp_step_diff = labs(*step - (rrd.stat_head->pdp_step
261 * rrd.rra_def[i].pdp_cnt));
262 /* best full match */
263 if (cal_start <= *start) {
264 if (first_full || (tmp_step_diff < best_full_step_diff)) {
265 first_full = 0;
266 best_full_step_diff = tmp_step_diff;
267 best_full_rra = i;
268 #ifdef DEBUG
269 fprintf(stderr, "best full match so far\n");
270 } else {
271 fprintf(stderr, "full match, not best\n");
272 #endif
273 }
275 } else {
276 /* best partial match */
277 tmp_match = full_match;
278 if (cal_start > *start)
279 tmp_match -= (cal_start - *start);
280 if (first_part ||
281 (best_match < tmp_match) ||
282 (best_match == tmp_match &&
283 tmp_step_diff < best_part_step_diff)) {
284 #ifdef DEBUG
285 fprintf(stderr, "best partial so far\n");
286 #endif
287 first_part = 0;
288 best_match = tmp_match;
289 best_part_step_diff = tmp_step_diff;
290 best_part_rra = i;
291 } else {
292 #ifdef DEBUG
293 fprintf(stderr, "partial match, not best\n");
294 #endif
295 }
296 }
297 }
298 }
300 /* lets see how the matching went. */
301 if (first_full == 0)
302 chosen_rra = best_full_rra;
303 else if (first_part == 0)
304 chosen_rra = best_part_rra;
305 else {
306 rrd_set_error
307 ("the RRD does not contain an RRA matching the chosen CF");
308 goto err_free_all_ds_namv;
309 }
311 /* set the wish parameters to their real values */
312 *step = rrd.stat_head->pdp_step * rrd.rra_def[chosen_rra].pdp_cnt;
313 *start -= (*start % *step);
314 *end += (*step - *end % *step);
315 rows = (*end - *start) / *step + 1;
317 #ifdef DEBUG
318 fprintf(stderr,
319 "We found: start %10lu end %10lu step %5lu rows %lu\n",
320 *start, *end, *step, rows);
321 #endif
323 /* Start and end are now multiples of the step size. The amount of
324 ** steps we want is (end-start)/step and *not* an extra one.
325 ** Reasoning: if step is s and we want to graph from t to t+s,
326 ** we need exactly ((t+s)-t)/s rows. The row to collect from the
327 ** database is the one with time stamp (t+s) which means t to t+s.
328 */
329 *ds_cnt = rrd.stat_head->ds_cnt;
330 if (((*data) = malloc(*ds_cnt * rows * sizeof(rrd_value_t))) == NULL) {
331 rrd_set_error("malloc fetch data area");
332 goto err_free_all_ds_namv;
333 }
335 data_ptr = (*data);
337 /* find base address of rra */
338 rra_base = rrd_file->header_len;
339 for (i = 0; i < chosen_rra; i++)
340 rra_base += (*ds_cnt * rrd.rra_def[i].row_cnt * sizeof(rrd_value_t));
342 /* find start and end offset */
343 rra_end_time = (rrd.live_head->last_up
344 - (rrd.live_head->last_up % *step));
345 rra_start_time = (rra_end_time
346 - (*step * (rrd.rra_def[chosen_rra].row_cnt - 1)));
347 /* here's an error by one if we don't be careful */
348 start_offset = (long) (*start + *step - rra_start_time) / (long) *step;
349 end_offset = (long) (rra_end_time - *end) / (long) *step;
350 #ifdef DEBUG
351 fprintf(stderr,
352 "rra_start %lu, rra_end %lu, start_off %li, end_off %li\n",
353 rra_start_time, rra_end_time, start_offset, end_offset);
354 #endif
356 /* fill the gap at the start if needs be */
358 if (start_offset <= 0)
359 rra_pointer = rrd.rra_ptr[chosen_rra].cur_row + 1;
360 else
361 rra_pointer = rrd.rra_ptr[chosen_rra].cur_row + 1 + start_offset;
363 if (rrd_seek(rrd_file, (rra_base + (rra_pointer * (*ds_cnt)
364 * sizeof(rrd_value_t))),
365 SEEK_SET) != 0) {
366 rrd_set_error("seek error in RRA");
367 goto err_free_data;
368 }
369 #ifdef DEBUG
370 fprintf(stderr, "First Seek: rra_base %lu rra_pointer %lu\n",
371 rra_base, rra_pointer);
372 #endif
373 /* step trough the array */
375 for (i = start_offset;
376 i < (signed) rrd.rra_def[chosen_rra].row_cnt - end_offset; i++) {
377 /* no valid data yet */
378 if (i < 0) {
379 #ifdef DEBUG
380 fprintf(stderr, "pre fetch %li -- ", i);
381 #endif
382 for (ii = 0; (unsigned) ii < *ds_cnt; ii++) {
383 *(data_ptr++) = DNAN;
384 #ifdef DEBUG
385 fprintf(stderr, "%10.2f ", *(data_ptr - 1));
386 #endif
387 }
388 }
389 /* past the valid data area */
390 else if (i >= (signed) rrd.rra_def[chosen_rra].row_cnt) {
391 #ifdef DEBUG
392 fprintf(stderr, "past fetch %li -- ", i);
393 #endif
394 for (ii = 0; (unsigned) ii < *ds_cnt; ii++) {
395 *(data_ptr++) = DNAN;
396 #ifdef DEBUG
397 fprintf(stderr, "%10.2f ", *(data_ptr - 1));
398 #endif
399 }
400 } else {
401 /* OK we are inside the valid area but the pointer has to
402 * be wrapped*/
403 if (rra_pointer >= (signed) rrd.rra_def[chosen_rra].row_cnt) {
404 rra_pointer -= rrd.rra_def[chosen_rra].row_cnt;
405 if (rrd_seek(rrd_file, (rra_base + rra_pointer * (*ds_cnt)
406 * sizeof(rrd_value_t)),
407 SEEK_SET) != 0) {
408 rrd_set_error("wrap seek in RRA did fail");
409 goto err_free_data;
410 }
411 #ifdef DEBUG
412 fprintf(stderr, "wrap seek ...\n");
413 #endif
414 }
416 if (rrd_read(rrd_file, data_ptr, sizeof(rrd_value_t) * (*ds_cnt))
417 != (ssize_t) (sizeof(rrd_value_t) * (*ds_cnt))) {
418 rrd_set_error("fetching cdp from rra");
419 goto err_free_data;
420 }
421 #ifdef DEBUG
422 fprintf(stderr, "post fetch %li -- ", i);
423 for (ii = 0; ii < *ds_cnt; ii++)
424 fprintf(stderr, "%10.2f ", *(data_ptr + ii));
425 #endif
426 data_ptr += *ds_cnt;
427 rra_pointer++;
428 }
429 #ifdef DEBUG
430 fprintf(stderr, "\n");
431 #endif
433 }
435 rrd_close(rrd_file);
436 return (0);
437 err_free_data:
438 free(*data);
439 *data = NULL;
440 err_free_all_ds_namv:
441 for (i = 0; (unsigned long) i < rrd.stat_head->ds_cnt; ++i)
442 free((*ds_namv)[i]);
443 err_free_ds_namv:
444 free(*ds_namv);
445 err_close:
446 rrd_close(rrd_file);
447 err_free:
448 rrd_free(&rrd);
449 return (-1);
450 }