X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcommon.h;h=85db3adb35faf5981477b1dd90179f6aaffa9c6b;hb=a1ae4b5afaf3207a7070b85f802b41b32c0b9a20;hp=ce1ffe52d65568a3090711c79a46a1c8732ec6c4;hpb=79d36d9eb61ac09f253769feff144383b2b665c9;p=collectd.git

diff --git a/src/common.h b/src/common.h
index ce1ffe52..85db3adb 100644
--- 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,33 +24,51 @@
 #define COMMON_H
 
 #include "collectd.h"
+#include "plugin.h"
+
+#if HAVE_PWD_H
+# include <pwd.h>
+#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);
@@ -60,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);
@@ -100,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.
@@ -116,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);
@@ -140,8 +158,29 @@ 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);
+int strsubstitute (char *str, char c_from, char c_to);
+
+/*
+ * 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)
 
 int check_create_dir (const char *file_orig);
 
@@ -153,4 +192,49 @@ 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)
+
+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 */