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 #ifdef _MSC_VER
  61         typedef int mode_t;
  62         #define strtoll _strtoi64
  63 #endif
  64         typedef size_t ssize_t;
  65         typedef long off_t;
  66 #endif
  67
  68 #include <time.h>
  69 #include <stdio.h>      /* for FILE */
  70 #include <string.h>
  71
  72 /* Formerly rrd_nan_inf.h */
  73 #ifndef DNAN
  74 # define DNAN rrd_set_to_DNAN()
  75 #endif
  76
  77 #ifndef DINF
  78 # define DINF rrd_set_to_DINF()
  79 #endif
  80     double    rrd_set_to_DNAN(
  81     void);
  82     double    rrd_set_to_DINF(
  83     void);
  84 /* end of rrd_nan_inf.h */
  85
  86 /* Transplanted from rrd_format.h */
  87     typedef double rrd_value_t; /* the data storage type is
  88                                  * double */
  89 /* END rrd_format.h */
  90
  91 /* information about an rrd file */
  92     typedef struct rrd_file_t {
  93         size_t     header_len;   /* length of the header of this rrd file */
  94         size_t     file_len; /* total size of the rrd file */
  95         size_t     pos;  /* current pos in file */
  96         void      *pvt;
  97     } rrd_file_t;
  98
  99 /* information used for the conventional file access methods */
 100     typedef struct rrd_simple_file_t {
 101         int       fd;  /* file descriptor of this rrd file */
 102 #ifdef HAVE_MMAP
 103         char     *file_start;   /* start address of an open rrd file */
 104         int       mm_prot;
 105         int       mm_flags;
 106 #endif
 107     } rrd_simple_file_t;
 108
 109 /* rrd info interface */
 110     typedef struct rrd_blob_t {
 111         unsigned long size; /* size of the blob */
 112         unsigned char *ptr; /* pointer */
 113     } rrd_blob_t;
 114
 115     typedef enum rrd_info_type { RD_I_VAL = 0,
 116         RD_I_CNT,
 117         RD_I_STR,
 118         RD_I_INT,
 119         RD_I_BLO
 120     } rrd_info_type_t;
 121
 122     typedef union rrd_infoval {
 123         unsigned long u_cnt;
 124         rrd_value_t u_val;
 125         char     *u_str;
 126         int       u_int;
 127         rrd_blob_t u_blo;
 128     } rrd_infoval_t;
 129
 130     typedef struct rrd_info_t {
 131         char     *key;
 132         rrd_info_type_t type;
 133         rrd_infoval_t value;
 134         struct rrd_info_t *next;
 135     } rrd_info_t;
 136
 137     typedef size_t (* rrd_output_callback_t)(
 138     const void *,
 139     size_t,
 140     void *);
 141
 142 /* main function blocks */
 143     int       rrd_create(
 144     int,
 145     char **);
 146     void      rrd_create_set_no_overwrite(
 147     int);
 148     rrd_info_t *rrd_info(
 149     int,
 150     char **);
 151     rrd_info_t *rrd_info_push(
 152     rrd_info_t *,
 153     char *,
 154     rrd_info_type_t,
 155     rrd_infoval_t);
 156     void      rrd_info_print(
 157     rrd_info_t * data);
 158     void      rrd_info_free(
 159     rrd_info_t *);
 160     int       rrd_update(
 161     int,
 162     char **);
 163     rrd_info_t *rrd_update_v(
 164     int,
 165     char **);
 166     int       rrd_graph(
 167     int,
 168     char **,
 169     char ***,
 170     int *,
 171     int *,
 172     FILE *,
 173     double *,
 174     double *);
 175     rrd_info_t *rrd_graph_v(
 176     int,
 177     char **);
 178
 179     int       rrd_fetch(
 180     int,
 181     char **,
 182     time_t *,
 183     time_t *,
 184     unsigned long *,
 185     unsigned long *,
 186     char ***,
 187     rrd_value_t **);
 188     int       rrd_restore(
 189     int,
 190     char **);
 191     int       rrd_dump(
 192     int,
 193     char **);
 194     int       rrd_tune(
 195     int,
 196     char **);
 197     time_t    rrd_last(
 198     int,
 199     char **);
 200     int rrd_lastupdate(int argc, char **argv);
 201     time_t    rrd_first(
 202     int,
 203     char **);
 204     int       rrd_resize(
 205     int,
 206     char **);
 207     char     *rrd_strversion(
 208     void);
 209     double    rrd_version(
 210     void);
 211     int       rrd_xport(
 212     int,
 213     char **,
 214     int *,
 215     time_t *,
 216     time_t *,
 217     unsigned long *,
 218     unsigned long *,
 219     char ***,
 220     rrd_value_t **);
 221     int       rrd_flushcached (int argc, char **argv);
 222
 223     void      rrd_freemem(
 224     void *mem);
 225
 226 /* thread-safe (hopefully) */
 227     int       rrd_create_r(
 228     const char *filename,
 229     unsigned long pdp_step,
 230     time_t last_up,
 231     int argc,
 232     const char **argv);
 233     rrd_info_t *rrd_info_r(
 234     char *);
 235 /* NOTE: rrd_update_r and rrd_update_v_r are only thread-safe if no at-style
 236    time specifications get used!!! */
 237
 238     int       rrd_update_r(
 239     const char *filename,
 240     const char *_template,
 241     int argc,
 242     const char **argv);
 243     int       rrd_update_v_r(
 244     const char *filename,
 245     const char *_template,
 246     int argc,
 247     const char **argv,
 248     rrd_info_t * pcdp_summary);
 249     int rrd_fetch_r (
 250             const char *filename,
 251             const char *cf,
 252             time_t *start,
 253             time_t *end,
 254             unsigned long *step,
 255             unsigned long *ds_cnt,
 256             char ***ds_namv,
 257             rrd_value_t **data);
 258     int       rrd_dump_r(
 259     const char *filename,
 260     char *outname);
 261     time_t    rrd_last_r (const char *filename);
 262     int rrd_lastupdate_r (const char *filename,
 263             time_t *ret_last_update,
 264             unsigned long *ret_ds_count,
 265             char ***ret_ds_names,
 266             char ***ret_last_ds);
 267     time_t    rrd_first_r(
 268     const char *filename,
 269     int rraindex);
 270
 271     int rrd_dump_cb_r(
 272     const char *filename,
 273     int opt_header,
 274     rrd_output_callback_t cb,
 275     void *user);
 276
 277 /* Transplanted from rrd_parsetime.h */
 278     typedef enum {
 279         ABSOLUTE_TIME,
 280         RELATIVE_TO_START_TIME,
 281         RELATIVE_TO_END_TIME
 282     } rrd_timetype_t;
 283
 284 #define TIME_OK NULL
 285
 286     typedef struct rrd_time_value {
 287         rrd_timetype_t type;
 288         long      offset;
 289         struct tm tm;
 290     } rrd_time_value_t;
 291
 292     char     *rrd_parsetime(
 293     const char *spec,
 294     rrd_time_value_t * ptv);
 295 /* END rrd_parsetime.h */
 296
 297     typedef struct rrd_context {
 298         char      lib_errstr[256];
 299         char      rrd_error[4096];
 300     } rrd_context_t;
 301
 302 /* returns the current per-thread rrd_context */
 303     rrd_context_t *rrd_get_context(void);
 304
 305 #ifdef WIN32
 306 /* this was added by the win32 porters Christof.Wegmann@exitgames.com */
 307     rrd_context_t *rrd_force_new_context(void);
 308 #endif
 309
 310 int       rrd_proc_start_end(
 311     rrd_time_value_t *,
 312     rrd_time_value_t *,
 313     time_t *,
 314     time_t *);
 315
 316 /* HELPER FUNCTIONS */
 317     void      rrd_set_error(
 318     char *,
 319     ...);
 320     void      rrd_clear_error(
 321     void);
 322     int       rrd_test_error(
 323     void);
 324     char     *rrd_get_error(
 325     void);
 326
 327     /* rrd_strerror is thread safe, but still it uses a global buffer
 328        (but one per thread), thus subsequent calls within a single
 329        thread overwrite the same buffer */
 330     const char *rrd_strerror(
 331     int err);
 332
 333 /** MULTITHREADED HELPER FUNCTIONS */
 334     rrd_context_t *rrd_new_context(
 335     void);
 336     void      rrd_free_context(
 337     rrd_context_t * buf);
 338
 339 /* void   rrd_set_error_r  (rrd_context_t *, char *, ...); */
 340 /* void   rrd_clear_error_r(rrd_context_t *); */
 341 /* int    rrd_test_error_r (rrd_context_t *); */
 342 /* char  *rrd_get_error_r  (rrd_context_t *); */
 343
 344 /** UTILITY FUNCTIONS */
 345
 346     long rrd_random(void);
 347
 348     int rrd_add_ptr_chunk(void ***dest, size_t *dest_size, void *src,
 349                           size_t *alloc, size_t chunk);
 350     int rrd_add_ptr(void ***dest, size_t *dest_size, void *src);
 351     int rrd_add_strdup(char ***dest, size_t *dest_size, char *src);
 352     int rrd_add_strdup_chunk(char ***dest, size_t *dest_size, char *src,
 353                              size_t *alloc, size_t chunk);
 354     void rrd_free_ptrs(void ***src, size_t *cnt);
 355
 356     int rrd_mkdir_p(const char *pathname, mode_t mode);
 357
 358 /*
 359  * The following functions are _internal_ functions needed to read the raw RRD
 360  * files. Since they are _internal_ they may change with the file format and
 361  * will be replaced with a more general interface in RRDTool 1.4. Don't use
 362  * these functions unless you have good reasons to do so. If you do use these
 363  * functions you will have to adapt your code for RRDTool 1.4!
 364  *
 365  * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before
 366  * including <rrd_test.h>. You have been warned! If you come back to the
 367  * RRDTool mailing list and whine about your broken application, you will get
 368  * hit with something smelly!
 369  */
 370 #if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED)
 371
 372 # if defined(_RRD_TOOL_H)
 373 #  include "rrd_format.h"
 374 # else
 375 #  include <rrd_format.h>
 376 # endif
 377
 378 #if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED)
 379 # define RRD_DEPRECATED __attribute__((deprecated))
 380 #else
 381 # define RRD_DEPRECATED          /**/
 382 #endif
 383      void     rrd_free(
 384     rrd_t *rrd)
 385               RRD_DEPRECATED;
 386     void      rrd_init(
 387     rrd_t *rrd)
 388               RRD_DEPRECATED;
 389
 390     rrd_file_t *rrd_open(
 391     const char *const file_name,
 392     rrd_t *rrd,
 393     unsigned rdwr)
 394               RRD_DEPRECATED;
 395
 396     void      rrd_dontneed(
 397     rrd_file_t *rrd_file,
 398     rrd_t *rrd)
 399               RRD_DEPRECATED;
 400     int       rrd_close(
 401     rrd_file_t *rrd_file)
 402               RRD_DEPRECATED;
 403     ssize_t   rrd_read(
 404     rrd_file_t *rrd_file,
 405     void *buf,
 406     size_t count)
 407               RRD_DEPRECATED;
 408     ssize_t   rrd_write(
 409     rrd_file_t *rrd_file,
 410     const void *buf,
 411     size_t count)
 412               RRD_DEPRECATED;
 413     void      rrd_flush(
 414     rrd_file_t *rrd_file)
 415               RRD_DEPRECATED;
 416     off_t     rrd_seek(
 417     rrd_file_t *rrd_file,
 418     off_t off,
 419     int whence)
 420               RRD_DEPRECATED;
 421     off_t     rrd_tell(
 422     rrd_file_t *rrd_file)
 423               RRD_DEPRECATED;
 424     int       rrd_lock(
 425     rrd_file_t *file)
 426               RRD_DEPRECATED;
 427     void      rrd_notify_row(
 428     rrd_file_t *rrd_file,
 429     int rra_idx,
 430     unsigned long rra_row,
 431     time_t rra_time)
 432               RRD_DEPRECATED;
 433     unsigned long rrd_select_initial_row(
 434     rrd_file_t *rrd_file,
 435     int rra_idx,
 436     rra_def_t *rra
 437     )
 438               RRD_DEPRECATED;
 439 #endif                  /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */
 440
 441 #endif                  /* _RRDLIB_H */
 442
 443 #ifdef  __cplusplus
 444 }
 445 #endif