src/utils/common/common.c

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