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