parse_identifier: Make hostname optional, if a default has been specified.
[collectd.git] / src / daemon / common.c
1 /**
2  * collectd - src/common.c
3  * Copyright (C) 2005-2014  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  *   Niki W. Waibel <niki.waibel@gmx.net>
26  *   Sebastian Harl <sh at tokkee.org>
27  *   Michał Mirosław <mirq-linux at rere.qmqm.pl>
28 **/
29
30 #if HAVE_CONFIG_H
31 # include "config.h"
32 #endif
33
34 #include "collectd.h"
35
36 #include "common.h"
37 #include "plugin.h"
38 #include "utils_cache.h"
39
40 #ifdef HAVE_MATH_H
41 # include <math.h>
42 #endif
43
44 /* for getaddrinfo */
45 #include <sys/types.h>
46 #include <netdb.h>
47
48 #include <poll.h>
49
50 #if HAVE_NETINET_IN_H
51 # include <netinet/in.h>
52 #endif
53
54 #if HAVE_NETINET_TCP_H
55 # include <netinet/tcp.h>
56 #endif
57
58 /* for ntohl and htonl */
59 #if HAVE_ARPA_INET_H
60 # include <arpa/inet.h>
61 #endif
62
63 #ifdef HAVE_SYS_CAPABILITY_H
64 # include <sys/capability.h>
65 #endif
66
67 #ifdef HAVE_LIBKSTAT
68 extern kstat_ctl_t *kc;
69 #endif
70
71 #if !HAVE_GETPWNAM_R
72 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
73 #endif
74
75 #if !HAVE_STRERROR_R
76 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
77 #endif
78
79 char *sstrncpy (char *dest, const char *src, size_t n)
80 {
81         strncpy (dest, src, n);
82         dest[n - 1] = '\0';
83
84         return (dest);
85 } /* char *sstrncpy */
86
87 int ssnprintf (char *dest, size_t n, const char *format, ...)
88 {
89         int ret = 0;
90         va_list ap;
91
92         va_start (ap, format);
93         ret = vsnprintf (dest, n, format, ap);
94         dest[n - 1] = '\0';
95         va_end (ap);
96
97         return (ret);
98 } /* int ssnprintf */
99
100 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
101 {
102         char static_buffer[1024] = "";
103         char *alloc_buffer;
104         size_t alloc_buffer_size;
105         int status;
106         va_list ap;
107
108         /* Try printing into the static buffer. In many cases it will be
109          * sufficiently large and we can simply return a strdup() of this
110          * buffer. */
111         va_start (ap, format);
112         status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
113         va_end (ap);
114         if (status < 0)
115                 return (NULL);
116
117         /* "status" does not include the null byte. */
118         alloc_buffer_size = (size_t) (status + 1);
119         if (alloc_buffer_size <= sizeof (static_buffer))
120                 return (strdup (static_buffer));
121
122         /* Allocate a buffer large enough to hold the string. */
123         alloc_buffer = calloc (1, alloc_buffer_size);
124         if (alloc_buffer == NULL)
125                 return (NULL);
126
127         /* Print again into this new buffer. */
128         va_start (ap, format);
129         status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
130         va_end (ap);
131         if (status < 0)
132         {
133                 sfree (alloc_buffer);
134                 return (NULL);
135         }
136
137         return (alloc_buffer);
138 } /* }}} char *ssnprintf_alloc */
139
140 char *sstrdup (const char *s)
141 {
142         char *r;
143         size_t sz;
144
145         if (s == NULL)
146                 return (NULL);
147
148         /* Do not use `strdup' here, because it's not specified in POSIX. It's
149          * ``only'' an XSI extension. */
150         sz = strlen (s) + 1;
151         r = malloc (sz);
152         if (r == NULL)
153         {
154                 ERROR ("sstrdup: Out of memory.");
155                 exit (3);
156         }
157         memcpy (r, s, sizeof (char) * sz);
158
159         return (r);
160 } /* char *sstrdup */
161
162 /* Even though Posix requires "strerror_r" to return an "int",
163  * some systems (e.g. the GNU libc) return a "char *" _and_
164  * ignore the second argument ... -tokkee */
165 char *sstrerror (int errnum, char *buf, size_t buflen)
166 {
167         buf[0] = '\0';
168
169 #if !HAVE_STRERROR_R
170         {
171                 char *temp;
172
173                 pthread_mutex_lock (&strerror_r_lock);
174
175                 temp = strerror (errnum);
176                 sstrncpy (buf, temp, buflen);
177
178                 pthread_mutex_unlock (&strerror_r_lock);
179         }
180 /* #endif !HAVE_STRERROR_R */
181
182 #elif STRERROR_R_CHAR_P
183         {
184                 char *temp;
185                 temp = strerror_r (errnum, buf, buflen);
186                 if (buf[0] == '\0')
187                 {
188                         if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
189                                 sstrncpy (buf, temp, buflen);
190                         else
191                                 sstrncpy (buf, "strerror_r did not return "
192                                                 "an error message", buflen);
193                 }
194         }
195 /* #endif STRERROR_R_CHAR_P */
196
197 #else
198         if (strerror_r (errnum, buf, buflen) != 0)
199         {
200                 ssnprintf (buf, buflen, "Error #%i; "
201                                 "Additionally, strerror_r failed.",
202                                 errnum);
203         }
204 #endif /* STRERROR_R_CHAR_P */
205
206         return (buf);
207 } /* char *sstrerror */
208
209 void *smalloc (size_t size)
210 {
211         void *r;
212
213         if ((r = malloc (size)) == NULL)
214         {
215                 ERROR ("Not enough memory.");
216                 exit (3);
217         }
218
219         return (r);
220 } /* void *smalloc */
221
222 #if 0
223 void sfree (void **ptr)
224 {
225         if (ptr == NULL)
226                 return;
227
228         if (*ptr != NULL)
229                 free (*ptr);
230
231         *ptr = NULL;
232 }
233 #endif
234
235 ssize_t sread (int fd, void *buf, size_t count)
236 {
237         char    *ptr;
238         size_t   nleft;
239         ssize_t  status;
240
241         ptr   = (char *) buf;
242         nleft = count;
243
244         while (nleft > 0)
245         {
246                 status = read (fd, (void *) ptr, nleft);
247
248                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
249                         continue;
250
251                 if (status < 0)
252                         return (status);
253
254                 if (status == 0)
255                 {
256                         DEBUG ("Received EOF from fd %i. "
257                                         "Closing fd and returning error.",
258                                         fd);
259                         close (fd);
260                         return (-1);
261                 }
262
263                 assert ((0 > status) || (nleft >= (size_t)status));
264
265                 nleft = nleft - ((size_t) status);
266                 ptr   = ptr   + ((size_t) status);
267         }
268
269         return (0);
270 }
271
272
273 ssize_t swrite (int fd, const void *buf, size_t count)
274 {
275         const char *ptr;
276         size_t      nleft;
277         ssize_t     status;
278         struct      pollfd pfd;
279
280         ptr   = (const char *) buf;
281         nleft = count;
282         
283         if (fd < 0)
284                 return (-1);
285
286         /* checking for closed peer connection */
287         pfd.fd = fd;
288         pfd.events = POLLIN | POLLHUP;
289         pfd.revents = 0;
290         if (poll(&pfd, 1, 0) > 0) {
291                 char buffer[32];
292                 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
293                         // if recv returns zero (even though poll() said there is data to be read),
294                         // that means the connection has been closed
295                         return -1;
296                 }
297         }
298
299         while (nleft > 0)
300         {
301                 status = write (fd, (const void *) ptr, nleft);
302
303                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
304                         continue;
305
306                 if (status < 0)
307                         return (status);
308
309                 nleft = nleft - ((size_t) status);
310                 ptr   = ptr   + ((size_t) status);
311         }
312
313         return (0);
314 }
315
316 int strsplit (char *string, char **fields, size_t size)
317 {
318         size_t i;
319         char *ptr;
320         char *saveptr;
321
322         i = 0;
323         ptr = string;
324         saveptr = NULL;
325         while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
326         {
327                 ptr = NULL;
328                 i++;
329
330                 if (i >= size)
331                         break;
332         }
333
334         return ((int) i);
335 }
336
337 int strjoin(char *buffer, size_t buffer_size, char **fields, size_t fields_num,
338             const char *sep) {
339   size_t avail = 0;
340   char *ptr = buffer;
341   size_t sep_len = 0;
342
343   size_t buffer_req = 0;
344
345   if (((fields_num != 0) && (fields == NULL)) ||
346       ((buffer_size != 0) && (buffer == NULL)))
347     return (-EINVAL);
348
349   if (buffer != NULL)
350     buffer[0] = 0;
351
352   if (buffer_size != 0)
353     avail = buffer_size - 1;
354
355   if (sep != NULL)
356     sep_len = strlen(sep);
357
358   for (size_t i = 0; i < fields_num; i++) {
359     size_t field_len = strlen(fields[i]);
360
361     if (i != 0)
362       buffer_req += sep_len;
363     buffer_req += field_len;
364
365     if ((i != 0) && (sep_len > 0)) {
366       if (sep_len >= avail) {
367         /* prevent subsequent iterations from writing to the
368          * buffer. */
369         avail = 0;
370         continue;
371       }
372
373       memcpy(ptr, sep, sep_len);
374
375       ptr += sep_len;
376       avail -= sep_len;
377     }
378
379     if (field_len > avail)
380       field_len = avail;
381
382     memcpy(ptr, fields[i], field_len);
383     ptr += field_len;
384
385     avail -= field_len;
386     if (ptr != NULL)
387       *ptr = 0;
388   }
389
390   return (int)buffer_req;
391 }
392
393 int escape_string (char *buffer, size_t buffer_size)
394 {
395   char *temp;
396   size_t j;
397
398   /* Check if we need to escape at all first */
399   temp = strpbrk (buffer, " \t\"\\");
400   if (temp == NULL)
401     return (0);
402
403   if (buffer_size < 3)
404     return (EINVAL);
405
406   temp = calloc (1, buffer_size);
407   if (temp == NULL)
408     return (ENOMEM);
409
410   temp[0] = '"';
411   j = 1;
412
413   for (size_t i = 0; i < buffer_size; i++)
414   {
415     if (buffer[i] == 0)
416     {
417       break;
418     }
419     else if ((buffer[i] == '"') || (buffer[i] == '\\'))
420     {
421       if (j > (buffer_size - 4))
422         break;
423       temp[j] = '\\';
424       temp[j + 1] = buffer[i];
425       j += 2;
426     }
427     else
428     {
429       if (j > (buffer_size - 3))
430         break;
431       temp[j] = buffer[i];
432       j++;
433     }
434   }
435
436   assert ((j + 1) < buffer_size);
437   temp[j] = '"';
438   temp[j + 1] = 0;
439
440   sstrncpy (buffer, temp, buffer_size);
441   sfree (temp);
442   return (0);
443 } /* int escape_string */
444
445 int strunescape (char *buf, size_t buf_len)
446 {
447         for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
448         {
449                 if (buf[i] != '\\')
450                         continue;
451
452                 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
453                         ERROR ("string unescape: backslash found at end of string.");
454                         /* Ensure null-byte at the end of the buffer. */
455                         buf[i] = 0;
456                         return (-1);
457                 }
458
459                 switch (buf[i + 1]) {
460                         case 't':
461                                 buf[i] = '\t';
462                                 break;
463                         case 'n':
464                                 buf[i] = '\n';
465                                 break;
466                         case 'r':
467                                 buf[i] = '\r';
468                                 break;
469                         default:
470                                 buf[i] = buf[i + 1];
471                                 break;
472                 }
473
474                 /* Move everything after the position one position to the left.
475                  * Add a null-byte as last character in the buffer. */
476                 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
477                 buf[buf_len - 1] = 0;
478         }
479         return (0);
480 } /* int strunescape */
481
482 size_t strstripnewline (char *buffer)
483 {
484         size_t buffer_len = strlen (buffer);
485
486         while (buffer_len > 0)
487         {
488                 if ((buffer[buffer_len - 1] != '\n')
489                                 && (buffer[buffer_len - 1] != '\r'))
490                         break;
491                 buffer_len--;
492                 buffer[buffer_len] = 0;
493         }
494
495         return (buffer_len);
496 } /* size_t strstripnewline */
497
498 int escape_slashes (char *buffer, size_t buffer_size)
499 {
500         size_t buffer_len;
501
502         buffer_len = strlen (buffer);
503
504         if (buffer_len <= 1)
505         {
506                 if (strcmp ("/", buffer) == 0)
507                 {
508                         if (buffer_size < 5)
509                                 return (-1);
510                         sstrncpy (buffer, "root", buffer_size);
511                 }
512                 return (0);
513         }
514
515         /* Move one to the left */
516         if (buffer[0] == '/')
517         {
518                 memmove (buffer, buffer + 1, buffer_len);
519                 buffer_len--;
520         }
521
522         for (size_t i = 0; i < buffer_len; i++)
523         {
524                 if (buffer[i] == '/')
525                         buffer[i] = '_';
526         }
527
528         return (0);
529 } /* int escape_slashes */
530
531 void replace_special (char *buffer, size_t buffer_size)
532 {
533         for (size_t i = 0; i < buffer_size; i++)
534         {
535                 if (buffer[i] == 0)
536                         return;
537                 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
538                         buffer[i] = '_';
539         }
540 } /* void replace_special */
541
542 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
543 {
544         struct timeval *larger;
545         struct timeval *smaller;
546
547         int status;
548
549         NORMALIZE_TIMEVAL (tv0);
550         NORMALIZE_TIMEVAL (tv1);
551
552         if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
553         {
554                 if (delta != NULL) {
555                         delta->tv_sec  = 0;
556                         delta->tv_usec = 0;
557                 }
558                 return (0);
559         }
560
561         if ((tv0.tv_sec < tv1.tv_sec)
562                         || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
563         {
564                 larger  = &tv1;
565                 smaller = &tv0;
566                 status  = -1;
567         }
568         else
569         {
570                 larger  = &tv0;
571                 smaller = &tv1;
572                 status  = 1;
573         }
574
575         if (delta != NULL) {
576                 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
577
578                 if (smaller->tv_usec <= larger->tv_usec)
579                         delta->tv_usec = larger->tv_usec - smaller->tv_usec;
580                 else
581                 {
582                         --delta->tv_sec;
583                         delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
584                 }
585         }
586
587         assert ((delta == NULL)
588                         || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
589
590         return (status);
591 } /* int timeval_cmp */
592
593 int check_create_dir (const char *file_orig)
594 {
595         struct stat statbuf;
596
597         char  file_copy[512];
598         char  dir[512];
599         int   dir_len = 512;
600         char *fields[16];
601         int   fields_num;
602         char *ptr;
603         char *saveptr;
604         int   last_is_file = 1;
605         int   path_is_absolute = 0;
606         size_t len;
607
608         /*
609          * Sanity checks first
610          */
611         if (file_orig == NULL)
612                 return (-1);
613
614         if ((len = strlen (file_orig)) < 1)
615                 return (-1);
616         else if (len >= sizeof (file_copy))
617                 return (-1);
618
619         /*
620          * If `file_orig' ends in a slash the last component is a directory,
621          * otherwise it's a file. Act accordingly..
622          */
623         if (file_orig[len - 1] == '/')
624                 last_is_file = 0;
625         if (file_orig[0] == '/')
626                 path_is_absolute = 1;
627
628         /*
629          * Create a copy for `strtok_r' to destroy
630          */
631         sstrncpy (file_copy, file_orig, sizeof (file_copy));
632
633         /*
634          * Break into components. This will eat up several slashes in a row and
635          * remove leading and trailing slashes..
636          */
637         ptr = file_copy;
638         saveptr = NULL;
639         fields_num = 0;
640         while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
641         {
642                 ptr = NULL;
643                 fields_num++;
644
645                 if (fields_num >= 16)
646                         break;
647         }
648
649         /*
650          * For each component, do..
651          */
652         for (int i = 0; i < (fields_num - last_is_file); i++)
653         {
654                 /*
655                  * Do not create directories that start with a dot. This
656                  * prevents `../../' attacks and other likely malicious
657                  * behavior.
658                  */
659                 if (fields[i][0] == '.')
660                 {
661                         ERROR ("Cowardly refusing to create a directory that "
662                                         "begins with a `.' (dot): `%s'", file_orig);
663                         return (-2);
664                 }
665
666                 /*
667                  * Join the components together again
668                  */
669                 dir[0] = '/';
670                 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
671                                         fields, (size_t) (i + 1), "/") < 0)
672                 {
673                         ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
674                         return (-1);
675                 }
676
677                 while (42) {
678                         if ((stat (dir, &statbuf) == -1)
679                                         && (lstat (dir, &statbuf) == -1))
680                         {
681                                 if (errno == ENOENT)
682                                 {
683                                         if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
684                                                 break;
685
686                                         /* this might happen, if a different thread created
687                                          * the directory in the meantime
688                                          * => call stat() again to check for S_ISDIR() */
689                                         if (EEXIST == errno)
690                                                 continue;
691
692                                         char errbuf[1024];
693                                         ERROR ("check_create_dir: mkdir (%s): %s", dir,
694                                                         sstrerror (errno,
695                                                                 errbuf, sizeof (errbuf)));
696                                         return (-1);
697                                 }
698                                 else
699                                 {
700                                         char errbuf[1024];
701                                         ERROR ("check_create_dir: stat (%s): %s", dir,
702                                                         sstrerror (errno, errbuf,
703                                                                 sizeof (errbuf)));
704                                         return (-1);
705                                 }
706                         }
707                         else if (!S_ISDIR (statbuf.st_mode))
708                         {
709                                 ERROR ("check_create_dir: `%s' exists but is not "
710                                                 "a directory!", dir);
711                                 return (-1);
712                         }
713                         break;
714                 }
715         }
716
717         return (0);
718 } /* check_create_dir */
719
720 #ifdef HAVE_LIBKSTAT
721 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
722 {
723         char ident[128];
724
725         *ksp_ptr = NULL;
726
727         if (kc == NULL)
728                 return (-1);
729
730         ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
731
732         *ksp_ptr = kstat_lookup (kc, module, instance, name);
733         if (*ksp_ptr == NULL)
734         {
735                 ERROR ("get_kstat: Cound not find kstat %s", ident);
736                 return (-1);
737         }
738
739         if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
740         {
741                 ERROR ("get_kstat: kstat %s has wrong type", ident);
742                 *ksp_ptr = NULL;
743                 return (-1);
744         }
745
746 #ifdef assert
747         assert (*ksp_ptr != NULL);
748         assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
749 #endif
750
751         if (kstat_read (kc, *ksp_ptr, NULL) == -1)
752         {
753                 ERROR ("get_kstat: kstat %s could not be read", ident);
754                 return (-1);
755         }
756
757         if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
758         {
759                 ERROR ("get_kstat: kstat %s has wrong type", ident);
760                 return (-1);
761         }
762
763         return (0);
764 }
765
766 long long get_kstat_value (kstat_t *ksp, char *name)
767 {
768         kstat_named_t *kn;
769         long long retval = -1LL;
770
771         if (ksp == NULL)
772         {
773                 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
774                 return (-1LL);
775         }
776         else if (ksp->ks_type != KSTAT_TYPE_NAMED)
777         {
778                 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
779                                 "is not KSTAT_TYPE_NAMED (%#x).",
780                                 name,
781                                 (unsigned int) ksp->ks_type,
782                                 (unsigned int) KSTAT_TYPE_NAMED);
783                 return (-1LL);
784         }
785
786         if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
787                 return (-1LL);
788
789         if (kn->data_type == KSTAT_DATA_INT32)
790                 retval = (long long) kn->value.i32;
791         else if (kn->data_type == KSTAT_DATA_UINT32)
792                 retval = (long long) kn->value.ui32;
793         else if (kn->data_type == KSTAT_DATA_INT64)
794                 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
795         else if (kn->data_type == KSTAT_DATA_UINT64)
796                 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
797         else
798                 WARNING ("get_kstat_value: Not a numeric value: %s", name);
799
800         return (retval);
801 }
802 #endif /* HAVE_LIBKSTAT */
803
804 #ifndef HAVE_HTONLL
805 unsigned long long ntohll (unsigned long long n)
806 {
807 #if BYTE_ORDER == BIG_ENDIAN
808         return (n);
809 #else
810         return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
811 #endif
812 } /* unsigned long long ntohll */
813
814 unsigned long long htonll (unsigned long long n)
815 {
816 #if BYTE_ORDER == BIG_ENDIAN
817         return (n);
818 #else
819         return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
820 #endif
821 } /* unsigned long long htonll */
822 #endif /* HAVE_HTONLL */
823
824 #if FP_LAYOUT_NEED_NOTHING
825 /* Well, we need nothing.. */
826 /* #endif FP_LAYOUT_NEED_NOTHING */
827
828 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
829 # if FP_LAYOUT_NEED_ENDIANFLIP
830 #  define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
831                          (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
832                          (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
833                          (((uint64_t)(A) & 0x000000ff00000000LL) >> 8)  | \
834                          (((uint64_t)(A) & 0x00000000ff000000LL) << 8)  | \
835                          (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
836                          (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
837                          (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
838 # else
839 #  define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
840                          (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
841 # endif
842
843 double ntohd (double d)
844 {
845         union
846         {
847                 uint8_t  byte[8];
848                 uint64_t integer;
849                 double   floating;
850         } ret;
851
852         ret.floating = d;
853
854         /* NAN in x86 byte order */
855         if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
856                         && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
857                         && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
858                         && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
859         {
860                 return (NAN);
861         }
862         else
863         {
864                 uint64_t tmp;
865
866                 tmp = ret.integer;
867                 ret.integer = FP_CONVERT (tmp);
868                 return (ret.floating);
869         }
870 } /* double ntohd */
871
872 double htond (double d)
873 {
874         union
875         {
876                 uint8_t  byte[8];
877                 uint64_t integer;
878                 double   floating;
879         } ret;
880
881         if (isnan (d))
882         {
883                 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
884                 ret.byte[4] = ret.byte[5] = 0x00;
885                 ret.byte[6] = 0xf8;
886                 ret.byte[7] = 0x7f;
887                 return (ret.floating);
888         }
889         else
890         {
891                 uint64_t tmp;
892
893                 ret.floating = d;
894                 tmp = FP_CONVERT (ret.integer);
895                 ret.integer = tmp;
896                 return (ret.floating);
897         }
898 } /* double htond */
899 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
900
901 int format_name (char *ret, int ret_len,
902                 const char *hostname,
903                 const char *plugin, const char *plugin_instance,
904                 const char *type, const char *type_instance)
905 {
906   char *buffer;
907   size_t buffer_size;
908
909   buffer = ret;
910   buffer_size = (size_t) ret_len;
911
912 #define APPEND(str) do {                                               \
913   size_t l = strlen (str);                                             \
914   if (l >= buffer_size)                                                \
915     return (ENOBUFS);                                                  \
916   memcpy (buffer, (str), l);                                           \
917   buffer += l; buffer_size -= l;                                       \
918 } while (0)
919
920   assert (plugin != NULL);
921   assert (type != NULL);
922
923   APPEND (hostname);
924   APPEND ("/");
925   APPEND (plugin);
926   if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
927   {
928     APPEND ("-");
929     APPEND (plugin_instance);
930   }
931   APPEND ("/");
932   APPEND (type);
933   if ((type_instance != NULL) && (type_instance[0] != 0))
934   {
935     APPEND ("-");
936     APPEND (type_instance);
937   }
938   assert (buffer_size > 0);
939   buffer[0] = 0;
940
941 #undef APPEND
942   return (0);
943 } /* int format_name */
944
945 int format_values (char *ret, size_t ret_len, /* {{{ */
946                 const data_set_t *ds, const value_list_t *vl,
947                 _Bool store_rates)
948 {
949         size_t offset = 0;
950         int status;
951         gauge_t *rates = NULL;
952
953         assert (0 == strcmp (ds->type, vl->type));
954
955         memset (ret, 0, ret_len);
956
957 #define BUFFER_ADD(...) do { \
958         status = ssnprintf (ret + offset, ret_len - offset, \
959                         __VA_ARGS__); \
960         if (status < 1) \
961         { \
962                 sfree (rates); \
963                 return (-1); \
964         } \
965         else if (((size_t) status) >= (ret_len - offset)) \
966         { \
967                 sfree (rates); \
968                 return (-1); \
969         } \
970         else \
971                 offset += ((size_t) status); \
972 } while (0)
973
974         BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
975
976         for (size_t i = 0; i < ds->ds_num; i++)
977         {
978                 if (ds->ds[i].type == DS_TYPE_GAUGE)
979                         BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
980                 else if (store_rates)
981                 {
982                         if (rates == NULL)
983                                 rates = uc_get_rate (ds, vl);
984                         if (rates == NULL)
985                         {
986                                 WARNING ("format_values: uc_get_rate failed.");
987                                 return (-1);
988                         }
989                         BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
990                 }
991                 else if (ds->ds[i].type == DS_TYPE_COUNTER)
992                         BUFFER_ADD (":%llu", vl->values[i].counter);
993                 else if (ds->ds[i].type == DS_TYPE_DERIVE)
994                         BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
995                 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
996                         BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
997                 else
998                 {
999                         ERROR ("format_values: Unknown data source type: %i",
1000                                         ds->ds[i].type);
1001                         sfree (rates);
1002                         return (-1);
1003                 }
1004         } /* for ds->ds_num */
1005
1006 #undef BUFFER_ADD
1007
1008         sfree (rates);
1009         return (0);
1010 } /* }}} int format_values */
1011
1012 int parse_identifier (char *str, char **ret_host,
1013                 char **ret_plugin, char **ret_plugin_instance,
1014                 char **ret_type, char **ret_type_instance,
1015                 char *default_host)
1016 {
1017         char *hostname = NULL;
1018         char *plugin = NULL;
1019         char *plugin_instance = NULL;
1020         char *type = NULL;
1021         char *type_instance = NULL;
1022
1023         hostname = str;
1024         if (hostname == NULL)
1025                 return (-1);
1026
1027         plugin = strchr (hostname, '/');
1028         if (plugin == NULL)
1029                 return (-1);
1030         *plugin = '\0'; plugin++;
1031
1032         type = strchr (plugin, '/');
1033         if (type == NULL)
1034         {
1035                 if (default_host == NULL)
1036                         return (-1);
1037                 /* else: no host specified; use default */
1038                 type = plugin;
1039                 plugin = hostname;
1040                 hostname = default_host;
1041         }
1042         else
1043         {
1044                 *type = '\0';
1045                 type++;
1046         }
1047
1048         plugin_instance = strchr (plugin, '-');
1049         if (plugin_instance != NULL)
1050         {
1051                 *plugin_instance = '\0';
1052                 plugin_instance++;
1053         }
1054
1055         type_instance = strchr (type, '-');
1056         if (type_instance != NULL)
1057         {
1058                 *type_instance = '\0';
1059                 type_instance++;
1060         }
1061
1062         *ret_host = hostname;
1063         *ret_plugin = plugin;
1064         *ret_plugin_instance = plugin_instance;
1065         *ret_type = type;
1066         *ret_type_instance = type_instance;
1067         return (0);
1068 } /* int parse_identifier */
1069
1070 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1071 {
1072         char str_copy[6 * DATA_MAX_NAME_LEN];
1073         char *host = NULL;
1074         char *plugin = NULL;
1075         char *plugin_instance = NULL;
1076         char *type = NULL;
1077         char *type_instance = NULL;
1078         int status;
1079
1080         if ((str == NULL) || (vl == NULL))
1081                 return (EINVAL);
1082
1083         sstrncpy (str_copy, str, sizeof (str_copy));
1084
1085         status = parse_identifier (str_copy, &host,
1086                         &plugin, &plugin_instance,
1087                         &type, &type_instance,
1088                         /* default_host = */ NULL);
1089         if (status != 0)
1090                 return (status);
1091
1092         sstrncpy (vl->host, host, sizeof (vl->host));
1093         sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1094         sstrncpy (vl->plugin_instance,
1095                         (plugin_instance != NULL) ? plugin_instance : "",
1096                         sizeof (vl->plugin_instance));
1097         sstrncpy (vl->type, type, sizeof (vl->type));
1098         sstrncpy (vl->type_instance,
1099                         (type_instance != NULL) ? type_instance : "",
1100                         sizeof (vl->type_instance));
1101
1102         return (0);
1103 } /* }}} int parse_identifier_vl */
1104
1105 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1106 {
1107   char *value;
1108   char *endptr = NULL;
1109   size_t value_len;
1110
1111   if (value_orig == NULL)
1112     return (EINVAL);
1113
1114   value = strdup (value_orig);
1115   if (value == NULL)
1116     return (ENOMEM);
1117   value_len = strlen (value);
1118
1119   while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1120   {
1121     value[value_len - 1] = 0;
1122     value_len--;
1123   }
1124
1125   switch (ds_type)
1126   {
1127     case DS_TYPE_COUNTER:
1128       ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1129       break;
1130
1131     case DS_TYPE_GAUGE:
1132       ret_value->gauge = (gauge_t) strtod (value, &endptr);
1133       break;
1134
1135     case DS_TYPE_DERIVE:
1136       ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1137       break;
1138
1139     case DS_TYPE_ABSOLUTE:
1140       ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1141       break;
1142
1143     default:
1144       sfree (value);
1145       ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1146       return -1;
1147   }
1148
1149   if (value == endptr) {
1150     ERROR ("parse_value: Failed to parse string as %s: %s.",
1151         DS_TYPE_TO_STRING (ds_type), value);
1152     sfree (value);
1153     return -1;
1154   }
1155   else if ((NULL != endptr) && ('\0' != *endptr))
1156     INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1157         "Input string was \"%s\".",
1158         endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1159
1160   sfree (value);
1161   return 0;
1162 } /* int parse_value */
1163
1164 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1165 {
1166         size_t i;
1167         char *dummy;
1168         char *ptr;
1169         char *saveptr;
1170
1171         if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1172                 return EINVAL;
1173
1174         i = 0;
1175         dummy = buffer;
1176         saveptr = NULL;
1177         vl->time = 0;
1178         while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1179         {
1180                 dummy = NULL;
1181
1182                 if (i >= vl->values_len)
1183                 {
1184                         /* Make sure i is invalid. */
1185                         i = 0;
1186                         break;
1187                 }
1188
1189                 if (vl->time == 0)
1190                 {
1191                         if (strcmp ("N", ptr) == 0)
1192                                 vl->time = cdtime ();
1193                         else
1194                         {
1195                                 char *endptr = NULL;
1196                                 double tmp;
1197
1198                                 errno = 0;
1199                                 tmp = strtod (ptr, &endptr);
1200                                 if ((errno != 0)                    /* Overflow */
1201                                                 || (endptr == ptr)  /* Invalid string */
1202                                                 || (endptr == NULL) /* This should not happen */
1203                                                 || (*endptr != 0))  /* Trailing chars */
1204                                         return (-1);
1205
1206                                 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1207                         }
1208
1209                         continue;
1210                 }
1211
1212                 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1213                         vl->values[i].gauge = NAN;
1214                 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1215                         return -1;
1216
1217                 i++;
1218         } /* while (strtok_r) */
1219
1220         if ((ptr != NULL) || (i == 0))
1221                 return (-1);
1222         return (0);
1223 } /* int parse_values */
1224
1225 int parse_value_file (char const *path, value_t *ret_value, int ds_type)
1226 {
1227         FILE *fh;
1228         char buffer[256];
1229
1230         fh = fopen (path, "r");
1231         if (fh == NULL)
1232                 return (-1);
1233
1234         if (fgets (buffer, sizeof (buffer), fh) == NULL)
1235         {
1236                 fclose (fh);
1237                 return (-1);
1238         }
1239
1240         fclose (fh);
1241
1242         strstripnewline (buffer);
1243
1244         return parse_value (buffer, ret_value, ds_type);
1245 } /* int parse_value_file */
1246
1247 #if !HAVE_GETPWNAM_R
1248 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1249                 size_t buflen, struct passwd **pwbufp)
1250 {
1251         int status = 0;
1252         struct passwd *pw;
1253
1254         memset (pwbuf, '\0', sizeof (struct passwd));
1255
1256         pthread_mutex_lock (&getpwnam_r_lock);
1257
1258         do
1259         {
1260                 pw = getpwnam (name);
1261                 if (pw == NULL)
1262                 {
1263                         status = (errno != 0) ? errno : ENOENT;
1264                         break;
1265                 }
1266
1267 #define GETPWNAM_COPY_MEMBER(member) \
1268                 if (pw->member != NULL) \
1269                 { \
1270                         int len = strlen (pw->member); \
1271                         if (len >= buflen) \
1272                         { \
1273                                 status = ENOMEM; \
1274                                 break; \
1275                         } \
1276                         sstrncpy (buf, pw->member, buflen); \
1277                         pwbuf->member = buf; \
1278                         buf    += (len + 1); \
1279                         buflen -= (len + 1); \
1280                 }
1281                 GETPWNAM_COPY_MEMBER(pw_name);
1282                 GETPWNAM_COPY_MEMBER(pw_passwd);
1283                 GETPWNAM_COPY_MEMBER(pw_gecos);
1284                 GETPWNAM_COPY_MEMBER(pw_dir);
1285                 GETPWNAM_COPY_MEMBER(pw_shell);
1286
1287                 pwbuf->pw_uid = pw->pw_uid;
1288                 pwbuf->pw_gid = pw->pw_gid;
1289
1290                 if (pwbufp != NULL)
1291                         *pwbufp = pwbuf;
1292         } while (0);
1293
1294         pthread_mutex_unlock (&getpwnam_r_lock);
1295
1296         return (status);
1297 } /* int getpwnam_r */
1298 #endif /* !HAVE_GETPWNAM_R */
1299
1300 int notification_init (notification_t *n, int severity, const char *message,
1301                 const char *host,
1302                 const char *plugin, const char *plugin_instance,
1303                 const char *type, const char *type_instance)
1304 {
1305         memset (n, '\0', sizeof (notification_t));
1306
1307         n->severity = severity;
1308
1309         if (message != NULL)
1310                 sstrncpy (n->message, message, sizeof (n->message));
1311         if (host != NULL)
1312                 sstrncpy (n->host, host, sizeof (n->host));
1313         if (plugin != NULL)
1314                 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1315         if (plugin_instance != NULL)
1316                 sstrncpy (n->plugin_instance, plugin_instance,
1317                                 sizeof (n->plugin_instance));
1318         if (type != NULL)
1319                 sstrncpy (n->type, type, sizeof (n->type));
1320         if (type_instance != NULL)
1321                 sstrncpy (n->type_instance, type_instance,
1322                                 sizeof (n->type_instance));
1323
1324         return (0);
1325 } /* int notification_init */
1326
1327 int walk_directory (const char *dir, dirwalk_callback_f callback,
1328                 void *user_data, int include_hidden)
1329 {
1330         struct dirent *ent;
1331         DIR *dh;
1332         int success;
1333         int failure;
1334
1335         success = 0;
1336         failure = 0;
1337
1338         if ((dh = opendir (dir)) == NULL)
1339         {
1340                 char errbuf[1024];
1341                 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1342                                 sstrerror (errno, errbuf, sizeof (errbuf)));
1343                 return -1;
1344         }
1345
1346         while ((ent = readdir (dh)) != NULL)
1347         {
1348                 int status;
1349
1350                 if (include_hidden)
1351                 {
1352                         if ((strcmp (".", ent->d_name) == 0)
1353                                         || (strcmp ("..", ent->d_name) == 0))
1354                                 continue;
1355                 }
1356                 else /* if (!include_hidden) */
1357                 {
1358                         if (ent->d_name[0]=='.')
1359                                 continue;
1360                 }
1361
1362                 status = (*callback) (dir, ent->d_name, user_data);
1363                 if (status != 0)
1364                         failure++;
1365                 else
1366                         success++;
1367         }
1368
1369         closedir (dh);
1370
1371         if ((success == 0) && (failure > 0))
1372                 return (-1);
1373         return (0);
1374 }
1375
1376 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1377 {
1378         FILE *fh;
1379         ssize_t ret;
1380
1381         fh = fopen (filename, "r");
1382         if (fh == NULL)
1383                 return (-1);
1384
1385         ret = (ssize_t) fread (buf, 1, bufsize, fh);
1386         if ((ret == 0) && (ferror (fh) != 0))
1387         {
1388                 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1389                                 filename);
1390                 ret = -1;
1391         }
1392
1393         fclose(fh);
1394         return (ret);
1395 }
1396
1397 counter_t counter_diff (counter_t old_value, counter_t new_value)
1398 {
1399         counter_t diff;
1400
1401         if (old_value > new_value)
1402         {
1403                 if (old_value <= 4294967295U)
1404                         diff = (4294967295U - old_value) + new_value + 1;
1405                 else
1406                         diff = (18446744073709551615ULL - old_value) + new_value + 1;
1407         }
1408         else
1409         {
1410                 diff = new_value - old_value;
1411         }
1412
1413         return (diff);
1414 } /* counter_t counter_diff */
1415
1416 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1417                 rate_to_value_state_t *state,
1418                 int ds_type, cdtime_t t)
1419 {
1420         gauge_t delta_gauge;
1421         cdtime_t delta_t;
1422
1423         if (ds_type == DS_TYPE_GAUGE)
1424         {
1425                 state->last_value.gauge = rate;
1426                 state->last_time = t;
1427
1428                 *ret_value = state->last_value;
1429                 return (0);
1430         }
1431
1432         /* Counter and absolute can't handle negative rates. Reset "last time"
1433          * to zero, so that the next valid rate will re-initialize the
1434          * structure. */
1435         if ((rate < 0.0)
1436                         && ((ds_type == DS_TYPE_COUNTER)
1437                                 || (ds_type == DS_TYPE_ABSOLUTE)))
1438         {
1439                 memset (state, 0, sizeof (*state));
1440                 return (EINVAL);
1441         }
1442
1443         /* Another invalid state: The time is not increasing. */
1444         if (t <= state->last_time)
1445         {
1446                 memset (state, 0, sizeof (*state));
1447                 return (EINVAL);
1448         }
1449
1450         delta_t = t - state->last_time;
1451         delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1452
1453         /* Previous value is invalid. */
1454         if (state->last_time == 0) /* {{{ */
1455         {
1456                 if (ds_type == DS_TYPE_DERIVE)
1457                 {
1458                         state->last_value.derive = (derive_t) rate;
1459                         state->residual = rate - ((gauge_t) state->last_value.derive);
1460                 }
1461                 else if (ds_type == DS_TYPE_COUNTER)
1462                 {
1463                         state->last_value.counter = (counter_t) rate;
1464                         state->residual = rate - ((gauge_t) state->last_value.counter);
1465                 }
1466                 else if (ds_type == DS_TYPE_ABSOLUTE)
1467                 {
1468                         state->last_value.absolute = (absolute_t) rate;
1469                         state->residual = rate - ((gauge_t) state->last_value.absolute);
1470                 }
1471                 else
1472                 {
1473                         assert (23 == 42);
1474                 }
1475
1476                 state->last_time = t;
1477                 return (EAGAIN);
1478         } /* }}} */
1479
1480         if (ds_type == DS_TYPE_DERIVE)
1481         {
1482                 derive_t delta_derive = (derive_t) delta_gauge;
1483
1484                 state->last_value.derive += delta_derive;
1485                 state->residual = delta_gauge - ((gauge_t) delta_derive);
1486         }
1487         else if (ds_type == DS_TYPE_COUNTER)
1488         {
1489                 counter_t delta_counter = (counter_t) delta_gauge;
1490
1491                 state->last_value.counter += delta_counter;
1492                 state->residual = delta_gauge - ((gauge_t) delta_counter);
1493         }
1494         else if (ds_type == DS_TYPE_ABSOLUTE)
1495         {
1496                 absolute_t delta_absolute = (absolute_t) delta_gauge;
1497
1498                 state->last_value.absolute = delta_absolute;
1499                 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1500         }
1501         else
1502         {
1503                 assert (23 == 42);
1504         }
1505
1506         state->last_time = t;
1507         *ret_value = state->last_value;
1508         return (0);
1509 } /* }}} value_t rate_to_value */
1510
1511 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1512                 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1513 {
1514         gauge_t interval;
1515
1516         /* Another invalid state: The time is not increasing. */
1517         if (t <= state->last_time)
1518         {
1519                 memset (state, 0, sizeof (*state));
1520                 return (EINVAL);
1521         }
1522
1523         interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1524
1525         /* Previous value is invalid. */
1526         if (state->last_time == 0)
1527         {
1528                 state->last_value = value;
1529                 state->last_time = t;
1530                 return (EAGAIN);
1531         }
1532
1533         switch (ds_type) {
1534         case DS_TYPE_DERIVE: {
1535                 derive_t diff = value.derive - state->last_value.derive;
1536                 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1537                 break;
1538         }
1539         case DS_TYPE_GAUGE: {
1540                 *ret_rate = value.gauge;
1541                 break;
1542         }
1543         case DS_TYPE_COUNTER: {
1544                 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1545                 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1546                 break;
1547         }
1548         case DS_TYPE_ABSOLUTE: {
1549                 absolute_t diff = value.absolute;
1550                 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1551                 break;
1552         }
1553         default:
1554                 return EINVAL;
1555         }
1556
1557         state->last_value = value;
1558         state->last_time = t;
1559         return (0);
1560 } /* }}} value_t rate_to_value */
1561
1562 int service_name_to_port_number (const char *service_name)
1563 {
1564         struct addrinfo *ai_list;
1565         int status;
1566         int service_number;
1567
1568         if (service_name == NULL)
1569                 return (-1);
1570
1571         struct addrinfo ai_hints = {
1572                 .ai_family = AF_UNSPEC
1573         };
1574
1575         status = getaddrinfo (/* node = */ NULL, service_name,
1576                         &ai_hints, &ai_list);
1577         if (status != 0)
1578         {
1579                 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1580                                 gai_strerror (status));
1581                 return (-1);
1582         }
1583
1584         service_number = -1;
1585         for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1586         {
1587                 if (ai_ptr->ai_family == AF_INET)
1588                 {
1589                         struct sockaddr_in *sa;
1590
1591                         sa = (void *) ai_ptr->ai_addr;
1592                         service_number = (int) ntohs (sa->sin_port);
1593                 }
1594                 else if (ai_ptr->ai_family == AF_INET6)
1595                 {
1596                         struct sockaddr_in6 *sa;
1597
1598                         sa = (void *) ai_ptr->ai_addr;
1599                         service_number = (int) ntohs (sa->sin6_port);
1600                 }
1601
1602                 if ((service_number > 0) && (service_number <= 65535))
1603                         break;
1604         }
1605
1606         freeaddrinfo (ai_list);
1607
1608         if ((service_number > 0) && (service_number <= 65535))
1609                 return (service_number);
1610         return (-1);
1611 } /* int service_name_to_port_number */
1612
1613 void set_sock_opts (int sockfd) /* {{{ */
1614 {
1615         int status;
1616         int socktype;
1617
1618         socklen_t socklen = sizeof (socklen_t);
1619         int so_keepalive = 1;
1620
1621         status = getsockopt (sockfd, SOL_SOCKET, SO_TYPE, &socktype, &socklen);
1622         if (status != 0)
1623         {
1624                 WARNING ("set_sock_opts: failed to determine socket type");
1625                 return;
1626         }
1627
1628         if (socktype == SOCK_STREAM)
1629         {
1630                 status = setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE,
1631                                 &so_keepalive, sizeof (so_keepalive));
1632                 if (status != 0)
1633                         WARNING ("set_sock_opts: failed to set socket keepalive flag");
1634
1635 #ifdef TCP_KEEPIDLE
1636                 int tcp_keepidle = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 100 + 1);
1637                 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPIDLE,
1638                                 &tcp_keepidle, sizeof (tcp_keepidle));
1639                 if (status != 0)
1640                         WARNING ("set_sock_opts: failed to set socket tcp keepalive time");
1641 #endif
1642
1643 #ifdef TCP_KEEPINTVL
1644                 int tcp_keepintvl = ((CDTIME_T_TO_MS(plugin_get_interval()) - 1) / 1000 + 1);
1645                 status = setsockopt(sockfd, IPPROTO_TCP, TCP_KEEPINTVL,
1646                                 &tcp_keepintvl, sizeof (tcp_keepintvl));
1647                 if (status != 0)
1648                         WARNING ("set_sock_opts: failed to set socket tcp keepalive interval");
1649 #endif
1650         }
1651 } /* }}} void set_sock_opts */
1652
1653 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1654 {
1655         derive_t tmp;
1656         char *endptr;
1657
1658         if ((string == NULL) || (ret_value == NULL))
1659                 return (EINVAL);
1660
1661         errno = 0;
1662         endptr = NULL;
1663         tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1664         if ((endptr == string) || (errno != 0))
1665                 return (-1);
1666
1667         *ret_value = tmp;
1668         return (0);
1669 } /* }}} int strtoderive */
1670
1671 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1672 {
1673         gauge_t tmp;
1674         char *endptr = NULL;
1675
1676         if ((string == NULL) || (ret_value == NULL))
1677                 return (EINVAL);
1678
1679         errno = 0;
1680         endptr = NULL;
1681         tmp = (gauge_t) strtod (string, &endptr);
1682         if (errno != 0)
1683                 return (errno);
1684         else if ((endptr == NULL) || (*endptr != 0))
1685                 return (EINVAL);
1686
1687         *ret_value = tmp;
1688         return (0);
1689 } /* }}} int strtogauge */
1690
1691 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1692 {
1693         char **array;
1694         size_t array_len = *ret_array_len;
1695
1696         if (str == NULL)
1697                 return (EINVAL);
1698
1699         array = realloc (*ret_array,
1700             (array_len + 1) * sizeof (*array));
1701         if (array == NULL)
1702                 return (ENOMEM);
1703         *ret_array = array;
1704
1705         array[array_len] = strdup (str);
1706         if (array[array_len] == NULL)
1707                 return (ENOMEM);
1708
1709         array_len++;
1710         *ret_array_len = array_len;
1711         return (0);
1712 } /* }}} int strarray_add */
1713
1714 void strarray_free (char **array, size_t array_len) /* {{{ */
1715 {
1716         for (size_t i = 0; i < array_len; i++)
1717                 sfree (array[i]);
1718         sfree (array);
1719 } /* }}} void strarray_free */
1720
1721 #ifdef HAVE_SYS_CAPABILITY_H
1722 int check_capability (int capability) /* {{{ */
1723 {
1724 #ifdef _LINUX_CAPABILITY_VERSION_3
1725         cap_user_header_t cap_header = calloc(1, sizeof (*cap_header));
1726         if (cap_header == NULL)
1727         {
1728                 ERROR("check_capability: calloc failed");
1729                 return (-1);
1730         }
1731
1732         cap_user_data_t cap_data = calloc(1, sizeof (*cap_data));
1733         if (cap_data == NULL)
1734         {
1735                 ERROR("check_capability: calloc failed");
1736                 sfree(cap_header);
1737                 return (-1);
1738         }
1739
1740         cap_header->pid = getpid();
1741         cap_header->version = _LINUX_CAPABILITY_VERSION;
1742         if (capget(cap_header, cap_data) < 0)
1743         {
1744                 ERROR("check_capability: capget failed");
1745                 sfree(cap_header);
1746                 sfree(cap_data);
1747                 return (-1);
1748         }
1749
1750         if ((cap_data->effective & (1 << capability)) == 0)
1751         {
1752                 sfree(cap_header);
1753                 sfree(cap_data);
1754                 return (-1);
1755         }
1756         else
1757         {
1758                 sfree(cap_header);
1759                 sfree(cap_data);
1760                 return (0);
1761         }
1762 #else
1763         WARNING ("check_capability: unsupported capability implementation. "
1764             "Some plugin(s) may require elevated privileges to work properly.");
1765         return (0);
1766 #endif /* _LINUX_CAPABILITY_VERSION_3 */
1767 } /* }}} int check_capability */
1768 #endif /* HAVE_SYS_CAPABILITY_H */