r24780: More work allowing libutil to be used by external users.
[kai/samba.git] / source4 / lib / util / util.h
1 /* 
2    Unix SMB/CIFS implementation.
3    Utility functions for Samba
4    Copyright (C) Andrew Tridgell 1992-1999
5    Copyright (C) Jelmer Vernooij 2005
6     
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef _SAMBA_UTIL_H_
22 #define _SAMBA_UTIL_H_
23
24 #include "charset/charset.h"
25
26 /**
27  * @file
28  * @brief Helpful macros
29  */
30
31 struct substitute_context;
32 struct smbsrv_tcon;
33
34 extern const char *logfile;
35 extern const char *panic_action;
36
37 #include "util/time.h"
38 #include "util/data_blob.h"
39 #include "util/xfile.h"
40 #include "util/debug.h"
41 #include "util/mutex.h"
42 #include "util/byteorder.h"
43
44 /**
45   this is a warning hack. The idea is to use this everywhere that we
46   get the "discarding const" warning from gcc. That doesn't actually
47   fix the problem of course, but it means that when we do get to
48   cleaning them up we can do it by searching the code for
49   discard_const.
50
51   It also means that other error types aren't as swamped by the noise
52   of hundreds of const warnings, so we are more likely to notice when
53   we get new errors.
54
55   Please only add more uses of this macro when you find it
56   _really_ hard to fix const warnings. Our aim is to eventually use
57   this function in only a very few places.
58
59   Also, please call this via the discard_const_p() macro interface, as that
60   makes the return type safe.
61 */
62 #ifndef discard_const
63 #define discard_const(ptr) ((void *)((intptr_t)(ptr)))
64 #endif
65
66 /** Type-safe version of discard_const */
67 #ifndef discard_const_p
68 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
69 #endif
70
71 /**
72  * assert macros 
73  */
74 #define SMB_ASSERT(b) do { if (!(b)) { \
75         DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
76         smb_panic("assert failed"); abort(); }} while (0)
77
78 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
79 /**
80  * Free memory if the pointer and zero the pointer.
81  *
82  * @note You are explicitly allowed to pass NULL pointers -- they will
83  * always be ignored.
84  **/
85 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
86 #endif
87
88 /** 
89  * Type-safe version of malloc. Allocated one copy of the 
90  * specified data type.
91  */
92 #define malloc_p(type) (type *)malloc(sizeof(type))
93
94 /**
95  * Allocate an array of elements of one data type. Does type-checking.
96  */
97 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
98
99 /** 
100  * Resize an array of elements of one data type. Does type-checking.
101  */
102 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
103
104 #if defined(VALGRIND)
105 #define strlen(x) valgrind_strlen(x)
106 #endif
107
108 /** 
109  * zero a structure 
110  */
111 #ifndef ZERO_STRUCT
112 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
113 #endif
114
115 /** 
116  * zero a structure given a pointer to the structure 
117  */
118 #ifndef ZERO_STRUCTP
119 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
120 #endif
121
122 /** 
123  * zero a structure given a pointer to the structure - no zero check 
124  */
125 #ifndef ZERO_STRUCTPN
126 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
127 #endif
128
129 /* zero an array - note that sizeof(array) must work - ie. it must not be a
130    pointer */
131 #ifndef ZERO_ARRAY
132 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
133 #endif
134
135 /**
136  * work out how many elements there are in a static array 
137  */
138 #ifndef ARRAY_SIZE
139 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
140 #endif
141
142 /** 
143  * pointer difference macro 
144  */
145 #ifndef PTR_DIFF
146 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
147 #endif
148
149
150 /** 
151  * this global variable determines what messages are printed 
152  */
153 _PUBLIC_ void debug_schedule_reopen_logs(void);
154
155 /**
156   the backend for debug messages. Note that the DEBUG() macro has already
157   ensured that the log level has been met before this is called
158 */
159 _PUBLIC_ void do_debug_header(int level, const char *location, const char *func);
160
161 /**
162   the backend for debug messages. Note that the DEBUG() macro has already
163   ensured that the log level has been met before this is called
164
165   @note You should never have to call this function directly. Call the DEBUG()
166   macro instead.
167 */
168 _PUBLIC_ void do_debug(const char *format, ...) _PRINTF_ATTRIBUTE(1,2);
169
170 /**
171   reopen the log file (usually called because the log file name might have changed)
172 */
173 _PUBLIC_ void reopen_logs(void);
174
175 /**
176   control the name of the logfile and whether logging will be to stdout, stderr
177   or a file
178 */
179 _PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype);
180
181 /**
182   return a string constant containing n tabs
183   no more than 10 tabs are returned
184 */
185 _PUBLIC_ const char *do_debug_tab(int n);
186
187 /**
188   log suspicious usage - print comments and backtrace
189 */      
190 _PUBLIC_ void log_suspicious_usage(const char *from, const char *info);
191
192 /**
193   print suspicious usage - print comments and backtrace
194 */      
195 _PUBLIC_ void print_suspicious_usage(const char* from, const char* info);
196 _PUBLIC_ uint32_t get_task_id(void);
197 _PUBLIC_ void log_task_id(void);
198
199 /**
200   register a set of debug handlers. 
201 */
202 _PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops);
203
204 /* The following definitions come from lib/util/fault.c  */
205
206
207 /**
208  * Write backtrace to debug log
209  */
210 _PUBLIC_ void call_backtrace(void);
211
212 /**
213  Something really nasty happened - panic !
214 **/
215 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
216
217 /**
218 setup our fault handlers
219 **/
220 _PUBLIC_ void fault_setup(const char *pname);
221
222 /**
223   register a fault handler. 
224   Should only be called once in the execution of smbd.
225 */
226 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
227
228 /* The following definitions come from lib/util/signal.c  */
229
230
231 /**
232  Block sigs.
233 **/
234 void BlockSignals(bool block, int signum);
235
236 /**
237  Catch a signal. This should implement the following semantics:
238
239  1) The handler remains installed after being called.
240  2) The signal should be blocked during handler execution.
241 **/
242 void (*CatchSignal(int signum,void (*handler)(int )))(int);
243
244 /**
245  Ignore SIGCLD via whatever means is necessary for this OS.
246 **/
247 void CatchChild(void);
248
249 /**
250  Catch SIGCLD but leave the child around so it's status can be reaped.
251 **/
252 void CatchChildLeaveStatus(void);
253
254 /* The following definitions come from lib/util/system.c  */
255
256
257 /**************************************************************************
258 A wrapper for gethostbyname() that tries avoids looking up hostnames 
259 in the root domain, which can cause dial-on-demand links to come up for no
260 apparent reason.
261 ****************************************************************************/
262 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
263 _PUBLIC_ const char *sys_inet_ntoa(struct ipv4_addr in);
264 _PUBLIC_ struct ipv4_addr sys_inet_makeaddr(int net, int host);
265
266 /* The following definitions come from lib/util/genrand.c  */
267
268 /**
269  Copy any user given reseed data.
270 **/
271 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(int *));
272
273 /**
274  * Tell the random number generator it needs to reseed.
275  */
276 _PUBLIC_ void set_need_random_reseed(void);
277
278 /**
279  Interface to the (hopefully) good crypto random number generator.
280 **/
281 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
282
283 /**
284   generate a single random uint32_t
285 **/
286 _PUBLIC_ uint32_t generate_random(void);
287
288 /**
289   very basic password quality checker
290 **/
291 _PUBLIC_ bool check_password_quality(const char *s);
292
293 /**
294  Use the random number generator to generate a random string.
295 **/
296 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
297
298 /**
299  * Generate a random text string consisting of the specified length.
300  * The returned string will be allocated.
301  *
302  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
303  */
304 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
305
306 /* The following definitions come from lib/util/dprintf.c  */
307
308 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) _PRINTF_ATTRIBUTE(2,0);
309 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) _PRINTF_ATTRIBUTE(2,3);
310 _PUBLIC_ int d_printf(const char *format, ...) _PRINTF_ATTRIBUTE(1,2);
311 _PUBLIC_ void display_set_stderr(void);
312
313 /* The following definitions come from lib/util/util_str.c  */
314
315
316 /**
317  Trim the specified elements off the front and back of a string.
318 **/
319 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
320
321 /**
322  Find the number of 'c' chars in a string
323 **/
324 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
325
326 /**
327  Safe string copy into a known length string. maxlength does not
328  include the terminating zero.
329 **/
330 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
331
332 /**
333  Safe string cat into a string. maxlength does not
334  include the terminating zero.
335 **/
336 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
337
338 /**
339  Routine to get hex characters and turn them into a 16 byte array.
340  the array can be variable length, and any non-hex-numeric
341  characters are skipped.  "0xnn" or "0Xnn" is specially catered
342  for.
343
344  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
345
346
347 **/
348 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex);
349
350 /** 
351  * Parse a hex string and return a data blob. 
352  */
353 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(const char *strhex) ;
354
355 /**
356  * Routine to print a buffer as HEX digits, into an allocated string.
357  */
358 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
359
360 /**
361  * talloc version of hex_encode()
362  */
363 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
364
365 /**
366  Free a string value.
367 **/
368 _PUBLIC_ void string_free(char **s);
369
370 /**
371  Set a string value, deallocating any existing space, and allocing the space
372  for the string
373 **/
374 _PUBLIC_ bool string_set(char **dest, const char *src);
375
376 /**
377  Substitute a string for a pattern in another string. Make sure there is 
378  enough room!
379
380  This routine looks for pattern in s and replaces it with 
381  insert. It may do multiple replacements.
382
383  Any of " ; ' $ or ` in the insert string are replaced with _
384  if len==0 then the string cannot be extended. This is different from the old
385  use of len==0 which was for no length checks to be done.
386 **/
387 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
388
389 /**
390  Similar to string_sub() but allows for any character to be substituted. 
391  Use with caution!
392  if len==0 then the string cannot be extended. This is different from the old
393  use of len==0 which was for no length checks to be done.
394 **/
395 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
396
397 /**
398  Unescape a URL encoded string, in place.
399 **/
400 _PUBLIC_ void rfc1738_unescape(char *buf);
401 size_t valgrind_strlen(const char *s);
402
403 /**
404   format a string into length-prefixed dotted domain format, as used in NBT
405   and in some ADS structures
406 **/
407 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
408
409 /**
410  * Add a string to an array of strings.
411  *
412  * num should be a pointer to an integer that holds the current 
413  * number of elements in strings. It will be updated by this function.
414  */
415 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
416                          const char *str, const char ***strings, int *num);
417
418 /**
419   varient of strcmp() that handles NULL ptrs
420 **/
421 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
422
423 /**
424 return the number of bytes occupied by a buffer in ASCII format
425 the result includes the null termination
426 limited by 'n' bytes
427 **/
428 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
429
430 /**
431  Return a string representing a CIFS attribute for a file.
432 **/
433 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
434
435 /**
436  Set a boolean variable from the text value stored in the passed string.
437  Returns true in success, false if the passed string does not correctly 
438  represent a boolean.
439 **/
440 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
441
442 /**
443  * Parse a string containing a boolean value.
444  *
445  * val will be set to the read value.
446  *
447  * @retval true if a boolean value was parsed, false otherwise.
448  */
449 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
450
451 /**
452  * Convert a size specification like 16K into an integral number of bytes. 
453  **/
454 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
455
456 /**
457  * Parse a uint64_t value from a string
458  *
459  * val will be set to the value read.
460  *
461  * @retval true if parsing was successful, false otherwise
462  */
463 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
464
465 /**
466 return the number of bytes occupied by a buffer in CH_UTF16 format
467 the result includes the null termination
468 **/
469 _PUBLIC_ size_t utf16_len(const void *buf);
470
471 /**
472 return the number of bytes occupied by a buffer in CH_UTF16 format
473 the result includes the null termination
474 limited by 'n' bytes
475 **/
476 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
477 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
478
479 /**
480 Do a case-insensitive, whitespace-ignoring string compare.
481 **/
482 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
483
484 /**
485  String replace.
486 **/
487 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
488
489 /**
490  * Compare 2 strings.
491  *
492  * @note The comparison is case-insensitive.
493  **/
494 _PUBLIC_ bool strequal(const char *s1, const char *s2);
495
496 /* The following definitions come from lib/util/util_strlist.c  */
497
498
499 /**
500   build a null terminated list of strings from a input string and a
501   separator list. The separator list must contain characters less than
502   or equal to 0x2f for this to work correctly on multi-byte strings
503 */
504 _PUBLIC_ const char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
505
506 /**
507  * build a null terminated list of strings from an argv-like input string 
508  * Entries are seperated by spaces and can be enclosed by quotes. 
509  * Does NOT support escaping
510  */
511 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
512
513 /**
514  * join a list back to one string 
515  */
516 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
517
518 /** join a list back to one (shell-like) string; entries 
519  * seperated by spaces, using quotes where necessary */
520 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
521
522 /**
523   return the number of elements in a string list
524 */
525 _PUBLIC_ size_t str_list_length(const char **list);
526
527 /**
528   copy a string list
529 */
530 _PUBLIC_ const char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
531
532 /**
533    Return true if all the elements of the list match exactly.
534  */
535 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
536
537 /**
538   add an entry to a string list
539 */
540 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
541
542 /**
543   remove an entry from a string list
544 */
545 _PUBLIC_ void str_list_remove(const char **list, const char *s);
546
547 /**
548   return true if a string is in a list
549 */
550 _PUBLIC_ bool str_list_check(const char **list, const char *s);
551
552 /**
553   return true if a string is in a list, case insensitively
554 */
555 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
556
557 /**
558  Check if a string is part of a list.
559 **/
560 _PUBLIC_ bool in_list(const char *s, const char *list, bool casesensitive);
561
562 /* The following definitions come from lib/util/util_file.c  */
563
564
565 /**
566 read a line from a file with possible \ continuation chars. 
567 Blanks at the start or end of a line are stripped.
568 The string will be allocated if s2 is NULL
569 **/
570 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
571
572 /**
573  * Read one line (data until next newline or eof) and allocate it 
574  */
575 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
576
577 /**
578 load a file into memory from a fd.
579 **/
580 _PUBLIC_ char *fd_load(int fd, size_t *size, TALLOC_CTX *mem_ctx);
581
582 /**
583 load a file into memory
584 **/
585 _PUBLIC_ char *file_load(const char *fname, size_t *size, TALLOC_CTX *mem_ctx);
586
587 /**
588 mmap (if possible) or read a file
589 **/
590 _PUBLIC_ void *map_file(const char *fname, size_t size);
591
592 /**
593 load a file into memory and return an array of pointers to lines in the file
594 must be freed with talloc_free(). 
595 **/
596 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, TALLOC_CTX *mem_ctx);
597
598 /**
599 load a fd into memory and return an array of pointers to lines in the file
600 must be freed with talloc_free(). If convert is true calls unix_to_dos on
601 the list.
602 **/
603 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, TALLOC_CTX *mem_ctx);
604
605 /**
606 take a list of lines and modify them to produce a list where \ continues
607 a line
608 **/
609 _PUBLIC_ void file_lines_slashcont(char **lines);
610
611 /**
612   save a lump of data into a file. Mostly used for debugging 
613 */
614 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
615 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) _PRINTF_ATTRIBUTE(2,0);
616 _PUBLIC_ int fdprintf(int fd, const char *format, ...) _PRINTF_ATTRIBUTE(2,3);
617 _PUBLIC_ bool large_file_support(const char *path);
618
619 /* The following definitions come from lib/util/util.c  */
620
621
622 /**
623  Find a suitable temporary directory. The result should be copied immediately
624  as it may be overwritten by a subsequent call.
625 **/
626 _PUBLIC_ const char *tmpdir(void);
627
628 /**
629  Check if a file exists - call vfs_file_exist for samba files.
630 **/
631 _PUBLIC_ bool file_exist(const char *fname);
632
633 /**
634  Check a files mod time.
635 **/
636 _PUBLIC_ time_t file_modtime(const char *fname);
637
638 /**
639  Check if a directory exists.
640 **/
641 _PUBLIC_ bool directory_exist(const char *dname);
642
643 /**
644  * Try to create the specified directory if it didn't exist.
645  *
646  * @retval true if the directory already existed and has the right permissions 
647  * or was successfully created.
648  */
649 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid, 
650                                mode_t dir_perms);
651
652 /**
653  Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
654  else
655   if SYSV use O_NDELAY
656   if BSD use FNDELAY
657 **/
658 _PUBLIC_ int set_blocking(int fd, bool set);
659
660 /**
661  Sleep for a specified number of milliseconds.
662 **/
663 _PUBLIC_ void msleep(unsigned int t);
664
665 /**
666  Get my own name, return in malloc'ed storage.
667 **/
668 _PUBLIC_ char* get_myname(void);
669
670 /**
671  Return true if a string could be a pure IP address.
672 **/
673 _PUBLIC_ bool is_ipaddress(const char *str);
674
675 /**
676  Interpret an internet address or name into an IP address in 4 byte form.
677 **/
678 _PUBLIC_ uint32_t interpret_addr(const char *str);
679
680 /**
681  A convenient addition to interpret_addr().
682 **/
683 _PUBLIC_ struct ipv4_addr interpret_addr2(const char *str);
684
685 /**
686  Check if an IP is the 0.0.0.0.
687 **/
688 _PUBLIC_ bool is_zero_ip(struct ipv4_addr ip);
689
690 /**
691  Are two IPs on the same subnet?
692 **/
693 _PUBLIC_ bool same_net(struct ipv4_addr ip1,struct ipv4_addr ip2,struct ipv4_addr mask);
694
695 /**
696  Check if a process exists. Does this work on all unixes?
697 **/
698 _PUBLIC_ bool process_exists(pid_t pid);
699
700 /**
701  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
702  is dealt with in posix.c
703 **/
704 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
705
706 /**
707  * Write dump of binary data to the log file.
708  *
709  * The data is only written if the log level is at least level.
710  */
711 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
712
713 /**
714  malloc that aborts with smb_panic on fail or zero size.
715 **/
716 _PUBLIC_ void *smb_xmalloc(size_t size);
717
718 /**
719  Memdup with smb_panic on fail.
720 **/
721 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
722
723 /**
724  strdup that aborts on malloc fail.
725 **/
726 _PUBLIC_ char *smb_xstrdup(const char *s);
727
728 /**
729  Like strdup but for memory.
730 **/
731 _PUBLIC_ void *memdup(const void *p, size_t size);
732
733 /**
734  * Write a password to the log file.
735  *
736  * @note Only actually does something if DEBUG_PASSWORD was defined during 
737  * compile-time.
738  */
739 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
740
741 /**
742  * see if a range of memory is all zero. A NULL pointer is considered
743  * to be all zero 
744  */
745 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
746
747 /**
748   realloc an array, checking for integer overflow in the array size
749 */
750 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count);
751
752 /* The following definitions come from lib/util/fsusage.c  */
753
754
755 /**
756  * Retrieve amount of free disk space.
757  * this does all of the system specific guff to get the free disk space.
758  * It is derived from code in the GNU fileutils package, but has been
759  * considerably mangled for use here 
760  *
761  * results are returned in *dfree and *dsize, in 512 byte units
762 */
763 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
764
765 /* The following definitions come from lib/util/ms_fnmatch.c  */
766
767
768 /**
769  * @file
770  * @brief MS-style Filename matching
771  */
772 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
773
774 /** a generic fnmatch function - uses for non-CIFS pattern matching */
775 int gen_fnmatch(const char *pattern, const char *string);
776
777 /* The following definitions come from lib/util/mutex.c  */
778
779
780 /**
781   register a set of mutex/rwlock handlers. 
782   Should only be called once in the execution of smbd.
783 */
784 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
785
786 /* The following definitions come from lib/util/idtree.c  */
787
788
789 /**
790   initialise a idr tree. The context return value must be passed to
791   all subsequent idr calls. To destroy the idr tree use talloc_free()
792   on this context
793  */
794 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
795
796 /**
797   allocate the next available id, and assign 'ptr' into its slot.
798   you can retrieve later this pointer using idr_find()
799 */
800 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
801
802 /**
803    allocate a new id, giving the first available value greater than or
804    equal to the given starting id
805 */
806 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
807
808 /**
809   allocate a new id randomly in the given range
810 */
811 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
812
813 /**
814   find a pointer value previously set with idr_get_new given an id
815 */
816 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
817
818 /**
819   remove an id from the idr tree
820 */
821 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
822
823 /* The following definitions come from lib/util/module.c  */
824
825
826 /**
827  * Obtain the init function from a shared library file
828  */
829 _PUBLIC_ init_module_fn load_module(TALLOC_CTX *mem_ctx, const char *path);
830
831 /**
832  * Obtain list of init functions from the modules in the specified
833  * directory
834  */
835 _PUBLIC_ init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path);
836
837 /**
838  * Run the specified init functions.
839  *
840  * @return true if all functions ran successfully, false otherwise
841  */
842 _PUBLIC_ bool run_init_functions(NTSTATUS (**fns) (void));
843
844 /* The following definitions come from lib/util/become_daemon.c  */
845
846
847 /**
848  Become a daemon, discarding the controlling terminal.
849 **/
850 _PUBLIC_ void become_daemon(bool Fork);
851
852 #endif /* _SAMBA_UTIL_H_ */