Code

Merge branch 'collectd-5.4' into collectd-5.5
[collectd.git] / src / daemon / common.h
1 /**
2  * collectd - src/common.h
3  * Copyright (C) 2005-2014  Florian octo Forster
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  *   Florian octo Forster <octo at collectd.org>
25  *   Niki W. Waibel <niki.waibel@gmx.net>
26 **/
28 #ifndef COMMON_H
29 #define COMMON_H
31 #include "collectd.h"
32 #include "plugin.h"
34 #if HAVE_PWD_H
35 # include <pwd.h>
36 #endif
38 #define sfree(ptr) \
39         do { \
40                 if((ptr) != NULL) { \
41                         free(ptr); \
42                 } \
43                 (ptr) = NULL; \
44         } while (0)
46 #define STATIC_ARRAY_SIZE(a) (sizeof (a) / sizeof (*(a)))
48 #define IS_TRUE(s) ((strcasecmp ("true", (s)) == 0) \
49                 || (strcasecmp ("yes", (s)) == 0) \
50                 || (strcasecmp ("on", (s)) == 0))
51 #define IS_FALSE(s) ((strcasecmp ("false", (s)) == 0) \
52                 || (strcasecmp ("no", (s)) == 0) \
53                 || (strcasecmp ("off", (s)) == 0))
55 struct rate_to_value_state_s
56 {
57   value_t last_value;
58   cdtime_t last_time;
59   gauge_t residual;
60 };
61 typedef struct rate_to_value_state_s rate_to_value_state_t;
63 struct value_to_rate_state_s
64 {
65   value_t last_value;
66   cdtime_t last_time;
67 };
68 typedef struct value_to_rate_state_s value_to_rate_state_t;
70 char *sstrncpy (char *dest, const char *src, size_t n);
72 __attribute__ ((format(printf,3,4)))
73 int ssnprintf (char *dest, size_t n, const char *format, ...);
75 __attribute__ ((format(printf,1,2)))
76 char *ssnprintf_alloc (char const *format, ...);
78 char *sstrdup(const char *s);
79 void *smalloc(size_t size);
80 char *sstrerror (int errnum, char *buf, size_t buflen);
82 /*
83  * NAME
84  *   sread
85  *
86  * DESCRIPTION
87  *   Reads exactly `n' bytes or fails. Syntax and other behavior is analogous
88  *   to `read(2)'. If EOF is received the file descriptor is closed and an
89  *   error is returned.
90  *
91  * PARAMETERS
92  *   `fd'          File descriptor to write to.
93  *   `buf'         Buffer that is to be written.
94  *   `count'       Number of bytes in the buffer.
95  *
96  * RETURN VALUE
97  *   Zero upon success or non-zero if an error occurred. `errno' is set in this
98  *   case.
99  */
100 ssize_t sread (int fd, void *buf, size_t count);
102 /*
103  * NAME
104  *   swrite
105  *
106  * DESCRIPTION
107  *   Writes exactly `n' bytes or fails. Syntax and other behavior is analogous
108  *   to `write(2)'.
109  *
110  * PARAMETERS
111  *   `fd'          File descriptor to write to.
112  *   `buf'         Buffer that is to be written.
113  *   `count'       Number of bytes in the buffer.
114  *
115  * RETURN VALUE
116  *   Zero upon success or non-zero if an error occurred. `errno' is set in this
117  *   case.
118  */
119 ssize_t swrite (int fd, const void *buf, size_t count);
121 /*
122  * NAME
123  *   strsplit
124  *
125  * DESCRIPTION
126  *   Splits a string into parts and stores pointers to the parts in `fields'.
127  *   The characters split at are: " ", "\t", "\r", and "\n".
128  *
129  * PARAMETERS
130  *   `string'      String to split. This string will be modified. `fields' will
131  *                 contain pointers to parts of this string, so free'ing it
132  *                 will destroy `fields' as well.
133  *   `fields'      Array of strings where pointers to the parts will be stored.
134  *   `size'        Number of elements in the array. No more than `size'
135  *                 pointers will be stored in `fields'.
136  *
137  * RETURN VALUE
138  *    Returns the number of parts stored in `fields'.
139  */
140 int strsplit (char *string, char **fields, size_t size);
142 /*
143  * NAME
144  *   strjoin
145  *
146  * DESCRIPTION
147  *   Joins together several parts of a string using `sep' as a separator. This
148  *   is equivalent to the Perl built-in `join'.
149  *
150  * PARAMETERS
151  *   `dst'         Buffer where the result is stored.
152  *   `dst_len'     Length of the destination buffer. No more than this many
153  *                 bytes will be written to the memory pointed to by `dst',
154  *                 including the trailing null-byte.
155  *   `fields'      Array of strings to be joined.
156  *   `fields_num'  Number of elements in the `fields' array.
157  *   `sep'         String to be inserted between any two elements of `fields'.
158  *                 This string is neither prepended nor appended to the result.
159  *                 Instead of passing "" (empty string) one can pass NULL.
160  *
161  * RETURN VALUE
162  *   Returns the number of characters in `dst', NOT including the trailing
163  *   null-byte. If an error occurred (empty array or `dst' too small) a value
164  *   smaller than zero will be returned.
165  */
166 int strjoin (char *dst, size_t dst_len, char **fields, size_t fields_num, const char *sep);
168 /*
169  * NAME
170  *   escape_slashes
171  *
172  * DESCRIPTION
173  *   Removes slashes ("/") from "buffer". If buffer contains a single slash,
174  *   the result will be "root". Leading slashes are removed. All other slashes
175  *   are replaced with underscores ("_").
176  *   This function is used by plugin_dispatch_values() to escape all parts of
177  *   the identifier.
178  *
179  * PARAMETERS
180  *   `buffer'         String to be escaped.
181  *   `buffer_size'    Size of the buffer. No more then this many bytes will be
182  *                    written to `buffer', including the trailing null-byte.
183  *
184  * RETURN VALUE
185  *   Returns zero upon success and a value smaller than zero upon failure.
186  */
187 int escape_slashes (char *buffer, size_t buffer_size);
189 /**
190  * NAME
191  *   escape_string
192  *
193  * DESCRIPTION
194  *   escape_string quotes and escapes a string to be usable with collectd's
195  *   plain text protocol. "simple" strings are left as they are, for example if
196  *   buffer is 'simple' before the call, it will remain 'simple'. However, if
197  *   buffer contains 'more "complex"' before the call, the returned buffer will
198  *   contain '"more \"complex\""'.
199  *
200  *   If the buffer is too small to contain the escaped string, the string will
201  *   be truncated. However, leading and trailing double quotes, as well as an
202  *   ending null byte are guaranteed.
203  *
204  * RETURN VALUE
205  *   Returns zero on success, even if the string was truncated. Non-zero on
206  *   failure.
207  */
208 int escape_string (char *buffer, size_t buffer_size);
210 /*
211  * NAME
212  *   replace_special
213  *
214  * DESCRIPTION
215  *   Replaces any special characters (anything that's not alpha-numeric or a
216  *   dash) with an underscore.
217  *
218  *   E.g. "foo$bar&" would become "foo_bar_".
219  *
220  * PARAMETERS
221  *   `buffer'      String to be handled.
222  *   `buffer_size' Length of the string. The function returns after
223  *                 encountering a null-byte or reading this many bytes.
224  */
225 void replace_special (char *buffer, size_t buffer_size);
227 int strsubstitute (char *str, char c_from, char c_to);
229 /*
230  * NAME
231  *   strunescape
232  *
233  * DESCRIPTION
234  *   Replaces any escaped characters in a string with the appropriate special
235  *   characters. The following escaped characters are recognized:
236  *
237  *     \t -> <tab>
238  *     \n -> <newline>
239  *     \r -> <carriage return>
240  *
241  *   For all other escacped characters only the backslash will be removed.
242  *
243  * PARAMETERS
244  *   `buf'         String to be unescaped.
245  *   `buf_len'     Length of the string, including the terminating null-byte.
246  *
247  * RETURN VALUE
248  *   Returns zero upon success, a value less than zero else.
249  */
250 int strunescape (char *buf, size_t buf_len);
252 /**
253  * Removed trailing newline characters (CR and LF) from buffer, which must be
254  * null terminated. Returns the length of the resulting string.
255  */
256 __attribute__((nonnull (1)))
257 size_t strstripnewline (char *buffer);
259 /*
260  * NAME
261  *   timeval_cmp
262  *
263  * DESCRIPTION
264  *   Compare the two time values `tv0' and `tv1' and store the absolut value
265  *   of the difference in the time value pointed to by `delta' if it does not
266  *   equal NULL.
267  *
268  * RETURN VALUE
269  *   Returns an integer less than, equal to, or greater than zero if `tv0' is
270  *   less than, equal to, or greater than `tv1' respectively.
271  */
272 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta);
274 /* make sure tv_usec stores less than a second */
275 #define NORMALIZE_TIMEVAL(tv) \
276         do { \
277                 (tv).tv_sec += (tv).tv_usec / 1000000; \
278                 (tv).tv_usec = (tv).tv_usec % 1000000; \
279         } while (0)
281 /* make sure tv_sec stores less than a second */
282 #define NORMALIZE_TIMESPEC(tv) \
283         do { \
284                 (tv).tv_sec += (tv).tv_nsec / 1000000000; \
285                 (tv).tv_nsec = (tv).tv_nsec % 1000000000; \
286         } while (0)
288 int check_create_dir (const char *file_orig);
290 #ifdef HAVE_LIBKSTAT
291 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name);
292 long long get_kstat_value (kstat_t *ksp, char *name);
293 #endif
295 #ifndef HAVE_HTONLL
296 unsigned long long ntohll (unsigned long long n);
297 unsigned long long htonll (unsigned long long n);
298 #endif
300 #if FP_LAYOUT_NEED_NOTHING
301 # define ntohd(d) (d)
302 # define htond(d) (d)
303 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
304 double ntohd (double d);
305 double htond (double d);
306 #else
307 # error "Don't know how to convert between host and network representation of doubles."
308 #endif
310 int format_name (char *ret, int ret_len,
311                 const char *hostname,
312                 const char *plugin, const char *plugin_instance,
313                 const char *type, const char *type_instance);
314 #define FORMAT_VL(ret, ret_len, vl) \
315         format_name (ret, ret_len, (vl)->host, (vl)->plugin, (vl)->plugin_instance, \
316                         (vl)->type, (vl)->type_instance)
317 int format_values (char *ret, size_t ret_len,
318                 const data_set_t *ds, const value_list_t *vl,
319                 _Bool store_rates);
321 int parse_identifier (char *str, char **ret_host,
322                 char **ret_plugin, char **ret_plugin_instance,
323                 char **ret_type, char **ret_type_instance);
324 int parse_identifier_vl (const char *str, value_list_t *vl);
325 int parse_value (const char *value, value_t *ret_value, int ds_type);
326 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds);
328 #if !HAVE_GETPWNAM_R
329 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
330                 size_t buflen, struct passwd **pwbufp);
331 #endif
333 int notification_init (notification_t *n, int severity, const char *message,
334                 const char *host,
335                 const char *plugin, const char *plugin_instance,
336                 const char *type, const char *type_instance);
337 #define NOTIFICATION_INIT_VL(n, vl) \
338         notification_init (n, NOTIF_FAILURE, NULL, \
339                         (vl)->host, (vl)->plugin, (vl)->plugin_instance, \
340                         (vl)->type, (vl)->type_instance)
342 typedef int (*dirwalk_callback_f)(const char *dirname, const char *filename,
343                 void *user_data);
344 int walk_directory (const char *dir, dirwalk_callback_f callback,
345                 void *user_data, int hidden);
346 /* Returns the number of bytes read or negative on error. */
347 ssize_t read_file_contents (char const *filename, char *buf, size_t bufsize);
349 counter_t counter_diff (counter_t old_value, counter_t new_value);
351 /* Convert a rate back to a value_t. When converting to a derive_t, counter_t
352  * or absoltue_t, take fractional residuals into account. This is important
353  * when scaling counters, for example.
354  * Returns zero on success. Returns EAGAIN when called for the first time; in
355  * this case the value_t is invalid and the next call should succeed. Other
356  * return values indicate an error. */
357 int rate_to_value (value_t *ret_value, gauge_t rate,
358                 rate_to_value_state_t *state, int ds_type, cdtime_t t);
360 int value_to_rate (value_t *ret_rate, derive_t value,
361                 value_to_rate_state_t *state, int ds_type, cdtime_t t);
363 /* Converts a service name (a string) to a port number
364  * (in the range [1-65535]). Returns less than zero on error. */
365 int service_name_to_port_number (const char *service_name);
367 /** Parse a string to a derive_t value. Returns zero on success or non-zero on
368  * failure. If failure is returned, ret_value is not touched. */
369 int strtoderive (const char *string, derive_t *ret_value);
371 /** Parse a string to a gauge_t value. Returns zero on success or non-zero on
372  * failure. If failure is returned, ret_value is not touched. */
373 int strtogauge (const char *string, gauge_t *ret_value);
375 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str);
376 void strarray_free (char **array, size_t array_len);
378 #endif /* COMMON_H */