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         while (fgets (buffer, sizeof (buffer), fhin) != NULL)
 193         {
 194                 int len;
 195
 196                 len = strlen (buffer);
 197                 while ((len > 0)
 198                                 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
 199                         buffer[--len] = '\0';
 200
 201                 if (len == 0)
 202                         continue;
 203
 204                 DEBUG ("fgets -> buffer = %s; len = %i;", buffer, len);
 205
 206                 fields_num = strsplit (buffer, fields,
 207                                 sizeof (fields) / sizeof (fields[0]));
 208
 209                 if (fields_num < 1)
 210                 {
 211                         close (fd);
 212                         break;
 213                 }
 214
 215                 if (strcasecmp (fields[0], "getval") == 0)
 216                 {
 217                         handle_getval (fhout, fields, fields_num);
 218                 }
 219                 else if (strcasecmp (fields[0], "putval") == 0)
 220                 {
 221                         handle_putval (fhout, fields, fields_num);
 222                 }
 223                 else if (strcasecmp (fields[0], "listval") == 0)
 224                 {
 225                         handle_listval (fhout, fields, fields_num);
 226                 }
 227                 else if (strcasecmp (fields[0], "putnotif") == 0)
 228                 {
 229                         handle_putnotif (fhout, fields, fields_num);
 230                 }
 231                 else if (strcasecmp (fields[0], "flush") == 0)
 232                 {
 233                         handle_flush (fhout, fields, fields_num);
 234                 }
 235                 else
 236                 {
 237                         fprintf (fhout, "-1 Unknown command: %s\n", fields[0]);
 238                         fflush (fhout);
 239                 }
 240         } /* while (fgets) */
 241
 242         DEBUG ("Exiting..");
 243         fclose (fhin);
 244         fclose (fhout);
 245
 246         pthread_exit ((void *) 0);
 247         return ((void *) 0);
 248 } /* void *us_handle_client */
 249
 250 static void *us_server_thread (void *arg)
 251 {
 252         int  status;
 253         int *remote_fd;
 254         pthread_t th;
 255         pthread_attr_t th_attr;
 256
 257         if (us_open_socket () != 0)
 258                 pthread_exit ((void *) 1);
 259
 260         while (loop != 0)
 261         {
 262                 DEBUG ("unixsock plugin: Calling accept..");
 263                 status = accept (sock_fd, NULL, NULL);
 264                 if (status < 0)
 265                 {
 266                         char errbuf[1024];
 267
 268                         if (errno == EINTR)
 269                                 continue;
 270
 271                         ERROR ("unixsock plugin: accept failed: %s",
 272                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 273                         close (sock_fd);
 274                         sock_fd = -1;
 275                         pthread_exit ((void *) 1);
 276                 }
 277
 278                 remote_fd = (int *) malloc (sizeof (int));
 279                 if (remote_fd == NULL)
 280                 {
 281                         char errbuf[1024];
 282                         WARNING ("unixsock plugin: malloc failed: %s",
 283                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 284                         close (status);
 285                         continue;
 286                 }
 287                 *remote_fd = status;
 288
 289                 DEBUG ("Spawning child to handle connection on fd #%i", *remote_fd);
 290
 291                 pthread_attr_init (&th_attr);
 292                 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
 293
 294                 status = pthread_create (&th, &th_attr, us_handle_client, (void *) remote_fd);
 295                 if (status != 0)
 296                 {
 297                         char errbuf[1024];
 298                         WARNING ("unixsock plugin: pthread_create failed: %s",
 299                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 300                         close (*remote_fd);
 301                         free (remote_fd);
 302                         continue;
 303                 }
 304         } /* while (loop) */
 305
 306         close (sock_fd);
 307         sock_fd = -1;
 308
 309         status = unlink ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH);
 310         if (status != 0)
 311         {
 312                 char errbuf[1024];
 313                 NOTICE ("unixsock plugin: unlink (%s) failed: %s",
 314                                 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 315                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 316         }
 317
 318         return ((void *) 0);
 319 } /* void *us_server_thread */
 320
 321 static int us_config (const char *key, const char *val)
 322 {
 323         if (strcasecmp (key, "SocketFile") == 0)
 324         {
 325                 char *new_sock_file = strdup (val);
 326                 if (new_sock_file == NULL)
 327                         return (1);
 328
 329                 sfree (sock_file);
 330                 sock_file = new_sock_file;
 331         }
 332         else if (strcasecmp (key, "SocketGroup") == 0)
 333         {
 334                 char *new_sock_group = strdup (val);
 335                 if (new_sock_group == NULL)
 336                         return (1);
 337
 338                 sfree (sock_group);
 339                 sock_group = new_sock_group;
 340         }
 341         else if (strcasecmp (key, "SocketPerms") == 0)
 342         {
 343                 sock_perms = (int) strtol (val, NULL, 8);
 344         }
 345         else
 346         {
 347                 return (-1);
 348         }
 349
 350         return (0);
 351 } /* int us_config */
 352
 353 static int us_init (void)
 354 {
 355         int status;
 356
 357         loop = 1;
 358
 359         status = pthread_create (&listen_thread, NULL, us_server_thread, NULL);
 360         if (status != 0)
 361         {
 362                 char errbuf[1024];
 363                 ERROR ("unixsock plugin: pthread_create failed: %s",
 364                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 365                 return (-1);
 366         }
 367
 368         return (0);
 369 } /* int us_init */
 370
 371 static int us_shutdown (void)
 372 {
 373         void *ret;
 374
 375         loop = 0;
 376
 377         if (listen_thread != (pthread_t) 0)
 378         {
 379                 pthread_kill (listen_thread, SIGTERM);
 380                 pthread_join (listen_thread, &ret);
 381                 listen_thread = (pthread_t) 0;
 382         }
 383
 384         plugin_unregister_init ("unixsock");
 385         plugin_unregister_shutdown ("unixsock");
 386
 387         return (0);
 388 } /* int us_shutdown */
 389
 390 void module_register (void)
 391 {
 392         plugin_register_config ("unixsock", us_config,
 393                         config_keys, config_keys_num);
 394         plugin_register_init ("unixsock", us_init);
 395         plugin_register_shutdown ("unixsock", us_shutdown);
 396 } /* void module_register (void) */
 397
 398 /* vim: set sw=4 ts=4 sts=4 tw=78 : */