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"
36 #include "common.h"
37 #include "plugin.h"
38 #include "utils_cache.h"
40 #ifdef HAVE_MATH_H
41 # include <math.h>
42 #endif
44 /* for getaddrinfo */
45 #include <sys/types.h>
46 #include <netdb.h>
48 #include <poll.h>
50 #if HAVE_NETINET_IN_H
51 # include <netinet/in.h>
52 #endif
54 /* for ntohl and htonl */
55 #if HAVE_ARPA_INET_H
56 # include <arpa/inet.h>
57 #endif
59 #ifdef HAVE_LIBKSTAT
60 extern kstat_ctl_t *kc;
61 #endif
63 #if !HAVE_GETPWNAM_R
64 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
65 #endif
67 #if !HAVE_STRERROR_R
68 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
69 #endif
71 char *sstrncpy (char *dest, const char *src, size_t n)
72 {
73 strncpy (dest, src, n);
74 dest[n - 1] = '\0';
76 return (dest);
77 } /* char *sstrncpy */
79 int ssnprintf (char *dest, size_t n, const char *format, ...)
80 {
81 int ret = 0;
82 va_list ap;
84 va_start (ap, format);
85 ret = vsnprintf (dest, n, format, ap);
86 dest[n - 1] = '\0';
87 va_end (ap);
89 return (ret);
90 } /* int ssnprintf */
92 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
93 {
94 char static_buffer[1024] = "";
95 char *alloc_buffer;
96 size_t alloc_buffer_size;
97 int status;
98 va_list ap;
100 /* Try printing into the static buffer. In many cases it will be
101 * sufficiently large and we can simply return a strdup() of this
102 * buffer. */
103 va_start (ap, format);
104 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
105 va_end (ap);
106 if (status < 0)
107 return (NULL);
109 /* "status" does not include the null byte. */
110 alloc_buffer_size = (size_t) (status + 1);
111 if (alloc_buffer_size <= sizeof (static_buffer))
112 return (strdup (static_buffer));
114 /* Allocate a buffer large enough to hold the string. */
115 alloc_buffer = calloc (1, alloc_buffer_size);
116 if (alloc_buffer == NULL)
117 return (NULL);
119 /* Print again into this new buffer. */
120 va_start (ap, format);
121 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
122 va_end (ap);
123 if (status < 0)
124 {
125 sfree (alloc_buffer);
126 return (NULL);
127 }
129 return (alloc_buffer);
130 } /* }}} char *ssnprintf_alloc */
132 char *sstrdup (const char *s)
133 {
134 char *r;
135 size_t sz;
137 if (s == NULL)
138 return (NULL);
140 /* Do not use `strdup' here, because it's not specified in POSIX. It's
141 * ``only'' an XSI extension. */
142 sz = strlen (s) + 1;
143 r = malloc (sz);
144 if (r == NULL)
145 {
146 ERROR ("sstrdup: Out of memory.");
147 exit (3);
148 }
149 memcpy (r, s, sizeof (char) * sz);
151 return (r);
152 } /* char *sstrdup */
154 /* Even though Posix requires "strerror_r" to return an "int",
155 * some systems (e.g. the GNU libc) return a "char *" _and_
156 * ignore the second argument ... -tokkee */
157 char *sstrerror (int errnum, char *buf, size_t buflen)
158 {
159 buf[0] = '\0';
161 #if !HAVE_STRERROR_R
162 {
163 char *temp;
165 pthread_mutex_lock (&strerror_r_lock);
167 temp = strerror (errnum);
168 sstrncpy (buf, temp, buflen);
170 pthread_mutex_unlock (&strerror_r_lock);
171 }
172 /* #endif !HAVE_STRERROR_R */
174 #elif STRERROR_R_CHAR_P
175 {
176 char *temp;
177 temp = strerror_r (errnum, buf, buflen);
178 if (buf[0] == '\0')
179 {
180 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
181 sstrncpy (buf, temp, buflen);
182 else
183 sstrncpy (buf, "strerror_r did not return "
184 "an error message", buflen);
185 }
186 }
187 /* #endif STRERROR_R_CHAR_P */
189 #else
190 if (strerror_r (errnum, buf, buflen) != 0)
191 {
192 ssnprintf (buf, buflen, "Error #%i; "
193 "Additionally, strerror_r failed.",
194 errnum);
195 }
196 #endif /* STRERROR_R_CHAR_P */
198 return (buf);
199 } /* char *sstrerror */
201 void *smalloc (size_t size)
202 {
203 void *r;
205 if ((r = malloc (size)) == NULL)
206 {
207 ERROR ("Not enough memory.");
208 exit (3);
209 }
211 return (r);
212 } /* void *smalloc */
214 #if 0
215 void sfree (void **ptr)
216 {
217 if (ptr == NULL)
218 return;
220 if (*ptr != NULL)
221 free (*ptr);
223 *ptr = NULL;
224 }
225 #endif
227 ssize_t sread (int fd, void *buf, size_t count)
228 {
229 char *ptr;
230 size_t nleft;
231 ssize_t status;
233 ptr = (char *) buf;
234 nleft = count;
236 while (nleft > 0)
237 {
238 status = read (fd, (void *) ptr, nleft);
240 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
241 continue;
243 if (status < 0)
244 return (status);
246 if (status == 0)
247 {
248 DEBUG ("Received EOF from fd %i. "
249 "Closing fd and returning error.",
250 fd);
251 close (fd);
252 return (-1);
253 }
255 assert ((0 > status) || (nleft >= (size_t)status));
257 nleft = nleft - ((size_t) status);
258 ptr = ptr + ((size_t) status);
259 }
261 return (0);
262 }
265 ssize_t swrite (int fd, const void *buf, size_t count)
266 {
267 const char *ptr;
268 size_t nleft;
269 ssize_t status;
270 struct pollfd pfd;
272 ptr = (const char *) buf;
273 nleft = count;
275 if (fd < 0)
276 return (-1);
278 /* checking for closed peer connection */
279 pfd.fd = fd;
280 pfd.events = POLLIN | POLLHUP;
281 pfd.revents = 0;
282 if (poll(&pfd, 1, 0) > 0) {
283 char buffer[32];
284 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
285 // if recv returns zero (even though poll() said there is data to be read),
286 // that means the connection has been closed
287 return -1;
288 }
289 }
291 while (nleft > 0)
292 {
293 status = write (fd, (const void *) ptr, nleft);
295 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
296 continue;
298 if (status < 0)
299 return (status);
301 nleft = nleft - ((size_t) status);
302 ptr = ptr + ((size_t) status);
303 }
305 return (0);
306 }
308 int strsplit (char *string, char **fields, size_t size)
309 {
310 size_t i;
311 char *ptr;
312 char *saveptr;
314 i = 0;
315 ptr = string;
316 saveptr = NULL;
317 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
318 {
319 ptr = NULL;
320 i++;
322 if (i >= size)
323 break;
324 }
326 return ((int) i);
327 }
329 int strjoin (char *buffer, size_t buffer_size,
330 char **fields, size_t fields_num,
331 const char *sep)
332 {
333 size_t avail;
334 char *ptr;
335 size_t sep_len;
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 (size_t 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 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 (size_t 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 for (size_t i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
430 {
431 if (buf[i] != '\\')
432 continue;
434 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
435 ERROR ("string unescape: backslash found at end of string.");
436 /* Ensure null-byte at the end of the buffer. */
437 buf[i] = 0;
438 return (-1);
439 }
441 switch (buf[i + 1]) {
442 case 't':
443 buf[i] = '\t';
444 break;
445 case 'n':
446 buf[i] = '\n';
447 break;
448 case 'r':
449 buf[i] = '\r';
450 break;
451 default:
452 buf[i] = buf[i + 1];
453 break;
454 }
456 /* Move everything after the position one position to the left.
457 * Add a null-byte as last character in the buffer. */
458 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
459 buf[buf_len - 1] = 0;
460 }
461 return (0);
462 } /* int strunescape */
464 size_t strstripnewline (char *buffer)
465 {
466 size_t buffer_len = strlen (buffer);
468 while (buffer_len > 0)
469 {
470 if ((buffer[buffer_len - 1] != '\n')
471 && (buffer[buffer_len - 1] != '\r'))
472 break;
473 buffer_len--;
474 buffer[buffer_len] = 0;
475 }
477 return (buffer_len);
478 } /* size_t strstripnewline */
480 int escape_slashes (char *buffer, size_t buffer_size)
481 {
482 size_t buffer_len;
484 buffer_len = strlen (buffer);
486 if (buffer_len <= 1)
487 {
488 if (strcmp ("/", buffer) == 0)
489 {
490 if (buffer_size < 5)
491 return (-1);
492 sstrncpy (buffer, "root", buffer_size);
493 }
494 return (0);
495 }
497 /* Move one to the left */
498 if (buffer[0] == '/')
499 {
500 memmove (buffer, buffer + 1, buffer_len);
501 buffer_len--;
502 }
504 for (size_t i = 0; i < buffer_len; i++)
505 {
506 if (buffer[i] == '/')
507 buffer[i] = '_';
508 }
510 return (0);
511 } /* int escape_slashes */
513 void replace_special (char *buffer, size_t buffer_size)
514 {
515 for (size_t i = 0; i < buffer_size; i++)
516 {
517 if (buffer[i] == 0)
518 return;
519 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
520 buffer[i] = '_';
521 }
522 } /* void replace_special */
524 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
525 {
526 struct timeval *larger;
527 struct timeval *smaller;
529 int status;
531 NORMALIZE_TIMEVAL (tv0);
532 NORMALIZE_TIMEVAL (tv1);
534 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
535 {
536 if (delta != NULL) {
537 delta->tv_sec = 0;
538 delta->tv_usec = 0;
539 }
540 return (0);
541 }
543 if ((tv0.tv_sec < tv1.tv_sec)
544 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
545 {
546 larger = &tv1;
547 smaller = &tv0;
548 status = -1;
549 }
550 else
551 {
552 larger = &tv0;
553 smaller = &tv1;
554 status = 1;
555 }
557 if (delta != NULL) {
558 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
560 if (smaller->tv_usec <= larger->tv_usec)
561 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
562 else
563 {
564 --delta->tv_sec;
565 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
566 }
567 }
569 assert ((delta == NULL)
570 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
572 return (status);
573 } /* int timeval_cmp */
575 int check_create_dir (const char *file_orig)
576 {
577 struct stat statbuf;
579 char file_copy[512];
580 char dir[512];
581 int dir_len = 512;
582 char *fields[16];
583 int fields_num;
584 char *ptr;
585 char *saveptr;
586 int last_is_file = 1;
587 int path_is_absolute = 0;
588 size_t len;
590 /*
591 * Sanity checks first
592 */
593 if (file_orig == NULL)
594 return (-1);
596 if ((len = strlen (file_orig)) < 1)
597 return (-1);
598 else if (len >= sizeof (file_copy))
599 return (-1);
601 /*
602 * If `file_orig' ends in a slash the last component is a directory,
603 * otherwise it's a file. Act accordingly..
604 */
605 if (file_orig[len - 1] == '/')
606 last_is_file = 0;
607 if (file_orig[0] == '/')
608 path_is_absolute = 1;
610 /*
611 * Create a copy for `strtok_r' to destroy
612 */
613 sstrncpy (file_copy, file_orig, sizeof (file_copy));
615 /*
616 * Break into components. This will eat up several slashes in a row and
617 * remove leading and trailing slashes..
618 */
619 ptr = file_copy;
620 saveptr = NULL;
621 fields_num = 0;
622 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
623 {
624 ptr = NULL;
625 fields_num++;
627 if (fields_num >= 16)
628 break;
629 }
631 /*
632 * For each component, do..
633 */
634 for (int i = 0; i < (fields_num - last_is_file); i++)
635 {
636 /*
637 * Do not create directories that start with a dot. This
638 * prevents `../../' attacks and other likely malicious
639 * behavior.
640 */
641 if (fields[i][0] == '.')
642 {
643 ERROR ("Cowardly refusing to create a directory that "
644 "begins with a `.' (dot): `%s'", file_orig);
645 return (-2);
646 }
648 /*
649 * Join the components together again
650 */
651 dir[0] = '/';
652 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
653 fields, (size_t) (i + 1), "/") < 0)
654 {
655 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
656 return (-1);
657 }
659 while (42) {
660 if ((stat (dir, &statbuf) == -1)
661 && (lstat (dir, &statbuf) == -1))
662 {
663 if (errno == ENOENT)
664 {
665 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
666 break;
668 /* this might happen, if a different thread created
669 * the directory in the meantime
670 * => call stat() again to check for S_ISDIR() */
671 if (EEXIST == errno)
672 continue;
674 char errbuf[1024];
675 ERROR ("check_create_dir: mkdir (%s): %s", dir,
676 sstrerror (errno,
677 errbuf, sizeof (errbuf)));
678 return (-1);
679 }
680 else
681 {
682 char errbuf[1024];
683 ERROR ("check_create_dir: stat (%s): %s", dir,
684 sstrerror (errno, errbuf,
685 sizeof (errbuf)));
686 return (-1);
687 }
688 }
689 else if (!S_ISDIR (statbuf.st_mode))
690 {
691 ERROR ("check_create_dir: `%s' exists but is not "
692 "a directory!", dir);
693 return (-1);
694 }
695 break;
696 }
697 }
699 return (0);
700 } /* check_create_dir */
702 #ifdef HAVE_LIBKSTAT
703 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
704 {
705 char ident[128];
707 *ksp_ptr = NULL;
709 if (kc == NULL)
710 return (-1);
712 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
714 *ksp_ptr = kstat_lookup (kc, module, instance, name);
715 if (*ksp_ptr == NULL)
716 {
717 ERROR ("get_kstat: Cound not find kstat %s", ident);
718 return (-1);
719 }
721 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
722 {
723 ERROR ("get_kstat: kstat %s has wrong type", ident);
724 *ksp_ptr = NULL;
725 return (-1);
726 }
728 #ifdef assert
729 assert (*ksp_ptr != NULL);
730 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
731 #endif
733 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
734 {
735 ERROR ("get_kstat: kstat %s could not be read", ident);
736 return (-1);
737 }
739 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
740 {
741 ERROR ("get_kstat: kstat %s has wrong type", ident);
742 return (-1);
743 }
745 return (0);
746 }
748 long long get_kstat_value (kstat_t *ksp, char *name)
749 {
750 kstat_named_t *kn;
751 long long retval = -1LL;
753 if (ksp == NULL)
754 {
755 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
756 return (-1LL);
757 }
758 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
759 {
760 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
761 "is not KSTAT_TYPE_NAMED (%#x).",
762 name,
763 (unsigned int) ksp->ks_type,
764 (unsigned int) KSTAT_TYPE_NAMED);
765 return (-1LL);
766 }
768 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
769 return (-1LL);
771 if (kn->data_type == KSTAT_DATA_INT32)
772 retval = (long long) kn->value.i32;
773 else if (kn->data_type == KSTAT_DATA_UINT32)
774 retval = (long long) kn->value.ui32;
775 else if (kn->data_type == KSTAT_DATA_INT64)
776 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
777 else if (kn->data_type == KSTAT_DATA_UINT64)
778 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
779 else
780 WARNING ("get_kstat_value: Not a numeric value: %s", name);
782 return (retval);
783 }
784 #endif /* HAVE_LIBKSTAT */
786 #ifndef HAVE_HTONLL
787 unsigned long long ntohll (unsigned long long n)
788 {
789 #if BYTE_ORDER == BIG_ENDIAN
790 return (n);
791 #else
792 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
793 #endif
794 } /* unsigned long long ntohll */
796 unsigned long long htonll (unsigned long long n)
797 {
798 #if BYTE_ORDER == BIG_ENDIAN
799 return (n);
800 #else
801 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
802 #endif
803 } /* unsigned long long htonll */
804 #endif /* HAVE_HTONLL */
806 #if FP_LAYOUT_NEED_NOTHING
807 /* Well, we need nothing.. */
808 /* #endif FP_LAYOUT_NEED_NOTHING */
810 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
811 # if FP_LAYOUT_NEED_ENDIANFLIP
812 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
813 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
814 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
815 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
816 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
817 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
818 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
819 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
820 # else
821 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
822 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
823 # endif
825 double ntohd (double d)
826 {
827 union
828 {
829 uint8_t byte[8];
830 uint64_t integer;
831 double floating;
832 } ret;
834 ret.floating = d;
836 /* NAN in x86 byte order */
837 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
838 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
839 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
840 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
841 {
842 return (NAN);
843 }
844 else
845 {
846 uint64_t tmp;
848 tmp = ret.integer;
849 ret.integer = FP_CONVERT (tmp);
850 return (ret.floating);
851 }
852 } /* double ntohd */
854 double htond (double d)
855 {
856 union
857 {
858 uint8_t byte[8];
859 uint64_t integer;
860 double floating;
861 } ret;
863 if (isnan (d))
864 {
865 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
866 ret.byte[4] = ret.byte[5] = 0x00;
867 ret.byte[6] = 0xf8;
868 ret.byte[7] = 0x7f;
869 return (ret.floating);
870 }
871 else
872 {
873 uint64_t tmp;
875 ret.floating = d;
876 tmp = FP_CONVERT (ret.integer);
877 ret.integer = tmp;
878 return (ret.floating);
879 }
880 } /* double htond */
881 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
883 int format_name (char *ret, int ret_len,
884 const char *hostname,
885 const char *plugin, const char *plugin_instance,
886 const char *type, const char *type_instance)
887 {
888 char *buffer;
889 size_t buffer_size;
891 buffer = ret;
892 buffer_size = (size_t) ret_len;
894 #define APPEND(str) do { \
895 size_t l = strlen (str); \
896 if (l >= buffer_size) \
897 return (ENOBUFS); \
898 memcpy (buffer, (str), l); \
899 buffer += l; buffer_size -= l; \
900 } while (0)
902 assert (plugin != NULL);
903 assert (type != NULL);
905 APPEND (hostname);
906 APPEND ("/");
907 APPEND (plugin);
908 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
909 {
910 APPEND ("-");
911 APPEND (plugin_instance);
912 }
913 APPEND ("/");
914 APPEND (type);
915 if ((type_instance != NULL) && (type_instance[0] != 0))
916 {
917 APPEND ("-");
918 APPEND (type_instance);
919 }
920 assert (buffer_size > 0);
921 buffer[0] = 0;
923 #undef APPEND
924 return (0);
925 } /* int format_name */
927 int format_values (char *ret, size_t ret_len, /* {{{ */
928 const data_set_t *ds, const value_list_t *vl,
929 _Bool store_rates)
930 {
931 size_t offset = 0;
932 int status;
933 gauge_t *rates = NULL;
935 assert (0 == strcmp (ds->type, vl->type));
937 memset (ret, 0, ret_len);
939 #define BUFFER_ADD(...) do { \
940 status = ssnprintf (ret + offset, ret_len - offset, \
941 __VA_ARGS__); \
942 if (status < 1) \
943 { \
944 sfree (rates); \
945 return (-1); \
946 } \
947 else if (((size_t) status) >= (ret_len - offset)) \
948 { \
949 sfree (rates); \
950 return (-1); \
951 } \
952 else \
953 offset += ((size_t) status); \
954 } while (0)
956 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
958 for (size_t i = 0; i < ds->ds_num; i++)
959 {
960 if (ds->ds[i].type == DS_TYPE_GAUGE)
961 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
962 else if (store_rates)
963 {
964 if (rates == NULL)
965 rates = uc_get_rate (ds, vl);
966 if (rates == NULL)
967 {
968 WARNING ("format_values: uc_get_rate failed.");
969 return (-1);
970 }
971 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
972 }
973 else if (ds->ds[i].type == DS_TYPE_COUNTER)
974 BUFFER_ADD (":%llu", vl->values[i].counter);
975 else if (ds->ds[i].type == DS_TYPE_DERIVE)
976 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
977 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
978 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
979 else
980 {
981 ERROR ("format_values: Unknown data source type: %i",
982 ds->ds[i].type);
983 sfree (rates);
984 return (-1);
985 }
986 } /* for ds->ds_num */
988 #undef BUFFER_ADD
990 sfree (rates);
991 return (0);
992 } /* }}} int format_values */
994 int parse_identifier (char *str, char **ret_host,
995 char **ret_plugin, char **ret_plugin_instance,
996 char **ret_type, char **ret_type_instance)
997 {
998 char *hostname = NULL;
999 char *plugin = NULL;
1000 char *plugin_instance = NULL;
1001 char *type = NULL;
1002 char *type_instance = NULL;
1004 hostname = str;
1005 if (hostname == NULL)
1006 return (-1);
1008 plugin = strchr (hostname, '/');
1009 if (plugin == NULL)
1010 return (-1);
1011 *plugin = '\0'; plugin++;
1013 type = strchr (plugin, '/');
1014 if (type == NULL)
1015 return (-1);
1016 *type = '\0'; type++;
1018 plugin_instance = strchr (plugin, '-');
1019 if (plugin_instance != NULL)
1020 {
1021 *plugin_instance = '\0';
1022 plugin_instance++;
1023 }
1025 type_instance = strchr (type, '-');
1026 if (type_instance != NULL)
1027 {
1028 *type_instance = '\0';
1029 type_instance++;
1030 }
1032 *ret_host = hostname;
1033 *ret_plugin = plugin;
1034 *ret_plugin_instance = plugin_instance;
1035 *ret_type = type;
1036 *ret_type_instance = type_instance;
1037 return (0);
1038 } /* int parse_identifier */
1040 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1041 {
1042 char str_copy[6 * DATA_MAX_NAME_LEN];
1043 char *host = NULL;
1044 char *plugin = NULL;
1045 char *plugin_instance = NULL;
1046 char *type = NULL;
1047 char *type_instance = NULL;
1048 int status;
1050 if ((str == NULL) || (vl == NULL))
1051 return (EINVAL);
1053 sstrncpy (str_copy, str, sizeof (str_copy));
1055 status = parse_identifier (str_copy, &host,
1056 &plugin, &plugin_instance,
1057 &type, &type_instance);
1058 if (status != 0)
1059 return (status);
1061 sstrncpy (vl->host, host, sizeof (vl->host));
1062 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1063 sstrncpy (vl->plugin_instance,
1064 (plugin_instance != NULL) ? plugin_instance : "",
1065 sizeof (vl->plugin_instance));
1066 sstrncpy (vl->type, type, sizeof (vl->type));
1067 sstrncpy (vl->type_instance,
1068 (type_instance != NULL) ? type_instance : "",
1069 sizeof (vl->type_instance));
1071 return (0);
1072 } /* }}} int parse_identifier_vl */
1074 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1075 {
1076 char *value;
1077 char *endptr = NULL;
1078 size_t value_len;
1080 if (value_orig == NULL)
1081 return (EINVAL);
1083 value = strdup (value_orig);
1084 if (value == NULL)
1085 return (ENOMEM);
1086 value_len = strlen (value);
1088 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1089 {
1090 value[value_len - 1] = 0;
1091 value_len--;
1092 }
1094 switch (ds_type)
1095 {
1096 case DS_TYPE_COUNTER:
1097 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1098 break;
1100 case DS_TYPE_GAUGE:
1101 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1102 break;
1104 case DS_TYPE_DERIVE:
1105 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1106 break;
1108 case DS_TYPE_ABSOLUTE:
1109 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1110 break;
1112 default:
1113 sfree (value);
1114 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1115 return -1;
1116 }
1118 if (value == endptr) {
1119 ERROR ("parse_value: Failed to parse string as %s: %s.",
1120 DS_TYPE_TO_STRING (ds_type), value);
1121 sfree (value);
1122 return -1;
1123 }
1124 else if ((NULL != endptr) && ('\0' != *endptr))
1125 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1126 "Input string was \"%s\".",
1127 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1129 sfree (value);
1130 return 0;
1131 } /* int parse_value */
1133 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1134 {
1135 size_t i;
1136 char *dummy;
1137 char *ptr;
1138 char *saveptr;
1140 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1141 return EINVAL;
1143 i = 0;
1144 dummy = buffer;
1145 saveptr = NULL;
1146 vl->time = 0;
1147 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1148 {
1149 dummy = NULL;
1151 if (i >= vl->values_len)
1152 {
1153 /* Make sure i is invalid. */
1154 i = 0;
1155 break;
1156 }
1158 if (vl->time == 0)
1159 {
1160 if (strcmp ("N", ptr) == 0)
1161 vl->time = cdtime ();
1162 else
1163 {
1164 char *endptr = NULL;
1165 double tmp;
1167 errno = 0;
1168 tmp = strtod (ptr, &endptr);
1169 if ((errno != 0) /* Overflow */
1170 || (endptr == ptr) /* Invalid string */
1171 || (endptr == NULL) /* This should not happen */
1172 || (*endptr != 0)) /* Trailing chars */
1173 return (-1);
1175 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1176 }
1178 continue;
1179 }
1181 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1182 vl->values[i].gauge = NAN;
1183 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1184 return -1;
1186 i++;
1187 } /* while (strtok_r) */
1189 if ((ptr != NULL) || (i == 0))
1190 return (-1);
1191 return (0);
1192 } /* int parse_values */
1194 #if !HAVE_GETPWNAM_R
1195 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1196 size_t buflen, struct passwd **pwbufp)
1197 {
1198 int status = 0;
1199 struct passwd *pw;
1201 memset (pwbuf, '\0', sizeof (struct passwd));
1203 pthread_mutex_lock (&getpwnam_r_lock);
1205 do
1206 {
1207 pw = getpwnam (name);
1208 if (pw == NULL)
1209 {
1210 status = (errno != 0) ? errno : ENOENT;
1211 break;
1212 }
1214 #define GETPWNAM_COPY_MEMBER(member) \
1215 if (pw->member != NULL) \
1216 { \
1217 int len = strlen (pw->member); \
1218 if (len >= buflen) \
1219 { \
1220 status = ENOMEM; \
1221 break; \
1222 } \
1223 sstrncpy (buf, pw->member, buflen); \
1224 pwbuf->member = buf; \
1225 buf += (len + 1); \
1226 buflen -= (len + 1); \
1227 }
1228 GETPWNAM_COPY_MEMBER(pw_name);
1229 GETPWNAM_COPY_MEMBER(pw_passwd);
1230 GETPWNAM_COPY_MEMBER(pw_gecos);
1231 GETPWNAM_COPY_MEMBER(pw_dir);
1232 GETPWNAM_COPY_MEMBER(pw_shell);
1234 pwbuf->pw_uid = pw->pw_uid;
1235 pwbuf->pw_gid = pw->pw_gid;
1237 if (pwbufp != NULL)
1238 *pwbufp = pwbuf;
1239 } while (0);
1241 pthread_mutex_unlock (&getpwnam_r_lock);
1243 return (status);
1244 } /* int getpwnam_r */
1245 #endif /* !HAVE_GETPWNAM_R */
1247 int notification_init (notification_t *n, int severity, const char *message,
1248 const char *host,
1249 const char *plugin, const char *plugin_instance,
1250 const char *type, const char *type_instance)
1251 {
1252 memset (n, '\0', sizeof (notification_t));
1254 n->severity = severity;
1256 if (message != NULL)
1257 sstrncpy (n->message, message, sizeof (n->message));
1258 if (host != NULL)
1259 sstrncpy (n->host, host, sizeof (n->host));
1260 if (plugin != NULL)
1261 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1262 if (plugin_instance != NULL)
1263 sstrncpy (n->plugin_instance, plugin_instance,
1264 sizeof (n->plugin_instance));
1265 if (type != NULL)
1266 sstrncpy (n->type, type, sizeof (n->type));
1267 if (type_instance != NULL)
1268 sstrncpy (n->type_instance, type_instance,
1269 sizeof (n->type_instance));
1271 return (0);
1272 } /* int notification_init */
1274 int walk_directory (const char *dir, dirwalk_callback_f callback,
1275 void *user_data, int include_hidden)
1276 {
1277 struct dirent *ent;
1278 DIR *dh;
1279 int success;
1280 int failure;
1282 success = 0;
1283 failure = 0;
1285 if ((dh = opendir (dir)) == NULL)
1286 {
1287 char errbuf[1024];
1288 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1289 sstrerror (errno, errbuf, sizeof (errbuf)));
1290 return -1;
1291 }
1293 while ((ent = readdir (dh)) != NULL)
1294 {
1295 int status;
1297 if (include_hidden)
1298 {
1299 if ((strcmp (".", ent->d_name) == 0)
1300 || (strcmp ("..", ent->d_name) == 0))
1301 continue;
1302 }
1303 else /* if (!include_hidden) */
1304 {
1305 if (ent->d_name[0]=='.')
1306 continue;
1307 }
1309 status = (*callback) (dir, ent->d_name, user_data);
1310 if (status != 0)
1311 failure++;
1312 else
1313 success++;
1314 }
1316 closedir (dh);
1318 if ((success == 0) && (failure > 0))
1319 return (-1);
1320 return (0);
1321 }
1323 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1324 {
1325 FILE *fh;
1326 ssize_t ret;
1328 fh = fopen (filename, "r");
1329 if (fh == NULL)
1330 return (-1);
1332 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1333 if ((ret == 0) && (ferror (fh) != 0))
1334 {
1335 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1336 filename);
1337 ret = -1;
1338 }
1340 fclose(fh);
1341 return (ret);
1342 }
1344 counter_t counter_diff (counter_t old_value, counter_t new_value)
1345 {
1346 counter_t diff;
1348 if (old_value > new_value)
1349 {
1350 if (old_value <= 4294967295U)
1351 diff = (4294967295U - old_value) + new_value + 1;
1352 else
1353 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1354 }
1355 else
1356 {
1357 diff = new_value - old_value;
1358 }
1360 return (diff);
1361 } /* counter_t counter_diff */
1363 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1364 rate_to_value_state_t *state,
1365 int ds_type, cdtime_t t)
1366 {
1367 gauge_t delta_gauge;
1368 cdtime_t delta_t;
1370 if (ds_type == DS_TYPE_GAUGE)
1371 {
1372 state->last_value.gauge = rate;
1373 state->last_time = t;
1375 *ret_value = state->last_value;
1376 return (0);
1377 }
1379 /* Counter and absolute can't handle negative rates. Reset "last time"
1380 * to zero, so that the next valid rate will re-initialize the
1381 * structure. */
1382 if ((rate < 0.0)
1383 && ((ds_type == DS_TYPE_COUNTER)
1384 || (ds_type == DS_TYPE_ABSOLUTE)))
1385 {
1386 memset (state, 0, sizeof (*state));
1387 return (EINVAL);
1388 }
1390 /* Another invalid state: The time is not increasing. */
1391 if (t <= state->last_time)
1392 {
1393 memset (state, 0, sizeof (*state));
1394 return (EINVAL);
1395 }
1397 delta_t = t - state->last_time;
1398 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1400 /* Previous value is invalid. */
1401 if (state->last_time == 0) /* {{{ */
1402 {
1403 if (ds_type == DS_TYPE_DERIVE)
1404 {
1405 state->last_value.derive = (derive_t) rate;
1406 state->residual = rate - ((gauge_t) state->last_value.derive);
1407 }
1408 else if (ds_type == DS_TYPE_COUNTER)
1409 {
1410 state->last_value.counter = (counter_t) rate;
1411 state->residual = rate - ((gauge_t) state->last_value.counter);
1412 }
1413 else if (ds_type == DS_TYPE_ABSOLUTE)
1414 {
1415 state->last_value.absolute = (absolute_t) rate;
1416 state->residual = rate - ((gauge_t) state->last_value.absolute);
1417 }
1418 else
1419 {
1420 assert (23 == 42);
1421 }
1423 state->last_time = t;
1424 return (EAGAIN);
1425 } /* }}} */
1427 if (ds_type == DS_TYPE_DERIVE)
1428 {
1429 derive_t delta_derive = (derive_t) delta_gauge;
1431 state->last_value.derive += delta_derive;
1432 state->residual = delta_gauge - ((gauge_t) delta_derive);
1433 }
1434 else if (ds_type == DS_TYPE_COUNTER)
1435 {
1436 counter_t delta_counter = (counter_t) delta_gauge;
1438 state->last_value.counter += delta_counter;
1439 state->residual = delta_gauge - ((gauge_t) delta_counter);
1440 }
1441 else if (ds_type == DS_TYPE_ABSOLUTE)
1442 {
1443 absolute_t delta_absolute = (absolute_t) delta_gauge;
1445 state->last_value.absolute = delta_absolute;
1446 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1447 }
1448 else
1449 {
1450 assert (23 == 42);
1451 }
1453 state->last_time = t;
1454 *ret_value = state->last_value;
1455 return (0);
1456 } /* }}} value_t rate_to_value */
1458 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1459 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1460 {
1461 gauge_t interval;
1463 /* Another invalid state: The time is not increasing. */
1464 if (t <= state->last_time)
1465 {
1466 memset (state, 0, sizeof (*state));
1467 return (EINVAL);
1468 }
1470 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1472 /* Previous value is invalid. */
1473 if (state->last_time == 0)
1474 {
1475 state->last_value = value;
1476 state->last_time = t;
1477 return (EAGAIN);
1478 }
1480 switch (ds_type) {
1481 case DS_TYPE_DERIVE: {
1482 derive_t diff = value.derive - state->last_value.derive;
1483 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1484 break;
1485 }
1486 case DS_TYPE_GAUGE: {
1487 *ret_rate = value.gauge;
1488 break;
1489 }
1490 case DS_TYPE_COUNTER: {
1491 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1492 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1493 break;
1494 }
1495 case DS_TYPE_ABSOLUTE: {
1496 absolute_t diff = value.absolute;
1497 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1498 break;
1499 }
1500 default:
1501 return EINVAL;
1502 }
1504 state->last_value = value;
1505 state->last_time = t;
1506 return (0);
1507 } /* }}} value_t rate_to_value */
1509 int service_name_to_port_number (const char *service_name)
1510 {
1511 struct addrinfo *ai_list;
1512 int status;
1513 int service_number;
1515 if (service_name == NULL)
1516 return (-1);
1518 struct addrinfo ai_hints = {
1519 .ai_family = AF_UNSPEC
1520 };
1522 status = getaddrinfo (/* node = */ NULL, service_name,
1523 &ai_hints, &ai_list);
1524 if (status != 0)
1525 {
1526 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1527 gai_strerror (status));
1528 return (-1);
1529 }
1531 service_number = -1;
1532 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1533 {
1534 if (ai_ptr->ai_family == AF_INET)
1535 {
1536 struct sockaddr_in *sa;
1538 sa = (void *) ai_ptr->ai_addr;
1539 service_number = (int) ntohs (sa->sin_port);
1540 }
1541 else if (ai_ptr->ai_family == AF_INET6)
1542 {
1543 struct sockaddr_in6 *sa;
1545 sa = (void *) ai_ptr->ai_addr;
1546 service_number = (int) ntohs (sa->sin6_port);
1547 }
1549 if ((service_number > 0) && (service_number <= 65535))
1550 break;
1551 }
1553 freeaddrinfo (ai_list);
1555 if ((service_number > 0) && (service_number <= 65535))
1556 return (service_number);
1557 return (-1);
1558 } /* int service_name_to_port_number */
1560 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1561 {
1562 derive_t tmp;
1563 char *endptr;
1565 if ((string == NULL) || (ret_value == NULL))
1566 return (EINVAL);
1568 errno = 0;
1569 endptr = NULL;
1570 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1571 if ((endptr == string) || (errno != 0))
1572 return (-1);
1574 *ret_value = tmp;
1575 return (0);
1576 } /* }}} int strtoderive */
1578 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1579 {
1580 gauge_t tmp;
1581 char *endptr = NULL;
1583 if ((string == NULL) || (ret_value == NULL))
1584 return (EINVAL);
1586 errno = 0;
1587 endptr = NULL;
1588 tmp = (gauge_t) strtod (string, &endptr);
1589 if (errno != 0)
1590 return (errno);
1591 else if ((endptr == NULL) || (*endptr != 0))
1592 return (EINVAL);
1594 *ret_value = tmp;
1595 return (0);
1596 } /* }}} int strtogauge */
1598 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1599 {
1600 char **array;
1601 size_t array_len = *ret_array_len;
1603 if (str == NULL)
1604 return (EINVAL);
1606 array = realloc (*ret_array,
1607 (array_len + 1) * sizeof (*array));
1608 if (array == NULL)
1609 return (ENOMEM);
1610 *ret_array = array;
1612 array[array_len] = strdup (str);
1613 if (array[array_len] == NULL)
1614 return (ENOMEM);
1616 array_len++;
1617 *ret_array_len = array_len;
1618 return (0);
1619 } /* }}} int strarray_add */
1621 void strarray_free (char **array, size_t array_len) /* {{{ */
1622 {
1623 for (size_t i = 0; i < array_len; i++)
1624 sfree (array[i]);
1625 sfree (array);
1626 } /* }}} void strarray_free */