lib/util/util.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Andrew Tridgell 1992-1998
   5    Copyright (C) Jeremy Allison 2001-2002
   6    Copyright (C) Simo Sorce 2001-2011
   7    Copyright (C) Jim McDonough (jmcd@us.ibm.com)  2003.
   8    Copyright (C) James J Myers 2003
   9    Copyright (C) Volker Lendecke 2010
  10
  11    This program is free software; you can redistribute it and/or modify
  12    it under the terms of the GNU General Public License as published by
  13    the Free Software Foundation; either version 3 of the License, or
  14    (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19    GNU General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23 */
  24
  25 #include "includes.h"
  26 #include "system/network.h"
  27 #include "system/filesys.h"
  28 #include "system/locale.h"
  29 #include "system/shmem.h"
  30 #include "system/passwd.h"
  31
  32 #undef malloc
  33 #undef strcasecmp
  34 #undef strncasecmp
  35 #undef strdup
  36 #undef realloc
  37
  38 /**
  39  * @file
  40  * @brief Misc utility functions
  41  */
  42
  43 /**
  44  Find a suitable temporary directory. The result should be copied immediately
  45  as it may be overwritten by a subsequent call.
  46 **/
  47 _PUBLIC_ const char *tmpdir(void)
  48 {
  49         char *p;
  50         if ((p = getenv("TMPDIR")))
  51                 return p;
  52         return "/tmp";
  53 }
  54
  55
  56 /**
  57  Create a tmp file, open it and immediately unlink it.
  58  If dir is NULL uses tmpdir()
  59  Returns the file descriptor or -1 on error.
  60 **/
  61 int create_unlink_tmp(const char *dir)
  62 {
  63         char *fname;
  64         int fd;
  65
  66         if (!dir) {
  67                 dir = tmpdir();
  68         }
  69
  70         fname = talloc_asprintf(talloc_tos(), "%s/listenerlock_XXXXXX", dir);
  71         if (fname == NULL) {
  72                 errno = ENOMEM;
  73                 return -1;
  74         }
  75         fd = mkstemp(fname);
  76         if (fd == -1) {
  77                 TALLOC_FREE(fname);
  78                 return -1;
  79         }
  80         if (unlink(fname) == -1) {
  81                 int sys_errno = errno;
  82                 close(fd);
  83                 TALLOC_FREE(fname);
  84                 errno = sys_errno;
  85                 return -1;
  86         }
  87         TALLOC_FREE(fname);
  88         return fd;
  89 }
  90
  91
  92 /**
  93  Check if a file exists - call vfs_file_exist for samba files.
  94 **/
  95 _PUBLIC_ bool file_exist(const char *fname)
  96 {
  97         struct stat st;
  98
  99         if (stat(fname, &st) != 0) {
 100                 return false;
 101         }
 102
 103         return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
 104 }
 105
 106 /**
 107  Check a files mod time.
 108 **/
 109
 110 _PUBLIC_ time_t file_modtime(const char *fname)
 111 {
 112         struct stat st;
 113
 114         if (stat(fname,&st) != 0)
 115                 return(0);
 116
 117         return(st.st_mtime);
 118 }
 119
 120 /**
 121  Check if a directory exists.
 122 **/
 123
 124 _PUBLIC_ bool directory_exist(const char *dname)
 125 {
 126         struct stat st;
 127         bool ret;
 128
 129         if (stat(dname,&st) != 0) {
 130                 return false;
 131         }
 132
 133         ret = S_ISDIR(st.st_mode);
 134         if(!ret)
 135                 errno = ENOTDIR;
 136         return ret;
 137 }
 138
 139 /**
 140  * Try to create the specified directory if it didn't exist.
 141  *
 142  * @retval true if the directory already existed and has the right permissions
 143  * or was successfully created.
 144  */
 145 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
 146                                mode_t dir_perms)
 147 {
 148         mode_t old_umask;
 149         struct stat st;
 150
 151         old_umask = umask(0);
 152         if (lstat(dname, &st) == -1) {
 153                 if (errno == ENOENT) {
 154                         /* Create directory */
 155                         if (mkdir(dname, dir_perms) == -1) {
 156                                 DEBUG(0, ("mkdir failed on directory "
 157                                           "%s: %s\n", dname,
 158                                           strerror(errno)));
 159                                 umask(old_umask);
 160                                 return false;
 161                         }
 162                 } else {
 163                         DEBUG(0, ("lstat failed on directory %s: %s\n",
 164                                   dname, strerror(errno)));
 165                         umask(old_umask);
 166                         return false;
 167                 }
 168         } else {
 169                 /* Check ownership and permission on existing directory */
 170                 if (!S_ISDIR(st.st_mode)) {
 171                         DEBUG(0, ("directory %s isn't a directory\n",
 172                                 dname));
 173                         umask(old_umask);
 174                         return false;
 175                 }
 176                 if (st.st_uid != uid && !uwrap_enabled()) {
 177                         DEBUG(0, ("invalid ownership on directory "
 178                                   "%s\n", dname));
 179                         umask(old_umask);
 180                         return false;
 181                 }
 182                 if ((st.st_mode & 0777) != dir_perms) {
 183                         DEBUG(0, ("invalid permissions on directory "
 184                                   "'%s': has 0%o should be 0%o\n", dname,
 185                                   (st.st_mode & 0777), dir_perms));
 186                         umask(old_umask);
 187                         return false;
 188                 }
 189         }
 190         return true;
 191 }
 192
 193
 194 /**
 195  Sleep for a specified number of milliseconds.
 196 **/
 197
 198 _PUBLIC_ void smb_msleep(unsigned int t)
 199 {
 200 #if defined(HAVE_NANOSLEEP)
 201         struct timespec ts;
 202         int ret;
 203
 204         ts.tv_sec = t/1000;
 205         ts.tv_nsec = 1000000*(t%1000);
 206
 207         do {
 208                 errno = 0;
 209                 ret = nanosleep(&ts, &ts);
 210         } while (ret < 0 && errno == EINTR && (ts.tv_sec > 0 || ts.tv_nsec > 0));
 211 #else
 212         unsigned int tdiff=0;
 213         struct timeval tval,t1,t2;
 214         fd_set fds;
 215
 216         GetTimeOfDay(&t1);
 217         t2 = t1;
 218
 219         while (tdiff < t) {
 220                 tval.tv_sec = (t-tdiff)/1000;
 221                 tval.tv_usec = 1000*((t-tdiff)%1000);
 222
 223                 /* Never wait for more than 1 sec. */
 224                 if (tval.tv_sec > 1) {
 225                         tval.tv_sec = 1;
 226                         tval.tv_usec = 0;
 227                 }
 228
 229                 FD_ZERO(&fds);
 230                 errno = 0;
 231                 select(0,&fds,NULL,NULL,&tval);
 232
 233                 GetTimeOfDay(&t2);
 234                 if (t2.tv_sec < t1.tv_sec) {
 235                         /* Someone adjusted time... */
 236                         t1 = t2;
 237                 }
 238
 239                 tdiff = usec_time_diff(&t2,&t1)/1000;
 240         }
 241 #endif
 242 }
 243
 244 /**
 245  Get my own name, return in talloc'ed storage.
 246 **/
 247
 248 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
 249 {
 250         char *p;
 251         char hostname[HOST_NAME_MAX];
 252
 253         /* get my host name */
 254         if (gethostname(hostname, sizeof(hostname)) == -1) {
 255                 DEBUG(0,("gethostname failed\n"));
 256                 return NULL;
 257         }
 258
 259         /* Ensure null termination. */
 260         hostname[sizeof(hostname)-1] = '\0';
 261
 262         /* split off any parts after an initial . */
 263         p = strchr_m(hostname, '.');
 264         if (p) {
 265                 *p = 0;
 266         }
 267
 268         return talloc_strdup(ctx, hostname);
 269 }
 270
 271 /**
 272  Check if a process exists. Does this work on all unixes?
 273 **/
 274
 275 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
 276 {
 277         /* Doing kill with a non-positive pid causes messages to be
 278          * sent to places we don't want. */
 279         SMB_ASSERT(pid > 0);
 280         return(kill(pid,0) == 0 || errno != ESRCH);
 281 }
 282
 283 /**
 284  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
 285  is dealt with in posix.c
 286 **/
 287
 288 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
 289 {
 290         struct flock lock;
 291         int ret;
 292
 293         DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
 294
 295         lock.l_type = type;
 296         lock.l_whence = SEEK_SET;
 297         lock.l_start = offset;
 298         lock.l_len = count;
 299         lock.l_pid = 0;
 300
 301         ret = fcntl(fd,op,&lock);
 302
 303         if (ret == -1 && errno != 0)
 304                 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
 305
 306         /* a lock query */
 307         if (op == F_GETLK) {
 308                 if ((ret != -1) &&
 309                                 (lock.l_type != F_UNLCK) &&
 310                                 (lock.l_pid != 0) &&
 311                                 (lock.l_pid != getpid())) {
 312                         DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
 313                         return true;
 314                 }
 315
 316                 /* it must be not locked or locked by me */
 317                 return false;
 318         }
 319
 320         /* a lock set or unset */
 321         if (ret == -1) {
 322                 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
 323                         (double)offset,(double)count,op,type,strerror(errno)));
 324                 return false;
 325         }
 326
 327         /* everything went OK */
 328         DEBUG(8,("fcntl_lock: Lock call successful\n"));
 329
 330         return true;
 331 }
 332
 333 static void debugadd_cb(const char *buf, void *private_data)
 334 {
 335         int *plevel = (int *)private_data;
 336         DEBUGADD(*plevel, ("%s", buf));
 337 }
 338
 339 void print_asc_cb(const uint8_t *buf, int len,
 340                   void (*cb)(const char *buf, void *private_data),
 341                   void *private_data)
 342 {
 343         int i;
 344         char s[2];
 345         s[1] = 0;
 346
 347         for (i=0; i<len; i++) {
 348                 s[0] = isprint(buf[i]) ? buf[i] : '.';
 349                 cb(s, private_data);
 350         }
 351 }
 352
 353 void print_asc(int level, const uint8_t *buf,int len)
 354 {
 355         print_asc_cb(buf, len, debugadd_cb, &level);
 356 }
 357
 358 /**
 359  * Write dump of binary data to a callback
 360  */
 361 void dump_data_cb(const uint8_t *buf, int len,
 362                   bool omit_zero_bytes,
 363                   void (*cb)(const char *buf, void *private_data),
 364                   void *private_data)
 365 {
 366         int i=0;
 367         static const uint8_t empty[16] = { 0, };
 368         bool skipped = false;
 369         char tmp[16];
 370
 371         if (len<=0) return;
 372
 373         for (i=0;i<len;) {
 374
 375                 if (i%16 == 0) {
 376                         if ((omit_zero_bytes == true) &&
 377                             (i > 0) &&
 378                             (len > i+16) &&
 379                             (memcmp(&buf[i], &empty, 16) == 0))
 380                         {
 381                                 i +=16;
 382                                 continue;
 383                         }
 384
 385                         if (i<len)  {
 386                                 snprintf(tmp, sizeof(tmp), "[%04X] ", i);
 387                                 cb(tmp, private_data);
 388                         }
 389                 }
 390
 391                 snprintf(tmp, sizeof(tmp), "%02X ", (int)buf[i]);
 392                 cb(tmp, private_data);
 393                 i++;
 394                 if (i%8 == 0) {
 395                         cb("  ", private_data);
 396                 }
 397                 if (i%16 == 0) {
 398
 399                         print_asc_cb(&buf[i-16], 8, cb, private_data);
 400                         cb(" ", private_data);
 401                         print_asc_cb(&buf[i-8], 8, cb, private_data);
 402                         cb("\n", private_data);
 403
 404                         if ((omit_zero_bytes == true) &&
 405                             (len > i+16) &&
 406                             (memcmp(&buf[i], &empty, 16) == 0)) {
 407                                 if (!skipped) {
 408                                         cb("skipping zero buffer bytes\n",
 409                                            private_data);
 410                                         skipped = true;
 411                                 }
 412                         }
 413                 }
 414         }
 415
 416         if (i%16) {
 417                 int n;
 418                 n = 16 - (i%16);
 419                 cb(" ", private_data);
 420                 if (n>8) {
 421                         cb(" ", private_data);
 422                 }
 423                 while (n--) {
 424                         cb("   ", private_data);
 425                 }
 426                 n = MIN(8,i%16);
 427                 print_asc_cb(&buf[i-(i%16)], n, cb, private_data);
 428                 cb(" ", private_data);
 429                 n = (i%16) - n;
 430                 if (n>0) {
 431                         print_asc_cb(&buf[i-n], n, cb, private_data);
 432                 }
 433                 cb("\n", private_data);
 434         }
 435
 436 }
 437
 438 /**
 439  * Write dump of binary data to the log file.
 440  *
 441  * The data is only written if the log level is at least level.
 442  */
 443 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
 444 {
 445         if (!DEBUGLVL(level)) {
 446                 return;
 447         }
 448         dump_data_cb(buf, len, false, debugadd_cb, &level);
 449 }
 450
 451 /**
 452  * Write dump of binary data to the log file.
 453  *
 454  * The data is only written if the log level is at least level.
 455  * 16 zero bytes in a row are omitted
 456  */
 457 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
 458 {
 459         if (!DEBUGLVL(level)) {
 460                 return;
 461         }
 462         dump_data_cb(buf, len, true, debugadd_cb, &level);
 463 }
 464
 465 static void fprintf_cb(const char *buf, void *private_data)
 466 {
 467         FILE *f = (FILE *)private_data;
 468         fprintf(f, "%s", buf);
 469 }
 470
 471 void dump_data_file(const uint8_t *buf, int len, bool omit_zero_bytes,
 472                     FILE *f)
 473 {
 474         dump_data_cb(buf, len, omit_zero_bytes, fprintf_cb, f);
 475 }
 476
 477 /**
 478  malloc that aborts with smb_panic on fail or zero size.
 479 **/
 480
 481 _PUBLIC_ void *smb_xmalloc(size_t size)
 482 {
 483         void *p;
 484         if (size == 0)
 485                 smb_panic("smb_xmalloc: called with zero size.\n");
 486         if ((p = malloc(size)) == NULL)
 487                 smb_panic("smb_xmalloc: malloc fail.\n");
 488         return p;
 489 }
 490
 491 /**
 492  Memdup with smb_panic on fail.
 493 **/
 494
 495 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
 496 {
 497         void *p2;
 498         p2 = smb_xmalloc(size);
 499         memcpy(p2, p, size);
 500         return p2;
 501 }
 502
 503 /**
 504  strdup that aborts on malloc fail.
 505 **/
 506
 507 char *smb_xstrdup(const char *s)
 508 {
 509 #if defined(PARANOID_MALLOC_CHECKER)
 510 #ifdef strdup
 511 #undef strdup
 512 #endif
 513 #endif
 514
 515 #ifndef HAVE_STRDUP
 516 #define strdup rep_strdup
 517 #endif
 518
 519         char *s1 = strdup(s);
 520 #if defined(PARANOID_MALLOC_CHECKER)
 521 #ifdef strdup
 522 #undef strdup
 523 #endif
 524 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 525 #endif
 526         if (!s1) {
 527                 smb_panic("smb_xstrdup: malloc failed");
 528         }
 529         return s1;
 530
 531 }
 532
 533 /**
 534  strndup that aborts on malloc fail.
 535 **/
 536
 537 char *smb_xstrndup(const char *s, size_t n)
 538 {
 539 #if defined(PARANOID_MALLOC_CHECKER)
 540 #ifdef strndup
 541 #undef strndup
 542 #endif
 543 #endif
 544
 545 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 546 #undef HAVE_STRNDUP
 547 #define strndup rep_strndup
 548 #endif
 549
 550         char *s1 = strndup(s, n);
 551 #if defined(PARANOID_MALLOC_CHECKER)
 552 #ifdef strndup
 553 #undef strndup
 554 #endif
 555 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 556 #endif
 557         if (!s1) {
 558                 smb_panic("smb_xstrndup: malloc failed");
 559         }
 560         return s1;
 561 }
 562
 563
 564
 565 /**
 566  Like strdup but for memory.
 567 **/
 568
 569 _PUBLIC_ void *memdup(const void *p, size_t size)
 570 {
 571         void *p2;
 572         if (size == 0)
 573                 return NULL;
 574         p2 = malloc(size);
 575         if (!p2)
 576                 return NULL;
 577         memcpy(p2, p, size);
 578         return p2;
 579 }
 580
 581 /**
 582  * Write a password to the log file.
 583  *
 584  * @note Only actually does something if DEBUG_PASSWORD was defined during
 585  * compile-time.
 586  */
 587 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
 588 {
 589 #ifdef DEBUG_PASSWORD
 590         DEBUG(11, ("%s", msg));
 591         if (data != NULL && len > 0)
 592         {
 593                 dump_data(11, data, len);
 594         }
 595 #endif
 596 }
 597
 598
 599 /**
 600  * see if a range of memory is all zero. A NULL pointer is considered
 601  * to be all zero
 602  */
 603 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
 604 {
 605         int i;
 606         if (!ptr) return true;
 607         for (i=0;i<size;i++) {
 608                 if (ptr[i]) return false;
 609         }
 610         return true;
 611 }
 612
 613 /**
 614   realloc an array, checking for integer overflow in the array size
 615 */
 616 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
 617 {
 618 #define MAX_MALLOC_SIZE 0x7fffffff
 619         if (count == 0 ||
 620             count >= MAX_MALLOC_SIZE/el_size) {
 621                 if (free_on_fail)
 622                         SAFE_FREE(ptr);
 623                 return NULL;
 624         }
 625         if (!ptr) {
 626                 return malloc(el_size * count);
 627         }
 628         return realloc(ptr, el_size * count);
 629 }
 630
 631 /****************************************************************************
 632  Type-safe malloc.
 633 ****************************************************************************/
 634
 635 void *malloc_array(size_t el_size, unsigned int count)
 636 {
 637         return realloc_array(NULL, el_size, count, false);
 638 }
 639
 640 /**
 641  Trim the specified elements off the front and back of a string.
 642 **/
 643 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
 644 {
 645         bool ret = false;
 646         size_t front_len;
 647         size_t back_len;
 648         size_t len;
 649
 650         /* Ignore null or empty strings. */
 651         if (!s || (s[0] == '\0'))
 652                 return false;
 653
 654         front_len       = front? strlen(front) : 0;
 655         back_len        = back? strlen(back) : 0;
 656
 657         len = strlen(s);
 658
 659         if (front_len) {
 660                 while (len && strncmp(s, front, front_len)==0) {
 661                         /* Must use memmove here as src & dest can
 662                          * easily overlap. Found by valgrind. JRA. */
 663                         memmove(s, s+front_len, (len-front_len)+1);
 664                         len -= front_len;
 665                         ret=true;
 666                 }
 667         }
 668
 669         if (back_len) {
 670                 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
 671                         s[len-back_len]='\0';
 672                         len -= back_len;
 673                         ret=true;
 674                 }
 675         }
 676         return ret;
 677 }
 678
 679 /**
 680  Find the number of 'c' chars in a string
 681 **/
 682 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
 683 {
 684         size_t count = 0;
 685
 686         while (*s) {
 687                 if (*s == c) count++;
 688                 s ++;
 689         }
 690
 691         return count;
 692 }
 693
 694 /**
 695  * Routine to get hex characters and turn them into a byte array.
 696  * the array can be variable length.
 697  * -  "0xnn" or "0Xnn" is specially catered for.
 698  * - The first non-hex-digit character (apart from possibly leading "0x"
 699  *   finishes the conversion and skips the rest of the input.
 700  * - A single hex-digit character at the end of the string is skipped.
 701  *
 702  * valid examples: "0A5D15"; "0x123456"
 703  */
 704 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
 705 {
 706         size_t i = 0;
 707         size_t num_chars = 0;
 708         uint8_t   lonybble, hinybble;
 709         const char     *hexchars = "0123456789ABCDEF";
 710         char           *p1 = NULL, *p2 = NULL;
 711
 712         /* skip leading 0x prefix */
 713         if (strncasecmp(strhex, "0x", 2) == 0) {
 714                 i += 2; /* skip two chars */
 715         }
 716
 717         for (; i+1 < strhex_len && strhex[i] != 0 && strhex[i+1] != 0; i++) {
 718                 p1 = strchr(hexchars, toupper((unsigned char)strhex[i]));
 719                 if (p1 == NULL) {
 720                         break;
 721                 }
 722
 723                 i++; /* next hex digit */
 724
 725                 p2 = strchr(hexchars, toupper((unsigned char)strhex[i]));
 726                 if (p2 == NULL) {
 727                         break;
 728                 }
 729
 730                 /* get the two nybbles */
 731                 hinybble = PTR_DIFF(p1, hexchars);
 732                 lonybble = PTR_DIFF(p2, hexchars);
 733
 734                 if (num_chars >= p_len) {
 735                         break;
 736                 }
 737
 738                 p[num_chars] = (hinybble << 4) | lonybble;
 739                 num_chars++;
 740
 741                 p1 = NULL;
 742                 p2 = NULL;
 743         }
 744         return num_chars;
 745 }
 746
 747 /**
 748  * Parse a hex string and return a data blob.
 749  */
 750 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
 751 {
 752         DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
 753
 754         ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
 755                                         strhex,
 756                                         strlen(strhex));
 757
 758         return ret_blob;
 759 }
 760
 761 /**
 762  * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
 763  */
 764 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen)
 765 {
 766         size_t i;
 767         for (i=0; i<srclen; i++) {
 768                 snprintf(dst + i*2, 3, "%02X", src[i]);
 769         }
 770         /*
 771          * Ensure 0-termination for 0-length buffers
 772          */
 773         dst[srclen*2] = '\0';
 774 }
 775
 776 /**
 777  * Routine to print a buffer as HEX digits, into an allocated string.
 778  */
 779 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
 780 {
 781         char *hex_buffer;
 782
 783         *out_hex_buffer = malloc_array_p(char, (len*2)+1);
 784         hex_buffer = *out_hex_buffer;
 785         hex_encode_buf(hex_buffer, buff_in, len);
 786 }
 787
 788 /**
 789  * talloc version of hex_encode()
 790  */
 791 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
 792 {
 793         char *hex_buffer;
 794
 795         hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
 796         if (!hex_buffer) {
 797                 return NULL;
 798         }
 799         hex_encode_buf(hex_buffer, buff_in, len);
 800         talloc_set_name_const(hex_buffer, hex_buffer);
 801         return hex_buffer;
 802 }
 803
 804 /**
 805   varient of strcmp() that handles NULL ptrs
 806 **/
 807 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
 808 {
 809         if (s1 == s2) {
 810                 return 0;
 811         }
 812         if (s1 == NULL || s2 == NULL) {
 813                 return s1?-1:1;
 814         }
 815         return strcmp(s1, s2);
 816 }
 817
 818
 819 /**
 820 return the number of bytes occupied by a buffer in ASCII format
 821 the result includes the null termination
 822 limited by 'n' bytes
 823 **/
 824 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
 825 {
 826         size_t len;
 827
 828         len = strnlen(src, n);
 829         if (len+1 <= n) {
 830                 len += 1;
 831         }
 832
 833         return len;
 834 }
 835
 836 /**
 837  Set a boolean variable from the text value stored in the passed string.
 838  Returns true in success, false if the passed string does not correctly
 839  represent a boolean.
 840 **/
 841
 842 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
 843 {
 844         if (strwicmp(boolean_string, "yes") == 0 ||
 845             strwicmp(boolean_string, "true") == 0 ||
 846             strwicmp(boolean_string, "on") == 0 ||
 847             strwicmp(boolean_string, "1") == 0) {
 848                 *boolean = true;
 849                 return true;
 850         } else if (strwicmp(boolean_string, "no") == 0 ||
 851                    strwicmp(boolean_string, "false") == 0 ||
 852                    strwicmp(boolean_string, "off") == 0 ||
 853                    strwicmp(boolean_string, "0") == 0) {
 854                 *boolean = false;
 855                 return true;
 856         }
 857         return false;
 858 }
 859
 860 /**
 861 return the number of bytes occupied by a buffer in CH_UTF16 format
 862 the result includes the null termination
 863 **/
 864 _PUBLIC_ size_t utf16_len(const void *buf)
 865 {
 866         size_t len;
 867
 868         for (len = 0; SVAL(buf,len); len += 2) ;
 869
 870         return len + 2;
 871 }
 872
 873 /**
 874 return the number of bytes occupied by a buffer in CH_UTF16 format
 875 the result includes the null termination
 876 limited by 'n' bytes
 877 **/
 878 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
 879 {
 880         size_t len;
 881
 882         for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
 883
 884         if (len+2 <= n) {
 885                 len += 2;
 886         }
 887
 888         return len;
 889 }
 890
 891 /**
 892  * @file
 893  * @brief String utilities.
 894  **/
 895
 896 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
 897                                 const char **ptr,
 898                                 char **pp_buff,
 899                                 const char *sep,
 900                                 bool ltrim)
 901 {
 902         const char *s;
 903         const char *saved_s;
 904         char *pbuf;
 905         bool quoted;
 906         size_t len=1;
 907
 908         *pp_buff = NULL;
 909         if (!ptr) {
 910                 return(false);
 911         }
 912
 913         s = *ptr;
 914
 915         /* default to simple separators */
 916         if (!sep) {
 917                 sep = " \t\n\r";
 918         }
 919
 920         /* find the first non sep char, if left-trimming is requested */
 921         if (ltrim) {
 922                 while (*s && strchr_m(sep,*s)) {
 923                         s++;
 924                 }
 925         }
 926
 927         /* nothing left? */
 928         if (!*s) {
 929                 return false;
 930         }
 931
 932         /* When restarting we need to go from here. */
 933         saved_s = s;
 934
 935         /* Work out the length needed. */
 936         for (quoted = false; *s &&
 937                         (quoted || !strchr_m(sep,*s)); s++) {
 938                 if (*s == '\"') {
 939                         quoted = !quoted;
 940                 } else {
 941                         len++;
 942                 }
 943         }
 944
 945         /* We started with len = 1 so we have space for the nul. */
 946         *pp_buff = talloc_array(ctx, char, len);
 947         if (!*pp_buff) {
 948                 return false;
 949         }
 950
 951         /* copy over the token */
 952         pbuf = *pp_buff;
 953         s = saved_s;
 954         for (quoted = false; *s &&
 955                         (quoted || !strchr_m(sep,*s)); s++) {
 956                 if ( *s == '\"' ) {
 957                         quoted = !quoted;
 958                 } else {
 959                         *pbuf++ = *s;
 960                 }
 961         }
 962
 963         *ptr = (*s) ? s+1 : s;
 964         *pbuf = 0;
 965
 966         return true;
 967 }
 968
 969 bool next_token_talloc(TALLOC_CTX *ctx,
 970                         const char **ptr,
 971                         char **pp_buff,
 972                         const char *sep)
 973 {
 974         return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
 975 }
 976
 977 /*
 978  * Get the next token from a string, return false if none found.  Handles
 979  * double-quotes.  This version does not trim leading separator characters
 980  * before looking for a token.
 981  */
 982
 983 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
 984                         const char **ptr,
 985                         char **pp_buff,
 986                         const char *sep)
 987 {
 988         return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
 989 }
 990
 991 /**
 992  * Get the next token from a string, return False if none found.
 993  * Handles double-quotes.
 994  *
 995  * Based on a routine by GJC@VILLAGE.COM.
 996  * Extensively modified by Andrew.Tridgell@anu.edu.au
 997  **/
 998 _PUBLIC_ bool next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
 999 {
1000         const char *s;
1001         bool quoted;
1002         size_t len=1;
1003
1004         if (!ptr)
1005                 return false;
1006
1007         s = *ptr;
1008
1009         /* default to simple separators */
1010         if (!sep)
1011                 sep = " \t\n\r";
1012
1013         /* find the first non sep char */
1014         while (*s && strchr_m(sep,*s))
1015                 s++;
1016
1017         /* nothing left? */
1018         if (!*s)
1019                 return false;
1020
1021         /* copy over the token */
1022         for (quoted = false; len < bufsize && *s && (quoted || !strchr_m(sep,*s)); s++) {
1023                 if (*s == '\"') {
1024                         quoted = !quoted;
1025                 } else {
1026                         len++;
1027                         *buff++ = *s;
1028                 }
1029         }
1030
1031         *ptr = (*s) ? s+1 : s;
1032         *buff = 0;
1033
1034         return true;
1035 }
1036
1037 struct anonymous_shared_header {
1038         union {
1039                 size_t length;
1040                 uint8_t pad[16];
1041         } u;
1042 };
1043
1044 /* Map a shared memory buffer of at least nelem counters. */
1045 void *anonymous_shared_allocate(size_t orig_bufsz)
1046 {
1047         void *ptr;
1048         void *buf;
1049         size_t pagesz = getpagesize();
1050         size_t pagecnt;
1051         size_t bufsz = orig_bufsz;
1052         struct anonymous_shared_header *hdr;
1053
1054         bufsz += sizeof(*hdr);
1055
1056         /* round up to full pages */
1057         pagecnt = bufsz / pagesz;
1058         if (bufsz % pagesz) {
1059                 pagecnt += 1;
1060         }
1061         bufsz = pagesz * pagecnt;
1062
1063         if (orig_bufsz >= bufsz) {
1064                 /* integer wrap */
1065                 errno = ENOMEM;
1066                 return NULL;
1067         }
1068
1069 #ifdef MAP_ANON
1070         /* BSD */
1071         buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED,
1072                         -1 /* fd */, 0 /* offset */);
1073 #else
1074         buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_FILE|MAP_SHARED,
1075                         open("/dev/zero", O_RDWR), 0 /* offset */);
1076 #endif
1077
1078         if (buf == MAP_FAILED) {
1079                 return NULL;
1080         }
1081
1082         hdr = (struct anonymous_shared_header *)buf;
1083         hdr->u.length = bufsz;
1084
1085         ptr = (void *)(&hdr[1]);
1086
1087         return ptr;
1088 }
1089
1090 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove)
1091 {
1092 #ifdef HAVE_MREMAP
1093         void *buf;
1094         size_t pagesz = getpagesize();
1095         size_t pagecnt;
1096         size_t bufsz;
1097         struct anonymous_shared_header *hdr;
1098         int flags = 0;
1099
1100         if (ptr == NULL) {
1101                 errno = EINVAL;
1102                 return NULL;
1103         }
1104
1105         hdr = (struct anonymous_shared_header *)ptr;
1106         hdr--;
1107         if (hdr->u.length > (new_size + sizeof(*hdr))) {
1108                 errno = EINVAL;
1109                 return NULL;
1110         }
1111
1112         bufsz = new_size + sizeof(*hdr);
1113
1114         /* round up to full pages */
1115         pagecnt = bufsz / pagesz;
1116         if (bufsz % pagesz) {
1117                 pagecnt += 1;
1118         }
1119         bufsz = pagesz * pagecnt;
1120
1121         if (new_size >= bufsz) {
1122                 /* integer wrap */
1123                 errno = ENOSPC;
1124                 return NULL;
1125         }
1126
1127         if (bufsz <= hdr->u.length) {
1128                 return ptr;
1129         }
1130
1131         if (maymove) {
1132                 flags = MREMAP_MAYMOVE;
1133         }
1134
1135         buf = mremap(hdr, hdr->u.length, bufsz, flags);
1136
1137         if (buf == MAP_FAILED) {
1138                 errno = ENOSPC;
1139                 return NULL;
1140         }
1141
1142         hdr = (struct anonymous_shared_header *)buf;
1143         hdr->u.length = bufsz;
1144
1145         ptr = (void *)(&hdr[1]);
1146
1147         return ptr;
1148 #else
1149         errno = ENOSPC;
1150         return NULL;
1151 #endif
1152 }
1153
1154 void anonymous_shared_free(void *ptr)
1155 {
1156         struct anonymous_shared_header *hdr;
1157
1158         if (ptr == NULL) {
1159                 return;
1160         }
1161
1162         hdr = (struct anonymous_shared_header *)ptr;
1163
1164         hdr--;
1165
1166         munmap(hdr, hdr->u.length);
1167 }
1168
1169 #ifdef DEVELOPER
1170 /* used when you want a debugger started at a particular point in the
1171    code. Mostly useful in code that runs as a child process, where
1172    normal gdb attach is harder to organise.
1173 */
1174 void samba_start_debugger(void)
1175 {
1176         char *cmd = NULL;
1177         if (asprintf(&cmd, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
1178                 return;
1179         }
1180         if (system(cmd) == -1) {
1181                 free(cmd);
1182                 return;
1183         }
1184         free(cmd);
1185         sleep(2);
1186 }
1187 #endif