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