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_insert (const data_set_t *ds, const value_list_t *vl)
149 /* We're called from `cache_update' so we don't need to lock the mutex */
153 DEBUG ("unixsock plugin: cache_insert: ds->ds_num = %i;"
154 " vl->values_len = %i;",
155 ds->ds_num, vl->values_len);
156 assert (ds->ds_num == vl->values_len);
158 vc = (value_cache_t *) malloc (sizeof (value_cache_t));
162 pthread_mutex_unlock (&cache_lock);
163 ERROR ("unixsock plugin: malloc failed: %s",
164 sstrerror (errno, errbuf, sizeof (errbuf)));
168 vc->gauge = (gauge_t *) malloc (sizeof (gauge_t) * vl->values_len);
169 if (vc->gauge == NULL)
172 pthread_mutex_unlock (&cache_lock);
173 ERROR ("unixsock plugin: malloc failed: %s",
174 sstrerror (errno, errbuf, sizeof (errbuf)));
179 vc->counter = (counter_t *) malloc (sizeof (counter_t) * vl->values_len);
180 if (vc->counter == NULL)
183 pthread_mutex_unlock (&cache_lock);
184 ERROR ("unixsock plugin: malloc failed: %s",
185 sstrerror (errno, errbuf, sizeof (errbuf)));
191 if (FORMAT_VL (vc->name, sizeof (vc->name), vl, ds))
193 pthread_mutex_unlock (&cache_lock);
194 ERROR ("unixsock plugin: FORMAT_VL failed.");
201 for (i = 0; i < ds->ds_num; i++)
203 if (ds->ds[i].type == DS_TYPE_COUNTER)
206 vc->counter[i] = vl->values[i].counter;
208 else if (ds->ds[i].type == DS_TYPE_GAUGE)
210 vc->gauge[i] = vl->values[i].gauge;
219 vc->values_num = ds->ds_num;
222 vc->next = cache_head;
226 if (vc->time < cache_oldest)
227 cache_oldest = vc->time;
229 pthread_mutex_unlock (&cache_lock);
231 } /* int cache_insert */
233 static int cache_update (const data_set_t *ds, const value_list_t *vl)
235 char name[4*DATA_MAX_NAME_LEN];;
239 if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
242 pthread_mutex_lock (&cache_lock);
244 vc = cache_search (name);
246 /* pthread_mutex_lock is called by cache_insert. */
248 return (cache_insert (ds, vl));
250 assert (vc->values_num == ds->ds_num);
251 assert (vc->values_num == vl->values_len);
253 /* Avoid floating-point exceptions due to division by zero. */
254 if (vc->time >= vl->time)
256 pthread_mutex_unlock (&cache_lock);
257 ERROR ("unixsock plugin: vc->time >= vl->time. vc->time = %u; "
258 "vl->time = %u; vl = %s;",
259 (unsigned int) vc->time, (unsigned int) vl->time,
262 } /* if (vc->time >= vl->time) */
265 * Update the values. This is possibly a lot more that you'd expect
266 * because we honor min and max values and handle counter overflows here.
268 for (i = 0; i < ds->ds_num; i++)
270 if (ds->ds[i].type == DS_TYPE_COUNTER)
272 if (vl->values[i].counter < vc->counter[i])
274 if (vl->values[i].counter <= 4294967295U)
276 vc->gauge[i] = ((4294967295U - vl->values[i].counter)
277 + vc->counter[i]) / (vl->time - vc->time);
281 vc->gauge[i] = ((18446744073709551615ULL - vl->values[i].counter)
282 + vc->counter[i]) / (vl->time - vc->time);
287 vc->gauge[i] = (vl->values[i].counter - vc->counter[i])
288 / (vl->time - vc->time);
291 vc->counter[i] = vl->values[i].counter;
293 else if (ds->ds[i].type == DS_TYPE_GAUGE)
295 vc->gauge[i] = vl->values[i].gauge;
304 if (isnan (vc->gauge[i])
305 || (!isnan (ds->ds[i].min) && (vc->gauge[i] < ds->ds[i].min))
306 || (!isnan (ds->ds[i].max) && (vc->gauge[i] > ds->ds[i].max)))
308 } /* for i = 0 .. ds->ds_num */
313 if (vc->time < cache_oldest)
314 cache_oldest = vc->time;
316 pthread_mutex_unlock (&cache_lock);
318 } /* int cache_update */
320 static void cache_flush (int max_age)
326 pthread_mutex_lock (&cache_lock);
330 if ((now - cache_oldest) <= max_age)
332 pthread_mutex_unlock (&cache_lock);
343 if ((now - this->time) <= max_age)
345 if (this->time < cache_oldest)
346 cache_oldest = this->time;
354 cache_head = this->next;
356 prev->next = this->next;
359 free (this->counter);
366 } /* while (this != NULL) */
368 pthread_mutex_unlock (&cache_lock);
369 } /* int cache_flush */
371 static int us_open_socket (void)
373 struct sockaddr_un sa;
376 sock_fd = socket (PF_UNIX, SOCK_STREAM, 0);
380 ERROR ("unixsock plugin: socket failed: %s",
381 sstrerror (errno, errbuf, sizeof (errbuf)));
385 memset (&sa, '\0', sizeof (sa));
386 sa.sun_family = AF_UNIX;
387 strncpy (sa.sun_path, (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
388 sizeof (sa.sun_path) - 1);
389 /* unlink (sa.sun_path); */
391 status = bind (sock_fd, (struct sockaddr *) &sa, sizeof (sa));
395 sstrerror (errno, errbuf, sizeof (errbuf));
396 DEBUG ("bind failed: %s; sa.sun_path = %s", errbuf, sa.sun_path);
397 ERROR ("unixsock plugin: bind failed: %s", errbuf);
403 status = listen (sock_fd, 8);
407 ERROR ("unixsock plugin: listen failed: %s",
408 sstrerror (errno, errbuf, sizeof (errbuf)));
421 grpname = (sock_group != NULL) ? sock_group : COLLECTD_GRP_NAME;
424 status = getgrnam_r (grpname, &sg, grbuf, sizeof (grbuf), &g);
428 WARNING ("unixsock plugin: getgrnam_r (%s) failed: %s", grpname,
429 sstrerror (errno, errbuf, sizeof (errbuf)));
434 WARNING ("unixsock plugin: No such group: `%s'",
439 if (chown ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
440 (uid_t) -1, g->gr_gid) != 0)
443 WARNING ("unixsock plugin: chown (%s, -1, %i) failed: %s",
444 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
446 sstrerror (errno, errbuf, sizeof (errbuf)));
451 } /* int us_open_socket */
453 static int us_handle_getval (FILE *fh, char **fields, int fields_num)
457 char *plugin_instance;
460 char name[4*DATA_MAX_NAME_LEN];
467 DEBUG ("unixsock plugin: Wrong number of fields: %i", fields_num);
468 fprintf (fh, "-1 Wrong number of fields: Got %i, expected 2.\n",
473 DEBUG ("unixsock plugin: Got query for `%s'", fields[1]);
475 status = parse_identifier (fields[1], &hostname,
476 &plugin, &plugin_instance,
477 &type, &type_instance);
480 DEBUG ("unixsock plugin: Cannot parse `%s'", fields[1]);
481 fprintf (fh, "-1 Cannot parse identifier.\n");
486 status = format_name (name, sizeof (name),
487 hostname, plugin, plugin_instance, type, type_instance);
488 /* FIXME: Send some response */
492 pthread_mutex_lock (&cache_lock);
494 DEBUG ("vc = cache_search (%s)", name);
495 vc = cache_search (name);
499 DEBUG ("Did not find cache entry.");
500 fprintf (fh, "-1 No such value");
504 DEBUG ("Found cache entry.");
505 fprintf (fh, "%i", vc->values_num);
506 for (i = 0; i < vc->values_num; i++)
508 fprintf (fh, " %s=", vc->ds->ds[i].name);
509 if (isnan (vc->gauge[i]))
512 fprintf (fh, "%12e", vc->gauge[i]);
516 /* Free the mutex as soon as possible and definitely before flushing */
517 pthread_mutex_unlock (&cache_lock);
523 } /* int us_handle_getval */
525 static int us_handle_putval (FILE *fh, char **fields, int fields_num)
529 char *plugin_instance;
535 const data_set_t *ds;
536 value_list_t vl = VALUE_LIST_INIT;
542 DEBUG ("unixsock plugin: Wrong number of fields: %i", fields_num);
543 fprintf (fh, "-1 Wrong number of fields: Got %i, expected 3.\n",
549 status = parse_identifier (fields[1], &hostname,
550 &plugin, &plugin_instance,
551 &type, &type_instance);
554 DEBUG ("unixsock plugin: Cannot parse `%s'", fields[1]);
555 fprintf (fh, "-1 Cannot parse identifier.\n");
560 /* FIXME: Send some response */
561 if ((strlen (hostname) > sizeof (vl.host))
562 || (strlen (plugin) > sizeof (vl.plugin))
563 || ((plugin_instance != NULL)
564 && (strlen (plugin_instance) > sizeof (vl.plugin_instance)))
565 || ((type_instance != NULL)
566 && (strlen (type_instance) > sizeof (vl.type_instance))))
569 strcpy (vl.host, hostname);
570 strcpy (vl.plugin, plugin);
571 if (plugin_instance != NULL)
572 strcpy (vl.plugin_instance, plugin_instance);
573 if (type_instance != NULL)
574 strcpy (vl.type_instance, type_instance);
576 { /* parse the time */
578 char *v = strchr (t, ':');
583 vl.time = (time_t) atoi (t);
585 vl.time = time (NULL);
590 ds = plugin_get_ds (type);
594 value_ptr = (char **) calloc (ds->ds_num, sizeof (char *));
595 /* FIXME: Send some response */
596 if (value_ptr == NULL)
600 { /* parse the value-list. It's colon-separated. */
608 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
623 /* FIXME: Send some response */
626 } /* done parsing the value-list */
628 vl.values_len = ds->ds_num;
629 vl.values = (value_t *) malloc (vl.values_len * sizeof (value_t));
630 if (vl.values == NULL)
635 DEBUG ("value_ptr = 0x%p; vl.values = 0x%p;", (void *) value_ptr, (void *) vl.values);
637 for (i = 0; i < ds->ds_num; i++)
639 if (strcmp (value_ptr[i], "U") == 0)
640 vl.values[i].gauge = NAN;
641 else if (ds->ds[i].type == DS_TYPE_COUNTER)
642 vl.values[i].counter = atoll (value_ptr[i]);
643 else if (ds->ds[i].type == DS_TYPE_GAUGE)
644 vl.values[i].gauge = atof (value_ptr[i]);
645 } /* for (i = 2 .. fields_num) */
647 plugin_dispatch_values (type, &vl);
649 DEBUG ("value_ptr = 0x%p; vl.values = 0x%p;", (void *) value_ptr, (void *) vl.values);
654 fprintf (fh, "0 Success\n");
658 } /* int us_handle_putval */
660 static void *us_handle_client (void *arg)
672 DEBUG ("Reading from fd #%i", fd);
674 fh = fdopen (fd, "r+");
678 ERROR ("unixsock plugin: fdopen failed: %s",
679 sstrerror (errno, errbuf, sizeof (errbuf)));
681 pthread_exit ((void *) 1);
684 while (fgets (buffer, sizeof (buffer), fh) != NULL)
688 len = strlen (buffer);
690 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
691 buffer[--len] = '\0';
696 DEBUG ("fgets -> buffer = %s; len = %i;", buffer, len);
698 fields_num = strsplit (buffer, fields,
699 sizeof (fields) / sizeof (fields[0]));
707 if (strcasecmp (fields[0], "getval") == 0)
709 us_handle_getval (fh, fields, fields_num);
711 else if (strcasecmp (fields[0], "putval") == 0)
713 us_handle_putval (fh, fields, fields_num);
717 fprintf (fh, "Unknown command: %s\n", fields[0]);
720 } /* while (fgets) */
725 pthread_exit ((void *) 0);
726 } /* void *us_handle_client */
728 static void *us_server_thread (void *arg)
733 pthread_attr_t th_attr;
735 if (us_open_socket () != 0)
736 pthread_exit ((void *) 1);
740 DEBUG ("Calling accept..");
741 status = accept (sock_fd, NULL, NULL);
749 ERROR ("unixsock plugin: accept failed: %s",
750 sstrerror (errno, errbuf, sizeof (errbuf)));
753 pthread_exit ((void *) 1);
756 remote_fd = (int *) malloc (sizeof (int));
757 if (remote_fd == NULL)
760 WARNING ("unixsock plugin: malloc failed: %s",
761 sstrerror (errno, errbuf, sizeof (errbuf)));
767 DEBUG ("Spawning child to handle connection on fd #%i", *remote_fd);
769 pthread_attr_init (&th_attr);
770 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
772 status = pthread_create (&th, &th_attr, us_handle_client, (void *) remote_fd);
776 WARNING ("unixsock plugin: pthread_create failed: %s",
777 sstrerror (errno, errbuf, sizeof (errbuf)));
788 } /* void *us_server_thread */
790 static int us_config (const char *key, const char *val)
792 if (strcasecmp (key, "SocketFile") == 0)
795 sock_file = strdup (val);
797 else if (strcasecmp (key, "SocketGroup") == 0)
800 sock_group = strdup (val);
802 else if (strcasecmp (key, "SocketPerms") == 0)
804 sock_perms = (int) strtol (val, NULL, 8);
812 } /* int us_config */
814 static int us_init (void)
820 status = pthread_create (&listen_thread, NULL, us_server_thread, NULL);
824 ERROR ("unixsock plugin: pthread_create failed: %s",
825 sstrerror (errno, errbuf, sizeof (errbuf)));
832 static int us_shutdown (void)
838 if (listen_thread != (pthread_t) 0)
840 pthread_kill (listen_thread, SIGTERM);
841 pthread_join (listen_thread, &ret);
842 listen_thread = (pthread_t) 0;
845 plugin_unregister_init ("unixsock");
846 plugin_unregister_write ("unixsock");
847 plugin_unregister_shutdown ("unixsock");
850 } /* int us_shutdown */
852 static int us_write (const data_set_t *ds, const value_list_t *vl)
854 cache_update (ds, vl);
855 cache_flush (2 * interval_g);
860 void module_register (void)
862 plugin_register_config ("unixsock", us_config,
863 config_keys, config_keys_num);
864 plugin_register_init ("unixsock", us_init);
865 plugin_register_write ("unixsock", us_write);
866 plugin_register_shutdown ("unixsock", us_shutdown);
867 } /* void module_register (void) */
869 /* vim: set sw=4 ts=4 sts=4 tw=78 : */