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