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