fddadd08883ced24e679174e67415eae5643fa4b
1 /*****************************************************************************
2 * RRDtool 1.3.3 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
52 #ifndef _RRDLIB_H
53 #define _RRDLIB_H
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 */
61 /* Formerly rrd_nan_inf.h */
62 #ifndef DNAN
63 # define DNAN rrd_set_to_DNAN()
64 #endif
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 */
75 /* Transplanted from rrd_format.h */
76 typedef double rrd_value_t; /* the data storage type is
77 * double */
78 /* END rrd_format.h */
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;
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;
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;
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;
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;
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 **);
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(
175 int argc,
176 char **argv,
177 time_t *last_update,
178 unsigned long *ds_cnt,
179 char ***ds_namv,
180 char ***last_ds);
181 time_t rrd_first(
182 int,
183 char **);
184 int rrd_resize(
185 int,
186 char **);
187 char *rrd_strversion(
188 void);
189 double rrd_version(
190 void);
191 int rrd_xport(
192 int,
193 char **,
194 int *,
195 time_t *,
196 time_t *,
197 unsigned long *,
198 unsigned long *,
199 char ***,
200 rrd_value_t **);
202 void rrd_freemem(
203 void *mem);
205 /* thread-safe (hopefully) */
206 int rrd_create_r(
207 const char *filename,
208 unsigned long pdp_step,
209 time_t last_up,
210 int argc,
211 const char **argv);
212 /* NOTE: rrd_update_r are only thread-safe if no at-style time
213 specifications get used!!! */
215 int rrd_update_r(
216 const char *filename,
217 const char *_template,
218 int argc,
219 const char **argv);
220 int rrd_fetch_r(
221 const char *filename,
222 const char *cf,
223 time_t *start,
224 time_t *end,
225 unsigned long *step,
226 unsigned long *ds_cnt,
227 char ***ds_namv,
228 rrd_value_t **data);
229 int rrd_dump_r(
230 const char *filename,
231 char *outname);
232 time_t rrd_last_r(
233 const char *filename);
234 time_t rrd_first_r(
235 const char *filename,
236 int rraindex);
238 /* Transplanted from rrd_parsetime.h */
239 typedef enum {
240 ABSOLUTE_TIME,
241 RELATIVE_TO_START_TIME,
242 RELATIVE_TO_END_TIME
243 } rrd_timetype_t;
245 #define TIME_OK NULL
247 typedef struct rrd_time_value {
248 rrd_timetype_t type;
249 long offset;
250 struct tm tm;
251 } rrd_time_value_t;
253 char *rrd_parsetime(
254 const char *spec,
255 rrd_time_value_t * ptv);
256 /* END rrd_parsetime.h */
258 typedef struct rrd_context {
259 char lib_errstr[256];
260 char rrd_error[4096];
261 } rrd_context_t;
263 /* returns the current per-thread rrd_context */
264 rrd_context_t *rrd_get_context(
265 void);
268 int rrd_proc_start_end(
269 rrd_time_value_t *,
270 rrd_time_value_t *,
271 time_t *,
272 time_t *);
274 /* HELPER FUNCTIONS */
275 void rrd_set_error(
276 char *,
277 ...);
278 void rrd_clear_error(
279 void);
280 int rrd_test_error(
281 void);
282 char *rrd_get_error(
283 void);
285 /* rrd_strerror is thread safe, but still it uses a global buffer
286 (but one per thread), thus subsequent calls within a single
287 thread overwrite the same buffer */
288 const char *rrd_strerror(
289 int err);
291 /** MULTITHREADED HELPER FUNCTIONS */
292 rrd_context_t *rrd_new_context(
293 void);
294 void rrd_free_context(
295 rrd_context_t * buf);
297 /* void rrd_set_error_r (rrd_context_t *, char *, ...); */
298 /* void rrd_clear_error_r(rrd_context_t *); */
299 /* int rrd_test_error_r (rrd_context_t *); */
300 /* char *rrd_get_error_r (rrd_context_t *); */
302 /*
303 * The following functions are _internal_ functions needed to read the raw RRD
304 * files. Since they are _internal_ they may change with the file format and
305 * will be replaced with a more general interface in RRDTool 1.4. Don't use
306 * these functions unless you have good reasons to do so. If you do use these
307 * functions you will have to adapt your code for RRDTool 1.4!
308 *
309 * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before
310 * including <rrd_test.h>. You have been warned! If you come back to the
311 * RRDTool mailing list and whine about your broken application, you will get
312 * hit with something smelly!
313 */
314 #if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED)
316 # if defined(_RRD_TOOL_H)
317 # include "rrd_format.h"
318 # else
319 # include <rrd_format.h>
320 # endif
322 #if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED)
323 # define RRD_DEPRECATED __attribute__((deprecated))
324 #else
325 # define RRD_DEPRECATED /**/
326 #endif
327 void rrd_free(
328 rrd_t *rrd)
329 RRD_DEPRECATED;
330 void rrd_init(
331 rrd_t *rrd)
332 RRD_DEPRECATED;
334 rrd_file_t *rrd_open(
335 const char *const file_name,
336 rrd_t *rrd,
337 unsigned rdwr)
338 RRD_DEPRECATED;
340 void rrd_dontneed(
341 rrd_file_t *rrd_file,
342 rrd_t *rrd)
343 RRD_DEPRECATED;
344 int rrd_close(
345 rrd_file_t *rrd_file)
346 RRD_DEPRECATED;
347 ssize_t rrd_read(
348 rrd_file_t *rrd_file,
349 void *buf,
350 size_t count)
351 RRD_DEPRECATED;
352 ssize_t rrd_write(
353 rrd_file_t *rrd_file,
354 const void *buf,
355 size_t count)
356 RRD_DEPRECATED;
357 void rrd_flush(
358 rrd_file_t *rrd_file)
359 RRD_DEPRECATED;
360 off_t rrd_seek(
361 rrd_file_t *rrd_file,
362 off_t off,
363 int whence)
364 RRD_DEPRECATED;
365 off_t rrd_tell(
366 rrd_file_t *rrd_file)
367 RRD_DEPRECATED;
368 int rrd_lock(
369 rrd_file_t *file)
370 RRD_DEPRECATED;
371 #endif /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */
373 #endif /* _RRDLIB_H */
375 #ifdef __cplusplus
376 }
377 #endif