src/unixsock.c

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