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