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