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 if (fd < 0)
277 return (-1);
279 /* checking for closed peer connection */
280 pfd.fd = fd;
281 pfd.events = POLLIN | POLLHUP;
282 pfd.revents = 0;
283 if (poll(&pfd, 1, 0) > 0) {
284 char buffer[32];
285 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
286 // if recv returns zero (even though poll() said there is data to be read),
287 // that means the connection has been closed
288 return -1;
289 }
290 }
292 while (nleft > 0)
293 {
294 status = write (fd, (const void *) ptr, nleft);
296 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
297 continue;
299 if (status < 0)
300 return (status);
302 nleft = nleft - ((size_t) status);
303 ptr = ptr + ((size_t) status);
304 }
306 return (0);
307 }
309 int strsplit (char *string, char **fields, size_t size)
310 {
311 size_t i;
312 char *ptr;
313 char *saveptr;
315 i = 0;
316 ptr = string;
317 saveptr = NULL;
318 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
319 {
320 ptr = NULL;
321 i++;
323 if (i >= size)
324 break;
325 }
327 return ((int) i);
328 }
330 int strjoin (char *buffer, size_t buffer_size,
331 char **fields, size_t fields_num,
332 const char *sep)
333 {
334 size_t avail;
335 char *ptr;
336 size_t sep_len;
337 size_t i;
339 if ((buffer_size < 1) || (fields_num == 0))
340 return (-1);
342 memset (buffer, 0, buffer_size);
343 ptr = buffer;
344 avail = buffer_size - 1;
346 sep_len = 0;
347 if (sep != NULL)
348 sep_len = strlen (sep);
350 for (i = 0; i < fields_num; i++)
351 {
352 size_t field_len;
354 if ((i > 0) && (sep_len > 0))
355 {
356 if (avail < sep_len)
357 return (-1);
359 memcpy (ptr, sep, sep_len);
360 ptr += sep_len;
361 avail -= sep_len;
362 }
364 field_len = strlen (fields[i]);
365 if (avail < field_len)
366 return (-1);
368 memcpy (ptr, fields[i], field_len);
369 ptr += field_len;
370 avail -= field_len;
371 }
373 assert (buffer[buffer_size - 1] == 0);
374 return ((int) strlen (buffer));
375 }
377 int escape_string (char *buffer, size_t buffer_size)
378 {
379 char *temp;
380 size_t i;
381 size_t j;
383 /* Check if we need to escape at all first */
384 temp = strpbrk (buffer, " \t\"\\");
385 if (temp == NULL)
386 return (0);
388 if (buffer_size < 3)
389 return (EINVAL);
391 temp = calloc (1, buffer_size);
392 if (temp == NULL)
393 return (ENOMEM);
395 temp[0] = '"';
396 j = 1;
398 for (i = 0; i < buffer_size; i++)
399 {
400 if (buffer[i] == 0)
401 {
402 break;
403 }
404 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
405 {
406 if (j > (buffer_size - 4))
407 break;
408 temp[j] = '\\';
409 temp[j + 1] = buffer[i];
410 j += 2;
411 }
412 else
413 {
414 if (j > (buffer_size - 3))
415 break;
416 temp[j] = buffer[i];
417 j++;
418 }
419 }
421 assert ((j + 1) < buffer_size);
422 temp[j] = '"';
423 temp[j + 1] = 0;
425 sstrncpy (buffer, temp, buffer_size);
426 sfree (temp);
427 return (0);
428 } /* int escape_string */
430 int strunescape (char *buf, size_t buf_len)
431 {
432 size_t i;
434 for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
435 {
436 if (buf[i] != '\\')
437 continue;
439 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
440 ERROR ("string unescape: backslash found at end of string.");
441 /* Ensure null-byte at the end of the buffer. */
442 buf[i] = 0;
443 return (-1);
444 }
446 switch (buf[i + 1]) {
447 case 't':
448 buf[i] = '\t';
449 break;
450 case 'n':
451 buf[i] = '\n';
452 break;
453 case 'r':
454 buf[i] = '\r';
455 break;
456 default:
457 buf[i] = buf[i + 1];
458 break;
459 }
461 /* Move everything after the position one position to the left.
462 * Add a null-byte as last character in the buffer. */
463 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
464 buf[buf_len - 1] = 0;
465 }
466 return (0);
467 } /* int strunescape */
469 size_t strstripnewline (char *buffer)
470 {
471 size_t buffer_len = strlen (buffer);
473 while (buffer_len > 0)
474 {
475 if ((buffer[buffer_len - 1] != '\n')
476 && (buffer[buffer_len - 1] != '\r'))
477 break;
478 buffer_len--;
479 buffer[buffer_len] = 0;
480 }
482 return (buffer_len);
483 } /* size_t strstripnewline */
485 int escape_slashes (char *buffer, size_t buffer_size)
486 {
487 size_t buffer_len;
488 size_t i;
490 buffer_len = strlen (buffer);
492 if (buffer_len <= 1)
493 {
494 if (strcmp ("/", buffer) == 0)
495 {
496 if (buffer_size < 5)
497 return (-1);
498 sstrncpy (buffer, "root", buffer_size);
499 }
500 return (0);
501 }
503 /* Move one to the left */
504 if (buffer[0] == '/')
505 {
506 memmove (buffer, buffer + 1, buffer_len);
507 buffer_len--;
508 }
510 for (i = 0; i < buffer_len; i++)
511 {
512 if (buffer[i] == '/')
513 buffer[i] = '_';
514 }
516 return (0);
517 } /* int escape_slashes */
519 void replace_special (char *buffer, size_t buffer_size)
520 {
521 size_t i;
523 for (i = 0; i < buffer_size; i++)
524 {
525 if (buffer[i] == 0)
526 return;
527 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
528 buffer[i] = '_';
529 }
530 } /* void replace_special */
532 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
533 {
534 struct timeval *larger;
535 struct timeval *smaller;
537 int status;
539 NORMALIZE_TIMEVAL (tv0);
540 NORMALIZE_TIMEVAL (tv1);
542 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
543 {
544 if (delta != NULL) {
545 delta->tv_sec = 0;
546 delta->tv_usec = 0;
547 }
548 return (0);
549 }
551 if ((tv0.tv_sec < tv1.tv_sec)
552 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
553 {
554 larger = &tv1;
555 smaller = &tv0;
556 status = -1;
557 }
558 else
559 {
560 larger = &tv0;
561 smaller = &tv1;
562 status = 1;
563 }
565 if (delta != NULL) {
566 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
568 if (smaller->tv_usec <= larger->tv_usec)
569 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
570 else
571 {
572 --delta->tv_sec;
573 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
574 }
575 }
577 assert ((delta == NULL)
578 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
580 return (status);
581 } /* int timeval_cmp */
583 int check_create_dir (const char *file_orig)
584 {
585 struct stat statbuf;
587 char file_copy[512];
588 char dir[512];
589 int dir_len = 512;
590 char *fields[16];
591 int fields_num;
592 char *ptr;
593 char *saveptr;
594 int last_is_file = 1;
595 int path_is_absolute = 0;
596 size_t len;
597 int i;
599 /*
600 * Sanity checks first
601 */
602 if (file_orig == NULL)
603 return (-1);
605 if ((len = strlen (file_orig)) < 1)
606 return (-1);
607 else if (len >= sizeof (file_copy))
608 return (-1);
610 /*
611 * If `file_orig' ends in a slash the last component is a directory,
612 * otherwise it's a file. Act accordingly..
613 */
614 if (file_orig[len - 1] == '/')
615 last_is_file = 0;
616 if (file_orig[0] == '/')
617 path_is_absolute = 1;
619 /*
620 * Create a copy for `strtok_r' to destroy
621 */
622 sstrncpy (file_copy, file_orig, sizeof (file_copy));
624 /*
625 * Break into components. This will eat up several slashes in a row and
626 * remove leading and trailing slashes..
627 */
628 ptr = file_copy;
629 saveptr = NULL;
630 fields_num = 0;
631 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
632 {
633 ptr = NULL;
634 fields_num++;
636 if (fields_num >= 16)
637 break;
638 }
640 /*
641 * For each component, do..
642 */
643 for (i = 0; i < (fields_num - last_is_file); i++)
644 {
645 /*
646 * Do not create directories that start with a dot. This
647 * prevents `../../' attacks and other likely malicious
648 * behavior.
649 */
650 if (fields[i][0] == '.')
651 {
652 ERROR ("Cowardly refusing to create a directory that "
653 "begins with a `.' (dot): `%s'", file_orig);
654 return (-2);
655 }
657 /*
658 * Join the components together again
659 */
660 dir[0] = '/';
661 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
662 fields, (size_t) (i + 1), "/") < 0)
663 {
664 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
665 return (-1);
666 }
668 while (42) {
669 if ((stat (dir, &statbuf) == -1)
670 && (lstat (dir, &statbuf) == -1))
671 {
672 if (errno == ENOENT)
673 {
674 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
675 break;
677 /* this might happen, if a different thread created
678 * the directory in the meantime
679 * => call stat() again to check for S_ISDIR() */
680 if (EEXIST == errno)
681 continue;
683 char errbuf[1024];
684 ERROR ("check_create_dir: mkdir (%s): %s", dir,
685 sstrerror (errno,
686 errbuf, sizeof (errbuf)));
687 return (-1);
688 }
689 else
690 {
691 char errbuf[1024];
692 ERROR ("check_create_dir: stat (%s): %s", dir,
693 sstrerror (errno, errbuf,
694 sizeof (errbuf)));
695 return (-1);
696 }
697 }
698 else if (!S_ISDIR (statbuf.st_mode))
699 {
700 ERROR ("check_create_dir: `%s' exists but is not "
701 "a directory!", dir);
702 return (-1);
703 }
704 break;
705 }
706 }
708 return (0);
709 } /* check_create_dir */
711 #ifdef HAVE_LIBKSTAT
712 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
713 {
714 char ident[128];
716 *ksp_ptr = NULL;
718 if (kc == NULL)
719 return (-1);
721 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
723 *ksp_ptr = kstat_lookup (kc, module, instance, name);
724 if (*ksp_ptr == NULL)
725 {
726 ERROR ("get_kstat: Cound not find kstat %s", ident);
727 return (-1);
728 }
730 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
731 {
732 ERROR ("get_kstat: kstat %s has wrong type", ident);
733 *ksp_ptr = NULL;
734 return (-1);
735 }
737 #ifdef assert
738 assert (*ksp_ptr != NULL);
739 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
740 #endif
742 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
743 {
744 ERROR ("get_kstat: kstat %s could not be read", ident);
745 return (-1);
746 }
748 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
749 {
750 ERROR ("get_kstat: kstat %s has wrong type", ident);
751 return (-1);
752 }
754 return (0);
755 }
757 long long get_kstat_value (kstat_t *ksp, char *name)
758 {
759 kstat_named_t *kn;
760 long long retval = -1LL;
762 if (ksp == NULL)
763 {
764 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
765 return (-1LL);
766 }
767 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
768 {
769 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
770 "is not KSTAT_TYPE_NAMED (%#x).",
771 name,
772 (unsigned int) ksp->ks_type,
773 (unsigned int) KSTAT_TYPE_NAMED);
774 return (-1LL);
775 }
777 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
778 return (-1LL);
780 if (kn->data_type == KSTAT_DATA_INT32)
781 retval = (long long) kn->value.i32;
782 else if (kn->data_type == KSTAT_DATA_UINT32)
783 retval = (long long) kn->value.ui32;
784 else if (kn->data_type == KSTAT_DATA_INT64)
785 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
786 else if (kn->data_type == KSTAT_DATA_UINT64)
787 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
788 else
789 WARNING ("get_kstat_value: Not a numeric value: %s", name);
791 return (retval);
792 }
793 #endif /* HAVE_LIBKSTAT */
795 #ifndef HAVE_HTONLL
796 unsigned long long ntohll (unsigned long long n)
797 {
798 #if BYTE_ORDER == BIG_ENDIAN
799 return (n);
800 #else
801 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
802 #endif
803 } /* unsigned long long ntohll */
805 unsigned long long htonll (unsigned long long n)
806 {
807 #if BYTE_ORDER == BIG_ENDIAN
808 return (n);
809 #else
810 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
811 #endif
812 } /* unsigned long long htonll */
813 #endif /* HAVE_HTONLL */
815 #if FP_LAYOUT_NEED_NOTHING
816 /* Well, we need nothing.. */
817 /* #endif FP_LAYOUT_NEED_NOTHING */
819 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
820 # if FP_LAYOUT_NEED_ENDIANFLIP
821 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
822 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
823 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
824 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
825 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
826 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
827 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
828 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
829 # else
830 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
831 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
832 # endif
834 double ntohd (double d)
835 {
836 union
837 {
838 uint8_t byte[8];
839 uint64_t integer;
840 double floating;
841 } ret;
843 ret.floating = d;
845 /* NAN in x86 byte order */
846 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
847 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
848 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
849 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
850 {
851 return (NAN);
852 }
853 else
854 {
855 uint64_t tmp;
857 tmp = ret.integer;
858 ret.integer = FP_CONVERT (tmp);
859 return (ret.floating);
860 }
861 } /* double ntohd */
863 double htond (double d)
864 {
865 union
866 {
867 uint8_t byte[8];
868 uint64_t integer;
869 double floating;
870 } ret;
872 if (isnan (d))
873 {
874 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
875 ret.byte[4] = ret.byte[5] = 0x00;
876 ret.byte[6] = 0xf8;
877 ret.byte[7] = 0x7f;
878 return (ret.floating);
879 }
880 else
881 {
882 uint64_t tmp;
884 ret.floating = d;
885 tmp = FP_CONVERT (ret.integer);
886 ret.integer = tmp;
887 return (ret.floating);
888 }
889 } /* double htond */
890 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
892 int format_name (char *ret, int ret_len,
893 const char *hostname,
894 const char *plugin, const char *plugin_instance,
895 const char *type, const char *type_instance)
896 {
897 char *buffer;
898 size_t buffer_size;
900 buffer = ret;
901 buffer_size = (size_t) ret_len;
903 #define APPEND(str) do { \
904 size_t l = strlen (str); \
905 if (l >= buffer_size) \
906 return (ENOBUFS); \
907 memcpy (buffer, (str), l); \
908 buffer += l; buffer_size -= l; \
909 } while (0)
911 assert (plugin != NULL);
912 assert (type != NULL);
914 APPEND (hostname);
915 APPEND ("/");
916 APPEND (plugin);
917 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
918 {
919 APPEND ("-");
920 APPEND (plugin_instance);
921 }
922 APPEND ("/");
923 APPEND (type);
924 if ((type_instance != NULL) && (type_instance[0] != 0))
925 {
926 APPEND ("-");
927 APPEND (type_instance);
928 }
929 assert (buffer_size > 0);
930 buffer[0] = 0;
932 #undef APPEND
933 return (0);
934 } /* int format_name */
936 int format_values (char *ret, size_t ret_len, /* {{{ */
937 const data_set_t *ds, const value_list_t *vl,
938 _Bool store_rates)
939 {
940 size_t offset = 0;
941 int status;
942 size_t i;
943 gauge_t *rates = NULL;
945 assert (0 == strcmp (ds->type, vl->type));
947 memset (ret, 0, ret_len);
949 #define BUFFER_ADD(...) do { \
950 status = ssnprintf (ret + offset, ret_len - offset, \
951 __VA_ARGS__); \
952 if (status < 1) \
953 { \
954 sfree (rates); \
955 return (-1); \
956 } \
957 else if (((size_t) status) >= (ret_len - offset)) \
958 { \
959 sfree (rates); \
960 return (-1); \
961 } \
962 else \
963 offset += ((size_t) status); \
964 } while (0)
966 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
968 for (i = 0; i < ds->ds_num; i++)
969 {
970 if (ds->ds[i].type == DS_TYPE_GAUGE)
971 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
972 else if (store_rates)
973 {
974 if (rates == NULL)
975 rates = uc_get_rate (ds, vl);
976 if (rates == NULL)
977 {
978 WARNING ("format_values: uc_get_rate failed.");
979 return (-1);
980 }
981 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
982 }
983 else if (ds->ds[i].type == DS_TYPE_COUNTER)
984 BUFFER_ADD (":%llu", vl->values[i].counter);
985 else if (ds->ds[i].type == DS_TYPE_DERIVE)
986 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
987 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
988 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
989 else
990 {
991 ERROR ("format_values: Unknown data source type: %i",
992 ds->ds[i].type);
993 sfree (rates);
994 return (-1);
995 }
996 } /* for ds->ds_num */
998 #undef BUFFER_ADD
1000 sfree (rates);
1001 return (0);
1002 } /* }}} int format_values */
1004 int parse_identifier (char *str, char **ret_host,
1005 char **ret_plugin, char **ret_plugin_instance,
1006 char **ret_type, char **ret_type_instance)
1007 {
1008 char *hostname = NULL;
1009 char *plugin = NULL;
1010 char *plugin_instance = NULL;
1011 char *type = NULL;
1012 char *type_instance = NULL;
1014 hostname = str;
1015 if (hostname == NULL)
1016 return (-1);
1018 plugin = strchr (hostname, '/');
1019 if (plugin == NULL)
1020 return (-1);
1021 *plugin = '\0'; plugin++;
1023 type = strchr (plugin, '/');
1024 if (type == NULL)
1025 return (-1);
1026 *type = '\0'; type++;
1028 plugin_instance = strchr (plugin, '-');
1029 if (plugin_instance != NULL)
1030 {
1031 *plugin_instance = '\0';
1032 plugin_instance++;
1033 }
1035 type_instance = strchr (type, '-');
1036 if (type_instance != NULL)
1037 {
1038 *type_instance = '\0';
1039 type_instance++;
1040 }
1042 *ret_host = hostname;
1043 *ret_plugin = plugin;
1044 *ret_plugin_instance = plugin_instance;
1045 *ret_type = type;
1046 *ret_type_instance = type_instance;
1047 return (0);
1048 } /* int parse_identifier */
1050 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1051 {
1052 char str_copy[6 * DATA_MAX_NAME_LEN];
1053 char *host = NULL;
1054 char *plugin = NULL;
1055 char *plugin_instance = NULL;
1056 char *type = NULL;
1057 char *type_instance = NULL;
1058 int status;
1060 if ((str == NULL) || (vl == NULL))
1061 return (EINVAL);
1063 sstrncpy (str_copy, str, sizeof (str_copy));
1065 status = parse_identifier (str_copy, &host,
1066 &plugin, &plugin_instance,
1067 &type, &type_instance);
1068 if (status != 0)
1069 return (status);
1071 sstrncpy (vl->host, host, sizeof (vl->host));
1072 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1073 sstrncpy (vl->plugin_instance,
1074 (plugin_instance != NULL) ? plugin_instance : "",
1075 sizeof (vl->plugin_instance));
1076 sstrncpy (vl->type, type, sizeof (vl->type));
1077 sstrncpy (vl->type_instance,
1078 (type_instance != NULL) ? type_instance : "",
1079 sizeof (vl->type_instance));
1081 return (0);
1082 } /* }}} int parse_identifier_vl */
1084 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1085 {
1086 char *value;
1087 char *endptr = NULL;
1088 size_t value_len;
1090 if (value_orig == NULL)
1091 return (EINVAL);
1093 value = strdup (value_orig);
1094 if (value == NULL)
1095 return (ENOMEM);
1096 value_len = strlen (value);
1098 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1099 {
1100 value[value_len - 1] = 0;
1101 value_len--;
1102 }
1104 switch (ds_type)
1105 {
1106 case DS_TYPE_COUNTER:
1107 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1108 break;
1110 case DS_TYPE_GAUGE:
1111 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1112 break;
1114 case DS_TYPE_DERIVE:
1115 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1116 break;
1118 case DS_TYPE_ABSOLUTE:
1119 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1120 break;
1122 default:
1123 sfree (value);
1124 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1125 return -1;
1126 }
1128 if (value == endptr) {
1129 ERROR ("parse_value: Failed to parse string as %s: %s.",
1130 DS_TYPE_TO_STRING (ds_type), value);
1131 sfree (value);
1132 return -1;
1133 }
1134 else if ((NULL != endptr) && ('\0' != *endptr))
1135 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1136 "Input string was \"%s\".",
1137 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1139 sfree (value);
1140 return 0;
1141 } /* int parse_value */
1143 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1144 {
1145 size_t i;
1146 char *dummy;
1147 char *ptr;
1148 char *saveptr;
1150 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1151 return EINVAL;
1153 i = 0;
1154 dummy = buffer;
1155 saveptr = NULL;
1156 vl->time = 0;
1157 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1158 {
1159 dummy = NULL;
1161 if (i >= vl->values_len)
1162 {
1163 /* Make sure i is invalid. */
1164 i = 0;
1165 break;
1166 }
1168 if (vl->time == 0)
1169 {
1170 if (strcmp ("N", ptr) == 0)
1171 vl->time = cdtime ();
1172 else
1173 {
1174 char *endptr = NULL;
1175 double tmp;
1177 errno = 0;
1178 tmp = strtod (ptr, &endptr);
1179 if ((errno != 0) /* Overflow */
1180 || (endptr == ptr) /* Invalid string */
1181 || (endptr == NULL) /* This should not happen */
1182 || (*endptr != 0)) /* Trailing chars */
1183 return (-1);
1185 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1186 }
1188 continue;
1189 }
1191 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1192 vl->values[i].gauge = NAN;
1193 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1194 return -1;
1196 i++;
1197 } /* while (strtok_r) */
1199 if ((ptr != NULL) || (i == 0))
1200 return (-1);
1201 return (0);
1202 } /* int parse_values */
1204 #if !HAVE_GETPWNAM_R
1205 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1206 size_t buflen, struct passwd **pwbufp)
1207 {
1208 int status = 0;
1209 struct passwd *pw;
1211 memset (pwbuf, '\0', sizeof (struct passwd));
1213 pthread_mutex_lock (&getpwnam_r_lock);
1215 do
1216 {
1217 pw = getpwnam (name);
1218 if (pw == NULL)
1219 {
1220 status = (errno != 0) ? errno : ENOENT;
1221 break;
1222 }
1224 #define GETPWNAM_COPY_MEMBER(member) \
1225 if (pw->member != NULL) \
1226 { \
1227 int len = strlen (pw->member); \
1228 if (len >= buflen) \
1229 { \
1230 status = ENOMEM; \
1231 break; \
1232 } \
1233 sstrncpy (buf, pw->member, buflen); \
1234 pwbuf->member = buf; \
1235 buf += (len + 1); \
1236 buflen -= (len + 1); \
1237 }
1238 GETPWNAM_COPY_MEMBER(pw_name);
1239 GETPWNAM_COPY_MEMBER(pw_passwd);
1240 GETPWNAM_COPY_MEMBER(pw_gecos);
1241 GETPWNAM_COPY_MEMBER(pw_dir);
1242 GETPWNAM_COPY_MEMBER(pw_shell);
1244 pwbuf->pw_uid = pw->pw_uid;
1245 pwbuf->pw_gid = pw->pw_gid;
1247 if (pwbufp != NULL)
1248 *pwbufp = pwbuf;
1249 } while (0);
1251 pthread_mutex_unlock (&getpwnam_r_lock);
1253 return (status);
1254 } /* int getpwnam_r */
1255 #endif /* !HAVE_GETPWNAM_R */
1257 int notification_init (notification_t *n, int severity, const char *message,
1258 const char *host,
1259 const char *plugin, const char *plugin_instance,
1260 const char *type, const char *type_instance)
1261 {
1262 memset (n, '\0', sizeof (notification_t));
1264 n->severity = severity;
1266 if (message != NULL)
1267 sstrncpy (n->message, message, sizeof (n->message));
1268 if (host != NULL)
1269 sstrncpy (n->host, host, sizeof (n->host));
1270 if (plugin != NULL)
1271 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1272 if (plugin_instance != NULL)
1273 sstrncpy (n->plugin_instance, plugin_instance,
1274 sizeof (n->plugin_instance));
1275 if (type != NULL)
1276 sstrncpy (n->type, type, sizeof (n->type));
1277 if (type_instance != NULL)
1278 sstrncpy (n->type_instance, type_instance,
1279 sizeof (n->type_instance));
1281 return (0);
1282 } /* int notification_init */
1284 int walk_directory (const char *dir, dirwalk_callback_f callback,
1285 void *user_data, int include_hidden)
1286 {
1287 struct dirent *ent;
1288 DIR *dh;
1289 int success;
1290 int failure;
1292 success = 0;
1293 failure = 0;
1295 if ((dh = opendir (dir)) == NULL)
1296 {
1297 char errbuf[1024];
1298 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1299 sstrerror (errno, errbuf, sizeof (errbuf)));
1300 return -1;
1301 }
1303 while ((ent = readdir (dh)) != NULL)
1304 {
1305 int status;
1307 if (include_hidden)
1308 {
1309 if ((strcmp (".", ent->d_name) == 0)
1310 || (strcmp ("..", ent->d_name) == 0))
1311 continue;
1312 }
1313 else /* if (!include_hidden) */
1314 {
1315 if (ent->d_name[0]=='.')
1316 continue;
1317 }
1319 status = (*callback) (dir, ent->d_name, user_data);
1320 if (status != 0)
1321 failure++;
1322 else
1323 success++;
1324 }
1326 closedir (dh);
1328 if ((success == 0) && (failure > 0))
1329 return (-1);
1330 return (0);
1331 }
1333 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1334 {
1335 FILE *fh;
1336 ssize_t ret;
1338 fh = fopen (filename, "r");
1339 if (fh == NULL)
1340 return (-1);
1342 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1343 if ((ret == 0) && (ferror (fh) != 0))
1344 {
1345 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1346 filename);
1347 ret = -1;
1348 }
1350 fclose(fh);
1351 return (ret);
1352 }
1354 counter_t counter_diff (counter_t old_value, counter_t new_value)
1355 {
1356 counter_t diff;
1358 if (old_value > new_value)
1359 {
1360 if (old_value <= 4294967295U)
1361 diff = (4294967295U - old_value) + new_value + 1;
1362 else
1363 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1364 }
1365 else
1366 {
1367 diff = new_value - old_value;
1368 }
1370 return (diff);
1371 } /* counter_t counter_diff */
1373 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1374 rate_to_value_state_t *state,
1375 int ds_type, cdtime_t t)
1376 {
1377 gauge_t delta_gauge;
1378 cdtime_t delta_t;
1380 if (ds_type == DS_TYPE_GAUGE)
1381 {
1382 state->last_value.gauge = rate;
1383 state->last_time = t;
1385 *ret_value = state->last_value;
1386 return (0);
1387 }
1389 /* Counter and absolute can't handle negative rates. Reset "last time"
1390 * to zero, so that the next valid rate will re-initialize the
1391 * structure. */
1392 if ((rate < 0.0)
1393 && ((ds_type == DS_TYPE_COUNTER)
1394 || (ds_type == DS_TYPE_ABSOLUTE)))
1395 {
1396 memset (state, 0, sizeof (*state));
1397 return (EINVAL);
1398 }
1400 /* Another invalid state: The time is not increasing. */
1401 if (t <= state->last_time)
1402 {
1403 memset (state, 0, sizeof (*state));
1404 return (EINVAL);
1405 }
1407 delta_t = t - state->last_time;
1408 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1410 /* Previous value is invalid. */
1411 if (state->last_time == 0) /* {{{ */
1412 {
1413 if (ds_type == DS_TYPE_DERIVE)
1414 {
1415 state->last_value.derive = (derive_t) rate;
1416 state->residual = rate - ((gauge_t) state->last_value.derive);
1417 }
1418 else if (ds_type == DS_TYPE_COUNTER)
1419 {
1420 state->last_value.counter = (counter_t) rate;
1421 state->residual = rate - ((gauge_t) state->last_value.counter);
1422 }
1423 else if (ds_type == DS_TYPE_ABSOLUTE)
1424 {
1425 state->last_value.absolute = (absolute_t) rate;
1426 state->residual = rate - ((gauge_t) state->last_value.absolute);
1427 }
1428 else
1429 {
1430 assert (23 == 42);
1431 }
1433 state->last_time = t;
1434 return (EAGAIN);
1435 } /* }}} */
1437 if (ds_type == DS_TYPE_DERIVE)
1438 {
1439 derive_t delta_derive = (derive_t) delta_gauge;
1441 state->last_value.derive += delta_derive;
1442 state->residual = delta_gauge - ((gauge_t) delta_derive);
1443 }
1444 else if (ds_type == DS_TYPE_COUNTER)
1445 {
1446 counter_t delta_counter = (counter_t) delta_gauge;
1448 state->last_value.counter += delta_counter;
1449 state->residual = delta_gauge - ((gauge_t) delta_counter);
1450 }
1451 else if (ds_type == DS_TYPE_ABSOLUTE)
1452 {
1453 absolute_t delta_absolute = (absolute_t) delta_gauge;
1455 state->last_value.absolute = delta_absolute;
1456 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1457 }
1458 else
1459 {
1460 assert (23 == 42);
1461 }
1463 state->last_time = t;
1464 *ret_value = state->last_value;
1465 return (0);
1466 } /* }}} value_t rate_to_value */
1468 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1469 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1470 {
1471 gauge_t interval;
1473 /* Another invalid state: The time is not increasing. */
1474 if (t <= state->last_time)
1475 {
1476 memset (state, 0, sizeof (*state));
1477 return (EINVAL);
1478 }
1480 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1482 /* Previous value is invalid. */
1483 if (state->last_time == 0)
1484 {
1485 state->last_value = value;
1486 state->last_time = t;
1487 return (EAGAIN);
1488 }
1490 switch (ds_type) {
1491 case DS_TYPE_DERIVE: {
1492 derive_t diff = value.derive - state->last_value.derive;
1493 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1494 break;
1495 }
1496 case DS_TYPE_GAUGE: {
1497 *ret_rate = value.gauge;
1498 break;
1499 }
1500 case DS_TYPE_COUNTER: {
1501 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1502 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1503 break;
1504 }
1505 case DS_TYPE_ABSOLUTE: {
1506 absolute_t diff = value.absolute;
1507 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1508 break;
1509 }
1510 default:
1511 return EINVAL;
1512 }
1514 state->last_value = value;
1515 state->last_time = t;
1516 return (0);
1517 } /* }}} value_t rate_to_value */
1519 int service_name_to_port_number (const char *service_name)
1520 {
1521 struct addrinfo *ai_list;
1522 struct addrinfo *ai_ptr;
1523 struct addrinfo ai_hints;
1524 int status;
1525 int service_number;
1527 if (service_name == NULL)
1528 return (-1);
1530 ai_list = NULL;
1531 memset (&ai_hints, 0, sizeof (ai_hints));
1532 ai_hints.ai_family = AF_UNSPEC;
1534 status = getaddrinfo (/* node = */ NULL, service_name,
1535 &ai_hints, &ai_list);
1536 if (status != 0)
1537 {
1538 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1539 gai_strerror (status));
1540 return (-1);
1541 }
1543 service_number = -1;
1544 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1545 {
1546 if (ai_ptr->ai_family == AF_INET)
1547 {
1548 struct sockaddr_in *sa;
1550 sa = (void *) ai_ptr->ai_addr;
1551 service_number = (int) ntohs (sa->sin_port);
1552 }
1553 else if (ai_ptr->ai_family == AF_INET6)
1554 {
1555 struct sockaddr_in6 *sa;
1557 sa = (void *) ai_ptr->ai_addr;
1558 service_number = (int) ntohs (sa->sin6_port);
1559 }
1561 if ((service_number > 0) && (service_number <= 65535))
1562 break;
1563 }
1565 freeaddrinfo (ai_list);
1567 if ((service_number > 0) && (service_number <= 65535))
1568 return (service_number);
1569 return (-1);
1570 } /* int service_name_to_port_number */
1572 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1573 {
1574 derive_t tmp;
1575 char *endptr;
1577 if ((string == NULL) || (ret_value == NULL))
1578 return (EINVAL);
1580 errno = 0;
1581 endptr = NULL;
1582 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1583 if ((endptr == string) || (errno != 0))
1584 return (-1);
1586 *ret_value = tmp;
1587 return (0);
1588 } /* }}} int strtoderive */
1590 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1591 {
1592 gauge_t tmp;
1593 char *endptr = NULL;
1595 if ((string == NULL) || (ret_value == NULL))
1596 return (EINVAL);
1598 errno = 0;
1599 endptr = NULL;
1600 tmp = (gauge_t) strtod (string, &endptr);
1601 if (errno != 0)
1602 return (errno);
1603 else if ((endptr == NULL) || (*endptr != 0))
1604 return (EINVAL);
1606 *ret_value = tmp;
1607 return (0);
1608 } /* }}} int strtogauge */
1610 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1611 {
1612 char **array;
1613 size_t array_len = *ret_array_len;
1615 if (str == NULL)
1616 return (EINVAL);
1618 array = realloc (*ret_array,
1619 (array_len + 1) * sizeof (*array));
1620 if (array == NULL)
1621 return (ENOMEM);
1622 *ret_array = array;
1624 array[array_len] = strdup (str);
1625 if (array[array_len] == NULL)
1626 return (ENOMEM);
1628 array_len++;
1629 *ret_array_len = array_len;
1630 return (0);
1631 } /* }}} int strarray_add */
1633 void strarray_free (char **array, size_t array_len) /* {{{ */
1634 {
1635 size_t i;
1637 for (i = 0; i < array_len; i++)
1638 sfree (array[i]);
1639 sfree (array);
1640 } /* }}} void strarray_free */