X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcommon.h;h=d0cc4e829b59a2bf895248ac8bf7664b727e655e;hb=25ac639c505394e4ae9600ee62f5d5aeea97c6d4;hp=2be2ff504b84f58276bc3304ef5696c5623ec52d;hpb=fdf203eed0a91818db735105a4cc85effd7971d9;p=collectd.git diff --git a/src/common.h b/src/common.h index 2be2ff50..d0cc4e82 100644 --- a/src/common.h +++ b/src/common.h @@ -1,21 +1,19 @@ /** * collectd - src/common.h - * Copyright (C) 2005,2006 Florian octo Forster + * Copyright (C) 2005-2008 Florian octo Forster * - * This program is free software; you can redistribute it and/ - * or modify it under the terms of the GNU General Public Li- - * cence as published by the Free Software Foundation; either - * version 2 of the Licence, or any later version. + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; only version 2 of the License is applicable. * - * This program is distributed in the hope that it will be use- - * ful, but WITHOUT ANY WARRANTY; without even the implied war- - * ranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - * See the GNU General Public Licence for more details. + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. * - * You should have received a copy of the GNU General Public - * Licence along with this program; if not, write to the Free - * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, - * USA. + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * * Authors: * Florian octo Forster @@ -26,33 +24,51 @@ #define COMMON_H #include "collectd.h" +#include "plugin.h" + +#if HAVE_PWD_H +# include +#endif #define sfree(ptr) \ - if((ptr) != NULL) { \ - free(ptr); \ - } \ - (ptr) = NULL + do { \ + if((ptr) != NULL) { \ + free(ptr); \ + } \ + (ptr) = NULL; \ + } while (0) + +#define STATIC_ARRAY_SIZE(a) (sizeof (a) / sizeof (*(a))) -void sstrncpy(char *d, const char *s, int len); +#define IS_TRUE(s) ((strcasecmp ("true", (s)) == 0) \ + || (strcasecmp ("yes", (s)) == 0) \ + || (strcasecmp ("on", (s)) == 0)) +#define IS_FALSE(s) ((strcasecmp ("false", (s)) == 0) \ + || (strcasecmp ("no", (s)) == 0) \ + || (strcasecmp ("off", (s)) == 0)) + +char *sstrncpy (char *dest, const char *src, size_t n); +int ssnprintf (char *dest, size_t n, const char *format, ...); char *sstrdup(const char *s); void *smalloc(size_t size); +char *sstrerror (int errnum, char *buf, size_t buflen); /* * NAME * sread * * DESCRIPTION - * Reads exactly `n' bytes or failes. Syntax and other behavior is analogous + * Reads exactly `n' bytes or fails. Syntax and other behavior is analogous * to `read(2)'. If EOF is received the file descriptor is closed and an * error is returned. * * PARAMETERS * `fd' File descriptor to write to. * `buf' Buffer that is to be written. - * `count' Numver of bytes in the buffer. + * `count' Number of bytes in the buffer. * * RETURN VALUE - * Zero upon success or non-zero if an error occured. `errno' is set in this + * Zero upon success or non-zero if an error occurred. `errno' is set in this * case. */ ssize_t sread (int fd, void *buf, size_t count); @@ -62,16 +78,16 @@ ssize_t sread (int fd, void *buf, size_t count); * swrite * * DESCRIPTION - * Writes exactly `n' bytes or failes. Syntax and other behavior is analogous + * Writes exactly `n' bytes or fails. Syntax and other behavior is analogous * to `write(2)'. * * PARAMETERS * `fd' File descriptor to write to. * `buf' Buffer that is to be written. - * `count' Numver of bytes in the buffer. + * `count' Number of bytes in the buffer. * * RETURN VALUE - * Zero upon success or non-zero if an error occured. `errno' is set in this + * Zero upon success or non-zero if an error occurred. `errno' is set in this * case. */ ssize_t swrite (int fd, const void *buf, size_t count); @@ -82,7 +98,7 @@ ssize_t swrite (int fd, const void *buf, size_t count); * * DESCRIPTION * Splits a string into parts and stores pointers to the parts in `fields'. - * The characters split at are ` ' (space) and "\t" (tab). + * The characters split at are: " ", "\t", "\r", and "\n". * * PARAMETERS * `string' String to split. This string will be modified. `fields' will @@ -102,8 +118,8 @@ int strsplit (char *string, char **fields, size_t size); * strjoin * * DESCRIPTION - * Joins together several parts of a string using `sep' as a seperator. This - * is equipollent to the perl buildin `join'. + * Joins together several parts of a string using `sep' as a separator. This + * is equivalent to the Perl built-in `join'. * * PARAMETERS * `dst' Buffer where the result is stored. @@ -118,7 +134,7 @@ int strsplit (char *string, char **fields, size_t size); * * RETURN VALUE * Returns the number of characters in `dst', NOT including the trailing - * null-byte. If an error occured (empty array or `dst' too small) a value + * null-byte. If an error occurred (empty array or `dst' too small) a value * smaller than zero will be returned. */ int strjoin (char *dst, size_t dst_len, char **fields, size_t fields_num, const char *sep); @@ -142,15 +158,131 @@ int strjoin (char *dst, size_t dst_len, char **fields, size_t fields_num, const */ int escape_slashes (char *buf, int buf_len); -/* FIXME: `timeval_sub_timespec' needs a description */ -int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret); +/* + * NAME + * replace_special + * + * DESCRIPTION + * Replaces any special characters (anything that's not alpha-numeric or a + * dash) with an underscore. + * + * E.g. "foo$bar&" would become "foo_bar_". + * + * PARAMETERS + * `buffer' String to be handled. + * `buffer_size' Length of the string. The function returns after + * encountering a null-byte or reading this many bytes. + */ +void replace_special (char *buffer, size_t buffer_size); -int rrd_update_file (char *host, char *file, char *values, - char **ds_def, int ds_num); +int strsubstitute (char *str, char c_from, char c_to); + +/* + * NAME + * strunescape + * + * DESCRIPTION + * Replaces any escaped characters in a string with the appropriate special + * characters. The following escaped characters are recognized: + * + * \t -> + * \n -> + * \r -> + * + * For all other escacped characters only the backslash will be removed. + * + * PARAMETERS + * `buf' String to be unescaped. + * `buf_len' Length of the string, including the terminating null-byte. + * + * RETURN VALUE + * Returns zero upon success, a value less than zero else. + */ +int strunescape (char *buf, size_t buf_len); + +/* + * NAME + * timeval_cmp + * + * DESCRIPTION + * Compare the two time values `tv0' and `tv1' and store the absolut value + * of the difference in the time value pointed to by `delta' if it does not + * equal NULL. + * + * RETURN VALUE + * Returns an integer less than, equal to, or greater than zero if `tv0' is + * less than, equal to, or greater than `tv1' respectively. + */ +int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta); + +/* make sure tv_usec stores less than a second */ +#define NORMALIZE_TIMEVAL(tv) \ + do { \ + (tv).tv_sec += (tv).tv_usec / 1000000; \ + (tv).tv_usec = (tv).tv_usec % 1000000; \ + } while (0) + +/* make sure tv_sec stores less than a second */ +#define NORMALIZE_TIMESPEC(tv) \ + do { \ + (tv).tv_sec += (tv).tv_nsec / 1000000000; \ + (tv).tv_nsec = (tv).tv_nsec % 1000000000; \ + } while (0) + +int check_create_dir (const char *file_orig); #ifdef HAVE_LIBKSTAT int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name); long long get_kstat_value (kstat_t *ksp, char *name); #endif +unsigned long long ntohll (unsigned long long n); +unsigned long long htonll (unsigned long long n); + +#if FP_LAYOUT_NEED_NOTHING +# define ntohd(d) (d) +# define htond(d) (d) +#elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP +double ntohd (double d); +double htond (double d); +#else +# error "Don't know how to convert between host and network representation of doubles." +#endif + +int format_name (char *ret, int ret_len, + const char *hostname, + const char *plugin, const char *plugin_instance, + const char *type, const char *type_instance); +#define FORMAT_VL(ret, ret_len, vl, ds) \ + format_name (ret, ret_len, (vl)->host, (vl)->plugin, (vl)->plugin_instance, \ + (ds)->type, (vl)->type_instance) + +int parse_identifier (char *str, char **ret_host, + char **ret_plugin, char **ret_plugin_instance, + char **ret_type, char **ret_type_instance); +int parse_value (const char *value, value_t *ret_value, const data_source_t ds); +int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds); + +#if !HAVE_GETPWNAM_R +int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf, + size_t buflen, struct passwd **pwbufp); +#endif + +int notification_init (notification_t *n, int severity, const char *message, + const char *host, + const char *plugin, const char *plugin_instance, + const char *type, const char *type_instance); +#define NOTIFICATION_INIT_VL(n, vl, ds) \ + notification_init (n, NOTIF_FAILURE, NULL, \ + (vl)->host, (vl)->plugin, (vl)->plugin_instance, \ + (ds)->type, (vl)->type_instance) + +typedef int (*dirwalk_callback_f)(const char *dirname, const char *filename, + void *user_data); +int walk_directory (const char *dir, dirwalk_callback_f callback, + void *user_data); +int read_file_contents (const char *filename, char *buf, int bufsize); + +counter_t counter_diff (counter_t old_value, counter_t new_value); + #endif /* COMMON_H */