Code

src/plugin.c: Free allocated data if plugin_insert_read() fails.
[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 **/
25 #if HAVE_CONFIG_H
26 # include "config.h"
27 #endif
29 #include "collectd.h"
30 #include "common.h"
31 #include "plugin.h"
32 #include "utils_cache.h"
34 #if HAVE_PTHREAD_H
35 # include <pthread.h>
36 #endif
38 #ifdef HAVE_MATH_H
39 # include <math.h>
40 #endif
42 /* for ntohl and htonl */
43 #if HAVE_ARPA_INET_H
44 # include <arpa/inet.h>
45 #endif
47 /* for getaddrinfo */
48 #include <sys/types.h>
49 #include <sys/socket.h>
50 #include <netdb.h>
52 #if HAVE_NETINET_IN_H
53 # include <netinet/in.h>
54 #endif
56 #ifdef HAVE_LIBKSTAT
57 extern kstat_ctl_t *kc;
58 #endif
60 #if !HAVE_GETPWNAM_R
61 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
62 #endif
64 #if !HAVE_STRERROR_R
65 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
66 #endif
68 char *sstrncpy (char *dest, const char *src, size_t n)
69 {
70         strncpy (dest, src, n);
71         dest[n - 1] = '\0';
73         return (dest);
74 } /* char *sstrncpy */
76 int ssnprintf (char *dest, size_t n, const char *format, ...)
77 {
78         int ret = 0;
79         va_list ap;
81         va_start (ap, format);
82         ret = vsnprintf (dest, n, format, ap);
83         dest[n - 1] = '\0';
84         va_end (ap);
86         return (ret);
87 } /* int ssnprintf */
89 char *sstrdup (const char *s)
90 {
91         char *r;
92         size_t sz;
94         if (s == NULL)
95                 return (NULL);
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);
108         return (r);
109 } /* char *sstrdup */
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)
116         buf[0] = '\0';
118 #if !HAVE_STRERROR_R
119         {
120                 char *temp;
122                 pthread_mutex_lock (&strerror_r_lock);
124                 temp = strerror (errnum);
125                 sstrncpy (buf, temp, buflen);
127                 pthread_mutex_unlock (&strerror_r_lock);
128         }
129 /* #endif !HAVE_STRERROR_R */
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 */
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 */
155         return (buf);
156 } /* char *sstrerror */
158 void *smalloc (size_t size)
160         void *r;
162         if ((r = malloc (size)) == NULL)
163         {
164                 ERROR ("Not enough memory.");
165                 exit (3);
166         }
168         return (r);
169 } /* void *smalloc */
171 #if 0
172 void sfree (void **ptr)
174         if (ptr == NULL)
175                 return;
177         if (*ptr != NULL)
178                 free (*ptr);
180         *ptr = NULL;
182 #endif
184 ssize_t sread (int fd, void *buf, size_t count)
186         char    *ptr;
187         size_t   nleft;
188         ssize_t  status;
190         ptr   = (char *) buf;
191         nleft = count;
193         while (nleft > 0)
194         {
195                 status = read (fd, (void *) ptr, nleft);
197                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
198                         continue;
200                 if (status < 0)
201                         return (status);
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                 }
212                 assert ((0 > status) || (nleft >= (size_t)status));
214                 nleft = nleft - status;
215                 ptr   = ptr   + status;
216         }
218         return (0);
222 ssize_t swrite (int fd, const void *buf, size_t count)
224         const char *ptr;
225         size_t      nleft;
226         ssize_t     status;
228         ptr   = (const char *) buf;
229         nleft = count;
231         while (nleft > 0)
232         {
233                 status = write (fd, (const void *) ptr, nleft);
235                 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
236                         continue;
238                 if (status < 0)
239                         return (status);
241                 nleft = nleft - status;
242                 ptr   = ptr   + status;
243         }
245         return (0);
248 int strsplit (char *string, char **fields, size_t size)
250         size_t i;
251         char *ptr;
252         char *saveptr;
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++;
262                 if (i >= size)
263                         break;
264         }
266         return ((int) i);
269 int strjoin (char *dst, size_t dst_len,
270                 char **fields, size_t fields_num,
271                 const char *sep)
273         size_t field_len;
274         size_t sep_len;
275         int i;
277         memset (dst, '\0', dst_len);
279         if (fields_num <= 0)
280                 return (-1);
282         sep_len = 0;
283         if (sep != NULL)
284                 sep_len = strlen (sep);
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);
293                         strncat (dst, sep, dst_len);
294                         dst_len -= sep_len;
295                 }
297                 field_len = strlen (fields[i]);
299                 if (dst_len <= field_len)
300                         return (-1);
302                 strncat (dst, fields[i], dst_len);
303                 dst_len -= field_len;
304         }
306         return (strlen (dst));
309 int strsubstitute (char *str, char c_from, char c_to)
311         int ret;
313         if (str == NULL)
314                 return (-1);
316         ret = 0;
317         while (*str != '\0')
318         {
319                 if (*str == c_from)
320                 {
321                         *str = c_to;
322                         ret++;
323                 }
324                 str++;
325         }
327         return (ret);
328 } /* int strsubstitute */
330 int strunescape (char *buf, size_t buf_len)
332         size_t i;
334         for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
335         {
336                 if (buf[i] != '\\')
337                         continue;
339                 if ((i >= buf_len) || (buf[i + 1] == '\0')) {
340                         ERROR ("string unescape: backslash found at end of string.");
341                         return (-1);
342                 }
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                 }
359                 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
360         }
361         return (0);
362 } /* int strunescape */
364 int escape_slashes (char *buf, int buf_len)
366         int i;
368         if (strcmp (buf, "/") == 0)
369         {
370                 if (buf_len < 5)
371                         return (-1);
373                 strncpy (buf, "root", buf_len);
374                 return (0);
375         }
377         if (buf_len <= 1)
378                 return (0);
380         /* Move one to the left */
381         if (buf[0] == '/')
382                 memmove (buf, buf + 1, buf_len - 1);
384         for (i = 0; i < buf_len - 1; i++)
385         {
386                 if (buf[i] == '\0')
387                         break;
388                 else if (buf[i] == '/')
389                         buf[i] = '_';
390         }
391         buf[i] = '\0';
393         return (0);
394 } /* int escape_slashes */
396 void replace_special (char *buffer, size_t buffer_size)
398         size_t i;
400         for (i = 0; i < buffer_size; i++)
401         {
402                 if (buffer[i] == 0)
403                         return;
404                 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
405                         buffer[i] = '_';
406         }
407 } /* void replace_special */
409 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
411         struct timeval *larger;
412         struct timeval *smaller;
414         int status;
416         NORMALIZE_TIMEVAL (tv0);
417         NORMALIZE_TIMEVAL (tv1);
419         if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
420         {
421                 if (delta != NULL) {
422                         delta->tv_sec  = 0;
423                         delta->tv_usec = 0;
424                 }
425                 return (0);
426         }
428         if ((tv0.tv_sec < tv1.tv_sec)
429                         || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
430         {
431                 larger  = &tv1;
432                 smaller = &tv0;
433                 status  = -1;
434         }
435         else
436         {
437                 larger  = &tv0;
438                 smaller = &tv1;
439                 status  = 1;
440         }
442         if (delta != NULL) {
443                 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
445                 if (smaller->tv_usec <= larger->tv_usec)
446                         delta->tv_usec = larger->tv_usec - smaller->tv_usec;
447                 else
448                 {
449                         --delta->tv_sec;
450                         delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
451                 }
452         }
454         assert ((delta == NULL)
455                         || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
457         return (status);
458 } /* int timeval_cmp */
460 int check_create_dir (const char *file_orig)
462         struct stat statbuf;
464         char  file_copy[512];
465         char  dir[512];
466         int   dir_len = 512;
467         char *fields[16];
468         int   fields_num;
469         char *ptr;
470         char *saveptr;
471         int   last_is_file = 1;
472         int   path_is_absolute = 0;
473         size_t len;
474         int   i;
476         /*
477          * Sanity checks first
478          */
479         if (file_orig == NULL)
480                 return (-1);
482         if ((len = strlen (file_orig)) < 1)
483                 return (-1);
484         else if (len >= sizeof (file_copy))
485                 return (-1);
487         /*
488          * If `file_orig' ends in a slash the last component is a directory,
489          * otherwise it's a file. Act accordingly..
490          */
491         if (file_orig[len - 1] == '/')
492                 last_is_file = 0;
493         if (file_orig[0] == '/')
494                 path_is_absolute = 1;
496         /*
497          * Create a copy for `strtok_r' to destroy
498          */
499         sstrncpy (file_copy, file_orig, sizeof (file_copy));
501         /*
502          * Break into components. This will eat up several slashes in a row and
503          * remove leading and trailing slashes..
504          */
505         ptr = file_copy;
506         saveptr = NULL;
507         fields_num = 0;
508         while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
509         {
510                 ptr = NULL;
511                 fields_num++;
513                 if (fields_num >= 16)
514                         break;
515         }
517         /*
518          * For each component, do..
519          */
520         for (i = 0; i < (fields_num - last_is_file); i++)
521         {
522                 /*
523                  * Do not create directories that start with a dot. This
524                  * prevents `../../' attacks and other likely malicious
525                  * behavior.
526                  */
527                 if (fields[i][0] == '.')
528                 {
529                         ERROR ("Cowardly refusing to create a directory that "
530                                         "begins with a `.' (dot): `%s'", file_orig);
531                         return (-2);
532                 }
534                 /*
535                  * Join the components together again
536                  */
537                 dir[0] = '/';
538                 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
539                                         fields, i + 1, "/") < 0)
540                 {
541                         ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
542                         return (-1);
543                 }
545                 while (42) {
546                         if (stat (dir, &statbuf) == -1)
547                         {
548                                 if (errno == ENOENT)
549                                 {
550                                         if (mkdir (dir, 0755) == 0)
551                                                 break;
553                                         /* this might happen, if a different thread created
554                                          * the directory in the meantime
555                                          * => call stat() again to check for S_ISDIR() */
556                                         if (EEXIST == errno)
557                                                 continue;
559                                         char errbuf[1024];
560                                         ERROR ("check_create_dir: mkdir (%s): %s", dir,
561                                                         sstrerror (errno,
562                                                                 errbuf, sizeof (errbuf)));
563                                         return (-1);
564                                 }
565                                 else
566                                 {
567                                         char errbuf[1024];
568                                         ERROR ("check_create_dir: stat (%s): %s", dir,
569                                                         sstrerror (errno, errbuf,
570                                                                 sizeof (errbuf)));
571                                         return (-1);
572                                 }
573                         }
574                         else if (!S_ISDIR (statbuf.st_mode))
575                         {
576                                 ERROR ("check_create_dir: `%s' exists but is not "
577                                                 "a directory!", dir);
578                                 return (-1);
579                         }
580                         break;
581                 }
582         }
584         return (0);
585 } /* check_create_dir */
587 #ifdef HAVE_LIBKSTAT
588 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
590         char ident[128];
592         *ksp_ptr = NULL;
593         
594         if (kc == NULL)
595                 return (-1);
597         ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
599         *ksp_ptr = kstat_lookup (kc, module, instance, name);
600         if (*ksp_ptr == NULL)
601         {
602                 ERROR ("get_kstat: Cound not find kstat %s", ident);
603                 return (-1);
604         }
606         if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
607         {
608                 ERROR ("get_kstat: kstat %s has wrong type", ident);
609                 *ksp_ptr = NULL;
610                 return (-1);
611         }
613 #ifdef assert
614         assert (*ksp_ptr != NULL);
615         assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
616 #endif
618         if (kstat_read (kc, *ksp_ptr, NULL) == -1)
619         {
620                 ERROR ("get_kstat: kstat %s could not be read", ident);
621                 return (-1);
622         }
624         if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
625         {
626                 ERROR ("get_kstat: kstat %s has wrong type", ident);
627                 return (-1);
628         }
630         return (0);
633 long long get_kstat_value (kstat_t *ksp, char *name)
635         kstat_named_t *kn;
636         long long retval = -1LL;
638 #ifdef assert
639         assert (ksp != NULL);
640         assert (ksp->ks_type == KSTAT_TYPE_NAMED);
641 #else
642         if (ksp == NULL)
643         {
644                 ERROR ("ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
645                 return (-1LL);
646         }
647         else if (ksp->ks_type != KSTAT_TYPE_NAMED)
648         {
649                 ERROR ("ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
650                 return (-1LL);
651         }
652 #endif
654         if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
655                 return (retval);
657         if (kn->data_type == KSTAT_DATA_INT32)
658                 retval = (long long) kn->value.i32;
659         else if (kn->data_type == KSTAT_DATA_UINT32)
660                 retval = (long long) kn->value.ui32;
661         else if (kn->data_type == KSTAT_DATA_INT64)
662                 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
663         else if (kn->data_type == KSTAT_DATA_UINT64)
664                 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
665         else
666                 WARNING ("get_kstat_value: Not a numeric value: %s", name);
667                  
668         return (retval);
670 #endif /* HAVE_LIBKSTAT */
672 #ifndef HAVE_HTONLL
673 unsigned long long ntohll (unsigned long long n)
675 #if BYTE_ORDER == BIG_ENDIAN
676         return (n);
677 #else
678         return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
679 #endif
680 } /* unsigned long long ntohll */
682 unsigned long long htonll (unsigned long long n)
684 #if BYTE_ORDER == BIG_ENDIAN
685         return (n);
686 #else
687         return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
688 #endif
689 } /* unsigned long long htonll */
690 #endif /* HAVE_HTONLL */
692 #if FP_LAYOUT_NEED_NOTHING
693 /* Well, we need nothing.. */
694 /* #endif FP_LAYOUT_NEED_NOTHING */
696 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
697 # if FP_LAYOUT_NEED_ENDIANFLIP
698 #  define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
699                          (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
700                          (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
701                          (((uint64_t)(A) & 0x000000ff00000000LL) >> 8)  | \
702                          (((uint64_t)(A) & 0x00000000ff000000LL) << 8)  | \
703                          (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
704                          (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
705                          (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
706 # else
707 #  define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
708                          (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
709 # endif
711 double ntohd (double d)
713         union
714         {
715                 uint8_t  byte[8];
716                 uint64_t integer;
717                 double   floating;
718         } ret;
720         ret.floating = d;
722         /* NAN in x86 byte order */
723         if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
724                         && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
725                         && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
726                         && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
727         {
728                 return (NAN);
729         }
730         else
731         {
732                 uint64_t tmp;
734                 tmp = ret.integer;
735                 ret.integer = FP_CONVERT (tmp);
736                 return (ret.floating);
737         }
738 } /* double ntohd */
740 double htond (double d)
742         union
743         {
744                 uint8_t  byte[8];
745                 uint64_t integer;
746                 double   floating;
747         } ret;
749         if (isnan (d))
750         {
751                 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
752                 ret.byte[4] = ret.byte[5] = 0x00;
753                 ret.byte[6] = 0xf8;
754                 ret.byte[7] = 0x7f;
755                 return (ret.floating);
756         }
757         else
758         {
759                 uint64_t tmp;
761                 ret.floating = d;
762                 tmp = FP_CONVERT (ret.integer);
763                 ret.integer = tmp;
764                 return (ret.floating);
765         }
766 } /* double htond */
767 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
769 int format_name (char *ret, int ret_len,
770                 const char *hostname,
771                 const char *plugin, const char *plugin_instance,
772                 const char *type, const char *type_instance)
774         int  status;
776         assert (plugin != NULL);
777         assert (type != NULL);
779         if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
780         {
781                 if ((type_instance == NULL) || (strlen (type_instance) == 0))
782                         status = ssnprintf (ret, ret_len, "%s/%s/%s",
783                                         hostname, plugin, type);
784                 else
785                         status = ssnprintf (ret, ret_len, "%s/%s/%s-%s",
786                                         hostname, plugin, type,
787                                         type_instance);
788         }
789         else
790         {
791                 if ((type_instance == NULL) || (strlen (type_instance) == 0))
792                         status = ssnprintf (ret, ret_len, "%s/%s-%s/%s",
793                                         hostname, plugin, plugin_instance,
794                                         type);
795                 else
796                         status = ssnprintf (ret, ret_len, "%s/%s-%s/%s-%s",
797                                         hostname, plugin, plugin_instance,
798                                         type, type_instance);
799         }
801         if ((status < 1) || (status >= ret_len))
802                 return (-1);
803         return (0);
804 } /* int format_name */
806 int format_values (char *ret, size_t ret_len, /* {{{ */
807                 const data_set_t *ds, const value_list_t *vl,
808                 _Bool store_rates)
810         size_t offset = 0;
811         int status;
812         int i;
813         gauge_t *rates = NULL;
815         assert (0 == strcmp (ds->type, vl->type));
817         memset (ret, 0, ret_len);
819 #define BUFFER_ADD(...) do { \
820         status = ssnprintf (ret + offset, ret_len - offset, \
821                         __VA_ARGS__); \
822         if (status < 1) \
823         { \
824                 sfree (rates); \
825                 return (-1); \
826         } \
827         else if (((size_t) status) >= (ret_len - offset)) \
828         { \
829                 sfree (rates); \
830                 return (-1); \
831         } \
832         else \
833                 offset += ((size_t) status); \
834 } while (0)
836         BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
838         for (i = 0; i < ds->ds_num; i++)
839         {
840                 if (ds->ds[i].type == DS_TYPE_GAUGE)
841                         BUFFER_ADD (":%f", vl->values[i].gauge);
842                 else if (store_rates)
843                 {
844                         if (rates == NULL)
845                                 rates = uc_get_rate (ds, vl);
846                         if (rates == NULL)
847                         {
848                                 WARNING ("format_values: "
849                                                 "uc_get_rate failed.");
850                                 return (-1);
851                         }
852                         BUFFER_ADD (":%g", rates[i]);
853                 }
854                 else if (ds->ds[i].type == DS_TYPE_COUNTER)
855                         BUFFER_ADD (":%llu", vl->values[i].counter);
856                 else if (ds->ds[i].type == DS_TYPE_DERIVE)
857                         BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
858                 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
859                         BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
860                 else
861                 {
862                         ERROR ("format_values plugin: Unknown data source type: %i",
863                                         ds->ds[i].type);
864                         sfree (rates);
865                         return (-1);
866                 }
867         } /* for ds->ds_num */
869 #undef BUFFER_ADD
871         sfree (rates);
872         return (0);
873 } /* }}} int format_values */
875 int parse_identifier (char *str, char **ret_host,
876                 char **ret_plugin, char **ret_plugin_instance,
877                 char **ret_type, char **ret_type_instance)
879         char *hostname = NULL;
880         char *plugin = NULL;
881         char *plugin_instance = NULL;
882         char *type = NULL;
883         char *type_instance = NULL;
885         hostname = str;
886         if (hostname == NULL)
887                 return (-1);
889         plugin = strchr (hostname, '/');
890         if (plugin == NULL)
891                 return (-1);
892         *plugin = '\0'; plugin++;
894         type = strchr (plugin, '/');
895         if (type == NULL)
896                 return (-1);
897         *type = '\0'; type++;
899         plugin_instance = strchr (plugin, '-');
900         if (plugin_instance != NULL)
901         {
902                 *plugin_instance = '\0';
903                 plugin_instance++;
904         }
906         type_instance = strchr (type, '-');
907         if (type_instance != NULL)
908         {
909                 *type_instance = '\0';
910                 type_instance++;
911         }
913         *ret_host = hostname;
914         *ret_plugin = plugin;
915         *ret_plugin_instance = plugin_instance;
916         *ret_type = type;
917         *ret_type_instance = type_instance;
918         return (0);
919 } /* int parse_identifier */
921 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
923         char str_copy[6 * DATA_MAX_NAME_LEN];
924         char *host = NULL;
925         char *plugin = NULL;
926         char *plugin_instance = NULL;
927         char *type = NULL;
928         char *type_instance = NULL;
929         int status;
931         if ((str == NULL) || (vl == NULL))
932                 return (EINVAL);
934         sstrncpy (str_copy, str, sizeof (str_copy));
936         status = parse_identifier (str_copy, &host,
937                         &plugin, &plugin_instance,
938                         &type, &type_instance);
939         if (status != 0)
940                 return (status);
942         sstrncpy (vl->host, host, sizeof (host));
943         sstrncpy (vl->plugin, plugin, sizeof (plugin));
944         sstrncpy (vl->plugin_instance,
945                         (plugin_instance != NULL) ? plugin_instance : "",
946                         sizeof (plugin_instance));
947         sstrncpy (vl->type, type, sizeof (type));
948         sstrncpy (vl->type_instance,
949                         (type_instance != NULL) ? type_instance : "",
950                         sizeof (type_instance));
952         return (0);
953 } /* }}} int parse_identifier_vl */
955 int parse_value (const char *value, value_t *ret_value, int ds_type)
957   char *endptr = NULL;
959   switch (ds_type)
960   {
961     case DS_TYPE_COUNTER:
962       ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
963       break;
965     case DS_TYPE_GAUGE:
966       ret_value->gauge = (gauge_t) strtod (value, &endptr);
967       break;
969     case DS_TYPE_DERIVE:
970       ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
971       break;
973     case DS_TYPE_ABSOLUTE:
974       ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
975       break;
977     default:
978       ERROR ("parse_value: Invalid data source type: %i.", ds_type);
979       return -1;
980   }
982   if (value == endptr) {
983     ERROR ("parse_value: Failed to parse string as number: %s.", value);
984     return -1;
985   }
986   else if ((NULL != endptr) && ('\0' != *endptr))
987     WARNING ("parse_value: Ignoring trailing garbage after number: %s.",
988         endptr);
989   return 0;
990 } /* int parse_value */
992 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
994         int i;
995         char *dummy;
996         char *ptr;
997         char *saveptr;
999         i = -1;
1000         dummy = buffer;
1001         saveptr = NULL;
1002         while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1003         {
1004                 dummy = NULL;
1006                 if (i >= vl->values_len)
1007                 {
1008                         /* Make sure i is invalid. */
1009                         i = vl->values_len + 1;
1010                         break;
1011                 }
1013                 if (i == -1)
1014                 {
1015                         if (strcmp ("N", ptr) == 0)
1016                                 vl->time = cdtime ();
1017                         else
1018                         {
1019                                 char *endptr = NULL;
1020                                 double tmp;
1022                                 errno = 0;
1023                                 tmp = strtod (ptr, &endptr);
1024                                 if ((errno != 0)                    /* Overflow */
1025                                                 || (endptr == ptr)  /* Invalid string */
1026                                                 || (endptr == NULL) /* This should not happen */
1027                                                 || (*endptr != 0))  /* Trailing chars */
1028                                         return (-1);
1030                                 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1031                         }
1032                 }
1033                 else
1034                 {
1035                         if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1036                                 vl->values[i].gauge = NAN;
1037                         else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1038                                 return -1;
1039                 }
1041                 i++;
1042         } /* while (strtok_r) */
1044         if ((ptr != NULL) || (i != vl->values_len))
1045                 return (-1);
1046         return (0);
1047 } /* int parse_values */
1049 #if !HAVE_GETPWNAM_R
1050 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1051                 size_t buflen, struct passwd **pwbufp)
1053         int status = 0;
1054         struct passwd *pw;
1056         memset (pwbuf, '\0', sizeof (struct passwd));
1058         pthread_mutex_lock (&getpwnam_r_lock);
1060         do
1061         {
1062                 pw = getpwnam (name);
1063                 if (pw == NULL)
1064                 {
1065                         status = (errno != 0) ? errno : ENOENT;
1066                         break;
1067                 }
1069 #define GETPWNAM_COPY_MEMBER(member) \
1070                 if (pw->member != NULL) \
1071                 { \
1072                         int len = strlen (pw->member); \
1073                         if (len >= buflen) \
1074                         { \
1075                                 status = ENOMEM; \
1076                                 break; \
1077                         } \
1078                         sstrncpy (buf, pw->member, buflen); \
1079                         pwbuf->member = buf; \
1080                         buf    += (len + 1); \
1081                         buflen -= (len + 1); \
1082                 }
1083                 GETPWNAM_COPY_MEMBER(pw_name);
1084                 GETPWNAM_COPY_MEMBER(pw_passwd);
1085                 GETPWNAM_COPY_MEMBER(pw_gecos);
1086                 GETPWNAM_COPY_MEMBER(pw_dir);
1087                 GETPWNAM_COPY_MEMBER(pw_shell);
1089                 pwbuf->pw_uid = pw->pw_uid;
1090                 pwbuf->pw_gid = pw->pw_gid;
1092                 if (pwbufp != NULL)
1093                         *pwbufp = pwbuf;
1094         } while (0);
1096         pthread_mutex_unlock (&getpwnam_r_lock);
1098         return (status);
1099 } /* int getpwnam_r */
1100 #endif /* !HAVE_GETPWNAM_R */
1102 int notification_init (notification_t *n, int severity, const char *message,
1103                 const char *host,
1104                 const char *plugin, const char *plugin_instance,
1105                 const char *type, const char *type_instance)
1107         memset (n, '\0', sizeof (notification_t));
1109         n->severity = severity;
1111         if (message != NULL)
1112                 sstrncpy (n->message, message, sizeof (n->message));
1113         if (host != NULL)
1114                 sstrncpy (n->host, host, sizeof (n->host));
1115         if (plugin != NULL)
1116                 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1117         if (plugin_instance != NULL)
1118                 sstrncpy (n->plugin_instance, plugin_instance,
1119                                 sizeof (n->plugin_instance));
1120         if (type != NULL)
1121                 sstrncpy (n->type, type, sizeof (n->type));
1122         if (type_instance != NULL)
1123                 sstrncpy (n->type_instance, type_instance,
1124                                 sizeof (n->type_instance));
1126         return (0);
1127 } /* int notification_init */
1129 int walk_directory (const char *dir, dirwalk_callback_f callback,
1130                 void *user_data, int include_hidden)
1132         struct dirent *ent;
1133         DIR *dh;
1134         int success;
1135         int failure;
1137         success = 0;
1138         failure = 0;
1140         if ((dh = opendir (dir)) == NULL)
1141         {
1142                 char errbuf[1024];
1143                 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1144                                 sstrerror (errno, errbuf, sizeof (errbuf)));
1145                 return -1;
1146         }
1148         while ((ent = readdir (dh)) != NULL)
1149         {
1150                 int status;
1151                 
1152                 if (include_hidden)
1153                 {
1154                         if ((strcmp (".", ent->d_name) == 0)
1155                                         || (strcmp ("..", ent->d_name) == 0))
1156                                 continue;
1157                 }
1158                 else /* if (!include_hidden) */
1159                 {
1160                         if (ent->d_name[0]=='.')
1161                                 continue;
1162                 }
1164                 status = (*callback) (dir, ent->d_name, user_data);
1165                 if (status != 0)
1166                         failure++;
1167                 else
1168                         success++;
1169         }
1171         closedir (dh);
1173         if ((success == 0) && (failure > 0))
1174                 return (-1);
1175         return (0);
1178 int read_file_contents (const char *filename, char *buf, int bufsize)
1180         FILE *fh;
1181         int n;
1183         if ((fh = fopen (filename, "r")) == NULL)
1184                 return -1;
1186         n = fread(buf, 1, bufsize, fh);
1187         fclose(fh);
1189         return n;
1192 counter_t counter_diff (counter_t old_value, counter_t new_value)
1194         counter_t diff;
1196         if (old_value > new_value)
1197         {
1198                 if (old_value <= 4294967295U)
1199                         diff = (4294967295U - old_value) + new_value;
1200                 else
1201                         diff = (18446744073709551615ULL - old_value)
1202                                 + new_value;
1203         }
1204         else
1205         {
1206                 diff = new_value - old_value;
1207         }
1209         return (diff);
1210 } /* counter_t counter_to_gauge */
1212 int service_name_to_port_number (const char *service_name)
1214         struct addrinfo *ai_list;
1215         struct addrinfo *ai_ptr;
1216         struct addrinfo ai_hints;
1217         int status;
1218         int service_number;
1220         if (service_name == NULL)
1221                 return (-1);
1223         ai_list = NULL;
1224         memset (&ai_hints, 0, sizeof (ai_hints));
1225         ai_hints.ai_family = AF_UNSPEC;
1227         status = getaddrinfo (/* node = */ NULL, service_name,
1228                         &ai_hints, &ai_list);
1229         if (status != 0)
1230         {
1231                 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1232                                 gai_strerror (status));
1233                 return (-1);
1234         }
1236         service_number = -1;
1237         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1238         {
1239                 if (ai_ptr->ai_family == AF_INET)
1240                 {
1241                         struct sockaddr_in *sa;
1243                         sa = (void *) ai_ptr->ai_addr;
1244                         service_number = (int) ntohs (sa->sin_port);
1245                 }
1246                 else if (ai_ptr->ai_family == AF_INET6)
1247                 {
1248                         struct sockaddr_in6 *sa;
1250                         sa = (void *) ai_ptr->ai_addr;
1251                         service_number = (int) ntohs (sa->sin6_port);
1252                 }
1254                 if ((service_number > 0) && (service_number <= 65535))
1255                         break;
1256         }
1258         freeaddrinfo (ai_list);
1260         if ((service_number > 0) && (service_number <= 65535))
1261                 return (service_number);
1262         return (-1);
1263 } /* int service_name_to_port_number */
1265 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1267         derive_t tmp;
1268         char *endptr;
1270         if ((string == NULL) || (ret_value == NULL))
1271                 return (EINVAL);
1273         errno = 0;
1274         endptr = NULL;
1275         tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1276         if ((endptr == string) || (errno != 0))
1277                 return (-1);
1279         *ret_value = tmp;
1280         return (0);
1281 } /* }}} int strtoderive */