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 #ifndef SAMBA_UTIL_CORE_ONLY
  25 #include "lib/util/charset/charset.h"
  26 #else
  27 #include "charset_compat.h"
  28 #endif
  29
  30 #include "lib/util/attr.h"
  31
  32 /* for TALLOC_CTX */
  33 #include <talloc.h>
  34
  35 /* for struct stat */
  36 #include <sys/stat.h>
  37
  38 /**
  39  * @file
  40  * @brief Helpful macros
  41  */
  42
  43 struct smbsrv_tcon;
  44
  45 extern const char *panic_action;
  46
  47 #include "lib/util/time.h"
  48 #include "lib/util/data_blob.h"
  49 #include "lib/util/xfile.h"
  50 #include "lib/util/byteorder.h"
  51 #include "lib/util/talloc_stack.h"
  52
  53 #ifndef ABS
  54 #define ABS(a) ((a)>0?(a):(-(a)))
  55 #endif
  56
  57 #include "lib/util/memory.h"
  58
  59 #include "../libcli/util/ntstatus.h"
  60 #include "lib/util/string_wrappers.h"
  61
  62 #include "fault.h"
  63
  64 #include "lib/util/util.h"
  65
  66 /**
  67  * Write backtrace to debug log
  68  */
  69 _PUBLIC_ void call_backtrace(void);
  70
  71 _PUBLIC_ void dump_core_setup(const char *progname, const char *logfile);
  72
  73 /**
  74   register a fault handler.
  75   Should only be called once in the execution of smbd.
  76 */
  77 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
  78
  79 #include "lib/util/signal.h" /* Avoid /usr/include/signal.h */
  80
  81 struct sockaddr;
  82
  83 _PUBLIC_ int sys_getnameinfo(const struct sockaddr *psa,
  84                              int salen,
  85                              char *host,
  86                              size_t hostlen,
  87                              char *service,
  88                              size_t servlen,
  89                              int flags);
  90
  91 /* The following definitions come from lib/util/genrand.c  */
  92
  93 #include "lib/util/genrand.h"
  94
  95 /**
  96   generate a single random uint32_t
  97 **/
  98 _PUBLIC_ uint32_t generate_random(void);
  99
 100 /**
 101   very basic password quality checker
 102 **/
 103 _PUBLIC_ bool check_password_quality(const char *s);
 104
 105 /**
 106  * Generate a random text password.
 107  */
 108 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
 109
 110 /**
 111  Use the random number generator to generate a random string.
 112 **/
 113 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
 114
 115 /**
 116  * Generate a random text string consisting of the specified length.
 117  * The returned string will be allocated.
 118  *
 119  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 120  */
 121 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
 122
 123 /**
 124  * Generate an array of unique text strings all of the same length.
 125  * The returned strings will be allocated.
 126  * Returns NULL if the number of unique combinations cannot be created.
 127  *
 128  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
 129  */
 130 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
 131                                          uint32_t num);
 132
 133 /* The following definitions come from lib/util/dprintf.c  */
 134
 135 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 136 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
 137 _PUBLIC_ void display_set_stderr(void);
 138
 139 /* The following definitions come from lib/util/util_str.c  */
 140
 141 bool next_token_talloc(TALLOC_CTX *ctx,
 142                         const char **ptr,
 143                         char **pp_buff,
 144                         const char *sep);
 145
 146 /**
 147  * Get the next token from a string, return false if none found.  Handles
 148  * double-quotes.  This version does not trim leading separator characters
 149  * before looking for a token.
 150  */
 151 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
 152                         const char **ptr,
 153                         char **pp_buff,
 154                         const char *sep);
 155
 156
 157 /**
 158  Trim the specified elements off the front and back of a string.
 159 **/
 160 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
 161
 162 /**
 163  Find the number of 'c' chars in a string
 164 **/
 165 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
 166
 167 /**
 168  Routine to get hex characters and turn them into a 16 byte array.
 169  the array can be variable length, and any non-hex-numeric
 170  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 171  for.
 172
 173  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 174
 175
 176 **/
 177 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
 178
 179 /**
 180  * Parse a hex string and return a data blob.
 181  */
 182 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
 183
 184 /**
 185  * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
 186  */
 187 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen);
 188
 189 /**
 190  * talloc version of hex_encode_buf()
 191  */
 192 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
 193
 194 #include "substitute.h"
 195
 196 /**
 197  Unescape a URL encoded string, in place.
 198 **/
 199 _PUBLIC_ void rfc1738_unescape(char *buf);
 200
 201
 202 /**
 203  * rfc1738_escape
 204  * Returns a static buffer that contains the RFC
 205  * 1738 compliant, escaped version of the given url. (escapes unsafe and % characters)
 206  **/
 207 _PUBLIC_ char *rfc1738_escape(TALLOC_CTX *mem_ctx, const char *url);
 208
 209 /**
 210  * rfc1738_escape_unescaped
 211  *
 212  * Returns a static buffer that contains
 213  * the RFC 1738 compliant, escaped version of the given url (escapes unsafe chars only)
 214  **/
 215 _PUBLIC_ char *rfc1738_escape_unescaped(TALLOC_CTX *mem_ctx, const char *url);
 216
 217 /**
 218  * rfc1738_escape_part
 219  * Returns a static buffer that contains the RFC
 220  * 1738 compliant, escaped version of the given url segment. (escapes
 221  * unsafe, reserved and % chars) It would mangle the :// in http://,
 222  * and mangle paths (because of /).
 223  **/
 224 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
 225
 226 /**
 227   varient of strcmp() that handles NULL ptrs
 228 **/
 229 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
 230
 231 /**
 232 return the number of bytes occupied by a buffer in ASCII format
 233 the result includes the null termination
 234 limited by 'n' bytes
 235 **/
 236 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
 237
 238 /**
 239  Set a boolean variable from the text value stored in the passed string.
 240  Returns true in success, false if the passed string does not correctly
 241  represent a boolean.
 242 **/
 243 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
 244
 245 /**
 246  * Parse a string containing a boolean value.
 247  *
 248  * val will be set to the read value.
 249  *
 250  * @retval true if a boolean value was parsed, false otherwise.
 251  */
 252 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
 253
 254 /**
 255  * Convert a size specification like 16K into an integral number of bytes.
 256  **/
 257 _PUBLIC_ bool conv_str_size_error(const char * str, uint64_t * val);
 258
 259 /**
 260  * Parse a uint64_t value from a string
 261  *
 262  * val will be set to the value read.
 263  *
 264  * @retval true if parsing was successful, false otherwise
 265  */
 266 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
 267
 268 /**
 269 return the number of bytes occupied by a buffer in CH_UTF16 format
 270 the result includes the null termination
 271 **/
 272 _PUBLIC_ size_t utf16_len(const void *buf);
 273
 274 /**
 275 return the number of bytes occupied by a buffer in CH_UTF16 format
 276 the result includes the null termination
 277 limited by 'n' bytes
 278 **/
 279 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
 280 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
 281
 282 /**
 283  * @brief Constant time compare to memory regions.
 284  *
 285  * @param[in]  s1  The first memory region to compare.
 286  *
 287  * @param[in]  s2  The second memory region to compare.
 288  *
 289  * @param[in]  n   The length of the memory to comapre.
 290  *
 291  * @return 0 when the memory regions are equal, 0 if not.
 292  */
 293 _PUBLIC_ int memcmp_const_time(const void *s1, const void *s2, size_t n);
 294
 295 /**
 296 Do a case-insensitive, whitespace-ignoring string compare.
 297 **/
 298 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
 299
 300 /**
 301  String replace.
 302 **/
 303 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
 304
 305 /**
 306  * Compare 2 strings.
 307  *
 308  * @note The comparison is case-insensitive.
 309  **/
 310 _PUBLIC_ bool strequal(const char *s1, const char *s2);
 311
 312 #include "util_strlist.h"
 313
 314 /* The following definitions come from lib/util/util_strlist_v3.c  */
 315
 316 /**
 317  * Needed for making an "unconst" list "const"
 318  */
 319 _PUBLIC_ const char **const_str_list(char **list);
 320
 321 /**
 322  * str_list_make, v3 version. The v4 version does not
 323  * look at quoted strings with embedded blanks, so
 324  * do NOT merge this function please!
 325  */
 326 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
 327         const char *sep);
 328
 329
 330 const char **str_list_make_v3_const(TALLOC_CTX *mem_ctx,
 331                                     const char *string,
 332                                     const char *sep);
 333
 334 /* The following definitions come from lib/util/util_file.c  */
 335
 336
 337 /**
 338 read a line from a file with possible \ continuation chars.
 339 Blanks at the start or end of a line are stripped.
 340 The string will be allocated if s2 is NULL
 341 **/
 342 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
 343
 344 /**
 345  * Read one line (data until next newline or eof) and allocate it
 346  */
 347 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
 348
 349 /**
 350 load a file into memory from a fd.
 351 **/
 352 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 353
 354
 355 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
 356
 357 /**
 358 load a file into memory
 359 **/
 360 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
 361
 362 /**
 363 load a file into memory and return an array of pointers to lines in the file
 364 must be freed with talloc_free().
 365 **/
 366 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 367
 368 /**
 369 load a fd into memory and return an array of pointers to lines in the file
 370 must be freed with talloc_free(). If convert is true calls unix_to_dos on
 371 the list.
 372 **/
 373 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
 374
 375 _PUBLIC_ bool file_save_mode(const char *fname, const void *packet,
 376                              size_t length, mode_t mode);
 377 /**
 378   save a lump of data into a file. Mostly used for debugging
 379 */
 380 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
 381 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 382 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 383
 384 /*
 385   compare two files, return true if the two files have the same content
 386  */
 387 bool file_compare(const char *path1, const char *path2);
 388
 389 /* The following definitions come from lib/util/util.c  */
 390
 391
 392 /**
 393  Find a suitable temporary directory. The result should be copied immediately
 394  as it may be overwritten by a subsequent call.
 395 **/
 396 _PUBLIC_ const char *tmpdir(void);
 397
 398 /**
 399  * Creates and immediately unlinks a file. Returns open file descriptor.
 400  **/
 401 _PUBLIC_ int create_unlink_tmp(const char *dir);
 402
 403 /**
 404  Check if a file exists - call vfs_file_exist for samba files.
 405 **/
 406 _PUBLIC_ bool file_exist(const char *fname);
 407
 408 /**
 409  Check a files mod time.
 410 **/
 411 _PUBLIC_ time_t file_modtime(const char *fname);
 412
 413 /**
 414  Check if a directory exists.
 415 **/
 416 _PUBLIC_ bool directory_exist(const char *dname);
 417
 418 /**
 419  Check file permissions.
 420 **/
 421 _PUBLIC_ bool file_check_permissions(const char *fname,
 422                                      uid_t uid,
 423                                      mode_t file_perms,
 424                                      struct stat *pst);
 425
 426 /**
 427  * Try to create the specified directory if it didn't exist.
 428  *
 429  * @retval true if the directory already existed and has the right permissions
 430  * or was successfully created.
 431  */
 432 _PUBLIC_ bool directory_create_or_exist(const char *dname, mode_t dir_perms);
 433
 434 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
 435                                                uid_t uid,
 436                                                mode_t dir_perms);
 437
 438 #include "blocking.h"
 439
 440 /**
 441  Sleep for a specified number of milliseconds.
 442 **/
 443 _PUBLIC_ void smb_msleep(unsigned int t);
 444
 445 /**
 446  Get my own name, return in talloc'ed storage.
 447 **/
 448 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
 449
 450 /**
 451  Check if a process exists. Does this work on all unixes?
 452 **/
 453 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
 454
 455 /**
 456  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
 457  is dealt with in posix.c
 458 **/
 459 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
 460
 461 /**
 462  * Write dump of binary data to the log file.
 463  *
 464  * The data is only written if the log level is at least level.
 465  * 16 zero bytes in a row are omitted
 466  */
 467 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
 468
 469 /**
 470  malloc that aborts with smb_panic on fail or zero size.
 471 **/
 472 _PUBLIC_ void *smb_xmalloc(size_t size);
 473
 474 /**
 475  Memdup with smb_panic on fail.
 476 **/
 477 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
 478
 479 /**
 480  strdup that aborts on malloc fail.
 481 **/
 482 _PUBLIC_ char *smb_xstrdup(const char *s);
 483
 484 char *smb_xstrndup(const char *s, size_t n);
 485
 486 /**
 487  Like strdup but for memory.
 488 **/
 489 _PUBLIC_ void *smb_memdup(const void *p, size_t size);
 490
 491 /**
 492  * Write a password to the log file.
 493  *
 494  * @note Only actually does something if DEBUG_PASSWORD was defined during
 495  * compile-time.
 496  */
 497 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
 498
 499 /**
 500  * see if a range of memory is all zero. A NULL pointer is considered
 501  * to be all zero
 502  */
 503 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
 504
 505 /**
 506   realloc an array, checking for integer overflow in the array size
 507 */
 508 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
 509
 510 void *malloc_array(size_t el_size, unsigned int count);
 511
 512 void *memalign_array(size_t el_size, size_t align, unsigned int count);
 513
 514 void *calloc_array(size_t size, size_t nmemb);
 515
 516 /* The following definitions come from lib/util/fsusage.c  */
 517
 518
 519 /**
 520  * Retrieve amount of free disk space.
 521  * this does all of the system specific guff to get the free disk space.
 522  * It is derived from code in the GNU fileutils package, but has been
 523  * considerably mangled for use here
 524  *
 525  * results are returned in *dfree and *dsize, in 512 byte units
 526 */
 527 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
 528
 529 /* The following definitions come from lib/util/ms_fnmatch.c  */
 530
 531
 532 /**
 533  * @file
 534  * @brief MS-style Filename matching
 535  */
 536
 537 int ms_fnmatch_protocol(const char *pattern, const char *string, int protocol);
 538
 539 /** a generic fnmatch function - uses for non-CIFS pattern matching */
 540 int gen_fnmatch(const char *pattern, const char *string);
 541
 542 #include "idtree.h"
 543 #include "idtree_random.h"
 544
 545 /**
 546  Close the low 3 fd's and open dev/null in their place
 547 **/
 548 _PUBLIC_ void close_low_fds(bool stdin_too, bool stdout_too, bool stderr_too);
 549
 550 /**
 551  Become a daemon, discarding the controlling terminal.
 552 **/
 553 _PUBLIC_ void become_daemon(bool do_fork, bool no_process_group, bool log_stdout);
 554
 555 /**
 556  Exit daemon and print error message to the log at level 0
 557  Optionally report failure to systemd if systemd integration is enabled
 558 **/
 559 _PUBLIC_ void exit_daemon(const char *msg, int error);
 560
 561 /**
 562  Report that the daemon is ready to serve connections to the log at level 0
 563  Optionally report status to systemd if systemd integration is enabled
 564 **/
 565 _PUBLIC_ void daemon_ready(const char *daemon);
 566
 567 /*
 568  * Report the daemon status. For example if it is not ready to serve connections
 569  * and is waiting for some event to happen.
 570  */
 571 _PUBLIC_ void daemon_status(const char *name, const char *msg);
 572
 573 /**
 574  * @brief Get a password from the console.
 575  *
 576  * You should make sure that the buffer is an empty string!
 577  *
 578  * You can also use this function to ask for a username. Then you can fill the
 579  * buffer with the username and it is shows to the users. If the users just
 580  * presses enter the buffer will be untouched.
 581  *
 582  * @code
 583  *   char username[128];
 584  *
 585  *   snprintf(username, sizeof(username), "john");
 586  *
 587  *   smb_getpass("Username:", username, sizeof(username), 1, 0);
 588  * @endcode
 589  *
 590  * The prompt will look like this:
 591  *
 592  *   Username: [john]
 593  *
 594  * If you press enter then john is used as the username, or you can type it in
 595  * to change it.
 596  *
 597  * @param[in]  prompt   The prompt to show to ask for the password.
 598  *
 599  * @param[out] buf    The buffer the password should be stored. It NEEDS to be
 600  *                      empty or filled out.
 601  *
 602  * @param[in]  len      The length of the buffer.
 603  *
 604  * @param[in]  echo     Should we echo what you type.
 605  *
 606  * @param[in]  verify   Should we ask for the password twice.
 607  *
 608  * @return              0 on success, -1 on error.
 609  */
 610 _PUBLIC_ int samba_getpass(const char *prompt, char *buf, size_t len,
 611                            bool echo, bool verify);
 612
 613 /**
 614  * Load a ini-style file.
 615  */
 616 bool pm_process( const char *fileName,
 617                  bool (*sfunc)(const char *, void *),
 618                  bool (*pfunc)(const char *, const char *, void *),
 619                                  void *userdata);
 620
 621 void print_asc(int level, const uint8_t *buf,int len);
 622 void print_asc_cb(const uint8_t *buf, int len,
 623                   void (*cb)(const char *buf, void *private_data),
 624                   void *private_data);
 625
 626 /**
 627  * Add an id to an array of ids.
 628  *
 629  * num should be a pointer to an integer that holds the current
 630  * number of elements in ids. It will be updated by this function.
 631  */
 632
 633 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
 634                              uid_t **uids, uint32_t *num_uids);
 635 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
 636                              gid_t **gids, uint32_t *num_gids);
 637
 638 /**
 639  * Allocate anonymous shared memory of the given size
 640  */
 641 void *anonymous_shared_allocate(size_t bufsz);
 642 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove);
 643 void anonymous_shared_free(void *ptr);
 644
 645 /*
 646   run a command as a child process, with a timeout.
 647
 648   any stdout/stderr from the child will appear in the Samba logs with
 649   the specified log levels
 650
 651   If callback is set then the callback is called on completion
 652   with the return code from the command
 653  */
 654 struct tevent_context;
 655 struct tevent_req;
 656 struct tevent_req *samba_runcmd_send(TALLOC_CTX *mem_ctx,
 657                                      struct tevent_context *ev,
 658                                      struct timeval endtime,
 659                                      int stdout_log_level,
 660                                      int stderr_log_level,
 661                                      const char * const *argv0, ...);
 662 int samba_runcmd_recv(struct tevent_req *req, int *perrno);
 663
 664 #ifdef DEVELOPER
 665 void samba_start_debugger(void);
 666 #endif
 667
 668 /**
 669  * @brief Returns an absolute path to a file in the Samba modules directory.
 670  *
 671  * @param name File to find, relative to MODULESDIR.
 672  *
 673  * @retval Pointer to a string containing the full path.
 674  **/
 675 char *modules_path(TALLOC_CTX *mem_ctx, const char *name);
 676
 677 /**
 678  * @brief Returns an absolute path to a file in the Samba data directory.
 679  *
 680  * @param name File to find, relative to CODEPAGEDIR.
 681  *
 682  * @retval Pointer to a talloc'ed string containing the full path.
 683  **/
 684 char *data_path(TALLOC_CTX *mem_ctx, const char *name);
 685
 686 /**
 687  * @brief Returns the platform specific shared library extension.
 688  *
 689  * @retval Pointer to a const char * containing the extension.
 690  **/
 691 const char *shlib_ext(void);
 692
 693 struct server_id;
 694
 695 struct server_id_buf { char buf[48]; }; /* probably a bit too large ... */
 696 char *server_id_str_buf(struct server_id id, struct server_id_buf *dst);
 697 size_t server_id_str_buf_unique(struct server_id id, char *buf, size_t buflen);
 698
 699 bool server_id_same_process(const struct server_id *p1,
 700                             const struct server_id *p2);
 701 bool server_id_equal(const struct server_id *p1, const struct server_id *p2);
 702 struct server_id server_id_from_string(uint32_t local_vnn,
 703                                        const char *pid_string);
 704
 705 /**
 706  * Set the serverid to the special value that represents a disconnected
 707  * client for (e.g.) durable handles.
 708  */
 709 void server_id_set_disconnected(struct server_id *id);
 710
 711 /**
 712  * check whether a serverid is the special placeholder for
 713  * a disconnected client
 714  */
 715 bool server_id_is_disconnected(const struct server_id *id);
 716
 717 #define SERVER_ID_BUF_LENGTH 24
 718 void server_id_put(uint8_t buf[SERVER_ID_BUF_LENGTH],
 719                    const struct server_id id);
 720 void server_id_get(struct server_id *id,
 721                    const uint8_t buf[SERVER_ID_BUF_LENGTH]);
 722
 723 /*
 724  * Samba code should use samba_tevent_context_init() instead of
 725  * tevent_context_init() in order to get the debug output.
 726  */
 727 struct tevent_context *samba_tevent_context_init(TALLOC_CTX *mem_ctx);
 728
 729 /*
 730  * if same samba code needs to use a specific tevent backend
 731  * it can use something like this:
 732  *
 733  * samba_tevent_set_debug(ev, "pysmb_tevent");
 734  */
 735 void samba_tevent_set_debug(struct tevent_context *ev, const char *name);
 736
 737 #endif /* _SAMBA_UTIL_H_ */