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