a2e09545171e3014e5d1b1550a74536cf7eff0a8
[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   we use struct ipv4_addr to avoid having to include all the
259   system networking headers everywhere
260 */
261 struct ipv4_addr {
262         uint32_t addr;
263 };
264
265 /**************************************************************************
266 A wrapper for gethostbyname() that tries avoids looking up hostnames 
267 in the root domain, which can cause dial-on-demand links to come up for no
268 apparent reason.
269 ****************************************************************************/
270 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
271 _PUBLIC_ const char *sys_inet_ntoa(struct ipv4_addr in);
272 _PUBLIC_ struct ipv4_addr sys_inet_makeaddr(int net, int host);
273
274 /* The following definitions come from lib/util/genrand.c  */
275
276 /**
277  Copy any user given reseed data.
278 **/
279 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(int *));
280
281 /**
282  * Tell the random number generator it needs to reseed.
283  */
284 _PUBLIC_ void set_need_random_reseed(void);
285
286 /**
287  Interface to the (hopefully) good crypto random number generator.
288 **/
289 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
290
291 /**
292   generate a single random uint32_t
293 **/
294 _PUBLIC_ uint32_t generate_random(void);
295
296 /**
297   very basic password quality checker
298 **/
299 _PUBLIC_ bool check_password_quality(const char *s);
300
301 /**
302  Use the random number generator to generate a random string.
303 **/
304 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
305
306 /**
307  * Generate a random text string consisting of the specified length.
308  * The returned string will be allocated.
309  *
310  * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
311  */
312 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
313
314 /* The following definitions come from lib/util/dprintf.c  */
315
316 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) _PRINTF_ATTRIBUTE(2,0);
317 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) _PRINTF_ATTRIBUTE(2,3);
318 _PUBLIC_ int d_printf(const char *format, ...) _PRINTF_ATTRIBUTE(1,2);
319 _PUBLIC_ void display_set_stderr(void);
320
321 /* The following definitions come from lib/util/util_str.c  */
322
323
324 /**
325  Trim the specified elements off the front and back of a string.
326 **/
327 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
328
329 /**
330  Find the number of 'c' chars in a string
331 **/
332 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
333
334 /**
335  Safe string copy into a known length string. maxlength does not
336  include the terminating zero.
337 **/
338 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
339
340 /**
341  Safe string cat into a string. maxlength does not
342  include the terminating zero.
343 **/
344 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
345
346 /**
347  Routine to get hex characters and turn them into a 16 byte array.
348  the array can be variable length, and any non-hex-numeric
349  characters are skipped.  "0xnn" or "0Xnn" is specially catered
350  for.
351
352  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
353
354
355 **/
356 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex);
357
358 /** 
359  * Parse a hex string and return a data blob. 
360  */
361 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(const char *strhex) ;
362
363 /**
364  * Routine to print a buffer as HEX digits, into an allocated string.
365  */
366 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
367
368 /**
369  * talloc version of hex_encode()
370  */
371 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
372
373 /**
374  Set a string value, deallocating any existing space, and allocing the space
375  for the string
376 **/
377 _PUBLIC_ bool string_set(TALLOC_CTX *mem_ctx, char **dest, const char *src);
378
379 /**
380  Substitute a string for a pattern in another string. Make sure there is 
381  enough room!
382
383  This routine looks for pattern in s and replaces it with 
384  insert. It may do multiple replacements.
385
386  Any of " ; ' $ or ` in the insert string are replaced with _
387  if len==0 then the string cannot be extended. This is different from the old
388  use of len==0 which was for no length checks to be done.
389 **/
390 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
391
392 /**
393  Similar to string_sub() but allows for any character to be substituted. 
394  Use with caution!
395  if len==0 then the string cannot be extended. This is different from the old
396  use of len==0 which was for no length checks to be done.
397 **/
398 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
399
400 /**
401  Unescape a URL encoded string, in place.
402 **/
403 _PUBLIC_ void rfc1738_unescape(char *buf);
404 size_t valgrind_strlen(const char *s);
405
406 /**
407   format a string into length-prefixed dotted domain format, as used in NBT
408   and in some ADS structures
409 **/
410 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
411
412 /**
413  * Add a string to an array of strings.
414  *
415  * num should be a pointer to an integer that holds the current 
416  * number of elements in strings. It will be updated by this function.
417  */
418 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
419                          const char *str, const char ***strings, int *num);
420
421 /**
422   varient of strcmp() that handles NULL ptrs
423 **/
424 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
425
426 /**
427 return the number of bytes occupied by a buffer in ASCII format
428 the result includes the null termination
429 limited by 'n' bytes
430 **/
431 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
432
433 /**
434  Return a string representing a CIFS attribute for a file.
435 **/
436 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
437
438 /**
439  Set a boolean variable from the text value stored in the passed string.
440  Returns true in success, false if the passed string does not correctly 
441  represent a boolean.
442 **/
443 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
444
445 /**
446  * Parse a string containing a boolean value.
447  *
448  * val will be set to the read value.
449  *
450  * @retval true if a boolean value was parsed, false otherwise.
451  */
452 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
453
454 /**
455  * Convert a size specification like 16K into an integral number of bytes. 
456  **/
457 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
458
459 /**
460  * Parse a uint64_t value from a string
461  *
462  * val will be set to the value read.
463  *
464  * @retval true if parsing was successful, false otherwise
465  */
466 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
467
468 /**
469 return the number of bytes occupied by a buffer in CH_UTF16 format
470 the result includes the null termination
471 **/
472 _PUBLIC_ size_t utf16_len(const void *buf);
473
474 /**
475 return the number of bytes occupied by a buffer in CH_UTF16 format
476 the result includes the null termination
477 limited by 'n' bytes
478 **/
479 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
480 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
481
482 /**
483 Do a case-insensitive, whitespace-ignoring string compare.
484 **/
485 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
486
487 /**
488  String replace.
489 **/
490 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
491
492 /**
493  * Compare 2 strings.
494  *
495  * @note The comparison is case-insensitive.
496  **/
497 _PUBLIC_ bool strequal(const char *s1, const char *s2);
498
499 /* The following definitions come from lib/util/util_strlist.c  */
500
501
502 /**
503   build a null terminated list of strings from a input string and a
504   separator list. The separator list must contain characters less than
505   or equal to 0x2f for this to work correctly on multi-byte strings
506 */
507 _PUBLIC_ const char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
508
509 /**
510  * build a null terminated list of strings from an argv-like input string 
511  * Entries are seperated by spaces and can be enclosed by quotes. 
512  * Does NOT support escaping
513  */
514 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
515
516 /**
517  * join a list back to one string 
518  */
519 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
520
521 /** join a list back to one (shell-like) string; entries 
522  * seperated by spaces, using quotes where necessary */
523 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
524
525 /**
526   return the number of elements in a string list
527 */
528 _PUBLIC_ size_t str_list_length(const char **list);
529
530 /**
531   copy a string list
532 */
533 _PUBLIC_ const char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
534
535 /**
536    Return true if all the elements of the list match exactly.
537  */
538 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
539
540 /**
541   add an entry to a string list
542 */
543 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
544
545 /**
546   remove an entry from a string list
547 */
548 _PUBLIC_ void str_list_remove(const char **list, const char *s);
549
550 /**
551   return true if a string is in a list
552 */
553 _PUBLIC_ bool str_list_check(const char **list, const char *s);
554
555 /**
556   return true if a string is in a list, case insensitively
557 */
558 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
559
560 /* The following definitions come from lib/util/util_file.c  */
561
562
563 /**
564 read a line from a file with possible \ continuation chars. 
565 Blanks at the start or end of a line are stripped.
566 The string will be allocated if s2 is NULL
567 **/
568 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
569
570 /**
571  * Read one line (data until next newline or eof) and allocate it 
572  */
573 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
574
575 /**
576 load a file into memory from a fd.
577 **/
578 _PUBLIC_ char *fd_load(int fd, size_t *size, TALLOC_CTX *mem_ctx);
579
580 /**
581 load a file into memory
582 **/
583 _PUBLIC_ char *file_load(const char *fname, size_t *size, TALLOC_CTX *mem_ctx);
584
585 /**
586 mmap (if possible) or read a file
587 **/
588 _PUBLIC_ void *map_file(const char *fname, size_t size);
589
590 /**
591 load a file into memory and return an array of pointers to lines in the file
592 must be freed with talloc_free(). 
593 **/
594 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, TALLOC_CTX *mem_ctx);
595
596 /**
597 load a fd into memory and return an array of pointers to lines in the file
598 must be freed with talloc_free(). If convert is true calls unix_to_dos on
599 the list.
600 **/
601 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, TALLOC_CTX *mem_ctx);
602
603 /**
604 take a list of lines and modify them to produce a list where \ continues
605 a line
606 **/
607 _PUBLIC_ void file_lines_slashcont(char **lines);
608
609 /**
610   save a lump of data into a file. Mostly used for debugging 
611 */
612 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
613 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) _PRINTF_ATTRIBUTE(2,0);
614 _PUBLIC_ int fdprintf(int fd, const char *format, ...) _PRINTF_ATTRIBUTE(2,3);
615 _PUBLIC_ bool large_file_support(const char *path);
616
617 /* The following definitions come from lib/util/util.c  */
618
619
620 /**
621  Find a suitable temporary directory. The result should be copied immediately
622  as it may be overwritten by a subsequent call.
623 **/
624 _PUBLIC_ const char *tmpdir(void);
625
626 /**
627  Check if a file exists - call vfs_file_exist for samba files.
628 **/
629 _PUBLIC_ bool file_exist(const char *fname);
630
631 /**
632  Check a files mod time.
633 **/
634 _PUBLIC_ time_t file_modtime(const char *fname);
635
636 /**
637  Check if a directory exists.
638 **/
639 _PUBLIC_ bool directory_exist(const char *dname);
640
641 /**
642  * Try to create the specified directory if it didn't exist.
643  *
644  * @retval true if the directory already existed and has the right permissions 
645  * or was successfully created.
646  */
647 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid, 
648                                mode_t dir_perms);
649
650 /**
651  Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
652  else
653   if SYSV use O_NDELAY
654   if BSD use FNDELAY
655 **/
656 _PUBLIC_ int set_blocking(int fd, bool set);
657
658 /**
659  Sleep for a specified number of milliseconds.
660 **/
661 _PUBLIC_ void msleep(unsigned int t);
662
663 /**
664  Get my own name, return in malloc'ed storage.
665 **/
666 _PUBLIC_ char* get_myname(void);
667
668 /**
669  Return true if a string could be a pure IP address.
670 **/
671 _PUBLIC_ bool is_ipaddress(const char *str);
672
673 /**
674  Interpret an internet address or name into an IP address in 4 byte form.
675 **/
676 _PUBLIC_ uint32_t interpret_addr(const char *str);
677
678 /**
679  A convenient addition to interpret_addr().
680 **/
681 _PUBLIC_ struct ipv4_addr interpret_addr2(const char *str);
682
683 /**
684  Check if an IP is the 0.0.0.0.
685 **/
686 _PUBLIC_ bool is_zero_ip(struct ipv4_addr ip);
687
688 /**
689  Are two IPs on the same subnet?
690 **/
691 _PUBLIC_ bool same_net(struct ipv4_addr ip1,struct ipv4_addr ip2,struct ipv4_addr mask);
692
693 /**
694  Check if a process exists. Does this work on all unixes?
695 **/
696 _PUBLIC_ bool process_exists(pid_t pid);
697
698 /**
699  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
700  is dealt with in posix.c
701 **/
702 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
703
704 /**
705  * Write dump of binary data to the log file.
706  *
707  * The data is only written if the log level is at least level.
708  */
709 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
710
711 /**
712  malloc that aborts with smb_panic on fail or zero size.
713 **/
714 _PUBLIC_ void *smb_xmalloc(size_t size);
715
716 /**
717  Memdup with smb_panic on fail.
718 **/
719 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
720
721 /**
722  strdup that aborts on malloc fail.
723 **/
724 _PUBLIC_ char *smb_xstrdup(const char *s);
725
726 /**
727  Like strdup but for memory.
728 **/
729 _PUBLIC_ void *memdup(const void *p, size_t size);
730
731 /**
732  * Write a password to the log file.
733  *
734  * @note Only actually does something if DEBUG_PASSWORD was defined during 
735  * compile-time.
736  */
737 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
738
739 /**
740  * see if a range of memory is all zero. A NULL pointer is considered
741  * to be all zero 
742  */
743 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
744
745 /**
746   realloc an array, checking for integer overflow in the array size
747 */
748 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count);
749
750 /* The following definitions come from lib/util/fsusage.c  */
751
752
753 /**
754  * Retrieve amount of free disk space.
755  * this does all of the system specific guff to get the free disk space.
756  * It is derived from code in the GNU fileutils package, but has been
757  * considerably mangled for use here 
758  *
759  * results are returned in *dfree and *dsize, in 512 byte units
760 */
761 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
762
763 /* The following definitions come from lib/util/ms_fnmatch.c  */
764
765
766 /**
767  * @file
768  * @brief MS-style Filename matching
769  */
770
771 /* protocol types. It assumes that higher protocols include lower protocols
772    as subsets. FIXME: Move to one of the smb-specific headers */
773 enum protocol_types {
774         PROTOCOL_NONE,
775         PROTOCOL_CORE,
776         PROTOCOL_COREPLUS,
777         PROTOCOL_LANMAN1,
778         PROTOCOL_LANMAN2,
779         PROTOCOL_NT1,
780         PROTOCOL_SMB2
781 };
782
783
784
785 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
786
787 /** a generic fnmatch function - uses for non-CIFS pattern matching */
788 int gen_fnmatch(const char *pattern, const char *string);
789
790 /* The following definitions come from lib/util/mutex.c  */
791
792
793 /**
794   register a set of mutex/rwlock handlers. 
795   Should only be called once in the execution of smbd.
796 */
797 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
798
799 /* The following definitions come from lib/util/idtree.c  */
800
801
802 /**
803   initialise a idr tree. The context return value must be passed to
804   all subsequent idr calls. To destroy the idr tree use talloc_free()
805   on this context
806  */
807 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
808
809 /**
810   allocate the next available id, and assign 'ptr' into its slot.
811   you can retrieve later this pointer using idr_find()
812 */
813 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
814
815 /**
816    allocate a new id, giving the first available value greater than or
817    equal to the given starting id
818 */
819 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
820
821 /**
822   allocate a new id randomly in the given range
823 */
824 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
825
826 /**
827   find a pointer value previously set with idr_get_new given an id
828 */
829 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
830
831 /**
832   remove an id from the idr tree
833 */
834 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
835
836 /* The following definitions come from lib/util/become_daemon.c  */
837
838 /**
839  Become a daemon, discarding the controlling terminal.
840 **/
841 _PUBLIC_ void become_daemon(bool Fork);
842
843 #endif /* _SAMBA_UTIL_H_ */