src/unixsock.c

   1 /**
   2  * collectd - src/unixsock.c
   3  * Copyright (C) 2007,2008  Florian octo Forster
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  * Author:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26
  27 #include "utils_cmd_flush.h"
  28 #include "utils_cmd_getval.h"
  29 #include "utils_cmd_listval.h"
  30 #include "utils_cmd_putval.h"
  31 #include "utils_cmd_putnotif.h"
  32
  33 /* Folks without pthread will need to disable this plugin. */
  34 #include <pthread.h>
  35
  36 #include <sys/socket.h>
  37 #include <sys/stat.h>
  38 #include <sys/un.h>
  39
  40 #include <grp.h>
  41
  42 #ifndef UNIX_PATH_MAX
  43 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
  44 #endif
  45
  46 #define US_DEFAULT_PATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-unixsock"
  47
  48 /*
  49  * Private variables
  50  */
  51 /* valid configuration file keys */
  52 static const char *config_keys[] =
  53 {
  54         "SocketFile",
  55         "SocketGroup",
  56         "SocketPerms"
  57 };
  58 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  59
  60 static int loop = 0;
  61
  62 /* socket configuration */
  63 static int   sock_fd    = -1;
  64 static char *sock_file  = NULL;
  65 static char *sock_group = NULL;
  66 static int   sock_perms = S_IRWXU | S_IRWXG;
  67
  68 static pthread_t listen_thread = (pthread_t) 0;
  69
  70 /*
  71  * Functions
  72  */
  73 static int us_open_socket (void)
  74 {
  75         struct sockaddr_un sa;
  76         int status;
  77
  78         sock_fd = socket (PF_UNIX, SOCK_STREAM, 0);
  79         if (sock_fd < 0)
  80         {
  81                 char errbuf[1024];
  82                 ERROR ("unixsock plugin: socket failed: %s",
  83                                 sstrerror (errno, errbuf, sizeof (errbuf)));
  84                 return (-1);
  85         }
  86
  87         memset (&sa, '\0', sizeof (sa));
  88         sa.sun_family = AF_UNIX;
  89         strncpy (sa.sun_path, (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
  90                         sizeof (sa.sun_path) - 1);
  91         /* unlink (sa.sun_path); */
  92
  93         DEBUG ("unixsock plugin: socket path = %s", sa.sun_path);
  94
  95         status = bind (sock_fd, (struct sockaddr *) &sa, sizeof (sa));
  96         if (status != 0)
  97         {
  98                 char errbuf[1024];
  99                 sstrerror (errno, errbuf, sizeof (errbuf));
 100                 ERROR ("unixsock plugin: bind failed: %s", errbuf);
 101                 close (sock_fd);
 102                 sock_fd = -1;
 103                 return (-1);
 104         }
 105
 106         chmod (sa.sun_path, sock_perms);
 107
 108         status = listen (sock_fd, 8);
 109         if (status != 0)
 110         {
 111                 char errbuf[1024];
 112                 ERROR ("unixsock plugin: listen failed: %s",
 113                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 114                 close (sock_fd);
 115                 sock_fd = -1;
 116                 return (-1);
 117         }
 118
 119         do
 120         {
 121                 char *grpname;
 122                 struct group *g;
 123                 struct group sg;
 124                 char grbuf[2048];
 125
 126                 grpname = (sock_group != NULL) ? sock_group : COLLECTD_GRP_NAME;
 127                 g = NULL;
 128
 129                 status = getgrnam_r (grpname, &sg, grbuf, sizeof (grbuf), &g);
 130                 if (status != 0)
 131                 {
 132                         char errbuf[1024];
 133                         WARNING ("unixsock plugin: getgrnam_r (%s) failed: %s", grpname,
 134                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 135                         break;
 136                 }
 137                 if (g == NULL)
 138                 {
 139                         WARNING ("unixsock plugin: No such group: `%s'",
 140                                         grpname);
 141                         break;
 142                 }
 143
 144                 if (chown ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 145                                         (uid_t) -1, g->gr_gid) != 0)
 146                 {
 147                         char errbuf[1024];
 148                         WARNING ("unixsock plugin: chown (%s, -1, %i) failed: %s",
 149                                         (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 150                                         (int) g->gr_gid,
 151                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 152                 }
 153         } while (0);
 154
 155         return (0);
 156 } /* int us_open_socket */
 157
 158 static void *us_handle_client (void *arg)
 159 {
 160         int fd;
 161         FILE *fhin, *fhout;
 162         char buffer[1024];
 163         char *fields[128];
 164         int   fields_num;
 165
 166         fd = *((int *) arg);
 167         free (arg);
 168         arg = NULL;
 169
 170         DEBUG ("Reading from fd #%i", fd);
 171
 172         fhin  = fdopen (fd, "r");
 173         if (fhin == NULL)
 174         {
 175                 char errbuf[1024];
 176                 ERROR ("unixsock plugin: fdopen failed: %s",
 177                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 178                 close (fd);
 179                 pthread_exit ((void *) 1);
 180         }
 181
 182         fhout = fdopen (fd, "w");
 183         if (fhout == NULL)
 184         {
 185                 char errbuf[1024];
 186                 ERROR ("unixsock plugin: fdopen failed: %s",
 187                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 188                 fclose (fhin); /* this closes fd as well */
 189                 pthread_exit ((void *) 1);
 190         }
 191
 192         /* change output buffer to line buffered mode */
 193         if (setvbuf (fhout, NULL, _IOLBF, 0) != 0)
 194         {
 195                 char errbuf[1024];
 196                 ERROR ("unixsock plugin: setvbuf failed: %s",
 197                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 198                 fclose (fhin);
 199                 fclose (fhout);
 200                 pthread_exit ((void *) 1);
 201         }
 202
 203         while (42)
 204         {
 205                 int len;
 206
 207                 errno = 0;
 208                 if (fgets (buffer, sizeof (buffer), fhin) == NULL)
 209                 {
 210                         if (errno != 0)
 211                         {
 212                                 char errbuf[1024];
 213                                 WARNING ("unixsock plugin: failed to read from socket #%i: %s",
 214                                                 fileno (fhin),
 215                                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 216                         }
 217                         break;
 218                 }
 219
 220                 len = strlen (buffer);
 221                 while ((len > 0)
 222                                 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
 223                         buffer[--len] = '\0';
 224
 225                 if (len == 0)
 226                         continue;
 227
 228                 DEBUG ("fgets -> buffer = %s; len = %i;", buffer, len);
 229
 230                 fields_num = strsplit (buffer, fields,
 231                                 sizeof (fields) / sizeof (fields[0]));
 232
 233                 if (fields_num < 1)
 234                 {
 235                         close (fd);
 236                         break;
 237                 }
 238
 239                 if (strcasecmp (fields[0], "getval") == 0)
 240                 {
 241                         handle_getval (fhout, fields, fields_num);
 242                 }
 243                 else if (strcasecmp (fields[0], "putval") == 0)
 244                 {
 245                         handle_putval (fhout, fields, fields_num);
 246                 }
 247                 else if (strcasecmp (fields[0], "listval") == 0)
 248                 {
 249                         handle_listval (fhout, fields, fields_num);
 250                 }
 251                 else if (strcasecmp (fields[0], "putnotif") == 0)
 252                 {
 253                         handle_putnotif (fhout, fields, fields_num);
 254                 }
 255                 else if (strcasecmp (fields[0], "flush") == 0)
 256                 {
 257                         handle_flush (fhout, fields, fields_num);
 258                 }
 259                 else
 260                 {
 261                         if (fprintf (fhout, "-1 Unknown command: %s\n", fields[0]) < 0)
 262                         {
 263                                 char errbuf[1024];
 264                                 WARNING ("unixsock plugin: failed to write to socket #%i: %s",
 265                                                 fileno (fhout),
 266                                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 267                                 break;
 268                         }
 269                 }
 270         } /* while (fgets) */
 271
 272         DEBUG ("Exiting..");
 273         fclose (fhin);
 274         fclose (fhout);
 275
 276         pthread_exit ((void *) 0);
 277         return ((void *) 0);
 278 } /* void *us_handle_client */
 279
 280 static void *us_server_thread (void *arg)
 281 {
 282         int  status;
 283         int *remote_fd;
 284         pthread_t th;
 285         pthread_attr_t th_attr;
 286
 287         if (us_open_socket () != 0)
 288                 pthread_exit ((void *) 1);
 289
 290         while (loop != 0)
 291         {
 292                 DEBUG ("unixsock plugin: Calling accept..");
 293                 status = accept (sock_fd, NULL, NULL);
 294                 if (status < 0)
 295                 {
 296                         char errbuf[1024];
 297
 298                         if (errno == EINTR)
 299                                 continue;
 300
 301                         ERROR ("unixsock plugin: accept failed: %s",
 302                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 303                         close (sock_fd);
 304                         sock_fd = -1;
 305                         pthread_exit ((void *) 1);
 306                 }
 307
 308                 remote_fd = (int *) malloc (sizeof (int));
 309                 if (remote_fd == NULL)
 310                 {
 311                         char errbuf[1024];
 312                         WARNING ("unixsock plugin: malloc failed: %s",
 313                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 314                         close (status);
 315                         continue;
 316                 }
 317                 *remote_fd = status;
 318
 319                 DEBUG ("Spawning child to handle connection on fd #%i", *remote_fd);
 320
 321                 pthread_attr_init (&th_attr);
 322                 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
 323
 324                 status = pthread_create (&th, &th_attr, us_handle_client, (void *) remote_fd);
 325                 if (status != 0)
 326                 {
 327                         char errbuf[1024];
 328                         WARNING ("unixsock plugin: pthread_create failed: %s",
 329                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 330                         close (*remote_fd);
 331                         free (remote_fd);
 332                         continue;
 333                 }
 334         } /* while (loop) */
 335
 336         close (sock_fd);
 337         sock_fd = -1;
 338
 339         status = unlink ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH);
 340         if (status != 0)
 341         {
 342                 char errbuf[1024];
 343                 NOTICE ("unixsock plugin: unlink (%s) failed: %s",
 344                                 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 345                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 346         }
 347
 348         return ((void *) 0);
 349 } /* void *us_server_thread */
 350
 351 static int us_config (const char *key, const char *val)
 352 {
 353         if (strcasecmp (key, "SocketFile") == 0)
 354         {
 355                 char *new_sock_file = strdup (val);
 356                 if (new_sock_file == NULL)
 357                         return (1);
 358
 359                 sfree (sock_file);
 360                 sock_file = new_sock_file;
 361         }
 362         else if (strcasecmp (key, "SocketGroup") == 0)
 363         {
 364                 char *new_sock_group = strdup (val);
 365                 if (new_sock_group == NULL)
 366                         return (1);
 367
 368                 sfree (sock_group);
 369                 sock_group = new_sock_group;
 370         }
 371         else if (strcasecmp (key, "SocketPerms") == 0)
 372         {
 373                 sock_perms = (int) strtol (val, NULL, 8);
 374         }
 375         else
 376         {
 377                 return (-1);
 378         }
 379
 380         return (0);
 381 } /* int us_config */
 382
 383 static int us_init (void)
 384 {
 385         static int have_init = 0;
 386
 387         int status;
 388
 389         /* Initialize only once. */
 390         if (have_init != 0)
 391                 return (0);
 392         have_init = 1;
 393
 394         loop = 1;
 395
 396         status = pthread_create (&listen_thread, NULL, us_server_thread, NULL);
 397         if (status != 0)
 398         {
 399                 char errbuf[1024];
 400                 ERROR ("unixsock plugin: pthread_create failed: %s",
 401                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 402                 return (-1);
 403         }
 404
 405         return (0);
 406 } /* int us_init */
 407
 408 static int us_shutdown (void)
 409 {
 410         void *ret;
 411
 412         loop = 0;
 413
 414         if (listen_thread != (pthread_t) 0)
 415         {
 416                 pthread_kill (listen_thread, SIGTERM);
 417                 pthread_join (listen_thread, &ret);
 418                 listen_thread = (pthread_t) 0;
 419         }
 420
 421         plugin_unregister_init ("unixsock");
 422         plugin_unregister_shutdown ("unixsock");
 423
 424         return (0);
 425 } /* int us_shutdown */
 426
 427 void module_register (void)
 428 {
 429         plugin_register_config ("unixsock", us_config,
 430                         config_keys, config_keys_num);
 431         plugin_register_init ("unixsock", us_init);
 432         plugin_register_shutdown ("unixsock", us_shutdown);
 433 } /* void module_register (void) */
 434
 435 /* vim: set sw=4 ts=4 sts=4 tw=78 : */