1 /**
2 * collectd - src/common.c
3 * Copyright (C) 2005-2010 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
18 * Authors:
19 * Florian octo Forster <octo at collectd.org>
20 * Niki W. Waibel <niki.waibel@gmx.net>
21 * Sebastian Harl <sh at tokkee.org>
22 * Michał Mirosław <mirq-linux at rere.qmqm.pl>
23 **/
25 #if HAVE_CONFIG_H
26 # include "config.h"
27 #endif
29 #include "collectd.h"
30 #include "common.h"
31 #include "plugin.h"
32 #include "utils_cache.h"
34 #if HAVE_PTHREAD_H
35 # include <pthread.h>
36 #endif
38 #ifdef HAVE_MATH_H
39 # include <math.h>
40 #endif
42 /* for getaddrinfo */
43 #include <sys/types.h>
44 #include <sys/socket.h>
45 #include <netdb.h>
47 #include <poll.h>
49 #if HAVE_NETINET_IN_H
50 # include <netinet/in.h>
51 #endif
53 /* for ntohl and htonl */
54 #if HAVE_ARPA_INET_H
55 # include <arpa/inet.h>
56 #endif
58 #ifdef HAVE_LIBKSTAT
59 extern kstat_ctl_t *kc;
60 #endif
62 #if !HAVE_GETPWNAM_R
63 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
64 #endif
66 #if !HAVE_STRERROR_R
67 static pthread_mutex_t strerror_r_lock = PTHREAD_MUTEX_INITIALIZER;
68 #endif
70 char *sstrncpy (char *dest, const char *src, size_t n)
71 {
72 strncpy (dest, src, n);
73 dest[n - 1] = '\0';
75 return (dest);
76 } /* char *sstrncpy */
78 int ssnprintf (char *dest, size_t n, const char *format, ...)
79 {
80 int ret = 0;
81 va_list ap;
83 va_start (ap, format);
84 ret = vsnprintf (dest, n, format, ap);
85 dest[n - 1] = '\0';
86 va_end (ap);
88 return (ret);
89 } /* int ssnprintf */
91 char *ssnprintf_alloc (char const *format, ...) /* {{{ */
92 {
93 char static_buffer[1024] = "";
94 char *alloc_buffer;
95 size_t alloc_buffer_size;
96 int status;
97 va_list ap;
99 /* Try printing into the static buffer. In many cases it will be
100 * sufficiently large and we can simply return a strdup() of this
101 * buffer. */
102 va_start (ap, format);
103 status = vsnprintf (static_buffer, sizeof (static_buffer), format, ap);
104 va_end (ap);
105 if (status < 0)
106 return (NULL);
108 /* "status" does not include the null byte. */
109 alloc_buffer_size = (size_t) (status + 1);
110 if (alloc_buffer_size <= sizeof (static_buffer))
111 return (strdup (static_buffer));
113 /* Allocate a buffer large enough to hold the string. */
114 alloc_buffer = malloc (alloc_buffer_size);
115 if (alloc_buffer == NULL)
116 return (NULL);
117 memset (alloc_buffer, 0, alloc_buffer_size);
119 /* Print again into this new buffer. */
120 va_start (ap, format);
121 status = vsnprintf (alloc_buffer, alloc_buffer_size, format, ap);
122 va_end (ap);
123 if (status < 0)
124 {
125 sfree (alloc_buffer);
126 return (NULL);
127 }
129 return (alloc_buffer);
130 } /* }}} char *ssnprintf_alloc */
132 char *sstrdup (const char *s)
133 {
134 char *r;
135 size_t sz;
137 if (s == NULL)
138 return (NULL);
140 /* Do not use `strdup' here, because it's not specified in POSIX. It's
141 * ``only'' an XSI extension. */
142 sz = strlen (s) + 1;
143 r = (char *) malloc (sizeof (char) * sz);
144 if (r == NULL)
145 {
146 ERROR ("sstrdup: Out of memory.");
147 exit (3);
148 }
149 memcpy (r, s, sizeof (char) * sz);
151 return (r);
152 } /* char *sstrdup */
154 /* Even though Posix requires "strerror_r" to return an "int",
155 * some systems (e.g. the GNU libc) return a "char *" _and_
156 * ignore the second argument ... -tokkee */
157 char *sstrerror (int errnum, char *buf, size_t buflen)
158 {
159 buf[0] = '\0';
161 #if !HAVE_STRERROR_R
162 {
163 char *temp;
165 pthread_mutex_lock (&strerror_r_lock);
167 temp = strerror (errnum);
168 sstrncpy (buf, temp, buflen);
170 pthread_mutex_unlock (&strerror_r_lock);
171 }
172 /* #endif !HAVE_STRERROR_R */
174 #elif STRERROR_R_CHAR_P
175 {
176 char *temp;
177 temp = strerror_r (errnum, buf, buflen);
178 if (buf[0] == '\0')
179 {
180 if ((temp != NULL) && (temp != buf) && (temp[0] != '\0'))
181 sstrncpy (buf, temp, buflen);
182 else
183 sstrncpy (buf, "strerror_r did not return "
184 "an error message", buflen);
185 }
186 }
187 /* #endif STRERROR_R_CHAR_P */
189 #else
190 if (strerror_r (errnum, buf, buflen) != 0)
191 {
192 ssnprintf (buf, buflen, "Error #%i; "
193 "Additionally, strerror_r failed.",
194 errnum);
195 }
196 #endif /* STRERROR_R_CHAR_P */
198 return (buf);
199 } /* char *sstrerror */
201 void *smalloc (size_t size)
202 {
203 void *r;
205 if ((r = malloc (size)) == NULL)
206 {
207 ERROR ("Not enough memory.");
208 exit (3);
209 }
211 return (r);
212 } /* void *smalloc */
214 #if 0
215 void sfree (void **ptr)
216 {
217 if (ptr == NULL)
218 return;
220 if (*ptr != NULL)
221 free (*ptr);
223 *ptr = NULL;
224 }
225 #endif
227 ssize_t sread (int fd, void *buf, size_t count)
228 {
229 char *ptr;
230 size_t nleft;
231 ssize_t status;
233 ptr = (char *) buf;
234 nleft = count;
236 while (nleft > 0)
237 {
238 status = read (fd, (void *) ptr, nleft);
240 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
241 continue;
243 if (status < 0)
244 return (status);
246 if (status == 0)
247 {
248 DEBUG ("Received EOF from fd %i. "
249 "Closing fd and returning error.",
250 fd);
251 close (fd);
252 return (-1);
253 }
255 assert ((0 > status) || (nleft >= (size_t)status));
257 nleft = nleft - status;
258 ptr = ptr + status;
259 }
261 return (0);
262 }
265 ssize_t swrite (int fd, const void *buf, size_t count)
266 {
267 const char *ptr;
268 size_t nleft;
269 ssize_t status;
270 struct pollfd pfd;
272 ptr = (const char *) buf;
273 nleft = count;
275 /* checking for closed peer connection */
276 pfd.fd = fd;
277 pfd.events = POLLIN | POLLHUP;
278 pfd.revents = 0;
279 if (poll(&pfd, 1, 0) > 0) {
280 char buffer[32];
281 if (recv(fd, buffer, sizeof(buffer), MSG_PEEK | MSG_DONTWAIT) == 0) {
282 // if recv returns zero (even though poll() said there is data to be read),
283 // that means the connection has been closed
284 return -1;
285 }
286 }
288 while (nleft > 0)
289 {
290 status = write (fd, (const void *) ptr, nleft);
292 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
293 continue;
295 if (status < 0)
296 return (status);
298 nleft = nleft - status;
299 ptr = ptr + status;
300 }
302 return (0);
303 }
305 int strsplit (char *string, char **fields, size_t size)
306 {
307 size_t i;
308 char *ptr;
309 char *saveptr;
311 i = 0;
312 ptr = string;
313 saveptr = NULL;
314 while ((fields[i] = strtok_r (ptr, " \t\r\n", &saveptr)) != NULL)
315 {
316 ptr = NULL;
317 i++;
319 if (i >= size)
320 break;
321 }
323 return ((int) i);
324 }
326 int strjoin (char *buffer, size_t buffer_size,
327 char **fields, size_t fields_num,
328 const char *sep)
329 {
330 size_t avail;
331 char *ptr;
332 size_t sep_len;
333 size_t i;
335 if ((buffer_size < 1) || (fields_num <= 0))
336 return (-1);
338 memset (buffer, 0, buffer_size);
339 ptr = buffer;
340 avail = buffer_size - 1;
342 sep_len = 0;
343 if (sep != NULL)
344 sep_len = strlen (sep);
346 for (i = 0; i < fields_num; i++)
347 {
348 size_t field_len;
350 if ((i > 0) && (sep_len > 0))
351 {
352 if (avail < sep_len)
353 return (-1);
355 memcpy (ptr, sep, sep_len);
356 ptr += sep_len;
357 avail -= sep_len;
358 }
360 field_len = strlen (fields[i]);
361 if (avail < field_len)
362 return (-1);
364 memcpy (ptr, fields[i], field_len);
365 ptr += field_len;
366 avail -= field_len;
367 }
369 assert (buffer[buffer_size - 1] == 0);
370 return (strlen (buffer));
371 }
373 int strsubstitute (char *str, char c_from, char c_to)
374 {
375 int ret;
377 if (str == NULL)
378 return (-1);
380 ret = 0;
381 while (*str != '\0')
382 {
383 if (*str == c_from)
384 {
385 *str = c_to;
386 ret++;
387 }
388 str++;
389 }
391 return (ret);
392 } /* int strsubstitute */
394 int strunescape (char *buf, size_t buf_len)
395 {
396 size_t i;
398 for (i = 0; (i < buf_len) && (buf[i] != '\0'); ++i)
399 {
400 if (buf[i] != '\\')
401 continue;
403 if ((i >= buf_len) || (buf[i + 1] == '\0')) {
404 ERROR ("string unescape: backslash found at end of string.");
405 return (-1);
406 }
408 switch (buf[i + 1]) {
409 case 't':
410 buf[i] = '\t';
411 break;
412 case 'n':
413 buf[i] = '\n';
414 break;
415 case 'r':
416 buf[i] = '\r';
417 break;
418 default:
419 buf[i] = buf[i + 1];
420 break;
421 }
423 memmove (buf + i + 1, buf + i + 2, buf_len - i - 2);
424 }
425 return (0);
426 } /* int strunescape */
428 size_t strstripnewline (char *buffer)
429 {
430 size_t buffer_len = strlen (buffer);
432 while (buffer_len > 0)
433 {
434 if ((buffer[buffer_len - 1] != '\n')
435 && (buffer[buffer_len - 1] != '\r'))
436 break;
437 buffer_len--;
438 buffer[buffer_len] = 0;
439 }
441 return (buffer_len);
442 } /* size_t strstripnewline */
444 int escape_slashes (char *buf, int buf_len)
445 {
446 int i;
448 if (strcmp (buf, "/") == 0)
449 {
450 if (buf_len < 5)
451 return (-1);
453 strncpy (buf, "root", buf_len);
454 return (0);
455 }
457 if (buf_len <= 1)
458 return (0);
460 /* Move one to the left */
461 if (buf[0] == '/')
462 memmove (buf, buf + 1, buf_len - 1);
464 for (i = 0; i < buf_len; i++)
465 {
466 if (buf[i] == '\0')
467 break;
468 else if (buf[i] == '/')
469 buf[i] = '_';
470 }
471 buf[i] = '\0';
473 return (0);
474 } /* int escape_slashes */
476 void replace_special (char *buffer, size_t buffer_size)
477 {
478 size_t i;
480 for (i = 0; i < buffer_size; i++)
481 {
482 if (buffer[i] == 0)
483 return;
484 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
485 buffer[i] = '_';
486 }
487 } /* void replace_special */
489 int timeval_cmp (struct timeval tv0, struct timeval tv1, struct timeval *delta)
490 {
491 struct timeval *larger;
492 struct timeval *smaller;
494 int status;
496 NORMALIZE_TIMEVAL (tv0);
497 NORMALIZE_TIMEVAL (tv1);
499 if ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec == tv1.tv_usec))
500 {
501 if (delta != NULL) {
502 delta->tv_sec = 0;
503 delta->tv_usec = 0;
504 }
505 return (0);
506 }
508 if ((tv0.tv_sec < tv1.tv_sec)
509 || ((tv0.tv_sec == tv1.tv_sec) && (tv0.tv_usec < tv1.tv_usec)))
510 {
511 larger = &tv1;
512 smaller = &tv0;
513 status = -1;
514 }
515 else
516 {
517 larger = &tv0;
518 smaller = &tv1;
519 status = 1;
520 }
522 if (delta != NULL) {
523 delta->tv_sec = larger->tv_sec - smaller->tv_sec;
525 if (smaller->tv_usec <= larger->tv_usec)
526 delta->tv_usec = larger->tv_usec - smaller->tv_usec;
527 else
528 {
529 --delta->tv_sec;
530 delta->tv_usec = 1000000 + larger->tv_usec - smaller->tv_usec;
531 }
532 }
534 assert ((delta == NULL)
535 || ((0 <= delta->tv_usec) && (delta->tv_usec < 1000000)));
537 return (status);
538 } /* int timeval_cmp */
540 int check_create_dir (const char *file_orig)
541 {
542 struct stat statbuf;
544 char file_copy[512];
545 char dir[512];
546 int dir_len = 512;
547 char *fields[16];
548 int fields_num;
549 char *ptr;
550 char *saveptr;
551 int last_is_file = 1;
552 int path_is_absolute = 0;
553 size_t len;
554 int i;
556 /*
557 * Sanity checks first
558 */
559 if (file_orig == NULL)
560 return (-1);
562 if ((len = strlen (file_orig)) < 1)
563 return (-1);
564 else if (len >= sizeof (file_copy))
565 return (-1);
567 /*
568 * If `file_orig' ends in a slash the last component is a directory,
569 * otherwise it's a file. Act accordingly..
570 */
571 if (file_orig[len - 1] == '/')
572 last_is_file = 0;
573 if (file_orig[0] == '/')
574 path_is_absolute = 1;
576 /*
577 * Create a copy for `strtok_r' to destroy
578 */
579 sstrncpy (file_copy, file_orig, sizeof (file_copy));
581 /*
582 * Break into components. This will eat up several slashes in a row and
583 * remove leading and trailing slashes..
584 */
585 ptr = file_copy;
586 saveptr = NULL;
587 fields_num = 0;
588 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
589 {
590 ptr = NULL;
591 fields_num++;
593 if (fields_num >= 16)
594 break;
595 }
597 /*
598 * For each component, do..
599 */
600 for (i = 0; i < (fields_num - last_is_file); i++)
601 {
602 /*
603 * Do not create directories that start with a dot. This
604 * prevents `../../' attacks and other likely malicious
605 * behavior.
606 */
607 if (fields[i][0] == '.')
608 {
609 ERROR ("Cowardly refusing to create a directory that "
610 "begins with a `.' (dot): `%s'", file_orig);
611 return (-2);
612 }
614 /*
615 * Join the components together again
616 */
617 dir[0] = '/';
618 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
619 fields, i + 1, "/") < 0)
620 {
621 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
622 return (-1);
623 }
625 while (42) {
626 if ((stat (dir, &statbuf) == -1)
627 && (lstat (dir, &statbuf) == -1))
628 {
629 if (errno == ENOENT)
630 {
631 if (mkdir (dir, S_IRWXU | S_IRWXG | S_IRWXO) == 0)
632 break;
634 /* this might happen, if a different thread created
635 * the directory in the meantime
636 * => call stat() again to check for S_ISDIR() */
637 if (EEXIST == errno)
638 continue;
640 char errbuf[1024];
641 ERROR ("check_create_dir: mkdir (%s): %s", dir,
642 sstrerror (errno,
643 errbuf, sizeof (errbuf)));
644 return (-1);
645 }
646 else
647 {
648 char errbuf[1024];
649 ERROR ("check_create_dir: stat (%s): %s", dir,
650 sstrerror (errno, errbuf,
651 sizeof (errbuf)));
652 return (-1);
653 }
654 }
655 else if (!S_ISDIR (statbuf.st_mode))
656 {
657 ERROR ("check_create_dir: `%s' exists but is not "
658 "a directory!", dir);
659 return (-1);
660 }
661 break;
662 }
663 }
665 return (0);
666 } /* check_create_dir */
668 #ifdef HAVE_LIBKSTAT
669 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
670 {
671 char ident[128];
673 *ksp_ptr = NULL;
675 if (kc == NULL)
676 return (-1);
678 ssnprintf (ident, sizeof (ident), "%s,%i,%s", module, instance, name);
680 *ksp_ptr = kstat_lookup (kc, module, instance, name);
681 if (*ksp_ptr == NULL)
682 {
683 ERROR ("get_kstat: Cound not find kstat %s", ident);
684 return (-1);
685 }
687 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
688 {
689 ERROR ("get_kstat: kstat %s has wrong type", ident);
690 *ksp_ptr = NULL;
691 return (-1);
692 }
694 #ifdef assert
695 assert (*ksp_ptr != NULL);
696 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
697 #endif
699 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
700 {
701 ERROR ("get_kstat: kstat %s could not be read", ident);
702 return (-1);
703 }
705 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
706 {
707 ERROR ("get_kstat: kstat %s has wrong type", ident);
708 return (-1);
709 }
711 return (0);
712 }
714 long long get_kstat_value (kstat_t *ksp, char *name)
715 {
716 kstat_named_t *kn;
717 long long retval = -1LL;
719 if (ksp == NULL)
720 {
721 ERROR ("get_kstat_value (\"%s\"): ksp is NULL.", name);
722 return (-1LL);
723 }
724 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
725 {
726 ERROR ("get_kstat_value (\"%s\"): ksp->ks_type (%#x) "
727 "is not KSTAT_TYPE_NAMED (%#x).",
728 name,
729 (unsigned int) ksp->ks_type,
730 (unsigned int) KSTAT_TYPE_NAMED);
731 return (-1LL);
732 }
734 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
735 return (-1LL);
737 if (kn->data_type == KSTAT_DATA_INT32)
738 retval = (long long) kn->value.i32;
739 else if (kn->data_type == KSTAT_DATA_UINT32)
740 retval = (long long) kn->value.ui32;
741 else if (kn->data_type == KSTAT_DATA_INT64)
742 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
743 else if (kn->data_type == KSTAT_DATA_UINT64)
744 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
745 else
746 WARNING ("get_kstat_value: Not a numeric value: %s", name);
748 return (retval);
749 }
750 #endif /* HAVE_LIBKSTAT */
752 #ifndef HAVE_HTONLL
753 unsigned long long ntohll (unsigned long long n)
754 {
755 #if BYTE_ORDER == BIG_ENDIAN
756 return (n);
757 #else
758 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
759 #endif
760 } /* unsigned long long ntohll */
762 unsigned long long htonll (unsigned long long n)
763 {
764 #if BYTE_ORDER == BIG_ENDIAN
765 return (n);
766 #else
767 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
768 #endif
769 } /* unsigned long long htonll */
770 #endif /* HAVE_HTONLL */
772 #if FP_LAYOUT_NEED_NOTHING
773 /* Well, we need nothing.. */
774 /* #endif FP_LAYOUT_NEED_NOTHING */
776 #elif FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP
777 # if FP_LAYOUT_NEED_ENDIANFLIP
778 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xff00000000000000LL) >> 56) | \
779 (((uint64_t)(A) & 0x00ff000000000000LL) >> 40) | \
780 (((uint64_t)(A) & 0x0000ff0000000000LL) >> 24) | \
781 (((uint64_t)(A) & 0x000000ff00000000LL) >> 8) | \
782 (((uint64_t)(A) & 0x00000000ff000000LL) << 8) | \
783 (((uint64_t)(A) & 0x0000000000ff0000LL) << 24) | \
784 (((uint64_t)(A) & 0x000000000000ff00LL) << 40) | \
785 (((uint64_t)(A) & 0x00000000000000ffLL) << 56))
786 # else
787 # define FP_CONVERT(A) ((((uint64_t)(A) & 0xffffffff00000000LL) >> 32) | \
788 (((uint64_t)(A) & 0x00000000ffffffffLL) << 32))
789 # endif
791 double ntohd (double d)
792 {
793 union
794 {
795 uint8_t byte[8];
796 uint64_t integer;
797 double floating;
798 } ret;
800 ret.floating = d;
802 /* NAN in x86 byte order */
803 if ((ret.byte[0] == 0x00) && (ret.byte[1] == 0x00)
804 && (ret.byte[2] == 0x00) && (ret.byte[3] == 0x00)
805 && (ret.byte[4] == 0x00) && (ret.byte[5] == 0x00)
806 && (ret.byte[6] == 0xf8) && (ret.byte[7] == 0x7f))
807 {
808 return (NAN);
809 }
810 else
811 {
812 uint64_t tmp;
814 tmp = ret.integer;
815 ret.integer = FP_CONVERT (tmp);
816 return (ret.floating);
817 }
818 } /* double ntohd */
820 double htond (double d)
821 {
822 union
823 {
824 uint8_t byte[8];
825 uint64_t integer;
826 double floating;
827 } ret;
829 if (isnan (d))
830 {
831 ret.byte[0] = ret.byte[1] = ret.byte[2] = ret.byte[3] = 0x00;
832 ret.byte[4] = ret.byte[5] = 0x00;
833 ret.byte[6] = 0xf8;
834 ret.byte[7] = 0x7f;
835 return (ret.floating);
836 }
837 else
838 {
839 uint64_t tmp;
841 ret.floating = d;
842 tmp = FP_CONVERT (ret.integer);
843 ret.integer = tmp;
844 return (ret.floating);
845 }
846 } /* double htond */
847 #endif /* FP_LAYOUT_NEED_ENDIANFLIP || FP_LAYOUT_NEED_INTSWAP */
849 int format_name (char *ret, int ret_len,
850 const char *hostname,
851 const char *plugin, const char *plugin_instance,
852 const char *type, const char *type_instance)
853 {
854 char *buffer;
855 size_t buffer_size;
857 buffer = ret;
858 buffer_size = (size_t) ret_len;
860 #define APPEND(str) do { \
861 size_t l = strlen (str); \
862 if (l >= buffer_size) \
863 return (ENOBUFS); \
864 memcpy (buffer, (str), l); \
865 buffer += l; buffer_size -= l; \
866 } while (0)
868 assert (plugin != NULL);
869 assert (type != NULL);
871 APPEND (hostname);
872 APPEND ("/");
873 APPEND (plugin);
874 if ((plugin_instance != NULL) && (plugin_instance[0] != 0))
875 {
876 APPEND ("-");
877 APPEND (plugin_instance);
878 }
879 APPEND ("/");
880 APPEND (type);
881 if ((type_instance != NULL) && (type_instance[0] != 0))
882 {
883 APPEND ("-");
884 APPEND (type_instance);
885 }
886 assert (buffer_size > 0);
887 buffer[0] = 0;
889 #undef APPEND
890 return (0);
891 } /* int format_name */
893 int format_values (char *ret, size_t ret_len, /* {{{ */
894 const data_set_t *ds, const value_list_t *vl,
895 _Bool store_rates)
896 {
897 size_t offset = 0;
898 int status;
899 int i;
900 gauge_t *rates = NULL;
902 assert (0 == strcmp (ds->type, vl->type));
904 memset (ret, 0, ret_len);
906 #define BUFFER_ADD(...) do { \
907 status = ssnprintf (ret + offset, ret_len - offset, \
908 __VA_ARGS__); \
909 if (status < 1) \
910 { \
911 sfree (rates); \
912 return (-1); \
913 } \
914 else if (((size_t) status) >= (ret_len - offset)) \
915 { \
916 sfree (rates); \
917 return (-1); \
918 } \
919 else \
920 offset += ((size_t) status); \
921 } while (0)
923 BUFFER_ADD ("%.3f", CDTIME_T_TO_DOUBLE (vl->time));
925 for (i = 0; i < ds->ds_num; i++)
926 {
927 if (ds->ds[i].type == DS_TYPE_GAUGE)
928 BUFFER_ADD (":"GAUGE_FORMAT, vl->values[i].gauge);
929 else if (store_rates)
930 {
931 if (rates == NULL)
932 rates = uc_get_rate (ds, vl);
933 if (rates == NULL)
934 {
935 WARNING ("format_values: uc_get_rate failed.");
936 return (-1);
937 }
938 BUFFER_ADD (":"GAUGE_FORMAT, rates[i]);
939 }
940 else if (ds->ds[i].type == DS_TYPE_COUNTER)
941 BUFFER_ADD (":%llu", vl->values[i].counter);
942 else if (ds->ds[i].type == DS_TYPE_DERIVE)
943 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
944 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
945 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
946 else
947 {
948 ERROR ("format_values: Unknown data source type: %i",
949 ds->ds[i].type);
950 sfree (rates);
951 return (-1);
952 }
953 } /* for ds->ds_num */
955 #undef BUFFER_ADD
957 sfree (rates);
958 return (0);
959 } /* }}} int format_values */
961 int parse_identifier (char *str, char **ret_host,
962 char **ret_plugin, char **ret_plugin_instance,
963 char **ret_type, char **ret_type_instance)
964 {
965 char *hostname = NULL;
966 char *plugin = NULL;
967 char *plugin_instance = NULL;
968 char *type = NULL;
969 char *type_instance = NULL;
971 hostname = str;
972 if (hostname == NULL)
973 return (-1);
975 plugin = strchr (hostname, '/');
976 if (plugin == NULL)
977 return (-1);
978 *plugin = '\0'; plugin++;
980 type = strchr (plugin, '/');
981 if (type == NULL)
982 return (-1);
983 *type = '\0'; type++;
985 plugin_instance = strchr (plugin, '-');
986 if (plugin_instance != NULL)
987 {
988 *plugin_instance = '\0';
989 plugin_instance++;
990 }
992 type_instance = strchr (type, '-');
993 if (type_instance != NULL)
994 {
995 *type_instance = '\0';
996 type_instance++;
997 }
999 *ret_host = hostname;
1000 *ret_plugin = plugin;
1001 *ret_plugin_instance = plugin_instance;
1002 *ret_type = type;
1003 *ret_type_instance = type_instance;
1004 return (0);
1005 } /* int parse_identifier */
1007 int parse_identifier_vl (const char *str, value_list_t *vl) /* {{{ */
1008 {
1009 char str_copy[6 * DATA_MAX_NAME_LEN];
1010 char *host = NULL;
1011 char *plugin = NULL;
1012 char *plugin_instance = NULL;
1013 char *type = NULL;
1014 char *type_instance = NULL;
1015 int status;
1017 if ((str == NULL) || (vl == NULL))
1018 return (EINVAL);
1020 sstrncpy (str_copy, str, sizeof (str_copy));
1022 status = parse_identifier (str_copy, &host,
1023 &plugin, &plugin_instance,
1024 &type, &type_instance);
1025 if (status != 0)
1026 return (status);
1028 sstrncpy (vl->host, host, sizeof (vl->host));
1029 sstrncpy (vl->plugin, plugin, sizeof (vl->plugin));
1030 sstrncpy (vl->plugin_instance,
1031 (plugin_instance != NULL) ? plugin_instance : "",
1032 sizeof (vl->plugin_instance));
1033 sstrncpy (vl->type, type, sizeof (vl->type));
1034 sstrncpy (vl->type_instance,
1035 (type_instance != NULL) ? type_instance : "",
1036 sizeof (vl->type_instance));
1038 return (0);
1039 } /* }}} int parse_identifier_vl */
1041 int parse_value (const char *value_orig, value_t *ret_value, int ds_type)
1042 {
1043 char *value;
1044 char *endptr = NULL;
1045 size_t value_len;
1047 if (value_orig == NULL)
1048 return (EINVAL);
1050 value = strdup (value_orig);
1051 if (value == NULL)
1052 return (ENOMEM);
1053 value_len = strlen (value);
1055 while ((value_len > 0) && isspace ((int) value[value_len - 1]))
1056 {
1057 value[value_len - 1] = 0;
1058 value_len--;
1059 }
1061 switch (ds_type)
1062 {
1063 case DS_TYPE_COUNTER:
1064 ret_value->counter = (counter_t) strtoull (value, &endptr, 0);
1065 break;
1067 case DS_TYPE_GAUGE:
1068 ret_value->gauge = (gauge_t) strtod (value, &endptr);
1069 break;
1071 case DS_TYPE_DERIVE:
1072 ret_value->derive = (derive_t) strtoll (value, &endptr, 0);
1073 break;
1075 case DS_TYPE_ABSOLUTE:
1076 ret_value->absolute = (absolute_t) strtoull (value, &endptr, 0);
1077 break;
1079 default:
1080 sfree (value);
1081 ERROR ("parse_value: Invalid data source type: %i.", ds_type);
1082 return -1;
1083 }
1085 if (value == endptr) {
1086 ERROR ("parse_value: Failed to parse string as %s: %s.",
1087 DS_TYPE_TO_STRING (ds_type), value);
1088 sfree (value);
1089 return -1;
1090 }
1091 else if ((NULL != endptr) && ('\0' != *endptr))
1092 INFO ("parse_value: Ignoring trailing garbage \"%s\" after %s value. "
1093 "Input string was \"%s\".",
1094 endptr, DS_TYPE_TO_STRING (ds_type), value_orig);
1096 sfree (value);
1097 return 0;
1098 } /* int parse_value */
1100 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
1101 {
1102 int i;
1103 char *dummy;
1104 char *ptr;
1105 char *saveptr;
1107 i = -1;
1108 dummy = buffer;
1109 saveptr = NULL;
1110 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
1111 {
1112 dummy = NULL;
1114 if (i >= vl->values_len)
1115 {
1116 /* Make sure i is invalid. */
1117 i = vl->values_len + 1;
1118 break;
1119 }
1121 if (i == -1)
1122 {
1123 if (strcmp ("N", ptr) == 0)
1124 vl->time = cdtime ();
1125 else
1126 {
1127 char *endptr = NULL;
1128 double tmp;
1130 errno = 0;
1131 tmp = strtod (ptr, &endptr);
1132 if ((errno != 0) /* Overflow */
1133 || (endptr == ptr) /* Invalid string */
1134 || (endptr == NULL) /* This should not happen */
1135 || (*endptr != 0)) /* Trailing chars */
1136 return (-1);
1138 vl->time = DOUBLE_TO_CDTIME_T (tmp);
1139 }
1140 }
1141 else
1142 {
1143 if ((strcmp ("U", ptr) == 0) && (ds->ds[i].type == DS_TYPE_GAUGE))
1144 vl->values[i].gauge = NAN;
1145 else if (0 != parse_value (ptr, &vl->values[i], ds->ds[i].type))
1146 return -1;
1147 }
1149 i++;
1150 } /* while (strtok_r) */
1152 if ((ptr != NULL) || (i != vl->values_len))
1153 return (-1);
1154 return (0);
1155 } /* int parse_values */
1157 #if !HAVE_GETPWNAM_R
1158 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
1159 size_t buflen, struct passwd **pwbufp)
1160 {
1161 int status = 0;
1162 struct passwd *pw;
1164 memset (pwbuf, '\0', sizeof (struct passwd));
1166 pthread_mutex_lock (&getpwnam_r_lock);
1168 do
1169 {
1170 pw = getpwnam (name);
1171 if (pw == NULL)
1172 {
1173 status = (errno != 0) ? errno : ENOENT;
1174 break;
1175 }
1177 #define GETPWNAM_COPY_MEMBER(member) \
1178 if (pw->member != NULL) \
1179 { \
1180 int len = strlen (pw->member); \
1181 if (len >= buflen) \
1182 { \
1183 status = ENOMEM; \
1184 break; \
1185 } \
1186 sstrncpy (buf, pw->member, buflen); \
1187 pwbuf->member = buf; \
1188 buf += (len + 1); \
1189 buflen -= (len + 1); \
1190 }
1191 GETPWNAM_COPY_MEMBER(pw_name);
1192 GETPWNAM_COPY_MEMBER(pw_passwd);
1193 GETPWNAM_COPY_MEMBER(pw_gecos);
1194 GETPWNAM_COPY_MEMBER(pw_dir);
1195 GETPWNAM_COPY_MEMBER(pw_shell);
1197 pwbuf->pw_uid = pw->pw_uid;
1198 pwbuf->pw_gid = pw->pw_gid;
1200 if (pwbufp != NULL)
1201 *pwbufp = pwbuf;
1202 } while (0);
1204 pthread_mutex_unlock (&getpwnam_r_lock);
1206 return (status);
1207 } /* int getpwnam_r */
1208 #endif /* !HAVE_GETPWNAM_R */
1210 int notification_init (notification_t *n, int severity, const char *message,
1211 const char *host,
1212 const char *plugin, const char *plugin_instance,
1213 const char *type, const char *type_instance)
1214 {
1215 memset (n, '\0', sizeof (notification_t));
1217 n->severity = severity;
1219 if (message != NULL)
1220 sstrncpy (n->message, message, sizeof (n->message));
1221 if (host != NULL)
1222 sstrncpy (n->host, host, sizeof (n->host));
1223 if (plugin != NULL)
1224 sstrncpy (n->plugin, plugin, sizeof (n->plugin));
1225 if (plugin_instance != NULL)
1226 sstrncpy (n->plugin_instance, plugin_instance,
1227 sizeof (n->plugin_instance));
1228 if (type != NULL)
1229 sstrncpy (n->type, type, sizeof (n->type));
1230 if (type_instance != NULL)
1231 sstrncpy (n->type_instance, type_instance,
1232 sizeof (n->type_instance));
1234 return (0);
1235 } /* int notification_init */
1237 int walk_directory (const char *dir, dirwalk_callback_f callback,
1238 void *user_data, int include_hidden)
1239 {
1240 struct dirent *ent;
1241 DIR *dh;
1242 int success;
1243 int failure;
1245 success = 0;
1246 failure = 0;
1248 if ((dh = opendir (dir)) == NULL)
1249 {
1250 char errbuf[1024];
1251 ERROR ("walk_directory: Cannot open '%s': %s", dir,
1252 sstrerror (errno, errbuf, sizeof (errbuf)));
1253 return -1;
1254 }
1256 while ((ent = readdir (dh)) != NULL)
1257 {
1258 int status;
1260 if (include_hidden)
1261 {
1262 if ((strcmp (".", ent->d_name) == 0)
1263 || (strcmp ("..", ent->d_name) == 0))
1264 continue;
1265 }
1266 else /* if (!include_hidden) */
1267 {
1268 if (ent->d_name[0]=='.')
1269 continue;
1270 }
1272 status = (*callback) (dir, ent->d_name, user_data);
1273 if (status != 0)
1274 failure++;
1275 else
1276 success++;
1277 }
1279 closedir (dh);
1281 if ((success == 0) && (failure > 0))
1282 return (-1);
1283 return (0);
1284 }
1286 ssize_t read_file_contents (const char *filename, char *buf, size_t bufsize)
1287 {
1288 FILE *fh;
1289 ssize_t ret;
1291 fh = fopen (filename, "r");
1292 if (fh == NULL)
1293 return (-1);
1295 ret = (ssize_t) fread (buf, 1, bufsize, fh);
1296 if ((ret == 0) && (ferror (fh) != 0))
1297 {
1298 ERROR ("read_file_contents: Reading file \"%s\" failed.",
1299 filename);
1300 ret = -1;
1301 }
1303 fclose(fh);
1304 return (ret);
1305 }
1307 counter_t counter_diff (counter_t old_value, counter_t new_value)
1308 {
1309 counter_t diff;
1311 if (old_value > new_value)
1312 {
1313 if (old_value <= 4294967295U)
1314 diff = (4294967295U - old_value) + new_value;
1315 else
1316 diff = (18446744073709551615ULL - old_value)
1317 + new_value;
1318 }
1319 else
1320 {
1321 diff = new_value - old_value;
1322 }
1324 return (diff);
1325 } /* counter_t counter_diff */
1327 int rate_to_value (value_t *ret_value, gauge_t rate, /* {{{ */
1328 rate_to_value_state_t *state,
1329 int ds_type, cdtime_t t)
1330 {
1331 gauge_t delta_gauge;
1332 cdtime_t delta_t;
1334 if (ds_type == DS_TYPE_GAUGE)
1335 {
1336 state->last_value.gauge = rate;
1337 state->last_time = t;
1339 *ret_value = state->last_value;
1340 return (0);
1341 }
1343 /* Counter and absolute can't handle negative rates. Reset "last time"
1344 * to zero, so that the next valid rate will re-initialize the
1345 * structure. */
1346 if ((rate < 0.0)
1347 && ((ds_type == DS_TYPE_COUNTER)
1348 || (ds_type == DS_TYPE_ABSOLUTE)))
1349 {
1350 memset (state, 0, sizeof (*state));
1351 return (EINVAL);
1352 }
1354 /* Another invalid state: The time is not increasing. */
1355 if (t <= state->last_time)
1356 {
1357 memset (state, 0, sizeof (*state));
1358 return (EINVAL);
1359 }
1361 delta_t = t - state->last_time;
1362 delta_gauge = (rate * CDTIME_T_TO_DOUBLE (delta_t)) + state->residual;
1364 /* Previous value is invalid. */
1365 if (state->last_time == 0) /* {{{ */
1366 {
1367 if (ds_type == DS_TYPE_DERIVE)
1368 {
1369 state->last_value.derive = (derive_t) rate;
1370 state->residual = rate - ((gauge_t) state->last_value.derive);
1371 }
1372 else if (ds_type == DS_TYPE_COUNTER)
1373 {
1374 state->last_value.counter = (counter_t) rate;
1375 state->residual = rate - ((gauge_t) state->last_value.counter);
1376 }
1377 else if (ds_type == DS_TYPE_ABSOLUTE)
1378 {
1379 state->last_value.absolute = (absolute_t) rate;
1380 state->residual = rate - ((gauge_t) state->last_value.absolute);
1381 }
1382 else
1383 {
1384 assert (23 == 42);
1385 }
1387 state->last_time = t;
1388 return (EAGAIN);
1389 } /* }}} */
1391 if (ds_type == DS_TYPE_DERIVE)
1392 {
1393 derive_t delta_derive = (derive_t) delta_gauge;
1395 state->last_value.derive += delta_derive;
1396 state->residual = delta_gauge - ((gauge_t) delta_derive);
1397 }
1398 else if (ds_type == DS_TYPE_COUNTER)
1399 {
1400 counter_t delta_counter = (counter_t) delta_gauge;
1402 state->last_value.counter += delta_counter;
1403 state->residual = delta_gauge - ((gauge_t) delta_counter);
1404 }
1405 else if (ds_type == DS_TYPE_ABSOLUTE)
1406 {
1407 absolute_t delta_absolute = (absolute_t) delta_gauge;
1409 state->last_value.absolute = delta_absolute;
1410 state->residual = delta_gauge - ((gauge_t) delta_absolute);
1411 }
1412 else
1413 {
1414 assert (23 == 42);
1415 }
1417 state->last_time = t;
1418 *ret_value = state->last_value;
1419 return (0);
1420 } /* }}} value_t rate_to_value */
1422 int service_name_to_port_number (const char *service_name)
1423 {
1424 struct addrinfo *ai_list;
1425 struct addrinfo *ai_ptr;
1426 struct addrinfo ai_hints;
1427 int status;
1428 int service_number;
1430 if (service_name == NULL)
1431 return (-1);
1433 ai_list = NULL;
1434 memset (&ai_hints, 0, sizeof (ai_hints));
1435 ai_hints.ai_family = AF_UNSPEC;
1437 status = getaddrinfo (/* node = */ NULL, service_name,
1438 &ai_hints, &ai_list);
1439 if (status != 0)
1440 {
1441 ERROR ("service_name_to_port_number: getaddrinfo failed: %s",
1442 gai_strerror (status));
1443 return (-1);
1444 }
1446 service_number = -1;
1447 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
1448 {
1449 if (ai_ptr->ai_family == AF_INET)
1450 {
1451 struct sockaddr_in *sa;
1453 sa = (void *) ai_ptr->ai_addr;
1454 service_number = (int) ntohs (sa->sin_port);
1455 }
1456 else if (ai_ptr->ai_family == AF_INET6)
1457 {
1458 struct sockaddr_in6 *sa;
1460 sa = (void *) ai_ptr->ai_addr;
1461 service_number = (int) ntohs (sa->sin6_port);
1462 }
1464 if ((service_number > 0) && (service_number <= 65535))
1465 break;
1466 }
1468 freeaddrinfo (ai_list);
1470 if ((service_number > 0) && (service_number <= 65535))
1471 return (service_number);
1472 return (-1);
1473 } /* int service_name_to_port_number */
1475 int strtoderive (const char *string, derive_t *ret_value) /* {{{ */
1476 {
1477 derive_t tmp;
1478 char *endptr;
1480 if ((string == NULL) || (ret_value == NULL))
1481 return (EINVAL);
1483 errno = 0;
1484 endptr = NULL;
1485 tmp = (derive_t) strtoll (string, &endptr, /* base = */ 0);
1486 if ((endptr == string) || (errno != 0))
1487 return (-1);
1489 *ret_value = tmp;
1490 return (0);
1491 } /* }}} int strtoderive */
1493 int strarray_add (char ***ret_array, size_t *ret_array_len, char const *str) /* {{{ */
1494 {
1495 char **array;
1496 size_t array_len = *ret_array_len;
1498 if (str == NULL)
1499 return (EINVAL);
1501 array = realloc (*ret_array,
1502 (array_len + 1) * sizeof (*array));
1503 if (array == NULL)
1504 return (ENOMEM);
1505 *ret_array = array;
1507 array[array_len] = strdup (str);
1508 if (array[array_len] == NULL)
1509 return (ENOMEM);
1511 array_len++;
1512 *ret_array_len = array_len;
1513 return (0);
1514 } /* }}} int strarray_add */
1516 void strarray_free (char **array, size_t array_len) /* {{{ */
1517 {
1518 size_t i;
1520 for (i = 0; i < array_len; i++)
1521 sfree (array[i]);
1522 sfree (array);
1523 } /* }}} void strarray_free */