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 "common.h"
  30 #include "plugin.h"
  31
  32 #include "utils_cmd_flush.h"
  33 #include "utils_cmd_getthreshold.h"
  34 #include "utils_cmd_getval.h"
  35 #include "utils_cmd_listval.h"
  36 #include "utils_cmd_putnotif.h"
  37 #include "utils_cmd_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 = 0;
  59
  60 /* socket configuration */
  61 static int sock_fd = -1;
  62 static char *sock_file = NULL;
  63 static char *sock_group = NULL;
  64 static int sock_perms = S_IRWXU | S_IRWXG;
  65 static _Bool delete_socket = 0;
  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     int len;
 212
 213     errno = 0;
 214     if (fgets(buffer, sizeof(buffer), fhin) == NULL) {
 215       if ((errno == EINTR) || (errno == EAGAIN))
 216         continue;
 217
 218       if (errno != 0) {
 219         WARNING("unixsock plugin: failed to read from socket #%i: %s",
 220                 fileno(fhin), STRERRNO);
 221       }
 222       break;
 223     }
 224
 225     len = strlen(buffer);
 226     while ((len > 0) &&
 227            ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
 228       buffer[--len] = '\0';
 229
 230     if (len == 0)
 231       continue;
 232
 233     sstrncpy(buffer_copy, buffer, sizeof(buffer_copy));
 234
 235     fields_num =
 236         strsplit(buffer_copy, fields, sizeof(fields) / sizeof(fields[0]));
 237     if (fields_num < 1) {
 238       fprintf(fhout, "-1 Internal error\n");
 239       fclose(fhin);
 240       fclose(fhout);
 241       pthread_exit((void *)1);
 242       return (void *)1;
 243     }
 244
 245     if (strcasecmp(fields[0], "getval") == 0) {
 246       cmd_handle_getval(fhout, buffer);
 247     } else if (strcasecmp(fields[0], "getthreshold") == 0) {
 248       handle_getthreshold(fhout, buffer);
 249     } else if (strcasecmp(fields[0], "putval") == 0) {
 250       cmd_handle_putval(fhout, buffer);
 251     } else if (strcasecmp(fields[0], "listval") == 0) {
 252       cmd_handle_listval(fhout, buffer);
 253     } else if (strcasecmp(fields[0], "putnotif") == 0) {
 254       handle_putnotif(fhout, buffer);
 255     } else if (strcasecmp(fields[0], "flush") == 0) {
 256       cmd_handle_flush(fhout, buffer);
 257     } else {
 258       if (fprintf(fhout, "-1 Unknown command: %s\n", fields[0]) < 0) {
 259         WARNING("unixsock plugin: failed to write to socket #%i: %s",
 260                 fileno(fhout), STRERRNO);
 261         break;
 262       }
 263     }
 264   } /* while (fgets) */
 265
 266   DEBUG("unixsock plugin: us_handle_client: Exiting..");
 267   fclose(fhin);
 268   fclose(fhout);
 269
 270   pthread_exit((void *)0);
 271   return (void *)0;
 272 } /* void *us_handle_client */
 273
 274 static void *us_server_thread(void __attribute__((unused)) * arg) {
 275   int status;
 276   int *remote_fd;
 277   pthread_t th;
 278   pthread_attr_t th_attr;
 279
 280   pthread_attr_init(&th_attr);
 281   pthread_attr_setdetachstate(&th_attr, PTHREAD_CREATE_DETACHED);
 282
 283   if (us_open_socket() != 0)
 284     pthread_exit((void *)1);
 285
 286   while (loop != 0) {
 287     DEBUG("unixsock plugin: Calling accept..");
 288     status = accept(sock_fd, NULL, NULL);
 289     if (status < 0) {
 290
 291       if (errno == EINTR)
 292         continue;
 293
 294       ERROR("unixsock plugin: accept failed: %s", STRERRNO);
 295       close(sock_fd);
 296       sock_fd = -1;
 297       pthread_attr_destroy(&th_attr);
 298       pthread_exit((void *)1);
 299     }
 300
 301     remote_fd = malloc(sizeof(*remote_fd));
 302     if (remote_fd == NULL) {
 303       WARNING("unixsock plugin: malloc failed: %s", STRERRNO);
 304       close(status);
 305       continue;
 306     }
 307     *remote_fd = status;
 308
 309     DEBUG("Spawning child to handle connection on fd #%i", *remote_fd);
 310
 311     status = plugin_thread_create(&th, &th_attr, us_handle_client,
 312                                   (void *)remote_fd, "unixsock conn");
 313     if (status != 0) {
 314       WARNING("unixsock plugin: pthread_create failed: %s", STRERRNO);
 315       close(*remote_fd);
 316       free(remote_fd);
 317       continue;
 318     }
 319   } /* while (loop) */
 320
 321   close(sock_fd);
 322   sock_fd = -1;
 323   pthread_attr_destroy(&th_attr);
 324
 325   status = unlink((sock_file != NULL) ? sock_file : US_DEFAULT_PATH);
 326   if (status != 0) {
 327     NOTICE("unixsock plugin: unlink (%s) failed: %s",
 328            (sock_file != NULL) ? sock_file : US_DEFAULT_PATH, STRERRNO);
 329   }
 330
 331   return (void *)0;
 332 } /* void *us_server_thread */
 333
 334 static int us_config(const char *key, const char *val) {
 335   if (strcasecmp(key, "SocketFile") == 0) {
 336     char *new_sock_file = strdup(val);
 337     if (new_sock_file == NULL)
 338       return 1;
 339
 340     sfree(sock_file);
 341     sock_file = new_sock_file;
 342   } else if (strcasecmp(key, "SocketGroup") == 0) {
 343     char *new_sock_group = strdup(val);
 344     if (new_sock_group == NULL)
 345       return 1;
 346
 347     sfree(sock_group);
 348     sock_group = new_sock_group;
 349   } else if (strcasecmp(key, "SocketPerms") == 0) {
 350     sock_perms = (int)strtol(val, NULL, 8);
 351   } else if (strcasecmp(key, "DeleteSocket") == 0) {
 352     if (IS_TRUE(val))
 353       delete_socket = 1;
 354     else
 355       delete_socket = 0;
 356   } else {
 357     return -1;
 358   }
 359
 360   return 0;
 361 } /* int us_config */
 362
 363 static int us_init(void) {
 364   static int have_init = 0;
 365
 366   int status;
 367
 368   /* Initialize only once. */
 369   if (have_init != 0)
 370     return 0;
 371   have_init = 1;
 372
 373   loop = 1;
 374
 375   status = plugin_thread_create(&listen_thread, NULL, us_server_thread, NULL,
 376                                 "unixsock listen");
 377   if (status != 0) {
 378     ERROR("unixsock plugin: pthread_create failed: %s", STRERRNO);
 379     return -1;
 380   }
 381
 382   return 0;
 383 } /* int us_init */
 384
 385 static int us_shutdown(void) {
 386   void *ret;
 387
 388   loop = 0;
 389
 390   if (listen_thread != (pthread_t)0) {
 391     pthread_kill(listen_thread, SIGTERM);
 392     pthread_join(listen_thread, &ret);
 393     listen_thread = (pthread_t)0;
 394   }
 395
 396   plugin_unregister_init("unixsock");
 397   plugin_unregister_shutdown("unixsock");
 398
 399   return 0;
 400 } /* int us_shutdown */
 401
 402 void module_register(void) {
 403   plugin_register_config("unixsock", us_config, config_keys, config_keys_num);
 404   plugin_register_init("unixsock", us_init);
 405   plugin_register_shutdown("unixsock", us_shutdown);
 406 } /* void module_register (void) */