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