src/common.c

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