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 "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 "util/time.h"
42 #include "util/data_blob.h"
43 #include "util/xfile.h"
44 #include "util/debug.h"
45 #include "util/mutex.h"
46 #include "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 *)((intptr_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)
82 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
84 * Free memory if the pointer and zero the pointer.
86 * @note You are explicitly allowed to pass NULL pointers -- they will
89 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
93 * Type-safe version of malloc. Allocated one copy of the
94 * specified data type.
96 #define malloc_p(type) (type *)malloc(sizeof(type))
99 * Allocate an array of elements of one data type. Does type-checking.
101 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
104 * Resize an array of elements of one data type. Does type-checking.
106 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
108 #if defined(VALGRIND)
109 #define strlen(x) valgrind_strlen(x)
116 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
120 * zero a structure given a pointer to the structure
123 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
127 * zero a structure given a pointer to the structure - no zero check
129 #ifndef ZERO_STRUCTPN
130 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
133 /* zero an array - note that sizeof(array) must work - ie. it must not be a
136 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
140 * work out how many elements there are in a static array
143 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
147 * pointer difference macro
150 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
153 /* The following definitions come from lib/util/fault.c */
157 * Write backtrace to debug log
159 _PUBLIC_ void call_backtrace(void);
162 Something really nasty happened - panic !
164 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
167 setup our fault handlers
169 _PUBLIC_ void fault_setup(const char *pname);
172 register a fault handler.
173 Should only be called once in the execution of smbd.
175 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
177 /* The following definitions come from lib/util/signal.c */
183 void BlockSignals(bool block, int signum);
186 Catch a signal. This should implement the following semantics:
188 1) The handler remains installed after being called.
189 2) The signal should be blocked during handler execution.
191 void (*CatchSignal(int signum,void (*handler)(int )))(int);
194 Ignore SIGCLD via whatever means is necessary for this OS.
196 void CatchChild(void);
199 Catch SIGCLD but leave the child around so it's status can be reaped.
201 void CatchChildLeaveStatus(void);
203 /* The following definitions come from lib/util/system.c */
208 /**************************************************************************
209 A wrapper for gethostbyname() that tries avoids looking up hostnames
210 in the root domain, which can cause dial-on-demand links to come up for no
212 ****************************************************************************/
213 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
214 _PUBLIC_ struct in_addr sys_inet_makeaddr(int net, int host);
216 /* The following definitions come from lib/util/genrand.c */
219 Copy any user given reseed data.
221 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
224 * Tell the random number generator it needs to reseed.
226 _PUBLIC_ void set_need_random_reseed(void);
229 Interface to the (hopefully) good crypto random number generator.
230 Will use our internal PRNG if more than 40 bytes of random generation
231 has been requested, otherwise tries to read from /dev/random
233 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
236 Interface to the (hopefully) good crypto random number generator.
237 Will always use /dev/urandom if available.
239 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
242 generate a single random uint32_t
244 _PUBLIC_ uint32_t generate_random(void);
247 very basic password quality checker
249 _PUBLIC_ bool check_password_quality(const char *s);
252 Use the random number generator to generate a random string.
254 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
257 * Generate a random text string consisting of the specified length.
258 * The returned string will be allocated.
260 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
262 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
264 /* The following definitions come from lib/util/dprintf.c */
266 _PUBLIC_ void d_set_iconv(smb_iconv_t);
267 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
268 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
269 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
270 _PUBLIC_ void display_set_stderr(void);
272 /* The following definitions come from lib/util/util_str.c */
276 Trim the specified elements off the front and back of a string.
278 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
281 Find the number of 'c' chars in a string
283 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
286 Safe string copy into a known length string. maxlength does not
287 include the terminating zero.
289 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
292 Safe string cat into a string. maxlength does not
293 include the terminating zero.
295 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
298 Routine to get hex characters and turn them into a 16 byte array.
299 the array can be variable length, and any non-hex-numeric
300 characters are skipped. "0xnn" or "0Xnn" is specially catered
303 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
307 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex);
310 * Parse a hex string and return a data blob.
312 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(const char *strhex) ;
315 * Routine to print a buffer as HEX digits, into an allocated string.
317 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
320 * talloc version of hex_encode()
322 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
325 Substitute a string for a pattern in another string. Make sure there is
328 This routine looks for pattern in s and replaces it with
329 insert. It may do multiple replacements.
331 Any of " ; ' $ or ` in the insert string are replaced with _
332 if len==0 then the string cannot be extended. This is different from the old
333 use of len==0 which was for no length checks to be done.
335 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
338 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
339 const char *pattern, const char *insert);
342 Similar to string_sub() but allows for any character to be substituted.
344 if len==0 then the string cannot be extended. This is different from the old
345 use of len==0 which was for no length checks to be done.
347 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
350 Unescape a URL encoded string, in place.
352 _PUBLIC_ void rfc1738_unescape(char *buf);
353 size_t valgrind_strlen(const char *s);
356 format a string into length-prefixed dotted domain format, as used in NBT
357 and in some ADS structures
359 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
362 * Add a string to an array of strings.
364 * num should be a pointer to an integer that holds the current
365 * number of elements in strings. It will be updated by this function.
367 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
368 const char *str, const char ***strings, int *num);
371 varient of strcmp() that handles NULL ptrs
373 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
376 return the number of bytes occupied by a buffer in ASCII format
377 the result includes the null termination
380 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
383 Return a string representing a CIFS attribute for a file.
385 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
388 Set a boolean variable from the text value stored in the passed string.
389 Returns true in success, false if the passed string does not correctly
392 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
395 * Parse a string containing a boolean value.
397 * val will be set to the read value.
399 * @retval true if a boolean value was parsed, false otherwise.
401 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
404 * Convert a size specification like 16K into an integral number of bytes.
406 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
409 * Parse a uint64_t value from a string
411 * val will be set to the value read.
413 * @retval true if parsing was successful, false otherwise
415 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
418 return the number of bytes occupied by a buffer in CH_UTF16 format
419 the result includes the null termination
421 _PUBLIC_ size_t utf16_len(const void *buf);
424 return the number of bytes occupied by a buffer in CH_UTF16 format
425 the result includes the null termination
428 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
429 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
432 Do a case-insensitive, whitespace-ignoring string compare.
434 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
439 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
444 * @note The comparison is case-insensitive.
446 _PUBLIC_ bool strequal(const char *s1, const char *s2);
448 /* The following definitions come from lib/util/util_strlist.c */
452 build a null terminated list of strings from a input string and a
453 separator list. The separator list must contain characters less than
454 or equal to 0x2f for this to work correctly on multi-byte strings
456 _PUBLIC_ const char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
459 * build a null terminated list of strings from an argv-like input string
460 * Entries are seperated by spaces and can be enclosed by quotes.
461 * Does NOT support escaping
463 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
466 * join a list back to one string
468 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
470 /** join a list back to one (shell-like) string; entries
471 * seperated by spaces, using quotes where necessary */
472 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
475 return the number of elements in a string list
477 _PUBLIC_ size_t str_list_length(const char **list);
482 _PUBLIC_ const char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
485 Return true if all the elements of the list match exactly.
487 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
490 add an entry to a string list
492 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
495 remove an entry from a string list
497 _PUBLIC_ void str_list_remove(const char **list, const char *s);
500 return true if a string is in a list
502 _PUBLIC_ bool str_list_check(const char **list, const char *s);
505 return true if a string is in a list, case insensitively
507 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
509 /* The following definitions come from lib/util/util_file.c */
513 read a line from a file with possible \ continuation chars.
514 Blanks at the start or end of a line are stripped.
515 The string will be allocated if s2 is NULL
517 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
520 * Read one line (data until next newline or eof) and allocate it
522 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
525 load a file into memory from a fd.
527 _PUBLIC_ char *fd_load(int fd, size_t *size, TALLOC_CTX *mem_ctx);
530 load a file into memory
532 _PUBLIC_ char *file_load(const char *fname, size_t *size, TALLOC_CTX *mem_ctx);
535 mmap (if possible) or read a file
537 _PUBLIC_ void *map_file(const char *fname, size_t size);
540 load a file into memory and return an array of pointers to lines in the file
541 must be freed with talloc_free().
543 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, TALLOC_CTX *mem_ctx);
546 load a fd into memory and return an array of pointers to lines in the file
547 must be freed with talloc_free(). If convert is true calls unix_to_dos on
550 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, TALLOC_CTX *mem_ctx);
553 take a list of lines and modify them to produce a list where \ continues
556 _PUBLIC_ void file_lines_slashcont(char **lines);
559 save a lump of data into a file. Mostly used for debugging
561 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
562 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
563 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
564 _PUBLIC_ bool large_file_support(const char *path);
566 /* The following definitions come from lib/util/util.c */
570 Find a suitable temporary directory. The result should be copied immediately
571 as it may be overwritten by a subsequent call.
573 _PUBLIC_ const char *tmpdir(void);
576 Check if a file exists - call vfs_file_exist for samba files.
578 _PUBLIC_ bool file_exist(const char *fname);
581 Check a files mod time.
583 _PUBLIC_ time_t file_modtime(const char *fname);
586 Check if a directory exists.
588 _PUBLIC_ bool directory_exist(const char *dname);
591 * Try to create the specified directory if it didn't exist.
593 * @retval true if the directory already existed and has the right permissions
594 * or was successfully created.
596 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
600 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
605 _PUBLIC_ int set_blocking(int fd, bool set);
608 Sleep for a specified number of milliseconds.
610 _PUBLIC_ void msleep(unsigned int t);
613 Get my own name, return in malloc'ed storage.
615 _PUBLIC_ char* get_myname(void);
618 Return true if a string could be a pure IP address.
620 _PUBLIC_ bool is_ipaddress(const char *str);
623 Interpret an internet address or name into an IP address in 4 byte form.
625 _PUBLIC_ uint32_t interpret_addr(const char *str);
628 A convenient addition to interpret_addr().
630 _PUBLIC_ struct in_addr interpret_addr2(const char *str);
633 Check if an IP is the 0.0.0.0.
635 _PUBLIC_ bool is_zero_ip(struct in_addr ip);
638 Are two IPs on the same subnet?
640 _PUBLIC_ bool same_net(struct in_addr ip1,struct in_addr ip2,struct in_addr mask);
643 Check if a process exists. Does this work on all unixes?
645 _PUBLIC_ bool process_exists(pid_t pid);
648 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
649 is dealt with in posix.c
651 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
654 * Write dump of binary data to the log file.
656 * The data is only written if the log level is at least level.
658 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
661 * Write dump of binary data to the log file.
663 * The data is only written if the log level is at least level.
664 * 16 zero bytes in a row are ommited
666 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
669 malloc that aborts with smb_panic on fail or zero size.
671 _PUBLIC_ void *smb_xmalloc(size_t size);
674 Memdup with smb_panic on fail.
676 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
679 strdup that aborts on malloc fail.
681 _PUBLIC_ char *smb_xstrdup(const char *s);
684 Like strdup but for memory.
686 _PUBLIC_ void *memdup(const void *p, size_t size);
689 * Write a password to the log file.
691 * @note Only actually does something if DEBUG_PASSWORD was defined during
694 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
697 * see if a range of memory is all zero. A NULL pointer is considered
700 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
703 realloc an array, checking for integer overflow in the array size
705 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count);
707 /* The following definitions come from lib/util/fsusage.c */
711 * Retrieve amount of free disk space.
712 * this does all of the system specific guff to get the free disk space.
713 * It is derived from code in the GNU fileutils package, but has been
714 * considerably mangled for use here
716 * results are returned in *dfree and *dsize, in 512 byte units
718 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
720 /* The following definitions come from lib/util/ms_fnmatch.c */
725 * @brief MS-style Filename matching
728 /* protocol types. It assumes that higher protocols include lower protocols
729 as subsets. FIXME: Move to one of the smb-specific headers */
730 enum protocol_types {
740 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
742 /** a generic fnmatch function - uses for non-CIFS pattern matching */
743 int gen_fnmatch(const char *pattern, const char *string);
745 /* The following definitions come from lib/util/mutex.c */
749 register a set of mutex/rwlock handlers.
750 Should only be called once in the execution of smbd.
752 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
754 /* The following definitions come from lib/util/idtree.c */
758 initialise a idr tree. The context return value must be passed to
759 all subsequent idr calls. To destroy the idr tree use talloc_free()
762 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
765 allocate the next available id, and assign 'ptr' into its slot.
766 you can retrieve later this pointer using idr_find()
768 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
771 allocate a new id, giving the first available value greater than or
772 equal to the given starting id
774 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
777 allocate a new id randomly in the given range
779 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
782 find a pointer value previously set with idr_get_new given an id
784 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
787 remove an id from the idr tree
789 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
791 /* The following definitions come from lib/util/become_daemon.c */
794 Become a daemon, discarding the controlling terminal.
796 _PUBLIC_ void become_daemon(bool fork);
799 * Load a ini-style file.
801 bool pm_process( const char *fileName,
802 bool (*sfunc)(const char *, void *),
803 bool (*pfunc)(const char *, const char *, void *),
807 * Add-on to talloc_get_type
809 _PUBLIC_ void *talloc_check_name_abort(const void *ptr, const char *name);
810 #define talloc_get_type_abort(ptr, type) \
811 (type *)talloc_check_name_abort(ptr, #type)
813 #endif /* _SAMBA_UTIL_H_ */