1 /*****************************************************************************
2 * RRDtool 1.4.3 Copyright by Tobi Oetiker, 1997-2010
3 *****************************************************************************
4 * rrdlib.h Public header file for librrd
5 *****************************************************************************
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>
12 * Revision 1.8 2004/05/26 22:11:12 oetiker
13 * reduce compiler warnings. Many small fixes. -- Mike Slifcak <slif@bellsouth.net>
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
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
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.
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.
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
36 * There is also a new file "THREADS", holding some documentation.
38 * -- Peter Stamfest <peter@stamfest.at>
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>
44 * Revision 1.1.1.1 2001/02/25 22:25:05 oetiker
47 *****************************************************************************/
55 #include <sys/types.h> /* for off_t */
58 #include <unistd.h> /* for off_t */
62 #define strtoll _strtoi64
64 typedef size_t ssize_t;
69 #include <stdio.h> /* for FILE */
72 /* Formerly rrd_nan_inf.h */
74 # define DNAN rrd_set_to_DNAN()
78 # define DINF rrd_set_to_DINF()
80 double rrd_set_to_DNAN(
82 double rrd_set_to_DINF(
84 /* end of rrd_nan_inf.h */
86 /* Transplanted from rrd_format.h */
87 typedef double rrd_value_t; /* the data storage type is
89 /* END rrd_format.h */
91 /* information about an rrd file */
92 typedef struct rrd_file_t {
93 size_t header_len; /* length of the header of this rrd file */
94 size_t file_len; /* total size of the rrd file */
95 size_t pos; /* current pos in file */
99 /* information used for the conventional file access methods */
100 typedef struct rrd_simple_file_t {
101 int fd; /* file descriptor of this rrd file */
103 char *file_start; /* start address of an open rrd file */
109 /* rrd info interface */
110 typedef struct rrd_blob_t {
111 unsigned long size; /* size of the blob */
112 unsigned char *ptr; /* pointer */
115 typedef enum rrd_info_type { RD_I_VAL = 0,
122 typedef union rrd_infoval {
130 typedef struct rrd_info_t {
132 rrd_info_type_t type;
134 struct rrd_info_t *next;
137 typedef size_t (* rrd_output_callback_t)(
142 /* main function blocks */
146 rrd_info_t *rrd_info(
149 rrd_info_t *rrd_info_push(
161 rrd_info_t *rrd_update_v(
173 rrd_info_t *rrd_graph_v(
198 int rrd_lastupdate(int argc, char **argv);
205 char *rrd_strversion(
219 int rrd_flushcached (int argc, char **argv);
224 /* thread-safe (hopefully) */
226 const char *filename,
227 unsigned long pdp_step,
231 rrd_info_t *rrd_info_r(
233 /* NOTE: rrd_update_r and rrd_update_v_r are only thread-safe if no at-style
234 time specifications get used!!! */
237 const char *filename,
238 const char *_template,
242 const char *filename,
243 const char *_template,
246 rrd_info_t * pcdp_summary);
248 const char *filename,
253 unsigned long *ds_cnt,
257 const char *filename,
259 time_t rrd_last_r (const char *filename);
260 int rrd_lastupdate_r (const char *filename,
261 time_t *ret_last_update,
262 unsigned long *ret_ds_count,
263 char ***ret_ds_names,
264 char ***ret_last_ds);
266 const char *filename,
270 const char *filename,
272 rrd_output_callback_t cb,
275 /* Transplanted from rrd_parsetime.h */
278 RELATIVE_TO_START_TIME,
284 typedef struct rrd_time_value {
292 rrd_time_value_t * ptv);
293 /* END rrd_parsetime.h */
295 typedef struct rrd_context {
296 char lib_errstr[256];
297 char rrd_error[4096];
300 /* returns the current per-thread rrd_context */
301 rrd_context_t *rrd_get_context(void);
304 /* this was added by the win32 porters Christof.Wegmann@exitgames.com */
305 rrd_context_t *rrd_force_new_context(void);
308 int rrd_proc_start_end(
314 /* HELPER FUNCTIONS */
318 void rrd_clear_error(
325 /* rrd_strerror is thread safe, but still it uses a global buffer
326 (but one per thread), thus subsequent calls within a single
327 thread overwrite the same buffer */
328 const char *rrd_strerror(
331 /** MULTITHREADED HELPER FUNCTIONS */
332 rrd_context_t *rrd_new_context(
334 void rrd_free_context(
335 rrd_context_t * buf);
337 /* void rrd_set_error_r (rrd_context_t *, char *, ...); */
338 /* void rrd_clear_error_r(rrd_context_t *); */
339 /* int rrd_test_error_r (rrd_context_t *); */
340 /* char *rrd_get_error_r (rrd_context_t *); */
342 /** UTILITY FUNCTIONS */
344 long rrd_random(void);
346 int rrd_add_ptr_chunk(void ***dest, size_t *dest_size, void *src,
347 size_t *alloc, size_t chunk);
348 int rrd_add_ptr(void ***dest, size_t *dest_size, void *src);
349 int rrd_add_strdup(char ***dest, size_t *dest_size, char *src);
350 int rrd_add_strdup_chunk(char ***dest, size_t *dest_size, char *src,
351 size_t *alloc, size_t chunk);
352 void rrd_free_ptrs(void ***src, size_t *cnt);
354 int rrd_mkdir_p(const char *pathname, mode_t mode);
357 * The following functions are _internal_ functions needed to read the raw RRD
358 * files. Since they are _internal_ they may change with the file format and
359 * will be replaced with a more general interface in RRDTool 1.4. Don't use
360 * these functions unless you have good reasons to do so. If you do use these
361 * functions you will have to adapt your code for RRDTool 1.4!
363 * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before
364 * including <rrd_test.h>. You have been warned! If you come back to the
365 * RRDTool mailing list and whine about your broken application, you will get
366 * hit with something smelly!
368 #if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED)
370 # if defined(_RRD_TOOL_H)
371 # include "rrd_format.h"
373 # include <rrd_format.h>
376 #if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED)
377 # define RRD_DEPRECATED __attribute__((deprecated))
379 # define RRD_DEPRECATED /**/
388 rrd_file_t *rrd_open(
389 const char *const file_name,
395 rrd_file_t *rrd_file,
399 rrd_file_t *rrd_file)
402 rrd_file_t *rrd_file,
407 rrd_file_t *rrd_file,
412 rrd_file_t *rrd_file)
415 rrd_file_t *rrd_file,
420 rrd_file_t *rrd_file)
426 rrd_file_t *rrd_file,
428 unsigned long rra_row,
431 unsigned long rrd_select_initial_row(
432 rrd_file_t *rrd_file,
437 #endif /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */
439 #endif /* _RRDLIB_H */