src/common.c

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