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