1 /*****************************************************************************
2 * RRDtool 1.2.12 Copyright by Tobi Oetiker, 1997-2005
3 *****************************************************************************
4 * rrd_restore.c creates new rrd from data dumped by rrd_dump.c
5 *****************************************************************************/
8 #include "rrd_rpncalc.h"
11 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
21 int eat_tag(char **, char *);
22 int read_tag(char **, char *, char *, void *);
23 int xml2rrd(char*, rrd_t*, char);
24 int rrd_write(char *, rrd_t *, char);
25 void parse_patch1028_RRA_params(char **buf, rrd_t *rrd, int rra_index);
26 void parse_patch1028_CDP_params(char **buf, rrd_t *rrd, int rra_index, int ds_index);
27 void parse_FAILURES_history(char **buf, rrd_t *rrd, int rra_index, int ds_index);
29 /* convert all occurrences of <BlaBlaBla> to <blablabla> */
31 void xml_lc(char* buf){
34 if (intag ==0 && (*buf) == '<') {
37 else if (intag ==1 && (*buf) == '>') {
40 } else if (intag ==1) {
52 while((*(ptr+1)) && ((*ptr)==' ' || (*ptr)=='\r' || (*ptr)=='\n' || (*ptr)=='\t')) ptr++;
53 if (strncmp(ptr,"<!--",4) == 0) {
54 ptr= strstr(ptr,"-->");
55 if (ptr) ptr+=3; else {
56 rrd_set_error("Dangling Comment");
61 } while ((*buf)!=ptr);
65 int eat_tag(char **buf, char *tag){
66 if ((*buf)==NULL) return -1; /* fall though clause */
71 && strncmp((*buf)+1,tag,strlen(tag)) == 0
72 && *((*buf)+strlen(tag)+1)=='>') {
73 (*buf) += strlen(tag)+2;
76 rrd_set_error("No <%s> tag found",tag);
84 int read_tag(char **buf, char *tag, char *format, void *value){
87 if ((*buf)==NULL) return -1; /* fall though clause */
89 if (eat_tag(buf,tag)==1){
92 while(*((*buf)+1) && (*(*buf) != '<')) (*buf)++; /*find start of endtag*/
94 matches =sscanf(temp,format,value);
96 end_tag = malloc((strlen(tag)+2)*sizeof(char));
97 sprintf(end_tag,"/%s",tag);
100 if (matches == 0 && strcmp(format,"%lf") == 0)
101 (*((double* )(value))) = DNAN;
102 if (matches != 1) return 0;
109 /* parse the data stored in buf and return a filled rrd structure */
110 int xml2rrd(char* buf, rrd_t* rrd, char rc){
111 /* pass 1 identify number of RRAs */
112 char *ptr,*ptr2,*ptr3; /* walks thought the buffer */
113 long rows=0,mempool=0,i=0;
115 xml_lc(buf); /* lets lowercase all active parts of the xml */
119 /* start with an RRD tag */
122 /* allocate static header */
123 if((rrd->stat_head = calloc(1,sizeof(stat_head_t)))==NULL){
124 rrd_set_error("allocating rrd.stat_head");
128 strcpy(rrd->stat_head->cookie,RRD_COOKIE);
129 read_tag(&ptr,"version","%4[0-9]",rrd->stat_head->version);
130 /* added primitive version checking */
131 if (atoi(rrd -> stat_head -> version) > atoi(RRD_VERSION) )
133 rrd_set_error("Incompatible file version, detected version %s is bigger than supported version %s\n",
134 rrd -> stat_head -> version, RRD_VERSION );
137 if (atoi(rrd -> stat_head -> version) < 2)
139 rrd_set_error("Can only restore version >= 2 (Not %s). Dump your old rrd using a current rrdtool dump.", rrd -> stat_head -> version );
142 rrd->stat_head->float_cookie = FLOAT_COOKIE;
143 rrd->stat_head->ds_cnt = 0;
144 rrd->stat_head->rra_cnt = 0;
145 read_tag(&ptr,"step","%lu",&(rrd->stat_head->pdp_step));
147 /* allocate live head */
148 if((rrd->live_head = calloc(1,sizeof(live_head_t)))==NULL){
149 rrd_set_error("allocating rrd.live_head");
152 read_tag(&ptr,"lastupdate","%lu",&(rrd->live_head->last_up));
154 /* Data Source Definition Part */
156 while (eat_tag(&ptr2,"ds") == 1){
157 rrd->stat_head->ds_cnt++;
158 if((rrd->ds_def = rrd_realloc(rrd->ds_def,rrd->stat_head->ds_cnt*sizeof(ds_def_t)))==NULL){
159 rrd_set_error("allocating rrd.ds_def");
162 /* clean out memory to make sure no data gets stored from previous tasks */
163 memset(&(rrd->ds_def[rrd->stat_head->ds_cnt-1]), 0, sizeof(ds_def_t));
164 if((rrd->pdp_prep = rrd_realloc(rrd->pdp_prep,rrd->stat_head->ds_cnt
165 *sizeof(pdp_prep_t)))==NULL){
166 rrd_set_error("allocating pdp_prep");
169 /* clean out memory to make sure no data gets stored from previous tasks */
170 memset(&(rrd->pdp_prep[rrd->stat_head->ds_cnt-1]), 0, sizeof(pdp_prep_t));
172 read_tag(&ptr2,"name",DS_NAM_FMT,rrd->ds_def[rrd->stat_head->ds_cnt-1].ds_nam);
174 read_tag(&ptr2,"type",DST_FMT,rrd->ds_def[rrd->stat_head->ds_cnt-1].dst);
175 /* test for valid type */
176 if( (int)dst_conv(rrd->ds_def[rrd->stat_head->ds_cnt-1].dst) == -1) return -1;
178 if (dst_conv(rrd->ds_def[rrd->stat_head->ds_cnt-1].dst) != DST_CDEF)
180 read_tag(&ptr2,"minimal_heartbeat","%lu",
181 &(rrd->ds_def[rrd->stat_head->ds_cnt-1].par[DS_mrhb_cnt].u_cnt));
182 read_tag(&ptr2,"min","%lf",&(rrd->ds_def[rrd->stat_head->ds_cnt-1].par[DS_min_val].u_val));
183 read_tag(&ptr2,"max","%lf",&(rrd->ds_def[rrd->stat_head->ds_cnt-1].par[DS_max_val].u_val));
184 } else { /* DST_CDEF */
186 read_tag(&ptr2,"cdef","%s",buffer);
187 parseCDEF_DS(buffer,rrd,rrd -> stat_head -> ds_cnt - 1);
190 read_tag(&ptr2,"last_ds","%30s",rrd->pdp_prep[rrd->stat_head->ds_cnt-1].last_ds);
191 read_tag(&ptr2,"value","%lf",&(rrd->pdp_prep[rrd->stat_head->ds_cnt-1].scratch[PDP_val].u_val));
192 read_tag(&ptr2,"unknown_sec","%lu",&(rrd->pdp_prep[rrd->stat_head->ds_cnt-1].scratch[PDP_unkn_sec_cnt].u_cnt));
193 eat_tag(&ptr2,"/ds");
198 while (eat_tag(&ptr2,"rra") == 1){
199 rrd->stat_head->rra_cnt++;
201 /* allocate and reset rra definition areas */
202 if((rrd->rra_def = rrd_realloc(rrd->rra_def,rrd->stat_head->rra_cnt*sizeof(rra_def_t)))==NULL){
203 rrd_set_error("allocating rra_def"); return -1; }
204 memset(&(rrd->rra_def[rrd->stat_head->rra_cnt-1]), 0, sizeof(rra_def_t));
206 /* allocate and reset consolidation point areas */
207 if((rrd->cdp_prep = rrd_realloc(rrd->cdp_prep,
208 rrd->stat_head->rra_cnt
209 *rrd->stat_head->ds_cnt*sizeof(cdp_prep_t)))==NULL){
210 rrd_set_error("allocating cdp_prep"); return -1; }
212 memset(&(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rrd->stat_head->rra_cnt-1)]),
213 0, rrd->stat_head->ds_cnt*sizeof(cdp_prep_t));
216 read_tag(&ptr2,"cf",CF_NAM_FMT,rrd->rra_def[rrd->stat_head->rra_cnt-1].cf_nam);
217 /* test for valid type */
218 if( (int)cf_conv(rrd->rra_def[rrd->stat_head->rra_cnt-1].cf_nam) == -1) return -1;
220 read_tag(&ptr2,"pdp_per_row","%lu",&(rrd->rra_def[rrd->stat_head->rra_cnt-1].pdp_cnt));
221 /* support to read RRA parameters */
222 eat_tag(&ptr2, "params");
224 rra_index = rrd->stat_head->rra_cnt - 1;
225 /* backwards compatibility w/ old patch */
226 if (strncmp(ptr2, "<value>",7) == 0) {
227 parse_patch1028_RRA_params(&ptr2,rrd,rra_index);
229 switch(cf_conv(rrd -> rra_def[rra_index].cf_nam)) {
231 read_tag(&ptr2, "hw_alpha", "%lf",
232 &(rrd->rra_def[rra_index].par[RRA_hw_alpha].u_val));
233 read_tag(&ptr2, "hw_beta", "%lf",
234 &(rrd->rra_def[rra_index].par[RRA_hw_beta].u_val));
235 read_tag(&ptr2, "dependent_rra_idx", "%lu",
236 &(rrd->rra_def[rra_index].par[RRA_dependent_rra_idx].u_cnt));
240 read_tag(&ptr2, "seasonal_gamma", "%lf",
241 &(rrd->rra_def[rra_index].par[RRA_seasonal_gamma].u_val));
242 read_tag(&ptr2, "seasonal_smooth_idx", "%lu",
243 &(rrd->rra_def[rra_index].par[RRA_seasonal_smooth_idx].u_cnt));
244 read_tag(&ptr2, "dependent_rra_idx", "%lu",
245 &(rrd->rra_def[rra_index].par[RRA_dependent_rra_idx].u_cnt));
248 read_tag(&ptr2, "delta_pos", "%lf",
249 &(rrd->rra_def[rra_index].par[RRA_delta_pos].u_val));
250 read_tag(&ptr2, "delta_neg", "%lf",
251 &(rrd->rra_def[rra_index].par[RRA_delta_neg].u_val));
252 read_tag(&ptr2, "window_len", "%lu",
253 &(rrd->rra_def[rra_index].par[RRA_window_len].u_cnt));
254 read_tag(&ptr2, "failure_threshold", "%lu",
255 &(rrd->rra_def[rra_index].par[RRA_failure_threshold].u_cnt));
258 read_tag(&ptr2, "dependent_rra_idx", "%lu",
259 &(rrd->rra_def[rra_index].par[RRA_dependent_rra_idx].u_cnt));
266 read_tag(&ptr2, "xff","%lf",
267 &(rrd->rra_def[rra_index].par[RRA_cdp_xff_val].u_val));
270 eat_tag(&ptr2, "/params");
271 eat_tag(&ptr2,"cdp_prep");
272 for(i=0;i< (int)rrd->stat_head->ds_cnt;i++)
275 /* support to read CDP parameters */
276 rra_index = rrd->stat_head->rra_cnt-1;
278 if (strncmp(ptr2, "<value>",7) == 0) {
279 parse_patch1028_CDP_params(&ptr2,rrd,rra_index,i);
281 read_tag(&ptr2, "primary_value","%lf",
282 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
283 +i].scratch[CDP_primary_val].u_val));
284 read_tag(&ptr2, "secondary_value","%lf",
285 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
286 +i].scratch[CDP_secondary_val].u_val));
287 switch(cf_conv(rrd->rra_def[rra_index].cf_nam)) {
289 read_tag(&ptr2,"intercept","%lf",
290 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
291 +i].scratch[CDP_hw_intercept].u_val));
292 read_tag(&ptr2,"last_intercept","%lf",
293 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
294 +i].scratch[CDP_hw_last_intercept].u_val));
295 read_tag(&ptr2,"slope","%lf",
296 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
297 +i].scratch[CDP_hw_slope].u_val));
298 read_tag(&ptr2,"last_slope","%lf",
299 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
300 +i].scratch[CDP_hw_last_slope].u_val));
301 read_tag(&ptr2,"nan_count","%lu",
302 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
303 +i].scratch[CDP_null_count].u_cnt));
304 read_tag(&ptr2,"last_nan_count","%lu",
305 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
306 +i].scratch[CDP_last_null_count].u_cnt));
310 read_tag(&ptr2,"seasonal","%lf",
311 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
312 +i].scratch[CDP_hw_seasonal].u_val));
313 read_tag(&ptr2,"last_seasonal","%lf",
314 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
315 +i].scratch[CDP_hw_last_seasonal].u_val));
316 read_tag(&ptr2,"init_flag","%lu",
317 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
318 +i].scratch[CDP_init_seasonal].u_cnt));
323 parse_FAILURES_history(&ptr2,rrd,rra_index,i);
330 read_tag(&ptr2,"value","%lf",&(rrd->cdp_prep[rrd->stat_head->ds_cnt
331 *(rra_index) +i].scratch[CDP_val].u_val));
332 read_tag(&ptr2,"unknown_datapoints","%lu",&(rrd->cdp_prep[rrd->stat_head->ds_cnt
333 *(rra_index) +i].scratch[CDP_unkn_pdp_cnt].u_cnt));
337 eat_tag(&ptr2,"/ds");
339 eat_tag(&ptr2,"/cdp_prep");
340 rrd->rra_def[rrd->stat_head->rra_cnt-1].row_cnt=0;
341 eat_tag(&ptr2,"database");
343 while (eat_tag(&ptr3,"row") == 1){
347 if((rrd->rrd_value = rrd_realloc(rrd->rrd_value,
348 (rows+mempool)*(rrd->stat_head->ds_cnt)
349 *sizeof(rrd_value_t)))==NULL) {
350 rrd_set_error("allocating rrd_values"); return -1; }
354 rrd->rra_def[rrd->stat_head->rra_cnt-1].row_cnt++;
355 for(i=0;i< (int)rrd->stat_head->ds_cnt;i++){
357 rrd_value_t * value = &(rrd->rrd_value[(rows-1)*rrd->stat_head->ds_cnt+i]);
359 read_tag(&ptr3,"v","%lf", value);
362 (rc == 1) /* do we have to check for the ranges */
364 (!isnan(*value)) /* not a NAN value */
366 (dst_conv(rrd->ds_def[i].dst) != DST_CDEF)
368 ( /* min defined and in the range ? */
369 (!isnan(rrd->ds_def[i].par[DS_min_val].u_val)
370 && (*value < rrd->ds_def[i].par[DS_min_val].u_val))
371 || /* max defined and in the range ? */
372 (!isnan(rrd->ds_def[i].par[DS_max_val].u_val)
373 && (*value > rrd->ds_def[i].par[DS_max_val].u_val))
376 fprintf (stderr, "out of range found [ds: %lu], [value : %0.10e]\n", i, *value);
380 eat_tag(&ptr3,"/row");
383 eat_tag(&ptr2,"/database");
384 eat_tag(&ptr2,"/rra");
387 eat_tag(&ptr,"/rrd");
389 if((rrd->rra_ptr = calloc(1,sizeof(rra_ptr_t)*rrd->stat_head->rra_cnt)) == NULL) {
390 rrd_set_error("allocating rra_ptr");
394 for(i=0; i < (int)rrd->stat_head->rra_cnt; i++) {
395 /* last row in the xml file is the most recent; as
396 * rrd_update increments the current row pointer, set cur_row
397 * here to the last row. */
398 rrd->rra_ptr[i].cur_row = rrd->rra_def[i].row_cnt-1;
409 /* create and empty rrd file according to the specs given */
412 rrd_write(char *file_name, rrd_t *rrd, char force_overwrite)
414 unsigned long i,ii,val_cnt;
419 if (strcmp("-",file_name)==0){
422 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
423 fdflags = O_RDWR|O_BINARY|O_CREAT;
425 fdflags = O_WRONLY|O_CREAT;
427 if (force_overwrite == 0) {
430 fd = open(file_name,fdflags,0666);
431 if (fd == -1 || (rrd_file = fdopen(fd,"wb")) == NULL) {
432 rrd_set_error("creating '%s': %s",file_name,rrd_strerror(errno));
438 fwrite(rrd->stat_head,
439 sizeof(stat_head_t), 1, rrd_file);
442 sizeof(ds_def_t), rrd->stat_head->ds_cnt, rrd_file);
445 sizeof(rra_def_t), rrd->stat_head->rra_cnt, rrd_file);
447 /* maybe the xml hold an old formatted rrd */
448 if (atoi(rrd->stat_head->version) < 3)
449 fwrite(&(rrd->live_head->last_up), sizeof(long),1, rrd_file);
451 fwrite(rrd->live_head, sizeof(live_head_t),1, rrd_file);
453 fwrite( rrd->pdp_prep, sizeof(pdp_prep_t),rrd->stat_head->ds_cnt,rrd_file);
455 fwrite( rrd->cdp_prep, sizeof(cdp_prep_t),rrd->stat_head->rra_cnt*
456 rrd->stat_head->ds_cnt,rrd_file);
457 fwrite( rrd->rra_ptr, sizeof(rra_ptr_t), rrd->stat_head->rra_cnt,rrd_file);
461 /* calculate the number of rrd_values to dump */
463 for(i=0; i < rrd->stat_head->rra_cnt; i++)
464 for(ii=0; ii < rrd->rra_def[i].row_cnt * rrd->stat_head->ds_cnt;ii++)
466 fwrite( rrd->rrd_value, sizeof(rrd_value_t),val_cnt,rrd_file);
468 /* lets see if we had an error */
469 if(ferror(rrd_file)){
470 rrd_set_error("a file error occurred while creating '%s'",file_name);
481 rrd_restore(int argc, char **argv)
486 char force_overwrite = 0;
489 optind = 0; opterr = 0; /* initialize getopt */
492 rrd_set_error("usage rrdtool %s [--range-check/-r] [--force-overwrite/-f] file.xml file.rrd",argv[0]);
497 static struct option long_options[] =
499 {"range-check", required_argument, 0, 'r'},
500 {"force-overwrite", required_argument, 0, 'f'},
503 int option_index = 0;
507 opt = getopt_long(argc, argv, "rf", long_options, &option_index);
520 rrd_set_error("usage rrdtool %s [--range-check|-r] [--force-overwrite/-f] file.xml file.rrd",argv[0]);
526 if (readfile(argv[optind],&buf,0)==-1){
529 if (xml2rrd(buf,&rrd,rc)==-1) {
535 if(rrd_write(argv[optind+1],&rrd,force_overwrite)==-1){
543 /* a backwards compatibility routine that will parse the RRA params section
544 * generated by the aberrant patch to 1.0.28. */
547 parse_patch1028_RRA_params(char **buf, rrd_t *rrd, int rra_index)
550 for (i = 0; i < MAX_RRA_PAR_EN; i++)
552 if (i == RRA_dependent_rra_idx ||
553 i == RRA_seasonal_smooth_idx ||
554 i == RRA_failure_threshold)
555 read_tag(buf, "value","%lu",
556 &(rrd->rra_def[rra_index].par[i].u_cnt));
558 read_tag(buf, "value","%lf",
559 &(rrd->rra_def[rra_index].par[i].u_val));
563 /* a backwards compatibility routine that will parse the CDP params section
564 * generated by the aberrant patch to 1.0.28. */
566 parse_patch1028_CDP_params(char **buf, rrd_t *rrd, int rra_index, int ds_index)
569 for (ii = 0; ii < MAX_CDP_PAR_EN; ii++)
571 if (cf_conv(rrd->rra_def[rra_index].cf_nam) == CF_FAILURES ||
572 ii == CDP_unkn_pdp_cnt ||
573 ii == CDP_null_count ||
574 ii == CDP_last_null_count)
576 read_tag(buf,"value","%lu",
577 &(rrd->cdp_prep[rrd->stat_head->ds_cnt*(rra_index) + ds_index].scratch[ii].u_cnt));
579 read_tag(buf,"value","%lf",&(rrd->cdp_prep[rrd->stat_head->ds_cnt*
580 (rra_index) + ds_index].scratch[ii].u_val));
586 parse_FAILURES_history(char **buf, rrd_t *rrd, int rra_index, int ds_index)
588 char history[MAX_FAILURES_WINDOW_LEN + 1];
589 char *violations_array;
592 /* 28 = MAX_FAILURES_WINDOW_LEN */
593 read_tag(buf, "history", "%28[0-1]", history);
594 violations_array = (char*) rrd -> cdp_prep[rrd->stat_head->ds_cnt*(rra_index)
597 for (i = 0; i < rrd -> rra_def[rra_index].par[RRA_window_len].u_cnt; ++i)
598 violations_array[i] = (history[i] == '1') ? 1 : 0;