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 #include "lib/charset/charset.h"
25 #include "../lib/util/attr.h"
32 * @brief Helpful macros
37 extern const char *logfile
;
38 extern const char *panic_action
;
40 #include "../lib/util/time.h"
41 #include "../lib/util/data_blob.h"
42 #include "../lib/util/xfile.h"
43 #include "../lib/util/mutex.h"
44 #include "../lib/util/byteorder.h"
47 this is a warning hack. The idea is to use this everywhere that we
48 get the "discarding const" warning from gcc. That doesn't actually
49 fix the problem of course, but it means that when we do get to
50 cleaning them up we can do it by searching the code for
53 It also means that other error types aren't as swamped by the noise
54 of hundreds of const warnings, so we are more likely to notice when
57 Please only add more uses of this macro when you find it
58 _really_ hard to fix const warnings. Our aim is to eventually use
59 this function in only a very few places.
61 Also, please call this via the discard_const_p() macro interface, as that
62 makes the return type safe.
65 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
68 /** Type-safe version of discard_const */
69 #ifndef discard_const_p
70 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
76 #define SMB_ASSERT(b) do { if (!(b)) { \
77 DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
78 smb_panic("assert failed"); }} while (0)
80 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
82 * Free memory if the pointer and zero the pointer.
84 * @note You are explicitly allowed to pass NULL pointers -- they will
87 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
91 * Type-safe version of malloc. Allocated one copy of the
92 * specified data type.
94 #define malloc_p(type) (type *)malloc(sizeof(type))
97 * Allocate an array of elements of one data type. Does type-checking.
99 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
102 * Resize an array of elements of one data type. Does type-checking.
104 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
106 #if defined(VALGRIND)
107 #define strlen(x) valgrind_strlen(x)
114 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
118 * zero a structure given a pointer to the structure
121 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
125 * zero a structure given a pointer to the structure - no zero check
127 #ifndef ZERO_STRUCTPN
128 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
131 /* zero an array - note that sizeof(array) must work - ie. it must not be a
134 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
138 * work out how many elements there are in a static array
141 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
145 * pointer difference macro
148 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
151 /* The following definitions come from lib/util/fault.c */
155 * Write backtrace to debug log
157 _PUBLIC_
void call_backtrace(void);
160 Something really nasty happened - panic !
162 _PUBLIC_ _NORETURN_
void smb_panic(const char *why
);
165 setup our fault handlers
167 _PUBLIC_
void fault_setup(const char *pname
);
170 register a fault handler.
171 Should only be called once in the execution of smbd.
173 _PUBLIC_
bool register_fault_handler(const char *name
, void (*fault_handler
)(int sig
));
175 /* The following definitions come from lib/util/signal.c */
181 void BlockSignals(bool block
, int signum
);
184 Catch a signal. This should implement the following semantics:
186 1) The handler remains installed after being called.
187 2) The signal should be blocked during handler execution.
189 void (*CatchSignal(int signum
,void (*handler
)(int )))(int);
192 Ignore SIGCLD via whatever means is necessary for this OS.
194 void CatchChild(void);
197 Catch SIGCLD but leave the child around so it's status can be reaped.
199 void CatchChildLeaveStatus(void);
201 /* The following definitions come from lib/util/system.c */
206 /**************************************************************************
207 A wrapper for gethostbyname() that tries avoids looking up hostnames
208 in the root domain, which can cause dial-on-demand links to come up for no
210 ****************************************************************************/
211 _PUBLIC_
struct hostent
*sys_gethostbyname(const char *name
);
212 _PUBLIC_
struct in_addr
sys_inet_makeaddr(int net
, int host
);
214 /* The following definitions come from lib/util/genrand.c */
217 Copy any user given reseed data.
219 _PUBLIC_
void set_rand_reseed_callback(void (*fn
)(void *, int *), void *);
222 * Tell the random number generator it needs to reseed.
224 _PUBLIC_
void set_need_random_reseed(void);
227 Interface to the (hopefully) good crypto random number generator.
228 Will use our internal PRNG if more than 40 bytes of random generation
229 has been requested, otherwise tries to read from /dev/random
231 _PUBLIC_
void generate_random_buffer(uint8_t *out
, int len
);
234 Interface to the (hopefully) good crypto random number generator.
235 Will always use /dev/urandom if available.
237 _PUBLIC_
void generate_secret_buffer(uint8_t *out
, int len
);
240 generate a single random uint32_t
242 _PUBLIC_
uint32_t generate_random(void);
245 very basic password quality checker
247 _PUBLIC_
bool check_password_quality(const char *s
);
250 Use the random number generator to generate a random string.
252 _PUBLIC_
char *generate_random_str_list(TALLOC_CTX
*mem_ctx
, size_t len
, const char *list
);
255 * Generate a random text string consisting of the specified length.
256 * The returned string will be allocated.
258 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
260 _PUBLIC_
char *generate_random_str(TALLOC_CTX
*mem_ctx
, size_t len
);
262 /* The following definitions come from lib/util/dprintf.c */
264 _PUBLIC_
void d_set_iconv(smb_iconv_t
);
265 _PUBLIC_
int d_vfprintf(FILE *f
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
266 _PUBLIC_
int d_fprintf(FILE *f
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
267 _PUBLIC_
int d_printf(const char *format
, ...) PRINTF_ATTRIBUTE(1,2);
268 _PUBLIC_
void display_set_stderr(void);
270 /* The following definitions come from lib/util/util_str.c */
274 Trim the specified elements off the front and back of a string.
276 _PUBLIC_
bool trim_string(char *s
, const char *front
, const char *back
);
279 Find the number of 'c' chars in a string
281 _PUBLIC_ _PURE_
size_t count_chars(const char *s
, char c
);
284 Safe string copy into a known length string. maxlength does not
285 include the terminating zero.
287 _PUBLIC_
char *safe_strcpy(char *dest
,const char *src
, size_t maxlength
);
290 Safe string cat into a string. maxlength does not
291 include the terminating zero.
293 _PUBLIC_
char *safe_strcat(char *dest
, const char *src
, size_t maxlength
);
296 Routine to get hex characters and turn them into a 16 byte array.
297 the array can be variable length, and any non-hex-numeric
298 characters are skipped. "0xnn" or "0Xnn" is specially catered
301 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
305 _PUBLIC_
size_t strhex_to_str(char *p
, size_t len
, const char *strhex
);
308 * Parse a hex string and return a data blob.
310 _PUBLIC_ _PURE_ DATA_BLOB
strhex_to_data_blob(const char *strhex
) ;
313 * Routine to print a buffer as HEX digits, into an allocated string.
315 _PUBLIC_
void hex_encode(const unsigned char *buff_in
, size_t len
, char **out_hex_buffer
);
318 * talloc version of hex_encode()
320 _PUBLIC_
char *hex_encode_talloc(TALLOC_CTX
*mem_ctx
, const unsigned char *buff_in
, size_t len
);
323 Substitute a string for a pattern in another string. Make sure there is
326 This routine looks for pattern in s and replaces it with
327 insert. It may do multiple replacements.
329 Any of " ; ' $ or ` in the insert string are replaced with _
330 if len==0 then the string cannot be extended. This is different from the old
331 use of len==0 which was for no length checks to be done.
333 _PUBLIC_
void string_sub(char *s
,const char *pattern
, const char *insert
, size_t len
);
336 _PUBLIC_
char *string_sub_talloc(TALLOC_CTX
*mem_ctx
, const char *s
,
337 const char *pattern
, const char *insert
);
340 Similar to string_sub() but allows for any character to be substituted.
342 if len==0 then the string cannot be extended. This is different from the old
343 use of len==0 which was for no length checks to be done.
345 _PUBLIC_
void all_string_sub(char *s
,const char *pattern
,const char *insert
, size_t len
);
348 Unescape a URL encoded string, in place.
350 _PUBLIC_
void rfc1738_unescape(char *buf
);
351 size_t valgrind_strlen(const char *s
);
354 format a string into length-prefixed dotted domain format, as used in NBT
355 and in some ADS structures
357 _PUBLIC_
const char *str_format_nbt_domain(TALLOC_CTX
*mem_ctx
, const char *s
);
360 * Add a string to an array of strings.
362 * num should be a pointer to an integer that holds the current
363 * number of elements in strings. It will be updated by this function.
365 _PUBLIC_
bool add_string_to_array(TALLOC_CTX
*mem_ctx
,
366 const char *str
, const char ***strings
, int *num
);
369 varient of strcmp() that handles NULL ptrs
371 _PUBLIC_
int strcmp_safe(const char *s1
, const char *s2
);
374 return the number of bytes occupied by a buffer in ASCII format
375 the result includes the null termination
378 _PUBLIC_
size_t ascii_len_n(const char *src
, size_t n
);
381 Return a string representing a CIFS attribute for a file.
383 _PUBLIC_
char *attrib_string(TALLOC_CTX
*mem_ctx
, uint32_t attrib
);
386 Set a boolean variable from the text value stored in the passed string.
387 Returns true in success, false if the passed string does not correctly
390 _PUBLIC_
bool set_boolean(const char *boolean_string
, bool *boolean
);
393 * Parse a string containing a boolean value.
395 * val will be set to the read value.
397 * @retval true if a boolean value was parsed, false otherwise.
399 _PUBLIC_
bool conv_str_bool(const char * str
, bool * val
);
402 * Convert a size specification like 16K into an integral number of bytes.
404 _PUBLIC_
bool conv_str_size(const char * str
, uint64_t * val
);
407 * Parse a uint64_t value from a string
409 * val will be set to the value read.
411 * @retval true if parsing was successful, false otherwise
413 _PUBLIC_
bool conv_str_u64(const char * str
, uint64_t * val
);
416 return the number of bytes occupied by a buffer in CH_UTF16 format
417 the result includes the null termination
419 _PUBLIC_
size_t utf16_len(const void *buf
);
422 return the number of bytes occupied by a buffer in CH_UTF16 format
423 the result includes the null termination
426 _PUBLIC_
size_t utf16_len_n(const void *src
, size_t n
);
427 _PUBLIC_
size_t ucs2_align(const void *base_ptr
, const void *p
, int flags
);
430 Do a case-insensitive, whitespace-ignoring string compare.
432 _PUBLIC_
int strwicmp(const char *psz1
, const char *psz2
);
437 _PUBLIC_
void string_replace(char *s
, char oldc
, char newc
);
442 * @note The comparison is case-insensitive.
444 _PUBLIC_
bool strequal(const char *s1
, const char *s2
);
446 /* The following definitions come from lib/util/util_strlist.c */
450 build a null terminated list of strings from a input string and a
451 separator list. The separator list must contain characters less than
452 or equal to 0x2f for this to work correctly on multi-byte strings
454 _PUBLIC_
char **str_list_make(TALLOC_CTX
*mem_ctx
, const char *string
, const char *sep
);
457 * build a null terminated list of strings from an argv-like input string
458 * Entries are seperated by spaces and can be enclosed by quotes.
459 * Does NOT support escaping
461 _PUBLIC_
const 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 seperator
);
468 /** join a list back to one (shell-like) string; entries
469 * seperated 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
);
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 **list1
, const char **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 /* The following definitions come from lib/util/util_file.c */
511 read a line from a file with possible \ continuation chars.
512 Blanks at the start or end of a line are stripped.
513 The string will be allocated if s2 is NULL
515 _PUBLIC_
char *fgets_slash(char *s2
,int maxlen
,XFILE
*f
);
518 * Read one line (data until next newline or eof) and allocate it
520 _PUBLIC_
char *afdgets(int fd
, TALLOC_CTX
*mem_ctx
, size_t hint
);
523 load a file into memory from a fd.
525 _PUBLIC_
char *fd_load(int fd
, size_t *size
, size_t maxsize
, TALLOC_CTX
*mem_ctx
);
528 load a file into memory
530 _PUBLIC_
char *file_load(const char *fname
, size_t *size
, size_t maxsize
, TALLOC_CTX
*mem_ctx
);
533 mmap (if possible) or read a file
535 _PUBLIC_
void *map_file(const char *fname
, size_t size
);
538 load a file into memory and return an array of pointers to lines in the file
539 must be freed with talloc_free().
541 _PUBLIC_
char **file_lines_load(const char *fname
, int *numlines
, size_t maxsize
, TALLOC_CTX
*mem_ctx
);
544 load a fd into memory and return an array of pointers to lines in the file
545 must be freed with talloc_free(). If convert is true calls unix_to_dos on
548 _PUBLIC_
char **fd_lines_load(int fd
, int *numlines
, size_t maxsize
, TALLOC_CTX
*mem_ctx
);
551 take a list of lines and modify them to produce a list where \ continues
554 _PUBLIC_
void file_lines_slashcont(char **lines
);
557 save a lump of data into a file. Mostly used for debugging
559 _PUBLIC_
bool file_save(const char *fname
, const void *packet
, size_t length
);
560 _PUBLIC_
int vfdprintf(int fd
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
561 _PUBLIC_
int fdprintf(int fd
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
562 _PUBLIC_
bool large_file_support(const char *path
);
564 /* The following definitions come from lib/util/util.c */
568 Find a suitable temporary directory. The result should be copied immediately
569 as it may be overwritten by a subsequent call.
571 _PUBLIC_
const char *tmpdir(void);
574 Check if a file exists - call vfs_file_exist for samba files.
576 _PUBLIC_
bool file_exist(const char *fname
);
579 Check a files mod time.
581 _PUBLIC_
time_t file_modtime(const char *fname
);
584 Check if a directory exists.
586 _PUBLIC_
bool directory_exist(const char *dname
);
589 * Try to create the specified directory if it didn't exist.
591 * @retval true if the directory already existed and has the right permissions
592 * or was successfully created.
594 _PUBLIC_
bool directory_create_or_exist(const char *dname
, uid_t uid
,
598 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
603 _PUBLIC_
int set_blocking(int fd
, bool set
);
606 Sleep for a specified number of milliseconds.
608 _PUBLIC_
void msleep(unsigned int t
);
611 Get my own name, return in malloc'ed storage.
613 _PUBLIC_
char* get_myname(void);
616 Return true if a string could be a pure IP address.
618 _PUBLIC_
bool is_ipaddress(const char *str
);
621 Interpret an internet address or name into an IP address in 4 byte form.
623 _PUBLIC_
uint32_t interpret_addr(const char *str
);
626 A convenient addition to interpret_addr().
628 _PUBLIC_
struct in_addr
interpret_addr2(const char *str
);
631 Check if an IP is the 0.0.0.0.
633 _PUBLIC_
bool is_zero_ip(struct in_addr ip
);
636 Are two IPs on the same subnet?
638 _PUBLIC_
bool same_net(struct in_addr ip1
,struct in_addr ip2
,struct in_addr mask
);
641 Check if a process exists. Does this work on all unixes?
643 _PUBLIC_
bool process_exists(pid_t pid
);
646 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
647 is dealt with in posix.c
649 _PUBLIC_
bool fcntl_lock(int fd
, int op
, off_t offset
, off_t count
, int type
);
652 * Write dump of binary data to the log file.
654 * The data is only written if the log level is at least level.
656 _PUBLIC_
void dump_data(int level
, const uint8_t *buf
,int len
);
659 * Write dump of binary data to the log file.
661 * The data is only written if the log level is at least level.
662 * 16 zero bytes in a row are ommited
664 _PUBLIC_
void dump_data_skip_zeros(int level
, const uint8_t *buf
, int len
);
667 malloc that aborts with smb_panic on fail or zero size.
669 _PUBLIC_
void *smb_xmalloc(size_t size
);
672 Memdup with smb_panic on fail.
674 _PUBLIC_
void *smb_xmemdup(const void *p
, size_t size
);
677 strdup that aborts on malloc fail.
679 _PUBLIC_
char *smb_xstrdup(const char *s
);
682 Like strdup but for memory.
684 _PUBLIC_
void *memdup(const void *p
, size_t size
);
687 * Write a password to the log file.
689 * @note Only actually does something if DEBUG_PASSWORD was defined during
692 _PUBLIC_
void dump_data_pw(const char *msg
, const uint8_t * data
, size_t len
);
695 * see if a range of memory is all zero. A NULL pointer is considered
698 _PUBLIC_
bool all_zero(const uint8_t *ptr
, size_t size
);
701 realloc an array, checking for integer overflow in the array size
703 _PUBLIC_
void *realloc_array(void *ptr
, size_t el_size
, unsigned count
);
705 /* The following definitions come from lib/util/fsusage.c */
709 * Retrieve amount of free disk space.
710 * this does all of the system specific guff to get the free disk space.
711 * It is derived from code in the GNU fileutils package, but has been
712 * considerably mangled for use here
714 * results are returned in *dfree and *dsize, in 512 byte units
716 _PUBLIC_
int sys_fsusage(const char *path
, uint64_t *dfree
, uint64_t *dsize
);
718 /* The following definitions come from lib/util/ms_fnmatch.c */
723 * @brief MS-style Filename matching
726 /* protocol types. It assumes that higher protocols include lower protocols
727 as subsets. FIXME: Move to one of the smb-specific headers */
728 enum protocol_types
{
738 int ms_fnmatch(const char *pattern
, const char *string
, enum protocol_types protocol
);
740 /** a generic fnmatch function - uses for non-CIFS pattern matching */
741 int gen_fnmatch(const char *pattern
, const char *string
);
743 /* The following definitions come from lib/util/mutex.c */
747 register a set of mutex/rwlock handlers.
748 Should only be called once in the execution of smbd.
750 _PUBLIC_
bool register_mutex_handlers(const char *name
, struct mutex_ops
*ops
);
752 /* The following definitions come from lib/util/idtree.c */
756 initialise a idr tree. The context return value must be passed to
757 all subsequent idr calls. To destroy the idr tree use talloc_free()
760 _PUBLIC_
struct idr_context
*idr_init(TALLOC_CTX
*mem_ctx
);
763 allocate the next available id, and assign 'ptr' into its slot.
764 you can retrieve later this pointer using idr_find()
766 _PUBLIC_
int idr_get_new(struct idr_context
*idp
, void *ptr
, int limit
);
769 allocate a new id, giving the first available value greater than or
770 equal to the given starting id
772 _PUBLIC_
int idr_get_new_above(struct idr_context
*idp
, void *ptr
, int starting_id
, int limit
);
775 allocate a new id randomly in the given range
777 _PUBLIC_
int idr_get_new_random(struct idr_context
*idp
, void *ptr
, int limit
);
780 find a pointer value previously set with idr_get_new given an id
782 _PUBLIC_
void *idr_find(struct idr_context
*idp
, int id
);
785 remove an id from the idr tree
787 _PUBLIC_
int idr_remove(struct idr_context
*idp
, int id
);
789 /* The following definitions come from lib/util/become_daemon.c */
792 Become a daemon, discarding the controlling terminal.
794 _PUBLIC_
void become_daemon(bool fork
);
797 * Load a ini-style file.
799 bool pm_process( const char *fileName
,
800 bool (*sfunc
)(const char *, void *),
801 bool (*pfunc
)(const char *, const char *, void *),
805 * Add-on to talloc_get_type
807 _PUBLIC_
void *talloc_check_name_abort(const void *ptr
, const char *name
);
808 #define talloc_get_type_abort(ptr, type) \
809 (type *)talloc_check_name_abort(ptr, #type)
811 #endif /* _SAMBA_UTIL_H_ */