src/rrd.h

   1 /*****************************************************************************
   2  * RRDtool 1.2.23  Copyright by Tobi Oetiker, 1997-2007
   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 /* Transplanted from rrd_format.h */
  61 typedef double       rrd_value_t;         /* the data storage type is
  62                                            * double */
  63 /* END rrd_format.h */
  64
  65 /* information about an rrd file */
  66 typedef struct rrd_file_t {
  67         int   fd;         /* file descriptor if this rrd file */
  68         char* file_start; /* start address of an open rrd file */
  69         off_t header_len; /* length of the header of this rrd file */
  70         off_t file_len;   /* total size of the rrd file */
  71         off_t pos;        /* current pos in file */
  72 } rrd_file_t;
  73
  74 /* main function blocks */
  75 int    rrd_create(int, char **);
  76 int    rrd_update(int, char **);
  77 int    rrd_graph(int, char **, char ***, int *, int *, FILE *, double *, double *);
  78 int    rrd_fetch(int, char **, time_t *, time_t *, unsigned long *,
  79                  unsigned long *, char ***, rrd_value_t **);
  80 int    rrd_restore(int, char **);
  81 int    rrd_dump(int, char **);
  82 int    rrd_tune(int, char **);
  83 time_t rrd_last(int, char **);
  84 time_t rrd_first(int, char **);
  85 int    rrd_resize(int, char **);
  86 char * rrd_strversion(void);
  87 double rrd_version(void);
  88 int    rrd_xport(int, char **, int *, time_t *, time_t *,
  89                  unsigned long *, unsigned long *,
  90                  char ***, rrd_value_t **);
  91
  92 /* thread-safe (hopefully) */
  93 int    rrd_create_r(const char *filename,
  94                     unsigned long pdp_step, time_t last_up,
  95                     int argc, const char **argv);
  96 /* NOTE: rrd_update_r are only thread-safe if no at-style time
  97    specifications get used!!! */
  98
  99 int    rrd_update_r(const char *filename, const char *_template,
 100                     int argc, const char **argv);
 101 int    rrd_fetch_r(const char *filename, const char* cf,
 102                    time_t *start, time_t *end,
 103                    unsigned long *step,
 104                    unsigned long *ds_cnt,
 105                    char        ***ds_namv,
 106                    rrd_value_t **data);
 107 int    rrd_dump_r(const char *filename, char *outname);
 108 time_t rrd_last_r(const char *filename);
 109 time_t rrd_first_r(const char *filename, int rraindex);
 110
 111 /* Transplanted from parsetime.h */
 112 typedef enum {
 113         ABSOLUTE_TIME,
 114         RELATIVE_TO_START_TIME,
 115         RELATIVE_TO_END_TIME
 116 } timetype;
 117
 118 #define TIME_OK NULL
 119
 120 struct rrd_time_value {
 121   timetype type;
 122   long offset;
 123   struct tm tm;
 124 };
 125
 126 char *parsetime(const char *spec, struct rrd_time_value *ptv);
 127 /* END parsetime.h */
 128
 129 struct rrd_context {
 130     int len;
 131     int errlen;
 132     char *lib_errstr;
 133     char *rrd_error;
 134 };
 135
 136 /* returns the current per-thread rrd_context */
 137 struct rrd_context *rrd_get_context(void);
 138
 139
 140 int proc_start_end (struct rrd_time_value *,  struct rrd_time_value *, time_t *, time_t *);
 141
 142 /* HELPER FUNCTIONS */
 143 void rrd_set_error(char *,...);
 144 void rrd_clear_error(void);
 145 int  rrd_test_error(void);
 146 char *rrd_get_error(void);
 147
 148 /** MULTITHREADED HELPER FUNCTIONS */
 149 struct rrd_context *rrd_new_context(void);
 150 void   rrd_free_context (struct rrd_context *buf);
 151
 152 /* void   rrd_set_error_r  (struct rrd_context *, char *, ...); */
 153 /* void   rrd_clear_error_r(struct rrd_context *); */
 154 /* int    rrd_test_error_r (struct rrd_context *); */
 155 /* char  *rrd_get_error_r  (struct rrd_context *); */
 156
 157 int  LockRRD(int in_file);
 158
 159 #endif /* _RRDLIB_H */
 160
 161 #ifdef  __cplusplus
 162 }
 163 #endif