src/rrd.h

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