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
52 #ifndef _RRDLIB_H
53 #define _RRDLIB_H
55 #include <sys/types.h> /* for off_t */
57 #ifndef WIN32
58 #include <unistd.h> /* for off_t */
59 #else
60 #ifdef _MSC_VER
61 #ifndef PERLPATCHLEVEL
62 typedef int mode_t;
63 #endif
64 #define strtoll _strtoi64
65 #endif
66 typedef size_t ssize_t;
67 typedef long off_t;
68 #endif
70 #include <time.h>
71 #include <stdio.h> /* for FILE */
72 #include <string.h>
74 /* Formerly rrd_nan_inf.h */
75 #ifndef DNAN
76 # define DNAN rrd_set_to_DNAN()
77 #endif
79 #ifndef DINF
80 # define DINF rrd_set_to_DINF()
81 #endif
82 double rrd_set_to_DNAN(
83 void);
84 double rrd_set_to_DINF(
85 void);
86 /* end of rrd_nan_inf.h */
88 /* Transplanted from rrd_format.h */
89 typedef double rrd_value_t; /* the data storage type is
90 * double */
91 /* END rrd_format.h */
93 /* information about an rrd file */
94 typedef struct rrd_file_t {
95 size_t header_len; /* length of the header of this rrd file */
96 size_t file_len; /* total size of the rrd file */
97 size_t pos; /* current pos in file */
98 void *pvt;
99 } rrd_file_t;
101 /* information used for the conventional file access methods */
102 typedef struct rrd_simple_file_t {
103 int fd; /* file descriptor of this rrd file */
104 #ifdef HAVE_MMAP
105 char *file_start; /* start address of an open rrd file */
106 int mm_prot;
107 int mm_flags;
108 #endif
109 } rrd_simple_file_t;
111 /* rrd info interface */
112 typedef struct rrd_blob_t {
113 unsigned long size; /* size of the blob */
114 unsigned char *ptr; /* pointer */
115 } rrd_blob_t;
117 typedef enum rrd_info_type { RD_I_VAL = 0,
118 RD_I_CNT,
119 RD_I_STR,
120 RD_I_INT,
121 RD_I_BLO
122 } rrd_info_type_t;
124 typedef union rrd_infoval {
125 unsigned long u_cnt;
126 rrd_value_t u_val;
127 char *u_str;
128 int u_int;
129 rrd_blob_t u_blo;
130 } rrd_infoval_t;
132 typedef struct rrd_info_t {
133 char *key;
134 rrd_info_type_t type;
135 rrd_infoval_t value;
136 struct rrd_info_t *next;
137 } rrd_info_t;
139 typedef size_t (* rrd_output_callback_t)(
140 const void *,
141 size_t,
142 void *);
144 /* main function blocks */
145 int rrd_create(
146 int,
147 char **);
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 **);
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);
223 void rrd_freemem(
224 void *mem);
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 no_overwrite, */
232 int argc,
233 const char **argv);
234 int rrd_create_r2(
235 const char *filename,
236 unsigned long pdp_step,
237 time_t last_up,
238 int no_overwrite,
239 int argc,
240 const char **argv);
241 rrd_info_t *rrd_info_r(
242 char *);
243 /* NOTE: rrd_update_r and rrd_update_v_r are only thread-safe if no at-style
244 time specifications get used!!! */
246 int rrd_update_r(
247 const char *filename,
248 const char *_template,
249 int argc,
250 const char **argv);
251 int rrd_update_v_r(
252 const char *filename,
253 const char *_template,
254 int argc,
255 const char **argv,
256 rrd_info_t * pcdp_summary);
257 int rrd_fetch_r (
258 const char *filename,
259 const char *cf,
260 time_t *start,
261 time_t *end,
262 unsigned long *step,
263 unsigned long *ds_cnt,
264 char ***ds_namv,
265 rrd_value_t **data);
266 int rrd_dump_r(
267 const char *filename,
268 char *outname);
269 time_t rrd_last_r (const char *filename);
270 int rrd_lastupdate_r (const char *filename,
271 time_t *ret_last_update,
272 unsigned long *ret_ds_count,
273 char ***ret_ds_names,
274 char ***ret_last_ds);
275 time_t rrd_first_r(
276 const char *filename,
277 int rraindex);
279 int rrd_dump_cb_r(
280 const char *filename,
281 int opt_header,
282 rrd_output_callback_t cb,
283 void *user);
285 /* Transplanted from rrd_parsetime.h */
286 typedef enum {
287 ABSOLUTE_TIME,
288 RELATIVE_TO_START_TIME,
289 RELATIVE_TO_END_TIME,
290 RELATIVE_TO_EPOCH
291 } rrd_timetype_t;
293 #define TIME_OK NULL
295 typedef struct rrd_time_value {
296 rrd_timetype_t type;
297 long offset;
298 struct tm tm;
299 } rrd_time_value_t;
301 char *rrd_parsetime(
302 const char *spec,
303 rrd_time_value_t * ptv);
304 /* END rrd_parsetime.h */
306 typedef struct rrd_context {
307 char lib_errstr[256];
308 char rrd_error[4096];
309 } rrd_context_t;
311 /* returns the current per-thread rrd_context */
312 rrd_context_t *rrd_get_context(void);
314 #ifdef WIN32
315 /* this was added by the win32 porters Christof.Wegmann@exitgames.com */
316 rrd_context_t *rrd_force_new_context(void);
317 #endif
319 int rrd_proc_start_end(
320 rrd_time_value_t *,
321 rrd_time_value_t *,
322 time_t *,
323 time_t *);
325 /* HELPER FUNCTIONS */
326 void rrd_set_error(
327 char *,
328 ...);
329 void rrd_clear_error(
330 void);
331 int rrd_test_error(
332 void);
333 char *rrd_get_error(
334 void);
336 /* rrd_strerror is thread safe, but still it uses a global buffer
337 (but one per thread), thus subsequent calls within a single
338 thread overwrite the same buffer */
339 const char *rrd_strerror(
340 int err);
342 /** MULTITHREADED HELPER FUNCTIONS */
343 rrd_context_t *rrd_new_context(
344 void);
345 void rrd_free_context(
346 rrd_context_t * buf);
348 /* void rrd_set_error_r (rrd_context_t *, char *, ...); */
349 /* void rrd_clear_error_r(rrd_context_t *); */
350 /* int rrd_test_error_r (rrd_context_t *); */
351 /* char *rrd_get_error_r (rrd_context_t *); */
353 /** UTILITY FUNCTIONS */
355 long rrd_random(void);
357 int rrd_add_ptr_chunk(void ***dest, size_t *dest_size, void *src,
358 size_t *alloc, size_t chunk);
359 int rrd_add_ptr(void ***dest, size_t *dest_size, void *src);
360 int rrd_add_strdup(char ***dest, size_t *dest_size, char *src);
361 int rrd_add_strdup_chunk(char ***dest, size_t *dest_size, char *src,
362 size_t *alloc, size_t chunk);
363 void rrd_free_ptrs(void ***src, size_t *cnt);
365 int rrd_mkdir_p(const char *pathname, mode_t mode);
367 /*
368 * The following functions are _internal_ functions needed to read the raw RRD
369 * files. Since they are _internal_ they may change with the file format and
370 * will be replaced with a more general interface in RRDTool 1.4. Don't use
371 * these functions unless you have good reasons to do so. If you do use these
372 * functions you will have to adapt your code for RRDTool 1.4!
373 *
374 * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before
375 * including <rrd_test.h>. You have been warned! If you come back to the
376 * RRDTool mailing list and whine about your broken application, you will get
377 * hit with something smelly!
378 */
379 #if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED)
381 # if defined(_RRD_TOOL_H)
382 # include "rrd_format.h"
383 # else
384 # include <rrd_format.h>
385 # endif
387 #if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED)
388 # define RRD_DEPRECATED __attribute__((deprecated))
389 #else
390 # define RRD_DEPRECATED /**/
391 #endif
392 void rrd_free(
393 rrd_t *rrd)
394 RRD_DEPRECATED;
395 void rrd_init(
396 rrd_t *rrd)
397 RRD_DEPRECATED;
399 rrd_file_t *rrd_open(
400 const char *const file_name,
401 rrd_t *rrd,
402 unsigned rdwr)
403 RRD_DEPRECATED;
405 void rrd_dontneed(
406 rrd_file_t *rrd_file,
407 rrd_t *rrd)
408 RRD_DEPRECATED;
409 int rrd_close(
410 rrd_file_t *rrd_file)
411 RRD_DEPRECATED;
412 ssize_t rrd_read(
413 rrd_file_t *rrd_file,
414 void *buf,
415 size_t count)
416 RRD_DEPRECATED;
417 ssize_t rrd_write(
418 rrd_file_t *rrd_file,
419 const void *buf,
420 size_t count)
421 RRD_DEPRECATED;
422 void rrd_flush(
423 rrd_file_t *rrd_file)
424 RRD_DEPRECATED;
425 off_t rrd_seek(
426 rrd_file_t *rrd_file,
427 off_t off,
428 int whence)
429 RRD_DEPRECATED;
430 off_t rrd_tell(
431 rrd_file_t *rrd_file)
432 RRD_DEPRECATED;
433 int rrd_lock(
434 rrd_file_t *file)
435 RRD_DEPRECATED;
436 void rrd_notify_row(
437 rrd_file_t *rrd_file,
438 int rra_idx,
439 unsigned long rra_row,
440 time_t rra_time)
441 RRD_DEPRECATED;
442 unsigned long rrd_select_initial_row(
443 rrd_file_t *rrd_file,
444 int rra_idx,
445 rra_def_t *rra
446 )
447 RRD_DEPRECATED;
448 #endif /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */
450 #endif /* _RRDLIB_H */
452 #ifdef __cplusplus
453 }
454 #endif