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         sstrncpy (sa.sun_path, (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
  90                         sizeof (sa.sun_path));
  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 fdin;
 161         int fdout;
 162         FILE *fhin, *fhout;
 163
 164         fdin = *((int *) arg);
 165         free (arg);
 166         arg = NULL;
 167
 168         DEBUG ("unixsock plugin: us_handle_client: Reading from fd #%i", fdin);
 169
 170         fdout = dup (fdin);
 171         if (fdout < 0)
 172         {
 173                 char errbuf[1024];
 174                 ERROR ("unixsock plugin: dup failed: %s",
 175                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 176                 close (fdin);
 177                 pthread_exit ((void *) 1);
 178         }
 179
 180         fhin  = fdopen (fdin, "r");
 181         if (fhin == NULL)
 182         {
 183                 char errbuf[1024];
 184                 ERROR ("unixsock plugin: fdopen failed: %s",
 185                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 186                 close (fdin);
 187                 close (fdout);
 188                 pthread_exit ((void *) 1);
 189         }
 190
 191         fhout = fdopen (fdout, "w");
 192         if (fhout == NULL)
 193         {
 194                 char errbuf[1024];
 195                 ERROR ("unixsock plugin: fdopen failed: %s",
 196                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 197                 fclose (fhin); /* this closes fdin as well */
 198                 close (fdout);
 199                 pthread_exit ((void *) 1);
 200         }
 201
 202         /* change output buffer to line buffered mode */
 203         if (setvbuf (fhout, NULL, _IOLBF, 0) != 0)
 204         {
 205                 char errbuf[1024];
 206                 ERROR ("unixsock plugin: setvbuf failed: %s",
 207                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 208                 fclose (fhin);
 209                 fclose (fhout);
 210                 pthread_exit ((void *) 1);
 211         }
 212
 213         while (42)
 214         {
 215                 char buffer[1024];
 216                 char buffer_copy[1024];
 217                 char *fields[128];
 218                 int   fields_num;
 219                 int   len;
 220
 221                 errno = 0;
 222                 if (fgets (buffer, sizeof (buffer), fhin) == NULL)
 223                 {
 224                         if (errno != 0)
 225                         {
 226                                 char errbuf[1024];
 227                                 WARNING ("unixsock plugin: failed to read from socket #%i: %s",
 228                                                 fileno (fhin),
 229                                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 230                         }
 231                         break;
 232                 }
 233
 234                 len = strlen (buffer);
 235                 while ((len > 0)
 236                                 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
 237                         buffer[--len] = '\0';
 238
 239                 if (len == 0)
 240                         continue;
 241
 242                 sstrncpy (buffer_copy, buffer, sizeof (buffer_copy));
 243
 244                 fields_num = strsplit (buffer_copy, fields,
 245                                 sizeof (fields) / sizeof (fields[0]));
 246                 if (fields_num < 1)
 247                 {
 248                         fprintf (fhout, "-1 Internal error\n");
 249                         fclose (fhin);
 250                         fclose (fhout);
 251                         pthread_exit ((void *) 1);
 252                 }
 253
 254                 if (strcasecmp (fields[0], "getval") == 0)
 255                 {
 256                         handle_getval (fhout, buffer);
 257                 }
 258                 else if (strcasecmp (fields[0], "putval") == 0)
 259                 {
 260                         handle_putval (fhout, buffer);
 261                 }
 262                 else if (strcasecmp (fields[0], "listval") == 0)
 263                 {
 264                         handle_listval (fhout, buffer);
 265                 }
 266                 else if (strcasecmp (fields[0], "putnotif") == 0)
 267                 {
 268                         handle_putnotif (fhout, buffer);
 269                 }
 270                 else if (strcasecmp (fields[0], "flush") == 0)
 271                 {
 272                         handle_flush (fhout, buffer);
 273                 }
 274                 else
 275                 {
 276                         if (fprintf (fhout, "-1 Unknown command: %s\n", fields[0]) < 0)
 277                         {
 278                                 char errbuf[1024];
 279                                 WARNING ("unixsock plugin: failed to write to socket #%i: %s",
 280                                                 fileno (fhout),
 281                                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 282                                 break;
 283                         }
 284                 }
 285         } /* while (fgets) */
 286
 287         DEBUG ("unixsock plugin: us_handle_client: Exiting..");
 288         fclose (fhin);
 289         fclose (fhout);
 290
 291         pthread_exit ((void *) 0);
 292         return ((void *) 0);
 293 } /* void *us_handle_client */
 294
 295 static void *us_server_thread (void __attribute__((unused)) *arg)
 296 {
 297         int  status;
 298         int *remote_fd;
 299         pthread_t th;
 300         pthread_attr_t th_attr;
 301
 302         if (us_open_socket () != 0)
 303                 pthread_exit ((void *) 1);
 304
 305         while (loop != 0)
 306         {
 307                 DEBUG ("unixsock plugin: Calling accept..");
 308                 status = accept (sock_fd, NULL, NULL);
 309                 if (status < 0)
 310                 {
 311                         char errbuf[1024];
 312
 313                         if (errno == EINTR)
 314                                 continue;
 315
 316                         ERROR ("unixsock plugin: accept failed: %s",
 317                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 318                         close (sock_fd);
 319                         sock_fd = -1;
 320                         pthread_exit ((void *) 1);
 321                 }
 322
 323                 remote_fd = (int *) malloc (sizeof (int));
 324                 if (remote_fd == NULL)
 325                 {
 326                         char errbuf[1024];
 327                         WARNING ("unixsock plugin: malloc failed: %s",
 328                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 329                         close (status);
 330                         continue;
 331                 }
 332                 *remote_fd = status;
 333
 334                 DEBUG ("Spawning child to handle connection on fd #%i", *remote_fd);
 335
 336                 pthread_attr_init (&th_attr);
 337                 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
 338
 339                 status = pthread_create (&th, &th_attr, us_handle_client, (void *) remote_fd);
 340                 if (status != 0)
 341                 {
 342                         char errbuf[1024];
 343                         WARNING ("unixsock plugin: pthread_create failed: %s",
 344                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 345                         close (*remote_fd);
 346                         free (remote_fd);
 347                         continue;
 348                 }
 349         } /* while (loop) */
 350
 351         close (sock_fd);
 352         sock_fd = -1;
 353
 354         status = unlink ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH);
 355         if (status != 0)
 356         {
 357                 char errbuf[1024];
 358                 NOTICE ("unixsock plugin: unlink (%s) failed: %s",
 359                                 (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 360                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 361         }
 362
 363         return ((void *) 0);
 364 } /* void *us_server_thread */
 365
 366 static int us_config (const char *key, const char *val)
 367 {
 368         if (strcasecmp (key, "SocketFile") == 0)
 369         {
 370                 char *new_sock_file = strdup (val);
 371                 if (new_sock_file == NULL)
 372                         return (1);
 373
 374                 sfree (sock_file);
 375                 sock_file = new_sock_file;
 376         }
 377         else if (strcasecmp (key, "SocketGroup") == 0)
 378         {
 379                 char *new_sock_group = strdup (val);
 380                 if (new_sock_group == NULL)
 381                         return (1);
 382
 383                 sfree (sock_group);
 384                 sock_group = new_sock_group;
 385         }
 386         else if (strcasecmp (key, "SocketPerms") == 0)
 387         {
 388                 sock_perms = (int) strtol (val, NULL, 8);
 389         }
 390         else
 391         {
 392                 return (-1);
 393         }
 394
 395         return (0);
 396 } /* int us_config */
 397
 398 static int us_init (void)
 399 {
 400         static int have_init = 0;
 401
 402         int status;
 403
 404         /* Initialize only once. */
 405         if (have_init != 0)
 406                 return (0);
 407         have_init = 1;
 408
 409         loop = 1;
 410
 411         status = pthread_create (&listen_thread, NULL, us_server_thread, NULL);
 412         if (status != 0)
 413         {
 414                 char errbuf[1024];
 415                 ERROR ("unixsock plugin: pthread_create failed: %s",
 416                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 417                 return (-1);
 418         }
 419
 420         return (0);
 421 } /* int us_init */
 422
 423 static int us_shutdown (void)
 424 {
 425         void *ret;
 426
 427         loop = 0;
 428
 429         if (listen_thread != (pthread_t) 0)
 430         {
 431                 pthread_kill (listen_thread, SIGTERM);
 432                 pthread_join (listen_thread, &ret);
 433                 listen_thread = (pthread_t) 0;
 434         }
 435
 436         plugin_unregister_init ("unixsock");
 437         plugin_unregister_shutdown ("unixsock");
 438
 439         return (0);
 440 } /* int us_shutdown */
 441
 442 void module_register (void)
 443 {
 444         plugin_register_config ("unixsock", us_config,
 445                         config_keys, config_keys_num);
 446         plugin_register_init ("unixsock", us_init);
 447         plugin_register_shutdown ("unixsock", us_shutdown);
 448 } /* void module_register (void) */
 449
 450 /* vim: set sw=4 ts=4 sts=4 tw=78 : */