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. */
42 #include <sys/socket.h>
49 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
52 #define US_DEFAULT_PATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-unixsock"
57 /* valid configuration file keys */
58 static const char *config_keys[] =
65 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
69 /* socket configuration */
70 static int sock_fd = -1;
71 static char *sock_file = NULL;
72 static char *sock_group = NULL;
73 static int sock_perms = S_IRWXU | S_IRWXG;
74 static _Bool delete_socket = 0;
76 static pthread_t listen_thread = (pthread_t) 0;
81 static int us_open_socket (void)
83 struct sockaddr_un sa;
86 sock_fd = socket (PF_UNIX, SOCK_STREAM, 0);
90 ERROR ("unixsock plugin: socket failed: %s",
91 sstrerror (errno, errbuf, sizeof (errbuf)));
95 memset (&sa, '\0', sizeof (sa));
96 sa.sun_family = AF_UNIX;
97 sstrncpy (sa.sun_path, (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
98 sizeof (sa.sun_path));
100 DEBUG ("unixsock plugin: socket path = %s", sa.sun_path);
105 status = unlink (sa.sun_path);
106 if ((status != 0) && (errno != ENOENT))
109 WARNING ("unixsock plugin: Deleting socket file \"%s\" failed: %s",
111 sstrerror (errno, errbuf, sizeof (errbuf)));
113 else if (status == 0)
115 INFO ("unixsock plugin: Successfully deleted socket file \"%s\".",
120 status = bind (sock_fd, (struct sockaddr *) &sa, sizeof (sa));
124 sstrerror (errno, errbuf, sizeof (errbuf));
125 ERROR ("unixsock plugin: bind failed: %s", errbuf);
131 status = chmod (sa.sun_path, sock_perms);
135 ERROR ("unixsock plugin: chmod failed: %s",
136 sstrerror (errno, errbuf, sizeof (errbuf)));
142 status = listen (sock_fd, 8);
146 ERROR ("unixsock plugin: listen failed: %s",
147 sstrerror (errno, errbuf, sizeof (errbuf)));
160 grpname = (sock_group != NULL) ? sock_group : COLLECTD_GRP_NAME;
163 status = getgrnam_r (grpname, &sg, grbuf, sizeof (grbuf), &g);
167 WARNING ("unixsock plugin: getgrnam_r (%s) failed: %s", grpname,
168 sstrerror (errno, errbuf, sizeof (errbuf)));
173 WARNING ("unixsock plugin: No such group: `%s'",
178 if (chown ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
179 (uid_t) -1, g->gr_gid) != 0)
182 WARNING ("unixsock plugin: chown (%s, -1, %i) failed: %s",
183 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
185 sstrerror (errno, errbuf, sizeof (errbuf)));
190 } /* int us_open_socket */
192 static void *us_handle_client (void *arg)
198 fdin = *((int *) arg);
202 DEBUG ("unixsock plugin: us_handle_client: Reading from fd #%i", fdin);
208 ERROR ("unixsock plugin: dup failed: %s",
209 sstrerror (errno, errbuf, sizeof (errbuf)));
211 pthread_exit ((void *) 1);
214 fhin = fdopen (fdin, "r");
218 ERROR ("unixsock plugin: fdopen failed: %s",
219 sstrerror (errno, errbuf, sizeof (errbuf)));
222 pthread_exit ((void *) 1);
226 fhout = fdopen (fdout, "w");
230 ERROR ("unixsock plugin: fdopen failed: %s",
231 sstrerror (errno, errbuf, sizeof (errbuf)));
232 fclose (fhin); /* this closes fdin as well */
234 pthread_exit ((void *) 1);
238 /* change output buffer to line buffered mode */
239 if (setvbuf (fhout, NULL, _IOLBF, 0) != 0)
242 ERROR ("unixsock plugin: setvbuf failed: %s",
243 sstrerror (errno, errbuf, sizeof (errbuf)));
246 pthread_exit ((void *) 1);
253 char buffer_copy[1024];
259 if (fgets (buffer, sizeof (buffer), fhin) == NULL)
261 if ((errno == EINTR) || (errno == EAGAIN))
267 WARNING ("unixsock plugin: failed to read from socket #%i: %s",
269 sstrerror (errno, errbuf, sizeof (errbuf)));
274 len = strlen (buffer);
276 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
277 buffer[--len] = '\0';
282 sstrncpy (buffer_copy, buffer, sizeof (buffer_copy));
284 fields_num = strsplit (buffer_copy, fields,
285 sizeof (fields) / sizeof (fields[0]));
288 fprintf (fhout, "-1 Internal error\n");
291 pthread_exit ((void *) 1);
295 if (strcasecmp (fields[0], "getval") == 0)
297 handle_getval (fhout, buffer);
299 else if (strcasecmp (fields[0], "getthreshold") == 0)
301 handle_getthreshold (fhout, buffer);
303 else if (strcasecmp (fields[0], "putval") == 0)
305 handle_putval (fhout, buffer);
307 else if (strcasecmp (fields[0], "listval") == 0)
309 handle_listval (fhout, buffer);
311 else if (strcasecmp (fields[0], "putnotif") == 0)
313 handle_putnotif (fhout, buffer);
315 else if (strcasecmp (fields[0], "flush") == 0)
317 handle_flush (fhout, buffer);
321 if (fprintf (fhout, "-1 Unknown command: %s\n", fields[0]) < 0)
324 WARNING ("unixsock plugin: failed to write to socket #%i: %s",
326 sstrerror (errno, errbuf, sizeof (errbuf)));
330 } /* while (fgets) */
332 DEBUG ("unixsock plugin: us_handle_client: Exiting..");
336 pthread_exit ((void *) 0);
338 } /* void *us_handle_client */
340 static void *us_server_thread (void __attribute__((unused)) *arg)
345 pthread_attr_t th_attr;
347 pthread_attr_init (&th_attr);
348 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
350 if (us_open_socket () != 0)
351 pthread_exit ((void *) 1);
355 DEBUG ("unixsock plugin: Calling accept..");
356 status = accept (sock_fd, NULL, NULL);
364 ERROR ("unixsock plugin: accept failed: %s",
365 sstrerror (errno, errbuf, sizeof (errbuf)));
368 pthread_attr_destroy (&th_attr);
369 pthread_exit ((void *) 1);
372 remote_fd = (int *) malloc (sizeof (int));
373 if (remote_fd == NULL)
376 WARNING ("unixsock plugin: malloc failed: %s",
377 sstrerror (errno, errbuf, sizeof (errbuf)));
383 DEBUG ("Spawning child to handle connection on fd #%i", *remote_fd);
385 status = plugin_thread_create (&th, &th_attr,
386 us_handle_client, (void *) remote_fd);
390 WARNING ("unixsock plugin: pthread_create failed: %s",
391 sstrerror (errno, errbuf, sizeof (errbuf)));
400 pthread_attr_destroy (&th_attr);
402 status = unlink ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH);
406 NOTICE ("unixsock plugin: unlink (%s) failed: %s",
407 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
408 sstrerror (errno, errbuf, sizeof (errbuf)));
412 } /* void *us_server_thread */
414 static int us_config (const char *key, const char *val)
416 if (strcasecmp (key, "SocketFile") == 0)
418 char *new_sock_file = strdup (val);
419 if (new_sock_file == NULL)
423 sock_file = new_sock_file;
425 else if (strcasecmp (key, "SocketGroup") == 0)
427 char *new_sock_group = strdup (val);
428 if (new_sock_group == NULL)
432 sock_group = new_sock_group;
434 else if (strcasecmp (key, "SocketPerms") == 0)
436 sock_perms = (int) strtol (val, NULL, 8);
438 else if (strcasecmp (key, "DeleteSocket") == 0)
451 } /* int us_config */
453 static int us_init (void)
455 static int have_init = 0;
459 /* Initialize only once. */
466 status = plugin_thread_create (&listen_thread, NULL,
467 us_server_thread, NULL);
471 ERROR ("unixsock plugin: pthread_create failed: %s",
472 sstrerror (errno, errbuf, sizeof (errbuf)));
479 static int us_shutdown (void)
485 if (listen_thread != (pthread_t) 0)
487 pthread_kill (listen_thread, SIGTERM);
488 pthread_join (listen_thread, &ret);
489 listen_thread = (pthread_t) 0;
492 plugin_unregister_init ("unixsock");
493 plugin_unregister_shutdown ("unixsock");
496 } /* int us_shutdown */
498 void module_register (void)
500 plugin_register_config ("unixsock", us_config,
501 config_keys, config_keys_num);
502 plugin_register_init ("unixsock", us_init);
503 plugin_register_shutdown ("unixsock", us_shutdown);
504 } /* void module_register (void) */
506 /* vim: set sw=4 ts=4 sts=4 tw=78 : */