src/rrd_format.h

   1 /*****************************************************************************
   2  * RRDtool 1.2.23  Copyright by Tobi Oetiker, 1997-2007
   3  *****************************************************************************
   4  * rrd_format.h  RRD Database Format header
   5  *****************************************************************************/
   6
   7 #ifndef _RRD_FORMAT_H
   8 #define _RRD_FORMAT_H
   9
  10 #include "rrd.h"
  11
  12 /*****************************************************************************
  13  * put this in your /usr/lib/magic file (/etc/magic on HPUX)
  14  *
  15  *  # rrd database format
  16  *  0       string          RRD\0           rrd file
  17  *  >5      string          >\0             version '%s'
  18  *
  19  *****************************************************************************/
  20
  21 #define RRD_COOKIE    "RRD"
  22 /* #define RRD_VERSION   "0002" */
  23 /* changed because microsecond precision requires another field */
  24 #define RRD_VERSION   "0003"
  25 #define FLOAT_COOKIE  8.642135E130
  26
  27 #include "rrd_nan_inf.h"
  28
  29 typedef union unival {
  30     unsigned long u_cnt;
  31     rrd_value_t u_val;
  32 } unival;
  33
  34
  35 /****************************************************************************
  36  * The RRD Database Structure
  37  * ---------------------------
  38  *
  39  * In oder to properly describe the database structure lets define a few
  40  * new words:
  41  *
  42  * ds - Data Source (ds) providing input to the database. A Data Source (ds)
  43  *       can be a traffic counter, a temperature, the number of users logged
  44  *       into a system. The rrd database format can handle the input of
  45  *       several Data Sources (ds) in a singe database.
  46  *
  47  * dst - Data Source Type (dst). The Data Source Type (dst) defines the rules
  48  *       applied to Build Primary Data Points from the input provided by the
  49  *       data sources (ds).
  50  *
  51  * pdp - Primary Data Point (pdp). After the database has accepted the
  52  *       input from the data sources (ds). It starts building Primary
  53  *       Data Points (pdp) from the data. Primary Data Points (pdp)
  54  *       are evenly spaced along the time axis (pdp_step). The values
  55  *       of the Primary Data Points are calculated from the values of
  56  *       the data source (ds) and the exact time these values were
  57  *       provided by the data source (ds).
  58  *
  59  * pdp_st - PDP Start (pdp_st). The moments (pdp_st) in time where
  60  *       these steps occur are defined by the moments where the
  61  *       number of seconds since 1970-jan-1 modulo pdp_step equals
  62  *       zero (pdp_st).
  63  *
  64  * cf -  Consolidation Function (cf). An arbitrary Consolidation Function (cf)
  65  *       (averaging, min, max) is applied to the primary data points (pdp) to
  66  *       calculate the consolidated data point.
  67  *
  68  * cdp - Consolidated Data Point (cdp) is the long term storage format for data
  69  *       in the rrd database. Consolidated Data Points represent one or
  70  *       several primary data points collected along the time axis. The
  71  *       Consolidated Data Points (cdp) are stored in Round Robin Archives
  72  *       (rra).
  73  *
  74  * rra - Round Robin Archive (rra). This is the place where the
  75  *       consolidated data points (cdp) get stored. The data is
  76  *       organized in rows (row) and columns (col). The Round Robin
  77  *       Archive got its name from the method data is stored in
  78  *       there. An RRD database can contain several Round Robin
  79  *       Archives. Each Round Robin Archive can have a different row
  80  *       spacing along the time axis (pdp_cnt) and a different
  81  *       consolidation function (cf) used to build its consolidated
  82  *       data points (cdp).
  83  *
  84  * rra_st - RRA Start (rra_st). The moments (rra_st) in time where
  85  *       Consolidated Data Points (cdp) are added to an rra are
  86  *       defined by the moments where the number of seconds since
  87  *       1970-jan-1 modulo pdp_cnt*pdp_step equals zero (rra_st).
  88  *
  89  * row - Row (row). A row represent all consolidated data points (cdp)
  90  *       in a round robin archive who are of the same age.
  91  *
  92  * col - Column (col). A column (col) represent all consolidated
  93  *       data points (cdp) in a round robin archive (rra) who
  94  *       originated from the same data source (ds).
  95  *
  96  */
  97
  98 /****************************************************************************
  99  * POS 1: stat_head_t                           static header of the database
 100  ****************************************************************************/
 101
 102 typedef struct stat_head_t {
 103
 104     /* Data Base Identification Section ** */
 105     char      cookie[4];    /* RRD */
 106     char      version[5];   /* version of the format */
 107     double    float_cookie; /* is it the correct double
 108                              * representation ?  */
 109
 110     /* Data Base Structure Definition **** */
 111     unsigned long ds_cnt;   /* how many different ds provide
 112                              * input to the rrd */
 113     unsigned long rra_cnt;  /* how many rras will be maintained
 114                              * in the rrd */
 115     unsigned long pdp_step; /* pdp interval in seconds */
 116
 117     unival    par[10];  /* global parameters ... unused
 118                            at the moment */
 119 } stat_head_t;
 120
 121
 122 /****************************************************************************
 123  * POS 2: ds_def_t  (* ds_cnt)                        Data Source definitions
 124  ****************************************************************************/
 125
 126 enum dst_en { DST_COUNTER = 0,  /* data source types available */
 127     DST_ABSOLUTE,
 128     DST_GAUGE,
 129     DST_DERIVE,
 130     DST_CDEF
 131 };
 132
 133 enum ds_param_en { DS_mrhb_cnt = 0, /* minimum required heartbeat. A
 134                                      * data source must provide input at
 135                                      * least every ds_mrhb seconds,
 136                                      * otherwise it is regarded dead and
 137                                      * will be set to UNKNOWN */
 138     DS_min_val,         /* the processed input of a ds must */
 139     DS_max_val,         /* be between max_val and min_val
 140                          * both can be set to UNKNOWN if you
 141                          * do not care. Data outside the limits
 142                          * set to UNKNOWN */
 143     DS_cdef = DS_mrhb_cnt
 144 };                      /* pointer to encoded rpn
 145                          * expression only applies to DST_CDEF */
 146
 147 /* The magic number here is one less than DS_NAM_SIZE */
 148 #define DS_NAM_FMT    "%19[a-zA-Z0-9_-]"
 149 #define DS_NAM_SIZE   20
 150
 151 #define DST_FMT    "%19[A-Z]"
 152 #define DST_SIZE   20
 153
 154 typedef struct ds_def_t {
 155     char      ds_nam[DS_NAM_SIZE];  /* Name of the data source (null terminated) */
 156     char      dst[DST_SIZE];    /* Type of data source (null terminated) */
 157     unival    par[10];  /* index of this array see ds_param_en */
 158 } ds_def_t;
 159
 160 /****************************************************************************
 161  * POS 3: rra_def_t ( *  rra_cnt)         one for each store to be maintained
 162  ****************************************************************************/
 163 enum cf_en { CF_AVERAGE = 0,    /* data consolidation functions */
 164     CF_MINIMUM,
 165     CF_MAXIMUM,
 166     CF_LAST,
 167     CF_HWPREDICT,
 168     /* An array of predictions using the seasonal
 169      * Holt-Winters algorithm. Requires an RRA of type
 170      * CF_SEASONAL for this data source. */
 171     CF_SEASONAL,
 172     /* An array of seasonal effects. Requires an RRA of
 173      * type CF_HWPREDICT for this data source. */
 174     CF_DEVPREDICT,
 175     /* An array of deviation predictions based upon
 176      * smoothed seasonal deviations. Requires an RRA of
 177      * type CF_DEVSEASONAL for this data source. */
 178     CF_DEVSEASONAL,
 179     /* An array of smoothed seasonal deviations. Requires
 180      * an RRA of type CF_HWPREDICT for this data source.
 181      * */
 182     CF_FAILURES
 183 };
 184
 185                        /* A binary array of failure indicators: 1 indicates
 186                         * that the number of violations in the prescribed
 187                         * window exceeded the prescribed threshold. */
 188
 189 #define MAX_RRA_PAR_EN 10
 190 enum rra_par_en { RRA_cdp_xff_val = 0,  /* what part of the consolidated
 191                                          * datapoint must be known, to produce a
 192                                          * valid entry in the rra */
 193     RRA_hw_alpha,
 194     /* exponential smoothing parameter for the intercept in
 195      * the Holt-Winters prediction algorithm. */
 196     RRA_hw_beta,
 197     /* exponential smoothing parameter for the slope in
 198      * the Holt-Winters prediction algorithm. */
 199     RRA_dependent_rra_idx,
 200     /* For CF_HWPREDICT: index of the RRA with the seasonal
 201      * effects of the Holt-Winters algorithm (of type
 202      * CF_SEASONAL).
 203      * For CF_DEVPREDICT: index of the RRA with the seasonal
 204      * deviation predictions (of type CF_DEVSEASONAL).
 205      * For CF_SEASONAL: index of the RRA with the Holt-Winters
 206      * intercept and slope coefficient (of type CF_HWPREDICT).
 207      * For CF_DEVSEASONAL: index of the RRA with the
 208      * Holt-Winters prediction (of type CF_HWPREDICT).
 209      * For CF_FAILURES: index of the CF_DEVSEASONAL array.
 210      * */
 211     RRA_seasonal_smooth_idx,
 212     /* For CF_SEASONAL and CF_DEVSEASONAL:
 213      * an integer between 0 and row_count - 1 which
 214      * is index in the seasonal cycle for applying
 215      * the period smoother. */
 216     RRA_failure_threshold,
 217     /* For CF_FAILURES, number of violations within the last
 218      * window required to mark a failure. */
 219     RRA_seasonal_gamma = RRA_hw_alpha,
 220     /* exponential smoothing parameter for seasonal effects.
 221      * */
 222     RRA_delta_pos = RRA_hw_alpha,
 223     RRA_delta_neg = RRA_hw_beta,
 224     /* confidence bound scaling parameters for the
 225      * the FAILURES RRA. */
 226     RRA_window_len = RRA_seasonal_smooth_idx
 227 };
 228
 229                     /* For CF_FAILURES, the length of the window for measuring
 230                      * failures. */
 231
 232 #define CF_NAM_FMT    "%19[A-Z]"
 233 #define CF_NAM_SIZE   20
 234
 235 typedef struct rra_def_t {
 236     char      cf_nam[CF_NAM_SIZE];  /* consolidation function (null term) */
 237     unsigned long row_cnt;  /* number of entries in the store */
 238     unsigned long pdp_cnt;  /* how many primary data points are
 239                              * required for a consolidated data
 240                              * point?*/
 241     unival    par[MAX_RRA_PAR_EN];  /* index see rra_param_en */
 242
 243 } rra_def_t;
 244
 245
 246 /****************************************************************************
 247  ****************************************************************************
 248  ****************************************************************************
 249  * LIVE PART OF THE HEADER. THIS WILL BE WRITTEN ON EVERY UPDATE         *
 250  ****************************************************************************
 251  ****************************************************************************
 252  ****************************************************************************/
 253 /****************************************************************************
 254  * POS 4: live_head_t
 255  ****************************************************************************/
 256
 257 typedef struct live_head_t {
 258     time_t    last_up;  /* when was rrd last updated */
 259     long      last_up_usec; /* micro seconds part of the
 260                                update timestamp. Always >= 0 */
 261 } live_head_t;
 262
 263
 264 /****************************************************************************
 265  * POS 5: pdp_prep_t  (* ds_cnt)                     here we prepare the pdps
 266  ****************************************************************************/
 267 #define LAST_DS_LEN 30  /* DO NOT CHANGE THIS ... */
 268
 269 enum pdp_par_en { PDP_unkn_sec_cnt = 0, /* how many seconds of the current
 270                                          * pdp value is unknown data? */
 271
 272     PDP_val
 273 };                      /* current value of the pdp.
 274                            this depends on dst */
 275
 276 typedef struct pdp_prep_t {
 277     char      last_ds[LAST_DS_LEN]; /* the last reading from the data
 278                                      * source.  this is stored in ASCII
 279                                      * to cater for very large counters
 280                                      * we might encounter in connection
 281                                      * with SNMP. */
 282     unival    scratch[10];  /* contents according to pdp_par_en */
 283 } pdp_prep_t;
 284
 285 /* data is passed from pdp to cdp when seconds since epoch modulo pdp_step == 0
 286    obviously the updates do not occur at these times only. Especially does the
 287    format allow for updates to occur at different times for each data source.
 288    The rules which makes this work is as follows:
 289
 290    * DS updates may only occur at ever increasing points in time
 291    * When any DS update arrives after a cdp update time, the *previous*
 292      update cycle gets executed. All pdps are transfered to cdps and the
 293      cdps feed the rras where necessary. Only then the new DS value
 294      is loaded into the PDP.                                                   */
 295
 296
 297 /****************************************************************************
 298  * POS 6: cdp_prep_t (* rra_cnt * ds_cnt )      data prep area for cdp values
 299  ****************************************************************************/
 300 #define MAX_CDP_PAR_EN 10
 301 #define MAX_CDP_FAILURES_IDX 8
 302 /* max CDP scratch entries avail to record violations for a FAILURES RRA */
 303 #define MAX_FAILURES_WINDOW_LEN 28
 304 enum cdp_par_en { CDP_val = 0,
 305     /* the base_interval is always an
 306      * average */
 307     CDP_unkn_pdp_cnt,
 308     /* how many unknown pdp were
 309      * integrated. This and the cdp_xff
 310      * will decide if this is going to
 311      * be a UNKNOWN or a valid value */
 312     CDP_hw_intercept,
 313     /* Current intercept coefficient for the Holt-Winters
 314      * prediction algorithm. */
 315     CDP_hw_last_intercept,
 316     /* Last iteration intercept coefficient for the Holt-Winters
 317      * prediction algorihtm. */
 318     CDP_hw_slope,
 319     /* Current slope coefficient for the Holt-Winters
 320      * prediction algorithm. */
 321     CDP_hw_last_slope,
 322     /* Last iteration slope coeffient. */
 323     CDP_null_count,
 324     /* Number of sequential Unknown (DNAN) values + 1 preceding
 325      * the current prediction.
 326      * */
 327     CDP_last_null_count,
 328     /* Last iteration count of Unknown (DNAN) values. */
 329     CDP_primary_val = 8,
 330     /* optimization for bulk updates: the value of the first CDP
 331      * value to be written in the bulk update. */
 332     CDP_secondary_val = 9,
 333     /* optimization for bulk updates: the value of subsequent
 334      * CDP values to be written in the bulk update. */
 335     CDP_hw_seasonal = CDP_hw_intercept,
 336     /* Current seasonal coefficient for the Holt-Winters
 337      * prediction algorithm. This is stored in CDP prep to avoid
 338      * redundant seek operations. */
 339     CDP_hw_last_seasonal = CDP_hw_last_intercept,
 340     /* Last iteration seasonal coeffient. */
 341     CDP_seasonal_deviation = CDP_hw_intercept,
 342     CDP_last_seasonal_deviation = CDP_hw_last_intercept,
 343     CDP_init_seasonal = CDP_null_count
 344 };
 345
 346                    /* init_seasonal is a flag which when > 0, forces smoothing updates
 347                     * to occur when rra_ptr.cur_row == 0 */
 348
 349 typedef struct cdp_prep_t {
 350     unival    scratch[MAX_CDP_PAR_EN];
 351     /* contents according to cdp_par_en *
 352      * init state should be NAN */
 353
 354 } cdp_prep_t;
 355
 356 /****************************************************************************
 357  * POS 7: rra_ptr_t (* rra_cnt)       pointers to the current row in each rra
 358  ****************************************************************************/
 359
 360 typedef struct rra_ptr_t {
 361     unsigned long cur_row;  /* current row in the rra */
 362 } rra_ptr_t;
 363
 364
 365 /****************************************************************************
 366  ****************************************************************************
 367  * One single struct to hold all the others. For convenience.
 368  ****************************************************************************
 369  ****************************************************************************/
 370 typedef struct rrd_t {
 371     stat_head_t *stat_head; /* the static header */
 372     ds_def_t *ds_def;   /* list of data source definitions */
 373     rra_def_t *rra_def; /* list of round robin archive def */
 374     live_head_t *live_head;
 375     pdp_prep_t *pdp_prep;   /* pdp data prep area */
 376     cdp_prep_t *cdp_prep;   /* cdp prep area */
 377     rra_ptr_t *rra_ptr; /* list of rra pointers */
 378     rrd_value_t *rrd_value; /* list of rrd values */
 379 } rrd_t;
 380
 381 /****************************************************************************
 382  ****************************************************************************
 383  * AFTER the header section we have the DATA STORAGE AREA it is made up from
 384  * Consolidated Data Points organized in Round Robin Archives.
 385  ****************************************************************************
 386  ****************************************************************************
 387
 388  *RRA 0
 389  (0,0) .................... ( ds_cnt -1 , 0)
 390  .
 391  .
 392  .
 393  (0, row_cnt -1) ... (ds_cnt -1, row_cnt -1)
 394
 395  *RRA 1
 396  *RRA 2
 397
 398  *RRA rra_cnt -1
 399
 400  ****************************************************************************/
 401
 402
 403 #endif