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