src/rrd.h

   1 /*****************************************************************************
   2  * RRDtool 1.4.3  Copyright by Tobi Oetiker, 1997-2010
   3  *****************************************************************************
   4  * rrdlib.h   Public header file for librrd
   5  *****************************************************************************
   6  * $Id$
   7  * $Log$
   8  * Revision 1.9  2005/02/13 16:13:33  oetiker
   9  * let rrd_graph return the actual value range it picked ...
  10  * -- Henrik Stoerner <henrik@hswn.dk>
  11  *
  12  * Revision 1.8  2004/05/26 22:11:12  oetiker
  13  * reduce compiler warnings. Many small fixes. -- Mike Slifcak <slif@bellsouth.net>
  14  *
  15  * Revision 1.7  2003/11/12 22:14:26  oetiker
  16  * allow to pass an open filehandle into rrd_graph as an extra argument
  17  *
  18  * Revision 1.6  2003/11/11 19:46:21  oetiker
  19  * replaced time_value with rrd_time_value as MacOS X introduced a struct of that name in their standard headers
  20  *
  21  * Revision 1.5  2003/04/25 18:35:08  jake
  22  * Alternate update interface, updatev. Returns info about CDPs written to disk as result of update. Output format is similar to rrd_info, a hash of key-values.
  23  *
  24  * Revision 1.4  2003/04/01 22:52:23  jake
  25  * Fix Win32 build. VC++ 6.0 and 7.0 now use the thread-safe code.
  26  *
  27  * Revision 1.3  2003/02/13 07:05:27  oetiker
  28  * Find attached the patch I promised to send to you. Please note that there
  29  * are three new source files (src/rrd_is_thread_safe.h, src/rrd_thread_safe.c
  30  * and src/rrd_not_thread_safe.c) and the introduction of librrd_th. This
  31  * library is identical to librrd, but it contains support code for per-thread
  32  * global variables currently used for error information only. This is similar
  33  * to how errno per-thread variables are implemented.  librrd_th must be linked
  34  * alongside of libpthred
  35  *
  36  * There is also a new file "THREADS", holding some documentation.
  37  *
  38  * -- Peter Stamfest <peter@stamfest.at>
  39  *
  40  * Revision 1.2  2002/05/07 21:58:32  oetiker
  41  * new command rrdtool xport integrated
  42  * --  Wolfgang Schrimm <Wolfgang.Schrimm@urz.uni-heidelberg.de>
  43  *
  44  * Revision 1.1.1.1  2001/02/25 22:25:05  oetiker
  45  * checkin
  46  *
  47  *****************************************************************************/
  48 #ifdef  __cplusplus
  49 extern    "C" {
  50 #endif
  51
  52 #ifndef _RRDLIB_H
  53 #define _RRDLIB_H
  54
  55 #include <sys/types.h>  /* for off_t */
  56
  57 #ifndef WIN32
  58 #include <unistd.h>     /* for off_t */
  59 #else
  60         typedef size_t ssize_t;
  61         typedef long off_t;
  62 #endif
  63
  64 #include <time.h>
  65 #include <stdio.h>      /* for FILE */
  66 #include <string.h>
  67
  68 /* Formerly rrd_nan_inf.h */
  69 #ifndef DNAN
  70 # define DNAN rrd_set_to_DNAN()
  71 #endif
  72
  73 #ifndef DINF
  74 # define DINF rrd_set_to_DINF()
  75 #endif
  76     double    rrd_set_to_DNAN(
  77     void);
  78     double    rrd_set_to_DINF(
  79     void);
  80 /* end of rrd_nan_inf.h */
  81
  82 /* Transplanted from rrd_format.h */
  83     typedef double rrd_value_t; /* the data storage type is
  84                                  * double */
  85 /* END rrd_format.h */
  86
  87 /* information about an rrd file */
  88     typedef struct rrd_file_t {
  89         size_t     header_len;   /* length of the header of this rrd file */
  90         size_t     file_len; /* total size of the rrd file */
  91         size_t     pos;  /* current pos in file */
  92         void      *pvt;
  93     } rrd_file_t;
  94
  95 /* information used for the conventional file access methods */
  96     typedef struct rrd_simple_file_t {
  97         int       fd;  /* file descriptor of this rrd file */
  98 #ifdef HAVE_MMAP
  99         char     *file_start;   /* start address of an open rrd file */
 100         int       mm_prot;
 101         int       mm_flags;
 102 #endif
 103     } rrd_simple_file_t;
 104
 105 /* rrd info interface */
 106     typedef struct rrd_blob_t {
 107         unsigned long size; /* size of the blob */
 108         unsigned char *ptr; /* pointer */
 109     } rrd_blob_t;
 110
 111     typedef enum rrd_info_type { RD_I_VAL = 0,
 112         RD_I_CNT,
 113         RD_I_STR,
 114         RD_I_INT,
 115         RD_I_BLO
 116     } rrd_info_type_t;
 117
 118     typedef union rrd_infoval {
 119         unsigned long u_cnt;
 120         rrd_value_t u_val;
 121         char     *u_str;
 122         int       u_int;
 123         rrd_blob_t u_blo;
 124     } rrd_infoval_t;
 125
 126     typedef struct rrd_info_t {
 127         char     *key;
 128         rrd_info_type_t type;
 129         rrd_infoval_t value;
 130         struct rrd_info_t *next;
 131     } rrd_info_t;
 132
 133     typedef size_t (* rrd_output_callback_t)(
 134     const void *,
 135     size_t,
 136     void *);
 137
 138 /* main function blocks */
 139     int       rrd_create(
 140     int,
 141     char **);
 142     rrd_info_t *rrd_info(
 143     int,
 144     char **);
 145     rrd_info_t *rrd_info_push(
 146     rrd_info_t *,
 147     char *,
 148     rrd_info_type_t,
 149     rrd_infoval_t);
 150     void      rrd_info_print(
 151     rrd_info_t * data);
 152     void      rrd_info_free(
 153     rrd_info_t *);
 154     int       rrd_update(
 155     int,
 156     char **);
 157     rrd_info_t *rrd_update_v(
 158     int,
 159     char **);
 160     int       rrd_graph(
 161     int,
 162     char **,
 163     char ***,
 164     int *,
 165     int *,
 166     FILE *,
 167     double *,
 168     double *);
 169     rrd_info_t *rrd_graph_v(
 170     int,
 171     char **);
 172
 173     int       rrd_fetch(
 174     int,
 175     char **,
 176     time_t *,
 177     time_t *,
 178     unsigned long *,
 179     unsigned long *,
 180     char ***,
 181     rrd_value_t **);
 182     int       rrd_restore(
 183     int,
 184     char **);
 185     int       rrd_dump(
 186     int,
 187     char **);
 188     int       rrd_tune(
 189     int,
 190     char **);
 191     time_t    rrd_last(
 192     int,
 193     char **);
 194     int rrd_lastupdate(int argc, char **argv);
 195     time_t    rrd_first(
 196     int,
 197     char **);
 198     int       rrd_resize(
 199     int,
 200     char **);
 201     char     *rrd_strversion(
 202     void);
 203     double    rrd_version(
 204     void);
 205     int       rrd_xport(
 206     int,
 207     char **,
 208     int *,
 209     time_t *,
 210     time_t *,
 211     unsigned long *,
 212     unsigned long *,
 213     char ***,
 214     rrd_value_t **);
 215     int       rrd_flushcached (int argc, char **argv);
 216
 217     void      rrd_freemem(
 218     void *mem);
 219
 220 /* thread-safe (hopefully) */
 221     int       rrd_create_r(
 222     const char *filename,
 223     unsigned long pdp_step,
 224     time_t last_up,
 225     int argc,
 226     const char **argv);
 227     rrd_info_t *rrd_info_r(
 228     char *);
 229 /* NOTE: rrd_update_r and rrd_update_v_r are only thread-safe if no at-style
 230    time specifications get used!!! */
 231
 232     int       rrd_update_r(
 233     const char *filename,
 234     const char *_template,
 235     int argc,
 236     const char **argv);
 237     int       rrd_update_v_r(
 238     const char *filename,
 239     const char *_template,
 240     int argc,
 241     const char **argv,
 242     rrd_info_t * pcdp_summary);
 243     int rrd_fetch_r (
 244             const char *filename,
 245             const char *cf,
 246             time_t *start,
 247             time_t *end,
 248             unsigned long *step,
 249             unsigned long *ds_cnt,
 250             char ***ds_namv,
 251             rrd_value_t **data);
 252     int       rrd_dump_r(
 253     const char *filename,
 254     char *outname);
 255     time_t    rrd_last_r (const char *filename);
 256     int rrd_lastupdate_r (const char *filename,
 257             time_t *ret_last_update,
 258             unsigned long *ret_ds_count,
 259             char ***ret_ds_names,
 260             char ***ret_last_ds);
 261     time_t    rrd_first_r(
 262     const char *filename,
 263     int rraindex);
 264
 265     int rrd_dump_cb_r(
 266     const char *filename,
 267     int opt_header,
 268     rrd_output_callback_t cb,
 269     void *user);
 270
 271 /* Transplanted from rrd_parsetime.h */
 272     typedef enum {
 273         ABSOLUTE_TIME,
 274         RELATIVE_TO_START_TIME,
 275         RELATIVE_TO_END_TIME
 276     } rrd_timetype_t;
 277
 278 #define TIME_OK NULL
 279
 280     typedef struct rrd_time_value {
 281         rrd_timetype_t type;
 282         long      offset;
 283         struct tm tm;
 284     } rrd_time_value_t;
 285
 286     char     *rrd_parsetime(
 287     const char *spec,
 288     rrd_time_value_t * ptv);
 289 /* END rrd_parsetime.h */
 290
 291     typedef struct rrd_context {
 292         char      lib_errstr[256];
 293         char      rrd_error[4096];
 294     } rrd_context_t;
 295
 296 /* returns the current per-thread rrd_context */
 297     rrd_context_t *rrd_get_context(void);
 298
 299 #ifdef WIN32
 300 /* this was added by the win32 porters Christof.Wegmann@exitgames.com */
 301     rrd_context_t *rrd_force_new_context(void);
 302 #endif
 303
 304 int       rrd_proc_start_end(
 305     rrd_time_value_t *,
 306     rrd_time_value_t *,
 307     time_t *,
 308     time_t *);
 309
 310 /* HELPER FUNCTIONS */
 311     void      rrd_set_error(
 312     char *,
 313     ...);
 314     void      rrd_clear_error(
 315     void);
 316     int       rrd_test_error(
 317     void);
 318     char     *rrd_get_error(
 319     void);
 320
 321     /* rrd_strerror is thread safe, but still it uses a global buffer
 322        (but one per thread), thus subsequent calls within a single
 323        thread overwrite the same buffer */
 324     const char *rrd_strerror(
 325     int err);
 326
 327 /** MULTITHREADED HELPER FUNCTIONS */
 328     rrd_context_t *rrd_new_context(
 329     void);
 330     void      rrd_free_context(
 331     rrd_context_t * buf);
 332
 333 /* void   rrd_set_error_r  (rrd_context_t *, char *, ...); */
 334 /* void   rrd_clear_error_r(rrd_context_t *); */
 335 /* int    rrd_test_error_r (rrd_context_t *); */
 336 /* char  *rrd_get_error_r  (rrd_context_t *); */
 337
 338 /** UTILITY FUNCTIONS */
 339
 340     long rrd_random(void);
 341
 342     int rrd_add_ptr_chunk(void ***dest, size_t *dest_size, void *src,
 343                           size_t *alloc, size_t chunk);
 344     int rrd_add_ptr(void ***dest, size_t *dest_size, void *src);
 345     int rrd_add_strdup(char ***dest, size_t *dest_size, char *src);
 346     int rrd_add_strdup_chunk(char ***dest, size_t *dest_size, char *src,
 347                              size_t *alloc, size_t chunk);
 348     void rrd_free_ptrs(void ***src, size_t *cnt);
 349
 350     int rrd_mkdir_p(const char *pathname, mode_t mode);
 351
 352 /*
 353  * The following functions are _internal_ functions needed to read the raw RRD
 354  * files. Since they are _internal_ they may change with the file format and
 355  * will be replaced with a more general interface in RRDTool 1.4. Don't use
 356  * these functions unless you have good reasons to do so. If you do use these
 357  * functions you will have to adapt your code for RRDTool 1.4!
 358  *
 359  * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before
 360  * including <rrd_test.h>. You have been warned! If you come back to the
 361  * RRDTool mailing list and whine about your broken application, you will get
 362  * hit with something smelly!
 363  */
 364 #if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED)
 365
 366 # if defined(_RRD_TOOL_H)
 367 #  include "rrd_format.h"
 368 # else
 369 #  include <rrd_format.h>
 370 # endif
 371
 372 #if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED)
 373 # define RRD_DEPRECATED __attribute__((deprecated))
 374 #else
 375 # define RRD_DEPRECATED          /**/
 376 #endif
 377      void     rrd_free(
 378     rrd_t *rrd)
 379               RRD_DEPRECATED;
 380     void      rrd_init(
 381     rrd_t *rrd)
 382               RRD_DEPRECATED;
 383
 384     rrd_file_t *rrd_open(
 385     const char *const file_name,
 386     rrd_t *rrd,
 387     unsigned rdwr)
 388               RRD_DEPRECATED;
 389
 390     void      rrd_dontneed(
 391     rrd_file_t *rrd_file,
 392     rrd_t *rrd)
 393               RRD_DEPRECATED;
 394     int       rrd_close(
 395     rrd_file_t *rrd_file)
 396               RRD_DEPRECATED;
 397     ssize_t   rrd_read(
 398     rrd_file_t *rrd_file,
 399     void *buf,
 400     size_t count)
 401               RRD_DEPRECATED;
 402     ssize_t   rrd_write(
 403     rrd_file_t *rrd_file,
 404     const void *buf,
 405     size_t count)
 406               RRD_DEPRECATED;
 407     void      rrd_flush(
 408     rrd_file_t *rrd_file)
 409               RRD_DEPRECATED;
 410     off_t     rrd_seek(
 411     rrd_file_t *rrd_file,
 412     off_t off,
 413     int whence)
 414               RRD_DEPRECATED;
 415     off_t     rrd_tell(
 416     rrd_file_t *rrd_file)
 417               RRD_DEPRECATED;
 418     int       rrd_lock(
 419     rrd_file_t *file)
 420               RRD_DEPRECATED;
 421     void      rrd_notify_row(
 422     rrd_file_t *rrd_file,
 423     int rra_idx,
 424     unsigned long rra_row,
 425     time_t rra_time)
 426               RRD_DEPRECATED;
 427     unsigned long rrd_select_initial_row(
 428     rrd_file_t *rrd_file,
 429     int rra_idx,
 430     rra_def_t *rra
 431     )
 432               RRD_DEPRECATED;
 433 #endif                  /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */
 434
 435 #endif                  /* _RRDLIB_H */
 436
 437 #ifdef  __cplusplus
 438 }
 439 #endif