1 /*****************************************************************************
2 * RRDtool 1.2.12 Copyright by Tobi Oetiker, 1997-2005
3 *****************************************************************************
4 * rrd_create.c creates new rrds
5 *****************************************************************************/
8 #include "rrd_rpncalc.h"
11 #include "rrd_is_thread_safe.h"
13 unsigned long FnvHash(char *str);
14 int create_hw_contingent_rras(rrd_t *rrd, unsigned short period, unsigned long hashed_name);
15 void parseGENERIC_DS(char *def,rrd_t *rrd, int ds_idx);
18 rrd_create(int argc, char **argv)
20 time_t last_up = time(NULL)-10;
21 unsigned long pdp_step = 300;
22 struct rrd_time_value last_up_tv;
23 char *parsetime_error = NULL;
26 optind = 0; opterr = 0; /* initialize getopt */
29 static struct option long_options[] =
31 {"start", required_argument, 0, 'b'},
32 {"step", required_argument,0,'s'},
37 opt = getopt_long(argc, argv, "b:s:",
38 long_options, &option_index);
45 if ((parsetime_error = parsetime(optarg, &last_up_tv))) {
46 rrd_set_error("start time: %s", parsetime_error );
49 if (last_up_tv.type == RELATIVE_TO_END_TIME ||
50 last_up_tv.type == RELATIVE_TO_START_TIME) {
51 rrd_set_error("specifying time relative to the 'start' "
52 "or 'end' makes no sense here");
56 last_up = mktime(&last_up_tv.tm) + last_up_tv.offset;
58 if (last_up < 3600*24*365*10){
59 rrd_set_error("the first entry to the RRD should be after 1980");
65 long_tmp = atol(optarg);
67 rrd_set_error("step size should be no less than one second");
75 rrd_set_error("unknown option '%c'", optopt);
77 rrd_set_error("unknown option '%s'",argv[optind-1]);
82 rc = rrd_create_r(argv[optind],
84 argc - optind - 1, argv + optind + 1);
91 rrd_create_r(char *filename,
92 unsigned long pdp_step, time_t last_up,
93 int argc, char **argv)
99 char dummychar1[2], dummychar2[2];
100 unsigned short token_idx, error_flag, period=0;
101 unsigned long hashed_name;
106 if((rrd.stat_head = calloc(1,sizeof(stat_head_t)))==NULL){
107 rrd_set_error("allocating rrd.stat_head");
113 if((rrd.live_head = calloc(1,sizeof(live_head_t)))==NULL){
114 rrd_set_error("allocating rrd.live_head");
119 /* set some defaults */
120 strcpy(rrd.stat_head->cookie,RRD_COOKIE);
121 strcpy(rrd.stat_head->version,RRD_VERSION);
122 rrd.stat_head->float_cookie = FLOAT_COOKIE;
123 rrd.stat_head->ds_cnt = 0; /* this will be adjusted later */
124 rrd.stat_head->rra_cnt = 0; /* ditto */
125 rrd.stat_head->pdp_step = pdp_step; /* 5 minute default */
127 /* a default value */
131 rrd.live_head->last_up = last_up;
133 /* optind points to the first non-option command line arg,
134 * in this case, the file name. */
135 /* Compute the FNV hash value (used by SEASONAL and DEVSEASONAL
137 hashed_name = FnvHash(filename);
140 if (strncmp(argv[i],"DS:",3)==0){
141 size_t old_size = sizeof(ds_def_t)*(rrd.stat_head->ds_cnt);
142 if((rrd.ds_def = rrd_realloc(rrd.ds_def,
143 old_size+sizeof(ds_def_t)))==NULL){
144 rrd_set_error("allocating rrd.ds_def");
148 memset(&rrd.ds_def[rrd.stat_head->ds_cnt], 0, sizeof(ds_def_t));
149 /* extract the name and type */
150 switch (sscanf(&argv[i][3],
151 DS_NAM_FMT "%1[:]" DST_FMT "%1[:]%n",
152 rrd.ds_def[rrd.stat_head->ds_cnt].ds_nam,
154 rrd.ds_def[rrd.stat_head->ds_cnt].dst,
158 case 1: rrd_set_error("Invalid DS name"); break;
160 case 3: rrd_set_error("Invalid DS type"); break;
161 case 4: /* (%n may or may not be counted) */
162 case 5: /* check for duplicate datasource names */
163 for (ii=0;ii<rrd.stat_head->ds_cnt;ii++)
164 if(strcmp(rrd.ds_def[rrd.stat_head->ds_cnt].ds_nam,
165 rrd.ds_def[ii].ds_nam) == 0)
166 rrd_set_error("Duplicate DS name: %s",
167 rrd.ds_def[ii].ds_nam);
168 /* DS_type may be valid or not. Checked later */
170 default: rrd_set_error("invalid DS format");
172 if (rrd_test_error()) {
177 /* parse the remainder of the arguments */
178 switch(dst_conv(rrd.ds_def[rrd.stat_head->ds_cnt].dst))
184 parseGENERIC_DS(&argv[i][offset+3],&rrd, rrd.stat_head->ds_cnt);
187 parseCDEF_DS(&argv[i][offset+3],&rrd, rrd.stat_head->ds_cnt);
190 rrd_set_error("invalid DS type specified");
194 if (rrd_test_error()) {
198 rrd.stat_head -> ds_cnt++;
199 } else if (strncmp(argv[i],"RRA:",4)==0){
202 size_t old_size = sizeof(rra_def_t)*(rrd.stat_head->rra_cnt);
203 if((rrd.rra_def = rrd_realloc(rrd.rra_def,
204 old_size+sizeof(rra_def_t)))==NULL)
206 rrd_set_error("allocating rrd.rra_def");
210 memset(&rrd.rra_def[rrd.stat_head->rra_cnt], 0, sizeof(rra_def_t));
212 argvcopy = strdup(argv[i]);
213 token = strtok_r(&argvcopy[4],":", &tokptr);
214 token_idx = error_flag = 0;
215 while (token != NULL)
220 if (sscanf(token,CF_NAM_FMT,
221 rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam) != 1)
222 rrd_set_error("Failed to parse CF name");
223 switch(cf_conv(rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam))
226 /* initialize some parameters */
227 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_hw_alpha].u_val = 0.1;
228 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_hw_beta].u_val = 1.0/288;
229 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt =
230 rrd.stat_head -> rra_cnt;
234 /* initialize some parameters */
235 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_seasonal_gamma].u_val = 0.1;
238 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt = -1;
241 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_delta_pos].u_val = 2.0;
242 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_delta_neg].u_val = 2.0;
243 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_window_len].u_cnt = 3;
244 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_failure_threshold].u_cnt = 2;
245 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt = -1;
247 /* invalid consolidation function */
249 rrd_set_error("Unrecognized consolidation function %s",
250 rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam);
254 /* default: 1 pdp per cdp */
255 rrd.rra_def[rrd.stat_head->rra_cnt].pdp_cnt = 1;
258 switch(cf_conv(rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam))
265 rrd.rra_def[rrd.stat_head->rra_cnt].row_cnt = atoi(token);
268 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_cdp_xff_val].u_val = atof(token);
269 if (rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_cdp_xff_val].u_val<0.0 ||
270 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_cdp_xff_val].u_val>=1.0)
271 rrd_set_error("Invalid xff: must be between 0 and 1");
276 switch(cf_conv(rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam))
279 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_hw_alpha].u_val = atof(token);
280 if (atof(token) <= 0.0 || atof(token) >= 1.0)
281 rrd_set_error("Invalid alpha: must be between 0 and 1");
285 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_seasonal_gamma].u_val =
287 if (atof(token) <= 0.0 || atof(token) >= 1.0)
288 rrd_set_error("Invalid gamma: must be between 0 and 1");
289 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_seasonal_smooth_idx].u_cnt
290 = hashed_name % rrd.rra_def[rrd.stat_head->rra_cnt].row_cnt;
293 /* specifies the # of violations that constitutes the failure threshold */
294 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_failure_threshold].u_cnt =
296 if (atoi(token) < 1 || atoi(token) > MAX_FAILURES_WINDOW_LEN)
297 rrd_set_error("Failure threshold is out of range %d, %d",1,
298 MAX_FAILURES_WINDOW_LEN);
301 /* specifies the index (1-based) of CF_DEVSEASONAL array
302 * associated with this CF_DEVPREDICT array. */
303 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt =
307 rrd.rra_def[rrd.stat_head->rra_cnt].pdp_cnt = atoi(token);
312 switch(cf_conv(rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam))
315 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_hw_beta].u_val = atof(token);
316 if (atof(token) < 0.0 || atof(token) > 1.0)
317 rrd_set_error("Invalid beta: must be between 0 and 1");
321 /* specifies the index (1-based) of CF_HWPREDICT array
322 * associated with this CF_DEVSEASONAL or CF_SEASONAL array.
324 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt =
328 /* specifies the window length */
329 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_window_len].u_cnt =
331 if (atoi(token) < 1 || atoi(token) > MAX_FAILURES_WINDOW_LEN)
332 rrd_set_error("Window length is out of range %d, %d",1,
333 MAX_FAILURES_WINDOW_LEN);
334 /* verify that window length exceeds the failure threshold */
335 if (rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_window_len].u_cnt <
336 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_failure_threshold].u_cnt)
337 rrd_set_error("Window length is shorter than the failure threshold");
340 /* shouldn't be any more arguments */
341 rrd_set_error("Unexpected extra argument for consolidation function DEVPREDICT");
344 rrd.rra_def[rrd.stat_head->rra_cnt].row_cnt = atoi(token);
349 switch(cf_conv(rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam))
352 /* specifies the index (1-based) of CF_DEVSEASONAL array
353 * associated with this CF_DEVFAILURES array. */
354 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt =
358 /* length of the associated CF_SEASONAL and CF_DEVSEASONAL arrays. */
359 period = atoi(token);
360 if (period > rrd.rra_def[rrd.stat_head->rra_cnt].row_cnt)
361 rrd_set_error("Length of seasonal cycle exceeds length of HW prediction array");
364 /* shouldn't be any more arguments */
365 rrd_set_error("Unexpected extra argument for consolidation function %s",
366 rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam);
371 /* If we are here, this must be a CF_HWPREDICT RRA.
372 * Specifies the index (1-based) of CF_SEASONAL array
373 * associated with this CF_HWPREDICT array. If this argument
374 * is missing, then the CF_SEASONAL, CF_DEVSEASONAL, CF_DEVPREDICT,
376 * arrays are created automatically. */
377 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt =
381 /* should never get here */
382 rrd_set_error("Unknown error");
385 if (rrd_test_error())
387 /* all errors are unrecoverable */
392 token = strtok_r(NULL,":", &tokptr);
397 fprintf(stderr,"Creating RRA CF: %s, dep idx %lu, current idx %lu\n",
398 rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam,
399 rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt,
400 rrd.stat_head -> rra_cnt);
402 /* should we create CF_SEASONAL, CF_DEVSEASONAL, and CF_DEVPREDICT? */
403 if (cf_conv(rrd.rra_def[rrd.stat_head->rra_cnt].cf_nam) == CF_HWPREDICT
404 && rrd.rra_def[rrd.stat_head->rra_cnt].par[RRA_dependent_rra_idx].u_cnt
405 == rrd.stat_head -> rra_cnt)
408 fprintf(stderr,"Creating HW contingent RRAs\n");
410 if (create_hw_contingent_rras(&rrd,period,hashed_name) == -1) {
411 rrd_set_error("creating contingent RRA");
416 rrd.stat_head->rra_cnt++;
418 rrd_set_error("can't parse argument '%s'",argv[i]);
425 if (rrd.stat_head->rra_cnt < 1){
426 rrd_set_error("you must define at least one Round Robin Archive");
431 if (rrd.stat_head->ds_cnt < 1){
432 rrd_set_error("you must define at least one Data Source");
436 return rrd_create_fn(filename, &rrd);
439 void parseGENERIC_DS(char *def,rrd_t *rrd, int ds_idx)
441 char minstr[DS_NAM_SIZE], maxstr[DS_NAM_SIZE];
445 temp = sscanf(def,"%lu:%18[^:]:%18[^:]",
446 &(rrd -> ds_def[ds_idx].par[DS_mrhb_cnt].u_cnt),
449 if (sscanf(def,"%lu:%18[^:]:%18[^:]",
450 &(rrd -> ds_def[ds_idx].par[DS_mrhb_cnt].u_cnt),
453 if (minstr[0] == 'U' && minstr[1] == 0)
454 rrd -> ds_def[ds_idx].par[DS_min_val].u_val = DNAN;
456 rrd -> ds_def[ds_idx].par[DS_min_val].u_val = atof(minstr);
458 if (maxstr[0] == 'U' && maxstr[1] == 0)
459 rrd -> ds_def[ds_idx].par[DS_max_val].u_val = DNAN;
461 rrd -> ds_def[ds_idx].par[DS_max_val].u_val = atof(maxstr);
463 if (! isnan(rrd -> ds_def[ds_idx].par[DS_min_val].u_val) &&
464 ! isnan(rrd -> ds_def[ds_idx].par[DS_max_val].u_val) &&
465 rrd -> ds_def[ds_idx].par[DS_min_val].u_val
466 >= rrd -> ds_def[ds_idx].par[DS_max_val].u_val ) {
467 rrd_set_error("min must be less than max in DS definition");
471 rrd_set_error("failed to parse data source %s", def);
475 /* Create the CF_DEVPREDICT, CF_DEVSEASONAL, CF_SEASONAL, and CF_FAILURES RRAs
476 * associated with a CF_HWPREDICT RRA. */
478 create_hw_contingent_rras(rrd_t *rrd, unsigned short period, unsigned long hashed_name)
481 rra_def_t* current_rra;
483 /* save index to CF_HWPREDICT */
484 unsigned long hw_index = rrd -> stat_head -> rra_cnt;
485 /* advance the pointer */
486 (rrd -> stat_head -> rra_cnt)++;
487 /* allocate the memory for the 4 contingent RRAs */
488 old_size = sizeof(rra_def_t)*(rrd -> stat_head->rra_cnt);
489 if ((rrd -> rra_def = rrd_realloc(rrd -> rra_def,
490 old_size+4*sizeof(rra_def_t)))==NULL)
492 rrd_set_error("allocating rrd.rra_def");
496 memset(&(rrd -> rra_def[rrd -> stat_head->rra_cnt]), 0, 4*sizeof(rra_def_t));
498 /* create the CF_SEASONAL RRA */
499 current_rra = &(rrd -> rra_def[rrd -> stat_head -> rra_cnt]);
500 strcpy(current_rra -> cf_nam,"SEASONAL");
501 current_rra -> row_cnt = period;
502 current_rra -> par[RRA_seasonal_smooth_idx].u_cnt = hashed_name % period;
503 current_rra -> pdp_cnt = 1;
504 current_rra -> par[RRA_seasonal_gamma].u_val =
505 rrd -> rra_def[hw_index].par[RRA_hw_alpha].u_val;
506 current_rra -> par[RRA_dependent_rra_idx].u_cnt = hw_index;
507 rrd -> rra_def[hw_index].par[RRA_dependent_rra_idx].u_cnt = rrd -> stat_head -> rra_cnt;
509 /* create the CF_DEVSEASONAL RRA */
510 (rrd -> stat_head -> rra_cnt)++;
511 current_rra = &(rrd -> rra_def[rrd -> stat_head -> rra_cnt]);
512 strcpy(current_rra -> cf_nam,"DEVSEASONAL");
513 current_rra -> row_cnt = period;
514 current_rra -> par[RRA_seasonal_smooth_idx].u_cnt = hashed_name % period;
515 current_rra -> pdp_cnt = 1;
516 current_rra -> par[RRA_seasonal_gamma].u_val =
517 rrd -> rra_def[hw_index].par[RRA_hw_alpha].u_val;
518 current_rra -> par[RRA_dependent_rra_idx].u_cnt = hw_index;
520 /* create the CF_DEVPREDICT RRA */
521 (rrd -> stat_head -> rra_cnt)++;
522 current_rra = &(rrd -> rra_def[rrd -> stat_head -> rra_cnt]);
523 strcpy(current_rra -> cf_nam,"DEVPREDICT");
524 current_rra -> row_cnt = (rrd -> rra_def[hw_index]).row_cnt;
525 current_rra -> pdp_cnt = 1;
526 current_rra -> par[RRA_dependent_rra_idx].u_cnt
527 = hw_index + 2; /* DEVSEASONAL */
529 /* create the CF_FAILURES RRA */
530 (rrd -> stat_head -> rra_cnt)++;
531 current_rra = &(rrd -> rra_def[rrd -> stat_head -> rra_cnt]);
532 strcpy(current_rra -> cf_nam,"FAILURES");
533 current_rra -> row_cnt = period;
534 current_rra -> pdp_cnt = 1;
535 current_rra -> par[RRA_delta_pos].u_val = 2.0;
536 current_rra -> par[RRA_delta_neg].u_val = 2.0;
537 current_rra -> par[RRA_failure_threshold].u_cnt = 7;
538 current_rra -> par[RRA_window_len].u_cnt = 9;
539 current_rra -> par[RRA_dependent_rra_idx].u_cnt =
540 hw_index + 2; /* DEVSEASONAL */
544 /* create and empty rrd file according to the specs given */
547 rrd_create_fn(char *file_name, rrd_t *rrd)
551 rrd_value_t *unknown;
554 if ((rrd_file = fopen(file_name,"wb")) == NULL ) {
555 rrd_set_error("creating '%s': %s",file_name, rrd_strerror(errno));
556 free(rrd->stat_head);
562 fwrite(rrd->stat_head,
563 sizeof(stat_head_t), 1, rrd_file);
566 sizeof(ds_def_t), rrd->stat_head->ds_cnt, rrd_file);
569 sizeof(rra_def_t), rrd->stat_head->rra_cnt, rrd_file);
571 fwrite(rrd->live_head,
572 sizeof(live_head_t),1, rrd_file);
574 if((rrd->pdp_prep = calloc(1,sizeof(pdp_prep_t))) == NULL){
575 rrd_set_error("allocating pdp_prep");
581 strcpy(rrd->pdp_prep->last_ds,"UNKN");
583 rrd->pdp_prep->scratch[PDP_val].u_val = 0.0;
584 rrd->pdp_prep->scratch[PDP_unkn_sec_cnt].u_cnt =
585 rrd->live_head->last_up % rrd->stat_head->pdp_step;
587 for(i=0; i < rrd->stat_head->ds_cnt; i++)
588 fwrite( rrd->pdp_prep,sizeof(pdp_prep_t),1,rrd_file);
590 if((rrd->cdp_prep = calloc(1,sizeof(cdp_prep_t))) == NULL){
591 rrd_set_error("allocating cdp_prep");
598 for(i=0; i < rrd->stat_head->rra_cnt; i++) {
599 switch (cf_conv(rrd->rra_def[i].cf_nam))
602 init_hwpredict_cdp(rrd->cdp_prep);
606 init_seasonal_cdp(rrd->cdp_prep);
609 /* initialize violation history to 0 */
610 for (ii = 0; ii < MAX_CDP_PAR_EN; ii++)
612 /* We can zero everything out, by setting u_val to the
613 * NULL address. Each array entry in scratch is 8 bytes
614 * (a double), but u_cnt only accessed 4 bytes (long) */
615 rrd->cdp_prep->scratch[ii].u_val = 0.0;
619 /* can not be zero because we don't know anything ... */
620 rrd->cdp_prep->scratch[CDP_val].u_val = DNAN;
621 /* startup missing pdp count */
622 rrd->cdp_prep->scratch[CDP_unkn_pdp_cnt].u_cnt =
623 ((rrd->live_head->last_up -
624 rrd->pdp_prep->scratch[PDP_unkn_sec_cnt].u_cnt)
625 % (rrd->stat_head->pdp_step
626 * rrd->rra_def[i].pdp_cnt)) / rrd->stat_head->pdp_step;
630 for(ii=0; ii < rrd->stat_head->ds_cnt; ii++)
632 fwrite( rrd->cdp_prep,sizeof(cdp_prep_t),1,rrd_file);
636 /* now, we must make sure that the rest of the rrd
637 struct is properly initialized */
639 if((rrd->rra_ptr = calloc(1,sizeof(rra_ptr_t))) == NULL) {
640 rrd_set_error("allocating rra_ptr");
646 /* changed this initialization to be consistent with
647 * rrd_restore. With the old value (0), the first update
648 * would occur for cur_row = 1 because rrd_update increments
649 * the pointer a priori. */
650 for (i=0; i < rrd->stat_head->rra_cnt; i++)
652 rrd->rra_ptr->cur_row = rrd->rra_def[i].row_cnt - 1;
653 fwrite( rrd->rra_ptr, sizeof(rra_ptr_t),1,rrd_file);
656 /* write the empty data area */
657 if ((unknown = (rrd_value_t *)malloc(512 * sizeof(rrd_value_t))) == NULL) {
658 rrd_set_error("allocating unknown");
663 for (i = 0; i < 512; ++i)
667 for (i = 0; i < rrd->stat_head->rra_cnt; i++)
668 unkn_cnt += rrd->stat_head->ds_cnt * rrd->rra_def[i].row_cnt;
670 while (unkn_cnt > 0) {
671 fwrite(unknown, sizeof(rrd_value_t), min(unkn_cnt, 512), rrd_file);
676 /* lets see if we had an error */
677 if(ferror(rrd_file)){
678 rrd_set_error("a file error occurred while creating '%s'",file_name);