X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Femail.c;h=377a6b1ea6a5c6faac4fb3462b60fe6f8731e95c;hb=3c27e2490525efba4a4864faa8493f0ae53e68db;hp=5f612cd7eab121c92eb5a1b4cb883959788e1f5b;hpb=bd119c69bf481afbda804cdd422e9ba8e855bccf;p=collectd.git diff --git a/src/email.c b/src/email.c index 5f612cd7..377a6b1e 100644 --- a/src/email.c +++ b/src/email.c @@ -38,7 +38,14 @@ #include "common.h" #include "plugin.h" -#include +#include "configfile.h" + +#if HAVE_LIBPTHREAD +# include +# define EMAIL_HAVE_READ 1 +#else +# define EMAIL_HAVE_READ 0 +#endif #if HAVE_SYS_SELECT_H # include @@ -55,14 +62,32 @@ # include #endif /* HAVE_LINUX_UN_H | HAVE_SYS_UN_H */ +/* some systems (e.g. Darwin) seem to not define UNIX_PATH_MAX at all */ +#ifndef UNIX_PATH_MAX +# define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path) +#endif /* UNIX_PATH_MAX */ + +#if HAVE_GRP_H +# include +#endif /* HAVE_GRP_H */ + #define MODULE_NAME "email" /* 256 bytes ought to be enough for anybody ;-) */ #define BUFSIZE 256 -#define SOCK_PATH "/tmp/.collectd-email" +#ifndef COLLECTD_SOCKET_PREFIX +# define COLLECTD_SOCKET_PREFIX "/tmp/.collectd-" +#endif /* COLLECTD_SOCKET_PREFIX */ + +#define SOCK_PATH COLLECTD_SOCKET_PREFIX"email" #define MAX_CONNS 5 +#define MAX_CONNS_LIMIT 16384 +/* + * Private data structures + */ +#if EMAIL_HAVE_READ /* linked list of email and check types */ typedef struct type { char *name; @@ -75,41 +100,88 @@ typedef struct { type_t *tail; } type_list_t; -/* linked list of collector thread control information */ +/* collector thread control information */ typedef struct collector { pthread_t thread; + /* socket descriptor of the current/last connection */ + int socket; +} collector_t; + +/* linked list of pending connections */ +typedef struct conn { /* socket to read data from */ int socket; /* buffer to read data to */ - char buffer[BUFSIZE]; - int idx; /* current position in buffer */ + char *buffer; + int idx; /* current write position in buffer */ + int length; /* length of the current line, i.e. index of '\0' */ - struct collector *next; -} collector_t; + struct conn *next; +} conn_t; typedef struct { - collector_t *head; - collector_t *tail; -} collector_list_t; + conn_t *head; + conn_t *tail; +} conn_list_t; +#endif /* EMAIL_HAVE_READ */ + +/* + * Private variables + */ +#if EMAIL_HAVE_READ +/* valid configuration file keys */ +static char *config_keys[] = +{ + "SocketGroup", + "SocketPerms", + "MaxConns", + NULL +}; +static int config_keys_num = 3; + +/* socket configuration */ +static char *sock_group = COLLECTD_GRP_NAME; +static int sock_perms = S_IRWXU | S_IRWXG; +static int max_conns = MAX_CONNS; /* state of the plugin */ static int disabled = 0; /* thread managing "client" connections */ static pthread_t connector; +static int connector_socket; + +/* tell the collector threads that a new connection is available */ +static pthread_cond_t conn_available = PTHREAD_COND_INITIALIZER; + +/* connections that are waiting to be processed */ +static pthread_mutex_t conns_mutex = PTHREAD_MUTEX_INITIALIZER; +static conn_list_t conns; /* tell the connector thread that a collector is available */ static pthread_cond_t collector_available = PTHREAD_COND_INITIALIZER; -/* collector threads that are in use */ -static pthread_mutex_t active_mutex = PTHREAD_MUTEX_INITIALIZER; -static collector_list_t active; +/* collector threads */ +static collector_t **collectors; -/* collector threads that are available for use */ static pthread_mutex_t available_mutex = PTHREAD_MUTEX_INITIALIZER; -static collector_list_t available; +static int available_collectors; + +static pthread_mutex_t count_mutex = PTHREAD_MUTEX_INITIALIZER; +static type_list_t count; + +static pthread_mutex_t size_mutex = PTHREAD_MUTEX_INITIALIZER; +static type_list_t size; + +static pthread_mutex_t score_mutex = PTHREAD_MUTEX_INITIALIZER; +static double score; +static int score_count; + +static pthread_mutex_t check_mutex = PTHREAD_MUTEX_INITIALIZER; +static type_list_t check; +#endif /* EMAIL_HAVE_READ */ #define COUNT_FILE "email/email-%s.rrd" static char *count_ds_def[] = @@ -119,9 +191,6 @@ static char *count_ds_def[] = }; static int count_ds_num = 1; -static pthread_mutex_t count_mutex = PTHREAD_MUTEX_INITIALIZER; -static type_list_t count; - #define SIZE_FILE "email/email_size-%s.rrd" static char *size_ds_def[] = { @@ -130,9 +199,6 @@ static char *size_ds_def[] = }; static int size_ds_num = 1; -static pthread_mutex_t size_mutex = PTHREAD_MUTEX_INITIALIZER; -static type_list_t size; - #define SCORE_FILE "email/spam_score.rrd" static char *score_ds_def[] = { @@ -141,10 +207,6 @@ static char *score_ds_def[] = }; static int score_ds_num = 1; -static pthread_mutex_t score_mutex = PTHREAD_MUTEX_INITIALIZER; -static double score; -static int score_count; - #define CHECK_FILE "email/spam_check-%s.rrd" static char *check_ds_def[] = { @@ -153,8 +215,40 @@ static char *check_ds_def[] = }; static int check_ds_num = 1; -static pthread_mutex_t check_mutex = PTHREAD_MUTEX_INITIALIZER; -static type_list_t check; +#if EMAIL_HAVE_READ +static int email_config (char *key, char *value) +{ + if (0 == strcasecmp (key, "SocketGroup")) { + sock_group = sstrdup (value); + } + else if (0 == strcasecmp (key, "SocketPerms")) { + /* the user is responsible for providing reasonable values */ + sock_perms = (int)strtol (value, NULL, 8); + } + else if (0 == strcasecmp (key, "MaxConns")) { + long int tmp = strtol (value, NULL, 0); + + if (tmp < 1) { + fprintf (stderr, "email plugin: `MaxConns' was set to invalid " + "value %li, will use default %i.\n", + tmp, MAX_CONNS); + max_conns = MAX_CONNS; + } + else if (tmp > MAX_CONNS_LIMIT) { + fprintf (stderr, "email plugin: `MaxConns' was set to invalid " + "value %li, will use hardcoded limit %i.\n", + tmp, MAX_CONNS_LIMIT); + max_conns = MAX_CONNS_LIMIT; + } + else { + max_conns = (int)tmp; + } + } + else { + return -1; + } + return 0; +} /* static int email_config (char *, char *) */ /* Increment the value of the given name in the given list by incr. */ static void type_list_incr (type_list_t *list, char *name, int incr) @@ -193,7 +287,7 @@ static void type_list_incr (type_list_t *list, char *name, int incr) /* Read a single character from the socket. If an error occurs or end-of-file * is reached return '\0'. */ -char read_char (collector_t *src) +char read_char (conn_t *src) { char ret = '\0'; @@ -224,13 +318,12 @@ char read_char (collector_t *src) return '\0'; } while (EINTR == errno); return ret; -} /* char read_char (collector_t *) */ +} /* char read_char (conn_t *) */ /* Read a single line (terminated by '\n') from the the socket. * * The return value is zero terminated and does not contain any newline - * characters. In case that no complete line is available (non-blocking mode - * should be enabled) an empty string is returned. + * characters. * * If an error occurs or end-of-file is reached return NULL. * @@ -238,21 +331,27 @@ char read_char (collector_t *src) * characters of the input stream, the line will will be ignored! By * definition we should not get any longer input lines, thus this is * acceptable in this case ;-) */ -char *read_line (collector_t *src) +char *read_line (conn_t *src) { - int i = 0; - char *ret; + int i = 0; + + assert ((BUFSIZE >= src->idx) && (src->idx >= 0)); + assert ((src->idx > src->length) || (src->length == 0)); - assert (BUFSIZE > src->idx); + if (src->length > 0) { /* remove old line */ + src->idx -= (src->length + 1); + memmove (src->buffer, src->buffer + src->length + 1, src->idx); + src->length = 0; + } for (i = 0; i < src->idx; ++i) { if ('\n' == src->buffer[i]) break; } - if ('\n' != src->buffer[i]) { + if (i == src->idx) { fd_set fdset; - + ssize_t len = 0; FD_ZERO (&fdset); @@ -268,7 +367,7 @@ char *read_line (collector_t *src) do { errno = 0; if (0 > (len = read (src->socket, - (void *)(&(src->buffer[0]) + src->idx), + (void *)(src->buffer + src->idx), BUFSIZE - src->idx))) { if (EINTR != errno) { syslog (LOG_ERR, "read() failed: %s", strerror (errno)); @@ -287,10 +386,8 @@ char *read_line (collector_t *src) break; } - if ('\n' != src->buffer[i]) { - ret = (char *)smalloc (1); - - ret[0] = '\0'; + if (i == src->idx) { + src->length = 0; if (BUFSIZE == src->idx) { /* no space left in buffer */ while ('\n' != read_char (src)) @@ -298,165 +395,142 @@ char *read_line (collector_t *src) src->idx = 0; } - return ret; + return read_line (src); } } - ret = (char *)smalloc (i + 1); - memcpy (ret, &(src->buffer[0]), i + 1); - ret[i] = '\0'; + src->buffer[i] = '\0'; + src->length = i; - src->idx -= (i + 1); - - if (0 == src->idx) - src->buffer[0] = '\0'; - else - memmove (&(src->buffer[0]), &(src->buffer[i + 1]), src->idx); - return ret; -} /* char *read_line (collector_t *) */ + return src->buffer; +} /* char *read_line (conn_t *) */ static void *collect (void *arg) { collector_t *this = (collector_t *)arg; - - int loop = 1; - { /* put the socket in non-blocking mode */ - int flags = 0; + char *buffer = (char *)smalloc (BUFSIZE); - errno = 0; - if (-1 == fcntl (this->socket, F_GETFL, &flags)) { - syslog (LOG_ERR, "fcntl() failed: %s", strerror (errno)); - loop = 0; - } + while (1) { + int loop = 1; - errno = 0; - if (-1 == fcntl (this->socket, F_SETFL, flags | O_NONBLOCK)) { - syslog (LOG_ERR, "fcntl() failed: %s", strerror (errno)); - loop = 0; - } - } + conn_t *connection; - while (loop) { - char *line = read_line (this); + pthread_mutex_lock (&conns_mutex); - if (NULL == line) { - loop = 0; - break; + while (NULL == conns.head) { + pthread_cond_wait (&conn_available, &conns_mutex); } - if ('\0' == line[0]) { - free (line); - continue; - } + connection = conns.head; + conns.head = conns.head->next; - if (':' != line[1]) { - syslog (LOG_ERR, "email: syntax error in line '%s'", line); - free (line); - continue; + if (NULL == conns.head) { + conns.tail = NULL; } - if ('e' == line[0]) { /* e:: */ - char *type = strtok (line + 2, ":"); - char *tmp = strtok (NULL, ":"); - int bytes = 0; + this->socket = connection->socket; - if (NULL == tmp) { - syslog (LOG_ERR, "email: syntax error in line '%s'", line); - free (line); - continue; - } + pthread_mutex_unlock (&conns_mutex); - bytes = atoi (tmp); + connection->buffer = buffer; + connection->idx = 0; + connection->length = 0; - pthread_mutex_lock (&count_mutex); - type_list_incr (&count, type, 1); - pthread_mutex_unlock (&count_mutex); + { /* put the socket in non-blocking mode */ + int flags = 0; - pthread_mutex_lock (&size_mutex); - type_list_incr (&size, type, bytes); - pthread_mutex_unlock (&size_mutex); - } - else if ('s' == line[0]) { /* s: */ - pthread_mutex_lock (&score_mutex); - score = (score * (double)score_count + atof (line + 2)) - / (double)(score_count + 1); - ++score_count; - pthread_mutex_unlock (&score_mutex); - } - else if ('c' == line[0]) { /* c:[,,...] */ - char *type = strtok (line + 2, ","); - - do { - pthread_mutex_lock (&check_mutex); - type_list_incr (&check, type, 1); - pthread_mutex_unlock (&check_mutex); - } while (NULL != (type = strtok (NULL, ","))); - } - else { - syslog (LOG_ERR, "email: unknown type '%c'", line[0]); + errno = 0; + if (-1 == fcntl (connection->socket, F_GETFL, &flags)) { + syslog (LOG_ERR, "fcntl() failed: %s", strerror (errno)); + loop = 0; + } + + errno = 0; + if (-1 == fcntl (connection->socket, F_SETFL, flags | O_NONBLOCK)) { + syslog (LOG_ERR, "fcntl() failed: %s", strerror (errno)); + loop = 0; + } } - free (line); - } + while (loop) { + char *line = read_line (connection); + + if (NULL == line) { + loop = 0; + break; + } - /* put this thread back into the available list */ - pthread_mutex_lock (&active_mutex); - { - collector_t *last; - collector_t *ptr; + if (':' != line[1]) { + syslog (LOG_ERR, "email: syntax error in line '%s'", line); + continue; + } - last = NULL; + if ('e' == line[0]) { /* e:: */ + char *ptr = NULL; + char *type = strtok_r (line + 2, ":", &ptr); + char *tmp = strtok_r (NULL, ":", &ptr); + int bytes = 0; - for (ptr = active.head; NULL != ptr; last = ptr, ptr = ptr->next) { - if (0 != pthread_equal (ptr->thread, this->thread)) - break; - } + if (NULL == tmp) { + syslog (LOG_ERR, "email: syntax error in line '%s'", line); + continue; + } - /* the current thread _has_ to be in the active list */ - assert (NULL != ptr); + bytes = atoi (tmp); - if (NULL == last) { - active.head = ptr->next; - } - else { - last->next = ptr->next; + pthread_mutex_lock (&count_mutex); + type_list_incr (&count, type, 1); + pthread_mutex_unlock (&count_mutex); - if (NULL == last->next) { - active.tail = last; + pthread_mutex_lock (&size_mutex); + type_list_incr (&size, type, bytes); + pthread_mutex_unlock (&size_mutex); } - } - } - pthread_mutex_unlock (&active_mutex); + else if ('s' == line[0]) { /* s: */ + pthread_mutex_lock (&score_mutex); + score = (score * (double)score_count + atof (line + 2)) + / (double)(score_count + 1); + ++score_count; + pthread_mutex_unlock (&score_mutex); + } + else if ('c' == line[0]) { /* c:[,,...] */ + char *ptr = NULL; + char *type = strtok_r (line + 2, ",", &ptr); + + do { + pthread_mutex_lock (&check_mutex); + type_list_incr (&check, type, 1); + pthread_mutex_unlock (&check_mutex); + } while (NULL != (type = strtok_r (NULL, ",", &ptr))); + } + else { + syslog (LOG_ERR, "email: unknown type '%c'", line[0]); + } + } /* while (loop) */ - this->next = NULL; + close (connection->socket); - pthread_mutex_lock (&available_mutex); + free (connection); - if (NULL == available.head) { - available.head = this; - available.tail = this; - } - else { - available.tail->next = this; - available.tail = this; - } + pthread_mutex_lock (&available_mutex); + ++available_collectors; + pthread_mutex_unlock (&available_mutex); - pthread_mutex_unlock (&available_mutex); + pthread_cond_signal (&collector_available); + } /* while (1) */ - pthread_cond_signal (&collector_available); + free (buffer); pthread_exit ((void *)0); } /* void *collect (void *) */ static void *open_connection (void *arg) { - int local = 0; - struct sockaddr_un addr; /* create UNIX socket */ errno = 0; - if (-1 == (local = socket (PF_UNIX, SOCK_STREAM, 0))) { + if (-1 == (connector_socket = socket (PF_UNIX, SOCK_STREAM, 0))) { disabled = 1; syslog (LOG_ERR, "socket() failed: %s", strerror (errno)); pthread_exit ((void *)1); @@ -469,7 +543,7 @@ static void *open_connection (void *arg) unlink (addr.sun_path); errno = 0; - if (-1 == bind (local, (struct sockaddr *)&addr, + if (-1 == bind (connector_socket, (struct sockaddr *)&addr, offsetof (struct sockaddr_un, sun_path) + strlen(addr.sun_path))) { disabled = 1; @@ -478,51 +552,84 @@ static void *open_connection (void *arg) } errno = 0; - if (-1 == listen (local, 5)) { + if (-1 == listen (connector_socket, 5)) { disabled = 1; syslog (LOG_ERR, "listen() failed: %s", strerror (errno)); pthread_exit ((void *)1); } - { /* initialize queue of available threads */ - int i = 0; + if ((uid_t)0 == geteuid ()) { + struct group *grp; - collector_t *last; + errno = 0; + if (NULL != (grp = getgrnam (sock_group))) { + errno = 0; + if (0 != chown (SOCK_PATH, (uid_t)-1, grp->gr_gid)) { + syslog (LOG_WARNING, "chown() failed: %s", strerror (errno)); + } + } + else { + syslog (LOG_WARNING, "getgrnam() failed: %s", strerror (errno)); + } + } + else { + syslog (LOG_WARNING, "not running as root"); + } - active.head = NULL; - active.tail = NULL; + errno = 0; + if (0 != chmod (SOCK_PATH, sock_perms)) { + syslog (LOG_WARNING, "chmod() failed: %s", strerror (errno)); + } - available.head = (collector_t *)smalloc (sizeof (collector_t)); - available.tail = available.head; - available.tail->next = NULL; + { /* initialize collector threads */ + int i = 0; + int err = 0; - last = available.head; + pthread_attr_t ptattr; + + conns.head = NULL; + conns.tail = NULL; + + pthread_attr_init (&ptattr); + pthread_attr_setdetachstate (&ptattr, PTHREAD_CREATE_DETACHED); - for (i = 1; i < MAX_CONNS; ++i) { - last->next = (collector_t *)smalloc (sizeof (collector_t)); - last = last->next; - available.tail = last; - available.tail->next = NULL; + available_collectors = max_conns; + + collectors = + (collector_t **)smalloc (max_conns * sizeof (collector_t *)); + + for (i = 0; i < max_conns; ++i) { + collectors[i] = (collector_t *)smalloc (sizeof (collector_t)); + collectors[i]->socket = 0; + + if (0 != (err = pthread_create (&collectors[i]->thread, &ptattr, + collect, collectors[i]))) { + syslog (LOG_ERR, "pthread_create() failed: %s", + strerror (err)); + } } + + pthread_attr_destroy (&ptattr); } while (1) { int remote = 0; - int err = 0; - - collector_t *collector; - pthread_attr_t ptattr; + conn_t *connection; pthread_mutex_lock (&available_mutex); - while (NULL == available.head) { + + while (0 == available_collectors) { pthread_cond_wait (&collector_available, &available_mutex); } + + --available_collectors; + pthread_mutex_unlock (&available_mutex); do { errno = 0; - if (-1 == (remote = accept (local, NULL, NULL))) { + if (-1 == (remote = accept (connector_socket, NULL, NULL))) { if (EINTR != errno) { disabled = 1; syslog (LOG_ERR, "accept() failed: %s", strerror (errno)); @@ -531,68 +638,33 @@ static void *open_connection (void *arg) } } while (EINTR == errno); - /* assign connection to next available thread */ - pthread_mutex_lock (&available_mutex); - - collector = available.head; - collector->socket = remote; + connection = (conn_t *)smalloc (sizeof (conn_t)); - if (available.head == available.tail) { - available.head = NULL; - available.tail = NULL; - } - else { - available.head = available.head->next; - } + connection->socket = remote; + connection->next = NULL; - pthread_mutex_unlock (&available_mutex); - - collector->idx = 0; - collector->next = NULL; - - pthread_attr_init (&ptattr); - pthread_attr_setdetachstate (&ptattr, PTHREAD_CREATE_DETACHED); - - if (0 == (err = pthread_create (&collector->thread, &ptattr, collect, - (void *)collector))) { - pthread_mutex_lock (&active_mutex); - - if (NULL == active.head) { - active.head = collector; - active.tail = collector; - } - else { - active.tail->next = collector; - active.tail = collector; - } + pthread_mutex_lock (&conns_mutex); - pthread_mutex_unlock (&active_mutex); + if (NULL == conns.head) { + conns.head = connection; + conns.tail = connection; } else { - pthread_mutex_lock (&available_mutex); - - if (NULL == available.head) { - available.head = collector; - available.tail = collector; - } - else { - available.tail->next = collector; - available.tail = collector; - } - - pthread_mutex_unlock (&available_mutex); - - close (remote); - syslog (LOG_ERR, "pthread_create() failed: %s", strerror (err)); + conns.tail->next = connection; + conns.tail = conns.tail->next; } - pthread_attr_destroy (&ptattr); + pthread_mutex_unlock (&conns_mutex); + + pthread_cond_signal (&conn_available); } pthread_exit ((void *)0); } /* void *open_connection (void *) */ +#endif /* EMAIL_HAVE_READ */ static void email_init (void) { +#if EMAIL_HAVE_READ int err = 0; if (0 != (err = pthread_create (&connector, NULL, @@ -601,9 +673,36 @@ static void email_init (void) syslog (LOG_ERR, "pthread_create() failed: %s", strerror (err)); return; } +#endif /* EMAIL_HAVE_READ */ return; } /* static void email_init (void) */ +#if EMAIL_HAVE_READ +static void email_shutdown (void) +{ + int i = 0; + + if (disabled) + return; + + close (connector_socket); + pthread_kill (connector, SIGTERM); + + /* don't allow any more connections to be processed */ + pthread_mutex_lock (&conns_mutex); + + for (i = 0; i < max_conns; ++i) { + close (collectors[i]->socket); + pthread_kill (collectors[i]->thread, SIGTERM); + } + + pthread_mutex_unlock (&conns_mutex); + + unlink (SOCK_PATH); + return; +} /* static void email_shutdown (void) */ +#endif /* EMAIL_HAVE_READ */ + static void count_write (char *host, char *inst, char *val) { char file[BUFSIZE] = ""; @@ -649,6 +748,7 @@ static void check_write (char *host, char *inst, char *val) return; } /* static void check_write (char *host, char *inst, char *val) */ +#if EMAIL_HAVE_READ static void type_submit (char *plugin, char *inst, int value) { char buf[BUFSIZE] = ""; @@ -724,6 +824,9 @@ static void email_read (void) pthread_mutex_unlock (&check_mutex); return; } /* static void read (void) */ +#else /* if !EMAIL_HAVE_READ */ +# define email_read NULL +#endif void module_register (void) { @@ -732,6 +835,10 @@ void module_register (void) plugin_register ("email_size", NULL, NULL, size_write); plugin_register ("email_spam_score", NULL, NULL, score_write); plugin_register ("email_spam_check", NULL, NULL, check_write); +#if EMAIL_HAVE_READ + plugin_register_shutdown (MODULE_NAME, email_shutdown); + cf_register (MODULE_NAME, email_config, config_keys, config_keys_num); +#endif /* EMAIL_HAVE_READ */ return; } /* void module_register (void) */