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   "0004"
  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     CF_MHWPREDICT,
 169     /* An array of predictions using the seasonal
 170      * Holt-Winters algorithm. Requires an RRA of type
 171      * CF_SEASONAL for this data source. */
 172     CF_SEASONAL,
 173     /* An array of seasonal effects. Requires an RRA of
 174      * type CF_HWPREDICT for this data source. */
 175     CF_DEVPREDICT,
 176     /* An array of deviation predictions based upon
 177      * smoothed seasonal deviations. Requires an RRA of
 178      * type CF_DEVSEASONAL for this data source. */
 179     CF_DEVSEASONAL,
 180     /* An array of smoothed seasonal deviations. Requires
 181      * an RRA of type CF_HWPREDICT for this data source.
 182      * */
 183     CF_FAILURES
 184 };
 185
 186                        /* A binary array of failure indicators: 1 indicates
 187                         * that the number of violations in the prescribed
 188                         * window exceeded the prescribed threshold. */
 189
 190 #define MAX_RRA_PAR_EN 10
 191 enum rra_par_en { RRA_cdp_xff_val = 0,  /* what part of the consolidated
 192                                          * datapoint must be known, to produce a
 193                                          * valid entry in the rra */
 194     RRA_hw_alpha,
 195     /* exponential smoothing parameter for the intercept in
 196      * the Holt-Winters prediction algorithm. */
 197     RRA_hw_beta,
 198     /* exponential smoothing parameter for the slope in
 199      * the Holt-Winters prediction algorithm. */
 200     RRA_dependent_rra_idx,
 201     /* For CF_HWPREDICT: index of the RRA with the seasonal
 202      * effects of the Holt-Winters algorithm (of type
 203      * CF_SEASONAL).
 204      * For CF_DEVPREDICT: index of the RRA with the seasonal
 205      * deviation predictions (of type CF_DEVSEASONAL).
 206      * For CF_SEASONAL: index of the RRA with the Holt-Winters
 207      * intercept and slope coefficient (of type CF_HWPREDICT).
 208      * For CF_DEVSEASONAL: index of the RRA with the
 209      * Holt-Winters prediction (of type CF_HWPREDICT).
 210      * For CF_FAILURES: index of the CF_DEVSEASONAL array.
 211      * */
 212     RRA_seasonal_smooth_idx,
 213     /* For CF_SEASONAL and CF_DEVSEASONAL:
 214      * an integer between 0 and row_count - 1 which
 215      * is index in the seasonal cycle for applying
 216      * the period smoother. */
 217     RRA_failure_threshold,
 218     /* For CF_FAILURES, number of violations within the last
 219      * window required to mark a failure. */
 220     RRA_seasonal_gamma = RRA_hw_alpha,
 221     /* exponential smoothing parameter for seasonal effects.
 222      * */
 223     RRA_delta_pos = RRA_hw_alpha,
 224     RRA_delta_neg = RRA_hw_beta,
 225     /* confidence bound scaling parameters for the
 226      * the FAILURES RRA. */
 227     RRA_window_len = RRA_seasonal_smooth_idx
 228 };
 229
 230                     /* For CF_FAILURES, the length of the window for measuring
 231                      * failures. */
 232
 233 #define CF_NAM_FMT    "%19[A-Z]"
 234 #define CF_NAM_SIZE   20
 235
 236 typedef struct rra_def_t {
 237     char      cf_nam[CF_NAM_SIZE];  /* consolidation function (null term) */
 238     unsigned long row_cnt;  /* number of entries in the store */
 239     unsigned long pdp_cnt;  /* how many primary data points are
 240                              * required for a consolidated data
 241                              * point?*/
 242     unival    par[MAX_RRA_PAR_EN];  /* index see rra_param_en */
 243
 244 } rra_def_t;
 245
 246
 247 /****************************************************************************
 248  ****************************************************************************
 249  ****************************************************************************
 250  * LIVE PART OF THE HEADER. THIS WILL BE WRITTEN ON EVERY UPDATE         *
 251  ****************************************************************************
 252  ****************************************************************************
 253  ****************************************************************************/
 254 /****************************************************************************
 255  * POS 4: live_head_t
 256  ****************************************************************************/
 257
 258 typedef struct live_head_t {
 259     time_t    last_up;  /* when was rrd last updated */
 260     long      last_up_usec; /* micro seconds part of the
 261                                update timestamp. Always >= 0 */
 262 } live_head_t;
 263
 264
 265 /****************************************************************************
 266  * POS 5: pdp_prep_t  (* ds_cnt)                     here we prepare the pdps
 267  ****************************************************************************/
 268 #define LAST_DS_LEN 30  /* DO NOT CHANGE THIS ... */
 269
 270 enum pdp_par_en { PDP_unkn_sec_cnt = 0, /* how many seconds of the current
 271                                          * pdp value is unknown data? */
 272
 273     PDP_val
 274 };                      /* current value of the pdp.
 275                            this depends on dst */
 276
 277 typedef struct pdp_prep_t {
 278     char      last_ds[LAST_DS_LEN]; /* the last reading from the data
 279                                      * source.  this is stored in ASCII
 280                                      * to cater for very large counters
 281                                      * we might encounter in connection
 282                                      * with SNMP. */
 283     unival    scratch[10];  /* contents according to pdp_par_en */
 284 } pdp_prep_t;
 285
 286 /* data is passed from pdp to cdp when seconds since epoch modulo pdp_step == 0
 287    obviously the updates do not occur at these times only. Especially does the
 288    format allow for updates to occur at different times for each data source.
 289    The rules which makes this work is as follows:
 290
 291    * DS updates may only occur at ever increasing points in time
 292    * When any DS update arrives after a cdp update time, the *previous*
 293      update cycle gets executed. All pdps are transfered to cdps and the
 294      cdps feed the rras where necessary. Only then the new DS value
 295      is loaded into the PDP.                                                   */
 296
 297
 298 /****************************************************************************
 299  * POS 6: cdp_prep_t (* rra_cnt * ds_cnt )      data prep area for cdp values
 300  ****************************************************************************/
 301 #define MAX_CDP_PAR_EN 10
 302 #define MAX_CDP_FAILURES_IDX 8
 303 /* max CDP scratch entries avail to record violations for a FAILURES RRA */
 304 #define MAX_FAILURES_WINDOW_LEN 28
 305 enum cdp_par_en { CDP_val = 0,
 306     /* the base_interval is always an
 307      * average */
 308     CDP_unkn_pdp_cnt,
 309     /* how many unknown pdp were
 310      * integrated. This and the cdp_xff
 311      * will decide if this is going to
 312      * be a UNKNOWN or a valid value */
 313     CDP_hw_intercept,
 314     /* Current intercept coefficient for the Holt-Winters
 315      * prediction algorithm. */
 316     CDP_hw_last_intercept,
 317     /* Last iteration intercept coefficient for the Holt-Winters
 318      * prediction algorihtm. */
 319     CDP_hw_slope,
 320     /* Current slope coefficient for the Holt-Winters
 321      * prediction algorithm. */
 322     CDP_hw_last_slope,
 323     /* Last iteration slope coeffient. */
 324     CDP_null_count,
 325     /* Number of sequential Unknown (DNAN) values + 1 preceding
 326      * the current prediction.
 327      * */
 328     CDP_last_null_count,
 329     /* Last iteration count of Unknown (DNAN) values. */
 330     CDP_primary_val = 8,
 331     /* optimization for bulk updates: the value of the first CDP
 332      * value to be written in the bulk update. */
 333     CDP_secondary_val = 9,
 334     /* optimization for bulk updates: the value of subsequent
 335      * CDP values to be written in the bulk update. */
 336     CDP_hw_seasonal = CDP_hw_intercept,
 337     /* Current seasonal coefficient for the Holt-Winters
 338      * prediction algorithm. This is stored in CDP prep to avoid
 339      * redundant seek operations. */
 340     CDP_hw_last_seasonal = CDP_hw_last_intercept,
 341     /* Last iteration seasonal coeffient. */
 342     CDP_seasonal_deviation = CDP_hw_intercept,
 343     CDP_last_seasonal_deviation = CDP_hw_last_intercept,
 344     CDP_init_seasonal = CDP_null_count
 345 };
 346
 347                    /* init_seasonal is a flag which when > 0, forces smoothing updates
 348                     * to occur when rra_ptr.cur_row == 0 */
 349
 350 typedef struct cdp_prep_t {
 351     unival    scratch[MAX_CDP_PAR_EN];
 352     /* contents according to cdp_par_en *
 353      * init state should be NAN */
 354
 355 } cdp_prep_t;
 356
 357 /****************************************************************************
 358  * POS 7: rra_ptr_t (* rra_cnt)       pointers to the current row in each rra
 359  ****************************************************************************/
 360
 361 typedef struct rra_ptr_t {
 362     unsigned long cur_row;  /* current row in the rra */
 363 } rra_ptr_t;
 364
 365
 366 /****************************************************************************
 367  ****************************************************************************
 368  * One single struct to hold all the others. For convenience.
 369  ****************************************************************************
 370  ****************************************************************************/
 371 typedef struct rrd_t {
 372     stat_head_t *stat_head; /* the static header */
 373     ds_def_t *ds_def;   /* list of data source definitions */
 374     rra_def_t *rra_def; /* list of round robin archive def */
 375     live_head_t *live_head;
 376     pdp_prep_t *pdp_prep;   /* pdp data prep area */
 377     cdp_prep_t *cdp_prep;   /* cdp prep area */
 378     rra_ptr_t *rra_ptr; /* list of rra pointers */
 379     rrd_value_t *rrd_value; /* list of rrd values */
 380 } rrd_t;
 381
 382 /****************************************************************************
 383  ****************************************************************************
 384  * AFTER the header section we have the DATA STORAGE AREA it is made up from
 385  * Consolidated Data Points organized in Round Robin Archives.
 386  ****************************************************************************
 387  ****************************************************************************
 388
 389  *RRA 0
 390  (0,0) .................... ( ds_cnt -1 , 0)
 391  .
 392  .
 393  .
 394  (0, row_cnt -1) ... (ds_cnt -1, row_cnt -1)
 395
 396  *RRA 1
 397  *RRA 2
 398
 399  *RRA rra_cnt -1
 400
 401  ****************************************************************************/
 402
 403
 404 #endif