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