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