2 * collectd - src/unixsock.c
3 * Copyright (C) 2007 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
27 /* Folks without pthread will need to disable this plugin. */
30 #include <sys/socket.h>
37 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
40 #define US_DEFAULT_PATH PREFIX"/var/run/"PACKAGE_NAME"-unixsock"
43 * Private data structures
45 /* linked list of cached values */
46 typedef struct value_cache_s
48 char name[4*DATA_MAX_NAME_LEN];
54 struct value_cache_s *next;
60 /* valid configuration file keys */
61 static const char *config_keys[] =
68 static int config_keys_num = 3;
72 /* socket configuration */
73 static int sock_fd = -1;
74 static char *sock_file = NULL;
75 static char *sock_group = NULL;
76 static int sock_perms = S_IRWXU | S_IRWXG;
78 static pthread_t listen_thread = (pthread_t) 0;
80 /* Linked list and auxilliary variables for saving values */
81 static value_cache_t *cache_head = NULL;
82 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
83 static unsigned int cache_oldest = UINT_MAX;
88 static int parse_identifier (char *str, char **ret_host,
89 char **ret_plugin, char **ret_plugin_instance,
90 char **ret_type, char **ret_type_instance)
92 char *hostname = NULL;
94 char *plugin_instance = NULL;
96 char *type_instance = NULL;
102 plugin = strchr (hostname, '/');
105 *plugin = '\0'; plugin++;
107 type = strchr (plugin, '/');
110 *type = '\0'; type++;
112 plugin_instance = strchr (plugin, '-');
113 if (plugin_instance != NULL)
115 *plugin_instance = '\0';
119 type_instance = strchr (type, '-');
120 if (type_instance != NULL)
122 *type_instance = '\0';
126 *ret_host = hostname;
127 *ret_plugin = plugin;
128 *ret_plugin_instance = plugin_instance;
130 *ret_type_instance = type_instance;
132 } /* int parse_identifier */
134 static value_cache_t *cache_search (const char *name)
138 for (vc = cache_head; vc != NULL; vc = vc->next)
140 if (strcmp (vc->name, name) == 0)
142 } /* for vc = cache_head .. NULL */
145 } /* value_cache_t *cache_search */
147 static int cache_alloc_name (char *ret, int ret_len,
148 const char *hostname,
149 const char *plugin, const char *plugin_instance,
150 const char *type, const char *type_instance)
154 assert (plugin != NULL);
155 assert (type != NULL);
157 if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
159 if ((type_instance == NULL) || (strlen (type_instance) == 0))
160 status = snprintf (ret, ret_len, "%s/%s/%s",
161 hostname, plugin, type);
163 status = snprintf (ret, ret_len, "%s/%s/%s-%s",
164 hostname, plugin, type, type_instance);
168 if ((type_instance == NULL) || (strlen (type_instance) == 0))
169 status = snprintf (ret, ret_len, "%s/%s-%s/%s",
170 hostname, plugin, plugin_instance, type);
172 status = snprintf (ret, ret_len, "%s/%s-%s/%s-%s",
173 hostname, plugin, plugin_instance, type, type_instance);
176 if ((status < 1) || (status >= ret_len))
179 } /* int cache_alloc_name */
181 static int cache_insert (const data_set_t *ds, const value_list_t *vl)
183 /* We're called from `cache_update' so we don't need to lock the mutex */
187 DEBUG ("ds->ds_num = %i; vl->values_len = %i;",
188 ds->ds_num, vl->values_len);
189 assert (ds->ds_num == vl->values_len);
191 vc = (value_cache_t *) malloc (sizeof (value_cache_t));
195 pthread_mutex_unlock (&cache_lock);
196 ERROR ("unixsock plugin: malloc failed: %s",
197 sstrerror (errno, errbuf, sizeof (errbuf)));
201 vc->gauge = (gauge_t *) malloc (sizeof (gauge_t) * vl->values_len);
202 if (vc->gauge == NULL)
205 pthread_mutex_unlock (&cache_lock);
206 ERROR ("unixsock plugin: malloc failed: %s",
207 sstrerror (errno, errbuf, sizeof (errbuf)));
212 vc->counter = (counter_t *) malloc (sizeof (counter_t) * vl->values_len);
213 if (vc->counter == NULL)
216 pthread_mutex_unlock (&cache_lock);
217 ERROR ("unixsock plugin: malloc failed: %s",
218 sstrerror (errno, errbuf, sizeof (errbuf)));
224 if (cache_alloc_name (vc->name, sizeof (vc->name),
225 vl->host, vl->plugin, vl->plugin_instance,
226 ds->type, vl->type_instance) != 0)
228 pthread_mutex_unlock (&cache_lock);
229 ERROR ("unixsock plugin: cache_alloc_name failed.");
236 for (i = 0; i < ds->ds_num; i++)
238 if (ds->ds[i].type == DS_TYPE_COUNTER)
241 vc->counter[i] = vl->values[i].counter;
243 else if (ds->ds[i].type == DS_TYPE_GAUGE)
245 vc->gauge[i] = vl->values[i].gauge;
254 vc->values_num = ds->ds_num;
257 vc->next = cache_head;
261 if (vc->time < cache_oldest)
262 cache_oldest = vc->time;
264 pthread_mutex_unlock (&cache_lock);
266 } /* int cache_insert */
268 static int cache_update (const data_set_t *ds, const value_list_t *vl)
270 char name[4*DATA_MAX_NAME_LEN];;
274 if (cache_alloc_name (name, sizeof (name),
276 vl->plugin, vl->plugin_instance,
277 ds->type, vl->type_instance) != 0)
280 pthread_mutex_lock (&cache_lock);
282 vc = cache_search (name);
285 return (cache_insert (ds, vl));
287 assert (vc->values_num == ds->ds_num);
288 assert (vc->values_num == vl->values_len);
291 * Update the values. This is possibly a lot more that you'd expect
292 * because we honor min and max values and handle counter overflows here.
294 for (i = 0; i < ds->ds_num; i++)
296 if (ds->ds[i].type == DS_TYPE_COUNTER)
298 if (vl->values[i].counter < vc->counter[i])
300 if (vl->values[i].counter <= 4294967295U)
302 vc->gauge[i] = ((4294967295U - vl->values[i].counter)
303 + vc->counter[i]) / (vl->time - vc->time);
307 vc->gauge[i] = ((18446744073709551615ULL - vl->values[i].counter)
308 + vc->counter[i]) / (vl->time - vc->time);
313 vc->gauge[i] = (vl->values[i].counter - vc->counter[i])
314 / (vl->time - vc->time);
317 vc->counter[i] = vl->values[i].counter;
319 else if (ds->ds[i].type == DS_TYPE_GAUGE)
321 vc->gauge[i] = vl->values[i].gauge;
330 if (isnan (vc->gauge[i])
331 || (!isnan (ds->ds[i].min) && (vc->gauge[i] < ds->ds[i].min))
332 || (!isnan (ds->ds[i].max) && (vc->gauge[i] > ds->ds[i].max)))
334 } /* for i = 0 .. ds->ds_num */
339 if (vc->time < cache_oldest)
340 cache_oldest = vc->time;
342 pthread_mutex_unlock (&cache_lock);
344 } /* int cache_update */
346 static void cache_flush (int max_age)
352 pthread_mutex_lock (&cache_lock);
356 if ((now - cache_oldest) <= max_age)
358 pthread_mutex_unlock (&cache_lock);
369 if ((now - this->time) <= max_age)
371 if (this->time < cache_oldest)
372 cache_oldest = this->time;
380 cache_head = this->next;
382 prev->next = this->next;
385 free (this->counter);
392 } /* while (this != NULL) */
394 pthread_mutex_unlock (&cache_lock);
395 } /* int cache_flush */
397 static int us_open_socket (void)
399 struct sockaddr_un sa;
402 sock_fd = socket (PF_UNIX, SOCK_STREAM, 0);
406 ERROR ("unixsock plugin: socket failed: %s",
407 sstrerror (errno, errbuf, sizeof (errbuf)));
411 memset (&sa, '\0', sizeof (sa));
412 sa.sun_family = AF_UNIX;
413 strncpy (sa.sun_path, (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
414 sizeof (sa.sun_path) - 1);
415 /* unlink (sa.sun_path); */
417 status = bind (sock_fd, (struct sockaddr *) &sa, sizeof (sa));
421 sstrerror (errno, errbuf, sizeof (errbuf));
422 DEBUG ("bind failed: %s; sa.sun_path = %s", errbuf, sa.sun_path);
423 ERROR ("unixsock plugin: bind failed: %s", errbuf);
429 status = listen (sock_fd, 8);
433 ERROR ("unixsock plugin: listen failed: %s",
434 sstrerror (errno, errbuf, sizeof (errbuf)));
447 grpname = (sock_group != NULL) ? sock_group : COLLECTD_GRP_NAME;
450 status = getgrnam_r (grpname, &sg, grbuf, sizeof (grbuf), &g);
454 WARNING ("unixsock plugin: getgrnam_r (%s) failed: %s", grpname,
455 sstrerror (errno, errbuf, sizeof (errbuf)));
460 WARNING ("unixsock plugin: No such group: `%s'",
465 if (chown ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
466 (uid_t) -1, g->gr_gid) != 0)
469 WARNING ("unixsock plugin: chown (%s, -1, %i) failed: %s",
470 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
472 sstrerror (errno, errbuf, sizeof (errbuf)));
477 } /* int us_open_socket */
479 static int us_handle_getval (FILE *fh, char **fields, int fields_num)
483 char *plugin_instance;
486 char name[4*DATA_MAX_NAME_LEN];
493 DEBUG ("unixsock plugin: Wrong number of fields: %i", fields_num);
494 fprintf (fh, "-1 Wrong number of fields: Got %i, expected 2.\n",
499 DEBUG ("unixsock plugin: Got query for `%s'", fields[1]);
501 status = parse_identifier (fields[1], &hostname,
502 &plugin, &plugin_instance,
503 &type, &type_instance);
506 DEBUG ("unixsock plugin: Cannot parse `%s'", fields[1]);
507 fprintf (fh, "-1 Cannot parse identifier.\n");
512 status = cache_alloc_name (name, sizeof (name),
513 hostname, plugin, plugin_instance, type, type_instance);
514 /* FIXME: Send some response */
518 pthread_mutex_lock (&cache_lock);
520 DEBUG ("vc = cache_search (%s)", name);
521 vc = cache_search (name);
525 DEBUG ("Did not find cache entry.");
526 fprintf (fh, "-1 No such value");
530 DEBUG ("Found cache entry.");
531 fprintf (fh, "%i", vc->values_num);
532 for (i = 0; i < vc->values_num; i++)
534 fprintf (fh, " %s=", vc->ds->ds[i].name);
535 if (isnan (vc->gauge[i]))
538 fprintf (fh, "%12e", vc->gauge[i]);
542 /* Free the mutex as soon as possible and definitely before flushing */
543 pthread_mutex_unlock (&cache_lock);
549 } /* int us_handle_getval */
551 static int us_handle_putval (FILE *fh, char **fields, int fields_num)
555 char *plugin_instance;
561 const data_set_t *ds;
562 value_list_t vl = VALUE_LIST_INIT;
568 DEBUG ("unixsock plugin: Wrong number of fields: %i", fields_num);
569 fprintf (fh, "-1 Wrong number of fields: Got %i, expected 3.\n",
575 status = parse_identifier (fields[1], &hostname,
576 &plugin, &plugin_instance,
577 &type, &type_instance);
580 DEBUG ("unixsock plugin: Cannot parse `%s'", fields[1]);
581 fprintf (fh, "-1 Cannot parse identifier.\n");
586 /* FIXME: Send some response */
587 if ((strlen (hostname) > sizeof (vl.host))
588 || (strlen (plugin) > sizeof (vl.plugin))
589 || ((plugin_instance != NULL)
590 && (strlen (plugin_instance) > sizeof (vl.plugin_instance)))
591 || ((type_instance != NULL)
592 && (strlen (type_instance) > sizeof (vl.type_instance))))
595 strcpy (vl.host, hostname);
596 strcpy (vl.plugin, plugin);
597 if (plugin_instance != NULL)
598 strcpy (vl.plugin_instance, plugin_instance);
599 if (type_instance != NULL)
600 strcpy (vl.type_instance, type_instance);
602 { /* parse the time */
604 char *v = strchr (t, ':');
609 vl.time = (time_t) atoi (t);
611 vl.time = time (NULL);
616 ds = plugin_get_ds (type);
620 value_ptr = (char **) calloc (ds->ds_num, sizeof (char *));
621 /* FIXME: Send some response */
622 if (value_ptr == NULL)
626 { /* parse the value-list. It's colon-separated. */
634 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
649 /* FIXME: Send some response */
652 } /* done parsing the value-list */
654 vl.values_len = ds->ds_num;
655 vl.values = (value_t *) malloc (vl.values_len * sizeof (value_t));
656 if (vl.values == NULL)
661 DEBUG ("value_ptr = 0x%p; vl.values = 0x%p;", (void *) value_ptr, (void *) vl.values);
663 for (i = 0; i < ds->ds_num; i++)
665 if (strcmp (value_ptr[i], "U") == 0)
666 vl.values[i].gauge = NAN;
667 else if (ds->ds[i].type == DS_TYPE_COUNTER)
668 vl.values[i].counter = atoll (value_ptr[i]);
669 else if (ds->ds[i].type == DS_TYPE_GAUGE)
670 vl.values[i].gauge = atof (value_ptr[i]);
671 } /* for (i = 2 .. fields_num) */
673 plugin_dispatch_values (type, &vl);
675 DEBUG ("value_ptr = 0x%p; vl.values = 0x%p;", (void *) value_ptr, (void *) vl.values);
680 fprintf (fh, "0 Success\n");
684 } /* int us_handle_putval */
686 static void *us_handle_client (void *arg)
698 DEBUG ("Reading from fd #%i", fd);
700 fh = fdopen (fd, "r+");
704 ERROR ("unixsock plugin: fdopen failed: %s",
705 sstrerror (errno, errbuf, sizeof (errbuf)));
707 pthread_exit ((void *) 1);
710 while (fgets (buffer, sizeof (buffer), fh) != NULL)
714 len = strlen (buffer);
716 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
717 buffer[--len] = '\0';
722 DEBUG ("fgets -> buffer = %s; len = %i;", buffer, len);
724 fields_num = strsplit (buffer, fields,
725 sizeof (fields) / sizeof (fields[0]));
733 if (strcasecmp (fields[0], "getval") == 0)
735 us_handle_getval (fh, fields, fields_num);
737 else if (strcasecmp (fields[0], "putval") == 0)
739 us_handle_putval (fh, fields, fields_num);
743 fprintf (fh, "Unknown command: %s\n", fields[0]);
746 } /* while (fgets) */
751 pthread_exit ((void *) 0);
752 } /* void *us_handle_client */
754 static void *us_server_thread (void *arg)
759 pthread_attr_t th_attr;
761 if (us_open_socket () != 0)
762 pthread_exit ((void *) 1);
766 DEBUG ("Calling accept..");
767 status = accept (sock_fd, NULL, NULL);
775 ERROR ("unixsock plugin: accept failed: %s",
776 sstrerror (errno, errbuf, sizeof (errbuf)));
779 pthread_exit ((void *) 1);
782 remote_fd = (int *) malloc (sizeof (int));
783 if (remote_fd == NULL)
786 WARNING ("unixsock plugin: malloc failed: %s",
787 sstrerror (errno, errbuf, sizeof (errbuf)));
793 DEBUG ("Spawning child to handle connection on fd #%i", *remote_fd);
795 pthread_attr_init (&th_attr);
796 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
798 status = pthread_create (&th, &th_attr, us_handle_client, (void *) remote_fd);
802 WARNING ("unixsock plugin: pthread_create failed: %s",
803 sstrerror (errno, errbuf, sizeof (errbuf)));
814 } /* void *us_server_thread */
816 static int us_config (const char *key, const char *val)
818 if (strcasecmp (key, "SocketFile") == 0)
821 sock_file = strdup (val);
823 else if (strcasecmp (key, "SocketGroup") == 0)
826 sock_group = strdup (val);
828 else if (strcasecmp (key, "SocketPerms") == 0)
830 sock_perms = (int) strtol (val, NULL, 8);
838 } /* int us_config */
840 static int us_init (void)
846 status = pthread_create (&listen_thread, NULL, us_server_thread, NULL);
850 ERROR ("unixsock plugin: pthread_create failed: %s",
851 sstrerror (errno, errbuf, sizeof (errbuf)));
858 static int us_shutdown (void)
864 if (listen_thread != (pthread_t) 0)
866 DEBUG ("unixsock plugin: Sending SIGTERM to listening thread");
867 pthread_kill (listen_thread, SIGTERM);
868 DEBUG ("unixsock plugin: Waiting for thread to terminate");
869 pthread_join (listen_thread, &ret);
870 listen_thread = (pthread_t) 0;
873 plugin_unregister_init ("unixsock");
874 plugin_unregister_write ("unixsock");
875 plugin_unregister_shutdown ("unixsock");
878 } /* int us_shutdown */
880 static int us_write (const data_set_t *ds, const value_list_t *vl)
882 cache_update (ds, vl);
883 cache_flush (2 * atoi (COLLECTD_STEP));
888 void module_register (void)
890 plugin_register_config ("unixsock", us_config,
891 config_keys, config_keys_num);
892 plugin_register_init ("unixsock", us_init);
893 plugin_register_write ("unixsock", us_write);
894 plugin_register_shutdown ("unixsock", us_shutdown);
895 } /* void module_register (void) */
897 /* vim: set sw=4 ts=4 sts=4 tw=78 : */