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