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