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