Code

prepare for the release of rrdtool-1.2.16
[rrdtool.git] / src / rrd_tool.h
1 /*****************************************************************************
2  * RRDtool 1.2.16  Copyright by Tobi Oetiker, 1997-2006
3  *****************************************************************************
4  * rrd_tool.h   Common Header File
5  *****************************************************************************/
6 #ifdef  __cplusplus
7 extern "C" {
8 #endif
11 #ifndef _RRD_TOOL_H
12 #define _RRD_TOOL_H
14 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__) && !defined(HAVE_CONFIG_H)
15 #include "../win32/config.h"
16 #else
17 #ifdef HAVE_CONFIG_H
18 #include "../rrd_config.h"
19 #endif
20 #endif
22 #ifdef MUST_DISABLE_SIGFPE
23 #include <signal.h>
24 #endif
26 #ifdef MUST_DISABLE_FPMASK
27 #include <floatingpoint.h>
28 #endif
29     
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <errno.h>
33 #include <string.h>
34 #include <time.h>
35 #include <ctype.h>
37 #if HAVE_SYS_PARAM_H
38 #  include <sys/param.h>
39 #endif
41 #ifndef MAXPATH
42 #  define MAXPATH 1024
43 #endif
45 #if HAVE_MATH_H
46 # include <math.h>
47 #endif
48 /* Sorry: don't know autoconf as well how to check the exist of
49    dirent.h ans sys/stat.h
50 */
52 #if HAVE_DIRENT_H
53 # include <dirent.h>
54 # define NAMLEN(dirent) strlen((dirent)->d_name)
55 #else
56 # define dirent direct
57 # define NAMLEN(dirent) (dirent)->d_namlen
58 # if HAVE_SYS_NDIR_H
59 #  include <sys/ndir.h>
60 # endif
61 # if HAVE_SYS_DIR_H
62 #  include <sys/dir.h>
63 # endif
64 # if HAVE_NDIR_H
65 #  include <ndir.h>
66 # endif
67 #endif
69 #if HAVE_SYS_TYPES_H
70 # include <sys/types.h>
71 #endif
73 #if HAVE_SYS_STAT_H
74 # include <sys/stat.h>
75 #endif
78 #if HAVE_UNISTD_H
79 # include <unistd.h>
80 #endif
81 #if HAVE_SYS_TIME_H
82 # include <sys/time.h>
83 #endif
84 #if HAVE_SYS_TIMES_H
85 # include <sys/times.h>
86 #endif
87 #if HAVE_SYS_RESOURCE_H
88 # include <sys/resource.h>
89 #if (defined(__svr4__) && defined(__sun__))
90 /* Solaris headers (pre 2.6) don't have a getrusage prototype.
91    Use this instead. */
92 extern int getrusage(int, struct rusage *);
93 #endif /* __svr4__ && __sun__ */
94 #endif
96 #include "rrd.h"
98 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
100 /* Win32 only includes */
102 #include <float.h>        /* for _isnan  */
103 #include <io.h>           /* for chdir   */
105 struct tm* localtime_r(const time_t *timep, struct tm* result);
106 char* ctime_r(const time_t *timep, char* result);
107 struct tm* gmtime_r(const time_t *timep, struct tm* result);
108 char *strtok_r(char *str, const char *sep, char **last);
110 #else
112 /* unix-only includes */
113 #ifndef isnan
114 int isnan(double value);
115 #endif
117 #endif
119 /* local include files -- need to be after the system ones */
120 #include "getopt.h"
121 #include "rrd_format.h"
123 #ifndef max
124 #define max(a,b) ((a) > (b) ? (a) : (b))
125 #endif
127 #ifndef min
128 #define min(a,b) ((a) < (b) ? (a) : (b))
129 #endif                                                   
131 #define DIM(x) (sizeof(x)/sizeof(x[0]))
133 /* rrd info interface */
134 enum info_type   { RD_I_VAL=0,
135                RD_I_CNT,
136                RD_I_STR, 
137                    RD_I_INT };
139 typedef union infoval { 
140     unsigned long u_cnt; 
141     rrd_value_t   u_val;
142     char         *u_str;
143     int           u_int;
144 } infoval;
146 typedef struct info_t {
147     char            *key;
148     enum info_type  type;
149     union infoval   value;
150     struct info_t   *next;
151 } info_t;
153 info_t *rrd_info(int, char **);
154 int rrd_lastupdate(int argc, char **argv, time_t *last_update,
155                 unsigned long *ds_cnt, char ***ds_namv, char ***last_ds);
156 info_t *rrd_update_v(int, char **);
157 char * sprintf_alloc(char *, ...);
158 info_t *info_push(info_t *, char *, enum info_type, infoval);
160 /* HELPER FUNCTIONS */
162 int PngSize(FILE *, long *, long *);
164 int rrd_create_fn(char *file_name, rrd_t *rrd);
165 int rrd_fetch_fn(char *filename, enum cf_en cf_idx,
166                  time_t *start,time_t *end,
167                  unsigned long *step,
168                  unsigned long *ds_cnt,
169                  char        ***ds_namv,
170                  rrd_value_t **data);
172 void rrd_free(rrd_t *rrd);
173 void rrd_freemem(void *mem);
174 void rrd_init(rrd_t *rrd);
176 int rrd_open(const char *file_name, FILE **in_file, rrd_t *rrd, int rdwr);
177 int readfile(const char *file, char **buffer, int skipfirst);
179 #define RRD_READONLY    0
180 #define RRD_READWRITE   1
182 enum cf_en cf_conv(char *string);
183 enum dst_en dst_conv(char *string);
184 long ds_match(rrd_t *rrd,char *ds_nam);
185 double rrd_diff(char *a, char *b);
187     /* rrd_strerror is thread safe, but still it uses a global buffer
188        (but one per thread), thus subsequent calls within a single
189        thread overwrite the same buffer */
190 const char *rrd_strerror(int err);
192 #endif
194 #ifdef  __cplusplus
196 #endif