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