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