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