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 #ifdef HAVE_MATH_H
40 # include <math.h>
41 #endif
43 /* for getaddrinfo */
44 #include <sys/types.h>
45 #include <netdb.h>
47 #include <poll.h>
49 #if HAVE_NETINET_IN_H
50 # include <netinet/in.h>
51 #endif
53 /* for ntohl and htonl */
54 #if HAVE_ARPA_INET_H
55 # include <arpa/inet.h>
56 #endif
58 #ifdef HAVE_LIBKSTAT
59 extern kstat_ctl_t *kc;
60 #endif
62 #if !HAVE_GETPWNAM_R
63 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
64 #endif
66 #if !HAVE_STRERROR_R
67 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
68 #endif
70 char *sstrncpy (char *dest, const char *src, size_t n)
71 {
72 strncpy (dest, src, n);
73 dest[n - 1] = '\0';
75 return (dest);
76 } /* char *sstrncpy */
78 int ssnprintf (char *dest, size_t n, const char *format, ...)
79 {
80 int ret = 0;
81 va_list ap;
83 va_start (ap, format);
84 ret = vsnprintf (dest, n, format, ap);
85 dest[n - 1] = '\0';
86 va_end (ap);
88 return (ret);
89 } /* int ssnprintf */
91 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
92 {
93 char static_buffer[1024] = "";
94 char *alloc_buffer;
95 size_t alloc_buffer_size;
96 int status;
97 va_list ap;
99 /* Try printing into the static buffer. In many cases it will be
100 * sufficiently large and we can simply return a strdup() of this
101 * buffer. */
102 va_start (ap, format);
103 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
104 va_end (ap);
105 if (status < 0)
106 return (NULL);
108 /* "status" does not include the null byte. */
109 alloc_buffer_size = (size_t) (status + 1);
110 if (alloc_buffer_size <= sizeof (static_buffer))
111 return (strdup (static_buffer));
113 /* Allocate a buffer large enough to hold the string. */
114 alloc_buffer = calloc (1, alloc_buffer_size);
115 if (alloc_buffer == NULL)
116 return (NULL);
118 /* Print again into this new buffer. */
119 va_start (ap, format);
120 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
121 va_end (ap);
122 if (status < 0)
123 {
124 sfree (alloc_buffer);
125 return (NULL);
126 }
128 return (alloc_buffer);
129 } /* }}} char *ssnprintf_alloc */
131 char *sstrdup (const char *s)
132 {
133 char *r;
134 size_t sz;
136 if (s == NULL)
137 return (NULL);
139 /* Do not use `strdup' here, because it's not specified in POSIX. It's
140 * ``only'' an XSI extension. */
141 sz = strlen (s) + 1;
142 r = malloc (sz);
143 if (r == NULL)
144 {
145 ERROR ("sstrdup: Out of memory.");
146 exit (3);
147 }
148 memcpy (r, s, sizeof (char) * sz);
150 return (r);
151 } /* char *sstrdup */
153 /* Even though Posix requires "strerror_r" to return an "int",
154 * some systems (e.g. the GNU libc) return a "char *" _and_
155 * ignore the second argument ... -tokkee */
156 char *sstrerror (int errnum, char *buf, size_t buflen)
157 {
158 buf[0] = '\0';
160 #if !HAVE_STRERROR_R
161 {
162 char *temp;
164 pthread_mutex_lock (&strerror_r_lock);
166 temp = strerror (errnum);
167 sstrncpy (buf, temp, buflen);
169 pthread_mutex_unlock (&strerror_r_lock);
170 }
171 /* #endif !HAVE_STRERROR_R */
173 #elif STRERROR_R_CHAR_P
174 {
175 char *temp;
176 temp = strerror_r (errnum, buf, buflen);
177 if (buf[0] == '\0')
178 {
179 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
180 sstrncpy (buf, temp, buflen);
181 else
182 sstrncpy (buf, "strerror_r did not return "
183 "an error message", buflen);
184 }
185 }
186 /* #endif STRERROR_R_CHAR_P */
188 #else
189 if (strerror_r (errnum, buf, buflen) != 0)
190 {
191 ssnprintf (buf, buflen, "Error #%i; "
192 "Additionally, strerror_r failed.",
193 errnum);
194 }
195 #endif /* STRERROR_R_CHAR_P */
197 return (buf);
198 } /* char *sstrerror */
200 void *smalloc (size_t size)
201 {
202 void *r;
204 if ((r = malloc (size)) == NULL)
205 {
206 ERROR ("Not enough memory.");
207 exit (3);
208 }
210 return (r);
211 } /* void *smalloc */
213 #if 0
214 void sfree (void **ptr)
215 {
216 if (ptr == NULL)
217 return;
219 if (*ptr != NULL)
220 free (*ptr);
222 *ptr = NULL;
223 }
224 #endif
226 ssize_t sread (int fd, void *buf, size_t count)
227 {
228 char *ptr;
229 size_t nleft;
230 ssize_t status;
232 ptr = (char *) buf;
233 nleft = count;
235 while (nleft > 0)
236 {
237 status = read (fd, (void *) ptr, nleft);
239 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
240 continue;
242 if (status < 0)
243 return (status);
245 if (status == 0)
246 {
247 DEBUG ("Received EOF from fd %i. "
248 "Closing fd and returning error.",
249 fd);
250 close (fd);
251 return (-1);
252 }
254 assert ((0 > status) || (nleft >= (size_t)status));
256 nleft = nleft - ((size_t) status);
257 ptr = ptr + ((size_t) status);
258 }
260 return (0);
261 }
264 ssize_t swrite (int fd, const void *buf, size_t count)
265 {
266 const char *ptr;
267 size_t nleft;
268 ssize_t status;
269 struct pollfd pfd;
271 ptr = (const char *) buf;
272 nleft = count;
274 if (fd < 0)
275 return (-1);
277 /* checking for closed peer connection */
278 pfd.fd = fd;
279 pfd.events = POLLIN | POLLHUP;
280 pfd.revents = 0;
281 if (poll(&pfd, 1, 0) > 0) {
282 char buffer[32];
283 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
284 // if recv returns zero (even though poll() said there is data to be read),
285 // that means the connection has been closed
286 return -1;
287 }
288 }
290 while (nleft > 0)
291 {
292 status = write (fd, (const void *) ptr, nleft);
294 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
295 continue;
297 if (status < 0)
298 return (status);
300 nleft = nleft - ((size_t) status);
301 ptr = ptr + ((size_t) status);
302 }
304 return (0);
305 }
307 int strsplit (char *string, char **fields, size_t size)
308 {
309 size_t i;
310 char *ptr;
311 char *saveptr;
313 i = 0;
314 ptr = string;
315 saveptr = NULL;
316 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
317 {
318 ptr = NULL;
319 i++;
321 if (i >= size)
322 break;
323 }
325 return ((int) i);
326 }
328 int strjoin (char *buffer, size_t buffer_size,
329 char **fields, size_t fields_num,
330 const char *sep)
331 {
332 size_t avail;
333 char *ptr;
334 size_t sep_len;
335 size_t i;
337 if ((buffer_size < 1) || (fields_num == 0))
338 return (-1);
340 memset (buffer, 0, buffer_size);
341 ptr = buffer;
342 avail = buffer_size - 1;
344 sep_len = 0;
345 if (sep != NULL)
346 sep_len = strlen (sep);
348 for (i = 0; i < fields_num; i++)
349 {
350 size_t field_len;
352 if ((i > 0) && (sep_len > 0))
353 {
354 if (avail < sep_len)
355 return (-1);
357 memcpy (ptr, sep, sep_len);
358 ptr += sep_len;
359 avail -= sep_len;
360 }
362 field_len = strlen (fields[i]);
363 if (avail < field_len)
364 return (-1);
366 memcpy (ptr, fields[i], field_len);
367 ptr += field_len;
368 avail -= field_len;
369 }
371 assert (buffer[buffer_size - 1] == 0);
372 return ((int) strlen (buffer));
373 }
375 int escape_string (char *buffer, size_t buffer_size)
376 {
377 char *temp;
378 size_t i;
379 size_t j;
381 /* Check if we need to escape at all first */
382 temp = strpbrk (buffer, " \t\"\\");
383 if (temp == NULL)
384 return (0);
386 if (buffer_size < 3)
387 return (EINVAL);
389 temp = calloc (1, buffer_size);
390 if (temp == NULL)
391 return (ENOMEM);
393 temp[0] = '"';
394 j = 1;
396 for (i = 0; i < buffer_size; i++)
397 {
398 if (buffer[i] == 0)
399 {
400 break;
401 }
402 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
403 {
404 if (j > (buffer_size - 4))
405 break;
406 temp[j] = '\\';
407 temp[j + 1] = buffer[i];
408 j += 2;
409 }
410 else
411 {
412 if (j > (buffer_size - 3))
413 break;
414 temp[j] = buffer[i];
415 j++;
416 }
417 }
419 assert ((j + 1) < buffer_size);
420 temp[j] = '"';
421 temp[j + 1] = 0;
423 sstrncpy (buffer, temp, buffer_size);
424 sfree (temp);
425 return (0);
426 } /* int escape_string */
428 int strunescape (char *buf, size_t buf_len)
429 {
430 size_t i;
432 for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
433 {
434 if (buf[i] != '\\')
435 continue;
437 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
438 ERROR ("string unescape: backslash found at end of string.");
439 /* Ensure null-byte at the end of the buffer. */
440 buf[i] = 0;
441 return (-1);
442 }
444 switch (buf[i + 1]) {
445 case 't':
446 buf[i] = '\t';
447 break;
448 case 'n':
449 buf[i] = '\n';
450 break;
451 case 'r':
452 buf[i] = '\r';
453 break;
454 default:
455 buf[i] = buf[i + 1];
456 break;
457 }
459 /* Move everything after the position one position to the left.
460 * Add a null-byte as last character in the buffer. */
461 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
462 buf[buf_len - 1] = 0;
463 }
464 return (0);
465 } /* int strunescape */
467 size_t strstripnewline (char *buffer)
468 {
469 size_t buffer_len = strlen (buffer);
471 while (buffer_len > 0)
472 {
473 if ((buffer[buffer_len - 1] != '\n')
474 && (buffer[buffer_len - 1] != '\r'))
475 break;
476 buffer_len--;
477 buffer[buffer_len] = 0;
478 }
480 return (buffer_len);
481 } /* size_t strstripnewline */
483 int escape_slashes (char *buffer, size_t buffer_size)
484 {
485 size_t buffer_len;
486 size_t i;
488 buffer_len = strlen (buffer);
490 if (buffer_len <= 1)
491 {
492 if (strcmp ("/", buffer) == 0)
493 {
494 if (buffer_size < 5)
495 return (-1);
496 sstrncpy (buffer, "root", buffer_size);
497 }
498 return (0);
499 }
501 /* Move one to the left */
502 if (buffer[0] == '/')
503 {
504 memmove (buffer, buffer + 1, buffer_len);
505 buffer_len--;
506 }
508 for (i = 0; i < buffer_len; i++)
509 {
510 if (buffer[i] == '/')
511 buffer[i] = '_';
512 }
514 return (0);
515 } /* int escape_slashes */
517 void replace_special (char *buffer, size_t buffer_size)
518 {
519 size_t i;
521 for (i = 0; i < buffer_size; i++)
522 {
523 if (buffer[i] == 0)
524 return;
525 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
526 buffer[i] = '_';
527 }
528 } /* void replace_special */
530 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
531 {
532 struct timeval *larger;
533 struct timeval *smaller;
535 int status;
537 NORMALIZE_TIMEVAL (tv0);
538 NORMALIZE_TIMEVAL (tv1);
540 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
541 {
542 if (delta != NULL) {
543 delta->tv_sec = 0;
544 delta->tv_usec = 0;
545 }
546 return (0);
547 }
549 if ((tv0.tv_sec < tv1.tv_sec)
550 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
551 {
552 larger = &tv1;
553 smaller = &tv0;
554 status = -1;
555 }
556 else
557 {
558 larger = &tv0;
559 smaller = &tv1;
560 status = 1;
561 }
563 if (delta != NULL) {
564 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
566 if (smaller->tv_usec <= larger->tv_usec)
567 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
568 else
569 {
570 --delta->tv_sec;
571 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
572 }
573 }
575 assert ((delta == NULL)
576 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
578 return (status);
579 } /* int timeval_cmp */
581 int check_create_dir (const char *file_orig)
582 {
583 struct stat statbuf;
585 char file_copy[512];
586 char dir[512];
587 int dir_len = 512;
588 char *fields[16];
589 int fields_num;
590 char *ptr;
591 char *saveptr;
592 int last_is_file = 1;
593 int path_is_absolute = 0;
594 size_t len;
595 int i;
597 /*
598 * Sanity checks first
599 */
600 if (file_orig == NULL)
601 return (-1);
603 if ((len = strlen (file_orig)) < 1)
604 return (-1);
605 else if (len >= sizeof (file_copy))
606 return (-1);
608 /*
609 * If `file_orig' ends in a slash the last component is a directory,
610 * otherwise it's a file. Act accordingly..
611 */
612 if (file_orig[len - 1] == '/')
613 last_is_file = 0;
614 if (file_orig[0] == '/')
615 path_is_absolute = 1;
617 /*
618 * Create a copy for `strtok_r' to destroy
619 */
620 sstrncpy (file_copy, file_orig, sizeof (file_copy));
622 /*
623 * Break into components. This will eat up several slashes in a row and
624 * remove leading and trailing slashes..
625 */
626 ptr = file_copy;
627 saveptr = NULL;
628 fields_num = 0;
629 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
630 {
631 ptr = NULL;
632 fields_num++;
634 if (fields_num >= 16)
635 break;
636 }
638 /*
639 * For each component, do..
640 */
641 for (i = 0; i < (fields_num - last_is_file); i++)
642 {
643 /*
644 * Do not create directories that start with a dot. This
645 * prevents `../../' attacks and other likely malicious
646 * behavior.
647 */
648 if (fields[i][0] == '.')
649 {
650 ERROR ("Cowardly refusing to create a directory that "
651 "begins with a `.' (dot): `%s'", file_orig);
652 return (-2);
653 }
655 /*
656 * Join the components together again
657 */
658 dir[0] = '/';
659 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
660 fields, (size_t) (i + 1), "/") < 0)
661 {
662 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
663 return (-1);
664 }
666 while (42) {
667 if ((stat (dir, &statbuf) == -1)
668 && (lstat (dir, &statbuf) == -1))
669 {
670 if (errno == ENOENT)
671 {
672 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
673 break;
675 /* this might happen, if a different thread created
676 * the directory in the meantime
677 * => call stat() again to check for S_ISDIR() */
678 if (EEXIST == errno)
679 continue;
681 char errbuf[1024];
682 ERROR ("check_create_dir: mkdir (%s): %s", dir,
683 sstrerror (errno,
684 errbuf, sizeof (errbuf)));
685 return (-1);
686 }
687 else
688 {
689 char errbuf[1024];
690 ERROR ("check_create_dir: stat (%s): %s", dir,
691 sstrerror (errno, errbuf,
692 sizeof (errbuf)));
693 return (-1);
694 }
695 }
696 else if (!S_ISDIR (statbuf.st_mode))
697 {
698 ERROR ("check_create_dir: `%s' exists but is not "
699 "a directory!", dir);
700 return (-1);
701 }
702 break;
703 }
704 }
706 return (0);
707 } /* check_create_dir */
709 #ifdef HAVE_LIBKSTAT
710 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
711 {
712 char ident[128];
714 *ksp_ptr = NULL;
716 if (kc == NULL)
717 return (-1);
719 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
721 *ksp_ptr = kstat_lookup (kc, module, instance, name);
722 if (*ksp_ptr == NULL)
723 {
724 ERROR ("get_kstat: Cound not find kstat %s", ident);
725 return (-1);
726 }
728 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
729 {
730 ERROR ("get_kstat: kstat %s has wrong type", ident);
731 *ksp_ptr = NULL;
732 return (-1);
733 }
735 #ifdef assert
736 assert (*ksp_ptr != NULL);
737 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
738 #endif
740 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
741 {
742 ERROR ("get_kstat: kstat %s could not be read", ident);
743 return (-1);
744 }
746 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
747 {
748 ERROR ("get_kstat: kstat %s has wrong type", ident);
749 return (-1);
750 }
752 return (0);
753 }
755 long long get_kstat_value (kstat_t *ksp, char *name)
756 {
757 kstat_named_t *kn;
758 long long retval = -1LL;
760 if (ksp == NULL)
761 {
762 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
763 return (-1LL);
764 }
765 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
766 {
767 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
768 "is not KSTAT_TYPE_NAMED (%#x).",
769 name,
770 (unsigned int) ksp->ks_type,
771 (unsigned int) KSTAT_TYPE_NAMED);
772 return (-1LL);
773 }
775 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
776 return (-1LL);
778 if (kn->data_type == KSTAT_DATA_INT32)
779 retval = (long long) kn->value.i32;
780 else if (kn->data_type == KSTAT_DATA_UINT32)
781 retval = (long long) kn->value.ui32;
782 else if (kn->data_type == KSTAT_DATA_INT64)
783 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
784 else if (kn->data_type == KSTAT_DATA_UINT64)
785 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
786 else
787 WARNING ("get_kstat_value: Not a numeric value: %s", name);
789 return (retval);
790 }
791 #endif /* HAVE_LIBKSTAT */
793 #ifndef HAVE_HTONLL
794 unsigned long long ntohll (unsigned long long n)
795 {
796 #if BYTE_ORDER == BIG_ENDIAN
797 return (n);
798 #else
799 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
800 #endif
801 } /* unsigned long long ntohll */
803 unsigned long long htonll (unsigned long long n)
804 {
805 #if BYTE_ORDER == BIG_ENDIAN
806 return (n);
807 #else
808 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
809 #endif
810 } /* unsigned long long htonll */
811 #endif /* HAVE_HTONLL */
813 #if FP_LAYOUT_NEED_NOTHING
814 /* Well, we need nothing.. */
815 /* #endif FP_LAYOUT_NEED_NOTHING */
817 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
818 # if FP_LAYOUT_NEED_ENDIANFLIP
819 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
820 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
821 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
822 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
823 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
824 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
825 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
826 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
827 # else
828 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
829 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
830 # endif
832 double ntohd (double d)
833 {
834 union
835 {
836 uint8_t byte[8];
837 uint64_t integer;
838 double floating;
839 } ret;
841 ret.floating = d;
843 /* NAN in x86 byte order */
844 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
845 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
846 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
847 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
848 {
849 return (NAN);
850 }
851 else
852 {
853 uint64_t tmp;
855 tmp = ret.integer;
856 ret.integer = FP_CONVERT (tmp);
857 return (ret.floating);
858 }
859 } /* double ntohd */
861 double htond (double d)
862 {
863 union
864 {
865 uint8_t byte[8];
866 uint64_t integer;
867 double floating;
868 } ret;
870 if (isnan (d))
871 {
872 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
873 ret.byte[4] = ret.byte[5] = 0x00;
874 ret.byte[6] = 0xf8;
875 ret.byte[7] = 0x7f;
876 return (ret.floating);
877 }
878 else
879 {
880 uint64_t tmp;
882 ret.floating = d;
883 tmp = FP_CONVERT (ret.integer);
884 ret.integer = tmp;
885 return (ret.floating);
886 }
887 } /* double htond */
888 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
890 int format_name (char *ret, int ret_len,
891 const char *hostname,
892 const char *plugin, const char *plugin_instance,
893 const char *type, const char *type_instance)
894 {
895 char *buffer;
896 size_t buffer_size;
898 buffer = ret;
899 buffer_size = (size_t) ret_len;
901 #define APPEND(str) do { \
902 size_t l = strlen (str); \
903 if (l >= buffer_size) \
904 return (ENOBUFS); \
905 memcpy (buffer, (str), l); \
906 buffer += l; buffer_size -= l; \
907 } while (0)
909 assert (plugin != NULL);
910 assert (type != NULL);
912 APPEND (hostname);
913 APPEND ("/");
914 APPEND (plugin);
915 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
916 {
917 APPEND ("-");
918 APPEND (plugin_instance);
919 }
920 APPEND ("/");
921 APPEND (type);
922 if ((type_instance != NULL) && (type_instance[0] != 0))
923 {
924 APPEND ("-");
925 APPEND (type_instance);
926 }
927 assert (buffer_size > 0);
928 buffer[0] = 0;
930 #undef APPEND
931 return (0);
932 } /* int format_name */
934 int format_values (char *ret, size_t ret_len, /* {{{ */
935 const data_set_t *ds, const value_list_t *vl,
936 _Bool store_rates)
937 {
938 size_t offset = 0;
939 int status;
940 size_t i;
941 gauge_t *rates = NULL;
943 assert (0 == strcmp (ds->type, vl->type));
945 memset (ret, 0, ret_len);
947 #define BUFFER_ADD(...) do { \
948 status = ssnprintf (ret + offset, ret_len - offset, \
949 __VA_ARGS__); \
950 if (status < 1) \
951 { \
952 sfree (rates); \
953 return (-1); \
954 } \
955 else if (((size_t) status) >= (ret_len - offset)) \
956 { \
957 sfree (rates); \
958 return (-1); \
959 } \
960 else \
961 offset += ((size_t) status); \
962 } while (0)
964 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
966 for (i = 0; i < ds->ds_num; i++)
967 {
968 if (ds->ds[i].type == DS_TYPE_GAUGE)
969 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
970 else if (store_rates)
971 {
972 if (rates == NULL)
973 rates = uc_get_rate (ds, vl);
974 if (rates == NULL)
975 {
976 WARNING ("format_values: uc_get_rate failed.");
977 return (-1);
978 }
979 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
980 }
981 else if (ds->ds[i].type == DS_TYPE_COUNTER)
982 BUFFER_ADD (":%llu", vl->values[i].counter);
983 else if (ds->ds[i].type == DS_TYPE_DERIVE)
984 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
985 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
986 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
987 else
988 {
989 ERROR ("format_values: Unknown data source type: %i",
990 ds->ds[i].type);
991 sfree (rates);
992 return (-1);
993 }
994 } /* for ds->ds_num */
996 #undef BUFFER_ADD
998 sfree (rates);
999 return (0);
1000 } /* }}} int format_values */
1002 int parse_identifier (char *str, char **ret_host,
1003 char **ret_plugin, char **ret_plugin_instance,
1004 char **ret_type, char **ret_type_instance)
1005 {
1006 char *hostname = NULL;
1007 char *plugin = NULL;
1008 char *plugin_instance = NULL;
1009 char *type = NULL;
1010 char *type_instance = NULL;
1012 hostname = str;
1013 if (hostname == NULL)
1014 return (-1);
1016 plugin = strchr (hostname, '/');
1017 if (plugin == NULL)
1018 return (-1);
1019 *plugin = '\0'; plugin++;
1021 type = strchr (plugin, '/');
1022 if (type == NULL)
1023 return (-1);
1024 *type = '\0'; type++;
1026 plugin_instance = strchr (plugin, '-');
1027 if (plugin_instance != NULL)
1028 {
1029 *plugin_instance = '\0';
1030 plugin_instance++;
1031 }
1033 type_instance = strchr (type, '-');
1034 if (type_instance != NULL)
1035 {
1036 *type_instance = '\0';
1037 type_instance++;
1038 }
1040 *ret_host = hostname;
1041 *ret_plugin = plugin;
1042 *ret_plugin_instance = plugin_instance;
1043 *ret_type = type;
1044 *ret_type_instance = type_instance;
1045 return (0);
1046 } /* int parse_identifier */
1048 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1049 {
1050 char str_copy[6 * DATA_MAX_NAME_LEN];
1051 char *host = NULL;
1052 char *plugin = NULL;
1053 char *plugin_instance = NULL;
1054 char *type = NULL;
1055 char *type_instance = NULL;
1056 int status;
1058 if ((str == NULL) || (vl == NULL))
1059 return (EINVAL);
1061 sstrncpy (str_copy, str, sizeof (str_copy));
1063 status = parse_identifier (str_copy, &host,
1064 &plugin, &plugin_instance,
1065 &type, &type_instance);
1066 if (status != 0)
1067 return (status);
1069 sstrncpy (vl->host, host, sizeof (vl->host));
1070 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1071 sstrncpy (vl->plugin_instance,
1072 (plugin_instance != NULL) ? plugin_instance : "",
1073 sizeof (vl->plugin_instance));
1074 sstrncpy (vl->type, type, sizeof (vl->type));
1075 sstrncpy (vl->type_instance,
1076 (type_instance != NULL) ? type_instance : "",
1077 sizeof (vl->type_instance));
1079 return (0);
1080 } /* }}} int parse_identifier_vl */
1082 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1083 {
1084 char *value;
1085 char *endptr = NULL;
1086 size_t value_len;
1088 if (value_orig == NULL)
1089 return (EINVAL);
1091 value = strdup (value_orig);
1092 if (value == NULL)
1093 return (ENOMEM);
1094 value_len = strlen (value);
1096 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1097 {
1098 value[value_len - 1] = 0;
1099 value_len--;
1100 }
1102 switch (ds_type)
1103 {
1104 case DS_TYPE_COUNTER:
1105 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1106 break;
1108 case DS_TYPE_GAUGE:
1109 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1110 break;
1112 case DS_TYPE_DERIVE:
1113 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1114 break;
1116 case DS_TYPE_ABSOLUTE:
1117 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1118 break;
1120 default:
1121 sfree (value);
1122 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1123 return -1;
1124 }
1126 if (value == endptr) {
1127 ERROR ("parse_value: Failed to parse string as %s: %s.",
1128 DS_TYPE_TO_STRING (ds_type), value);
1129 sfree (value);
1130 return -1;
1131 }
1132 else if ((NULL != endptr) && ('\0' != *endptr))
1133 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1134 "Input string was \"%s\".",
1135 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1137 sfree (value);
1138 return 0;
1139 } /* int parse_value */
1141 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1142 {
1143 size_t i;
1144 char *dummy;
1145 char *ptr;
1146 char *saveptr;
1148 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1149 return EINVAL;
1151 i = 0;
1152 dummy = buffer;
1153 saveptr = NULL;
1154 vl->time = 0;
1155 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1156 {
1157 dummy = NULL;
1159 if (i >= vl->values_len)
1160 {
1161 /* Make sure i is invalid. */
1162 i = 0;
1163 break;
1164 }
1166 if (vl->time == 0)
1167 {
1168 if (strcmp ("N", ptr) == 0)
1169 vl->time = cdtime ();
1170 else
1171 {
1172 char *endptr = NULL;
1173 double tmp;
1175 errno = 0;
1176 tmp = strtod (ptr, &endptr);
1177 if ((errno != 0) /* Overflow */
1178 || (endptr == ptr) /* Invalid string */
1179 || (endptr == NULL) /* This should not happen */
1180 || (*endptr != 0)) /* Trailing chars */
1181 return (-1);
1183 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1184 }
1186 continue;
1187 }
1189 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1190 vl->values[i].gauge = NAN;
1191 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1192 return -1;
1194 i++;
1195 } /* while (strtok_r) */
1197 if ((ptr != NULL) || (i == 0))
1198 return (-1);
1199 return (0);
1200 } /* int parse_values */
1202 #if !HAVE_GETPWNAM_R
1203 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1204 size_t buflen, struct passwd **pwbufp)
1205 {
1206 int status = 0;
1207 struct passwd *pw;
1209 memset (pwbuf, '\0', sizeof (struct passwd));
1211 pthread_mutex_lock (&getpwnam_r_lock);
1213 do
1214 {
1215 pw = getpwnam (name);
1216 if (pw == NULL)
1217 {
1218 status = (errno != 0) ? errno : ENOENT;
1219 break;
1220 }
1222 #define GETPWNAM_COPY_MEMBER(member) \
1223 if (pw->member != NULL) \
1224 { \
1225 int len = strlen (pw->member); \
1226 if (len >= buflen) \
1227 { \
1228 status = ENOMEM; \
1229 break; \
1230 } \
1231 sstrncpy (buf, pw->member, buflen); \
1232 pwbuf->member = buf; \
1233 buf += (len + 1); \
1234 buflen -= (len + 1); \
1235 }
1236 GETPWNAM_COPY_MEMBER(pw_name);
1237 GETPWNAM_COPY_MEMBER(pw_passwd);
1238 GETPWNAM_COPY_MEMBER(pw_gecos);
1239 GETPWNAM_COPY_MEMBER(pw_dir);
1240 GETPWNAM_COPY_MEMBER(pw_shell);
1242 pwbuf->pw_uid = pw->pw_uid;
1243 pwbuf->pw_gid = pw->pw_gid;
1245 if (pwbufp != NULL)
1246 *pwbufp = pwbuf;
1247 } while (0);
1249 pthread_mutex_unlock (&getpwnam_r_lock);
1251 return (status);
1252 } /* int getpwnam_r */
1253 #endif /* !HAVE_GETPWNAM_R */
1255 int notification_init (notification_t *n, int severity, const char *message,
1256 const char *host,
1257 const char *plugin, const char *plugin_instance,
1258 const char *type, const char *type_instance)
1259 {
1260 memset (n, '\0', sizeof (notification_t));
1262 n->severity = severity;
1264 if (message != NULL)
1265 sstrncpy (n->message, message, sizeof (n->message));
1266 if (host != NULL)
1267 sstrncpy (n->host, host, sizeof (n->host));
1268 if (plugin != NULL)
1269 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1270 if (plugin_instance != NULL)
1271 sstrncpy (n->plugin_instance, plugin_instance,
1272 sizeof (n->plugin_instance));
1273 if (type != NULL)
1274 sstrncpy (n->type, type, sizeof (n->type));
1275 if (type_instance != NULL)
1276 sstrncpy (n->type_instance, type_instance,
1277 sizeof (n->type_instance));
1279 return (0);
1280 } /* int notification_init */
1282 int walk_directory (const char *dir, dirwalk_callback_f callback,
1283 void *user_data, int include_hidden)
1284 {
1285 struct dirent *ent;
1286 DIR *dh;
1287 int success;
1288 int failure;
1290 success = 0;
1291 failure = 0;
1293 if ((dh = opendir (dir)) == NULL)
1294 {
1295 char errbuf[1024];
1296 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1297 sstrerror (errno, errbuf, sizeof (errbuf)));
1298 return -1;
1299 }
1301 while ((ent = readdir (dh)) != NULL)
1302 {
1303 int status;
1305 if (include_hidden)
1306 {
1307 if ((strcmp (".", ent->d_name) == 0)
1308 || (strcmp ("..", ent->d_name) == 0))
1309 continue;
1310 }
1311 else /* if (!include_hidden) */
1312 {
1313 if (ent->d_name[0]=='.')
1314 continue;
1315 }
1317 status = (*callback) (dir, ent->d_name, user_data);
1318 if (status != 0)
1319 failure++;
1320 else
1321 success++;
1322 }
1324 closedir (dh);
1326 if ((success == 0) && (failure > 0))
1327 return (-1);
1328 return (0);
1329 }
1331 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1332 {
1333 FILE *fh;
1334 ssize_t ret;
1336 fh = fopen (filename, "r");
1337 if (fh == NULL)
1338 return (-1);
1340 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1341 if ((ret == 0) && (ferror (fh) != 0))
1342 {
1343 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1344 filename);
1345 ret = -1;
1346 }
1348 fclose(fh);
1349 return (ret);
1350 }
1352 counter_t counter_diff (counter_t old_value, counter_t new_value)
1353 {
1354 counter_t diff;
1356 if (old_value > new_value)
1357 {
1358 if (old_value <= 4294967295U)
1359 diff = (4294967295U - old_value) + new_value + 1;
1360 else
1361 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1362 }
1363 else
1364 {
1365 diff = new_value - old_value;
1366 }
1368 return (diff);
1369 } /* counter_t counter_diff */
1371 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1372 rate_to_value_state_t *state,
1373 int ds_type, cdtime_t t)
1374 {
1375 gauge_t delta_gauge;
1376 cdtime_t delta_t;
1378 if (ds_type == DS_TYPE_GAUGE)
1379 {
1380 state->last_value.gauge = rate;
1381 state->last_time = t;
1383 *ret_value = state->last_value;
1384 return (0);
1385 }
1387 /* Counter and absolute can't handle negative rates. Reset "last time"
1388 * to zero, so that the next valid rate will re-initialize the
1389 * structure. */
1390 if ((rate < 0.0)
1391 && ((ds_type == DS_TYPE_COUNTER)
1392 || (ds_type == DS_TYPE_ABSOLUTE)))
1393 {
1394 memset (state, 0, sizeof (*state));
1395 return (EINVAL);
1396 }
1398 /* Another invalid state: The time is not increasing. */
1399 if (t <= state->last_time)
1400 {
1401 memset (state, 0, sizeof (*state));
1402 return (EINVAL);
1403 }
1405 delta_t = t - state->last_time;
1406 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1408 /* Previous value is invalid. */
1409 if (state->last_time == 0) /* {{{ */
1410 {
1411 if (ds_type == DS_TYPE_DERIVE)
1412 {
1413 state->last_value.derive = (derive_t) rate;
1414 state->residual = rate - ((gauge_t) state->last_value.derive);
1415 }
1416 else if (ds_type == DS_TYPE_COUNTER)
1417 {
1418 state->last_value.counter = (counter_t) rate;
1419 state->residual = rate - ((gauge_t) state->last_value.counter);
1420 }
1421 else if (ds_type == DS_TYPE_ABSOLUTE)
1422 {
1423 state->last_value.absolute = (absolute_t) rate;
1424 state->residual = rate - ((gauge_t) state->last_value.absolute);
1425 }
1426 else
1427 {
1428 assert (23 == 42);
1429 }
1431 state->last_time = t;
1432 return (EAGAIN);
1433 } /* }}} */
1435 if (ds_type == DS_TYPE_DERIVE)
1436 {
1437 derive_t delta_derive = (derive_t) delta_gauge;
1439 state->last_value.derive += delta_derive;
1440 state->residual = delta_gauge - ((gauge_t) delta_derive);
1441 }
1442 else if (ds_type == DS_TYPE_COUNTER)
1443 {
1444 counter_t delta_counter = (counter_t) delta_gauge;
1446 state->last_value.counter += delta_counter;
1447 state->residual = delta_gauge - ((gauge_t) delta_counter);
1448 }
1449 else if (ds_type == DS_TYPE_ABSOLUTE)
1450 {
1451 absolute_t delta_absolute = (absolute_t) delta_gauge;
1453 state->last_value.absolute = delta_absolute;
1454 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1455 }
1456 else
1457 {
1458 assert (23 == 42);
1459 }
1461 state->last_time = t;
1462 *ret_value = state->last_value;
1463 return (0);
1464 } /* }}} value_t rate_to_value */
1466 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1467 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1468 {
1469 gauge_t interval;
1471 /* Another invalid state: The time is not increasing. */
1472 if (t <= state->last_time)
1473 {
1474 memset (state, 0, sizeof (*state));
1475 return (EINVAL);
1476 }
1478 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1480 /* Previous value is invalid. */
1481 if (state->last_time == 0)
1482 {
1483 state->last_value = value;
1484 state->last_time = t;
1485 return (EAGAIN);
1486 }
1488 switch (ds_type) {
1489 case DS_TYPE_DERIVE: {
1490 derive_t diff = value.derive - state->last_value.derive;
1491 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1492 break;
1493 }
1494 case DS_TYPE_GAUGE: {
1495 *ret_rate = value.gauge;
1496 break;
1497 }
1498 case DS_TYPE_COUNTER: {
1499 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1500 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1501 break;
1502 }
1503 case DS_TYPE_ABSOLUTE: {
1504 absolute_t diff = value.absolute;
1505 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1506 break;
1507 }
1508 default:
1509 return EINVAL;
1510 }
1512 state->last_value = value;
1513 state->last_time = t;
1514 return (0);
1515 } /* }}} value_t rate_to_value */
1517 int service_name_to_port_number (const char *service_name)
1518 {
1519 struct addrinfo *ai_list;
1520 struct addrinfo *ai_ptr;
1521 int status;
1522 int service_number;
1524 if (service_name == NULL)
1525 return (-1);
1527 struct addrinfo ai_hints = {
1528 .ai_family = AF_UNSPEC
1529 };
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 */