Merge branch 'collectd-4.2' into collectd-4.3

[collectd.git] / src / common.h

diff --git a/src/common.h b/src/common.h
index 310aa8a..8e0d840 100644 (file)
--- a/src/common.h
+++ b/src/common.h
@@ -1,6 +1,6 @@
 /**
  * collectd - src/common.h
- * Copyright (C) 2005-2007  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 License as published by the
@@ -24,6 +24,11 @@
 #define COMMON_H
 
 #include "collectd.h"
+#include "plugin.h"
+
+#if HAVE_PWD_H
+# include <pwd.h>
+#endif
 
 #define sfree(ptr) \
        if((ptr) != NULL) { \
@@ -43,17 +48,17 @@ char *sstrerror (int errnum, char *buf, size_t buflen);
  *   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);
@@ -63,16 +68,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);
@@ -103,8 +108,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.
@@ -119,7 +124,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);
@@ -143,6 +148,8 @@ int strjoin (char *dst, size_t dst_len, char **fields, size_t fields_num, const
  */
 int escape_slashes (char *buf, int buf_len);
 
+int strsubstitute (char *str, char c_from, char c_to);
+
 /* FIXME: `timeval_sub_timespec' needs a description */
 int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret);
 
@@ -156,4 +163,40 @@ long long get_kstat_value (kstat_t *ksp, char *name);
 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_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)
 #endif /* COMMON_H */