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