1 /**
2 * collectd - src/common.c
3 * Copyright (C) 2005-2014 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 * Niki W. Waibel <niki.waibel@gmx.net>
26 * Sebastian Harl <sh at tokkee.org>
27 * Michał Mirosław <mirq-linux at rere.qmqm.pl>
28 **/
30 #if HAVE_CONFIG_H
31 # include "config.h"
32 #endif
34 #include "collectd.h"
35 #include "common.h"
36 #include "plugin.h"
37 #include "utils_cache.h"
39 #if HAVE_PTHREAD_H
40 # include <pthread.h>
41 #endif
43 #ifdef HAVE_MATH_H
44 # include <math.h>
45 #endif
47 /* for getaddrinfo */
48 #include <sys/types.h>
49 #include <netdb.h>
51 #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 = malloc (alloc_buffer_size);
117 if (alloc_buffer == NULL)
118 return (NULL);
119 memset (alloc_buffer, 0, alloc_buffer_size);
121 /* Print again into this new buffer. */
122 va_start (ap, format);
123 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
124 va_end (ap);
125 if (status < 0)
126 {
127 sfree (alloc_buffer);
128 return (NULL);
129 }
131 return (alloc_buffer);
132 } /* }}} char *ssnprintf_alloc */
134 char *sstrdup (const char *s)
135 {
136 char *r;
137 size_t sz;
139 if (s == NULL)
140 return (NULL);
142 /* Do not use `strdup' here, because it's not specified in POSIX. It's
143 * ``only'' an XSI extension. */
144 sz = strlen (s) + 1;
145 r = (char *) malloc (sizeof (char) * sz);
146 if (r == NULL)
147 {
148 ERROR ("sstrdup: Out of memory.");
149 exit (3);
150 }
151 memcpy (r, s, sizeof (char) * sz);
153 return (r);
154 } /* char *sstrdup */
156 /* Even though Posix requires "strerror_r" to return an "int",
157 * some systems (e.g. the GNU libc) return a "char *" _and_
158 * ignore the second argument ... -tokkee */
159 char *sstrerror (int errnum, char *buf, size_t buflen)
160 {
161 buf[0] = '\0';
163 #if !HAVE_STRERROR_R
164 {
165 char *temp;
167 pthread_mutex_lock (&strerror_r_lock);
169 temp = strerror (errnum);
170 sstrncpy (buf, temp, buflen);
172 pthread_mutex_unlock (&strerror_r_lock);
173 }
174 /* #endif !HAVE_STRERROR_R */
176 #elif STRERROR_R_CHAR_P
177 {
178 char *temp;
179 temp = strerror_r (errnum, buf, buflen);
180 if (buf[0] == '\0')
181 {
182 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
183 sstrncpy (buf, temp, buflen);
184 else
185 sstrncpy (buf, "strerror_r did not return "
186 "an error message", buflen);
187 }
188 }
189 /* #endif STRERROR_R_CHAR_P */
191 #else
192 if (strerror_r (errnum, buf, buflen) != 0)
193 {
194 ssnprintf (buf, buflen, "Error #%i; "
195 "Additionally, strerror_r failed.",
196 errnum);
197 }
198 #endif /* STRERROR_R_CHAR_P */
200 return (buf);
201 } /* char *sstrerror */
203 void *smalloc (size_t size)
204 {
205 void *r;
207 if ((r = malloc (size)) == NULL)
208 {
209 ERROR ("Not enough memory.");
210 exit (3);
211 }
213 return (r);
214 } /* void *smalloc */
216 #if 0
217 void sfree (void **ptr)
218 {
219 if (ptr == NULL)
220 return;
222 if (*ptr != NULL)
223 free (*ptr);
225 *ptr = NULL;
226 }
227 #endif
229 ssize_t sread (int fd, void *buf, size_t count)
230 {
231 char *ptr;
232 size_t nleft;
233 ssize_t status;
235 ptr = (char *) buf;
236 nleft = count;
238 while (nleft > 0)
239 {
240 status = read (fd, (void *) ptr, nleft);
242 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
243 continue;
245 if (status < 0)
246 return (status);
248 if (status == 0)
249 {
250 DEBUG ("Received EOF from fd %i. "
251 "Closing fd and returning error.",
252 fd);
253 close (fd);
254 return (-1);
255 }
257 assert ((0 > status) || (nleft >= (size_t)status));
259 nleft = nleft - ((size_t) status);
260 ptr = ptr + ((size_t) status);
261 }
263 return (0);
264 }
267 ssize_t swrite (int fd, const void *buf, size_t count)
268 {
269 const char *ptr;
270 size_t nleft;
271 ssize_t status;
273 ptr = (const char *) buf;
274 nleft = count;
276 while (nleft > 0)
277 {
278 status = write (fd, (const void *) ptr, nleft);
280 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
281 continue;
283 if (status < 0)
284 return (status);
286 nleft = nleft - ((size_t) status);
287 ptr = ptr + ((size_t) status);
288 }
290 return (0);
291 }
293 int strsplit (char *string, char **fields, size_t size)
294 {
295 size_t i;
296 char *ptr;
297 char *saveptr;
299 i = 0;
300 ptr = string;
301 saveptr = NULL;
302 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
303 {
304 ptr = NULL;
305 i++;
307 if (i >= size)
308 break;
309 }
311 return ((int) i);
312 }
314 int strjoin (char *buffer, size_t buffer_size,
315 char **fields, size_t fields_num,
316 const char *sep)
317 {
318 size_t avail;
319 char *ptr;
320 size_t sep_len;
321 size_t i;
323 if ((buffer_size < 1) || (fields_num <= 0))
324 return (-1);
326 memset (buffer, 0, buffer_size);
327 ptr = buffer;
328 avail = buffer_size - 1;
330 sep_len = 0;
331 if (sep != NULL)
332 sep_len = strlen (sep);
334 for (i = 0; i < fields_num; i++)
335 {
336 size_t field_len;
338 if ((i > 0) && (sep_len > 0))
339 {
340 if (avail < sep_len)
341 return (-1);
343 memcpy (ptr, sep, sep_len);
344 ptr += sep_len;
345 avail -= sep_len;
346 }
348 field_len = strlen (fields[i]);
349 if (avail < field_len)
350 return (-1);
352 memcpy (ptr, fields[i], field_len);
353 ptr += field_len;
354 avail -= field_len;
355 }
357 assert (buffer[buffer_size - 1] == 0);
358 return ((int) strlen (buffer));
359 }
361 int strsubstitute (char *str, char c_from, char c_to)
362 {
363 int ret;
365 if (str == NULL)
366 return (-1);
368 ret = 0;
369 while (*str != '\0')
370 {
371 if (*str == c_from)
372 {
373 *str = c_to;
374 ret++;
375 }
376 str++;
377 }
379 return (ret);
380 } /* int strsubstitute */
382 int escape_string (char *buffer, size_t buffer_size)
383 {
384 char *temp;
385 size_t i;
386 size_t j;
388 /* Check if we need to escape at all first */
389 temp = strpbrk (buffer, " \t\"\\");
390 if (temp == NULL)
391 return (0);
393 if (buffer_size < 3)
394 return (EINVAL);
396 temp = (char *) malloc (buffer_size);
397 if (temp == NULL)
398 return (ENOMEM);
399 memset (temp, 0, buffer_size);
401 temp[0] = '"';
402 j = 1;
404 for (i = 0; i < buffer_size; i++)
405 {
406 if (buffer[i] == 0)
407 {
408 break;
409 }
410 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
411 {
412 if (j > (buffer_size - 4))
413 break;
414 temp[j] = '\\';
415 temp[j + 1] = buffer[i];
416 j += 2;
417 }
418 else
419 {
420 if (j > (buffer_size - 3))
421 break;
422 temp[j] = buffer[i];
423 j++;
424 }
425 }
427 assert ((j + 1) < buffer_size);
428 temp[j] = '"';
429 temp[j + 1] = 0;
431 sstrncpy (buffer, temp, buffer_size);
432 sfree (temp);
433 return (0);
434 } /* int escape_string */
436 int strunescape (char *buf, size_t buf_len)
437 {
438 size_t i;
440 for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
441 {
442 if (buf[i] != '\\')
443 continue;
445 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
446 ERROR ("string unescape: backslash found at end of string.");
447 /* Ensure null-byte at the end of the buffer. */
448 buf[i] = 0;
449 return (-1);
450 }
452 switch (buf[i + 1]) {
453 case 't':
454 buf[i] = '\t';
455 break;
456 case 'n':
457 buf[i] = '\n';
458 break;
459 case 'r':
460 buf[i] = '\r';
461 break;
462 default:
463 buf[i] = buf[i + 1];
464 break;
465 }
467 /* Move everything after the position one position to the left.
468 * Add a null-byte as last character in the buffer. */
469 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
470 buf[buf_len - 1] = 0;
471 }
472 return (0);
473 } /* int strunescape */
475 size_t strstripnewline (char *buffer)
476 {
477 size_t buffer_len = strlen (buffer);
479 while (buffer_len > 0)
480 {
481 if ((buffer[buffer_len - 1] != '\n')
482 && (buffer[buffer_len - 1] != '\r'))
483 break;
484 buffer_len--;
485 buffer[buffer_len] = 0;
486 }
488 return (buffer_len);
489 } /* size_t strstripnewline */
491 int escape_slashes (char *buffer, size_t buffer_size)
492 {
493 size_t buffer_len;
494 size_t i;
496 buffer_len = strlen (buffer);
498 if (buffer_len <= 1)
499 {
500 if (strcmp ("/", buffer) == 0)
501 {
502 if (buffer_size < 5)
503 return (-1);
504 sstrncpy (buffer, "root", buffer_size);
505 }
506 return (0);
507 }
509 /* Move one to the left */
510 if (buffer[0] == '/')
511 {
512 memmove (buffer, buffer + 1, buffer_len);
513 buffer_len--;
514 }
516 for (i = 0; i < buffer_len; i++)
517 {
518 if (buffer[i] == '/')
519 buffer[i] = '_';
520 }
522 return (0);
523 } /* int escape_slashes */
525 void replace_special (char *buffer, size_t buffer_size)
526 {
527 size_t i;
529 for (i = 0; i < buffer_size; i++)
530 {
531 if (buffer[i] == 0)
532 return;
533 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
534 buffer[i] = '_';
535 }
536 } /* void replace_special */
538 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
539 {
540 struct timeval *larger;
541 struct timeval *smaller;
543 int status;
545 NORMALIZE_TIMEVAL (tv0);
546 NORMALIZE_TIMEVAL (tv1);
548 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
549 {
550 if (delta != NULL) {
551 delta->tv_sec = 0;
552 delta->tv_usec = 0;
553 }
554 return (0);
555 }
557 if ((tv0.tv_sec < tv1.tv_sec)
558 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
559 {
560 larger = &tv1;
561 smaller = &tv0;
562 status = -1;
563 }
564 else
565 {
566 larger = &tv0;
567 smaller = &tv1;
568 status = 1;
569 }
571 if (delta != NULL) {
572 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
574 if (smaller->tv_usec <= larger->tv_usec)
575 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
576 else
577 {
578 --delta->tv_sec;
579 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
580 }
581 }
583 assert ((delta == NULL)
584 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
586 return (status);
587 } /* int timeval_cmp */
589 int check_create_dir (const char *file_orig)
590 {
591 struct stat statbuf;
593 char file_copy[512];
594 char dir[512];
595 int dir_len = 512;
596 char *fields[16];
597 int fields_num;
598 char *ptr;
599 char *saveptr;
600 int last_is_file = 1;
601 int path_is_absolute = 0;
602 size_t len;
603 int i;
605 /*
606 * Sanity checks first
607 */
608 if (file_orig == NULL)
609 return (-1);
611 if ((len = strlen (file_orig)) < 1)
612 return (-1);
613 else if (len >= sizeof (file_copy))
614 return (-1);
616 /*
617 * If `file_orig' ends in a slash the last component is a directory,
618 * otherwise it's a file. Act accordingly..
619 */
620 if (file_orig[len - 1] == '/')
621 last_is_file = 0;
622 if (file_orig[0] == '/')
623 path_is_absolute = 1;
625 /*
626 * Create a copy for `strtok_r' to destroy
627 */
628 sstrncpy (file_copy, file_orig, sizeof (file_copy));
630 /*
631 * Break into components. This will eat up several slashes in a row and
632 * remove leading and trailing slashes..
633 */
634 ptr = file_copy;
635 saveptr = NULL;
636 fields_num = 0;
637 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
638 {
639 ptr = NULL;
640 fields_num++;
642 if (fields_num >= 16)
643 break;
644 }
646 /*
647 * For each component, do..
648 */
649 for (i = 0; i < (fields_num - last_is_file); i++)
650 {
651 /*
652 * Do not create directories that start with a dot. This
653 * prevents `../../' attacks and other likely malicious
654 * behavior.
655 */
656 if (fields[i][0] == '.')
657 {
658 ERROR ("Cowardly refusing to create a directory that "
659 "begins with a `.' (dot): `%s'", file_orig);
660 return (-2);
661 }
663 /*
664 * Join the components together again
665 */
666 dir[0] = '/';
667 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
668 fields, (size_t) (i + 1), "/") < 0)
669 {
670 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
671 return (-1);
672 }
674 while (42) {
675 if ((stat (dir, &statbuf) == -1)
676 && (lstat (dir, &statbuf) == -1))
677 {
678 if (errno == ENOENT)
679 {
680 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
681 break;
683 /* this might happen, if a different thread created
684 * the directory in the meantime
685 * => call stat() again to check for S_ISDIR() */
686 if (EEXIST == errno)
687 continue;
689 char errbuf[1024];
690 ERROR ("check_create_dir: mkdir (%s): %s", dir,
691 sstrerror (errno,
692 errbuf, sizeof (errbuf)));
693 return (-1);
694 }
695 else
696 {
697 char errbuf[1024];
698 ERROR ("check_create_dir: stat (%s): %s", dir,
699 sstrerror (errno, errbuf,
700 sizeof (errbuf)));
701 return (-1);
702 }
703 }
704 else if (!S_ISDIR (statbuf.st_mode))
705 {
706 ERROR ("check_create_dir: `%s' exists but is not "
707 "a directory!", dir);
708 return (-1);
709 }
710 break;
711 }
712 }
714 return (0);
715 } /* check_create_dir */
717 #ifdef HAVE_LIBKSTAT
718 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
719 {
720 char ident[128];
722 *ksp_ptr = NULL;
724 if (kc == NULL)
725 return (-1);
727 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
729 *ksp_ptr = kstat_lookup (kc, module, instance, name);
730 if (*ksp_ptr == NULL)
731 {
732 ERROR ("get_kstat: Cound not find kstat %s", ident);
733 return (-1);
734 }
736 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
737 {
738 ERROR ("get_kstat: kstat %s has wrong type", ident);
739 *ksp_ptr = NULL;
740 return (-1);
741 }
743 #ifdef assert
744 assert (*ksp_ptr != NULL);
745 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
746 #endif
748 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
749 {
750 ERROR ("get_kstat: kstat %s could not be read", ident);
751 return (-1);
752 }
754 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
755 {
756 ERROR ("get_kstat: kstat %s has wrong type", ident);
757 return (-1);
758 }
760 return (0);
761 }
763 long long get_kstat_value (kstat_t *ksp, char *name)
764 {
765 kstat_named_t *kn;
766 long long retval = -1LL;
768 if (ksp == NULL)
769 {
770 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
771 return (-1LL);
772 }
773 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
774 {
775 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
776 "is not KSTAT_TYPE_NAMED (%#x).",
777 name,
778 (unsigned int) ksp->ks_type,
779 (unsigned int) KSTAT_TYPE_NAMED);
780 return (-1LL);
781 }
783 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
784 return (-1LL);
786 if (kn->data_type == KSTAT_DATA_INT32)
787 retval = (long long) kn->value.i32;
788 else if (kn->data_type == KSTAT_DATA_UINT32)
789 retval = (long long) kn->value.ui32;
790 else if (kn->data_type == KSTAT_DATA_INT64)
791 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
792 else if (kn->data_type == KSTAT_DATA_UINT64)
793 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
794 else
795 WARNING ("get_kstat_value: Not a numeric value: %s", name);
797 return (retval);
798 }
799 #endif /* HAVE_LIBKSTAT */
801 #ifndef HAVE_HTONLL
802 unsigned long long ntohll (unsigned long long n)
803 {
804 #if BYTE_ORDER == BIG_ENDIAN
805 return (n);
806 #else
807 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
808 #endif
809 } /* unsigned long long ntohll */
811 unsigned long long htonll (unsigned long long n)
812 {
813 #if BYTE_ORDER == BIG_ENDIAN
814 return (n);
815 #else
816 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
817 #endif
818 } /* unsigned long long htonll */
819 #endif /* HAVE_HTONLL */
821 #if FP_LAYOUT_NEED_NOTHING
822 /* Well, we need nothing.. */
823 /* #endif FP_LAYOUT_NEED_NOTHING */
825 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
826 # if FP_LAYOUT_NEED_ENDIANFLIP
827 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
828 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
829 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
830 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
831 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
832 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
833 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
834 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
835 # else
836 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
837 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
838 # endif
840 double ntohd (double d)
841 {
842 union
843 {
844 uint8_t byte[8];
845 uint64_t integer;
846 double floating;
847 } ret;
849 ret.floating = d;
851 /* NAN in x86 byte order */
852 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
853 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
854 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
855 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
856 {
857 return (NAN);
858 }
859 else
860 {
861 uint64_t tmp;
863 tmp = ret.integer;
864 ret.integer = FP_CONVERT (tmp);
865 return (ret.floating);
866 }
867 } /* double ntohd */
869 double htond (double d)
870 {
871 union
872 {
873 uint8_t byte[8];
874 uint64_t integer;
875 double floating;
876 } ret;
878 if (isnan (d))
879 {
880 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
881 ret.byte[4] = ret.byte[5] = 0x00;
882 ret.byte[6] = 0xf8;
883 ret.byte[7] = 0x7f;
884 return (ret.floating);
885 }
886 else
887 {
888 uint64_t tmp;
890 ret.floating = d;
891 tmp = FP_CONVERT (ret.integer);
892 ret.integer = tmp;
893 return (ret.floating);
894 }
895 } /* double htond */
896 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
898 int format_name (char *ret, int ret_len,
899 const char *hostname,
900 const char *plugin, const char *plugin_instance,
901 const char *type, const char *type_instance)
902 {
903 char *buffer;
904 size_t buffer_size;
906 buffer = ret;
907 buffer_size = (size_t) ret_len;
909 #define APPEND(str) do { \
910 size_t l = strlen (str); \
911 if (l >= buffer_size) \
912 return (ENOBUFS); \
913 memcpy (buffer, (str), l); \
914 buffer += l; buffer_size -= l; \
915 } while (0)
917 assert (plugin != NULL);
918 assert (type != NULL);
920 APPEND (hostname);
921 APPEND ("/");
922 APPEND (plugin);
923 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
924 {
925 APPEND ("-");
926 APPEND (plugin_instance);
927 }
928 APPEND ("/");
929 APPEND (type);
930 if ((type_instance != NULL) && (type_instance[0] != 0))
931 {
932 APPEND ("-");
933 APPEND (type_instance);
934 }
935 assert (buffer_size > 0);
936 buffer[0] = 0;
938 #undef APPEND
939 return (0);
940 } /* int format_name */
942 int format_values (char *ret, size_t ret_len, /* {{{ */
943 const data_set_t *ds, const value_list_t *vl,
944 _Bool store_rates)
945 {
946 size_t offset = 0;
947 int status;
948 size_t i;
949 gauge_t *rates = NULL;
951 assert (0 == strcmp (ds->type, vl->type));
953 memset (ret, 0, ret_len);
955 #define BUFFER_ADD(...) do { \
956 status = ssnprintf (ret + offset, ret_len - offset, \
957 __VA_ARGS__); \
958 if (status < 1) \
959 { \
960 sfree (rates); \
961 return (-1); \
962 } \
963 else if (((size_t) status) >= (ret_len - offset)) \
964 { \
965 sfree (rates); \
966 return (-1); \
967 } \
968 else \
969 offset += ((size_t) status); \
970 } while (0)
972 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
974 for (i = 0; i < ds->ds_num; i++)
975 {
976 if (ds->ds[i].type == DS_TYPE_GAUGE)
977 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
978 else if (store_rates)
979 {
980 if (rates == NULL)
981 rates = uc_get_rate (ds, vl);
982 if (rates == NULL)
983 {
984 WARNING ("format_values: uc_get_rate failed.");
985 return (-1);
986 }
987 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
988 }
989 else if (ds->ds[i].type == DS_TYPE_COUNTER)
990 BUFFER_ADD (":%llu", vl->values[i].counter);
991 else if (ds->ds[i].type == DS_TYPE_DERIVE)
992 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
993 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
994 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
995 else
996 {
997 ERROR ("format_values: Unknown data source type: %i",
998 ds->ds[i].type);
999 sfree (rates);
1000 return (-1);
1001 }
1002 } /* for ds->ds_num */
1004 #undef BUFFER_ADD
1006 sfree (rates);
1007 return (0);
1008 } /* }}} int format_values */
1010 int parse_identifier (char *str, char **ret_host,
1011 char **ret_plugin, char **ret_plugin_instance,
1012 char **ret_type, char **ret_type_instance)
1013 {
1014 char *hostname = NULL;
1015 char *plugin = NULL;
1016 char *plugin_instance = NULL;
1017 char *type = NULL;
1018 char *type_instance = NULL;
1020 hostname = str;
1021 if (hostname == NULL)
1022 return (-1);
1024 plugin = strchr (hostname, '/');
1025 if (plugin == NULL)
1026 return (-1);
1027 *plugin = '\0'; plugin++;
1029 type = strchr (plugin, '/');
1030 if (type == NULL)
1031 return (-1);
1032 *type = '\0'; type++;
1034 plugin_instance = strchr (plugin, '-');
1035 if (plugin_instance != NULL)
1036 {
1037 *plugin_instance = '\0';
1038 plugin_instance++;
1039 }
1041 type_instance = strchr (type, '-');
1042 if (type_instance != NULL)
1043 {
1044 *type_instance = '\0';
1045 type_instance++;
1046 }
1048 *ret_host = hostname;
1049 *ret_plugin = plugin;
1050 *ret_plugin_instance = plugin_instance;
1051 *ret_type = type;
1052 *ret_type_instance = type_instance;
1053 return (0);
1054 } /* int parse_identifier */
1056 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1057 {
1058 char str_copy[6 * DATA_MAX_NAME_LEN];
1059 char *host = NULL;
1060 char *plugin = NULL;
1061 char *plugin_instance = NULL;
1062 char *type = NULL;
1063 char *type_instance = NULL;
1064 int status;
1066 if ((str == NULL) || (vl == NULL))
1067 return (EINVAL);
1069 sstrncpy (str_copy, str, sizeof (str_copy));
1071 status = parse_identifier (str_copy, &host,
1072 &plugin, &plugin_instance,
1073 &type, &type_instance);
1074 if (status != 0)
1075 return (status);
1077 sstrncpy (vl->host, host, sizeof (vl->host));
1078 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1079 sstrncpy (vl->plugin_instance,
1080 (plugin_instance != NULL) ? plugin_instance : "",
1081 sizeof (vl->plugin_instance));
1082 sstrncpy (vl->type, type, sizeof (vl->type));
1083 sstrncpy (vl->type_instance,
1084 (type_instance != NULL) ? type_instance : "",
1085 sizeof (vl->type_instance));
1087 return (0);
1088 } /* }}} int parse_identifier_vl */
1090 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1091 {
1092 char *value;
1093 char *endptr = NULL;
1094 size_t value_len;
1096 if (value_orig == NULL)
1097 return (EINVAL);
1099 value = strdup (value_orig);
1100 if (value == NULL)
1101 return (ENOMEM);
1102 value_len = strlen (value);
1104 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1105 {
1106 value[value_len - 1] = 0;
1107 value_len--;
1108 }
1110 switch (ds_type)
1111 {
1112 case DS_TYPE_COUNTER:
1113 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1114 break;
1116 case DS_TYPE_GAUGE:
1117 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1118 break;
1120 case DS_TYPE_DERIVE:
1121 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1122 break;
1124 case DS_TYPE_ABSOLUTE:
1125 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1126 break;
1128 default:
1129 sfree (value);
1130 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1131 return -1;
1132 }
1134 if (value == endptr) {
1135 ERROR ("parse_value: Failed to parse string as %s: %s.",
1136 DS_TYPE_TO_STRING (ds_type), value);
1137 sfree (value);
1138 return -1;
1139 }
1140 else if ((NULL != endptr) && ('\0' != *endptr))
1141 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1142 "Input string was \"%s\".",
1143 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1145 sfree (value);
1146 return 0;
1147 } /* int parse_value */
1149 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1150 {
1151 size_t i;
1152 char *dummy;
1153 char *ptr;
1154 char *saveptr;
1156 i = 0;
1157 dummy = buffer;
1158 saveptr = NULL;
1159 vl->time = 0;
1160 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1161 {
1162 dummy = NULL;
1164 if (i >= vl->values_len)
1165 {
1166 /* Make sure i is invalid. */
1167 i = 0;
1168 break;
1169 }
1171 if (vl->time == 0)
1172 {
1173 if (strcmp ("N", ptr) == 0)
1174 vl->time = cdtime ();
1175 else
1176 {
1177 char *endptr = NULL;
1178 double tmp;
1180 errno = 0;
1181 tmp = strtod (ptr, &endptr);
1182 if ((errno != 0) /* Overflow */
1183 || (endptr == ptr) /* Invalid string */
1184 || (endptr == NULL) /* This should not happen */
1185 || (*endptr != 0)) /* Trailing chars */
1186 return (-1);
1188 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1189 }
1191 continue;
1192 }
1194 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1195 vl->values[i].gauge = NAN;
1196 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1197 return -1;
1199 i++;
1200 } /* while (strtok_r) */
1202 if ((ptr != NULL) || (i == 0))
1203 return (-1);
1204 return (0);
1205 } /* int parse_values */
1207 #if !HAVE_GETPWNAM_R
1208 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1209 size_t buflen, struct passwd **pwbufp)
1210 {
1211 int status = 0;
1212 struct passwd *pw;
1214 memset (pwbuf, '\0', sizeof (struct passwd));
1216 pthread_mutex_lock (&getpwnam_r_lock);
1218 do
1219 {
1220 pw = getpwnam (name);
1221 if (pw == NULL)
1222 {
1223 status = (errno != 0) ? errno : ENOENT;
1224 break;
1225 }
1227 #define GETPWNAM_COPY_MEMBER(member) \
1228 if (pw->member != NULL) \
1229 { \
1230 int len = strlen (pw->member); \
1231 if (len >= buflen) \
1232 { \
1233 status = ENOMEM; \
1234 break; \
1235 } \
1236 sstrncpy (buf, pw->member, buflen); \
1237 pwbuf->member = buf; \
1238 buf += (len + 1); \
1239 buflen -= (len + 1); \
1240 }
1241 GETPWNAM_COPY_MEMBER(pw_name);
1242 GETPWNAM_COPY_MEMBER(pw_passwd);
1243 GETPWNAM_COPY_MEMBER(pw_gecos);
1244 GETPWNAM_COPY_MEMBER(pw_dir);
1245 GETPWNAM_COPY_MEMBER(pw_shell);
1247 pwbuf->pw_uid = pw->pw_uid;
1248 pwbuf->pw_gid = pw->pw_gid;
1250 if (pwbufp != NULL)
1251 *pwbufp = pwbuf;
1252 } while (0);
1254 pthread_mutex_unlock (&getpwnam_r_lock);
1256 return (status);
1257 } /* int getpwnam_r */
1258 #endif /* !HAVE_GETPWNAM_R */
1260 int notification_init (notification_t *n, int severity, const char *message,
1261 const char *host,
1262 const char *plugin, const char *plugin_instance,
1263 const char *type, const char *type_instance)
1264 {
1265 memset (n, '\0', sizeof (notification_t));
1267 n->severity = severity;
1269 if (message != NULL)
1270 sstrncpy (n->message, message, sizeof (n->message));
1271 if (host != NULL)
1272 sstrncpy (n->host, host, sizeof (n->host));
1273 if (plugin != NULL)
1274 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1275 if (plugin_instance != NULL)
1276 sstrncpy (n->plugin_instance, plugin_instance,
1277 sizeof (n->plugin_instance));
1278 if (type != NULL)
1279 sstrncpy (n->type, type, sizeof (n->type));
1280 if (type_instance != NULL)
1281 sstrncpy (n->type_instance, type_instance,
1282 sizeof (n->type_instance));
1284 return (0);
1285 } /* int notification_init */
1287 int walk_directory (const char *dir, dirwalk_callback_f callback,
1288 void *user_data, int include_hidden)
1289 {
1290 struct dirent *ent;
1291 DIR *dh;
1292 int success;
1293 int failure;
1295 success = 0;
1296 failure = 0;
1298 if ((dh = opendir (dir)) == NULL)
1299 {
1300 char errbuf[1024];
1301 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1302 sstrerror (errno, errbuf, sizeof (errbuf)));
1303 return -1;
1304 }
1306 while ((ent = readdir (dh)) != NULL)
1307 {
1308 int status;
1310 if (include_hidden)
1311 {
1312 if ((strcmp (".", ent->d_name) == 0)
1313 || (strcmp ("..", ent->d_name) == 0))
1314 continue;
1315 }
1316 else /* if (!include_hidden) */
1317 {
1318 if (ent->d_name[0]=='.')
1319 continue;
1320 }
1322 status = (*callback) (dir, ent->d_name, user_data);
1323 if (status != 0)
1324 failure++;
1325 else
1326 success++;
1327 }
1329 closedir (dh);
1331 if ((success == 0) && (failure > 0))
1332 return (-1);
1333 return (0);
1334 }
1336 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1337 {
1338 FILE *fh;
1339 ssize_t ret;
1341 fh = fopen (filename, "r");
1342 if (fh == NULL)
1343 return (-1);
1345 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1346 if ((ret == 0) && (ferror (fh) != 0))
1347 {
1348 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1349 filename);
1350 ret = -1;
1351 }
1353 fclose(fh);
1354 return (ret);
1355 }
1357 counter_t counter_diff (counter_t old_value, counter_t new_value)
1358 {
1359 counter_t diff;
1361 if (old_value > new_value)
1362 {
1363 if (old_value <= 4294967295U)
1364 diff = (4294967295U - old_value) + new_value + 1;
1365 else
1366 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1367 }
1368 else
1369 {
1370 diff = new_value - old_value;
1371 }
1373 return (diff);
1374 } /* counter_t counter_diff */
1376 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1377 rate_to_value_state_t *state,
1378 int ds_type, cdtime_t t)
1379 {
1380 gauge_t delta_gauge;
1381 cdtime_t delta_t;
1383 if (ds_type == DS_TYPE_GAUGE)
1384 {
1385 state->last_value.gauge = rate;
1386 state->last_time = t;
1388 *ret_value = state->last_value;
1389 return (0);
1390 }
1392 /* Counter and absolute can't handle negative rates. Reset "last time"
1393 * to zero, so that the next valid rate will re-initialize the
1394 * structure. */
1395 if ((rate < 0.0)
1396 && ((ds_type == DS_TYPE_COUNTER)
1397 || (ds_type == DS_TYPE_ABSOLUTE)))
1398 {
1399 memset (state, 0, sizeof (*state));
1400 return (EINVAL);
1401 }
1403 /* Another invalid state: The time is not increasing. */
1404 if (t <= state->last_time)
1405 {
1406 memset (state, 0, sizeof (*state));
1407 return (EINVAL);
1408 }
1410 delta_t = t - state->last_time;
1411 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1413 /* Previous value is invalid. */
1414 if (state->last_time == 0) /* {{{ */
1415 {
1416 if (ds_type == DS_TYPE_DERIVE)
1417 {
1418 state->last_value.derive = (derive_t) rate;
1419 state->residual = rate - ((gauge_t) state->last_value.derive);
1420 }
1421 else if (ds_type == DS_TYPE_COUNTER)
1422 {
1423 state->last_value.counter = (counter_t) rate;
1424 state->residual = rate - ((gauge_t) state->last_value.counter);
1425 }
1426 else if (ds_type == DS_TYPE_ABSOLUTE)
1427 {
1428 state->last_value.absolute = (absolute_t) rate;
1429 state->residual = rate - ((gauge_t) state->last_value.absolute);
1430 }
1431 else
1432 {
1433 assert (23 == 42);
1434 }
1436 state->last_time = t;
1437 return (EAGAIN);
1438 } /* }}} */
1440 if (ds_type == DS_TYPE_DERIVE)
1441 {
1442 derive_t delta_derive = (derive_t) delta_gauge;
1444 state->last_value.derive += delta_derive;
1445 state->residual = delta_gauge - ((gauge_t) delta_derive);
1446 }
1447 else if (ds_type == DS_TYPE_COUNTER)
1448 {
1449 counter_t delta_counter = (counter_t) delta_gauge;
1451 state->last_value.counter += delta_counter;
1452 state->residual = delta_gauge - ((gauge_t) delta_counter);
1453 }
1454 else if (ds_type == DS_TYPE_ABSOLUTE)
1455 {
1456 absolute_t delta_absolute = (absolute_t) delta_gauge;
1458 state->last_value.absolute = delta_absolute;
1459 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1460 }
1461 else
1462 {
1463 assert (23 == 42);
1464 }
1466 state->last_time = t;
1467 *ret_value = state->last_value;
1468 return (0);
1469 } /* }}} value_t rate_to_value */
1471 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1472 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1473 {
1474 gauge_t interval;
1476 /* Another invalid state: The time is not increasing. */
1477 if (t <= state->last_time)
1478 {
1479 memset (state, 0, sizeof (*state));
1480 return (EINVAL);
1481 }
1483 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1485 /* Previous value is invalid. */
1486 if (state->last_time == 0)
1487 {
1488 state->last_value = value;
1489 state->last_time = t;
1490 return (EAGAIN);
1491 }
1493 switch (ds_type) {
1494 case DS_TYPE_DERIVE: {
1495 derive_t diff = value.derive - state->last_value.derive;
1496 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1497 break;
1498 }
1499 case DS_TYPE_GAUGE: {
1500 *ret_rate = value.gauge;
1501 break;
1502 }
1503 case DS_TYPE_COUNTER: {
1504 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1505 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1506 break;
1507 }
1508 case DS_TYPE_ABSOLUTE: {
1509 absolute_t diff = value.absolute;
1510 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1511 break;
1512 }
1513 default:
1514 return EINVAL;
1515 }
1517 state->last_value = value;
1518 state->last_time = t;
1519 return (0);
1520 } /* }}} value_t rate_to_value */
1522 int service_name_to_port_number (const char *service_name)
1523 {
1524 struct addrinfo *ai_list;
1525 struct addrinfo *ai_ptr;
1526 struct addrinfo ai_hints;
1527 int status;
1528 int service_number;
1530 if (service_name == NULL)
1531 return (-1);
1533 ai_list = NULL;
1534 memset (&ai_hints, 0, sizeof (ai_hints));
1535 ai_hints.ai_family = AF_UNSPEC;
1537 status = getaddrinfo (/* node = */ NULL, service_name,
1538 &ai_hints, &ai_list);
1539 if (status != 0)
1540 {
1541 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1542 gai_strerror (status));
1543 return (-1);
1544 }
1546 service_number = -1;
1547 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1548 {
1549 if (ai_ptr->ai_family == AF_INET)
1550 {
1551 struct sockaddr_in *sa;
1553 sa = (void *) ai_ptr->ai_addr;
1554 service_number = (int) ntohs (sa->sin_port);
1555 }
1556 else if (ai_ptr->ai_family == AF_INET6)
1557 {
1558 struct sockaddr_in6 *sa;
1560 sa = (void *) ai_ptr->ai_addr;
1561 service_number = (int) ntohs (sa->sin6_port);
1562 }
1564 if ((service_number > 0) && (service_number <= 65535))
1565 break;
1566 }
1568 freeaddrinfo (ai_list);
1570 if ((service_number > 0) && (service_number <= 65535))
1571 return (service_number);
1572 return (-1);
1573 } /* int service_name_to_port_number */
1575 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1576 {
1577 derive_t tmp;
1578 char *endptr;
1580 if ((string == NULL) || (ret_value == NULL))
1581 return (EINVAL);
1583 errno = 0;
1584 endptr = NULL;
1585 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1586 if ((endptr == string) || (errno != 0))
1587 return (-1);
1589 *ret_value = tmp;
1590 return (0);
1591 } /* }}} int strtoderive */
1593 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1594 {
1595 gauge_t tmp;
1596 char *endptr = NULL;
1598 if ((string == NULL) || (ret_value == NULL))
1599 return (EINVAL);
1601 errno = 0;
1602 endptr = NULL;
1603 tmp = (gauge_t) strtod (string, &endptr);
1604 if (errno != 0)
1605 return (errno);
1606 else if ((endptr == NULL) || (*endptr != 0))
1607 return (EINVAL);
1609 *ret_value = tmp;
1610 return (0);
1611 } /* }}} int strtogauge */
1613 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1614 {
1615 char **array;
1616 size_t array_len = *ret_array_len;
1618 if (str == NULL)
1619 return (EINVAL);
1621 array = realloc (*ret_array,
1622 (array_len + 1) * sizeof (*array));
1623 if (array == NULL)
1624 return (ENOMEM);
1625 *ret_array = array;
1627 array[array_len] = strdup (str);
1628 if (array[array_len] == NULL)
1629 return (ENOMEM);
1631 array_len++;
1632 *ret_array_len = array_len;
1633 return (0);
1634 } /* }}} int strarray_add */
1636 void strarray_free (char **array, size_t array_len) /* {{{ */
1637 {
1638 size_t i;
1640 for (i = 0; i < array_len; i++)
1641 sfree (array[i]);
1642 sfree (array);
1643 } /* }}} void strarray_free */