prep for 1.2rc9 release
[rrdtool.git] / src / rrd_tune.c
index b45e5db..706314e 100644 (file)
@@ -1,10 +1,35 @@
 /*****************************************************************************
- * RRDtool 1.0.33  Copyright Tobias Oetiker, 1997 - 2000
+ * RRDtool 1.2rc9  Copyright by Tobi Oetiker, 1997-2005
  *****************************************************************************
  * change header parameters of an rrd
  *****************************************************************************
  * $Id$
  * $Log$
+ * Revision 1.6  2004/05/26 22:11:12  oetiker
+ * reduce compiler warnings. Many small fixes. -- Mike Slifcak <slif@bellsouth.net>
+ *
+ * Revision 1.5  2002/02/01 20:34:49  oetiker
+ * fixed version number and date/time
+ *
+ * Revision 1.4  2001/08/22 22:29:07  jake
+ * Contents of this patch:
+ * (1) Adds/revises documentation for rrd tune in rrd_tool.c and pod files.
+ * (2) Moves some initialization code from rrd_create.c to rrd_hw.c.
+ * (3) Adds another pass to smoothing for SEASONAL and DEVSEASONAL RRAs.
+ * This pass computes the coefficients as deviations from an average; the
+ * average is added the baseline coefficient of HWPREDICT. Statistical texts
+ * suggest this to preserve algorithm stability. It will not invalidate
+ * RRD files created and smoothed with the old code.
+ * (4) Adds the aberrant-reset flag to rrd tune. This operation, which is
+ * specified for a single data source, causes the holt-winters algorithm to
+ * forget everthing it has learned and start over.
+ * (5) Fixes a few out-of-date code comments.
+ *
+ * Revision 1.3  2001/03/07 21:21:54  oetiker
+ * complete rewrite of rrdgraph documentation. This also includs info
+ * on upcomming/planned changes to the rrdgraph interface and functionality
+ * -- Alex van den Bogaerdt <alex@slot.hollandcasino.nl>
+ *
  * Revision 1.2  2001/03/04 13:01:55  oetiker
  * Aberrant Behavior Detection support. A brief overview added to rrdtool.pod.
  * Major updates to rrd_update.c, rrd_create.c. Minor update to other core files.
  * by old rrdtool versions. See http://cricket.sourceforge.net/aberrant/rrd_hw.htm
  * -- Jake Brutlag <jakeb@corp.webtv.net>
  *
- * Revision 1.1.1.1  2001/02/25 22:25:06  oetiker
- * checkin
- *
  *****************************************************************************/
 
 #include "rrd_tool.h"
+#include "rrd_rpncalc.h"
+#include "rrd_hw.h"
 
 int set_hwarg(rrd_t *rrd,enum cf_en cf,enum rra_par_en rra_par,char *arg);
 int set_deltaarg(rrd_t *rrd,enum rra_par_en rra_par,char *arg);
@@ -60,11 +84,13 @@ rrd_tune(int argc, char **argv)
            {"alpha",required_argument,0,'x'},
            {"beta",required_argument,0,'y'},
            {"gamma",required_argument,0,'z'},
+           {"gamma-deviation",required_argument,0,'v'},
+               {"aberrant-reset",required_argument,0,'b'},
            {0,0,0,0}
        };
        int option_index = 0;
        int opt;
-       opt = getopt_long(argc, argv, "h:i:a:d:r:p:n:w:f:x:y:z:", 
+       opt = getopt_long(argc, argv, "h:i:a:d:r:p:n:w:f:x:y:z:v:b:", 
                          long_options, &option_index);
        if (opt == EOF)
            break;
@@ -133,7 +159,7 @@ rrd_tune(int argc, char **argv)
                fclose(rrd_file);
                return -1;
            }
