use unsigned instead of uint32_t for LDB counters.
[Samba/cd1.git] / lib / util / util.h
blob264396efe611924be88a3c2e758a3d3d1a2a4c77
1 /*
2 Unix SMB/CIFS implementation.
3 Utility functions for Samba
4 Copyright (C) Andrew Tridgell 1992-1999
5 Copyright (C) Jelmer Vernooij 2005
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.
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.
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/>.
21 #ifndef _SAMBA_UTIL_H_
22 #define _SAMBA_UTIL_H_
24 #if _SAMBA_BUILD_ == 4
25 #include "../lib/util/charset/charset.h"
26 #endif
27 #include "../lib/util/attr.h"
29 /* for TALLOC_CTX */
30 #include <talloc.h>
32 /**
33 * @file
34 * @brief Helpful macros
37 struct smbsrv_tcon;
39 extern const char *logfile;
40 extern const char *panic_action;
42 #include "../lib/util/time.h"
43 #include "../lib/util/data_blob.h"
44 #include "../lib/util/xfile.h"
45 #include "../lib/util/mutex.h"
46 #include "../lib/util/byteorder.h"
47 #include "../lib/util/talloc_stack.h"
49 /**
50 * assert macros
52 #ifdef DEVELOPER
53 #define SMB_ASSERT(b) do { if (!(b)) { \
54 DEBUG(0,("PANIC: assert failed at %s(%d): %s\n", \
55 __FILE__, __LINE__, #b)); smb_panic("assert failed: " #b); }} while(0)
56 #else
57 /* redefine the assert macro for non-developer builds */
58 #define SMB_ASSERT(b) do { if (!(b)) { \
59 DEBUG(0,("PANIC: assert failed at %s(%d): %s\n", \
60 __FILE__, __LINE__, #b)); }} while (0)
61 #endif
63 #if _SAMBA_BUILD_ == 4
64 #ifdef VALGRIND
65 #define strlen(x) valgrind_strlen(x)
66 size_t valgrind_strlen(const char *s);
67 #endif
68 #endif
70 #ifndef ABS
71 #define ABS(a) ((a)>0?(a):(-(a)))
72 #endif
74 #include "../lib/util/memory.h"
76 /**
77 * Write backtrace to debug log
79 _PUBLIC_ void call_backtrace(void);
81 /**
82 Something really nasty happened - panic !
83 **/
84 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
86 #if _SAMBA_BUILD_ == 4
87 /**
88 setup our fault handlers
89 **/
90 _PUBLIC_ void fault_setup(const char *pname);
91 #endif
93 /**
94 register a fault handler.
95 Should only be called once in the execution of smbd.
97 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
99 /* The following definitions come from lib/util/signal.c */
103 Block sigs.
105 void BlockSignals(bool block, int signum);
108 Catch a signal. This should implement the following semantics:
110 1) The handler remains installed after being called.
111 2) The signal should be blocked during handler execution.
113 void (*CatchSignal(int signum,void (*handler)(int )))(int);
116 Ignore SIGCLD via whatever means is necessary for this OS.
118 void CatchChild(void);
121 Catch SIGCLD but leave the child around so it's status can be reaped.
123 void CatchChildLeaveStatus(void);
125 /* The following definitions come from lib/util/system.c */
127 /**************************************************************************
128 A wrapper for gethostbyname() that tries avoids looking up hostnames
129 in the root domain, which can cause dial-on-demand links to come up for no
130 apparent reason.
131 ****************************************************************************/
132 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
133 _PUBLIC_ struct in_addr sys_inet_makeaddr(int net, int host);
136 * Wrapper for fork used to invalid pid cache.
138 _PUBLIC_ pid_t sys_fork(void);
141 * Wrapper for getpid. Ensures we only do a system call *once*.
143 _PUBLIC_ pid_t sys_getpid(void);
145 /* The following definitions come from lib/util/genrand.c */
148 Copy any user given reseed data.
150 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
153 * Tell the random number generator it needs to reseed.
155 _PUBLIC_ void set_need_random_reseed(void);
158 Interface to the (hopefully) good crypto random number generator.
159 Will use our internal PRNG if more than 40 bytes of random generation
160 has been requested, otherwise tries to read from /dev/random
162 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
165 Interface to the (hopefully) good crypto random number generator.
166 Will always use /dev/urandom if available.
168 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
171 generate a single random uint32_t
173 _PUBLIC_ uint32_t generate_random(void);
176 very basic password quality checker
178 _PUBLIC_ bool check_password_quality(const char *s);
181 * Generate a random text password.
183 _PUBLIC_ char *generate_random_password(TALLOC_CTX *mem_ctx, size_t min, size_t max);
186 Use the random number generator to generate a random string.
188 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
191 * Generate a random text string consisting of the specified length.
192 * The returned string will be allocated.
194 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
196 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
199 * Generate an array of unique text strings all of the same length.
200 * The returned strings will be allocated.
201 * Returns NULL if the number of unique combinations cannot be created.
203 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
205 _PUBLIC_ char** generate_unique_strs(TALLOC_CTX *mem_ctx, size_t len,
206 uint32_t num);
208 /* The following definitions come from lib/util/dprintf.c */
209 #if _SAMBA_BUILD_ == 4
211 _PUBLIC_ void d_set_iconv(smb_iconv_t);
212 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
213 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
214 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
215 _PUBLIC_ void display_set_stderr(void);
216 #endif
218 /* The following definitions come from lib/util/util_str.c */
220 bool next_token_talloc(TALLOC_CTX *ctx,
221 const char **ptr,
222 char **pp_buff,
223 const char *sep);
226 * Get the next token from a string, return false if none found. Handles
227 * double-quotes. This version does not trim leading separator characters
228 * before looking for a token.
230 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
231 const char **ptr,
232 char **pp_buff,
233 const char *sep);
237 Trim the specified elements off the front and back of a string.
239 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
242 Find the number of 'c' chars in a string
244 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
247 Safe string copy into a known length string. maxlength does not
248 include the terminating zero.
250 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
253 Safe string cat into a string. maxlength does not
254 include the terminating zero.
256 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
259 Routine to get hex characters and turn them into a 16 byte array.
260 the array can be variable length, and any non-hex-numeric
261 characters are skipped. "0xnn" or "0Xnn" is specially catered
262 for.
264 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
268 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
270 /**
271 * Parse a hex string and return a data blob.
273 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
276 * Routine to print a buffer as HEX digits, into an allocated string.
278 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
281 * talloc version of hex_encode()
283 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
286 Substitute a string for a pattern in another string. Make sure there is
287 enough room!
289 This routine looks for pattern in s and replaces it with
290 insert. It may do multiple replacements.
292 Any of " ; ' $ or ` in the insert string are replaced with _
293 if len==0 then the string cannot be extended. This is different from the old
294 use of len==0 which was for no length checks to be done.
296 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
299 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
300 const char *pattern, const char *insert);
303 Similar to string_sub() but allows for any character to be substituted.
304 Use with caution!
305 if len==0 then the string cannot be extended. This is different from the old
306 use of len==0 which was for no length checks to be done.
308 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
311 Unescape a URL encoded string, in place.
313 _PUBLIC_ void rfc1738_unescape(char *buf);
317 * rfc1738_escape
318 * Returns a static buffer that contains the RFC
319 * 1738 compliant, escaped version of the given url. (escapes unsafe and % characters)
321 _PUBLIC_ char *rfc1738_escape(TALLOC_CTX *mem_ctx, const char *url);
324 * rfc1738_escape_unescaped
326 * Returns a static buffer that contains
327 * the RFC 1738 compliant, escaped version of the given url (escapes unsafe chars only)
329 _PUBLIC_ char *rfc1738_escape_unescaped(TALLOC_CTX *mem_ctx, const char *url);
332 * rfc1738_escape_part
333 * Returns a static buffer that contains the RFC
334 * 1738 compliant, escaped version of the given url segment. (escapes
335 * unsafe, reserved and % chars) It would mangle the :// in http://,
336 * and mangle paths (because of /).
338 _PUBLIC_ char *rfc1738_escape_part(TALLOC_CTX *mem_ctx, const char *url);
341 format a string into length-prefixed dotted domain format, as used in NBT
342 and in some ADS structures
344 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
347 * Add a string to an array of strings.
349 * num should be a pointer to an integer that holds the current
350 * number of elements in strings. It will be updated by this function.
352 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
353 const char *str, const char ***strings, int *num);
356 varient of strcmp() that handles NULL ptrs
358 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
361 return the number of bytes occupied by a buffer in ASCII format
362 the result includes the null termination
363 limited by 'n' bytes
365 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
368 Set a boolean variable from the text value stored in the passed string.
369 Returns true in success, false if the passed string does not correctly
370 represent a boolean.
372 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
375 * Parse a string containing a boolean value.
377 * val will be set to the read value.
379 * @retval true if a boolean value was parsed, false otherwise.
381 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
383 #if _SAMBA_BUILD_ == 4
385 * Convert a size specification like 16K into an integral number of bytes.
387 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
388 #endif
391 * Parse a uint64_t value from a string
393 * val will be set to the value read.
395 * @retval true if parsing was successful, false otherwise
397 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
400 return the number of bytes occupied by a buffer in CH_UTF16 format
401 the result includes the null termination
403 _PUBLIC_ size_t utf16_len(const void *buf);
406 return the number of bytes occupied by a buffer in CH_UTF16 format
407 the result includes the null termination
408 limited by 'n' bytes
410 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
411 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
414 Do a case-insensitive, whitespace-ignoring string compare.
416 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
419 String replace.
421 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
424 * Compare 2 strings.
426 * @note The comparison is case-insensitive.
428 _PUBLIC_ bool strequal(const char *s1, const char *s2);
430 /* The following definitions come from lib/util/util_strlist.c */
432 /* separators for lists */
433 #ifndef LIST_SEP
434 #define LIST_SEP " \t,\n\r"
435 #endif
438 build an empty (only NULL terminated) list of strings (for expansion with str_list_add() etc)
440 _PUBLIC_ char **str_list_make_empty(TALLOC_CTX *mem_ctx);
443 place the only element 'entry' into a new, NULL terminated string list
445 _PUBLIC_ char **str_list_make_single(TALLOC_CTX *mem_ctx,
446 const char *entry);
449 build a null terminated list of strings from a input string and a
450 separator list. The separator list must contain characters less than
451 or equal to 0x2f for this to work correctly on multi-byte strings
453 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string,
454 const char *sep);
457 * build a null terminated list of strings from an argv-like input string
458 * Entries are separated by spaces and can be enclosed by quotes.
459 * Does NOT support escaping
461 _PUBLIC_ char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
464 * join a list back to one string
466 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char separator);
468 /** join a list back to one (shell-like) string; entries
469 * separated by spaces, using quotes where necessary */
470 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
473 return the number of elements in a string list
475 _PUBLIC_ size_t str_list_length(const char * const *list);
478 copy a string list
480 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
483 Return true if all the elements of the list match exactly.
485 _PUBLIC_ bool str_list_equal(const char * const *list1, const char * const *list2);
488 add an entry to a string list
490 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
493 remove an entry from a string list
495 _PUBLIC_ void str_list_remove(const char **list, const char *s);
498 return true if a string is in a list
500 _PUBLIC_ bool str_list_check(const char **list, const char *s);
503 return true if a string is in a list, case insensitively
505 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
507 append one list to another - expanding list1
509 _PUBLIC_ const char **str_list_append(const char **list1,
510 const char * const *list2);
513 remove duplicate elements from a list
515 _PUBLIC_ const char **str_list_unique(const char **list);
518 very useful when debugging complex list related code
520 _PUBLIC_ void str_list_show(const char **list);
524 append one list to another - expanding list1
525 this assumes the elements of list2 are const pointers, so we can re-use them
527 _PUBLIC_ const char **str_list_append_const(const char **list1,
528 const char **list2);
531 add an entry to a string list
532 this assumes s will not change
534 _PUBLIC_ const char **str_list_add_const(const char **list, const char *s);
537 copy a string list
538 this assumes list will not change
540 _PUBLIC_ const char **str_list_copy_const(TALLOC_CTX *mem_ctx,
541 const char **list);
544 * Needed for making an "unconst" list "const"
546 _PUBLIC_ const char **const_str_list(char **list);
549 /* The following definitions come from lib/util/util_file.c */
553 read a line from a file with possible \ continuation chars.
554 Blanks at the start or end of a line are stripped.
555 The string will be allocated if s2 is NULL
557 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
560 * Read one line (data until next newline or eof) and allocate it
562 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
565 load a file into memory from a fd.
567 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
570 char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx);
573 load a file into memory
575 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
578 mmap (if possible) or read a file
580 _PUBLIC_ void *map_file(const char *fname, size_t size);
583 load a file into memory and return an array of pointers to lines in the file
584 must be freed with talloc_free().
586 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
589 load a fd into memory and return an array of pointers to lines in the file
590 must be freed with talloc_free(). If convert is true calls unix_to_dos on
591 the list.
593 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
596 take a list of lines and modify them to produce a list where \ continues
597 a line
599 _PUBLIC_ void file_lines_slashcont(char **lines);
602 save a lump of data into a file. Mostly used for debugging
604 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
605 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
606 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
607 _PUBLIC_ bool large_file_support(const char *path);
610 compare two files, return true if the two files have the same content
612 bool file_compare(const char *path1, const char *path2);
614 /* The following definitions come from lib/util/util.c */
618 Find a suitable temporary directory. The result should be copied immediately
619 as it may be overwritten by a subsequent call.
621 _PUBLIC_ const char *tmpdir(void);
624 Check if a file exists - call vfs_file_exist for samba files.
626 _PUBLIC_ bool file_exist(const char *fname);
629 Check a files mod time.
631 _PUBLIC_ time_t file_modtime(const char *fname);
634 Check if a directory exists.
636 _PUBLIC_ bool directory_exist(const char *dname);
639 * Try to create the specified directory if it didn't exist.
641 * @retval true if the directory already existed and has the right permissions
642 * or was successfully created.
644 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
645 mode_t dir_perms);
648 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
649 else
650 if SYSV use O_NDELAY
651 if BSD use FNDELAY
653 _PUBLIC_ int set_blocking(int fd, bool set);
656 Sleep for a specified number of milliseconds.
658 _PUBLIC_ void msleep(unsigned int t);
661 Get my own name, return in talloc'ed storage.
663 _PUBLIC_ char* get_myname(TALLOC_CTX *mem_ctx);
666 Return true if a string could be a pure IP address.
668 _PUBLIC_ bool is_ipaddress(const char *str);
671 Interpret an internet address or name into an IP address in 4 byte form.
673 _PUBLIC_ uint32_t interpret_addr(const char *str);
676 A convenient addition to interpret_addr().
678 _PUBLIC_ struct in_addr interpret_addr2(const char *str);
681 Check if an IP is the 0.0.0.0.
683 _PUBLIC_ bool is_zero_ip_v4(struct in_addr ip);
686 Are two IPs on the same subnet?
688 _PUBLIC_ bool same_net_v4(struct in_addr ip1,struct in_addr ip2,struct in_addr mask);
690 _PUBLIC_ bool is_ipaddress_v4(const char *str);
693 Check if a process exists. Does this work on all unixes?
695 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
698 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
699 is dealt with in posix.c
701 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
704 * Write dump of binary data to the log file.
706 * The data is only written if the log level is at least level.
708 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
711 * Write dump of binary data to the log file.
713 * The data is only written if the log level is at least level.
714 * 16 zero bytes in a row are omitted
716 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
719 malloc that aborts with smb_panic on fail or zero size.
721 _PUBLIC_ void *smb_xmalloc(size_t size);
724 Memdup with smb_panic on fail.
726 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
729 strdup that aborts on malloc fail.
731 _PUBLIC_ char *smb_xstrdup(const char *s);
733 char *smb_xstrndup(const char *s, size_t n);
736 Like strdup but for memory.
738 _PUBLIC_ void *memdup(const void *p, size_t size);
741 * Write a password to the log file.
743 * @note Only actually does something if DEBUG_PASSWORD was defined during
744 * compile-time.
746 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
749 * see if a range of memory is all zero. A NULL pointer is considered
750 * to be all zero
752 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
755 realloc an array, checking for integer overflow in the array size
757 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
759 void *malloc_array(size_t el_size, unsigned int count);
761 /* The following definitions come from lib/util/fsusage.c */
765 * Retrieve amount of free disk space.
766 * this does all of the system specific guff to get the free disk space.
767 * It is derived from code in the GNU fileutils package, but has been
768 * considerably mangled for use here
770 * results are returned in *dfree and *dsize, in 512 byte units
772 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
774 /* The following definitions come from lib/util/ms_fnmatch.c */
778 * @file
779 * @brief MS-style Filename matching
782 #if _SAMBA_BUILD_ == 4
783 /* protocol types. It assumes that higher protocols include lower protocols
784 as subsets. FIXME: Move to one of the smb-specific headers */
785 enum protocol_types {
786 PROTOCOL_NONE,
787 PROTOCOL_CORE,
788 PROTOCOL_COREPLUS,
789 PROTOCOL_LANMAN1,
790 PROTOCOL_LANMAN2,
791 PROTOCOL_NT1,
792 PROTOCOL_SMB2
795 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
797 /** a generic fnmatch function - uses for non-CIFS pattern matching */
798 int gen_fnmatch(const char *pattern, const char *string);
799 #endif
801 /* The following definitions come from lib/util/mutex.c */
805 register a set of mutex/rwlock handlers.
806 Should only be called once in the execution of smbd.
808 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
810 /* The following definitions come from lib/util/idtree.c */
814 initialise a idr tree. The context return value must be passed to
815 all subsequent idr calls. To destroy the idr tree use talloc_free()
816 on this context
818 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
821 allocate the next available id, and assign 'ptr' into its slot.
822 you can retrieve later this pointer using idr_find()
824 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
827 allocate a new id, giving the first available value greater than or
828 equal to the given starting id
830 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
833 allocate a new id randomly in the given range
835 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
838 find a pointer value previously set with idr_get_new given an id
840 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
843 remove an id from the idr tree
845 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
847 /* The following definitions come from lib/util/become_daemon.c */
850 Close the low 3 fd's and open dev/null in their place
852 _PUBLIC_ void close_low_fds(bool stderr_too);
855 Become a daemon, discarding the controlling terminal.
857 _PUBLIC_ void become_daemon(bool do_fork, bool no_process_group);
860 * Load a ini-style file.
862 bool pm_process( const char *fileName,
863 bool (*sfunc)(const char *, void *),
864 bool (*pfunc)(const char *, const char *, void *),
865 void *userdata);
867 bool unmap_file(void *start, size_t size);
869 void print_asc(int level, const uint8_t *buf,int len);
872 * Add an id to an array of ids.
874 * num should be a pointer to an integer that holds the current
875 * number of elements in ids. It will be updated by this function.
878 bool add_uid_to_array_unique(TALLOC_CTX *mem_ctx, uid_t uid,
879 uid_t **uids, size_t *num_uids);
880 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
881 gid_t **gids, size_t *num_gids);
884 run a command as a child process, with a timeout.
886 any stdout/stderr from the child will appear in the Samba logs with
887 the specified log levels
889 If callback is set then the callback is called on completion
890 with the return code from the command
892 struct tevent_context;
893 struct composite_context *samba_runcmd(struct tevent_context *ev,
894 TALLOC_CTX *mem_ctx,
895 struct timeval timeout,
896 int stdout_log_level,
897 int stderr_log_level,
898 const char **argv0, ...);
901 #endif /* _SAMBA_UTIL_H_ */