2 * collectd - src/unixsock.c
3 * Copyright (C) 2007,2008 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
30 #include "configfile.h"
32 #include "utils_cmd_flush.h"
33 #include "utils_cmd_getval.h"
34 #include "utils_cmd_getthreshold.h"
35 #include "utils_cmd_listval.h"
36 #include "utils_cmd_putval.h"
37 #include "utils_cmd_putnotif.h"
39 /* Folks without pthread will need to disable this plugin. */
48 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
51 #define US_DEFAULT_PATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-unixsock"
56 /* valid configuration file keys */
57 static const char *config_keys[] =
64 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
68 /* socket configuration */
69 static int sock_fd = -1;
70 static char *sock_file = NULL;
71 static char *sock_group = NULL;
72 static int sock_perms = S_IRWXU | S_IRWXG;
73 static _Bool delete_socket = 0;
75 static pthread_t listen_thread = (pthread_t) 0;
80 static int us_open_socket (void)
82 struct sockaddr_un sa;
85 sock_fd = socket (PF_UNIX, SOCK_STREAM, 0);
89 ERROR ("unixsock plugin: socket failed: %s",
90 sstrerror (errno, errbuf, sizeof (errbuf)));
94 memset (&sa, '\0', sizeof (sa));
95 sa.sun_family = AF_UNIX;
96 sstrncpy (sa.sun_path, (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
97 sizeof (sa.sun_path));
99 DEBUG ("unixsock plugin: socket path = %s", sa.sun_path);
104 status = unlink (sa.sun_path);
105 if ((status != 0) && (errno != ENOENT))
108 WARNING ("unixsock plugin: Deleting socket file \"%s\" failed: %s",
110 sstrerror (errno, errbuf, sizeof (errbuf)));
112 else if (status == 0)
114 INFO ("unixsock plugin: Successfully deleted socket file \"%s\".",
119 status = bind (sock_fd, (struct sockaddr *) &sa, sizeof (sa));
123 sstrerror (errno, errbuf, sizeof (errbuf));
124 ERROR ("unixsock plugin: bind failed: %s", errbuf);
130 chmod (sa.sun_path, sock_perms);
132 status = listen (sock_fd, 8);
136 ERROR ("unixsock plugin: listen failed: %s",
137 sstrerror (errno, errbuf, sizeof (errbuf)));
150 grpname = (sock_group != NULL) ? sock_group : COLLECTD_GRP_NAME;
153 status = getgrnam_r (grpname, &sg, grbuf, sizeof (grbuf), &g);
157 WARNING ("unixsock plugin: getgrnam_r (%s) failed: %s", grpname,
158 sstrerror (errno, errbuf, sizeof (errbuf)));
163 WARNING ("unixsock plugin: No such group: `%s'",
168 if (chown ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
169 (uid_t) -1, g->gr_gid) != 0)
172 WARNING ("unixsock plugin: chown (%s, -1, %i) failed: %s",
173 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
175 sstrerror (errno, errbuf, sizeof (errbuf)));
180 } /* int us_open_socket */
182 static void *us_handle_client (void *arg)
188 fdin = *((int *) arg);
192 DEBUG ("unixsock plugin: us_handle_client: Reading from fd #%i", fdin);
198 ERROR ("unixsock plugin: dup failed: %s",
199 sstrerror (errno, errbuf, sizeof (errbuf)));
201 pthread_exit ((void *) 1);
204 fhin = fdopen (fdin, "r");
208 ERROR ("unixsock plugin: fdopen failed: %s",
209 sstrerror (errno, errbuf, sizeof (errbuf)));
212 pthread_exit ((void *) 1);
216 fhout = fdopen (fdout, "w");
220 ERROR ("unixsock plugin: fdopen failed: %s",
221 sstrerror (errno, errbuf, sizeof (errbuf)));
222 fclose (fhin); /* this closes fdin as well */
224 pthread_exit ((void *) 1);
228 /* change output buffer to line buffered mode */
229 if (setvbuf (fhout, NULL, _IOLBF, 0) != 0)
232 ERROR ("unixsock plugin: setvbuf failed: %s",
233 sstrerror (errno, errbuf, sizeof (errbuf)));
236 pthread_exit ((void *) 1);
243 char buffer_copy[1024];
249 if (fgets (buffer, sizeof (buffer), fhin) == NULL)
251 if ((errno == EINTR) || (errno == EAGAIN))
257 WARNING ("unixsock plugin: failed to read from socket #%i: %s",
259 sstrerror (errno, errbuf, sizeof (errbuf)));
264 len = strlen (buffer);
266 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
267 buffer[--len] = '\0';
272 sstrncpy (buffer_copy, buffer, sizeof (buffer_copy));
274 fields_num = strsplit (buffer_copy, fields,
275 sizeof (fields) / sizeof (fields[0]));
278 fprintf (fhout, "-1 Internal error\n");
281 pthread_exit ((void *) 1);
285 if (strcasecmp (fields[0], "getval") == 0)
287 handle_getval (fhout, buffer);
289 else if (strcasecmp (fields[0], "getthreshold") == 0)
291 handle_getthreshold (fhout, buffer);
293 else if (strcasecmp (fields[0], "putval") == 0)
295 handle_putval (fhout, buffer);
297 else if (strcasecmp (fields[0], "listval") == 0)
299 handle_listval (fhout, buffer);
301 else if (strcasecmp (fields[0], "putnotif") == 0)
303 handle_putnotif (fhout, buffer);
305 else if (strcasecmp (fields[0], "flush") == 0)
307 handle_flush (fhout, buffer);
311 if (fprintf (fhout, "-1 Unknown command: %s\n", fields[0]) < 0)
314 WARNING ("unixsock plugin: failed to write to socket #%i: %s",
316 sstrerror (errno, errbuf, sizeof (errbuf)));
320 } /* while (fgets) */
322 DEBUG ("unixsock plugin: us_handle_client: Exiting..");
326 pthread_exit ((void *) 0);
328 } /* void *us_handle_client */
330 static void *us_server_thread (void __attribute__((unused)) *arg)
335 pthread_attr_t th_attr;
337 pthread_attr_init (&th_attr);
338 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
340 if (us_open_socket () != 0)
341 pthread_exit ((void *) 1);
345 DEBUG ("unixsock plugin: Calling accept..");
346 status = accept (sock_fd, NULL, NULL);
354 ERROR ("unixsock plugin: accept failed: %s",
355 sstrerror (errno, errbuf, sizeof (errbuf)));
358 pthread_attr_destroy (&th_attr);
359 pthread_exit ((void *) 1);
362 remote_fd = (int *) malloc (sizeof (int));
363 if (remote_fd == NULL)
366 WARNING ("unixsock plugin: malloc failed: %s",
367 sstrerror (errno, errbuf, sizeof (errbuf)));
373 DEBUG ("Spawning child to handle connection on fd #%i", *remote_fd);
375 status = plugin_thread_create (&th, &th_attr,
376 us_handle_client, (void *) remote_fd);
380 WARNING ("unixsock plugin: pthread_create failed: %s",
381 sstrerror (errno, errbuf, sizeof (errbuf)));
390 pthread_attr_destroy (&th_attr);
392 status = unlink ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH);
396 NOTICE ("unixsock plugin: unlink (%s) failed: %s",
397 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
398 sstrerror (errno, errbuf, sizeof (errbuf)));
402 } /* void *us_server_thread */
404 static int us_config (const char *key, const char *val)
406 if (strcasecmp (key, "SocketFile") == 0)
408 char *new_sock_file = strdup (val);
409 if (new_sock_file == NULL)
413 sock_file = new_sock_file;
415 else if (strcasecmp (key, "SocketGroup") == 0)
417 char *new_sock_group = strdup (val);
418 if (new_sock_group == NULL)
422 sock_group = new_sock_group;
424 else if (strcasecmp (key, "SocketPerms") == 0)
426 sock_perms = (int) strtol (val, NULL, 8);
428 else if (strcasecmp (key, "DeleteSocket") == 0)
441 } /* int us_config */
443 static int us_init (void)
445 static int have_init = 0;
449 /* Initialize only once. */
456 status = plugin_thread_create (&listen_thread, NULL,
457 us_server_thread, NULL);
461 ERROR ("unixsock plugin: pthread_create failed: %s",
462 sstrerror (errno, errbuf, sizeof (errbuf)));
469 static int us_shutdown (void)
475 if (listen_thread != (pthread_t) 0)
477 pthread_kill (listen_thread, SIGTERM);
478 pthread_join (listen_thread, &ret);
479 listen_thread = (pthread_t) 0;
482 plugin_unregister_init ("unixsock");
483 plugin_unregister_shutdown ("unixsock");
486 } /* int us_shutdown */
488 void module_register (void)
490 plugin_register_config ("unixsock", us_config,
491 config_keys, config_keys_num);
492 plugin_register_init ("unixsock", us_init);
493 plugin_register_shutdown ("unixsock", us_shutdown);
494 } /* void module_register (void) */
496 /* vim: set sw=4 ts=4 sts=4 tw=78 : */