-           if (dst_conv(dst) == -1){
+           if ((int)dst_conv(dst) == -1){
                rrd_free(&rrd);
                fclose(rrd_file);
                return -1;
@@ -206,6 +232,32 @@ rrd_tune(int argc, char **argv)
                   return -1;
                }
                break;
+       case 'v':
+               if (set_hwarg(&rrd,CF_DEVSEASONAL,RRA_seasonal_gamma,optarg)) {
+                  rrd_free(&rrd);
+                  return -1;
+               }
+               break;
+       case 'b':
+               if (sscanf(optarg,DS_NAM_FMT,ds_nam) != 1){
+               rrd_set_error("invalid argument for aberrant-reset");
+               rrd_free(&rrd);
+               fclose(rrd_file);
+               return -1;
+           }
+           if ((ds=ds_match(&rrd,ds_nam))==-1){
+           /* ds_match handles it own errors */        
+               rrd_free(&rrd);
+               fclose(rrd_file);
+               return -1;
+           }
+           reset_aberrant_coefficients(&rrd,rrd_file,(unsigned long) ds);
+               if (rrd_test_error()) {
+                  rrd_free(&rrd);
+                  fclose(rrd_file);
+                  return -1;
+               }
+               break;
        case '?':
             if (optopt != 0)
                 rrd_set_error("unknown option '%c'", optopt);
@@ -216,7 +268,7 @@ rrd_tune(int argc, char **argv)
             return -1;
         }
     }
-    if(optcnt>0){
+       if(optcnt>0){
        
        fseek(rrd_file,0,SEEK_SET);
        fwrite(rrd.stat_head,
@@ -228,13 +280,20 @@ rrd_tune(int argc, char **argv)
                   rrd_file);
     } else {
        int i;
-       for(i=0;i< rrd.stat_head->ds_cnt;i++)
+       for(i=0;i< (int)rrd.stat_head->ds_cnt;i++)
+               if (dst_conv(rrd.ds_def[i].dst) != DST_CDEF) {
            printf("DS[%s] typ: %s\thbt: %ld\tmin: %1.4f\tmax: %1.4f\n",
                   rrd.ds_def[i].ds_nam,
                   rrd.ds_def[i].dst,
                   rrd.ds_def[i].par[DS_mrhb_cnt].u_cnt,
                   rrd.ds_def[i].par[DS_min_val].u_val,
                   rrd.ds_def[i].par[DS_max_val].u_val);
+               } else {
+               char *buffer;
+               rpn_compact2str((rpn_cdefds_t *) &(rrd.ds_def[i].par[DS_cdef]),rrd.ds_def,&buffer);
+               printf("DS[%s] typ: %s\tcdef: %s\n", rrd.ds_def[i].ds_nam,rrd.ds_def[i].dst,buffer);
+           free(buffer);
+               }
     }
     fclose(rrd_file);
     rrd_free(&rrd);
@@ -245,7 +304,7 @@ int set_hwarg(rrd_t *rrd,enum cf_en cf,enum rra_par_en rra_par,char *arg)
 {
    double param;
    unsigned long i;
-   signed short rra_idx = -1, devseasonal_idx = -1;
+   signed short rra_idx = -1;
    /* read the value */
    param = atof(arg);
    if (param <= 0.0 || param >= 1.0)
@@ -259,11 +318,7 @@ int set_hwarg(rrd_t *rrd,enum cf_en cf,enum rra_par_en rra_par,char *arg)
          if (cf_conv(rrd -> rra_def[i].cf_nam) == cf)
          {
                 rra_idx = i;
-         }
-         /* find the DEVSEASONAL index separately, as it is optional */
-         if (cf_conv(rrd -> rra_def[i].cf_nam) == CF_DEVSEASONAL)
-         {
-                devseasonal_idx = i;
+                break;
          }
    }
    if (rra_idx == -1) 
@@ -274,8 +329,6 @@ int set_hwarg(rrd_t *rrd,enum cf_en cf,enum rra_par_en rra_par,char *arg)
    
    /* set the value */
    rrd -> rra_def[rra_idx].par[rra_par].u_val = param;
-   if (devseasonal_idx > -1)
-         rrd -> rra_def[devseasonal_idx].par[rra_par].u_val = param;
    return 0;
 }
 
@@ -318,12 +371,10 @@ int set_windowarg(rrd_t *rrd,enum rra_par_en rra_par,char *arg)
    signed short rra_idx = -1;
    /* read the value */
    param = atoi(arg);
-   /* there are 4 chars to a long, reserve on CDP entry for future
-       * use. */
    if (param < 1 || param > MAX_FAILURES_WINDOW_LEN)
    {
          rrd_set_error("Parameter must be between %d and %d",
-                1, MAX_CDP_PAR_EN - 1);
+                1, MAX_FAILURES_WINDOW_LEN);
          return -1;
    }
    /* does the appropriate RRA exist?  */