src/unixsock.c

   1 /**
   2  * collectd - src/unixsock.c
   3  * Copyright (C) 2007  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 #include "utils_debug.h"
  27
  28 /* Folks without pthread will need to disable this plugin. */
  29 #include <pthread.h>
  30
  31 #include <sys/socket.h>
  32 #include <sys/un.h>
  33 #include <sys/poll.h>
  34
  35 #include <grp.h>
  36
  37 #ifndef UNIX_PATH_MAX
  38 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
  39 #endif
  40
  41 #define US_DEFAULT_PATH PREFIX"/var/run/"PACKAGE_NAME"-unixsock"
  42
  43 /*
  44  * Private data structures
  45  */
  46 /* linked list of cached values */
  47 typedef struct value_cache_s
  48 {
  49         char       name[4*DATA_MAX_NAME_LEN];
  50         int        values_num;
  51         gauge_t   *gauge;
  52         counter_t *counter;
  53         const data_set_t *ds;
  54         time_t     time;
  55         struct value_cache_s *next;
  56 } value_cache_t;
  57
  58 /*
  59  * Private variables
  60  */
  61 /* valid configuration file keys */
  62 static const char *config_keys[] =
  63 {
  64         "SocketFile",
  65         "SocketGroup",
  66         "SocketPerms",
  67         NULL
  68 };
  69 static int config_keys_num = 3;
  70
  71 /* socket configuration */
  72 static int   sock_fd    = -1;
  73 static char *sock_file  = NULL;
  74 static char *sock_group = NULL;
  75 static int   sock_perms = S_IRWXU | S_IRWXG;
  76
  77 static pthread_t listen_thread = (pthread_t) 0;
  78
  79 /* Linked list and auxilliary variables for saving values */
  80 static value_cache_t   *cache_head = NULL;
  81 static pthread_mutex_t  cache_lock = PTHREAD_MUTEX_INITIALIZER;
  82 static unsigned int     cache_oldest = UINT_MAX;
  83
  84 /*
  85  * Functions
  86  */
  87 static value_cache_t *cache_search (const char *name)
  88 {
  89         value_cache_t *vc;
  90
  91         for (vc = cache_head; vc != NULL; vc = vc->next)
  92         {
  93                 if (strcmp (vc->name, name) == 0)
  94                         break;
  95         } /* for vc = cache_head .. NULL */
  96
  97         return (vc);
  98 } /* value_cache_t *cache_search */
  99
 100 static int cache_alloc_name (char *ret, int ret_len,
 101                 const char *hostname,
 102                 const char *plugin, const char *plugin_instance,
 103                 const char *type, const char *type_instance)
 104 {
 105         int  status;
 106
 107         assert (plugin != NULL);
 108         assert (type != NULL);
 109
 110         if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
 111         {
 112                 if ((type_instance == NULL) || (strlen (type_instance) == 0))
 113                         status = snprintf (ret, ret_len, "%s/%s/%s",
 114                                         hostname, plugin, type);
 115                 else
 116                         status = snprintf (ret, ret_len, "%s/%s/%s-%s",
 117                                         hostname, plugin, type, type_instance);
 118         }
 119         else
 120         {
 121                 if ((type_instance == NULL) || (strlen (type_instance) == 0))
 122                         status = snprintf (ret, ret_len, "%s/%s-%s/%s",
 123                                         hostname, plugin, plugin_instance, type);
 124                 else
 125                         status = snprintf (ret, ret_len, "%s/%s-%s/%s-%s",
 126                                         hostname, plugin, plugin_instance, type, type_instance);
 127         }
 128
 129         if ((status < 1) || (status >= ret_len))
 130                 return (-1);
 131         return (0);
 132 } /* int cache_alloc_name */
 133
 134 static int cache_insert (const data_set_t *ds, const value_list_t *vl)
 135 {
 136         /* We're called from `cache_update' so we don't need to lock the mutex */
 137         value_cache_t *vc;
 138         int i;
 139
 140         DBG ("ds->ds_num = %i; vl->values_len = %i;",
 141                         ds->ds_num, vl->values_len);
 142         assert (ds->ds_num == vl->values_len);
 143
 144         vc = (value_cache_t *) malloc (sizeof (value_cache_t));
 145         if (vc == NULL)
 146         {
 147                 pthread_mutex_unlock (&cache_lock);
 148                 syslog (LOG_ERR, "unixsock plugin: malloc failed: %s",
 149                                 strerror (errno));
 150                 return (-1);
 151         }
 152
 153         vc->gauge = (gauge_t *) malloc (sizeof (gauge_t) * vl->values_len);
 154         if (vc->gauge == NULL)
 155         {
 156                 pthread_mutex_unlock (&cache_lock);
 157                 syslog (LOG_ERR, "unixsock plugin: malloc failed: %s",
 158                                 strerror (errno));
 159                 free (vc);
 160                 return (-1);
 161         }
 162
 163         vc->counter = (counter_t *) malloc (sizeof (counter_t) * vl->values_len);
 164         if (vc->counter == NULL)
 165         {
 166                 pthread_mutex_unlock (&cache_lock);
 167                 syslog (LOG_ERR, "unixsock plugin: malloc failed: %s",
 168                                 strerror (errno));
 169                 free (vc->gauge);
 170                 free (vc);
 171                 return (-1);
 172         }
 173
 174         if (cache_alloc_name (vc->name, sizeof (vc->name),
 175                                 vl->host, vl->plugin, vl->plugin_instance,
 176                                 ds->type, vl->type_instance) != 0)
 177         {
 178                 pthread_mutex_unlock (&cache_lock);
 179                 syslog (LOG_ERR, "unixsock plugin: cache_alloc_name failed.");
 180                 free (vc->counter);
 181                 free (vc->gauge);
 182                 free (vc);
 183                 return (-1);
 184         }
 185
 186         for (i = 0; i < ds->ds_num; i++)
 187         {
 188                 if (ds->ds[i].type == DS_TYPE_COUNTER)
 189                 {
 190                         vc->gauge[i] = 0.0;
 191                         vc->counter[i] = vl->values[i].counter;
 192                 }
 193                 else if (ds->ds[i].type == DS_TYPE_GAUGE)
 194                 {
 195                         vc->gauge[i] = vl->values[i].gauge;
 196                         vc->counter[i] = 0;
 197                 }
 198                 else
 199                 {
 200                         vc->gauge[i] = 0.0;
 201                         vc->counter[i] = 0;
 202                 }
 203         }
 204         vc->values_num = ds->ds_num;
 205         vc->ds = ds;
 206
 207         vc->next = cache_head;
 208         cache_head = vc;
 209
 210         vc->time = vl->time;
 211         if (vc->time < cache_oldest)
 212                 cache_oldest = vc->time;
 213
 214         pthread_mutex_unlock (&cache_lock);
 215         return (0);
 216 } /* int cache_insert */
 217
 218 static int cache_update (const data_set_t *ds, const value_list_t *vl)
 219 {
 220         char name[4*DATA_MAX_NAME_LEN];;
 221         value_cache_t *vc;
 222         int i;
 223
 224         if (cache_alloc_name (name, sizeof (name),
 225                                 vl->host,
 226                                 vl->plugin, vl->plugin_instance,
 227                                 ds->type, vl->type_instance) != 0)
 228                 return (-1);
 229
 230         pthread_mutex_lock (&cache_lock);
 231
 232         vc = cache_search (name);
 233
 234         if (vc == NULL)
 235                 return (cache_insert (ds, vl));
 236
 237         assert (vc->values_num == ds->ds_num);
 238         assert (vc->values_num == vl->values_len);
 239
 240         /*
 241          * Update the values. This is possibly a lot more that you'd expect
 242          * because we honor min and max values and handle counter overflows here.
 243          */
 244         for (i = 0; i < ds->ds_num; i++)
 245         {
 246                 if (ds->ds[i].type == DS_TYPE_COUNTER)
 247                 {
 248                         if (vl->values[i].counter < vc->counter[i])
 249                         {
 250                                 if (vl->values[i].counter <= 4294967295U)
 251                                 {
 252                                         vc->gauge[i] = ((4294967295U - vl->values[i].counter)
 253                                                         + vc->counter[i]) / (vl->time - vc->time);
 254                                 }
 255                                 else
 256                                 {
 257                                         vc->gauge[i] = ((18446744073709551615ULL - vl->values[i].counter)
 258                                                 + vc->counter[i]) / (vl->time - vc->time);
 259                                 }
 260                         }
 261                         else
 262                         {
 263                                 vc->gauge[i] = (vl->values[i].counter - vc->counter[i])
 264                                         / (vl->time - vc->time);
 265                         }
 266
 267                         vc->counter[i] = vl->values[i].counter;
 268                 }
 269                 else if (ds->ds[i].type == DS_TYPE_GAUGE)
 270                 {
 271                         vc->gauge[i] = vl->values[i].gauge;
 272                         vc->counter[i] = 0;
 273                 }
 274                 else
 275                 {
 276                         vc->gauge[i] = NAN;
 277                         vc->counter[i] = 0;
 278                 }
 279
 280                 if ((vc->gauge[i] == NAN)
 281                                 || ((ds->ds[i].min != NAN) && (vc->gauge[i] < ds->ds[i].min))
 282                                 || ((ds->ds[i].max != NAN) && (vc->gauge[i] > ds->ds[i].max)))
 283                         vc->gauge[i] = NAN;
 284         } /* for i = 0 .. ds->ds_num */
 285
 286         vc->ds = ds;
 287         vc->time = vl->time;
 288
 289         if (vc->time < cache_oldest)
 290                 cache_oldest = vc->time;
 291
 292         pthread_mutex_unlock (&cache_lock);
 293         return (0);
 294 } /* int cache_update */
 295
 296 static void cache_flush (int max_age)
 297 {
 298         value_cache_t *this;
 299         value_cache_t *prev;
 300         time_t now;
 301
 302         pthread_mutex_lock (&cache_lock);
 303
 304         now = time (NULL);
 305
 306         if ((now - cache_oldest) <= max_age)
 307         {
 308                 pthread_mutex_unlock (&cache_lock);
 309                 return;
 310         }
 311
 312         cache_oldest = now;
 313
 314         prev = NULL;
 315         this = cache_head;
 316
 317         while (this != NULL)
 318         {
 319                 if ((now - this->time) <= max_age)
 320                 {
 321                         if (this->time < cache_oldest)
 322                                 cache_oldest = this->time;
 323
 324                         prev = this;
 325                         this = this->next;
 326                         continue;
 327                 }
 328
 329                 if (prev == NULL)
 330                         cache_head = this->next;
 331                 else
 332                         prev->next = this->next;
 333
 334                 free (this->gauge);
 335                 free (this->counter);
 336                 free (this);
 337
 338                 if (prev == NULL)
 339                         this = cache_head;
 340                 else
 341                         this = prev->next;
 342         } /* while (this != NULL) */
 343
 344         pthread_mutex_unlock (&cache_lock);
 345 } /* int cache_flush */
 346
 347 static int us_open_socket (void)
 348 {
 349         struct sockaddr_un sa;
 350         int status;
 351
 352         sock_fd = socket (PF_UNIX, SOCK_STREAM, 0);
 353         if (sock_fd < 0)
 354         {
 355                 syslog (LOG_ERR, "unixsock plugin: socket failed: %s",
 356                                 strerror (errno));
 357                 return (-1);
 358         }
 359
 360         memset (&sa, '\0', sizeof (sa));
 361         sa.sun_family = AF_UNIX;
 362         strncpy (sa.sun_path, (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 363                         sizeof (sa.sun_path) - 1);
 364         /* unlink (sa.sun_path); */
 365
 366         status = bind (sock_fd, (struct sockaddr *) &sa, sizeof (sa));
 367         if (status != 0)
 368         {
 369                 DBG ("bind failed: %s; sa.sun_path = %s",
 370                                 strerror (errno), sa.sun_path);
 371                 syslog (LOG_ERR, "unixsock plugin: bind failed: %s",
 372                                 strerror (errno));
 373                 close (sock_fd);
 374                 sock_fd = -1;
 375                 return (-1);
 376         }
 377
 378         status = listen (sock_fd, 8);
 379         if (status != 0)
 380         {
 381                 syslog (LOG_ERR, "unixsock plugin: listen failed: %s",
 382                                 strerror (errno));
 383                 close (sock_fd);
 384                 sock_fd = -1;
 385                 return (-1);
 386         }
 387
 388         do
 389         {
 390                 struct group *g;
 391
 392                 errno = 0;
 393                 g = getgrnam ((sock_group != NULL) ? sock_group : COLLECTD_GRP_NAME);
 394
 395                 if (errno != 0)
 396                 {
 397                         syslog (LOG_WARNING, "unixsock plugin: getgrnam (%s) failed: %s",
 398                                         (sock_group != NULL) ? sock_group : COLLECTD_GRP_NAME,
 399                                         strerror (errno));
 400                         break;
 401                 }
 402
 403                 if (g == NULL)
 404                         break;
 405
 406                 if (chown ((sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 407                                         (uid_t) -1, g->gr_gid) != 0)
 408                 {
 409                         syslog (LOG_WARNING, "unixsock plugin: chown (%s, -1, %i) failed: %s",
 410                                         (sock_file != NULL) ? sock_file : US_DEFAULT_PATH,
 411                                         (int) g->gr_gid,
 412                                         strerror (errno));
 413                 }
 414         } while (0);
 415
 416         return (0);
 417 } /* int us_open_socket */
 418
 419 static int us_handle_getval (FILE *fh, char **fields, int fields_num)
 420 {
 421         char *hostname = fields[1];
 422         char *plugin;
 423         char *plugin_instance;
 424         char *type;
 425         char *type_instance;
 426         char  name[4*DATA_MAX_NAME_LEN];
 427         value_cache_t *vc;
 428         int   status;
 429         int   i;
 430
 431         if (fields_num != 2)
 432                 return (-1);
 433
 434         plugin = strchr (hostname, '/');
 435         if (plugin == NULL)
 436                 return (-1);
 437         *plugin = '\0'; plugin++;
 438
 439         type = strchr (plugin, '/');
 440         if (type == NULL)
 441                 return (-1);
 442         *type = '\0'; type++;
 443
 444         plugin_instance = strchr (plugin, '-');
 445         if (plugin_instance != NULL)
 446         {
 447                 *plugin_instance = '\0';
 448                 plugin_instance++;
 449         }
 450
 451         type_instance = strchr (type, '-');
 452         if (type_instance != NULL)
 453         {
 454                 *type_instance = '\0';
 455                 type_instance++;
 456         }
 457
 458         status = cache_alloc_name (name, sizeof (name),
 459                         hostname, plugin, plugin_instance, type, type_instance);
 460         if (status != 0)
 461                 return (-1);
 462
 463         pthread_mutex_lock (&cache_lock);
 464
 465         DBG ("vc = cache_search (%s)", name);
 466         vc = cache_search (name);
 467
 468         if (vc == NULL)
 469         {
 470                 DBG ("Did not find cache entry.");
 471                 fprintf (fh, "-1 No such value");
 472         }
 473         else
 474         {
 475                 DBG ("Found cache entry.");
 476                 fprintf (fh, "%i", vc->values_num);
 477                 for (i = 0; i < vc->values_num; i++)
 478                 {
 479                         fprintf (fh, " %s=", vc->ds->ds[i].name);
 480                         if (vc->gauge[i] == NAN)
 481                                 fprintf (fh, "NaN");
 482                         else
 483                                 fprintf (fh, "%12e", vc->gauge[i]);
 484                 }
 485         }
 486
 487         /* Free the mutex as soon as possible and definitely before flushing */
 488         pthread_mutex_unlock (&cache_lock);
 489
 490         fprintf (fh, "\n");
 491         fflush (fh);
 492
 493         return (0);
 494 } /* int us_handle_getval */
 495
 496 static void *us_handle_client (void *arg)
 497 {
 498         int fd;
 499         FILE *fh;
 500         char buffer[1024];
 501         char *fields[128];
 502         int   fields_num;
 503
 504         fd = *((int *) arg);
 505         free (arg);
 506         arg = NULL;
 507
 508         DBG ("Reading from fd #%i", fd);
 509
 510         fh = fdopen (fd, "r+");
 511         if (fh == NULL)
 512         {
 513                 syslog (LOG_ERR, "unixsock plugin: fdopen failed: %s",
 514                                 strerror (errno));
 515                 close (fd);
 516                 pthread_exit ((void *) 1);
 517         }
 518
 519         while (fgets (buffer, sizeof (buffer), fh) != NULL)
 520         {
 521                 int len;
 522
 523                 len = strlen (buffer);
 524                 while ((len > 0)
 525                                 && ((buffer[len - 1] == '\n') || (buffer[len - 1] == '\r')))
 526                         buffer[--len] = '\0';
 527
 528                 if (len == 0)
 529                         continue;
 530
 531                 DBG ("fgets -> buffer = %s; len = %i;", buffer, len);
 532
 533                 fields_num = strsplit (buffer, fields,
 534                                 sizeof (fields) / sizeof (fields[0]));
 535
 536                 if (fields_num < 1)
 537                 {
 538                         close (fd);
 539                         break;
 540                 }
 541
 542                 if (strcasecmp (fields[0], "getval") == 0)
 543                 {
 544                         us_handle_getval (fh, fields, fields_num);
 545                 }
 546                 else
 547                 {
 548                         fprintf (fh, "Unknown command: %s\n", fields[0]);
 549                         fflush (fh);
 550                 }
 551         } /* while (fgets) */
 552
 553         DBG ("Exiting..");
 554         close (fd);
 555
 556         pthread_exit ((void *) 0);
 557 } /* void *us_handle_client */
 558
 559 static void *us_server_thread (void *arg)
 560 {
 561         int  status;
 562         int *remote_fd;
 563         pthread_t th;
 564         pthread_attr_t th_attr;
 565
 566         if (us_open_socket () != 0)
 567                 pthread_exit ((void *) 1);
 568
 569         while (42)
 570         {
 571                 DBG ("Calling accept..");
 572                 status = accept (sock_fd, NULL, NULL);
 573                 if (status < 0)
 574                 {
 575                         if (errno == EINTR)
 576                                 continue;
 577
 578                         syslog (LOG_ERR, "unixsock plugin: accept failed: %s",
 579                                         strerror (errno));
 580                         close (sock_fd);
 581                         sock_fd = -1;
 582                         pthread_exit ((void *) 1);
 583                 }
 584
 585                 remote_fd = (int *) malloc (sizeof (int));
 586                 if (remote_fd == NULL)
 587                 {
 588                         syslog (LOG_WARNING, "unixsock plugin: malloc failed: %s",
 589                                         strerror (errno));
 590                         close (status);
 591                         continue;
 592                 }
 593                 *remote_fd = status;
 594
 595                 DBG ("Spawning child to handle connection on fd #%i", *remote_fd);
 596
 597                 pthread_attr_init (&th_attr);
 598                 pthread_attr_setdetachstate (&th_attr, PTHREAD_CREATE_DETACHED);
 599
 600                 status = pthread_create (&th, &th_attr, us_handle_client, (void *) remote_fd);
 601                 if (status != 0)
 602                 {
 603                         syslog (LOG_WARNING, "unixsock plugin: pthread_create failed: %s",
 604                                         strerror (status));
 605                         close (*remote_fd);
 606                         free (remote_fd);
 607                         continue;
 608                 }
 609         } /* while (42) */
 610
 611         return ((void *) 0);
 612 } /* void *us_server_thread */
 613
 614 static int us_config (const char *key, const char *val)
 615 {
 616         if (strcasecmp (key, "SocketFile") == 0)
 617         {
 618                 sfree (sock_file);
 619                 sock_file = strdup (val);
 620         }
 621         else if (strcasecmp (key, "SocketGroup") == 0)
 622         {
 623                 sfree (sock_group);
 624                 sock_group = strdup (val);
 625         }
 626         else if (strcasecmp (key, "SocketPerms") == 0)
 627         {
 628                 sock_perms = (int) strtol (val, NULL, 8);
 629         }
 630         else
 631         {
 632                 return (-1);
 633         }
 634
 635         return (0);
 636 } /* int us_config */
 637
 638 static int us_init (void)
 639 {
 640         int status;
 641
 642         status = pthread_create (&listen_thread, NULL, us_server_thread, NULL);
 643         if (status != 0)
 644         {
 645                 syslog (LOG_ERR, "unixsock plugin: pthread_create failed: %s",
 646                                 strerror (status));
 647                 return (-1);
 648         }
 649
 650         return (0);
 651 } /* int us_init */
 652
 653 static int us_shutdown (void)
 654 {
 655         void *ret;
 656
 657         if (listen_thread != (pthread_t) 0)
 658         {
 659                 pthread_kill (listen_thread, SIGTERM);
 660                 pthread_join (listen_thread, &ret);
 661                 listen_thread = (pthread_t) 0;
 662         }
 663
 664         plugin_unregister_init ("unixsock");
 665         plugin_unregister_write ("unixsock");
 666         plugin_unregister_shutdown ("unixsock");
 667
 668         return (0);
 669 } /* int us_shutdown */
 670
 671 static int us_write (const data_set_t *ds, const value_list_t *vl)
 672 {
 673         cache_update (ds, vl);
 674         cache_flush (2 * atoi (COLLECTD_STEP));
 675
 676         return (0);
 677 }
 678
 679 void module_register (void)
 680 {
 681         plugin_register_config ("unixsock", us_config,
 682                         config_keys, config_keys_num);
 683         plugin_register_init ("unixsock", us_init);
 684         plugin_register_write ("unixsock", us_write);
 685         plugin_register_shutdown ("unixsock", us_shutdown);
 686 } /* void module_register (void) */
 687
 688 /* vim: set sw=4 ts=4 sts=4 tw=78 : */