X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=src%2Frrd.h;h=a7fe7597e0d47a1420b47e6db9ed88420eacb7f2;hp=a327a1ba4a8dd6c64244464d6d851caa5c580364;hb=657d850f957a2dd703e3aab2d7cde4b0f9711c15;hpb=5837606887a6d81e8b1f7588525cb1c8783fb62b diff --git a/src/rrd.h b/src/rrd.h index a327a1b..a7fe759 100644 --- a/src/rrd.h +++ b/src/rrd.h @@ -1,68 +1,231 @@ /***************************************************************************** - * RRDtool 1.0.33 Copyright Tobias Oetiker, 1997,1998, 1999 + * RRDtool 1.2.23 Copyright by Tobi Oetiker, 1997-2007 ***************************************************************************** * rrdlib.h Public header file for librrd ***************************************************************************** * $Id$ * $Log$ - * Revision 1.1 2001/02/25 22:25:05 oetiker - * Initial revision + * Revision 1.9 2005/02/13 16:13:33 oetiker + * let rrd_graph return the actual value range it picked ... + * -- Henrik Stoerner + * + * Revision 1.8 2004/05/26 22:11:12 oetiker + * reduce compiler warnings. Many small fixes. -- Mike Slifcak + * + * Revision 1.7 2003/11/12 22:14:26 oetiker + * allow to pass an open filehandle into rrd_graph as an extra argument + * + * Revision 1.6 2003/11/11 19:46:21 oetiker + * replaced time_value with rrd_time_value as MacOS X introduced a struct of that name in their standard headers + * + * Revision 1.5 2003/04/25 18:35:08 jake + * 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. + * + * Revision 1.4 2003/04/01 22:52:23 jake + * Fix Win32 build. VC++ 6.0 and 7.0 now use the thread-safe code. + * + * Revision 1.3 2003/02/13 07:05:27 oetiker + * Find attached the patch I promised to send to you. Please note that there + * are three new source files (src/rrd_is_thread_safe.h, src/rrd_thread_safe.c + * and src/rrd_not_thread_safe.c) and the introduction of librrd_th. This + * library is identical to librrd, but it contains support code for per-thread + * global variables currently used for error information only. This is similar + * to how errno per-thread variables are implemented. librrd_th must be linked + * alongside of libpthred + * + * There is also a new file "THREADS", holding some documentation. + * + * -- Peter Stamfest + * + * Revision 1.2 2002/05/07 21:58:32 oetiker + * new command rrdtool xport integrated + * -- Wolfgang Schrimm + * + * Revision 1.1.1.1 2001/02/25 22:25:05 oetiker + * checkin * *****************************************************************************/ #ifdef __cplusplus -extern "C" { +extern "C" { #endif #ifndef _RRDLIB_H #define _RRDLIB_H +#include /* for off_t */ +#include /* for off_t */ #include +#include /* for FILE */ /* Transplanted from rrd_format.h */ -typedef double rrd_value_t; /* the data storage type is - * double */ + typedef double rrd_value_t; /* the data storage type is + * double */ /* END rrd_format.h */ +/* information about an rrd file */ + typedef struct rrd_file_t { + int fd; /* file descriptor if this rrd file */ + char *file_start; /* start address of an open rrd file */ + off_t header_len; /* length of the header of this rrd file */ + off_t file_len; /* total size of the rrd file */ + off_t pos; /* current pos in file */ + } rrd_file_t; + /* main function blocks */ -int rrd_create(int, char **); -int rrd_update(int, char **); -int rrd_graph(int, char **, char ***, int *, int *); -int rrd_fetch(int, char **, time_t *, time_t *, unsigned long *, - unsigned long *, char ***, rrd_value_t **); -int rrd_restore(int, char **); -int rrd_dump(int, char **); -int rrd_tune(int, char **); -time_t rrd_last(int, char **); -int rrd_resize(int, char **); + int rrd_create( + int, + char **); + int rrd_update( + int, + char **); + int rrd_graph( + int, + char **, + char ***, + int *, + int *, + FILE *, + double *, + double *); + int rrd_fetch( + int, + char **, + time_t *, + time_t *, + unsigned long *, + unsigned long *, + char ***, + rrd_value_t **); + int rrd_restore( + int, + char **); + int rrd_dump( + int, + char **); + int rrd_tune( + int, + char **); + time_t rrd_last( + int, + char **); + time_t rrd_first( + int, + char **); + int rrd_resize( + int, + char **); + char *rrd_strversion( + void); + double rrd_version( + void); + int rrd_xport( + int, + char **, + int *, + time_t *, + time_t *, + unsigned long *, + unsigned long *, + char ***, + rrd_value_t **); + +/* thread-safe (hopefully) */ + int rrd_create_r( + const char *filename, + unsigned long pdp_step, + time_t last_up, + int argc, + const char **argv); +/* NOTE: rrd_update_r are only thread-safe if no at-style time + specifications get used!!! */ + + int rrd_update_r( + const char *filename, + const char *_template, + int argc, + const char **argv); + int rrd_fetch_r( + const char *filename, + const char *cf, + time_t *start, + time_t *end, + unsigned long *step, + unsigned long *ds_cnt, + char ***ds_namv, + rrd_value_t **data); + int rrd_dump_r( + const char *filename, + char *outname); + time_t rrd_last_r( + const char *filename); + time_t rrd_first_r( + const char *filename, + int rraindex); /* Transplanted from parsetime.h */ -typedef enum { + typedef enum { ABSOLUTE_TIME, - RELATIVE_TO_START_TIME, + RELATIVE_TO_START_TIME, RELATIVE_TO_END_TIME -} timetype; + } timetype; #define TIME_OK NULL -struct time_value { - timetype type; - long offset; - struct tm tm; -}; + struct rrd_time_value { + timetype type; + long offset; + struct tm tm; + }; -char *parsetime(char *spec, struct time_value *ptv); + char *parsetime( + const char *spec, + struct rrd_time_value *ptv); /* END parsetime.h */ -int proc_start_end (struct time_value *, struct time_value *, time_t *, time_t *); + struct rrd_context { + int len; + int errlen; + char *lib_errstr; + char *rrd_error; + }; + +/* returns the current per-thread rrd_context */ + struct rrd_context *rrd_get_context( + void); + + + int proc_start_end( + struct rrd_time_value *, + struct rrd_time_value *, + time_t *, + time_t *); /* HELPER FUNCTIONS */ -void rrd_set_error(char *,...); -void rrd_clear_error(void); -int rrd_test_error(void); -char *rrd_get_error(void); -int LockRRD(FILE *); + void rrd_set_error( + char *, + ...); + void rrd_clear_error( + void); + int rrd_test_error( + void); + char *rrd_get_error( + void); + +/** MULTITHREADED HELPER FUNCTIONS */ + struct rrd_context *rrd_new_context( + void); + void rrd_free_context( + struct rrd_context *buf); + +/* void rrd_set_error_r (struct rrd_context *, char *, ...); */ +/* void rrd_clear_error_r(struct rrd_context *); */ +/* int rrd_test_error_r (struct rrd_context *); */ +/* char *rrd_get_error_r (struct rrd_context *); */ + + int LockRRD( + int in_file); -#endif /* _RRDLIB_H */ +#endif /* _RRDLIB_H */ #ifdef __cplusplus }