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