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 #include <poll.h>
53 #if HAVE_NETINET_IN_H
54 # include <netinet/in.h>
55 #endif
57 /* for ntohl and htonl */
58 #if HAVE_ARPA_INET_H
59 # include <arpa/inet.h>
60 #endif
62 #ifdef HAVE_LIBKSTAT
63 extern kstat_ctl_t *kc;
64 #endif
66 #if !HAVE_GETPWNAM_R
67 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
68 #endif
70 #if !HAVE_STRERROR_R
71 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
72 #endif
74 char *sstrncpy (char *dest, const char *src, size_t n)
75 {
76 strncpy (dest, src, n);
77 dest[n - 1] = '\0';
79 return (dest);
80 } /* char *sstrncpy */
82 int ssnprintf (char *dest, size_t n, const char *format, ...)
83 {
84 int ret = 0;
85 va_list ap;
87 va_start (ap, format);
88 ret = vsnprintf (dest, n, format, ap);
89 dest[n - 1] = '\0';
90 va_end (ap);
92 return (ret);
93 } /* int ssnprintf */
95 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
96 {
97 char static_buffer[1024] = "";
98 char *alloc_buffer;
99 size_t alloc_buffer_size;
100 int status;
101 va_list ap;
103 /* Try printing into the static buffer. In many cases it will be
104 * sufficiently large and we can simply return a strdup() of this
105 * buffer. */
106 va_start (ap, format);
107 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
108 va_end (ap);
109 if (status < 0)
110 return (NULL);
112 /* "status" does not include the null byte. */
113 alloc_buffer_size = (size_t) (status + 1);
114 if (alloc_buffer_size <= sizeof (static_buffer))
115 return (strdup (static_buffer));
117 /* Allocate a buffer large enough to hold the string. */
118 alloc_buffer = calloc (1, alloc_buffer_size);
119 if (alloc_buffer == NULL)
120 return (NULL);
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 = malloc (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 - ((size_t) status);
261 ptr = ptr + ((size_t) 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;
273 struct pollfd pfd;
275 ptr = (const char *) buf;
276 nleft = count;
278 /* checking for closed peer connection */
279 pfd.fd = fd;
280 pfd.events = POLLIN | POLLHUP;
281 pfd.revents = 0;
282 if (poll(&pfd, 1, 0) > 0) {
283 char buffer[32];
284 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
285 // if recv returns zero (even though poll() said there is data to be read),
286 // that means the connection has been closed
287 return -1;
288 }
289 }
291 while (nleft > 0)
292 {
293 status = write (fd, (const void *) ptr, nleft);
295 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
296 continue;
298 if (status < 0)
299 return (status);
301 nleft = nleft - ((size_t) status);
302 ptr = ptr + ((size_t) status);
303 }
305 return (0);
306 }
308 int strsplit (char *string, char **fields, size_t size)
309 {
310 size_t i;
311 char *ptr;
312 char *saveptr;
314 i = 0;
315 ptr = string;
316 saveptr = NULL;
317 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
318 {
319 ptr = NULL;
320 i++;
322 if (i >= size)
323 break;
324 }
326 return ((int) i);
327 }
329 int strjoin (char *buffer, size_t buffer_size,
330 char **fields, size_t fields_num,
331 const char *sep)
332 {
333 size_t avail;
334 char *ptr;
335 size_t sep_len;
336 size_t i;
338 if ((buffer_size < 1) || (fields_num <= 0))
339 return (-1);
341 memset (buffer, 0, buffer_size);
342 ptr = buffer;
343 avail = buffer_size - 1;
345 sep_len = 0;
346 if (sep != NULL)
347 sep_len = strlen (sep);
349 for (i = 0; i < fields_num; i++)
350 {
351 size_t field_len;
353 if ((i > 0) && (sep_len > 0))
354 {
355 if (avail < sep_len)
356 return (-1);
358 memcpy (ptr, sep, sep_len);
359 ptr += sep_len;
360 avail -= sep_len;
361 }
363 field_len = strlen (fields[i]);
364 if (avail < field_len)
365 return (-1);
367 memcpy (ptr, fields[i], field_len);
368 ptr += field_len;
369 avail -= field_len;
370 }
372 assert (buffer[buffer_size - 1] == 0);
373 return ((int) strlen (buffer));
374 }
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 = calloc (1, buffer_size);
391 if (temp == NULL)
392 return (ENOMEM);
394 temp[0] = '"';
395 j = 1;
397 for (i = 0; i < buffer_size; i++)
398 {
399 if (buffer[i] == 0)
400 {
401 break;
402 }
403 else if ((buffer[i] == '"') || (buffer[i] == '\\'))
404 {
405 if (j > (buffer_size - 4))
406 break;
407 temp[j] = '\\';
408 temp[j + 1] = buffer[i];
409 j += 2;
410 }
411 else
412 {
413 if (j > (buffer_size - 3))
414 break;
415 temp[j] = buffer[i];
416 j++;
417 }
418 }
420 assert ((j + 1) < buffer_size);
421 temp[j] = '"';
422 temp[j + 1] = 0;
424 sstrncpy (buffer, temp, buffer_size);
425 sfree (temp);
426 return (0);
427 } /* int escape_string */
429 int strunescape (char *buf, size_t buf_len)
430 {
431 size_t i;
433 for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
434 {
435 if (buf[i] != '\\')
436 continue;
438 if (((i + 1) >= buf_len) || (buf[i + 1] == 0)) {
439 ERROR ("string unescape: backslash found at end of string.");
440 /* Ensure null-byte at the end of the buffer. */
441 buf[i] = 0;
442 return (-1);
443 }
445 switch (buf[i + 1]) {
446 case 't':
447 buf[i] = '\t';
448 break;
449 case 'n':
450 buf[i] = '\n';
451 break;
452 case 'r':
453 buf[i] = '\r';
454 break;
455 default:
456 buf[i] = buf[i + 1];
457 break;
458 }
460 /* Move everything after the position one position to the left.
461 * Add a null-byte as last character in the buffer. */
462 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
463 buf[buf_len - 1] = 0;
464 }
465 return (0);
466 } /* int strunescape */
468 size_t strstripnewline (char *buffer)
469 {
470 size_t buffer_len = strlen (buffer);
472 while (buffer_len > 0)
473 {
474 if ((buffer[buffer_len - 1] != '\n')
475 && (buffer[buffer_len - 1] != '\r'))
476 break;
477 buffer_len--;
478 buffer[buffer_len] = 0;
479 }
481 return (buffer_len);
482 } /* size_t strstripnewline */
484 int escape_slashes (char *buffer, size_t buffer_size)
485 {
486 size_t buffer_len;
487 size_t i;
489 buffer_len = strlen (buffer);
491 if (buffer_len <= 1)
492 {
493 if (strcmp ("/", buffer) == 0)
494 {
495 if (buffer_size < 5)
496 return (-1);
497 sstrncpy (buffer, "root", buffer_size);
498 }
499 return (0);
500 }
502 /* Move one to the left */
503 if (buffer[0] == '/')
504 {
505 memmove (buffer, buffer + 1, buffer_len);
506 buffer_len--;
507 }
509 for (i = 0; i < buffer_len; i++)
510 {
511 if (buffer[i] == '/')
512 buffer[i] = '_';
513 }
515 return (0);
516 } /* int escape_slashes */
518 void replace_special (char *buffer, size_t buffer_size)
519 {
520 size_t i;
522 for (i = 0; i < buffer_size; i++)
523 {
524 if (buffer[i] == 0)
525 return;
526 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
527 buffer[i] = '_';
528 }
529 } /* void replace_special */
531 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
532 {
533 struct timeval *larger;
534 struct timeval *smaller;
536 int status;
538 NORMALIZE_TIMEVAL (tv0);
539 NORMALIZE_TIMEVAL (tv1);
541 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
542 {
543 if (delta != NULL) {
544 delta->tv_sec = 0;
545 delta->tv_usec = 0;
546 }
547 return (0);
548 }
550 if ((tv0.tv_sec < tv1.tv_sec)
551 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
552 {
553 larger = &tv1;
554 smaller = &tv0;
555 status = -1;
556 }
557 else
558 {
559 larger = &tv0;
560 smaller = &tv1;
561 status = 1;
562 }
564 if (delta != NULL) {
565 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
567 if (smaller->tv_usec <= larger->tv_usec)
568 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
569 else
570 {
571 --delta->tv_sec;
572 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
573 }
574 }
576 assert ((delta == NULL)
577 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
579 return (status);
580 } /* int timeval_cmp */
582 int check_create_dir (const char *file_orig)
583 {
584 struct stat statbuf;
586 char file_copy[512];
587 char dir[512];
588 int dir_len = 512;
589 char *fields[16];
590 int fields_num;
591 char *ptr;
592 char *saveptr;
593 int last_is_file = 1;
594 int path_is_absolute = 0;
595 size_t len;
596 int i;
598 /*
599 * Sanity checks first
600 */
601 if (file_orig == NULL)
602 return (-1);
604 if ((len = strlen (file_orig)) < 1)
605 return (-1);
606 else if (len >= sizeof (file_copy))
607 return (-1);
609 /*
610 * If `file_orig' ends in a slash the last component is a directory,
611 * otherwise it's a file. Act accordingly..
612 */
613 if (file_orig[len - 1] == '/')
614 last_is_file = 0;
615 if (file_orig[0] == '/')
616 path_is_absolute = 1;
618 /*
619 * Create a copy for `strtok_r' to destroy
620 */
621 sstrncpy (file_copy, file_orig, sizeof (file_copy));
623 /*
624 * Break into components. This will eat up several slashes in a row and
625 * remove leading and trailing slashes..
626 */
627 ptr = file_copy;
628 saveptr = NULL;
629 fields_num = 0;
630 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
631 {
632 ptr = NULL;
633 fields_num++;
635 if (fields_num >= 16)
636 break;
637 }
639 /*
640 * For each component, do..
641 */
642 for (i = 0; i < (fields_num - last_is_file); i++)
643 {
644 /*
645 * Do not create directories that start with a dot. This
646 * prevents `../../' attacks and other likely malicious
647 * behavior.
648 */
649 if (fields[i][0] == '.')
650 {
651 ERROR ("Cowardly refusing to create a directory that "
652 "begins with a `.' (dot): `%s'", file_orig);
653 return (-2);
654 }
656 /*
657 * Join the components together again
658 */
659 dir[0] = '/';
660 if (strjoin (dir + path_is_absolute, (size_t) (dir_len - path_is_absolute),
661 fields, (size_t) (i + 1), "/") < 0)
662 {
663 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
664 return (-1);
665 }
667 while (42) {
668 if ((stat (dir, &statbuf) == -1)
669 && (lstat (dir, &statbuf) == -1))
670 {
671 if (errno == ENOENT)
672 {
673 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
674 break;
676 /* this might happen, if a different thread created
677 * the directory in the meantime
678 * => call stat() again to check for S_ISDIR() */
679 if (EEXIST == errno)
680 continue;
682 char errbuf[1024];
683 ERROR ("check_create_dir: mkdir (%s): %s", dir,
684 sstrerror (errno,
685 errbuf, sizeof (errbuf)));
686 return (-1);
687 }
688 else
689 {
690 char errbuf[1024];
691 ERROR ("check_create_dir: stat (%s): %s", dir,
692 sstrerror (errno, errbuf,
693 sizeof (errbuf)));
694 return (-1);
695 }
696 }
697 else if (!S_ISDIR (statbuf.st_mode))
698 {
699 ERROR ("check_create_dir: `%s' exists but is not "
700 "a directory!", dir);
701 return (-1);
702 }
703 break;
704 }
705 }
707 return (0);
708 } /* check_create_dir */
710 #ifdef HAVE_LIBKSTAT
711 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
712 {
713 char ident[128];
715 *ksp_ptr = NULL;
717 if (kc == NULL)
718 return (-1);
720 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
722 *ksp_ptr = kstat_lookup (kc, module, instance, name);
723 if (*ksp_ptr == NULL)
724 {
725 ERROR ("get_kstat: Cound not find kstat %s", ident);
726 return (-1);
727 }
729 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
730 {
731 ERROR ("get_kstat: kstat %s has wrong type", ident);
732 *ksp_ptr = NULL;
733 return (-1);
734 }
736 #ifdef assert
737 assert (*ksp_ptr != NULL);
738 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
739 #endif
741 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
742 {
743 ERROR ("get_kstat: kstat %s could not be read", ident);
744 return (-1);
745 }
747 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
748 {
749 ERROR ("get_kstat: kstat %s has wrong type", ident);
750 return (-1);
751 }
753 return (0);
754 }
756 long long get_kstat_value (kstat_t *ksp, char *name)
757 {
758 kstat_named_t *kn;
759 long long retval = -1LL;
761 if (ksp == NULL)
762 {
763 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
764 return (-1LL);
765 }
766 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
767 {
768 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
769 "is not KSTAT_TYPE_NAMED (%#x).",
770 name,
771 (unsigned int) ksp->ks_type,
772 (unsigned int) KSTAT_TYPE_NAMED);
773 return (-1LL);
774 }
776 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
777 return (-1LL);
779 if (kn->data_type == KSTAT_DATA_INT32)
780 retval = (long long) kn->value.i32;
781 else if (kn->data_type == KSTAT_DATA_UINT32)
782 retval = (long long) kn->value.ui32;
783 else if (kn->data_type == KSTAT_DATA_INT64)
784 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
785 else if (kn->data_type == KSTAT_DATA_UINT64)
786 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
787 else
788 WARNING ("get_kstat_value: Not a numeric value: %s", name);
790 return (retval);
791 }
792 #endif /* HAVE_LIBKSTAT */
794 #ifndef HAVE_HTONLL
795 unsigned long long ntohll (unsigned long long n)
796 {
797 #if BYTE_ORDER == BIG_ENDIAN
798 return (n);
799 #else
800 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
801 #endif
802 } /* unsigned long long ntohll */
804 unsigned long long htonll (unsigned long long n)
805 {
806 #if BYTE_ORDER == BIG_ENDIAN
807 return (n);
808 #else
809 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
810 #endif
811 } /* unsigned long long htonll */
812 #endif /* HAVE_HTONLL */
814 #if FP_LAYOUT_NEED_NOTHING
815 /* Well, we need nothing.. */
816 /* #endif FP_LAYOUT_NEED_NOTHING */
818 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
819 # if FP_LAYOUT_NEED_ENDIANFLIP
820 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
821 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
822 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
823 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
824 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
825 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
826 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
827 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
828 # else
829 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
830 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
831 # endif
833 double ntohd (double d)
834 {
835 union
836 {
837 uint8_t byte[8];
838 uint64_t integer;
839 double floating;
840 } ret;
842 ret.floating = d;
844 /* NAN in x86 byte order */
845 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
846 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
847 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
848 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
849 {
850 return (NAN);
851 }
852 else
853 {
854 uint64_t tmp;
856 tmp = ret.integer;
857 ret.integer = FP_CONVERT (tmp);
858 return (ret.floating);
859 }
860 } /* double ntohd */
862 double htond (double d)
863 {
864 union
865 {
866 uint8_t byte[8];
867 uint64_t integer;
868 double floating;
869 } ret;
871 if (isnan (d))
872 {
873 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
874 ret.byte[4] = ret.byte[5] = 0x00;
875 ret.byte[6] = 0xf8;
876 ret.byte[7] = 0x7f;
877 return (ret.floating);
878 }
879 else
880 {
881 uint64_t tmp;
883 ret.floating = d;
884 tmp = FP_CONVERT (ret.integer);
885 ret.integer = tmp;
886 return (ret.floating);
887 }
888 } /* double htond */
889 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
891 int format_name (char *ret, int ret_len,
892 const char *hostname,
893 const char *plugin, const char *plugin_instance,
894 const char *type, const char *type_instance)
895 {
896 char *buffer;
897 size_t buffer_size;
899 buffer = ret;
900 buffer_size = (size_t) ret_len;
902 #define APPEND(str) do { \
903 size_t l = strlen (str); \
904 if (l >= buffer_size) \
905 return (ENOBUFS); \
906 memcpy (buffer, (str), l); \
907 buffer += l; buffer_size -= l; \
908 } while (0)
910 assert (plugin != NULL);
911 assert (type != NULL);
913 APPEND (hostname);
914 APPEND ("/");
915 APPEND (plugin);
916 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
917 {
918 APPEND ("-");
919 APPEND (plugin_instance);
920 }
921 APPEND ("/");
922 APPEND (type);
923 if ((type_instance != NULL) && (type_instance[0] != 0))
924 {
925 APPEND ("-");
926 APPEND (type_instance);
927 }
928 assert (buffer_size > 0);
929 buffer[0] = 0;
931 #undef APPEND
932 return (0);
933 } /* int format_name */
935 int format_values (char *ret, size_t ret_len, /* {{{ */
936 const data_set_t *ds, const value_list_t *vl,
937 _Bool store_rates)
938 {
939 size_t offset = 0;
940 int status;
941 size_t i;
942 gauge_t *rates = NULL;
944 assert (0 == strcmp (ds->type, vl->type));
946 memset (ret, 0, ret_len);
948 #define BUFFER_ADD(...) do { \
949 status = ssnprintf (ret + offset, ret_len - offset, \
950 __VA_ARGS__); \
951 if (status < 1) \
952 { \
953 sfree (rates); \
954 return (-1); \
955 } \
956 else if (((size_t) status) >= (ret_len - offset)) \
957 { \
958 sfree (rates); \
959 return (-1); \
960 } \
961 else \
962 offset += ((size_t) status); \
963 } while (0)
965 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
967 for (i = 0; i < ds->ds_num; i++)
968 {
969 if (ds->ds[i].type == DS_TYPE_GAUGE)
970 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
971 else if (store_rates)
972 {
973 if (rates == NULL)
974 rates = uc_get_rate (ds, vl);
975 if (rates == NULL)
976 {
977 WARNING ("format_values: uc_get_rate failed.");
978 return (-1);
979 }
980 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
981 }
982 else if (ds->ds[i].type == DS_TYPE_COUNTER)
983 BUFFER_ADD (":%llu", vl->values[i].counter);
984 else if (ds->ds[i].type == DS_TYPE_DERIVE)
985 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
986 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
987 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
988 else
989 {
990 ERROR ("format_values: Unknown data source type: %i",
991 ds->ds[i].type);
992 sfree (rates);
993 return (-1);
994 }
995 } /* for ds->ds_num */
997 #undef BUFFER_ADD
999 sfree (rates);
1000 return (0);
1001 } /* }}} int format_values */
1003 int parse_identifier (char *str, char **ret_host,
1004 char **ret_plugin, char **ret_plugin_instance,
1005 char **ret_type, char **ret_type_instance)
1006 {
1007 char *hostname = NULL;
1008 char *plugin = NULL;
1009 char *plugin_instance = NULL;
1010 char *type = NULL;
1011 char *type_instance = NULL;
1013 hostname = str;
1014 if (hostname == NULL)
1015 return (-1);
1017 plugin = strchr (hostname, '/');
1018 if (plugin == NULL)
1019 return (-1);
1020 *plugin = '\0'; plugin++;
1022 type = strchr (plugin, '/');
1023 if (type == NULL)
1024 return (-1);
1025 *type = '\0'; type++;
1027 plugin_instance = strchr (plugin, '-');
1028 if (plugin_instance != NULL)
1029 {
1030 *plugin_instance = '\0';
1031 plugin_instance++;
1032 }
1034 type_instance = strchr (type, '-');
1035 if (type_instance != NULL)
1036 {
1037 *type_instance = '\0';
1038 type_instance++;
1039 }
1041 *ret_host = hostname;
1042 *ret_plugin = plugin;
1043 *ret_plugin_instance = plugin_instance;
1044 *ret_type = type;
1045 *ret_type_instance = type_instance;
1046 return (0);
1047 } /* int parse_identifier */
1049 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1050 {
1051 char str_copy[6 * DATA_MAX_NAME_LEN];
1052 char *host = NULL;
1053 char *plugin = NULL;
1054 char *plugin_instance = NULL;
1055 char *type = NULL;
1056 char *type_instance = NULL;
1057 int status;
1059 if ((str == NULL) || (vl == NULL))
1060 return (EINVAL);
1062 sstrncpy (str_copy, str, sizeof (str_copy));
1064 status = parse_identifier (str_copy, &host,
1065 &plugin, &plugin_instance,
1066 &type, &type_instance);
1067 if (status != 0)
1068 return (status);
1070 sstrncpy (vl->host, host, sizeof (vl->host));
1071 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1072 sstrncpy (vl->plugin_instance,
1073 (plugin_instance != NULL) ? plugin_instance : "",
1074 sizeof (vl->plugin_instance));
1075 sstrncpy (vl->type, type, sizeof (vl->type));
1076 sstrncpy (vl->type_instance,
1077 (type_instance != NULL) ? type_instance : "",
1078 sizeof (vl->type_instance));
1080 return (0);
1081 } /* }}} int parse_identifier_vl */
1083 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1084 {
1085 char *value;
1086 char *endptr = NULL;
1087 size_t value_len;
1089 if (value_orig == NULL)
1090 return (EINVAL);
1092 value = strdup (value_orig);
1093 if (value == NULL)
1094 return (ENOMEM);
1095 value_len = strlen (value);
1097 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1098 {
1099 value[value_len - 1] = 0;
1100 value_len--;
1101 }
1103 switch (ds_type)
1104 {
1105 case DS_TYPE_COUNTER:
1106 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1107 break;
1109 case DS_TYPE_GAUGE:
1110 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1111 break;
1113 case DS_TYPE_DERIVE:
1114 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1115 break;
1117 case DS_TYPE_ABSOLUTE:
1118 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1119 break;
1121 default:
1122 sfree (value);
1123 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1124 return -1;
1125 }
1127 if (value == endptr) {
1128 ERROR ("parse_value: Failed to parse string as %s: %s.",
1129 DS_TYPE_TO_STRING (ds_type), value);
1130 sfree (value);
1131 return -1;
1132 }
1133 else if ((NULL != endptr) && ('\0' != *endptr))
1134 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1135 "Input string was \"%s\".",
1136 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1138 sfree (value);
1139 return 0;
1140 } /* int parse_value */
1142 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1143 {
1144 size_t i;
1145 char *dummy;
1146 char *ptr;
1147 char *saveptr;
1149 if ((buffer == NULL) || (vl == NULL) || (ds == NULL))
1150 return EINVAL;
1152 i = 0;
1153 dummy = buffer;
1154 saveptr = NULL;
1155 vl->time = 0;
1156 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1157 {
1158 dummy = NULL;
1160 if (i >= vl->values_len)
1161 {
1162 /* Make sure i is invalid. */
1163 i = 0;
1164 break;
1165 }
1167 if (vl->time == 0)
1168 {
1169 if (strcmp ("N", ptr) == 0)
1170 vl->time = cdtime ();
1171 else
1172 {
1173 char *endptr = NULL;
1174 double tmp;
1176 errno = 0;
1177 tmp = strtod (ptr, &endptr);
1178 if ((errno != 0) /* Overflow */
1179 || (endptr == ptr) /* Invalid string */
1180 || (endptr == NULL) /* This should not happen */
1181 || (*endptr != 0)) /* Trailing chars */
1182 return (-1);
1184 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1185 }
1187 continue;
1188 }
1190 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1191 vl->values[i].gauge = NAN;
1192 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1193 return -1;
1195 i++;
1196 } /* while (strtok_r) */
1198 if ((ptr != NULL) || (i == 0))
1199 return (-1);
1200 return (0);
1201 } /* int parse_values */
1203 #if !HAVE_GETPWNAM_R
1204 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1205 size_t buflen, struct passwd **pwbufp)
1206 {
1207 int status = 0;
1208 struct passwd *pw;
1210 memset (pwbuf, '\0', sizeof (struct passwd));
1212 pthread_mutex_lock (&getpwnam_r_lock);
1214 do
1215 {
1216 pw = getpwnam (name);
1217 if (pw == NULL)
1218 {
1219 status = (errno != 0) ? errno : ENOENT;
1220 break;
1221 }
1223 #define GETPWNAM_COPY_MEMBER(member) \
1224 if (pw->member != NULL) \
1225 { \
1226 int len = strlen (pw->member); \
1227 if (len >= buflen) \
1228 { \
1229 status = ENOMEM; \
1230 break; \
1231 } \
1232 sstrncpy (buf, pw->member, buflen); \
1233 pwbuf->member = buf; \
1234 buf += (len + 1); \
1235 buflen -= (len + 1); \
1236 }
1237 GETPWNAM_COPY_MEMBER(pw_name);
1238 GETPWNAM_COPY_MEMBER(pw_passwd);
1239 GETPWNAM_COPY_MEMBER(pw_gecos);
1240 GETPWNAM_COPY_MEMBER(pw_dir);
1241 GETPWNAM_COPY_MEMBER(pw_shell);
1243 pwbuf->pw_uid = pw->pw_uid;
1244 pwbuf->pw_gid = pw->pw_gid;
1246 if (pwbufp != NULL)
1247 *pwbufp = pwbuf;
1248 } while (0);
1250 pthread_mutex_unlock (&getpwnam_r_lock);
1252 return (status);
1253 } /* int getpwnam_r */
1254 #endif /* !HAVE_GETPWNAM_R */
1256 int notification_init (notification_t *n, int severity, const char *message,
1257 const char *host,
1258 const char *plugin, const char *plugin_instance,
1259 const char *type, const char *type_instance)
1260 {
1261 memset (n, '\0', sizeof (notification_t));
1263 n->severity = severity;
1265 if (message != NULL)
1266 sstrncpy (n->message, message, sizeof (n->message));
1267 if (host != NULL)
1268 sstrncpy (n->host, host, sizeof (n->host));
1269 if (plugin != NULL)
1270 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1271 if (plugin_instance != NULL)
1272 sstrncpy (n->plugin_instance, plugin_instance,
1273 sizeof (n->plugin_instance));
1274 if (type != NULL)
1275 sstrncpy (n->type, type, sizeof (n->type));
1276 if (type_instance != NULL)
1277 sstrncpy (n->type_instance, type_instance,
1278 sizeof (n->type_instance));
1280 return (0);
1281 } /* int notification_init */
1283 int walk_directory (const char *dir, dirwalk_callback_f callback,
1284 void *user_data, int include_hidden)
1285 {
1286 struct dirent *ent;
1287 DIR *dh;
1288 int success;
1289 int failure;
1291 success = 0;
1292 failure = 0;
1294 if ((dh = opendir (dir)) == NULL)
1295 {
1296 char errbuf[1024];
1297 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1298 sstrerror (errno, errbuf, sizeof (errbuf)));
1299 return -1;
1300 }
1302 while ((ent = readdir (dh)) != NULL)
1303 {
1304 int status;
1306 if (include_hidden)
1307 {
1308 if ((strcmp (".", ent->d_name) == 0)
1309 || (strcmp ("..", ent->d_name) == 0))
1310 continue;
1311 }
1312 else /* if (!include_hidden) */
1313 {
1314 if (ent->d_name[0]=='.')
1315 continue;
1316 }
1318 status = (*callback) (dir, ent->d_name, user_data);
1319 if (status != 0)
1320 failure++;
1321 else
1322 success++;
1323 }
1325 closedir (dh);
1327 if ((success == 0) && (failure > 0))
1328 return (-1);
1329 return (0);
1330 }
1332 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1333 {
1334 FILE *fh;
1335 ssize_t ret;
1337 fh = fopen (filename, "r");
1338 if (fh == NULL)
1339 return (-1);
1341 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1342 if ((ret == 0) && (ferror (fh) != 0))
1343 {
1344 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1345 filename);
1346 ret = -1;
1347 }
1349 fclose(fh);
1350 return (ret);
1351 }
1353 counter_t counter_diff (counter_t old_value, counter_t new_value)
1354 {
1355 counter_t diff;
1357 if (old_value > new_value)
1358 {
1359 if (old_value <= 4294967295U)
1360 diff = (4294967295U - old_value) + new_value + 1;
1361 else
1362 diff = (18446744073709551615ULL - old_value) + new_value + 1;
1363 }
1364 else
1365 {
1366 diff = new_value - old_value;
1367 }
1369 return (diff);
1370 } /* counter_t counter_diff */
1372 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1373 rate_to_value_state_t *state,
1374 int ds_type, cdtime_t t)
1375 {
1376 gauge_t delta_gauge;
1377 cdtime_t delta_t;
1379 if (ds_type == DS_TYPE_GAUGE)
1380 {
1381 state->last_value.gauge = rate;
1382 state->last_time = t;
1384 *ret_value = state->last_value;
1385 return (0);
1386 }
1388 /* Counter and absolute can't handle negative rates. Reset "last time"
1389 * to zero, so that the next valid rate will re-initialize the
1390 * structure. */
1391 if ((rate < 0.0)
1392 && ((ds_type == DS_TYPE_COUNTER)
1393 || (ds_type == DS_TYPE_ABSOLUTE)))
1394 {
1395 memset (state, 0, sizeof (*state));
1396 return (EINVAL);
1397 }
1399 /* Another invalid state: The time is not increasing. */
1400 if (t <= state->last_time)
1401 {
1402 memset (state, 0, sizeof (*state));
1403 return (EINVAL);
1404 }
1406 delta_t = t - state->last_time;
1407 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1409 /* Previous value is invalid. */
1410 if (state->last_time == 0) /* {{{ */
1411 {
1412 if (ds_type == DS_TYPE_DERIVE)
1413 {
1414 state->last_value.derive = (derive_t) rate;
1415 state->residual = rate - ((gauge_t) state->last_value.derive);
1416 }
1417 else if (ds_type == DS_TYPE_COUNTER)
1418 {
1419 state->last_value.counter = (counter_t) rate;
1420 state->residual = rate - ((gauge_t) state->last_value.counter);
1421 }
1422 else if (ds_type == DS_TYPE_ABSOLUTE)
1423 {
1424 state->last_value.absolute = (absolute_t) rate;
1425 state->residual = rate - ((gauge_t) state->last_value.absolute);
1426 }
1427 else
1428 {
1429 assert (23 == 42);
1430 }
1432 state->last_time = t;
1433 return (EAGAIN);
1434 } /* }}} */
1436 if (ds_type == DS_TYPE_DERIVE)
1437 {
1438 derive_t delta_derive = (derive_t) delta_gauge;
1440 state->last_value.derive += delta_derive;
1441 state->residual = delta_gauge - ((gauge_t) delta_derive);
1442 }
1443 else if (ds_type == DS_TYPE_COUNTER)
1444 {
1445 counter_t delta_counter = (counter_t) delta_gauge;
1447 state->last_value.counter += delta_counter;
1448 state->residual = delta_gauge - ((gauge_t) delta_counter);
1449 }
1450 else if (ds_type == DS_TYPE_ABSOLUTE)
1451 {
1452 absolute_t delta_absolute = (absolute_t) delta_gauge;
1454 state->last_value.absolute = delta_absolute;
1455 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1456 }
1457 else
1458 {
1459 assert (23 == 42);
1460 }
1462 state->last_time = t;
1463 *ret_value = state->last_value;
1464 return (0);
1465 } /* }}} value_t rate_to_value */
1467 int value_to_rate (gauge_t *ret_rate, /* {{{ */
1468 value_t value, int ds_type, cdtime_t t, value_to_rate_state_t *state)
1469 {
1470 gauge_t 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 state->last_value = value;
1485 state->last_time = t;
1486 return (EAGAIN);
1487 }
1489 switch (ds_type) {
1490 case DS_TYPE_DERIVE: {
1491 derive_t diff = value.derive - state->last_value.derive;
1492 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1493 break;
1494 }
1495 case DS_TYPE_GAUGE: {
1496 *ret_rate = value.gauge;
1497 break;
1498 }
1499 case DS_TYPE_COUNTER: {
1500 counter_t diff = counter_diff (state->last_value.counter, value.counter);
1501 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1502 break;
1503 }
1504 case DS_TYPE_ABSOLUTE: {
1505 absolute_t diff = value.absolute;
1506 *ret_rate = ((gauge_t) diff) / ((gauge_t) interval);
1507 break;
1508 }
1509 default:
1510 return EINVAL;
1511 }
1513 state->last_value = value;
1514 state->last_time = t;
1515 return (0);
1516 } /* }}} value_t rate_to_value */
1518 int service_name_to_port_number (const char *service_name)
1519 {
1520 struct addrinfo *ai_list;
1521 struct addrinfo *ai_ptr;
1522 struct addrinfo ai_hints;
1523 int status;
1524 int service_number;
1526 if (service_name == NULL)
1527 return (-1);
1529 ai_list = NULL;
1530 memset (&ai_hints, 0, sizeof (ai_hints));
1531 ai_hints.ai_family = AF_UNSPEC;
1533 status = getaddrinfo (/* node = */ NULL, service_name,
1534 &ai_hints, &ai_list);
1535 if (status != 0)
1536 {
1537 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1538 gai_strerror (status));
1539 return (-1);
1540 }
1542 service_number = -1;
1543 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1544 {
1545 if (ai_ptr->ai_family == AF_INET)
1546 {
1547 struct sockaddr_in *sa;
1549 sa = (void *) ai_ptr->ai_addr;
1550 service_number = (int) ntohs (sa->sin_port);
1551 }
1552 else if (ai_ptr->ai_family == AF_INET6)
1553 {
1554 struct sockaddr_in6 *sa;
1556 sa = (void *) ai_ptr->ai_addr;
1557 service_number = (int) ntohs (sa->sin6_port);
1558 }
1560 if ((service_number > 0) && (service_number <= 65535))
1561 break;
1562 }
1564 freeaddrinfo (ai_list);
1566 if ((service_number > 0) && (service_number <= 65535))
1567 return (service_number);
1568 return (-1);
1569 } /* int service_name_to_port_number */
1571 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1572 {
1573 derive_t tmp;
1574 char *endptr;
1576 if ((string == NULL) || (ret_value == NULL))
1577 return (EINVAL);
1579 errno = 0;
1580 endptr = NULL;
1581 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1582 if ((endptr == string) || (errno != 0))
1583 return (-1);
1585 *ret_value = tmp;
1586 return (0);
1587 } /* }}} int strtoderive */
1589 int strtogauge (const char *string, gauge_t *ret_value) /* {{{ */
1590 {
1591 gauge_t tmp;
1592 char *endptr = NULL;
1594 if ((string == NULL) || (ret_value == NULL))
1595 return (EINVAL);
1597 errno = 0;
1598 endptr = NULL;
1599 tmp = (gauge_t) strtod (string, &endptr);
1600 if (errno != 0)
1601 return (errno);
1602 else if ((endptr == NULL) || (*endptr != 0))
1603 return (EINVAL);
1605 *ret_value = tmp;
1606 return (0);
1607 } /* }}} int strtogauge */
1609 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1610 {
1611 char **array;
1612 size_t array_len = *ret_array_len;
1614 if (str == NULL)
1615 return (EINVAL);
1617 array = realloc (*ret_array,
1618 (array_len + 1) * sizeof (*array));
1619 if (array == NULL)
1620 return (ENOMEM);
1621 *ret_array = array;
1623 array[array_len] = strdup (str);
1624 if (array[array_len] == NULL)
1625 return (ENOMEM);
1627 array_len++;
1628 *ret_array_len = array_len;
1629 return (0);
1630 } /* }}} int strarray_add */
1632 void strarray_free (char **array, size_t array_len) /* {{{ */
1633 {
1634 size_t i;
1636 for (i = 0; i < array_len; i++)
1637 sfree (array[i]);
1638 sfree (array);
1639 } /* }}} void strarray_free */