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