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