cb4870ca2e1ae42e24758bcdb03d17d64ec7dd47
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 <sys/socket.h>
50 #include <netdb.h>
52 #if HAVE_NETINET_IN_H
53 # include <netinet/in.h>
54 #endif
56 /* for ntohl and htonl */
57 #if HAVE_ARPA_INET_H
58 # include <arpa/inet.h>
59 #endif
61 #ifdef HAVE_LIBKSTAT
62 extern kstat_ctl_t *kc;
63 #endif
65 #if !HAVE_GETPWNAM_R
66 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
67 #endif
69 #if !HAVE_STRERROR_R
70 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
71 #endif
73 char *sstrncpy (char *dest, const char *src, size_t n)
74 {
75 strncpy (dest, src, n);
76 dest[n - 1] = '\0';
78 return (dest);
79 } /* char *sstrncpy */
81 int ssnprintf (char *dest, size_t n, const char *format, ...)
82 {
83 int ret = 0;
84 va_list ap;
86 va_start (ap, format);
87 ret = vsnprintf (dest, n, format, ap);
88 dest[n - 1] = '\0';
89 va_end (ap);
91 return (ret);
92 } /* int ssnprintf */
94 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
95 {
96 char static_buffer[1024] = "";
97 char *alloc_buffer;
98 size_t alloc_buffer_size;
99 int status;
100 va_list ap;
102 /* Try printing into the static buffer. In many cases it will be
103 * sufficiently large and we can simply return a strdup() of this
104 * buffer. */
105 va_start (ap, format);
106 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
107 va_end (ap);
108 if (status < 0)
109 return (NULL);
111 /* "status" does not include the null byte. */
112 alloc_buffer_size = (size_t) (status + 1);
113 if (alloc_buffer_size <= sizeof (static_buffer))
114 return (strdup (static_buffer));
116 /* Allocate a buffer large enough to hold the string. */
117 alloc_buffer = malloc (alloc_buffer_size);
118 if (alloc_buffer == NULL)
119 return (NULL);
120 memset (alloc_buffer, 0, alloc_buffer_size);
122 /* Print again into this new buffer. */
123 va_start (ap, format);
124 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
125 va_end (ap);
126 if (status < 0)
127 {
128 sfree (alloc_buffer);
129 return (NULL);
130 }
132 return (alloc_buffer);
133 } /* }}} char *ssnprintf_alloc */
135 char *sstrdup (const char *s)
136 {
137 char *r;
138 size_t sz;
140 if (s == NULL)
141 return (NULL);
143 /* Do not use `strdup' here, because it's not specified in POSIX. It's
144 * ``only'' an XSI extension. */
145 sz = strlen (s) + 1;
146 r = (char *) malloc (sizeof (char) * sz);
147 if (r == NULL)
148 {
149 ERROR ("sstrdup: Out of memory.");
150 exit (3);
151 }
152 memcpy (r, s, sizeof (char) * sz);
154 return (r);
155 } /* char *sstrdup */
157 /* Even though Posix requires "strerror_r" to return an "int",
158 * some systems (e.g. the GNU libc) return a "char *" _and_
159 * ignore the second argument ... -tokkee */
160 char *sstrerror (int errnum, char *buf, size_t buflen)
161 {
162 buf[0] = '\0';
164 #if !HAVE_STRERROR_R
165 {
166 char *temp;
168 pthread_mutex_lock (&strerror_r_lock);
170 temp = strerror (errnum);
171 sstrncpy (buf, temp, buflen);
173 pthread_mutex_unlock (&strerror_r_lock);
174 }
175 /* #endif !HAVE_STRERROR_R */
177 #elif STRERROR_R_CHAR_P
178 {
179 char *temp;
180 temp = strerror_r (errnum, buf, buflen);
181 if (buf[0] == '\0')
182 {
183 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
184 sstrncpy (buf, temp, buflen);
185 else
186 sstrncpy (buf, "strerror_r did not return "
187 "an error message", buflen);
188 }
189 }
190 /* #endif STRERROR_R_CHAR_P */
192 #else
193 if (strerror_r (errnum, buf, buflen) != 0)
194 {
195 ssnprintf (buf, buflen, "Error #%i; "
196 "Additionally, strerror_r failed.",
197 errnum);
198 }
199 #endif /* STRERROR_R_CHAR_P */
201 return (buf);
202 } /* char *sstrerror */
204 void *smalloc (size_t size)
205 {
206 void *r;
208 if ((r = malloc (size)) == NULL)
209 {
210 ERROR ("Not enough memory.");
211 exit (3);
212 }
214 return (r);
215 } /* void *smalloc */
217 #if 0
218 void sfree (void **ptr)
219 {
220 if (ptr == NULL)
221 return;
223 if (*ptr != NULL)
224 free (*ptr);
226 *ptr = NULL;
227 }
228 #endif
230 ssize_t sread (int fd, void *buf, size_t count)
231 {
232 char *ptr;
233 size_t nleft;
234 ssize_t status;
236 ptr = (char *) buf;
237 nleft = count;
239 while (nleft > 0)
240 {
241 status = read (fd, (void *) ptr, nleft);
243 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
244 continue;
246 if (status < 0)
247 return (status);
249 if (status == 0)
250 {
251 DEBUG ("Received EOF from fd %i. "
252 "Closing fd and returning error.",
253 fd);
254 close (fd);
255 return (-1);
256 }
258 assert ((0 > status) || (nleft >= (size_t)status));
260 nleft = nleft - status;
261 ptr = ptr + status;
262 }
264 return (0);
265 }
268 ssize_t swrite (int fd, const void *buf, size_t count)
269 {
270 const char *ptr;
271 size_t nleft;
272 ssize_t status;
274 ptr = (const char *) buf;
275 nleft = count;
277 while (nleft > 0)
278 {
279 status = write (fd, (const void *) ptr, nleft);
281 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
282 continue;
284 if (status < 0)
285 return (status);
287 nleft = nleft - status;
288 ptr = ptr + status;
289 }
291 return (0);
292 }
294 int strsplit (char *string, char **fields, size_t size)
295 {
296 size_t i;
297 char *ptr;
298 char *saveptr;
300 i = 0;
301 ptr = string;
302 saveptr = NULL;
303 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
304 {
305 ptr = NULL;
306 i++;
308 if (i >= size)
309 break;
310 }
312 return ((int) i);
313 }
315 int strjoin (char *buffer, size_t buffer_size,
316 char **fields, size_t fields_num,
317 const char *sep)
318 {
319 size_t avail;
320 char *ptr;
321 size_t sep_len;
322 size_t i;
324 if ((buffer_size < 1) || (fields_num <= 0))
325 return (-1);
327 memset (buffer, 0, buffer_size);
328 ptr = buffer;
329 avail = buffer_size - 1;
331 sep_len = 0;
332 if (sep != NULL)
333 sep_len = strlen (sep);
335 for (i = 0; i < fields_num; i++)
336 {
337 size_t field_len;
339 if ((i > 0) && (sep_len > 0))
340 {
341 if (avail < sep_len)
342 return (-1);
344 memcpy (ptr, sep, sep_len);
345 ptr += sep_len;
346 avail -= sep_len;
347 }
349 field_len = strlen (fields[i]);
350 if (avail < field_len)
351 return (-1);
353 memcpy (ptr, fields[i], field_len);
354 ptr += field_len;
355 avail -= field_len;
356 }
358 assert (buffer[buffer_size - 1] == 0);
359 return (strlen (buffer));
360 }
362 int strsubstitute (char *str, char c_from, char c_to)
363 {
364 int ret;
366 if (str == NULL)
367 return (-1);
369 ret = 0;
370 while (*str != '\0')
371 {
372 if (*str == c_from)
373 {
374 *str = c_to;
375 ret++;
376 }
377 str++;
378 }
380 return (ret);
381 } /* int strsubstitute */
383 int escape_string (char *buffer, size_t buffer_size)
384 {
385 char *temp;
386 size_t i;
387 size_t j;
389 /* Check if we need to escape at all first */
390 temp = strpbrk (buffer, " \t\"\\");
391 if (temp == NULL)
392 return (0);
394 if (buffer_size < 3)
395 return (EINVAL);
397 temp = (char *) malloc (buffer_size);
398 if (temp == NULL)
399 return (ENOMEM);
400 memset (temp, 0, buffer_size);
402 temp[0] = '"';
403 j = 1;
405 for (i = 0; i < buffer_size; i++)
406 {
407 if (buffer[i] == 0)
408 {
409 break;
410 }
411 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
412 {
413 if (j > (buffer_size - 4))
414 break;
415 temp[j] = '\\';
416 temp[j + 1] = buffer[i];
417 j += 2;
418 }
419 else
420 {
421 if (j > (buffer_size - 3))
422 break;
423 temp[j] = buffer[i];
424 j++;
425 }
426 }
428 assert ((j + 1) < buffer_size);
429 temp[j] = '"';
430 temp[j + 1] = 0;
432 sstrncpy (buffer, temp, buffer_size);
433 sfree (temp);
434 return (0);
435 } /* int escape_string */
437 int strunescape (char *buf, size_t buf_len)
438 {
439 size_t i;
441 for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
442 {
443 if (buf[i] != '\\')
444 continue;
446 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
447 ERROR ("string unescape: backslash found at end of string.");
448 /* Ensure null-byte at the end of the buffer. */
449 buf[i] = 0;
450 return (-1);
451 }
453 switch (buf[i + 1]) {
454 case 't':
455 buf[i] = '\t';
456 break;
457 case 'n':
458 buf[i] = '\n';
459 break;
460 case 'r':
461 buf[i] = '\r';
462 break;
463 default:
464 buf[i] = buf[i + 1];
465 break;
466 }
468 /* Move everything after the position one position to the left.
469 * Add a null-byte as last character in the buffer. */
470 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
471 buf[buf_len - 1] = 0;
472 }
473 return (0);
474 } /* int strunescape */
476 size_t strstripnewline (char *buffer)
477 {
478 size_t buffer_len = strlen (buffer);
480 while (buffer_len > 0)
481 {
482 if ((buffer[buffer_len - 1] != '\n')
483 && (buffer[buffer_len - 1] != '\r'))
484 break;
485 buffer_len--;
486 buffer[buffer_len] = 0;
487 }
489 return (buffer_len);
490 } /* size_t strstripnewline */
492 int escape_slashes (char *buffer, size_t buffer_size)
493 {
494 int i;
495 size_t buffer_len;
497 buffer_len = strlen (buffer);
499 if (buffer_len <= 1)
500 {
501 if (strcmp ("/", buffer) == 0)
502 {
503 if (buffer_size < 5)
504 return (-1);
505 sstrncpy (buffer, "root", buffer_size);
506 }
507 return (0);
508 }
510 /* Move one to the left */
511 if (buffer[0] == '/')
512 {
513 memmove (buffer, buffer + 1, buffer_len);
514 buffer_len--;
515 }
517 for (i = 0; i < buffer_len - 1; i++)
518 {
519 if (buffer[i] == '/')
520 buffer[i] = '_';
521 }
523 return (0);
524 } /* int escape_slashes */
526 void replace_special (char *buffer, size_t buffer_size)
527 {
528 size_t i;
530 for (i = 0; i < buffer_size; i++)
531 {
532 if (buffer[i] == 0)
533 return;
534 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
535 buffer[i] = '_';
536 }
537 } /* void replace_special */
539 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
540 {
541 struct timeval *larger;
542 struct timeval *smaller;
544 int status;
546 NORMALIZE_TIMEVAL (tv0);
547 NORMALIZE_TIMEVAL (tv1);
549 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
550 {
551 if (delta != NULL) {
552 delta->tv_sec = 0;
553 delta->tv_usec = 0;
554 }
555 return (0);
556 }
558 if ((tv0.tv_sec < tv1.tv_sec)
559 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
560 {
561 larger = &tv1;
562 smaller = &tv0;
563 status = -1;
564 }
565 else
566 {
567 larger = &tv0;
568 smaller = &tv1;
569 status = 1;
570 }
572 if (delta != NULL) {
573 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
575 if (smaller->tv_usec <= larger->tv_usec)
576 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
577 else
578 {
579 --delta->tv_sec;
580 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
581 }
582 }
584 assert ((delta == NULL)
585 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
587 return (status);
588 } /* int timeval_cmp */
590 int check_create_dir (const char *file_orig)
591 {
592 struct stat statbuf;
594 char file_copy[512];
595 char dir[512];
596 int dir_len = 512;
597 char *fields[16];
598 int fields_num;
599 char *ptr;
600 char *saveptr;
601 int last_is_file = 1;
602 int path_is_absolute = 0;
603 size_t len;
604 int i;
606 /*
607 * Sanity checks first
608 */
609 if (file_orig == NULL)
610 return (-1);
612 if ((len = strlen (file_orig)) < 1)
613 return (-1);
614 else if (len >= sizeof (file_copy))
615 return (-1);
617 /*
618 * If `file_orig' ends in a slash the last component is a directory,
619 * otherwise it's a file. Act accordingly..
620 */
621 if (file_orig[len - 1] == '/')
622 last_is_file = 0;
623 if (file_orig[0] == '/')
624 path_is_absolute = 1;
626 /*
627 * Create a copy for `strtok_r' to destroy
628 */
629 sstrncpy (file_copy, file_orig, sizeof (file_copy));
631 /*
632 * Break into components. This will eat up several slashes in a row and
633 * remove leading and trailing slashes..
634 */
635 ptr = file_copy;
636 saveptr = NULL;
637 fields_num = 0;
638 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
639 {
640 ptr = NULL;
641 fields_num++;
643 if (fields_num >= 16)
644 break;
645 }
647 /*
648 * For each component, do..
649 */
650 for (i = 0; i < (fields_num - last_is_file); i++)
651 {
652 /*
653 * Do not create directories that start with a dot. This
654 * prevents `../../' attacks and other likely malicious
655 * behavior.
656 */
657 if (fields[i][0] == '.')
658 {
659 ERROR ("Cowardly refusing to create a directory that "
660 "begins with a `.' (dot): `%s'", file_orig);
661 return (-2);
662 }
664 /*
665 * Join the components together again
666 */
667 dir[0] = '/';
668 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
669 fields, i + 1, "/") < 0)
670 {
671 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
672 return (-1);
673 }
675 while (42) {
676 if ((stat (dir, &statbuf) == -1)
677 && (lstat (dir, &statbuf) == -1))
678 {
679 if (errno == ENOENT)
680 {
681 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
682 break;
684 /* this might happen, if a different thread created
685 * the directory in the meantime
686 * => call stat() again to check for S_ISDIR() */
687 if (EEXIST == errno)
688 continue;
690 char errbuf[1024];
691 ERROR ("check_create_dir: mkdir (%s): %s", dir,
692 sstrerror (errno,
693 errbuf, sizeof (errbuf)));
694 return (-1);
695 }
696 else
697 {
698 char errbuf[1024];
699 ERROR ("check_create_dir: stat (%s): %s", dir,
700 sstrerror (errno, errbuf,
701 sizeof (errbuf)));
702 return (-1);
703 }
704 }
705 else if (!S_ISDIR (statbuf.st_mode))
706 {
707 ERROR ("check_create_dir: `%s' exists but is not "
708 "a directory!", dir);
709 return (-1);
710 }
711 break;
712 }
713 }
715 return (0);
716 } /* check_create_dir */
718 #ifdef HAVE_LIBKSTAT
719 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
720 {
721 char ident[128];
723 *ksp_ptr = NULL;
725 if (kc == NULL)
726 return (-1);
728 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
730 *ksp_ptr = kstat_lookup (kc, module, instance, name);
731 if (*ksp_ptr == NULL)
732 {
733 ERROR ("get_kstat: Cound not find kstat %s", ident);
734 return (-1);
735 }
737 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
738 {
739 ERROR ("get_kstat: kstat %s has wrong type", ident);
740 *ksp_ptr = NULL;
741 return (-1);
742 }
744 #ifdef assert
745 assert (*ksp_ptr != NULL);
746 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
747 #endif
749 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
750 {
751 ERROR ("get_kstat: kstat %s could not be read", ident);
752 return (-1);
753 }
755 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
756 {
757 ERROR ("get_kstat: kstat %s has wrong type", ident);
758 return (-1);
759 }
761 return (0);
762 }
764 long long get_kstat_value (kstat_t *ksp, char *name)
765 {
766 kstat_named_t *kn;
767 long long retval = -1LL;
769 if (ksp == NULL)
770 {
771 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
772 return (-1LL);
773 }
774 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
775 {
776 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
777 "is not KSTAT_TYPE_NAMED (%#x).",
778 name,
779 (unsigned int) ksp->ks_type,
780 (unsigned int) KSTAT_TYPE_NAMED);
781 return (-1LL);
782 }
784 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
785 return (-1LL);
787 if (kn->data_type == KSTAT_DATA_INT32)
788 retval = (long long) kn->value.i32;
789 else if (kn->data_type == KSTAT_DATA_UINT32)
790 retval = (long long) kn->value.ui32;
791 else if (kn->data_type == KSTAT_DATA_INT64)
792 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
793 else if (kn->data_type == KSTAT_DATA_UINT64)
794 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
795 else
796 WARNING ("get_kstat_value: Not a numeric value: %s", name);
798 return (retval);
799 }
800 #endif /* HAVE_LIBKSTAT */
802 #ifndef HAVE_HTONLL
803 unsigned long long ntohll (unsigned long long n)
804 {
805 #if BYTE_ORDER == BIG_ENDIAN
806 return (n);
807 #else
808 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
809 #endif
810 } /* unsigned long long ntohll */
812 unsigned long long htonll (unsigned long long n)
813 {
814 #if BYTE_ORDER == BIG_ENDIAN
815 return (n);
816 #else
817 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
818 #endif
819 } /* unsigned long long htonll */
820 #endif /* HAVE_HTONLL */
822 #if FP_LAYOUT_NEED_NOTHING
823 /* Well, we need nothing.. */
824 /* #endif FP_LAYOUT_NEED_NOTHING */
826 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
827 # if FP_LAYOUT_NEED_ENDIANFLIP
828 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
829 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
830 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
831 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
832 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
833 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
834 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
835 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
836 # else
837 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
838 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
839 # endif
841 double ntohd (double d)
842 {
843 union
844 {
845 uint8_t byte[8];
846 uint64_t integer;
847 double floating;
848 } ret;
850 ret.floating = d;
852 /* NAN in x86 byte order */
853 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
854 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
855 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
856 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
857 {
858 return (NAN);
859 }
860 else
861 {
862 uint64_t tmp;
864 tmp = ret.integer;
865 ret.integer = FP_CONVERT (tmp);
866 return (ret.floating);
867 }
868 } /* double ntohd */
870 double htond (double d)
871 {
872 union
873 {
874 uint8_t byte[8];
875 uint64_t integer;
876 double floating;
877 } ret;
879 if (isnan (d))
880 {
881 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
882 ret.byte[4] = ret.byte[5] = 0x00;
883 ret.byte[6] = 0xf8;
884 ret.byte[7] = 0x7f;
885 return (ret.floating);
886 }
887 else
888 {
889 uint64_t tmp;
891 ret.floating = d;
892 tmp = FP_CONVERT (ret.integer);
893 ret.integer = tmp;
894 return (ret.floating);
895 }
896 } /* double htond */
897 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
899 int format_name (char *ret, int ret_len,
900 const char *hostname,
901 const char *plugin, const char *plugin_instance,
902 const char *type, const char *type_instance)
903 {
904 char *buffer;
905 size_t buffer_size;
907 buffer = ret;
908 buffer_size = (size_t) ret_len;
910 #define APPEND(str) do { \
911 size_t l = strlen (str); \
912 if (l >= buffer_size) \
913 return (ENOBUFS); \
914 memcpy (buffer, (str), l); \
915 buffer += l; buffer_size -= l; \
916 } while (0)
918 assert (plugin != NULL);
919 assert (type != NULL);
921 APPEND (hostname);
922 APPEND ("/");
923 APPEND (plugin);
924 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
925 {
926 APPEND ("-");
927 APPEND (plugin_instance);
928 }
929 APPEND ("/");
930 APPEND (type);
931 if ((type_instance != NULL) && (type_instance[0] != 0))
932 {
933 APPEND ("-");
934 APPEND (type_instance);
935 }
936 assert (buffer_size > 0);
937 buffer[0] = 0;
939 #undef APPEND
940 return (0);
941 } /* int format_name */
943 int format_values (char *ret, size_t ret_len, /* {{{ */
944 const data_set_t *ds, const value_list_t *vl,
945 _Bool store_rates)
946 {
947 size_t offset = 0;
948 int status;
949 int i;
950 gauge_t *rates = NULL;
952 assert (0 == strcmp (ds->type, vl->type));
954 memset (ret, 0, ret_len);
956 #define BUFFER_ADD(...) do { \
957 status = ssnprintf (ret + offset, ret_len - offset, \
958 __VA_ARGS__); \
959 if (status < 1) \
960 { \
961 sfree (rates); \
962 return (-1); \
963 } \
964 else if (((size_t) status) >= (ret_len - offset)) \
965 { \
966 sfree (rates); \
967 return (-1); \
968 } \
969 else \
970 offset += ((size_t) status); \
971 } while (0)
973 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
975 for (i = 0; i < ds->ds_num; i++)
976 {
977 if (ds->ds[i].type == DS_TYPE_GAUGE)
978 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
979 else if (store_rates)
980 {
981 if (rates == NULL)
982 rates = uc_get_rate (ds, vl);
983 if (rates == NULL)
984 {
985 WARNING ("format_values: uc_get_rate failed.");
986 return (-1);
987 }
988 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
989 }
990 else if (ds->ds[i].type == DS_TYPE_COUNTER)
991 BUFFER_ADD (":%llu", vl->values[i].counter);
992 else if (ds->ds[i].type == DS_TYPE_DERIVE)
993 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
994 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
995 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
996 else
997 {
998 ERROR ("format_values: Unknown data source type: %i",
999 ds->ds[i].type);
1000 sfree (rates);
1001 return (-1);
1002 }
1003 } /* for ds->ds_num */
1005 #undef BUFFER_ADD
1007 sfree (rates);
1008 return (0);
1009 } /* }}} int format_values */
1011 int parse_identifier (char *str, char **ret_host,
1012 char **ret_plugin, char **ret_plugin_instance,
1013 char **ret_type, char **ret_type_instance)
1014 {
1015 char *hostname = NULL;
1016 char *plugin = NULL;
1017 char *plugin_instance = NULL;
1018 char *type = NULL;
1019 char *type_instance = NULL;
1021 hostname = str;
1022 if (hostname == NULL)
1023 return (-1);
1025 plugin = strchr (hostname, '/');
1026 if (plugin == NULL)
1027 return (-1);
1028 *plugin = '\0'; plugin++;
1030 type = strchr (plugin, '/');
1031 if (type == NULL)
1032 return (-1);
1033 *type = '\0'; type++;
1035 plugin_instance = strchr (plugin, '-');
1036 if (plugin_instance != NULL)
1037 {
1038 *plugin_instance = '\0';
1039 plugin_instance++;
1040 }
1042 type_instance = strchr (type, '-');
1043 if (type_instance != NULL)
1044 {
1045 *type_instance = '\0';
1046 type_instance++;
1047 }
1049 *ret_host = hostname;
1050 *ret_plugin = plugin;
1051 *ret_plugin_instance = plugin_instance;
1052 *ret_type = type;
1053 *ret_type_instance = type_instance;
1054 return (0);
1055 } /* int parse_identifier */
1057 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1058 {
1059 char str_copy[6 * DATA_MAX_NAME_LEN];
1060 char *host = NULL;
1061 char *plugin = NULL;
1062 char *plugin_instance = NULL;
1063 char *type = NULL;
1064 char *type_instance = NULL;
1065 int status;
1067 if ((str == NULL) || (vl == NULL))
1068 return (EINVAL);
1070 sstrncpy (str_copy, str, sizeof (str_copy));
1072 status = parse_identifier (str_copy, &host,
1073 &plugin, &plugin_instance,
1074 &type, &type_instance);
1075 if (status != 0)
1076 return (status);
1078 sstrncpy (vl->host, host, sizeof (vl->host));
1079 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1080 sstrncpy (vl->plugin_instance,
1081 (plugin_instance != NULL) ? plugin_instance : "",
1082 sizeof (vl->plugin_instance));
1083 sstrncpy (vl->type, type, sizeof (vl->type));
1084 sstrncpy (vl->type_instance,
1085 (type_instance != NULL) ? type_instance : "",
1086 sizeof (vl->type_instance));
1088 return (0);
1089 } /* }}} int parse_identifier_vl */
1091 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1092 {
1093 char *value;
1094 char *endptr = NULL;
1095 size_t value_len;
1097 if (value_orig == NULL)
1098 return (EINVAL);
1100 value = strdup (value_orig);
1101 if (value == NULL)
1102 return (ENOMEM);
1103 value_len = strlen (value);
1105 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1106 {
1107 value[value_len - 1] = 0;
1108 value_len--;
1109 }
1111 switch (ds_type)
1112 {
1113 case DS_TYPE_COUNTER:
1114 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1115 break;
1117 case DS_TYPE_GAUGE:
1118 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1119 break;
1121 case DS_TYPE_DERIVE:
1122 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1123 break;
1125 case DS_TYPE_ABSOLUTE:
1126 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1127 break;
1129 default:
1130 sfree (value);
1131 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1132 return -1;
1133 }
1135 if (value == endptr) {
1136 ERROR ("parse_value: Failed to parse string as %s: %s.",
1137 DS_TYPE_TO_STRING (ds_type), value);
1138 sfree (value);
1139 return -1;
1140 }
1141 else if ((NULL != endptr) && ('\0' != *endptr))
1142 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1143 "Input string was \"%s\".",
1144 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1146 sfree (value);
1147 return 0;
1148 } /* int parse_value */
1150 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1151 {
1152 size_t i;
1153 char *dummy;
1154 char *ptr;
1155 char *saveptr;
1157 i = 0;
1158 dummy = buffer;
1159 saveptr = NULL;
1160 vl->time = 0;
1161 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1162 {
1163 dummy = NULL;
1165 if (i >= vl->values_len)
1166 {
1167 /* Make sure i is invalid. */
1168 i = 0;
1169 break;
1170 }
1172 if (vl->time == 0)
1173 {
1174 if (strcmp ("N", ptr) == 0)
1175 vl->time = cdtime ();
1176 else
1177 {
1178 char *endptr = NULL;
1179 double tmp;
1181 errno = 0;
1182 tmp = strtod (ptr, &endptr);
1183 if ((errno != 0) /* Overflow */
1184 || (endptr == ptr) /* Invalid string */
1185 || (endptr == NULL) /* This should not happen */
1186 || (*endptr != 0)) /* Trailing chars */
1187 return (-1);
1189 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1190 }
1192 continue;
1193 }
1195 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1196 vl->values[i].gauge = NAN;
1197 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1198 return -1;
1200 i++;
1201 } /* while (strtok_r) */
1203 if ((ptr != NULL) || (i == 0))
1204 return (-1);
1205 return (0);
1206 } /* int parse_values */
1208 #if !HAVE_GETPWNAM_R
1209 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1210 size_t buflen, struct passwd **pwbufp)
1211 {
1212 int status = 0;
1213 struct passwd *pw;
1215 memset (pwbuf, '\0', sizeof (struct passwd));
1217 pthread_mutex_lock (&getpwnam_r_lock);
1219 do
1220 {
1221 pw = getpwnam (name);
1222 if (pw == NULL)
1223 {
1224 status = (errno != 0) ? errno : ENOENT;
1225 break;
1226 }
1228 #define GETPWNAM_COPY_MEMBER(member) \
1229 if (pw->member != NULL) \
1230 { \
1231 int len = strlen (pw->member); \
1232 if (len >= buflen) \
1233 { \
1234 status = ENOMEM; \
1235 break; \
1236 } \
1237 sstrncpy (buf, pw->member, buflen); \
1238 pwbuf->member = buf; \
1239 buf += (len + 1); \
1240 buflen -= (len + 1); \
1241 }
1242 GETPWNAM_COPY_MEMBER(pw_name);
1243 GETPWNAM_COPY_MEMBER(pw_passwd);
1244 GETPWNAM_COPY_MEMBER(pw_gecos);
1245 GETPWNAM_COPY_MEMBER(pw_dir);
1246 GETPWNAM_COPY_MEMBER(pw_shell);
1248 pwbuf->pw_uid = pw->pw_uid;
1249 pwbuf->pw_gid = pw->pw_gid;
1251 if (pwbufp != NULL)
1252 *pwbufp = pwbuf;
1253 } while (0);
1255 pthread_mutex_unlock (&getpwnam_r_lock);
1257 return (status);
1258 } /* int getpwnam_r */
1259 #endif /* !HAVE_GETPWNAM_R */
1261 int notification_init (notification_t *n, int severity, const char *message,
1262 const char *host,
1263 const char *plugin, const char *plugin_instance,
1264 const char *type, const char *type_instance)
1265 {
1266 memset (n, '\0', sizeof (notification_t));
1268 n->severity = severity;
1270 if (message != NULL)
1271 sstrncpy (n->message, message, sizeof (n->message));
1272 if (host != NULL)
1273 sstrncpy (n->host, host, sizeof (n->host));
1274 if (plugin != NULL)
1275 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1276 if (plugin_instance != NULL)
1277 sstrncpy (n->plugin_instance, plugin_instance,
1278 sizeof (n->plugin_instance));
1279 if (type != NULL)
1280 sstrncpy (n->type, type, sizeof (n->type));
1281 if (type_instance != NULL)
1282 sstrncpy (n->type_instance, type_instance,
1283 sizeof (n->type_instance));
1285 return (0);
1286 } /* int notification_init */
1288 int walk_directory (const char *dir, dirwalk_callback_f callback,
1289 void *user_data, int include_hidden)
1290 {
1291 struct dirent *ent;
1292 DIR *dh;
1293 int success;
1294 int failure;
1296 success = 0;
1297 failure = 0;
1299 if ((dh = opendir (dir)) == NULL)
1300 {
1301 char errbuf[1024];
1302 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1303 sstrerror (errno, errbuf, sizeof (errbuf)));
1304 return -1;
1305 }
1307 while ((ent = readdir (dh)) != NULL)
1308 {
1309 int status;
1311 if (include_hidden)
1312 {
1313 if ((strcmp (".", ent->d_name) == 0)
1314 || (strcmp ("..", ent->d_name) == 0))
1315 continue;
1316 }
1317 else /* if (!include_hidden) */
1318 {
1319 if (ent->d_name[0]=='.')
1320 continue;
1321 }
1323 status = (*callback) (dir, ent->d_name, user_data);
1324 if (status != 0)
1325 failure++;
1326 else
1327 success++;
1328 }
1330 closedir (dh);
1332 if ((success == 0) && (failure > 0))
1333 return (-1);
1334 return (0);
1335 }
1337 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1338 {
1339 FILE *fh;
1340 ssize_t ret;
1342 fh = fopen (filename, "r");
1343 if (fh == NULL)
1344 return (-1);
1346 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1347 if ((ret == 0) && (ferror (fh) != 0))
1348 {
1349 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1350 filename);
1351 ret = -1;
1352 }
1354 fclose(fh);
1355 return (ret);
1356 }
1358 counter_t counter_diff (counter_t old_value, counter_t new_value)
1359 {
1360 counter_t diff;
1362 if (old_value > new_value)
1363 {
1364 if (old_value <= 4294967295U)
1365 diff = (4294967295U - old_value) + new_value;
1366 else
1367 diff = (18446744073709551615ULL - old_value)
1368 + new_value;
1369 }
1370 else
1371 {
1372 diff = new_value - old_value;
1373 }
1375 return (diff);
1376 } /* counter_t counter_diff */
1378 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1379 rate_to_value_state_t *state,
1380 int ds_type, cdtime_t t)
1381 {
1382 gauge_t delta_gauge;
1383 cdtime_t delta_t;
1385 if (ds_type == DS_TYPE_GAUGE)
1386 {
1387 state->last_value.gauge = rate;
1388 state->last_time = t;
1390 *ret_value = state->last_value;
1391 return (0);
1392 }
1394 /* Counter and absolute can't handle negative rates. Reset "last time"
1395 * to zero, so that the next valid rate will re-initialize the
1396 * structure. */
1397 if ((rate < 0.0)
1398 && ((ds_type == DS_TYPE_COUNTER)
1399 || (ds_type == DS_TYPE_ABSOLUTE)))
1400 {
1401 memset (state, 0, sizeof (*state));
1402 return (EINVAL);
1403 }
1405 /* Another invalid state: The time is not increasing. */
1406 if (t <= state->last_time)
1407 {
1408 memset (state, 0, sizeof (*state));
1409 return (EINVAL);
1410 }
1412 delta_t = t - state->last_time;
1413 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1415 /* Previous value is invalid. */
1416 if (state->last_time == 0) /* {{{ */
1417 {
1418 if (ds_type == DS_TYPE_DERIVE)
1419 {
1420 state->last_value.derive = (derive_t) rate;
1421 state->residual = rate - ((gauge_t) state->last_value.derive);
1422 }
1423 else if (ds_type == DS_TYPE_COUNTER)
1424 {
1425 state->last_value.counter = (counter_t) rate;
1426 state->residual = rate - ((gauge_t) state->last_value.counter);
1427 }
1428 else if (ds_type == DS_TYPE_ABSOLUTE)
1429 {
1430 state->last_value.absolute = (absolute_t) rate;
1431 state->residual = rate - ((gauge_t) state->last_value.absolute);
1432 }
1433 else
1434 {
1435 assert (23 == 42);
1436 }
1438 state->last_time = t;
1439 return (EAGAIN);
1440 } /* }}} */
1442 if (ds_type == DS_TYPE_DERIVE)
1443 {
1444 derive_t delta_derive = (derive_t) delta_gauge;
1446 state->last_value.derive += delta_derive;
1447 state->residual = delta_gauge - ((gauge_t) delta_derive);
1448 }
1449 else if (ds_type == DS_TYPE_COUNTER)
1450 {
1451 counter_t delta_counter = (counter_t) delta_gauge;
1453 state->last_value.counter += delta_counter;
1454 state->residual = delta_gauge - ((gauge_t) delta_counter);
1455 }
1456 else if (ds_type == DS_TYPE_ABSOLUTE)
1457 {
1458 absolute_t delta_absolute = (absolute_t) delta_gauge;
1460 state->last_value.absolute = delta_absolute;
1461 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1462 }
1463 else
1464 {
1465 assert (23 == 42);
1466 }
1468 state->last_time = t;
1469 *ret_value = state->last_value;
1470 return (0);
1471 } /* }}} value_t rate_to_value */
1473 int value_to_rate (value_t *ret_rate, derive_t value, /* {{{ */
1474 value_to_rate_state_t *state,
1475 int ds_type, cdtime_t t)
1476 {
1477 double interval;
1479 /* Another invalid state: The time is not increasing. */
1480 if (t <= state->last_time)
1481 {
1482 memset (state, 0, sizeof (*state));
1483 return (EINVAL);
1484 }
1486 interval = CDTIME_T_TO_DOUBLE(t - state->last_time);
1488 /* Previous value is invalid. */
1489 if (state->last_time == 0) /* {{{ */
1490 {
1491 if (ds_type == DS_TYPE_DERIVE)
1492 {
1493 state->last_value.derive = value;
1494 }
1495 else if (ds_type == DS_TYPE_COUNTER)
1496 {
1497 state->last_value.counter = (counter_t) value;
1498 }
1499 else if (ds_type == DS_TYPE_ABSOLUTE)
1500 {
1501 state->last_value.absolute = (absolute_t) value;
1502 }
1503 else
1504 {
1505 assert (23 == 42);
1506 }
1508 state->last_time = t;
1509 return (EAGAIN);
1510 } /* }}} */
1512 if (ds_type == DS_TYPE_DERIVE)
1513 {
1514 ret_rate->gauge = (value - state->last_value.derive) / interval;
1515 state->last_value.derive = value;
1516 }
1517 else if (ds_type == DS_TYPE_COUNTER)
1518 {
1519 ret_rate->gauge = (((counter_t)value) - state->last_value.counter) / interval;
1520 state->last_value.counter = (counter_t) value;
1521 }
1522 else if (ds_type == DS_TYPE_ABSOLUTE)
1523 {
1524 ret_rate->gauge = (((absolute_t)value) - state->last_value.absolute) / interval;
1525 state->last_value.absolute = (absolute_t) value;
1526 }
1527 else
1528 {
1529 assert (23 == 42);
1530 }
1532 state->last_time = t;
1533 return (0);
1534 } /* }}} value_t rate_to_value */
1536 int service_name_to_port_number (const char *service_name)
1537 {
1538 struct addrinfo *ai_list;
1539 struct addrinfo *ai_ptr;
1540 struct addrinfo ai_hints;
1541 int status;
1542 int service_number;
1544 if (service_name == NULL)
1545 return (-1);
1547 ai_list = NULL;
1548 memset (&ai_hints, 0, sizeof (ai_hints));
1549 ai_hints.ai_family = AF_UNSPEC;
1551 status = getaddrinfo (/* node = */ NULL, service_name,
1552 &ai_hints, &ai_list);
1553 if (status != 0)
1554 {
1555 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1556 gai_strerror (status));
1557 return (-1);
1558 }
1560 service_number = -1;
1561 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1562 {
1563 if (ai_ptr->ai_family == AF_INET)
1564 {
1565 struct sockaddr_in *sa;
1567 sa = (void *) ai_ptr->ai_addr;
1568 service_number = (int) ntohs (sa->sin_port);
1569 }
1570 else if (ai_ptr->ai_family == AF_INET6)
1571 {
1572 struct sockaddr_in6 *sa;
1574 sa = (void *) ai_ptr->ai_addr;
1575 service_number = (int) ntohs (sa->sin6_port);
1576 }
1578 if ((service_number > 0) && (service_number <= 65535))
1579 break;
1580 }
1582 freeaddrinfo (ai_list);
1584 if ((service_number > 0) && (service_number <= 65535))
1585 return (service_number);
1586 return (-1);
1587 } /* int service_name_to_port_number */
1589 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1590 {
1591 derive_t tmp;
1592 char *endptr;
1594 if ((string == NULL) || (ret_value == NULL))
1595 return (EINVAL);
1597 errno = 0;
1598 endptr = NULL;
1599 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1600 if ((endptr == string) || (errno != 0))
1601 return (-1);
1603 *ret_value = tmp;
1604 return (0);
1605 } /* }}} int strtoderive */
1607 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1608 {
1609 gauge_t tmp;
1610 char *endptr = NULL;
1612 if ((string == NULL) || (ret_value == NULL))
1613 return (EINVAL);
1615 errno = 0;
1616 endptr = NULL;
1617 tmp = (gauge_t) strtod (string, &endptr);
1618 if (errno != 0)
1619 return (errno);
1620 else if ((endptr == NULL) || (*endptr != 0))
1621 return (EINVAL);
1623 *ret_value = tmp;
1624 return (0);
1625 } /* }}} int strtogauge */
1627 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1628 {
1629 char **array;
1630 size_t array_len = *ret_array_len;
1632 if (str == NULL)
1633 return (EINVAL);
1635 array = realloc (*ret_array,
1636 (array_len + 1) * sizeof (*array));
1637 if (array == NULL)
1638 return (ENOMEM);
1639 *ret_array = array;
1641 array[array_len] = strdup (str);
1642 if (array[array_len] == NULL)
1643 return (ENOMEM);
1645 array_len++;
1646 *ret_array_len = array_len;
1647 return (0);
1648 } /* }}} int strarray_add */
1650 void strarray_free (char **array, size_t array_len) /* {{{ */
1651 {
1652 size_t i;
1654 for (i = 0; i < array_len; i++)
1655 sfree (array[i]);
1656 sfree (array);
1657 } /* }}} void strarray_free */