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