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 "charset/charset.h"
28 * @brief Helpful macros
31 struct substitute_context;
34 extern const char *logfile;
35 extern const char *panic_action;
37 #include "util/time.h"
38 #include "util/data_blob.h"
39 #include "util/xfile.h"
40 #include "util/debug.h"
41 #include "util/mutex.h"
42 #include "util/byteorder.h"
45 this is a warning hack. The idea is to use this everywhere that we
46 get the "discarding const" warning from gcc. That doesn't actually
47 fix the problem of course, but it means that when we do get to
48 cleaning them up we can do it by searching the code for
51 It also means that other error types aren't as swamped by the noise
52 of hundreds of const warnings, so we are more likely to notice when
55 Please only add more uses of this macro when you find it
56 _really_ hard to fix const warnings. Our aim is to eventually use
57 this function in only a very few places.
59 Also, please call this via the discard_const_p() macro interface, as that
60 makes the return type safe.
63 #define discard_const(ptr) ((void *)((intptr_t)(ptr)))
66 /** Type-safe version of discard_const */
67 #ifndef discard_const_p
68 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
74 #define SMB_ASSERT(b) do { if (!(b)) { \
75 DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
76 smb_panic("assert failed"); abort(); }} while (0)
78 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
80 * Free memory if the pointer and zero the pointer.
82 * @note You are explicitly allowed to pass NULL pointers -- they will
85 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
89 * Type-safe version of malloc. Allocated one copy of the
90 * specified data type.
92 #define malloc_p(type) (type *)malloc(sizeof(type))
95 * Allocate an array of elements of one data type. Does type-checking.
97 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
100 * Resize an array of elements of one data type. Does type-checking.
102 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
104 #if defined(VALGRIND)
105 #define strlen(x) valgrind_strlen(x)
112 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
116 * zero a structure given a pointer to the structure
119 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
123 * zero a structure given a pointer to the structure - no zero check
125 #ifndef ZERO_STRUCTPN
126 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
129 /* zero an array - note that sizeof(array) must work - ie. it must not be a
132 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
136 * work out how many elements there are in a static array
139 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
143 * pointer difference macro
146 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
151 * this global variable determines what messages are printed
153 _PUBLIC_ void debug_schedule_reopen_logs(void);
156 the backend for debug messages. Note that the DEBUG() macro has already
157 ensured that the log level has been met before this is called
159 _PUBLIC_ void do_debug_header(int level, const char *location, const char *func);
162 the backend for debug messages. Note that the DEBUG() macro has already
163 ensured that the log level has been met before this is called
165 @note You should never have to call this function directly. Call the DEBUG()
168 _PUBLIC_ void do_debug(const char *format, ...) _PRINTF_ATTRIBUTE(1,2);
171 reopen the log file (usually called because the log file name might have changed)
173 _PUBLIC_ void reopen_logs(void);
176 control the name of the logfile and whether logging will be to stdout, stderr
179 _PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype);
182 return a string constant containing n tabs
183 no more than 10 tabs are returned
185 _PUBLIC_ const char *do_debug_tab(int n);
188 log suspicious usage - print comments and backtrace
190 _PUBLIC_ void log_suspicious_usage(const char *from, const char *info);
193 print suspicious usage - print comments and backtrace
195 _PUBLIC_ void print_suspicious_usage(const char* from, const char* info);
196 _PUBLIC_ uint32_t get_task_id(void);
197 _PUBLIC_ void log_task_id(void);
200 register a set of debug handlers.
202 _PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops);
204 /* The following definitions come from lib/util/fault.c */
208 * Write backtrace to debug log
210 _PUBLIC_ void call_backtrace(void);
213 Something really nasty happened - panic !
215 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
218 setup our fault handlers
220 _PUBLIC_ void fault_setup(const char *pname);
223 register a fault handler.
224 Should only be called once in the execution of smbd.
226 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
228 /* The following definitions come from lib/util/signal.c */
234 void BlockSignals(bool block, int signum);
237 Catch a signal. This should implement the following semantics:
239 1) The handler remains installed after being called.
240 2) The signal should be blocked during handler execution.
242 void (*CatchSignal(int signum,void (*handler)(int )))(int);
245 Ignore SIGCLD via whatever means is necessary for this OS.
247 void CatchChild(void);
250 Catch SIGCLD but leave the child around so it's status can be reaped.
252 void CatchChildLeaveStatus(void);
254 /* The following definitions come from lib/util/system.c */
258 we use struct ipv4_addr to avoid having to include all the
259 system networking headers everywhere
265 /**************************************************************************
266 A wrapper for gethostbyname() that tries avoids looking up hostnames
267 in the root domain, which can cause dial-on-demand links to come up for no
269 ****************************************************************************/
270 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
271 _PUBLIC_ const char *sys_inet_ntoa(struct ipv4_addr in);
272 _PUBLIC_ struct ipv4_addr sys_inet_makeaddr(int net, int host);
274 /* The following definitions come from lib/util/genrand.c */
277 Copy any user given reseed data.
279 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(int *));
282 * Tell the random number generator it needs to reseed.
284 _PUBLIC_ void set_need_random_reseed(void);
287 Interface to the (hopefully) good crypto random number generator.
289 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
292 generate a single random uint32_t
294 _PUBLIC_ uint32_t generate_random(void);
297 very basic password quality checker
299 _PUBLIC_ bool check_password_quality(const char *s);
302 Use the random number generator to generate a random string.
304 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
307 * Generate a random text string consisting of the specified length.
308 * The returned string will be allocated.
310 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
312 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
314 /* The following definitions come from lib/util/dprintf.c */
316 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) _PRINTF_ATTRIBUTE(2,0);
317 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) _PRINTF_ATTRIBUTE(2,3);
318 _PUBLIC_ int d_printf(const char *format, ...) _PRINTF_ATTRIBUTE(1,2);
319 _PUBLIC_ void display_set_stderr(void);
321 /* The following definitions come from lib/util/util_str.c */
325 Trim the specified elements off the front and back of a string.
327 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
330 Find the number of 'c' chars in a string
332 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
335 Safe string copy into a known length string. maxlength does not
336 include the terminating zero.
338 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
341 Safe string cat into a string. maxlength does not
342 include the terminating zero.
344 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
347 Routine to get hex characters and turn them into a 16 byte array.
348 the array can be variable length, and any non-hex-numeric
349 characters are skipped. "0xnn" or "0Xnn" is specially catered
352 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
356 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex);
359 * Parse a hex string and return a data blob.
361 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(const char *strhex) ;
364 * Routine to print a buffer as HEX digits, into an allocated string.
366 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
369 * talloc version of hex_encode()
371 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
374 Set a string value, deallocating any existing space, and allocing the space
377 _PUBLIC_ bool string_set(TALLOC_CTX *mem_ctx, char **dest, const char *src);
380 Substitute a string for a pattern in another string. Make sure there is
383 This routine looks for pattern in s and replaces it with
384 insert. It may do multiple replacements.
386 Any of " ; ' $ or ` in the insert string are replaced with _
387 if len==0 then the string cannot be extended. This is different from the old
388 use of len==0 which was for no length checks to be done.
390 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
393 Similar to string_sub() but allows for any character to be substituted.
395 if len==0 then the string cannot be extended. This is different from the old
396 use of len==0 which was for no length checks to be done.
398 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
401 Unescape a URL encoded string, in place.
403 _PUBLIC_ void rfc1738_unescape(char *buf);
404 size_t valgrind_strlen(const char *s);
407 format a string into length-prefixed dotted domain format, as used in NBT
408 and in some ADS structures
410 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
413 * Add a string to an array of strings.
415 * num should be a pointer to an integer that holds the current
416 * number of elements in strings. It will be updated by this function.
418 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
419 const char *str, const char ***strings, int *num);
422 varient of strcmp() that handles NULL ptrs
424 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
427 return the number of bytes occupied by a buffer in ASCII format
428 the result includes the null termination
431 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
434 Return a string representing a CIFS attribute for a file.
436 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
439 Set a boolean variable from the text value stored in the passed string.
440 Returns true in success, false if the passed string does not correctly
443 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
446 * Parse a string containing a boolean value.
448 * val will be set to the read value.
450 * @retval true if a boolean value was parsed, false otherwise.
452 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
455 * Convert a size specification like 16K into an integral number of bytes.
457 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
460 * Parse a uint64_t value from a string
462 * val will be set to the value read.
464 * @retval true if parsing was successful, false otherwise
466 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
469 return the number of bytes occupied by a buffer in CH_UTF16 format
470 the result includes the null termination
472 _PUBLIC_ size_t utf16_len(const void *buf);
475 return the number of bytes occupied by a buffer in CH_UTF16 format
476 the result includes the null termination
479 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
480 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
483 Do a case-insensitive, whitespace-ignoring string compare.
485 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
490 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
495 * @note The comparison is case-insensitive.
497 _PUBLIC_ bool strequal(const char *s1, const char *s2);
499 /* The following definitions come from lib/util/util_strlist.c */
503 build a null terminated list of strings from a input string and a
504 separator list. The separator list must contain characters less than
505 or equal to 0x2f for this to work correctly on multi-byte strings
507 _PUBLIC_ const char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
510 * build a null terminated list of strings from an argv-like input string
511 * Entries are seperated by spaces and can be enclosed by quotes.
512 * Does NOT support escaping
514 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
517 * join a list back to one string
519 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
521 /** join a list back to one (shell-like) string; entries
522 * seperated by spaces, using quotes where necessary */
523 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
526 return the number of elements in a string list
528 _PUBLIC_ size_t str_list_length(const char **list);
533 _PUBLIC_ const char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
536 Return true if all the elements of the list match exactly.
538 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
541 add an entry to a string list
543 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
546 remove an entry from a string list
548 _PUBLIC_ void str_list_remove(const char **list, const char *s);
551 return true if a string is in a list
553 _PUBLIC_ bool str_list_check(const char **list, const char *s);
556 return true if a string is in a list, case insensitively
558 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
560 /* The following definitions come from lib/util/util_file.c */
564 read a line from a file with possible \ continuation chars.
565 Blanks at the start or end of a line are stripped.
566 The string will be allocated if s2 is NULL
568 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
571 * Read one line (data until next newline or eof) and allocate it
573 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
576 load a file into memory from a fd.
578 _PUBLIC_ char *fd_load(int fd, size_t *size, TALLOC_CTX *mem_ctx);
581 load a file into memory
583 _PUBLIC_ char *file_load(const char *fname, size_t *size, TALLOC_CTX *mem_ctx);
586 mmap (if possible) or read a file
588 _PUBLIC_ void *map_file(const char *fname, size_t size);
591 load a file into memory and return an array of pointers to lines in the file
592 must be freed with talloc_free().
594 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, TALLOC_CTX *mem_ctx);
597 load a fd into memory and return an array of pointers to lines in the file
598 must be freed with talloc_free(). If convert is true calls unix_to_dos on
601 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, TALLOC_CTX *mem_ctx);
604 take a list of lines and modify them to produce a list where \ continues
607 _PUBLIC_ void file_lines_slashcont(char **lines);
610 save a lump of data into a file. Mostly used for debugging
612 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
613 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) _PRINTF_ATTRIBUTE(2,0);
614 _PUBLIC_ int fdprintf(int fd, const char *format, ...) _PRINTF_ATTRIBUTE(2,3);
615 _PUBLIC_ bool large_file_support(const char *path);
617 /* The following definitions come from lib/util/util.c */
621 Find a suitable temporary directory. The result should be copied immediately
622 as it may be overwritten by a subsequent call.
624 _PUBLIC_ const char *tmpdir(void);
627 Check if a file exists - call vfs_file_exist for samba files.
629 _PUBLIC_ bool file_exist(const char *fname);
632 Check a files mod time.
634 _PUBLIC_ time_t file_modtime(const char *fname);
637 Check if a directory exists.
639 _PUBLIC_ bool directory_exist(const char *dname);
642 * Try to create the specified directory if it didn't exist.
644 * @retval true if the directory already existed and has the right permissions
645 * or was successfully created.
647 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
651 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
656 _PUBLIC_ int set_blocking(int fd, bool set);
659 Sleep for a specified number of milliseconds.
661 _PUBLIC_ void msleep(unsigned int t);
664 Get my own name, return in malloc'ed storage.
666 _PUBLIC_ char* get_myname(void);
669 Return true if a string could be a pure IP address.
671 _PUBLIC_ bool is_ipaddress(const char *str);
674 Interpret an internet address or name into an IP address in 4 byte form.
676 _PUBLIC_ uint32_t interpret_addr(const char *str);
679 A convenient addition to interpret_addr().
681 _PUBLIC_ struct ipv4_addr interpret_addr2(const char *str);
684 Check if an IP is the 0.0.0.0.
686 _PUBLIC_ bool is_zero_ip(struct ipv4_addr ip);
689 Are two IPs on the same subnet?
691 _PUBLIC_ bool same_net(struct ipv4_addr ip1,struct ipv4_addr ip2,struct ipv4_addr mask);
694 Check if a process exists. Does this work on all unixes?
696 _PUBLIC_ bool process_exists(pid_t pid);
699 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
700 is dealt with in posix.c
702 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
705 * Write dump of binary data to the log file.
707 * The data is only written if the log level is at least level.
709 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
712 malloc that aborts with smb_panic on fail or zero size.
714 _PUBLIC_ void *smb_xmalloc(size_t size);
717 Memdup with smb_panic on fail.
719 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
722 strdup that aborts on malloc fail.
724 _PUBLIC_ char *smb_xstrdup(const char *s);
727 Like strdup but for memory.
729 _PUBLIC_ void *memdup(const void *p, size_t size);
732 * Write a password to the log file.
734 * @note Only actually does something if DEBUG_PASSWORD was defined during
737 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
740 * see if a range of memory is all zero. A NULL pointer is considered
743 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
746 realloc an array, checking for integer overflow in the array size
748 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count);
750 /* The following definitions come from lib/util/fsusage.c */
754 * Retrieve amount of free disk space.
755 * this does all of the system specific guff to get the free disk space.
756 * It is derived from code in the GNU fileutils package, but has been
757 * considerably mangled for use here
759 * results are returned in *dfree and *dsize, in 512 byte units
761 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
763 /* The following definitions come from lib/util/ms_fnmatch.c */
768 * @brief MS-style Filename matching
771 /* protocol types. It assumes that higher protocols include lower protocols
772 as subsets. FIXME: Move to one of the smb-specific headers */
773 enum protocol_types {
785 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
787 /** a generic fnmatch function - uses for non-CIFS pattern matching */
788 int gen_fnmatch(const char *pattern, const char *string);
790 /* The following definitions come from lib/util/mutex.c */
794 register a set of mutex/rwlock handlers.
795 Should only be called once in the execution of smbd.
797 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
799 /* The following definitions come from lib/util/idtree.c */
803 initialise a idr tree. The context return value must be passed to
804 all subsequent idr calls. To destroy the idr tree use talloc_free()
807 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
810 allocate the next available id, and assign 'ptr' into its slot.
811 you can retrieve later this pointer using idr_find()
813 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
816 allocate a new id, giving the first available value greater than or
817 equal to the given starting id
819 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
822 allocate a new id randomly in the given range
824 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
827 find a pointer value previously set with idr_get_new given an id
829 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
832 remove an id from the idr tree
834 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
836 /* The following definitions come from lib/util/become_daemon.c */
839 Become a daemon, discarding the controlling terminal.
841 _PUBLIC_ void become_daemon(bool Fork);
843 #endif /* _SAMBA_UTIL_H_ */