2 * collectd - src/common.c
3 * Copyright (C) 2005-2007 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
20 * Niki W. Waibel <niki.waibel@gmx.net>
38 /* for ntohl and htonl */
40 # include <arpa/inet.h>
44 extern kstat_ctl_t *kc;
48 static pthread_mutex_t getpwnam_r_lock = PTHREAD_MUTEX_INITIALIZER;
51 void sstrncpy (char *d, const char *s, int len)
57 char *sstrdup (const char *s)
64 if((r = strdup (s)) == NULL)
66 DEBUG ("Not enough memory.");
73 /* Even though Posix requires "strerror_r" to return an "int",
74 * some systems (e.g. the GNU libc) return a "char *" _and_
75 * ignore the second argument ... -tokkee */
76 char *sstrerror (int errnum, char *buf, size_t buflen)
79 #ifdef STRERROR_R_CHAR_P
82 temp = strerror_r (errnum, buf, buflen);
85 strncpy (buf, temp, buflen);
86 buf[buflen - 1] = '\0';
90 strerror_r (errnum, buf, buflen);
91 #endif /* STRERROR_R_CHAR_P */
93 } /* char *sstrerror */
95 void *smalloc (size_t size)
99 if ((r = malloc (size)) == NULL)
101 DEBUG("Not enough memory.");
109 void sfree (void **ptr)
121 ssize_t sread (int fd, void *buf, size_t count)
132 status = read (fd, (void *) ptr, nleft);
134 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
142 DEBUG ("Received EOF from fd %i. "
143 "Closing fd and returning error.",
149 assert (nleft >= status);
151 nleft = nleft - status;
159 ssize_t swrite (int fd, const void *buf, size_t count)
165 ptr = (const char *) buf;
170 status = write (fd, (const void *) ptr, nleft);
172 if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
178 nleft = nleft - status;
185 int strsplit (char *string, char **fields, size_t size)
194 while ((fields[i] = strtok_r (ptr, " \t", &saveptr)) != NULL)
206 int strjoin (char *dst, size_t dst_len,
207 char **fields, size_t fields_num,
214 memset (dst, '\0', dst_len);
221 sep_len = strlen (sep);
223 for (i = 0; i < fields_num; i++)
225 if ((i > 0) && (sep_len > 0))
227 if (dst_len <= sep_len)
230 strncat (dst, sep, dst_len);
234 field_len = strlen (fields[i]);
236 if (dst_len <= field_len)
239 strncat (dst, fields[i], dst_len);
240 dst_len -= field_len;
243 return (strlen (dst));
246 int strsubstitute (char *str, char c_from, char c_to)
265 } /* int strsubstitute */
267 int escape_slashes (char *buf, int buf_len)
271 if (strcmp (buf, "/") == 0)
276 strncpy (buf, "root", buf_len);
283 /* Move one to the left */
285 memmove (buf, buf + 1, buf_len - 1);
287 for (i = 0; i < buf_len - 1; i++)
291 else if (buf[i] == '/')
297 } /* int escape_slashes */
299 int timeval_sub_timespec (struct timeval *tv0, struct timeval *tv1, struct timespec *ret)
301 if ((tv0 == NULL) || (tv1 == NULL) || (ret == NULL))
304 if ((tv0->tv_sec < tv1->tv_sec)
305 || ((tv0->tv_sec == tv1->tv_sec) && (tv0->tv_usec < tv1->tv_usec)))
308 ret->tv_sec = tv0->tv_sec - tv1->tv_sec;
309 ret->tv_nsec = 1000 * ((long) (tv0->tv_usec - tv1->tv_usec));
311 if (ret->tv_nsec < 0)
313 assert (ret->tv_sec > 0);
315 ret->tv_nsec += 1000000000;
322 int check_create_dir (const char *file_orig)
333 int last_is_file = 1;
334 int path_is_absolute = 0;
339 * Sanity checks first
341 if (file_orig == NULL)
344 if ((len = strlen (file_orig)) < 1)
350 * If `file_orig' ends in a slash the last component is a directory,
351 * otherwise it's a file. Act accordingly..
353 if (file_orig[len - 1] == '/')
355 if (file_orig[0] == '/')
356 path_is_absolute = 1;
359 * Create a copy for `strtok_r' to destroy
361 strncpy (file_copy, file_orig, 512);
362 file_copy[511] = '\0';
365 * Break into components. This will eat up several slashes in a row and
366 * remove leading and trailing slashes..
371 while ((fields[fields_num] = strtok_r (ptr, "/", &saveptr)) != NULL)
376 if (fields_num >= 16)
381 * For each component, do..
383 for (i = 0; i < (fields_num - last_is_file); i++)
386 * Do not create directories that start with a dot. This
387 * prevents `../../' attacks and other likely malicious
390 if (fields[i][0] == '.')
392 ERROR ("Cowardly refusing to create a directory that begins with a `.' (dot): `%s'", file_orig);
397 * Join the components together again
400 if (strjoin (dir + path_is_absolute, dir_len - path_is_absolute,
401 fields, i + 1, "/") < 0)
403 ERROR ("strjoin failed: `%s', component #%i", file_orig, i);
407 if (stat (dir, &statbuf) == -1)
411 if (mkdir (dir, 0755) == -1)
414 ERROR ("mkdir (%s): %s", dir,
416 errbuf, sizeof (errbuf)));
423 ERROR ("stat (%s): %s", dir,
424 sstrerror (errno, errbuf,
429 else if (!S_ISDIR (statbuf.st_mode))
431 ERROR ("stat (%s): Not a directory!", dir);
440 int get_kstat (kstat_t **ksp_ptr, char *module, int instance, char *name)
447 snprintf (ident, 128, "%s,%i,%s", module, instance, name);
450 if (*ksp_ptr == NULL)
452 if ((*ksp_ptr = kstat_lookup (kc, module, instance, name)) == NULL)
454 ERROR ("Cound not find kstat %s", ident);
458 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
460 WARNING ("kstat %s has wrong type", ident);
467 assert (*ksp_ptr != NULL);
468 assert ((*ksp_ptr)->ks_type == KSTAT_TYPE_NAMED);
471 if (kstat_read (kc, *ksp_ptr, NULL) == -1)
473 WARNING ("kstat %s could not be read", ident);
477 if ((*ksp_ptr)->ks_type != KSTAT_TYPE_NAMED)
479 WARNING ("kstat %s has wrong type", ident);
486 long long get_kstat_value (kstat_t *ksp, char *name)
489 long long retval = -1LL;
492 assert (ksp != NULL);
493 assert (ksp->ks_type == KSTAT_TYPE_NAMED);
497 fprintf (stderr, "ERROR: %s:%i: ksp == NULL\n", __FILE__, __LINE__);
500 else if (ksp->ks_type != KSTAT_TYPE_NAMED)
502 fprintf (stderr, "ERROR: %s:%i: ksp->ks_type != KSTAT_TYPE_NAMED\n", __FILE__, __LINE__);
507 if ((kn = (kstat_named_t *) kstat_data_lookup (ksp, name)) == NULL)
510 if (kn->data_type == KSTAT_DATA_INT32)
511 retval = (long long) kn->value.i32;
512 else if (kn->data_type == KSTAT_DATA_UINT32)
513 retval = (long long) kn->value.ui32;
514 else if (kn->data_type == KSTAT_DATA_INT64)
515 retval = (long long) kn->value.i64; /* According to ANSI C99 `long long' must hold at least 64 bits */
516 else if (kn->data_type == KSTAT_DATA_UINT64)
517 retval = (long long) kn->value.ui64; /* XXX: Might overflow! */
519 WARNING ("get_kstat_value: Not a numeric value: %s", name);
523 #endif /* HAVE_LIBKSTAT */
525 unsigned long long ntohll (unsigned long long n)
527 #if __BYTE_ORDER == __BIG_ENDIAN
530 return (((unsigned long long) ntohl (n)) << 32) + ntohl (n >> 32);
532 } /* unsigned long long ntohll */
534 unsigned long long htonll (unsigned long long n)
536 #if __BYTE_ORDER == __BIG_ENDIAN
539 return (((unsigned long long) htonl (n)) << 32) + htonl (n >> 32);
541 } /* unsigned long long htonll */
543 int format_name (char *ret, int ret_len,
544 const char *hostname,
545 const char *plugin, const char *plugin_instance,
546 const char *type, const char *type_instance)
550 assert (plugin != NULL);
551 assert (type != NULL);
553 if ((plugin_instance == NULL) || (strlen (plugin_instance) == 0))
555 if ((type_instance == NULL) || (strlen (type_instance) == 0))
556 status = snprintf (ret, ret_len, "%s/%s/%s",
557 hostname, plugin, type);
559 status = snprintf (ret, ret_len, "%s/%s/%s-%s",
560 hostname, plugin, type,
565 if ((type_instance == NULL) || (strlen (type_instance) == 0))
566 status = snprintf (ret, ret_len, "%s/%s-%s/%s",
567 hostname, plugin, plugin_instance,
570 status = snprintf (ret, ret_len, "%s/%s-%s/%s-%s",
571 hostname, plugin, plugin_instance,
572 type, type_instance);
575 if ((status < 1) || (status >= ret_len))
578 } /* int format_name */
580 int parse_identifier (char *str, char **ret_host,
581 char **ret_plugin, char **ret_plugin_instance,
582 char **ret_type, char **ret_type_instance)
584 char *hostname = NULL;
586 char *plugin_instance = NULL;
588 char *type_instance = NULL;
591 if (hostname == NULL)
594 plugin = strchr (hostname, '/');
597 *plugin = '\0'; plugin++;
599 type = strchr (plugin, '/');
602 *type = '\0'; type++;
604 plugin_instance = strchr (plugin, '-');
605 if (plugin_instance != NULL)
607 *plugin_instance = '\0';
611 type_instance = strchr (type, '-');
612 if (type_instance != NULL)
614 *type_instance = '\0';
618 *ret_host = hostname;
619 *ret_plugin = plugin;
620 *ret_plugin_instance = plugin_instance;
622 *ret_type_instance = type_instance;
624 } /* int parse_identifier */
626 int parse_values (char *buffer, value_list_t *vl, const data_set_t *ds)
636 while ((ptr = strtok_r (dummy, ":", &saveptr)) != NULL)
640 if (i >= vl->values_len)
645 if (strcmp ("N", ptr) == 0)
646 vl->time = time (NULL);
648 vl->time = (time_t) atoi (ptr);
652 if (strcmp ("U", ptr) == 0)
653 vl->values[i].gauge = NAN;
654 else if (ds->ds[i].type == DS_TYPE_COUNTER)
655 vl->values[i].counter = atoll (ptr);
656 else if (ds->ds[i].type == DS_TYPE_GAUGE)
657 vl->values[i].gauge = atof (ptr);
661 } /* while (strtok_r) */
663 if ((ptr != NULL) || (i != vl->values_len))
666 } /* int parse_values */
669 int getpwnam_r (const char *name, struct passwd *pwbuf, char *buf,
670 size_t buflen, struct passwd **pwbufp)
675 memset (pwbuf, '\0', sizeof (struct passwd));
677 pthread_mutex_lock (&getpwnam_r_lock);
681 pw = getpwnam (name);
684 status = (errno != 0) ? errno : ENOENT;
688 #define GETPWNAM_COPY_MEMBER(member) \
689 if (pw->member != NULL) \
691 int len = strlen (pw->member); \
697 sstrncpy (buf, pw->member, buflen); \
698 pwbuf->member = buf; \
700 buflen -= (len + 1); \
702 GETPWNAM_COPY_MEMBER(pw_name);
703 GETPWNAM_COPY_MEMBER(pw_passwd);
704 GETPWNAM_COPY_MEMBER(pw_gecos);
705 GETPWNAM_COPY_MEMBER(pw_dir);
706 GETPWNAM_COPY_MEMBER(pw_shell);
708 pwbuf->pw_uid = pw->pw_uid;
709 pwbuf->pw_gid = pw->pw_gid;
715 pthread_mutex_unlock (&getpwnam_r_lock);
718 } /* int getpwnam_r */