1 /*****************************************************************************
2 * RRDtool 1.3.2 Copyright by Tobi Oetiker, 1997-2008
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 */
60 typedef size_t ssize_t;
65 #include <stdio.h> /* for FILE */
68 /* Formerly rrd_nan_inf.h */
70 # define DNAN rrd_set_to_DNAN()
74 # define DINF rrd_set_to_DINF()
76 double rrd_set_to_DNAN(
78 double rrd_set_to_DINF(
80 /* end of rrd_nan_inf.h */
82 /* Transplanted from rrd_format.h */
83 typedef double rrd_value_t; /* the data storage type is
85 /* END rrd_format.h */
87 /* information about an rrd file */
88 typedef struct rrd_file_t {
89 size_t header_len; /* length of the header of this rrd file */
90 size_t file_len; /* total size of the rrd file */
91 size_t pos; /* current pos in file */
95 /* information used for the conventional file access methods */
96 typedef struct rrd_simple_file_t {
97 int fd; /* file descriptor of this rrd file */
99 char *file_start; /* start address of an open rrd file */
105 /* rrd info interface */
106 typedef struct rrd_blob_t {
107 unsigned long size; /* size of the blob */
108 unsigned char *ptr; /* pointer */
111 typedef enum rrd_info_type { RD_I_VAL = 0,
118 typedef union rrd_infoval {
126 typedef struct rrd_info_t {
128 rrd_info_type_t type;
130 struct rrd_info_t *next;
134 /* main function blocks */
138 rrd_info_t *rrd_info(
141 rrd_info_t *rrd_info_push(
153 rrd_info_t *rrd_update_v(
165 rrd_info_t *rrd_graph_v(
190 int rrd_lastupdate(int argc, char **argv);
197 char *rrd_strversion(
211 int rrd_flushcached (int argc, char **argv);
216 /* thread-safe (hopefully) */
218 const char *filename,
219 unsigned long pdp_step,
223 rrd_info_t *rrd_info_r(
225 /* NOTE: rrd_update_r are only thread-safe if no at-style time
226 specifications get used!!! */
229 const char *filename,
230 const char *_template,
234 const char *filename,
239 unsigned long *ds_cnt,
243 const char *filename,
245 time_t rrd_last_r (const char *filename);
246 int rrd_lastupdate_r (const char *filename,
247 time_t *ret_last_update,
248 unsigned long *ret_ds_count,
249 char ***ret_ds_names,
250 char ***ret_last_ds);
252 const char *filename,
255 /* Transplanted from rrd_parsetime.h */
258 RELATIVE_TO_START_TIME,
264 typedef struct rrd_time_value {
272 rrd_time_value_t * ptv);
273 /* END rrd_parsetime.h */
275 typedef struct rrd_context {
276 char lib_errstr[256];
277 char rrd_error[4096];
280 /* returns the current per-thread rrd_context */
281 rrd_context_t *rrd_get_context(void);
284 /* this was added by the win32 porters Christof.Wegmann@exitgames.com */
285 rrd_context_t *rrd_force_new_context(void);
288 int rrd_proc_start_end(
294 /* HELPER FUNCTIONS */
298 void rrd_clear_error(
305 /* rrd_strerror is thread safe, but still it uses a global buffer
306 (but one per thread), thus subsequent calls within a single
307 thread overwrite the same buffer */
308 const char *rrd_strerror(
311 /** MULTITHREADED HELPER FUNCTIONS */
312 rrd_context_t *rrd_new_context(
314 void rrd_free_context(
315 rrd_context_t * buf);
317 /* void rrd_set_error_r (rrd_context_t *, char *, ...); */
318 /* void rrd_clear_error_r(rrd_context_t *); */
319 /* int rrd_test_error_r (rrd_context_t *); */
320 /* char *rrd_get_error_r (rrd_context_t *); */
322 /** UTILITY FUNCTIONS */
324 long rrd_random(void);
326 int rrd_add_ptr(void ***dest, size_t *dest_size, void *src);
327 int rrd_add_strdup(char ***dest, size_t *dest_size, char *src);
328 void rrd_free_ptrs(void ***src, size_t *cnt);
331 * The following functions are _internal_ functions needed to read the raw RRD
332 * files. Since they are _internal_ they may change with the file format and
333 * will be replaced with a more general interface in RRDTool 1.4. Don't use
334 * these functions unless you have good reasons to do so. If you do use these
335 * functions you will have to adapt your code for RRDTool 1.4!
337 * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before
338 * including <rrd_test.h>. You have been warned! If you come back to the
339 * RRDTool mailing list and whine about your broken application, you will get
340 * hit with something smelly!
342 #if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED)
344 # if defined(_RRD_TOOL_H)
345 # include "rrd_format.h"
347 # include <rrd_format.h>
350 #if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED)
351 # define RRD_DEPRECATED __attribute__((deprecated))
353 # define RRD_DEPRECATED /**/
362 rrd_file_t *rrd_open(
363 const char *const file_name,
369 rrd_file_t *rrd_file,
373 rrd_file_t *rrd_file)
376 rrd_file_t *rrd_file,
381 rrd_file_t *rrd_file,
386 rrd_file_t *rrd_file)
389 rrd_file_t *rrd_file,
394 rrd_file_t *rrd_file)
400 rrd_file_t *rrd_file,
402 unsigned long rra_row,
405 unsigned long rrd_select_initial_row(
406 rrd_file_t *rrd_file,
411 #endif /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */
413 #endif /* _RRDLIB_H */