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 a callback
 330  */
 331 void dump_data_cb(const uint8_t *buf, int len,
 332                   bool omit_zero_bytes,
 333                   void (*cb)(const char *buf, void *private_data),
 334                   void *private_data)
 335 {
 336         int i=0;
 337         static const uint8_t empty[16] = { 0, };
 338         bool skipped = false;
 339         char tmp[16];
 340
 341         if (len<=0) return;
 342
 343         for (i=0;i<len;) {
 344
 345                 if (i%16 == 0) {
 346                         if ((omit_zero_bytes == true) &&
 347                             (i > 0) &&
 348                             (len > i+16) &&
 349                             (memcmp(&buf[i], &empty, 16) == 0))
 350                         {
 351                                 i +=16;
 352                                 continue;
 353                         }
 354
 355                         if (i<len)  {
 356                                 snprintf(tmp, sizeof(tmp), "[%04X] ", i);
 357                                 cb(tmp, private_data);
 358                         }
 359                 }
 360
 361                 snprintf(tmp, sizeof(tmp), "%02X ", (int)buf[i]);
 362                 cb(tmp, private_data);
 363                 i++;
 364                 if (i%8 == 0) {
 365                         cb("  ", private_data);
 366                 }
 367                 if (i%16 == 0) {
 368
 369                         print_asc_cb(&buf[i-16], 8, cb, private_data);
 370                         cb(" ", private_data);
 371                         print_asc_cb(&buf[i-8], 8, cb, private_data);
 372                         cb("\n", private_data);
 373
 374                         if ((omit_zero_bytes == true) &&
 375                             (len > i+16) &&
 376                             (memcmp(&buf[i], &empty, 16) == 0)) {
 377                                 if (!skipped) {
 378                                         cb("skipping zero buffer bytes\n",
 379                                            private_data);
 380                                         skipped = true;
 381                                 }
 382                         }
 383                 }
 384         }
 385
 386         if (i%16) {
 387                 int n;
 388                 n = 16 - (i%16);
 389                 cb(" ", private_data);
 390                 if (n>8) {
 391                         cb(" ", private_data);
 392                 }
 393                 while (n--) {
 394                         cb("   ", private_data);
 395                 }
 396                 n = MIN(8,i%16);
 397                 print_asc_cb(&buf[i-(i%16)], n, cb, private_data);
 398                 cb(" ", private_data);
 399                 n = (i%16) - n;
 400                 if (n>0) {
 401                         print_asc_cb(&buf[i-n], n, cb, private_data);
 402                 }
 403                 cb("\n", private_data);
 404         }
 405
 406 }
 407
 408 /**
 409  * Write dump of binary data to the log file.
 410  *
 411  * The data is only written if the log level is at least level.
 412  */
 413 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
 414 {
 415         if (!DEBUGLVL(level)) {
 416                 return;
 417         }
 418         dump_data_cb(buf, len, false, debugadd_cb, &level);
 419 }
 420
 421 /**
 422  * Write dump of binary data to the log file.
 423  *
 424  * The data is only written if the log level is at least level.
 425  * 16 zero bytes in a row are omitted
 426  */
 427 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
 428 {
 429         if (!DEBUGLVL(level)) {
 430                 return;
 431         }
 432         dump_data_cb(buf, len, true, debugadd_cb, &level);
 433 }
 434
 435
 436 /**
 437  malloc that aborts with smb_panic on fail or zero size.
 438 **/
 439
 440 _PUBLIC_ void *smb_xmalloc(size_t size)
 441 {
 442         void *p;
 443         if (size == 0)
 444                 smb_panic("smb_xmalloc: called with zero size.\n");
 445         if ((p = malloc(size)) == NULL)
 446                 smb_panic("smb_xmalloc: malloc fail.\n");
 447         return p;
 448 }
 449
 450 /**
 451  Memdup with smb_panic on fail.
 452 **/
 453
 454 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
 455 {
 456         void *p2;
 457         p2 = smb_xmalloc(size);
 458         memcpy(p2, p, size);
 459         return p2;
 460 }
 461
 462 /**
 463  strdup that aborts on malloc fail.
 464 **/
 465
 466 char *smb_xstrdup(const char *s)
 467 {
 468 #if defined(PARANOID_MALLOC_CHECKER)
 469 #ifdef strdup
 470 #undef strdup
 471 #endif
 472 #endif
 473
 474 #ifndef HAVE_STRDUP
 475 #define strdup rep_strdup
 476 #endif
 477
 478         char *s1 = strdup(s);
 479 #if defined(PARANOID_MALLOC_CHECKER)
 480 #ifdef strdup
 481 #undef strdup
 482 #endif
 483 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 484 #endif
 485         if (!s1) {
 486                 smb_panic("smb_xstrdup: malloc failed");
 487         }
 488         return s1;
 489
 490 }
 491
 492 /**
 493  strndup that aborts on malloc fail.
 494 **/
 495
 496 char *smb_xstrndup(const char *s, size_t n)
 497 {
 498 #if defined(PARANOID_MALLOC_CHECKER)
 499 #ifdef strndup
 500 #undef strndup
 501 #endif
 502 #endif
 503
 504 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 505 #undef HAVE_STRNDUP
 506 #define strndup rep_strndup
 507 #endif
 508
 509         char *s1 = strndup(s, n);
 510 #if defined(PARANOID_MALLOC_CHECKER)
 511 #ifdef strndup
 512 #undef strndup
 513 #endif
 514 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 515 #endif
 516         if (!s1) {
 517                 smb_panic("smb_xstrndup: malloc failed");
 518         }
 519         return s1;
 520 }
 521
 522
 523
 524 /**
 525  Like strdup but for memory.
 526 **/
 527
 528 _PUBLIC_ void *memdup(const void *p, size_t size)
 529 {
 530         void *p2;
 531         if (size == 0)
 532                 return NULL;
 533         p2 = malloc(size);
 534         if (!p2)
 535                 return NULL;
 536         memcpy(p2, p, size);
 537         return p2;
 538 }
 539
 540 /**
 541  * Write a password to the log file.
 542  *
 543  * @note Only actually does something if DEBUG_PASSWORD was defined during
 544  * compile-time.
 545  */
 546 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
 547 {
 548 #ifdef DEBUG_PASSWORD
 549         DEBUG(11, ("%s", msg));
 550         if (data != NULL && len > 0)
 551         {
 552                 dump_data(11, data, len);
 553         }
 554 #endif
 555 }
 556
 557
 558 /**
 559  * see if a range of memory is all zero. A NULL pointer is considered
 560  * to be all zero
 561  */
 562 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
 563 {
 564         int i;
 565         if (!ptr) return true;
 566         for (i=0;i<size;i++) {
 567                 if (ptr[i]) return false;
 568         }
 569         return true;
 570 }
 571
 572 /**
 573   realloc an array, checking for integer overflow in the array size
 574 */
 575 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
 576 {
 577 #define MAX_MALLOC_SIZE 0x7fffffff
 578         if (count == 0 ||
 579             count >= MAX_MALLOC_SIZE/el_size) {
 580                 if (free_on_fail)
 581                         SAFE_FREE(ptr);
 582                 return NULL;
 583         }
 584         if (!ptr) {
 585                 return malloc(el_size * count);
 586         }
 587         return realloc(ptr, el_size * count);
 588 }
 589
 590 /****************************************************************************
 591  Type-safe malloc.
 592 ****************************************************************************/
 593
 594 void *malloc_array(size_t el_size, unsigned int count)
 595 {
 596         return realloc_array(NULL, el_size, count, false);
 597 }
 598
 599 /**
 600  Trim the specified elements off the front and back of a string.
 601 **/
 602 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
 603 {
 604         bool ret = false;
 605         size_t front_len;
 606         size_t back_len;
 607         size_t len;
 608
 609         /* Ignore null or empty strings. */
 610         if (!s || (s[0] == '\0'))
 611                 return false;
 612
 613         front_len       = front? strlen(front) : 0;
 614         back_len        = back? strlen(back) : 0;
 615
 616         len = strlen(s);
 617
 618         if (front_len) {
 619                 while (len && strncmp(s, front, front_len)==0) {
 620                         /* Must use memmove here as src & dest can
 621                          * easily overlap. Found by valgrind. JRA. */
 622                         memmove(s, s+front_len, (len-front_len)+1);
 623                         len -= front_len;
 624                         ret=true;
 625                 }
 626         }
 627
 628         if (back_len) {
 629                 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
 630                         s[len-back_len]='\0';
 631                         len -= back_len;
 632                         ret=true;
 633                 }
 634         }
 635         return ret;
 636 }
 637
 638 /**
 639  Find the number of 'c' chars in a string
 640 **/
 641 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
 642 {
 643         size_t count = 0;
 644
 645         while (*s) {
 646                 if (*s == c) count++;
 647                 s ++;
 648         }
 649
 650         return count;
 651 }
 652
 653 /**
 654  Routine to get hex characters and turn them into a 16 byte array.
 655  the array can be variable length, and any non-hex-numeric
 656  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 657  for.
 658
 659  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 660
 661
 662 **/
 663 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
 664 {
 665         size_t i = 0;
 666         size_t num_chars = 0;
 667         uint8_t   lonybble, hinybble;
 668         const char     *hexchars = "0123456789ABCDEF";
 669         char           *p1 = NULL, *p2 = NULL;
 670
 671         /* skip leading 0x prefix */
 672         if (strncasecmp(strhex, "0x", 2) == 0) {
 673                 i += 2; /* skip two chars */
 674         }
 675
 676         for (; i < strhex_len && strhex[i] != 0; i++) {
 677                 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
 678                         break;
 679
 680                 i++; /* next hex digit */
 681
 682                 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
 683                         break;
 684
 685                 /* get the two nybbles */
 686                 hinybble = PTR_DIFF(p1, hexchars);
 687                 lonybble = PTR_DIFF(p2, hexchars);
 688
 689                 if (num_chars >= p_len) {
 690                         break;
 691                 }
 692
 693                 p[num_chars] = (hinybble << 4) | lonybble;
 694                 num_chars++;
 695
 696                 p1 = NULL;
 697                 p2 = NULL;
 698         }
 699         return num_chars;
 700 }
 701
 702 /**
 703  * Parse a hex string and return a data blob.
 704  */
 705 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
 706 {
 707         DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
 708
 709         ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
 710                                         strhex,
 711                                         strlen(strhex));
 712
 713         return ret_blob;
 714 }
 715
 716
 717 /**
 718  * Routine to print a buffer as HEX digits, into an allocated string.
 719  */
 720 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
 721 {
 722         int i;
 723         char *hex_buffer;
 724
 725         *out_hex_buffer = malloc_array_p(char, (len*2)+1);
 726         hex_buffer = *out_hex_buffer;
 727
 728         for (i = 0; i < len; i++)
 729                 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
 730 }
 731
 732 /**
 733  * talloc version of hex_encode()
 734  */
 735 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
 736 {
 737         int i;
 738         char *hex_buffer;
 739
 740         hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
 741         if (!hex_buffer) {
 742                 return NULL;
 743         }
 744
 745         for (i = 0; i < len; i++)
 746                 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
 747
 748         talloc_set_name_const(hex_buffer, hex_buffer);
 749         return hex_buffer;
 750 }
 751
 752 /**
 753   varient of strcmp() that handles NULL ptrs
 754 **/
 755 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
 756 {
 757         if (s1 == s2) {
 758                 return 0;
 759         }
 760         if (s1 == NULL || s2 == NULL) {
 761                 return s1?-1:1;
 762         }
 763         return strcmp(s1, s2);
 764 }
 765
 766
 767 /**
 768 return the number of bytes occupied by a buffer in ASCII format
 769 the result includes the null termination
 770 limited by 'n' bytes
 771 **/
 772 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
 773 {
 774         size_t len;
 775
 776         len = strnlen(src, n);
 777         if (len+1 <= n) {
 778                 len += 1;
 779         }
 780
 781         return len;
 782 }
 783
 784 /**
 785  Set a boolean variable from the text value stored in the passed string.
 786  Returns true in success, false if the passed string does not correctly
 787  represent a boolean.
 788 **/
 789
 790 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
 791 {
 792         if (strwicmp(boolean_string, "yes") == 0 ||
 793             strwicmp(boolean_string, "true") == 0 ||
 794             strwicmp(boolean_string, "on") == 0 ||
 795             strwicmp(boolean_string, "1") == 0) {
 796                 *boolean = true;
 797                 return true;
 798         } else if (strwicmp(boolean_string, "no") == 0 ||
 799                    strwicmp(boolean_string, "false") == 0 ||
 800                    strwicmp(boolean_string, "off") == 0 ||
 801                    strwicmp(boolean_string, "0") == 0) {
 802                 *boolean = false;
 803                 return true;
 804         }
 805         return false;
 806 }
 807
 808 /**
 809 return the number of bytes occupied by a buffer in CH_UTF16 format
 810 the result includes the null termination
 811 **/
 812 _PUBLIC_ size_t utf16_len(const void *buf)
 813 {
 814         size_t len;
 815
 816         for (len = 0; SVAL(buf,len); len += 2) ;
 817
 818         return len + 2;
 819 }
 820
 821 /**
 822 return the number of bytes occupied by a buffer in CH_UTF16 format
 823 the result includes the null termination
 824 limited by 'n' bytes
 825 **/
 826 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
 827 {
 828         size_t len;
 829
 830         for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
 831
 832         if (len+2 <= n) {
 833                 len += 2;
 834         }
 835
 836         return len;
 837 }
 838
 839 /**
 840  * @file
 841  * @brief String utilities.
 842  **/
 843
 844 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
 845                                 const char **ptr,
 846                                 char **pp_buff,
 847                                 const char *sep,
 848                                 bool ltrim)
 849 {
 850         const char *s;
 851         const char *saved_s;
 852         char *pbuf;
 853         bool quoted;
 854         size_t len=1;
 855
 856         *pp_buff = NULL;
 857         if (!ptr) {
 858                 return(false);
 859         }
 860
 861         s = *ptr;
 862
 863         /* default to simple separators */
 864         if (!sep) {
 865                 sep = " \t\n\r";
 866         }
 867
 868         /* find the first non sep char, if left-trimming is requested */
 869         if (ltrim) {
 870                 while (*s && strchr_m(sep,*s)) {
 871                         s++;
 872                 }
 873         }
 874
 875         /* nothing left? */
 876         if (!*s) {
 877                 return false;
 878         }
 879
 880         /* When restarting we need to go from here. */
 881         saved_s = s;
 882
 883         /* Work out the length needed. */
 884         for (quoted = false; *s &&
 885                         (quoted || !strchr_m(sep,*s)); s++) {
 886                 if (*s == '\"') {
 887                         quoted = !quoted;
 888                 } else {
 889                         len++;
 890                 }
 891         }
 892
 893         /* We started with len = 1 so we have space for the nul. */
 894         *pp_buff = talloc_array(ctx, char, len);
 895         if (!*pp_buff) {
 896                 return false;
 897         }
 898
 899         /* copy over the token */
 900         pbuf = *pp_buff;
 901         s = saved_s;
 902         for (quoted = false; *s &&
 903                         (quoted || !strchr_m(sep,*s)); s++) {
 904                 if ( *s == '\"' ) {
 905                         quoted = !quoted;
 906                 } else {
 907                         *pbuf++ = *s;
 908                 }
 909         }
 910
 911         *ptr = (*s) ? s+1 : s;
 912         *pbuf = 0;
 913
 914         return true;
 915 }
 916
 917 bool next_token_talloc(TALLOC_CTX *ctx,
 918                         const char **ptr,
 919                         char **pp_buff,
 920                         const char *sep)
 921 {
 922         return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
 923 }
 924
 925 /*
 926  * Get the next token from a string, return false if none found.  Handles
 927  * double-quotes.  This version does not trim leading separator characters
 928  * before looking for a token.
 929  */
 930
 931 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
 932                         const char **ptr,
 933                         char **pp_buff,
 934                         const char *sep)
 935 {
 936         return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
 937 }
 938
 939 /**
 940  * Get the next token from a string, return False if none found.
 941  * Handles double-quotes.
 942  *
 943  * Based on a routine by GJC@VILLAGE.COM.
 944  * Extensively modified by Andrew.Tridgell@anu.edu.au
 945  **/
 946 _PUBLIC_ bool next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
 947 {
 948         const char *s;
 949         bool quoted;
 950         size_t len=1;
 951
 952         if (!ptr)
 953                 return false;
 954
 955         s = *ptr;
 956
 957         /* default to simple separators */
 958         if (!sep)
 959                 sep = " \t\n\r";
 960
 961         /* find the first non sep char */
 962         while (*s && strchr_m(sep,*s))
 963                 s++;
 964
 965         /* nothing left? */
 966         if (!*s)
 967                 return false;
 968
 969         /* copy over the token */
 970         for (quoted = false; len < bufsize && *s && (quoted || !strchr_m(sep,*s)); s++) {
 971                 if (*s == '\"') {
 972                         quoted = !quoted;
 973                 } else {
 974                         len++;
 975                         *buff++ = *s;
 976                 }
 977         }
 978
 979         *ptr = (*s) ? s+1 : s;
 980         *buff = 0;
 981
 982         return true;
 983 }
 984
 985 struct anonymous_shared_header {
 986         union {
 987                 size_t length;
 988                 uint8_t pad[16];
 989         } u;
 990 };
 991
 992 /* Map a shared memory buffer of at least nelem counters. */
 993 void *anonymous_shared_allocate(size_t orig_bufsz)
 994 {
 995         void *ptr;
 996         void *buf;
 997         size_t pagesz = getpagesize();
 998         size_t pagecnt;
 999         size_t bufsz = orig_bufsz;
1000         struct anonymous_shared_header *hdr;
1001
1002         bufsz += sizeof(*hdr);
1003
1004         /* round up to full pages */
1005         pagecnt = bufsz / pagesz;
1006         if (bufsz % pagesz) {
1007                 pagecnt += 1;
1008         }
1009         bufsz = pagesz * pagecnt;
1010
1011         if (orig_bufsz >= bufsz) {
1012                 /* integer wrap */
1013                 errno = ENOMEM;
1014                 return NULL;
1015         }
1016
1017 #ifdef MAP_ANON
1018         /* BSD */
1019         buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED,
1020                         -1 /* fd */, 0 /* offset */);
1021 #else
1022         buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_FILE|MAP_SHARED,
1023                         open("/dev/zero", O_RDWR), 0 /* offset */);
1024 #endif
1025
1026         if (buf == MAP_FAILED) {
1027                 return NULL;
1028         }
1029
1030         hdr = (struct anonymous_shared_header *)buf;
1031         hdr->u.length = bufsz;
1032
1033         ptr = (void *)(&hdr[1]);
1034
1035         return ptr;
1036 }
1037
1038 void anonymous_shared_free(void *ptr)
1039 {
1040         struct anonymous_shared_header *hdr;
1041
1042         if (ptr == NULL) {
1043                 return;
1044         }
1045
1046         hdr = (struct anonymous_shared_header *)ptr;
1047
1048         hdr--;
1049
1050         munmap(hdr, hdr->u.length);
1051 }
1052
1053 #ifdef DEVELOPER
1054 /* used when you want a debugger started at a particular point in the
1055    code. Mostly useful in code that runs as a child process, where
1056    normal gdb attach is harder to organise.
1057 */
1058 void samba_start_debugger(void)
1059 {
1060         char *cmd = NULL;
1061         if (asprintf(&cmd, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
1062                 return;
1063         }
1064         if (system(cmd) == -1) {
1065                 free(cmd);
1066                 return;
1067         }
1068         free(cmd);
1069         sleep(2);
1070 }
1071 #endif