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/charset/charset.h"
27 #include "../lib/util/attr.h"
34 * @brief Helpful macros
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"
49 this is a warning hack. The idea is to use this everywhere that we
50 get the "discarding const" warning from gcc. That doesn't actually
51 fix the problem of course, but it means that when we do get to
52 cleaning them up we can do it by searching the code for
55 It also means that other error types aren't as swamped by the noise
56 of hundreds of const warnings, so we are more likely to notice when
59 Please only add more uses of this macro when you find it
60 _really_ hard to fix const warnings. Our aim is to eventually use
61 this function in only a very few places.
63 Also, please call this via the discard_const_p() macro interface, as that
64 makes the return type safe.
67 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
70 /** Type-safe version of discard_const */
71 #ifndef discard_const_p
72 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
78 #define SMB_ASSERT(b) do { if (!(b)) { \
79 DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
80 smb_panic("assert failed"); }} while (0)
83 #define strlen(x) valgrind_strlen(x)
86 #include "../lib/util/memory.h"
89 * Write backtrace to debug log
91 _PUBLIC_ void call_backtrace(void);
94 Something really nasty happened - panic !
96 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
99 setup our fault handlers
101 _PUBLIC_ void fault_setup(const char *pname);
104 register a fault handler.
105 Should only be called once in the execution of smbd.
107 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
109 /* The following definitions come from lib/util/signal.c */
115 void BlockSignals(bool block, int signum);
118 Catch a signal. This should implement the following semantics:
120 1) The handler remains installed after being called.
121 2) The signal should be blocked during handler execution.
123 void (*CatchSignal(int signum,void (*handler)(int )))(int);
126 Ignore SIGCLD via whatever means is necessary for this OS.
128 void CatchChild(void);
131 Catch SIGCLD but leave the child around so it's status can be reaped.
133 void CatchChildLeaveStatus(void);
135 /* The following definitions come from lib/util/system.c */
140 /**************************************************************************
141 A wrapper for gethostbyname() that tries avoids looking up hostnames
142 in the root domain, which can cause dial-on-demand links to come up for no
144 ****************************************************************************/
145 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
146 _PUBLIC_ struct in_addr sys_inet_makeaddr(int net, int host);
148 /* The following definitions come from lib/util/genrand.c */
151 Copy any user given reseed data.
153 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
156 * Tell the random number generator it needs to reseed.
158 _PUBLIC_ void set_need_random_reseed(void);
161 Interface to the (hopefully) good crypto random number generator.
162 Will use our internal PRNG if more than 40 bytes of random generation
163 has been requested, otherwise tries to read from /dev/random
165 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
168 Interface to the (hopefully) good crypto random number generator.
169 Will always use /dev/urandom if available.
171 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
174 generate a single random uint32_t
176 _PUBLIC_ uint32_t generate_random(void);
179 very basic password quality checker
181 _PUBLIC_ bool check_password_quality(const char *s);
184 Use the random number generator to generate a random string.
186 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
189 * Generate a random text string consisting of the specified length.
190 * The returned string will be allocated.
192 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
194 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
196 /* The following definitions come from lib/util/dprintf.c */
198 _PUBLIC_ void d_set_iconv(smb_iconv_t);
199 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
200 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
201 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
202 _PUBLIC_ void display_set_stderr(void);
204 /* The following definitions come from lib/util/util_str.c */
208 Trim the specified elements off the front and back of a string.
210 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
213 Find the number of 'c' chars in a string
215 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
218 Safe string copy into a known length string. maxlength does not
219 include the terminating zero.
221 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
224 Safe string cat into a string. maxlength does not
225 include the terminating zero.
227 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
230 Routine to get hex characters and turn them into a 16 byte array.
231 the array can be variable length, and any non-hex-numeric
232 characters are skipped. "0xnn" or "0Xnn" is specially catered
235 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
239 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
242 * Parse a hex string and return a data blob.
244 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
247 * Routine to print a buffer as HEX digits, into an allocated string.
249 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
252 * talloc version of hex_encode()
254 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
257 Substitute a string for a pattern in another string. Make sure there is
260 This routine looks for pattern in s and replaces it with
261 insert. It may do multiple replacements.
263 Any of " ; ' $ or ` in the insert string are replaced with _
264 if len==0 then the string cannot be extended. This is different from the old
265 use of len==0 which was for no length checks to be done.
267 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
270 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
271 const char *pattern, const char *insert);
274 Similar to string_sub() but allows for any character to be substituted.
276 if len==0 then the string cannot be extended. This is different from the old
277 use of len==0 which was for no length checks to be done.
279 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
282 Unescape a URL encoded string, in place.
284 _PUBLIC_ void rfc1738_unescape(char *buf);
285 size_t valgrind_strlen(const char *s);
288 format a string into length-prefixed dotted domain format, as used in NBT
289 and in some ADS structures
291 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
294 * Add a string to an array of strings.
296 * num should be a pointer to an integer that holds the current
297 * number of elements in strings. It will be updated by this function.
299 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
300 const char *str, const char ***strings, int *num);
303 varient of strcmp() that handles NULL ptrs
305 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
308 return the number of bytes occupied by a buffer in ASCII format
309 the result includes the null termination
312 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
315 Return a string representing a CIFS attribute for a file.
317 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
320 Set a boolean variable from the text value stored in the passed string.
321 Returns true in success, false if the passed string does not correctly
324 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
327 * Parse a string containing a boolean value.
329 * val will be set to the read value.
331 * @retval true if a boolean value was parsed, false otherwise.
333 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
336 * Convert a size specification like 16K into an integral number of bytes.
338 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
341 * Parse a uint64_t value from a string
343 * val will be set to the value read.
345 * @retval true if parsing was successful, false otherwise
347 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
350 return the number of bytes occupied by a buffer in CH_UTF16 format
351 the result includes the null termination
353 _PUBLIC_ size_t utf16_len(const void *buf);
356 return the number of bytes occupied by a buffer in CH_UTF16 format
357 the result includes the null termination
360 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
361 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
364 Do a case-insensitive, whitespace-ignoring string compare.
366 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
371 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
376 * @note The comparison is case-insensitive.
378 _PUBLIC_ bool strequal(const char *s1, const char *s2);
380 /* The following definitions come from lib/util/util_strlist.c */
384 build a null terminated list of strings from a input string and a
385 separator list. The separator list must contain characters less than
386 or equal to 0x2f for this to work correctly on multi-byte strings
388 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
391 * build a null terminated list of strings from an argv-like input string
392 * Entries are seperated by spaces and can be enclosed by quotes.
393 * Does NOT support escaping
395 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
398 * join a list back to one string
400 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
402 /** join a list back to one (shell-like) string; entries
403 * seperated by spaces, using quotes where necessary */
404 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
407 return the number of elements in a string list
409 _PUBLIC_ size_t str_list_length(const char * const *list);
414 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
417 Return true if all the elements of the list match exactly.
419 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
422 add an entry to a string list
424 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
427 remove an entry from a string list
429 _PUBLIC_ void str_list_remove(const char **list, const char *s);
432 return true if a string is in a list
434 _PUBLIC_ bool str_list_check(const char **list, const char *s);
437 return true if a string is in a list, case insensitively
439 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
441 /* The following definitions come from lib/util/util_file.c */
445 read a line from a file with possible \ continuation chars.
446 Blanks at the start or end of a line are stripped.
447 The string will be allocated if s2 is NULL
449 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
452 * Read one line (data until next newline or eof) and allocate it
454 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
457 load a file into memory from a fd.
459 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
462 load a file into memory
464 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
467 mmap (if possible) or read a file
469 _PUBLIC_ void *map_file(const char *fname, size_t size);
472 load a file into memory and return an array of pointers to lines in the file
473 must be freed with talloc_free().
475 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
478 load a fd into memory and return an array of pointers to lines in the file
479 must be freed with talloc_free(). If convert is true calls unix_to_dos on
482 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
485 take a list of lines and modify them to produce a list where \ continues
488 _PUBLIC_ void file_lines_slashcont(char **lines);
491 save a lump of data into a file. Mostly used for debugging
493 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
494 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
495 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
496 _PUBLIC_ bool large_file_support(const char *path);
498 /* The following definitions come from lib/util/util.c */
502 Find a suitable temporary directory. The result should be copied immediately
503 as it may be overwritten by a subsequent call.
505 _PUBLIC_ const char *tmpdir(void);
508 Check if a file exists - call vfs_file_exist for samba files.
510 _PUBLIC_ bool file_exist(const char *fname);
513 Check a files mod time.
515 _PUBLIC_ time_t file_modtime(const char *fname);
518 Check if a directory exists.
520 _PUBLIC_ bool directory_exist(const char *dname);
523 * Try to create the specified directory if it didn't exist.
525 * @retval true if the directory already existed and has the right permissions
526 * or was successfully created.
528 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
532 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
537 _PUBLIC_ int set_blocking(int fd, bool set);
540 Sleep for a specified number of milliseconds.
542 _PUBLIC_ void msleep(unsigned int t);
545 Get my own name, return in malloc'ed storage.
547 _PUBLIC_ char* get_myname(void);
550 Return true if a string could be a pure IP address.
552 _PUBLIC_ bool is_ipaddress(const char *str);
555 Interpret an internet address or name into an IP address in 4 byte form.
557 _PUBLIC_ uint32_t interpret_addr(const char *str);
560 A convenient addition to interpret_addr().
562 _PUBLIC_ struct in_addr interpret_addr2(const char *str);
565 Check if an IP is the 0.0.0.0.
567 _PUBLIC_ bool is_zero_ip(struct in_addr ip);
570 Are two IPs on the same subnet?
572 _PUBLIC_ bool same_net(struct in_addr ip1,struct in_addr ip2,struct in_addr mask);
575 Check if a process exists. Does this work on all unixes?
577 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
580 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
581 is dealt with in posix.c
583 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
586 * Write dump of binary data to the log file.
588 * The data is only written if the log level is at least level.
590 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
593 * Write dump of binary data to the log file.
595 * The data is only written if the log level is at least level.
596 * 16 zero bytes in a row are ommited
598 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
601 malloc that aborts with smb_panic on fail or zero size.
603 _PUBLIC_ void *smb_xmalloc(size_t size);
606 Memdup with smb_panic on fail.
608 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
611 strdup that aborts on malloc fail.
613 _PUBLIC_ char *smb_xstrdup(const char *s);
616 Like strdup but for memory.
618 _PUBLIC_ void *memdup(const void *p, size_t size);
621 * Write a password to the log file.
623 * @note Only actually does something if DEBUG_PASSWORD was defined during
626 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
629 * see if a range of memory is all zero. A NULL pointer is considered
632 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
635 realloc an array, checking for integer overflow in the array size
637 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
639 /* The following definitions come from lib/util/fsusage.c */
643 * Retrieve amount of free disk space.
644 * this does all of the system specific guff to get the free disk space.
645 * It is derived from code in the GNU fileutils package, but has been
646 * considerably mangled for use here
648 * results are returned in *dfree and *dsize, in 512 byte units
650 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
652 /* The following definitions come from lib/util/ms_fnmatch.c */
657 * @brief MS-style Filename matching
660 /* protocol types. It assumes that higher protocols include lower protocols
661 as subsets. FIXME: Move to one of the smb-specific headers */
662 enum protocol_types {
672 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
674 /** a generic fnmatch function - uses for non-CIFS pattern matching */
675 int gen_fnmatch(const char *pattern, const char *string);
677 /* The following definitions come from lib/util/mutex.c */
681 register a set of mutex/rwlock handlers.
682 Should only be called once in the execution of smbd.
684 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
686 /* The following definitions come from lib/util/idtree.c */
690 initialise a idr tree. The context return value must be passed to
691 all subsequent idr calls. To destroy the idr tree use talloc_free()
694 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
697 allocate the next available id, and assign 'ptr' into its slot.
698 you can retrieve later this pointer using idr_find()
700 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
703 allocate a new id, giving the first available value greater than or
704 equal to the given starting id
706 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
709 allocate a new id randomly in the given range
711 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
714 find a pointer value previously set with idr_get_new given an id
716 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
719 remove an id from the idr tree
721 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
723 /* The following definitions come from lib/util/become_daemon.c */
726 Become a daemon, discarding the controlling terminal.
728 _PUBLIC_ void become_daemon(bool fork);
731 * Load a ini-style file.
733 bool pm_process( const char *fileName,
734 bool (*sfunc)(const char *, void *),
735 bool (*pfunc)(const char *, const char *, void *),
739 * Add-on to talloc_get_type
741 _PUBLIC_ void *talloc_check_name_abort(const void *ptr, const char *name);
742 #define talloc_get_type_abort(ptr, type) \
743 (type *)talloc_check_name_abort(ptr, #type)
745 #endif /* _SAMBA_UTIL_H_ */