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/util/attr.h"
26 #include "charset/charset.h"
33 * @brief Helpful macros
38 extern const char *logfile;
39 extern const char *panic_action;
41 #include "../lib/util/time.h"
42 #include "../lib/util/data_blob.h"
43 #include "../lib/util/xfile.h"
44 #include "../lib/util/mutex.h"
45 #include "../lib/util/byteorder.h"
48 this is a warning hack. The idea is to use this everywhere that we
49 get the "discarding const" warning from gcc. That doesn't actually
50 fix the problem of course, but it means that when we do get to
51 cleaning them up we can do it by searching the code for
54 It also means that other error types aren't as swamped by the noise
55 of hundreds of const warnings, so we are more likely to notice when
58 Please only add more uses of this macro when you find it
59 _really_ hard to fix const warnings. Our aim is to eventually use
60 this function in only a very few places.
62 Also, please call this via the discard_const_p() macro interface, as that
63 makes the return type safe.
66 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
69 /** Type-safe version of discard_const */
70 #ifndef discard_const_p
71 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
77 #define SMB_ASSERT(b) do { if (!(b)) { \
78 DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
79 smb_panic("assert failed"); }} while (0)
81 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
83 * Free memory if the pointer and zero the pointer.
85 * @note You are explicitly allowed to pass NULL pointers -- they will
88 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
92 * Type-safe version of malloc. Allocated one copy of the
93 * specified data type.
95 #define malloc_p(type) (type *)malloc(sizeof(type))
98 * Allocate an array of elements of one data type. Does type-checking.
100 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
103 * Resize an array of elements of one data type. Does type-checking.
105 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
107 #if defined(VALGRIND)
108 #define strlen(x) valgrind_strlen(x)
115 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
119 * zero a structure given a pointer to the structure
122 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
126 * zero a structure given a pointer to the structure - no zero check
128 #ifndef ZERO_STRUCTPN
129 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
132 /* zero an array - note that sizeof(array) must work - ie. it must not be a
135 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
139 * work out how many elements there are in a static array
142 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
146 * pointer difference macro
149 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
152 /* The following definitions come from lib/util/fault.c */
156 * Write backtrace to debug log
158 _PUBLIC_ void call_backtrace(void);
161 Something really nasty happened - panic !
163 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
166 setup our fault handlers
168 _PUBLIC_ void fault_setup(const char *pname);
171 register a fault handler.
172 Should only be called once in the execution of smbd.
174 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
176 /* The following definitions come from lib/util/signal.c */
182 void BlockSignals(bool block, int signum);
185 Catch a signal. This should implement the following semantics:
187 1) The handler remains installed after being called.
188 2) The signal should be blocked during handler execution.
190 void (*CatchSignal(int signum,void (*handler)(int )))(int);
193 Ignore SIGCLD via whatever means is necessary for this OS.
195 void CatchChild(void);
198 Catch SIGCLD but leave the child around so it's status can be reaped.
200 void CatchChildLeaveStatus(void);
202 /* The following definitions come from lib/util/system.c */
207 /**************************************************************************
208 A wrapper for gethostbyname() that tries avoids looking up hostnames
209 in the root domain, which can cause dial-on-demand links to come up for no
211 ****************************************************************************/
212 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
213 _PUBLIC_ struct in_addr sys_inet_makeaddr(int net, int host);
215 /* The following definitions come from lib/util/genrand.c */
218 Copy any user given reseed data.
220 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
223 * Tell the random number generator it needs to reseed.
225 _PUBLIC_ void set_need_random_reseed(void);
228 Interface to the (hopefully) good crypto random number generator.
229 Will use our internal PRNG if more than 40 bytes of random generation
230 has been requested, otherwise tries to read from /dev/random
232 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
235 Interface to the (hopefully) good crypto random number generator.
236 Will always use /dev/urandom if available.
238 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
241 generate a single random uint32_t
243 _PUBLIC_ uint32_t generate_random(void);
246 very basic password quality checker
248 _PUBLIC_ bool check_password_quality(const char *s);
251 Use the random number generator to generate a random string.
253 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
256 * Generate a random text string consisting of the specified length.
257 * The returned string will be allocated.
259 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
261 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
263 /* The following definitions come from lib/util/dprintf.c */
265 _PUBLIC_ void d_set_iconv(smb_iconv_t);
266 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
267 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
268 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
269 _PUBLIC_ void display_set_stderr(void);
271 /* The following definitions come from lib/util/util_str.c */
275 Trim the specified elements off the front and back of a string.
277 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
280 Find the number of 'c' chars in a string
282 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
285 Safe string copy into a known length string. maxlength does not
286 include the terminating zero.
288 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
291 Safe string cat into a string. maxlength does not
292 include the terminating zero.
294 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
297 Routine to get hex characters and turn them into a 16 byte array.
298 the array can be variable length, and any non-hex-numeric
299 characters are skipped. "0xnn" or "0Xnn" is specially catered
302 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
306 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex);
309 * Parse a hex string and return a data blob.
311 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(const char *strhex) ;
314 * Routine to print a buffer as HEX digits, into an allocated string.
316 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
319 * talloc version of hex_encode()
321 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
324 Substitute a string for a pattern in another string. Make sure there is
327 This routine looks for pattern in s and replaces it with
328 insert. It may do multiple replacements.
330 Any of " ; ' $ or ` in the insert string are replaced with _
331 if len==0 then the string cannot be extended. This is different from the old
332 use of len==0 which was for no length checks to be done.
334 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
337 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
338 const char *pattern, const char *insert);
341 Similar to string_sub() but allows for any character to be substituted.
343 if len==0 then the string cannot be extended. This is different from the old
344 use of len==0 which was for no length checks to be done.
346 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
349 Unescape a URL encoded string, in place.
351 _PUBLIC_ void rfc1738_unescape(char *buf);
352 size_t valgrind_strlen(const char *s);
355 format a string into length-prefixed dotted domain format, as used in NBT
356 and in some ADS structures
358 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
361 * Add a string to an array of strings.
363 * num should be a pointer to an integer that holds the current
364 * number of elements in strings. It will be updated by this function.
366 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
367 const char *str, const char ***strings, int *num);
370 varient of strcmp() that handles NULL ptrs
372 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
375 return the number of bytes occupied by a buffer in ASCII format
376 the result includes the null termination
379 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
382 Return a string representing a CIFS attribute for a file.
384 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
387 Set a boolean variable from the text value stored in the passed string.
388 Returns true in success, false if the passed string does not correctly
391 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
394 * Parse a string containing a boolean value.
396 * val will be set to the read value.
398 * @retval true if a boolean value was parsed, false otherwise.
400 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
403 * Convert a size specification like 16K into an integral number of bytes.
405 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
408 * Parse a uint64_t value from a string
410 * val will be set to the value read.
412 * @retval true if parsing was successful, false otherwise
414 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
417 return the number of bytes occupied by a buffer in CH_UTF16 format
418 the result includes the null termination
420 _PUBLIC_ size_t utf16_len(const void *buf);
423 return the number of bytes occupied by a buffer in CH_UTF16 format
424 the result includes the null termination
427 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
428 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
431 Do a case-insensitive, whitespace-ignoring string compare.
433 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
438 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
443 * @note The comparison is case-insensitive.
445 _PUBLIC_ bool strequal(const char *s1, const char *s2);
447 /* The following definitions come from lib/util/util_strlist.c */
451 build a null terminated list of strings from a input string and a
452 separator list. The separator list must contain characters less than
453 or equal to 0x2f for this to work correctly on multi-byte strings
455 _PUBLIC_ const char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
458 * build a null terminated list of strings from an argv-like input string
459 * Entries are seperated by spaces and can be enclosed by quotes.
460 * Does NOT support escaping
462 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
465 * join a list back to one string
467 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
469 /** join a list back to one (shell-like) string; entries
470 * seperated by spaces, using quotes where necessary */
471 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
474 return the number of elements in a string list
476 _PUBLIC_ size_t str_list_length(const char **list);
481 _PUBLIC_ const char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
484 Return true if all the elements of the list match exactly.
486 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
489 add an entry to a string list
491 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
494 remove an entry from a string list
496 _PUBLIC_ void str_list_remove(const char **list, const char *s);
499 return true if a string is in a list
501 _PUBLIC_ bool str_list_check(const char **list, const char *s);
504 return true if a string is in a list, case insensitively
506 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
508 /* The following definitions come from lib/util/util_file.c */
512 read a line from a file with possible \ continuation chars.
513 Blanks at the start or end of a line are stripped.
514 The string will be allocated if s2 is NULL
516 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
519 * Read one line (data until next newline or eof) and allocate it
521 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
524 load a file into memory from a fd.
526 _PUBLIC_ char *fd_load(int fd, size_t *size, TALLOC_CTX *mem_ctx);
529 load a file into memory
531 _PUBLIC_ char *file_load(const char *fname, size_t *size, TALLOC_CTX *mem_ctx);
534 mmap (if possible) or read a file
536 _PUBLIC_ void *map_file(const char *fname, size_t size);
539 load a file into memory and return an array of pointers to lines in the file
540 must be freed with talloc_free().
542 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, TALLOC_CTX *mem_ctx);
545 load a fd into memory and return an array of pointers to lines in the file
546 must be freed with talloc_free(). If convert is true calls unix_to_dos on
549 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, TALLOC_CTX *mem_ctx);
552 take a list of lines and modify them to produce a list where \ continues
555 _PUBLIC_ void file_lines_slashcont(char **lines);
558 save a lump of data into a file. Mostly used for debugging
560 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
561 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
562 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
563 _PUBLIC_ bool large_file_support(const char *path);
565 /* The following definitions come from lib/util/util.c */
569 Find a suitable temporary directory. The result should be copied immediately
570 as it may be overwritten by a subsequent call.
572 _PUBLIC_ const char *tmpdir(void);
575 Check if a file exists - call vfs_file_exist for samba files.
577 _PUBLIC_ bool file_exist(const char *fname);
580 Check a files mod time.
582 _PUBLIC_ time_t file_modtime(const char *fname);
585 Check if a directory exists.
587 _PUBLIC_ bool directory_exist(const char *dname);
590 * Try to create the specified directory if it didn't exist.
592 * @retval true if the directory already existed and has the right permissions
593 * or was successfully created.
595 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
599 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
604 _PUBLIC_ int set_blocking(int fd, bool set);
607 Sleep for a specified number of milliseconds.
609 _PUBLIC_ void msleep(unsigned int t);
612 Get my own name, return in malloc'ed storage.
614 _PUBLIC_ char* get_myname(void);
617 Return true if a string could be a pure IP address.
619 _PUBLIC_ bool is_ipaddress(const char *str);
622 Interpret an internet address or name into an IP address in 4 byte form.
624 _PUBLIC_ uint32_t interpret_addr(const char *str);
627 A convenient addition to interpret_addr().
629 _PUBLIC_ struct in_addr interpret_addr2(const char *str);
632 Check if an IP is the 0.0.0.0.
634 _PUBLIC_ bool is_zero_ip(struct in_addr ip);
637 Are two IPs on the same subnet?
639 _PUBLIC_ bool same_net(struct in_addr ip1,struct in_addr ip2,struct in_addr mask);
642 Check if a process exists. Does this work on all unixes?
644 _PUBLIC_ bool process_exists(pid_t pid);
647 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
648 is dealt with in posix.c
650 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
653 * Write dump of binary data to the log file.
655 * The data is only written if the log level is at least level.
657 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
660 * Write dump of binary data to the log file.
662 * The data is only written if the log level is at least level.
663 * 16 zero bytes in a row are ommited
665 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
668 malloc that aborts with smb_panic on fail or zero size.
670 _PUBLIC_ void *smb_xmalloc(size_t size);
673 Memdup with smb_panic on fail.
675 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
678 strdup that aborts on malloc fail.
680 _PUBLIC_ char *smb_xstrdup(const char *s);
683 Like strdup but for memory.
685 _PUBLIC_ void *memdup(const void *p, size_t size);
688 * Write a password to the log file.
690 * @note Only actually does something if DEBUG_PASSWORD was defined during
693 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
696 * see if a range of memory is all zero. A NULL pointer is considered
699 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
702 realloc an array, checking for integer overflow in the array size
704 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count);
706 /* The following definitions come from lib/util/fsusage.c */
710 * Retrieve amount of free disk space.
711 * this does all of the system specific guff to get the free disk space.
712 * It is derived from code in the GNU fileutils package, but has been
713 * considerably mangled for use here
715 * results are returned in *dfree and *dsize, in 512 byte units
717 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
719 /* The following definitions come from lib/util/ms_fnmatch.c */
724 * @brief MS-style Filename matching
727 /* protocol types. It assumes that higher protocols include lower protocols
728 as subsets. FIXME: Move to one of the smb-specific headers */
729 enum protocol_types {
739 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
741 /** a generic fnmatch function - uses for non-CIFS pattern matching */
742 int gen_fnmatch(const char *pattern, const char *string);
744 /* The following definitions come from lib/util/mutex.c */
748 register a set of mutex/rwlock handlers.
749 Should only be called once in the execution of smbd.
751 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
753 /* The following definitions come from lib/util/idtree.c */
757 initialise a idr tree. The context return value must be passed to
758 all subsequent idr calls. To destroy the idr tree use talloc_free()
761 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
764 allocate the next available id, and assign 'ptr' into its slot.
765 you can retrieve later this pointer using idr_find()
767 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
770 allocate a new id, giving the first available value greater than or
771 equal to the given starting id
773 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
776 allocate a new id randomly in the given range
778 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
781 find a pointer value previously set with idr_get_new given an id
783 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
786 remove an id from the idr tree
788 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
790 /* The following definitions come from lib/util/become_daemon.c */
793 Become a daemon, discarding the controlling terminal.
795 _PUBLIC_ void become_daemon(bool fork);
798 * Load a ini-style file.
800 bool pm_process( const char *fileName,
801 bool (*sfunc)(const char *, void *),
802 bool (*pfunc)(const char *, const char *, void *),
806 * Add-on to talloc_get_type
808 _PUBLIC_ void *talloc_check_name_abort(const void *ptr, const char *name);
809 #define talloc_get_type_abort(ptr, type) \
810 (type *)talloc_check_name_abort(ptr, #type)
812 #endif /* _SAMBA_UTIL_H_ */