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