1 /**
2 * collectd - src/common.h
3 * Copyright (C) 2005-2008 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
18 * Authors:
19 * Florian octo Forster <octo at verplant.org>
20 * Niki W. Waibel <niki.waibel@gmx.net>
21 **/
23 #ifndef COMMON_H
24 #define COMMON_H
26 #include "collectd.h"
27 #include "plugin.h"
29 #if HAVE_PWD_H
30 # include <pwd.h>
31 #endif
33 #define sfree(ptr) \
34 do { \
35 if((ptr) != NULL) { \
36 free(ptr); \
37 } \
38 (ptr) = NULL; \
39 } while (0)
41 #define STATIC_ARRAY_SIZE(a) (sizeof (a) / sizeof (*(a)))
43 #define IS_TRUE(s) ((strcasecmp ("true", (s)) == 0) \
44 || (strcasecmp ("yes", (s)) == 0) \
45 || (strcasecmp ("on", (s)) == 0))
46 #define IS_FALSE(s) ((strcasecmp ("false", (s)) == 0) \
47 || (strcasecmp ("no", (s)) == 0) \
48 || (strcasecmp ("off", (s)) == 0))
50 char *sstrncpy (char *dest, const char *src, size_t n);
51 int ssnprintf (char *dest, size_t n, const char *format, ...);
52 char *sstrdup(const char *s);
53 void *smalloc(size_t size);
54 char *sstrerror (int errnum, char *buf, size_t buflen);
56 /*
57 * NAME
58 * sread
59 *
60 * DESCRIPTION
61 * Reads exactly `n' bytes or fails. Syntax and other behavior is analogous
62 * to `read(2)'. If EOF is received the file descriptor is closed and an
63 * error is returned.
64 *
65 * PARAMETERS
66 * `fd' File descriptor to write to.
67 * `buf' Buffer that is to be written.
68 * `count' Number of bytes in the buffer.
69 *
70 * RETURN VALUE
71 * Zero upon success or non-zero if an error occurred. `errno' is set in this
72 * case.
73 */
74 ssize_t sread (int fd, void *buf, size_t count);
76 /*
77 * NAME
78 * swrite
79 *
80 * DESCRIPTION
81 * Writes exactly `n' bytes or fails. Syntax and other behavior is analogous
82 * to `write(2)'.
83 *
84 * PARAMETERS
85 * `fd' File descriptor to write to.
86 * `buf' Buffer that is to be written.
87 * `count' Number of bytes in the buffer.
88 *
89 * RETURN VALUE
90 * Zero upon success or non-zero if an error occurred. `errno' is set in this
91 * case.
92 */
93 ssize_t swrite (int fd, const void *buf, size_t count);
95 /*
96 * NAME
97 * strsplit
98 *
99 * DESCRIPTION
100 * Splits a string into parts and stores pointers to the parts in `fields'.
101 * The characters split at are ` ' (space) and "\t" (tab).
102 *
103 * PARAMETERS
104 * `string' String to split. This string will be modified. `fields' will
105 * contain pointers to parts of this string, so free'ing it
106 * will destroy `fields' as well.
107 * `fields' Array of strings where pointers to the parts will be stored.
108 * `size' Number of elements in the array. No more than `size'
109 * pointers will be stored in `fields'.
110 *
111 * RETURN VALUE
112 * Returns the number of parts stored in `fields'.
113 */
114 int strsplit (char *string, char **fields, size_t size);
116 /*
117 * NAME
118 * strjoin
119 *
120 * DESCRIPTION
121 * Joins together several parts of a string using `sep' as a separator. This
122 * is equivalent to the Perl built-in `join'.
123 *
124 * PARAMETERS
125 * `dst' Buffer where the result is stored.
126 * `dst_len' Length of the destination buffer. No more than this many
127 * bytes will be written to the memory pointed to by `dst',
128 * including the trailing null-byte.
129 * `fields' Array of strings to be joined.
130 * `fields_num' Number of elements in the `fields' array.
131 * `sep' String to be inserted between any two elements of `fields'.
132 * This string is neither prepended nor appended to the result.
133 * Instead of passing "" (empty string) one can pass NULL.
134 *
135 * RETURN VALUE
136 * Returns the number of characters in `dst', NOT including the trailing
137 * null-byte. If an error occurred (empty array or `dst' too small) a value
138 * smaller than zero will be returned.
139 */
140 int strjoin (char *dst, size_t dst_len, char **fields, size_t fields_num, const char *sep);
142 /*
143 * NAME
144 * escape_slashes
145 *
146 * DESCRIPTION
147 * Removes slashes from the string `buf' and substitutes them with something
148 * appropriate. This function should be used whenever a path is to be used as
149 * (part of) an instance.
150 *
151 * PARAMETERS
152 * `buf' String to be escaped.
153 * `buf_len' Length of the buffer. No more then this many bytes will be
154 * written to `buf', including the trailing null-byte.
155 *
156 * RETURN VALUE
157 * Returns zero upon success and a value smaller than zero upon failure.
158 */
159 int escape_slashes (char *buf, int buf_len);
161 int strsubstitute (char *str, char c_from, char c_to);
163 /*
164 * NAME
165 * timeval_cmp
166 *
167 * DESCRIPTION
168 * Compare the two time values `tv0' and `tv1' and store the absolut value
169 * of the difference in the time value pointed to by `delta' if it does not
170 * equal NULL.
171 *
172 * RETURN VALUE
173 * Returns an integer less than, equal to, or greater than zero if `tv0' is
174 * less than, equal to, or greater than `tv1' respectively.
175 */
176 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta);
178 /* make sure tv_usec stores less than a second */
179 #define NORMALIZE_TIMEVAL(tv) \
180 do { \
181 (tv).tv_sec += (tv).tv_usec / 1000000; \
182 (tv).tv_usec = (tv).tv_usec % 1000000; \
183 } while (0)
185 int check_create_dir (const char *file_orig);
187 #ifdef HAVE_LIBKSTAT
188 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name);
189 long long get_kstat_value (kstat_t *ksp, char *name);
190 #endif
192 unsigned long long ntohll (unsigned long long n);
193 unsigned long long htonll (unsigned long long n);
195 #if FP_LAYOUT_NEED_NOTHING
196 # define ntohd(d) (d)
197 # define htond(d) (d)
198 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
199 double ntohd (double d);
200 double htond (double d);
201 #else
202 # error "Don't know how to convert between host and network representation of doubles."
203 #endif
205 int format_name (char *ret, int ret_len,
206 const char *hostname,
207 const char *plugin, const char *plugin_instance,
208 const char *type, const char *type_instance);
209 #define FORMAT_VL(ret, ret_len, vl, ds) \
210 format_name (ret, ret_len, (vl)->host, (vl)->plugin, (vl)->plugin_instance, \
211 (ds)->type, (vl)->type_instance)
213 int parse_identifier (char *str, char **ret_host,
214 char **ret_plugin, char **ret_plugin_instance,
215 char **ret_type, char **ret_type_instance);
216 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds);
218 #if !HAVE_GETPWNAM_R
219 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
220 size_t buflen, struct passwd **pwbufp);
221 #endif
223 int notification_init (notification_t *n, int severity, const char *message,
224 const char *host,
225 const char *plugin, const char *plugin_instance,
226 const char *type, const char *type_instance);
227 #define NOTIFICATION_INIT_VL(n, vl, ds) \
228 notification_init (n, NOTIF_FAILURE, NULL, \
229 (vl)->host, (vl)->plugin, (vl)->plugin_instance, \
230 (ds)->type, (vl)->type_instance)
232 typedef int (*dirwalk_callback_f)(const char *dirname, const char *filename,
233 void *user_data);
234 int walk_directory (const char *dir, dirwalk_callback_f callback,
235 void *user_data);
236 int read_file_contents (const char *filename, char *buf, int bufsize);
238 counter_t counter_diff (counter_t old_value, counter_t new_value);
240 #endif /* COMMON_H */