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
 208 /**
 209  Trim the specified elements off the front and back of a string.
 210 **/
 211 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
 212
 213 /**
 214  Find the number of 'c' chars in a string
 215 **/
 216 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
 217
 218 /**
 219  Safe string copy into a known length string. maxlength does not
 220  include the terminating zero.
 221 **/
 222 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
 223
 224 /**
 225  Safe string cat into a string. maxlength does not
 226  include the terminating zero.
 227 **/
 228 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
 229
 230 /**
 231  Routine to get hex characters and turn them into a 16 byte array.
 232  the array can be variable length, and any non-hex-numeric
 233  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 234  for.
 235
 236  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 237
 238
 239 **/
 240 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
 241
 242 /**
 243  * Parse a hex string and return a data blob.
 244  */
 245 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
 246
 247 /**
 248  * Routine to print a buffer as HEX digits, into an allocated string.
 249  */
 250 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
 251
 252 /**
 253  * talloc version of hex_encode()
 254  */
 255 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
 256
 257 /**
 258  Substitute a string for a pattern in another string. Make sure there is
 259  enough room!
 260
 261  This routine looks for pattern in s and replaces it with
 262  insert. It may do multiple replacements.
 263
 264  Any of " ; ' $ or ` in the insert string are replaced with _
 265  if len==0 then the string cannot be extended. This is different from the old
 266  use of len==0 which was for no length checks to be done.
 267 **/
 268 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
 269
 270
 271 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
 272                                 const char *pattern, const char *insert);
 273
 274 /**
 275  Similar to string_sub() but allows for any character to be substituted.
 276  Use with caution!
 277  if len==0 then the string cannot be extended. This is different from the old
 278  use of len==0 which was for no length checks to be done.
 279 **/
 280 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
 281
 282 /**
 283  Unescape a URL encoded string, in place.
 284 **/
 285 _PUBLIC_ void rfc1738_unescape(char *buf);
 286
 287 /**
 288   format a string into length-prefixed dotted domain format, as used in NBT
 289   and in some ADS structures
 290 **/
 291 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
 292
 293 /**
 294  * Add a string to an array of strings.
 295  *
 296  * num should be a pointer to an integer that holds the current
 297  * number of elements in strings. It will be updated by this function.
 298  */
 299 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
 300                          const char *str, const char ***strings, int *num);
 301
 302 /**
 303   varient of strcmp() that handles NULL ptrs
 304 **/
 305 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
 306
 307 /**
 308 return the number of bytes occupied by a buffer in ASCII format
 309 the result includes the null termination
 310 limited by 'n' bytes
 311 **/
 312 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
 313
 314 /**
 315  Set a boolean variable from the text value stored in the passed string.
 316  Returns true in success, false if the passed string does not correctly
 317  represent a boolean.
 318 **/
 319 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
 320
 321 /**
 322  * Parse a string containing a boolean value.
 323  *
 324  * val will be set to the read value.
 325  *
 326  * @retval true if a boolean value was parsed, false otherwise.
 327  */
 328 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
 329
 330 #if _SAMBA_BUILD_ == 4
 331 /**
 332  * Convert a size specification like 16K into an integral number of bytes.
 333  **/
 334 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
 335 #endif
 336
 337 /**
 338  * Parse a uint64_t value from a string
 339  *
 340  * val will be set to the value read.
 341  *
 342  * @retval true if parsing was successful, false otherwise
 343  */
 344 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
 345
 346 /**
 347 return the number of bytes occupied by a buffer in CH_UTF16 format
 348 the result includes the null termination
 349 **/
 350 _PUBLIC_ size_t utf16_len(const void *buf);
 351
 352 /**
 353 return the number of bytes occupied by a buffer in CH_UTF16 format
 354 the result includes the null termination
 355 limited by 'n' bytes
 356 **/
 357 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
 358 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
 359
 360 /**
 361 Do a case-insensitive, whitespace-ignoring string compare.
 362 **/
 363 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
 364
 365 /**
 366  String replace.
 367 **/
 368 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
 369
 370 /**
 371  * Compare 2 strings.
 372  *
 373  * @note The comparison is case-insensitive.
 374  **/
 375 _PUBLIC_ bool strequal(const char *s1, const char *s2);
 376
 377 /* The following definitions come from lib/util/util_strlist.c  */
 378
 379 /* separators for lists */
 380 #ifndef LIST_SEP
 381 #define LIST_SEP " \t,\n\r"
 382 #endif
 383
 384 /**
 385   build a null terminated list of strings from a input string and a
 386   separator list. The separator list must contain characters less than
 387   or equal to 0x2f for this to work correctly on multi-byte strings
 388 */
 389 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
 390
 391 /**
 392  * build a null terminated list of strings from an argv-like input string
 393  * Entries are seperated by spaces and can be enclosed by quotes.
 394  * Does NOT support escaping
 395  */
 396 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
 397
 398 /**
 399  * join a list back to one string
 400  */
 401 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
 402
 403 /** join a list back to one (shell-like) string; entries
 404  * seperated by spaces, using quotes where necessary */
 405 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
 406
 407 /**
 408   return the number of elements in a string list
 409 */
 410 _PUBLIC_ size_t str_list_length(const char * const *list);
 411
 412 /**
 413   copy a string list
 414 */
 415 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
 416
 417 /**
 418    Return true if all the elements of the list match exactly.
 419  */
 420 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
 421
 422 /**
 423   add an entry to a string list
 424 */
 425 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
 426
 427 /**
 428   remove an entry from a string list
 429 */
 430 _PUBLIC_ void str_list_remove(const char **list, const char *s);
 431
 432 /**
 433   return true if a string is in a list
 434 */
 435 _PUBLIC_ bool str_list_check(const char **list, const char *s);
 436
 437 /**
 438   return true if a string is in a list, case insensitively
 439 */
 440 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
 441
 442 /* The following definitions come from lib/util/util_file.c  */
 443
 444
 445 /**
 446 read a line from a file with possible \ continuation chars.
 447 Blanks at the start or end of a line are stripped.
 448 The string will be allocated if s2 is NULL
 449 **/
 450 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
 451
 452 /**
 453  * Read one line (data until next newline or eof) and allocate it
 454  */
 455 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
 456
 457 /**
 458 load a file into memory from a fd.
 459 **/
 460 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 461
 462
 463 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
 464
 465 /**
 466 load a file into memory
 467 **/
 468 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 469
 470 /**
 471 mmap (if possible) or read a file
 472 **/
 473 _PUBLIC_ void *map_file(const char *fname, size_t size);
 474
 475 /**
 476 load a file into memory and return an array of pointers to lines in the file
 477 must be freed with talloc_free().
 478 **/
 479 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 480
 481 /**
 482 load a fd into memory and return an array of pointers to lines in the file
 483 must be freed with talloc_free(). If convert is true calls unix_to_dos on
 484 the list.
 485 **/
 486 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 487
 488 /**
 489 take a list of lines and modify them to produce a list where \ continues
 490 a line
 491 **/
 492 _PUBLIC_ void file_lines_slashcont(char **lines);
 493
 494 /**
 495   save a lump of data into a file. Mostly used for debugging
 496 */
 497 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
 498 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 499 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 500 _PUBLIC_ bool large_file_support(const char *path);
 501
 502 /* The following definitions come from lib/util/util.c  */
 503
 504
 505 /**
 506  Find a suitable temporary directory. The result should be copied immediately
 507  as it may be overwritten by a subsequent call.
 508 **/
 509 _PUBLIC_ const char *tmpdir(void);
 510
 511 /**
 512  Check if a file exists - call vfs_file_exist for samba files.
 513 **/
 514 _PUBLIC_ bool file_exist(const char *fname);
 515
 516 /**
 517  Check a files mod time.
 518 **/
 519 _PUBLIC_ time_t file_modtime(const char *fname);
 520
 521 /**
 522  Check if a directory exists.
 523 **/
 524 _PUBLIC_ bool directory_exist(const char *dname);
 525
 526 /**
 527  * Try to create the specified directory if it didn't exist.
 528  *
 529  * @retval true if the directory already existed and has the right permissions
 530  * or was successfully created.
 531  */
 532 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
 533                                mode_t dir_perms);
 534
 535 /**
 536  Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
 537  else
 538   if SYSV use O_NDELAY
 539   if BSD use FNDELAY
 540 **/
 541 _PUBLIC_ int set_blocking(int fd, bool set);
 542
 543 /**
 544  Sleep for a specified number of milliseconds.
 545 **/
 546 _PUBLIC_ void msleep(unsigned int t);
 547
 548 /**
 549  Get my own name, return in talloc'ed storage.
 550 **/
 551 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
 552
 553 /**
 554  Return true if a string could be a pure IP address.
 555 **/
 556 _PUBLIC_ bool is_ipaddress(const char *str);
 557
 558 /**
 559  Interpret an internet address or name into an IP address in 4 byte form.
 560 **/
 561 _PUBLIC_ uint32_t interpret_addr(const char *str);
 562
 563 /**
 564  A convenient addition to interpret_addr().
 565 **/
 566 _PUBLIC_ struct in_addr interpret_addr2(const char *str);
 567
 568 /**
 569  Check if an IP is the 0.0.0.0.
 570 **/
 571 _PUBLIC_ bool is_zero_ip_v4(struct in_addr ip);
 572
 573 /**
 574  Are two IPs on the same subnet?
 575 **/
 576 _PUBLIC_ bool same_net_v4(struct in_addr ip1,struct in_addr ip2,struct in_addr mask);
 577
 578 _PUBLIC_ bool is_ipaddress_v4(const char *str);
 579
 580 /**
 581  Check if a process exists. Does this work on all unixes?
 582 **/
 583 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
 584
 585 /**
 586  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
 587  is dealt with in posix.c
 588 **/
 589 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
 590
 591 /**
 592  * Write dump of binary data to the log file.
 593  *
 594  * The data is only written if the log level is at least level.
 595  */
 596 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
 597
 598 /**
 599  * Write dump of binary data to the log file.
 600  *
 601  * The data is only written if the log level is at least level.
 602  * 16 zero bytes in a row are ommited
 603  */
 604 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
 605
 606 /**
 607  malloc that aborts with smb_panic on fail or zero size.
 608 **/
 609 _PUBLIC_ void *smb_xmalloc(size_t size);
 610
 611 /**
 612  Memdup with smb_panic on fail.
 613 **/
 614 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
 615
 616 /**
 617  strdup that aborts on malloc fail.
 618 **/
 619 _PUBLIC_ char *smb_xstrdup(const char *s);
 620
 621 char *smb_xstrndup(const char *s, size_t n);
 622
 623 /**
 624  Like strdup but for memory.
 625 **/
 626 _PUBLIC_ void *memdup(const void *p, size_t size);
 627
 628 /**
 629  * Write a password to the log file.
 630  *
 631  * @note Only actually does something if DEBUG_PASSWORD was defined during
 632  * compile-time.
 633  */
 634 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
 635
 636 /**
 637  * see if a range of memory is all zero. A NULL pointer is considered
 638  * to be all zero
 639  */
 640 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
 641
 642 /**
 643   realloc an array, checking for integer overflow in the array size
 644 */
 645 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
 646
 647 void *malloc_array(size_t el_size, unsigned int count);
 648
 649 /* The following definitions come from lib/util/fsusage.c  */
 650
 651
 652 /**
 653  * Retrieve amount of free disk space.
 654  * this does all of the system specific guff to get the free disk space.
 655  * It is derived from code in the GNU fileutils package, but has been
 656  * considerably mangled for use here
 657  *
 658  * results are returned in *dfree and *dsize, in 512 byte units
 659 */
 660 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
 661
 662 /* The following definitions come from lib/util/ms_fnmatch.c  */
 663
 664
 665 /**
 666  * @file
 667  * @brief MS-style Filename matching
 668  */
 669
 670 #if _SAMBA_BUILD_ == 4
 671 /* protocol types. It assumes that higher protocols include lower protocols
 672    as subsets. FIXME: Move to one of the smb-specific headers */
 673 enum protocol_types {
 674         PROTOCOL_NONE,
 675         PROTOCOL_CORE,
 676         PROTOCOL_COREPLUS,
 677         PROTOCOL_LANMAN1,
 678         PROTOCOL_LANMAN2,
 679         PROTOCOL_NT1,
 680         PROTOCOL_SMB2
 681 };
 682
 683 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
 684
 685 /** a generic fnmatch function - uses for non-CIFS pattern matching */
 686 int gen_fnmatch(const char *pattern, const char *string);
 687 #endif
 688
 689 /* The following definitions come from lib/util/mutex.c  */
 690
 691
 692 /**
 693   register a set of mutex/rwlock handlers.
 694   Should only be called once in the execution of smbd.
 695 */
 696 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
 697
 698 /* The following definitions come from lib/util/idtree.c  */
 699
 700
 701 /**
 702   initialise a idr tree. The context return value must be passed to
 703   all subsequent idr calls. To destroy the idr tree use talloc_free()
 704   on this context
 705  */
 706 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
 707
 708 /**
 709   allocate the next available id, and assign 'ptr' into its slot.
 710   you can retrieve later this pointer using idr_find()
 711 */
 712 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
 713
 714 /**
 715    allocate a new id, giving the first available value greater than or
 716    equal to the given starting id
 717 */
 718 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
 719
 720 /**
 721   allocate a new id randomly in the given range
 722 */
 723 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
 724
 725 /**
 726   find a pointer value previously set with idr_get_new given an id
 727 */
 728 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
 729
 730 /**
 731   remove an id from the idr tree
 732 */
 733 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
 734
 735 /* The following definitions come from lib/util/become_daemon.c  */
 736
 737 /**
 738  Close the low 3 fd's and open dev/null in their place
 739 **/
 740 _PUBLIC_ void close_low_fds(bool stderr_too);
 741
 742 /**
 743  Become a daemon, discarding the controlling terminal.
 744 **/
 745 _PUBLIC_ void become_daemon(bool do_fork, bool no_process_group);
 746
 747 /**
 748  * Load a ini-style file.
 749  */
 750 bool pm_process( const char *fileName,
 751                  bool (*sfunc)(const char *, void *),
 752                  bool (*pfunc)(const char *, const char *, void *),
 753                                  void *userdata);
 754
 755 /**
 756  * Add-on to talloc_get_type
 757  */
 758 _PUBLIC_ void *talloc_check_name_abort(const void *ptr, const char *name);
 759 #define talloc_get_type_abort(ptr, type) \
 760         (type *)talloc_check_name_abort(ptr, #type)
 761
 762 bool unmap_file(void *start, size_t size);
 763
 764 void print_asc(int level, const uint8_t *buf,int len);
 765
 766 #endif /* _SAMBA_UTIL_H_ */