X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Frrd.h;h=a458b57cd0bef1b632d0008184bf3bb1501ae209;hb=abf9fa5d6a65566a6d3d6e05d3ab285f12b32123;hp=9c5fac6c8c874e4079236fe436bdb2cb2aa7bc39;hpb=5a7eb5b62b485b61ddb80a40ef22f4337cf2289f;p=rrdtool.git diff --git a/src/rrd.h b/src/rrd.h index 9c5fac6..a458b57 100644 --- a/src/rrd.h +++ b/src/rrd.h @@ -1,5 +1,5 @@ /***************************************************************************** - * RRDtool 1.2.5 Copyright by Tobi Oetiker, 1997-2005 + * RRDtool 1.3rc9 Copyright by Tobi Oetiker, 1997-2008 ***************************************************************************** * rrdlib.h Public header file for librrd ***************************************************************************** @@ -46,96 +46,260 @@ * *****************************************************************************/ #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 */ +#include /* for FILE */ + + +/* Formerly rrd_nan_inf.h */ +#ifndef DNAN +# define DNAN rrd_set_to_DNAN() +#endif + +#ifndef DINF +# define DINF rrd_set_to_DINF() +#endif + double rrd_set_to_DNAN( + void); + double rrd_set_to_DINF( + void); +/* end of rrd_nan_inf.h */ /* 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; + +/* rrd info interface */ + typedef struct rrd_blob_t { + unsigned long size; /* size of the blob */ + unsigned char *ptr; /* pointer */ + } rrd_blob_t; + + typedef enum rrd_info_type { RD_I_VAL = 0, + RD_I_CNT, + RD_I_STR, + RD_I_INT, + RD_I_BLO + } rrd_info_type_t; + + typedef union rrd_infoval { + unsigned long u_cnt; + rrd_value_t u_val; + char *u_str; + int u_int; + rrd_blob_t u_blo; + } rrd_infoval_t; + + typedef struct rrd_info_t { + char *key; + rrd_info_type_t type; + rrd_infoval_t value; + struct rrd_info_t *next; + } rrd_info_t; + + /* main function blocks */ -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 **); -int rrd_xport(int, char **, int *, time_t *, time_t *, - unsigned long *, unsigned long *, - char ***, rrd_value_t **); + int rrd_create( + int, + char **); + rrd_info_t *rrd_info( + int, + char **); + rrd_info_t *rrd_info_push( + rrd_info_t *, + char *, + rrd_info_type_t, + rrd_infoval_t); + void rrd_info_print( + rrd_info_t * data); + void rrd_info_free( + rrd_info_t *); + int rrd_update( + int, + char **); + rrd_info_t *rrd_update_v( + int, + char **); + int rrd_graph( + int, + char **, + char ***, + int *, + int *, + FILE *, + double *, + double *); + rrd_info_t *rrd_graph_v( + int, + char **); + + 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_lastupdate( + int argc, + char **argv, + time_t *last_update, + unsigned long *ds_cnt, + char ***ds_namv, + char ***last_ds); + 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 **); + + void rrd_freemem( + void *mem); /* thread-safe (hopefully) */ -int rrd_create_r(char *filename, - unsigned long pdp_step, time_t last_up, - int argc, char **argv); + 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(char *filename, char *_template, - int argc, char **argv); -int rrd_dump_r(char *filename); -time_t rrd_last_r(const char *filename); -time_t rrd_first_r(const char *filename, int rraindex); - -/* Transplanted from parsetime.h */ -typedef enum { + + 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 rrd_parsetime.h */ + typedef enum { ABSOLUTE_TIME, - RELATIVE_TO_START_TIME, + RELATIVE_TO_START_TIME, RELATIVE_TO_END_TIME -} timetype; + } rrd_timetype_t; #define TIME_OK NULL -struct rrd_time_value { - timetype type; - long offset; - struct tm tm; -}; + typedef struct rrd_time_value { + rrd_timetype_t type; + long offset; + struct tm tm; + } rrd_time_value_t; + + char *rrd_parsetime( + const char *spec, + rrd_time_value_t * ptv); +/* END rrd_parsetime.h */ -struct rrd_context { - int len; - int errlen; - char *lib_errstr; - char *rrd_error; -}; + typedef struct rrd_context { + char lib_errstr[256]; + char rrd_error[4096]; + } rrd_context_t; /* returns the current per-thread rrd_context */ -struct rrd_context *rrd_get_context(void); + rrd_context_t *rrd_get_context( + void); -char *parsetime(const char *spec, struct rrd_time_value *ptv); -/* END parsetime.h */ -int proc_start_end (struct rrd_time_value *, struct rrd_time_value *, time_t *, time_t *); + int rrd_proc_start_end( + rrd_time_value_t *, + rrd_time_value_t *, + 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); + 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); + /* rrd_strerror is thread safe, but still it uses a global buffer + (but one per thread), thus subsequent calls within a single + thread overwrite the same buffer */ + const char *rrd_strerror( + int err); -/* 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 *); */ +/** MULTITHREADED HELPER FUNCTIONS */ + rrd_context_t *rrd_new_context( + void); + void rrd_free_context( + rrd_context_t * buf); -int LockRRD(FILE *); +/* 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 *); */ -#endif /* _RRDLIB_H */ +#endif /* _RRDLIB_H */ #ifdef __cplusplus }