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