X-Git-Url: https://git.octo.it/?p=rrdtool.git;a=blobdiff_plain;f=src%2Frrd.h;h=91bf660b4936679c36459653a921c7b61a62fe31;hp=70674e87ba6ca9db20b6b0c68adeb524569b8203;hb=c29c7a38247934755ae9a68abb1bcf8cc7872d24;hpb=a5eb18ad8c70e530a2e28ed435a0f52da0f5bee0 diff --git a/src/rrd.h b/src/rrd.h index 70674e8..91bf660 100644 --- a/src/rrd.h +++ b/src/rrd.h @@ -1,5 +1,5 @@ /***************************************************************************** - * RRDtool 1.3rc8 Copyright by Tobi Oetiker, 1997-2008 + * RRDtool 1.4.3 Copyright by Tobi Oetiker, 1997-2010 ***************************************************************************** * rrdlib.h Public header file for librrd ***************************************************************************** @@ -53,10 +53,17 @@ extern "C" { #define _RRDLIB_H #include /* for off_t */ + +#ifndef WIN32 #include /* for off_t */ +#else + typedef size_t ssize_t; + typedef long off_t; +#endif + #include #include /* for FILE */ - +#include /* Formerly rrd_nan_inf.h */ #ifndef DNAN @@ -79,13 +86,22 @@ extern "C" { /* 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 */ + size_t header_len; /* length of the header of this rrd file */ + size_t file_len; /* total size of the rrd file */ + size_t pos; /* current pos in file */ + void *pvt; } rrd_file_t; +/* information used for the conventional file access methods */ + typedef struct rrd_simple_file_t { + int fd; /* file descriptor of this rrd file */ +#ifdef HAVE_MMAP + char *file_start; /* start address of an open rrd file */ + int mm_prot; + int mm_flags; +#endif + } rrd_simple_file_t; + /* rrd info interface */ typedef struct rrd_blob_t { unsigned long size; /* size of the blob */ @@ -114,6 +130,10 @@ extern "C" { struct rrd_info_t *next; } rrd_info_t; + typedef size_t (* rrd_output_callback_t)( + const void *, + size_t, + void *); /* main function blocks */ int rrd_create( @@ -128,7 +148,7 @@ extern "C" { rrd_info_type_t, rrd_infoval_t); void rrd_info_print( - rrd_info_t *data); + rrd_info_t * data); void rrd_info_free( rrd_info_t *); int rrd_update( @@ -171,13 +191,7 @@ extern "C" { time_t rrd_last( int, char **); - int rrd_lastupdate( - int argc, - char **argv, - time_t *last_update, - unsigned long *ds_cnt, - char ***ds_namv, - char ***last_ds); + int rrd_lastupdate(int argc, char **argv); time_t rrd_first( int, char **); @@ -198,6 +212,10 @@ extern "C" { unsigned long *, char ***, rrd_value_t **); + int rrd_flushcached (int argc, char **argv); + + void rrd_freemem( + void *mem); /* thread-safe (hopefully) */ int rrd_create_r( @@ -206,32 +224,50 @@ extern "C" { 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!!! */ + rrd_info_t *rrd_info_r( + char *); +/* NOTE: rrd_update_r and rrd_update_v_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( + int rrd_update_v_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); + const char *_template, + int argc, + const char **argv, + rrd_info_t * pcdp_summary); + 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_last_r (const char *filename); + int rrd_lastupdate_r (const char *filename, + time_t *ret_last_update, + unsigned long *ret_ds_count, + char ***ret_ds_names, + char ***ret_last_ds); time_t rrd_first_r( const char *filename, int rraindex); + int rrd_dump_cb_r( + const char *filename, + int opt_header, + rrd_output_callback_t cb, + void *user); + /* Transplanted from rrd_parsetime.h */ typedef enum { ABSOLUTE_TIME, @@ -249,7 +285,7 @@ extern "C" { char *rrd_parsetime( const char *spec, - rrd_time_value_t *ptv); + rrd_time_value_t * ptv); /* END rrd_parsetime.h */ typedef struct rrd_context { @@ -258,11 +294,14 @@ extern "C" { } rrd_context_t; /* returns the current per-thread rrd_context */ - rrd_context_t *rrd_get_context( - void); + rrd_context_t *rrd_get_context(void); +#ifdef WIN32 +/* this was added by the win32 porters Christof.Wegmann@exitgames.com */ + rrd_context_t *rrd_force_new_context(void); +#endif - int rrd_proc_start_end( +int rrd_proc_start_end( rrd_time_value_t *, rrd_time_value_t *, time_t *, @@ -289,13 +328,110 @@ extern "C" { rrd_context_t *rrd_new_context( void); void rrd_free_context( - rrd_context_t *buf); + rrd_context_t * buf); /* void rrd_set_error_r (rrd_context_t *, char *, ...); */ /* void rrd_clear_error_r(rrd_context_t *); */ /* int rrd_test_error_r (rrd_context_t *); */ /* char *rrd_get_error_r (rrd_context_t *); */ +/** UTILITY FUNCTIONS */ + + long rrd_random(void); + + int rrd_add_ptr_chunk(void ***dest, size_t *dest_size, void *src, + size_t *alloc, size_t chunk); + int rrd_add_ptr(void ***dest, size_t *dest_size, void *src); + int rrd_add_strdup(char ***dest, size_t *dest_size, char *src); + int rrd_add_strdup_chunk(char ***dest, size_t *dest_size, char *src, + size_t *alloc, size_t chunk); + void rrd_free_ptrs(void ***src, size_t *cnt); + + int rrd_mkdir_p(const char *pathname, mode_t mode); + +/* + * The following functions are _internal_ functions needed to read the raw RRD + * files. Since they are _internal_ they may change with the file format and + * will be replaced with a more general interface in RRDTool 1.4. Don't use + * these functions unless you have good reasons to do so. If you do use these + * functions you will have to adapt your code for RRDTool 1.4! + * + * To enable the deprecated functions define `RRD_EXPORT_DEPRECATED' before + * including . You have been warned! If you come back to the + * RRDTool mailing list and whine about your broken application, you will get + * hit with something smelly! + */ +#if defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) + +# if defined(_RRD_TOOL_H) +# include "rrd_format.h" +# else +# include +# endif + +#if defined(__GNUC__) && defined (RRD_EXPORT_DEPRECATED) +# define RRD_DEPRECATED __attribute__((deprecated)) +#else +# define RRD_DEPRECATED /**/ +#endif + void rrd_free( + rrd_t *rrd) + RRD_DEPRECATED; + void rrd_init( + rrd_t *rrd) + RRD_DEPRECATED; + + rrd_file_t *rrd_open( + const char *const file_name, + rrd_t *rrd, + unsigned rdwr) + RRD_DEPRECATED; + + void rrd_dontneed( + rrd_file_t *rrd_file, + rrd_t *rrd) + RRD_DEPRECATED; + int rrd_close( + rrd_file_t *rrd_file) + RRD_DEPRECATED; + ssize_t rrd_read( + rrd_file_t *rrd_file, + void *buf, + size_t count) + RRD_DEPRECATED; + ssize_t rrd_write( + rrd_file_t *rrd_file, + const void *buf, + size_t count) + RRD_DEPRECATED; + void rrd_flush( + rrd_file_t *rrd_file) + RRD_DEPRECATED; + off_t rrd_seek( + rrd_file_t *rrd_file, + off_t off, + int whence) + RRD_DEPRECATED; + off_t rrd_tell( + rrd_file_t *rrd_file) + RRD_DEPRECATED; + int rrd_lock( + rrd_file_t *file) + RRD_DEPRECATED; + void rrd_notify_row( + rrd_file_t *rrd_file, + int rra_idx, + unsigned long rra_row, + time_t rra_time) + RRD_DEPRECATED; + unsigned long rrd_select_initial_row( + rrd_file_t *rrd_file, + int rra_idx, + rra_def_t *rra + ) + RRD_DEPRECATED; +#endif /* defined(_RRD_TOOL_H) || defined(RRD_EXPORT_DEPRECATED) */ + #endif /* _RRDLIB_H */ #ifdef __cplusplus