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