lib/util/util.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Utility functions for Samba
   4    Copyright (C) Andrew Tridgell 1992-1999
   5    Copyright (C) Jelmer Vernooij 2005
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef _SAMBA_UTIL_H_
  22 #define _SAMBA_UTIL_H_
  23
  24 #if _SAMBA_BUILD_ == 4
  25 #include "../lib/util/charset/charset.h"
  26 #endif
  27 #include "../lib/util/attr.h"
  28
  29 /* for TALLOC_CTX */
  30 #include <talloc.h>
  31
  32 /**
  33  * @file
  34  * @brief Helpful macros
  35  */
  36
  37 struct smbsrv_tcon;
  38
  39 extern const char *logfile;
  40 extern const char *panic_action;
  41
  42 #include "../lib/util/time.h"
  43 #include "../lib/util/data_blob.h"
  44 #include "../lib/util/xfile.h"
  45 #include "../lib/util/byteorder.h"
  46 #include "../lib/util/talloc_stack.h"
  47
  48 /**
  49  * assert macros
  50  */
  51 #ifdef DEVELOPER
  52 #define SMB_ASSERT(b) do { if (!(b)) { \
  53         DEBUG(0,("PANIC: assert failed at %s(%d): %s\n", \
  54                  __FILE__, __LINE__, #b)); smb_panic("assert failed: " #b); }} while(0)
  55 #else
  56 /* redefine the assert macro for non-developer builds */
  57 #define SMB_ASSERT(b) do { if (!(b)) { \
  58         DEBUG(0,("PANIC: assert failed at %s(%d): %s\n", \
  59             __FILE__, __LINE__, #b)); }} while (0)
  60 #endif
  61
  62 #if _SAMBA_BUILD_ == 4
  63 #ifdef VALGRIND
  64 #define strlen(x) valgrind_strlen(x)
  65 size_t valgrind_strlen(const char *s);
  66 #endif
  67 #endif
  68
  69 #ifndef ABS
  70 #define ABS(a) ((a)>0?(a):(-(a)))
  71 #endif
  72
  73 #include "../lib/util/memory.h"
  74
  75 /**
  76  * Write backtrace to debug log
  77  */
  78 _PUBLIC_ void call_backtrace(void);
  79
  80 /**
  81  Something really nasty happened - panic !
  82 **/
  83 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
  84
  85 #if _SAMBA_BUILD_ == 4
  86 /**
  87 setup our fault handlers
  88 **/
  89 _PUBLIC_ void fault_setup(const char *pname);
  90 #endif
  91
  92 /**
  93   register a fault handler.
  94   Should only be called once in the execution of smbd.
  95 */
  96 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
  97
  98 /* The following definitions come from lib/util/signal.c  */
  99
 100
 101 /**
 102  Block sigs.
 103 **/
 104 void BlockSignals(bool block, int signum);
 105
 106 /**
 107  Catch a signal. This should implement the following semantics:
 108
 109  1) The handler remains installed after being called.
 110  2) The signal should be blocked during handler execution.
 111 **/
 112 void (*CatchSignal(int signum,void (*handler)(int )))(int);
 113
 114 /**
 115  Ignore SIGCLD via whatever means is necessary for this OS.
 116 **/
 117 void CatchChild(void);
 118
 119 /**
 120  Catch SIGCLD but leave the child around so it's status can be reaped.
 121 **/
 122 void CatchChildLeaveStatus(void);
 123
 124 /* The following definitions come from lib/util/system.c  */
 125
 126 /**************************************************************************
 127 A wrapper for gethostbyname() that tries avoids looking up hostnames
 128 in the root domain, which can cause dial-on-demand links to come up for no
 129 apparent reason.
 130 ****************************************************************************/
 131 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
 132 _PUBLIC_ struct in_addr sys_inet_makeaddr(int net, int host);
 133
 134 /**
 135  * Wrapper for fork used to invalid pid cache.
 136  **/
 137 _PUBLIC_ pid_t sys_fork(void);
 138
 139 /**
 140  * Wrapper for getpid. Ensures we only do a system call *once*.
 141  **/
 142 _PUBLIC_ pid_t sys_getpid(void);
 143
 144 /* The following definitions come from lib/util/genrand.c  */
 145
 146 /**
 147  Copy any user given reseed data.
 148 **/
 149 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
 150
 151 /**
 152  * Tell the random number generator it needs to reseed.
 153  */
 154 _PUBLIC_ void set_need_random_reseed(void);
 155
 156 /**
 157  Interface to the (hopefully) good crypto random number generator.
 158  Will use our internal PRNG if more than 40 bytes of random generation
 159  has been requested, otherwise tries to read from /dev/random
 160 **/
 161 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
 162
 163 /**
 164  Interface to the (hopefully) good crypto random number generator.
 165  Will always use /dev/urandom if available.
 166 **/
 167 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
 168
 169 /**
 170   generate a single random uint32_t
 171 **/
 172 _PUBLIC_ uint32_t generate_random(void);
 173
 174 /**
 175   very basic password quality checker
 176 **/
 177 _PUBLIC_ bool check_password_quality(const char *s);
 178
 179 /**
 180  * Generate a random text password.
 181  */
 182 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
 183
 184 /**
 185  Use the random number generator to generate a random string.
 186 **/
 187 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
 188
 189 /**
 190  * Generate a random text string consisting of the specified length.
 191  * The returned string will be allocated.
 192  *
 193  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 194  */
 195 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
 196
 197 /**
 198  * Generate an array of unique text strings all of the same length.
 199  * The returned strings will be allocated.
 200  * Returns NULL if the number of unique combinations cannot be created.
 201  *
 202  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 203  */
 204 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
 205                                          uint32_t num);
 206
 207 /* The following definitions come from lib/util/dprintf.c  */
 208 #if _SAMBA_BUILD_ == 4
 209
 210 _PUBLIC_ void d_set_iconv(smb_iconv_t);
 211 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 212 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 213 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
 214 _PUBLIC_ void display_set_stderr(void);
 215 #endif
 216
 217 /* The following definitions come from lib/util/util_str.c  */
 218
 219 bool next_token_talloc(TALLOC_CTX *ctx,
 220                         const char **ptr,
 221                         char **pp_buff,
 222                         const char *sep);
 223
 224 /**
 225  * Get the next token from a string, return false if none found.  Handles
 226  * double-quotes.  This version does not trim leading separator characters
 227  * before looking for a token.
 228  */
 229 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
 230                         const char **ptr,
 231                         char **pp_buff,
 232                         const char *sep);
 233
 234
 235 /**
 236  Trim the specified elements off the front and back of a string.
 237 **/
 238 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
 239
 240 /**
 241  Find the number of 'c' chars in a string
 242 **/
 243 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
 244
 245 /**
 246  Safe string copy into a known length string. maxlength does not
 247  include the terminating zero.
 248 **/
 249 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
 250
 251 /**
 252  Safe string cat into a string. maxlength does not
 253  include the terminating zero.
 254 **/
 255 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
 256
 257 /**
 258  Routine to get hex characters and turn them into a 16 byte array.
 259  the array can be variable length, and any non-hex-numeric
 260  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 261  for.
 262
 263  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 264
 265
 266 **/
 267 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
 268
 269 /**
 270  * Parse a hex string and return a data blob.
 271  */
 272 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
 273
 274 /**
 275  * Routine to print a buffer as HEX digits, into an allocated string.
 276  */
 277 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
 278
 279 /**
 280  * talloc version of hex_encode()
 281  */
 282 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
 283
 284 /**
 285  Substitute a string for a pattern in another string. Make sure there is
 286  enough room!
 287
 288  This routine looks for pattern in s and replaces it with
 289  insert. It may do multiple replacements.
 290
 291  Any of " ; ' $ or ` in the insert string are replaced with _
 292  if len==0 then the string cannot be extended. This is different from the old
 293  use of len==0 which was for no length checks to be done.
 294 **/
 295 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
 296
 297
 298 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
 299                                 const char *pattern, const char *insert);
 300
 301 /**
 302  Similar to string_sub() but allows for any character to be substituted.
 303  Use with caution!
 304  if len==0 then the string cannot be extended. This is different from the old
 305  use of len==0 which was for no length checks to be done.
 306 **/
 307 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
 308
 309 /**
 310  Unescape a URL encoded string, in place.
 311 **/
 312 _PUBLIC_ void rfc1738_unescape(char *buf);
 313
 314
 315 /**
 316  * rfc1738_escape
 317  * Returns a static buffer that contains the RFC
 318  * 1738 compliant, escaped version of the given url. (escapes unsafe and % characters)
 319  **/
 320 _PUBLIC_ char *rfc1738_escape(TALLOC_CTX *mem_ctx, const char *url);
 321
 322 /**
 323  * rfc1738_escape_unescaped
 324  *
 325  * Returns a static buffer that contains
 326  * the RFC 1738 compliant, escaped version of the given url (escapes unsafe chars only)
 327  **/
 328 _PUBLIC_ char *rfc1738_escape_unescaped(TALLOC_CTX *mem_ctx, const char *url);
 329
 330 /**
 331  * rfc1738_escape_part
 332  * Returns a static buffer that contains the RFC
 333  * 1738 compliant, escaped version of the given url segment. (escapes
 334  * unsafe, reserved and % chars) It would mangle the :// in http://,
 335  * and mangle paths (because of /).
 336  **/
 337 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
 338
 339 /**
 340   format a string into length-prefixed dotted domain format, as used in NBT
 341   and in some ADS structures
 342 **/
 343 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
 344
 345 /**
 346  * Add a string to an array of strings.
 347  *
 348  * num should be a pointer to an integer that holds the current
 349  * number of elements in strings. It will be updated by this function.
 350  */
 351 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
 352                          const char *str, const char ***strings, int *num);
 353
 354 /**
 355   varient of strcmp() that handles NULL ptrs
 356 **/
 357 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
 358
 359 /**
 360 return the number of bytes occupied by a buffer in ASCII format
 361 the result includes the null termination
 362 limited by 'n' bytes
 363 **/
 364 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
 365
 366 /**
 367  Set a boolean variable from the text value stored in the passed string.
 368  Returns true in success, false if the passed string does not correctly
 369  represent a boolean.
 370 **/
 371 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
 372
 373 /**
 374  * Parse a string containing a boolean value.
 375  *
 376  * val will be set to the read value.
 377  *
 378  * @retval true if a boolean value was parsed, false otherwise.
 379  */
 380 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
 381
 382 #if _SAMBA_BUILD_ == 4
 383 /**
 384  * Convert a size specification like 16K into an integral number of bytes.
 385  **/
 386 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
 387 #endif
 388
 389 /**
 390  * Parse a uint64_t value from a string
 391  *
 392  * val will be set to the value read.
 393  *
 394  * @retval true if parsing was successful, false otherwise
 395  */
 396 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
 397
 398 /**
 399 return the number of bytes occupied by a buffer in CH_UTF16 format
 400 the result includes the null termination
 401 **/
 402 _PUBLIC_ size_t utf16_len(const void *buf);
 403
 404 /**
 405 return the number of bytes occupied by a buffer in CH_UTF16 format
 406 the result includes the null termination
 407 limited by 'n' bytes
 408 **/
 409 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
 410 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
 411
 412 /**
 413 Do a case-insensitive, whitespace-ignoring string compare.
 414 **/
 415 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
 416
 417 /**
 418  String replace.
 419 **/
 420 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
 421
 422 /**
 423  * Compare 2 strings.
 424  *
 425  * @note The comparison is case-insensitive.
 426  **/
 427 _PUBLIC_ bool strequal(const char *s1, const char *s2);
 428
 429 /* The following definitions come from lib/util/util_strlist.c  */
 430
 431 /* separators for lists */
 432 #ifndef LIST_SEP
 433 #define LIST_SEP " \t,\n\r"
 434 #endif
 435
 436 /**
 437   build an empty (only NULL terminated) list of strings (for expansion with str_list_add() etc)
 438 */
 439 _PUBLIC_ char **str_list_make_empty(TALLOC_CTX *mem_ctx);
 440
 441 /**
 442   place the only element 'entry' into a new, NULL terminated string list
 443 */
 444 _PUBLIC_ char **str_list_make_single(TALLOC_CTX *mem_ctx,
 445         const char *entry);
 446
 447 /**
 448   build a null terminated list of strings from a input string and a
 449   separator list. The separator list must contain characters less than
 450   or equal to 0x2f for this to work correctly on multi-byte strings
 451 */
 452 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string,
 453         const char *sep);
 454
 455 /**
 456  * build a null terminated list of strings from an argv-like input string
 457  * Entries are separated by spaces and can be enclosed by quotes.
 458  * Does NOT support escaping
 459  */
 460 _PUBLIC_ char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
 461
 462 /**
 463  * join a list back to one string
 464  */
 465 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char separator);
 466
 467 /** join a list back to one (shell-like) string; entries
 468  * separated by spaces, using quotes where necessary */
 469 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
 470
 471 /**
 472   return the number of elements in a string list
 473 */
 474 _PUBLIC_ size_t str_list_length(const char * const *list);
 475
 476 /**
 477   copy a string list
 478 */
 479 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
 480
 481 /**
 482    Return true if all the elements of the list match exactly.
 483  */
 484 _PUBLIC_ bool str_list_equal(const char * const *list1, const char * const *list2);
 485
 486 /**
 487   add an entry to a string list
 488 */
 489 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
 490
 491 /**
 492   remove an entry from a string list
 493 */
 494 _PUBLIC_ void str_list_remove(const char **list, const char *s);
 495
 496 /**
 497   return true if a string is in a list
 498 */
 499 _PUBLIC_ bool str_list_check(const char **list, const char *s);
 500
 501 /**
 502   return true if a string is in a list, case insensitively
 503 */
 504 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
 505 /**
 506   append one list to another - expanding list1
 507 */
 508 _PUBLIC_ const char **str_list_append(const char **list1,
 509         const char * const *list2);
 510
 511 /**
 512  remove duplicate elements from a list
 513 */
 514 _PUBLIC_ const char **str_list_unique(const char **list);
 515
 516 /*
 517   very useful when debugging complex list related code
 518  */
 519 _PUBLIC_ void str_list_show(const char **list);
 520
 521
 522 /**
 523   append one list to another - expanding list1
 524   this assumes the elements of list2 are const pointers, so we can re-use them
 525 */
 526 _PUBLIC_ const char **str_list_append_const(const char **list1,
 527                                             const char **list2);
 528
 529 /**
 530   add an entry to a string list
 531   this assumes s will not change
 532 */
 533 _PUBLIC_ const char **str_list_add_const(const char **list, const char *s);
 534
 535 /**
 536   copy a string list
 537   this assumes list will not change
 538 */
 539 _PUBLIC_ const char **str_list_copy_const(TALLOC_CTX *mem_ctx,
 540                                           const char **list);
 541
 542 /**
 543  * Needed for making an "unconst" list "const"
 544  */
 545 _PUBLIC_ const char **const_str_list(char **list);
 546
 547
 548 /* The following definitions come from lib/util/util_file.c  */
 549
 550
 551 /**
 552 read a line from a file with possible \ continuation chars.
 553 Blanks at the start or end of a line are stripped.
 554 The string will be allocated if s2 is NULL
 555 **/
 556 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
 557
 558 /**
 559  * Read one line (data until next newline or eof) and allocate it
 560  */
 561 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
 562
 563 /**
 564 load a file into memory from a fd.
 565 **/
 566 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 567
 568
 569 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
 570
 571 /**
 572 load a file into memory
 573 **/
 574 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 575
 576 /**
 577 mmap (if possible) or read a file
 578 **/
 579 _PUBLIC_ void *map_file(const char *fname, size_t size);
 580
 581 /**
 582 load a file into memory and return an array of pointers to lines in the file
 583 must be freed with talloc_free().
 584 **/
 585 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 586
 587 /**
 588 load a fd into memory and return an array of pointers to lines in the file
 589 must be freed with talloc_free(). If convert is true calls unix_to_dos on
 590 the list.
 591 **/
 592 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 593
 594 /**
 595 take a list of lines and modify them to produce a list where \ continues
 596 a line
 597 **/
 598 _PUBLIC_ void file_lines_slashcont(char **lines);
 599
 600 /**
 601   save a lump of data into a file. Mostly used for debugging
 602 */
 603 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
 604 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 605 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 606 _PUBLIC_ bool large_file_support(const char *path);
 607
 608 /*
 609   compare two files, return true if the two files have the same content
 610  */
 611 bool file_compare(const char *path1, const char *path2);
 612
 613 /* The following definitions come from lib/util/util.c  */
 614
 615
 616 /**
 617  Find a suitable temporary directory. The result should be copied immediately
 618  as it may be overwritten by a subsequent call.
 619 **/
 620 _PUBLIC_ const char *tmpdir(void);
 621
 622 /**
 623  Check if a file exists - call vfs_file_exist for samba files.
 624 **/
 625 _PUBLIC_ bool file_exist(const char *fname);
 626
 627 /**
 628  Check a files mod time.
 629 **/
 630 _PUBLIC_ time_t file_modtime(const char *fname);
 631
 632 /**
 633  Check if a directory exists.
 634 **/
 635 _PUBLIC_ bool directory_exist(const char *dname);
 636
 637 /**
 638  * Try to create the specified directory if it didn't exist.
 639  *
 640  * @retval true if the directory already existed and has the right permissions
 641  * or was successfully created.
 642  */
 643 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
 644                                mode_t dir_perms);
 645
 646 /**
 647  Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
 648  else
 649   if SYSV use O_NDELAY
 650   if BSD use FNDELAY
 651 **/
 652 _PUBLIC_ int set_blocking(int fd, bool set);
 653
 654 /**
 655  Sleep for a specified number of milliseconds.
 656 **/
 657 _PUBLIC_ void smb_msleep(unsigned int t);
 658
 659 /**
 660  Get my own name, return in talloc'ed storage.
 661 **/
 662 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
 663
 664 /**
 665  Check if a process exists. Does this work on all unixes?
 666 **/
 667 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
 668
 669 /**
 670  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
 671  is dealt with in posix.c
 672 **/
 673 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
 674
 675 /**
 676  * Write dump of binary data to a callback
 677  */
 678 void dump_data_cb(const uint8_t *buf, int len,
 679                   bool omit_zero_bytes,
 680                   void (*cb)(const char *buf, void *private_data),
 681                   void *private_data);
 682
 683 /**
 684  * Write dump of binary data to the log file.
 685  *
 686  * The data is only written if the log level is at least level.
 687  */
 688 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
 689
 690 /**
 691  * Write dump of binary data to the log file.
 692  *
 693  * The data is only written if the log level is at least level.
 694  * 16 zero bytes in a row are omitted
 695  */
 696 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
 697
 698 /**
 699  malloc that aborts with smb_panic on fail or zero size.
 700 **/
 701 _PUBLIC_ void *smb_xmalloc(size_t size);
 702
 703 /**
 704  Memdup with smb_panic on fail.
 705 **/
 706 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
 707
 708 /**
 709  strdup that aborts on malloc fail.
 710 **/
 711 _PUBLIC_ char *smb_xstrdup(const char *s);
 712
 713 char *smb_xstrndup(const char *s, size_t n);
 714
 715 /**
 716  Like strdup but for memory.
 717 **/
 718 _PUBLIC_ void *memdup(const void *p, size_t size);
 719
 720 /**
 721  * Write a password to the log file.
 722  *
 723  * @note Only actually does something if DEBUG_PASSWORD was defined during
 724  * compile-time.
 725  */
 726 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
 727
 728 /**
 729  * see if a range of memory is all zero. A NULL pointer is considered
 730  * to be all zero
 731  */
 732 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
 733
 734 /**
 735   realloc an array, checking for integer overflow in the array size
 736 */
 737 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
 738
 739 void *malloc_array(size_t el_size, unsigned int count);
 740
 741 /* The following definitions come from lib/util/fsusage.c  */
 742
 743
 744 /**
 745  * Retrieve amount of free disk space.
 746  * this does all of the system specific guff to get the free disk space.
 747  * It is derived from code in the GNU fileutils package, but has been
 748  * considerably mangled for use here
 749  *
 750  * results are returned in *dfree and *dsize, in 512 byte units
 751 */
 752 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
 753
 754 /* The following definitions come from lib/util/ms_fnmatch.c  */
 755
 756
 757 /**
 758  * @file
 759  * @brief MS-style Filename matching
 760  */
 761
 762 #if _SAMBA_BUILD_ == 4
 763 /* protocol types. It assumes that higher protocols include lower protocols
 764    as subsets. FIXME: Move to one of the smb-specific headers */
 765 enum protocol_types {
 766         PROTOCOL_NONE,
 767         PROTOCOL_CORE,
 768         PROTOCOL_COREPLUS,
 769         PROTOCOL_LANMAN1,
 770         PROTOCOL_LANMAN2,
 771         PROTOCOL_NT1,
 772         PROTOCOL_SMB2
 773 };
 774
 775 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
 776
 777 /** a generic fnmatch function - uses for non-CIFS pattern matching */
 778 int gen_fnmatch(const char *pattern, const char *string);
 779 #endif
 780
 781 /* The following definitions come from lib/util/idtree.c  */
 782
 783
 784 /**
 785   initialise a idr tree. The context return value must be passed to
 786   all subsequent idr calls. To destroy the idr tree use talloc_free()
 787   on this context
 788  */
 789 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
 790
 791 /**
 792   allocate the next available id, and assign 'ptr' into its slot.
 793   you can retrieve later this pointer using idr_find()
 794 */
 795 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
 796
 797 /**
 798    allocate a new id, giving the first available value greater than or
 799    equal to the given starting id
 800 */
 801 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
 802
 803 /**
 804   allocate a new id randomly in the given range
 805 */
 806 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
 807
 808 /**
 809   find a pointer value previously set with idr_get_new given an id
 810 */
 811 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
 812
 813 /**
 814   remove an id from the idr tree
 815 */
 816 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
 817
 818 /* The following definitions come from lib/util/become_daemon.c  */
 819
 820 /**
 821  Close the low 3 fd's and open dev/null in their place
 822 **/
 823 _PUBLIC_ void close_low_fds(bool stderr_too);
 824
 825 /**
 826  Become a daemon, discarding the controlling terminal.
 827 **/
 828 _PUBLIC_ void become_daemon(bool do_fork, bool no_process_group, bool log_stdout);
 829
 830 /**
 831  * Load a ini-style file.
 832  */
 833 bool pm_process( const char *fileName,
 834                  bool (*sfunc)(const char *, void *),
 835                  bool (*pfunc)(const char *, const char *, void *),
 836                                  void *userdata);
 837
 838 bool unmap_file(void *start, size_t size);
 839
 840 void print_asc(int level, const uint8_t *buf,int len);
 841 void print_asc_cb(const uint8_t *buf, int len,
 842                   void (*cb)(const char *buf, void *private_data),
 843                   void *private_data);
 844
 845 /**
 846  * Add an id to an array of ids.
 847  *
 848  * num should be a pointer to an integer that holds the current
 849  * number of elements in ids. It will be updated by this function.
 850  */
 851
 852 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
 853                              uid_t **uids, size_t *num_uids);
 854 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
 855                              gid_t **gids, size_t *num_gids);
 856
 857 /**
 858  * Allocate anonymous shared memory of the given size
 859  */
 860 void *allocate_anonymous_shared(size_t bufsz);
 861
 862 /*
 863   run a command as a child process, with a timeout.
 864
 865   any stdout/stderr from the child will appear in the Samba logs with
 866   the specified log levels
 867
 868   If callback is set then the callback is called on completion
 869   with the return code from the command
 870  */
 871 struct tevent_context;
 872 struct tevent_req;
 873 struct tevent_req *samba_runcmd_send(TALLOC_CTX *mem_ctx,
 874                                      struct tevent_context *ev,
 875                                      struct timeval endtime,
 876                                      int stdout_log_level,
 877                                      int stderr_log_level,
 878                                      const char * const *argv0, ...);
 879 int samba_runcmd_recv(struct tevent_req *req, int *perrno);
 880
 881 #ifdef DEVELOPER
 882 void samba_start_debugger(void);
 883 #endif
 884
 885 #endif /* _SAMBA_UTIL_H_ */