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"
51 #define SMB_ASSERT(b) do { if (!(b)) { \
52 DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
53 smb_panic("assert failed"); }} while (0)
56 #define strlen(x) valgrind_strlen(x)
59 #include "../lib/util/memory.h"
62 * Write backtrace to debug log
64 _PUBLIC_ void call_backtrace(void);
67 Something really nasty happened - panic !
69 _PUBLIC_ _NORETURN_ void smb_panic(const char *why);
72 setup our fault handlers
74 _PUBLIC_ void fault_setup(const char *pname);
77 register a fault handler.
78 Should only be called once in the execution of smbd.
80 _PUBLIC_ bool register_fault_handler(const char *name, void (*fault_handler)(int sig));
82 /* The following definitions come from lib/util/signal.c */
88 void BlockSignals(bool block, int signum);
91 Catch a signal. This should implement the following semantics:
93 1) The handler remains installed after being called.
94 2) The signal should be blocked during handler execution.
96 void (*CatchSignal(int signum,void (*handler)(int )))(int);
99 Ignore SIGCLD via whatever means is necessary for this OS.
101 void CatchChild(void);
104 Catch SIGCLD but leave the child around so it's status can be reaped.
106 void CatchChildLeaveStatus(void);
108 /* The following definitions come from lib/util/system.c */
113 /**************************************************************************
114 A wrapper for gethostbyname() that tries avoids looking up hostnames
115 in the root domain, which can cause dial-on-demand links to come up for no
117 ****************************************************************************/
118 _PUBLIC_ struct hostent *sys_gethostbyname(const char *name);
119 _PUBLIC_ struct in_addr sys_inet_makeaddr(int net, int host);
121 /* The following definitions come from lib/util/genrand.c */
124 Copy any user given reseed data.
126 _PUBLIC_ void set_rand_reseed_callback(void (*fn)(void *, int *), void *);
129 * Tell the random number generator it needs to reseed.
131 _PUBLIC_ void set_need_random_reseed(void);
134 Interface to the (hopefully) good crypto random number generator.
135 Will use our internal PRNG if more than 40 bytes of random generation
136 has been requested, otherwise tries to read from /dev/random
138 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len);
141 Interface to the (hopefully) good crypto random number generator.
142 Will always use /dev/urandom if available.
144 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len);
147 generate a single random uint32_t
149 _PUBLIC_ uint32_t generate_random(void);
152 very basic password quality checker
154 _PUBLIC_ bool check_password_quality(const char *s);
157 Use the random number generator to generate a random string.
159 _PUBLIC_ char *generate_random_str_list(TALLOC_CTX *mem_ctx, size_t len, const char *list);
162 * Generate a random text string consisting of the specified length.
163 * The returned string will be allocated.
165 * Characters used are: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+_-#.,
167 _PUBLIC_ char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
169 /* The following definitions come from lib/util/dprintf.c */
171 _PUBLIC_ void d_set_iconv(smb_iconv_t);
172 _PUBLIC_ int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
173 _PUBLIC_ int d_fprintf(FILE *f, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
174 _PUBLIC_ int d_printf(const char *format, ...) PRINTF_ATTRIBUTE(1,2);
175 _PUBLIC_ void display_set_stderr(void);
177 /* The following definitions come from lib/util/util_str.c */
181 Trim the specified elements off the front and back of a string.
183 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back);
186 Find the number of 'c' chars in a string
188 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c);
191 Safe string copy into a known length string. maxlength does not
192 include the terminating zero.
194 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength);
197 Safe string cat into a string. maxlength does not
198 include the terminating zero.
200 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength);
203 Routine to get hex characters and turn them into a 16 byte array.
204 the array can be variable length, and any non-hex-numeric
205 characters are skipped. "0xnn" or "0Xnn" is specially catered
208 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
212 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len);
215 * Parse a hex string and return a data blob.
217 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex) ;
220 * Routine to print a buffer as HEX digits, into an allocated string.
222 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer);
225 * talloc version of hex_encode()
227 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len);
230 Substitute a string for a pattern in another string. Make sure there is
233 This routine looks for pattern in s and replaces it with
234 insert. It may do multiple replacements.
236 Any of " ; ' $ or ` in the insert string are replaced with _
237 if len==0 then the string cannot be extended. This is different from the old
238 use of len==0 which was for no length checks to be done.
240 _PUBLIC_ void string_sub(char *s,const char *pattern, const char *insert, size_t len);
243 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
244 const char *pattern, const char *insert);
247 Similar to string_sub() but allows for any character to be substituted.
249 if len==0 then the string cannot be extended. This is different from the old
250 use of len==0 which was for no length checks to be done.
252 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len);
255 Unescape a URL encoded string, in place.
257 _PUBLIC_ void rfc1738_unescape(char *buf);
258 size_t valgrind_strlen(const char *s);
261 format a string into length-prefixed dotted domain format, as used in NBT
262 and in some ADS structures
264 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s);
267 * Add a string to an array of strings.
269 * num should be a pointer to an integer that holds the current
270 * number of elements in strings. It will be updated by this function.
272 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
273 const char *str, const char ***strings, int *num);
276 varient of strcmp() that handles NULL ptrs
278 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2);
281 return the number of bytes occupied by a buffer in ASCII format
282 the result includes the null termination
285 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n);
288 Return a string representing a CIFS attribute for a file.
290 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib);
293 Set a boolean variable from the text value stored in the passed string.
294 Returns true in success, false if the passed string does not correctly
297 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean);
300 * Parse a string containing a boolean value.
302 * val will be set to the read value.
304 * @retval true if a boolean value was parsed, false otherwise.
306 _PUBLIC_ bool conv_str_bool(const char * str, bool * val);
309 * Convert a size specification like 16K into an integral number of bytes.
311 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val);
314 * Parse a uint64_t value from a string
316 * val will be set to the value read.
318 * @retval true if parsing was successful, false otherwise
320 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val);
323 return the number of bytes occupied by a buffer in CH_UTF16 format
324 the result includes the null termination
326 _PUBLIC_ size_t utf16_len(const void *buf);
329 return the number of bytes occupied by a buffer in CH_UTF16 format
330 the result includes the null termination
333 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n);
334 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags);
337 Do a case-insensitive, whitespace-ignoring string compare.
339 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2);
344 _PUBLIC_ void string_replace(char *s, char oldc, char newc);
349 * @note The comparison is case-insensitive.
351 _PUBLIC_ bool strequal(const char *s1, const char *s2);
353 /* The following definitions come from lib/util/util_strlist.c */
357 build a null terminated list of strings from a input string and a
358 separator list. The separator list must contain characters less than
359 or equal to 0x2f for this to work correctly on multi-byte strings
361 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
364 * build a null terminated list of strings from an argv-like input string
365 * Entries are seperated by spaces and can be enclosed by quotes.
366 * Does NOT support escaping
368 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep);
371 * join a list back to one string
373 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator);
375 /** join a list back to one (shell-like) string; entries
376 * seperated by spaces, using quotes where necessary */
377 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep);
380 return the number of elements in a string list
382 _PUBLIC_ size_t str_list_length(const char * const *list);
387 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list);
390 Return true if all the elements of the list match exactly.
392 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2);
395 add an entry to a string list
397 _PUBLIC_ const char **str_list_add(const char **list, const char *s);
400 remove an entry from a string list
402 _PUBLIC_ void str_list_remove(const char **list, const char *s);
405 return true if a string is in a list
407 _PUBLIC_ bool str_list_check(const char **list, const char *s);
410 return true if a string is in a list, case insensitively
412 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s);
414 /* The following definitions come from lib/util/util_file.c */
418 read a line from a file with possible \ continuation chars.
419 Blanks at the start or end of a line are stripped.
420 The string will be allocated if s2 is NULL
422 _PUBLIC_ char *fgets_slash(char *s2,int maxlen,XFILE *f);
425 * Read one line (data until next newline or eof) and allocate it
427 _PUBLIC_ char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint);
430 load a file into memory from a fd.
432 _PUBLIC_ char *fd_load(int fd, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
435 load a file into memory
437 _PUBLIC_ char *file_load(const char *fname, size_t *size, size_t maxsize, TALLOC_CTX *mem_ctx);
440 mmap (if possible) or read a file
442 _PUBLIC_ void *map_file(const char *fname, size_t size);
445 load a file into memory and return an array of pointers to lines in the file
446 must be freed with talloc_free().
448 _PUBLIC_ char **file_lines_load(const char *fname, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
451 load a fd into memory and return an array of pointers to lines in the file
452 must be freed with talloc_free(). If convert is true calls unix_to_dos on
455 _PUBLIC_ char **fd_lines_load(int fd, int *numlines, size_t maxsize, TALLOC_CTX *mem_ctx);
458 take a list of lines and modify them to produce a list where \ continues
461 _PUBLIC_ void file_lines_slashcont(char **lines);
464 save a lump of data into a file. Mostly used for debugging
466 _PUBLIC_ bool file_save(const char *fname, const void *packet, size_t length);
467 _PUBLIC_ int vfdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
468 _PUBLIC_ int fdprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
469 _PUBLIC_ bool large_file_support(const char *path);
471 /* The following definitions come from lib/util/util.c */
475 Find a suitable temporary directory. The result should be copied immediately
476 as it may be overwritten by a subsequent call.
478 _PUBLIC_ const char *tmpdir(void);
481 Check if a file exists - call vfs_file_exist for samba files.
483 _PUBLIC_ bool file_exist(const char *fname);
486 Check a files mod time.
488 _PUBLIC_ time_t file_modtime(const char *fname);
491 Check if a directory exists.
493 _PUBLIC_ bool directory_exist(const char *dname);
496 * Try to create the specified directory if it didn't exist.
498 * @retval true if the directory already existed and has the right permissions
499 * or was successfully created.
501 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
505 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
510 _PUBLIC_ int set_blocking(int fd, bool set);
513 Sleep for a specified number of milliseconds.
515 _PUBLIC_ void msleep(unsigned int t);
518 Get my own name, return in malloc'ed storage.
520 _PUBLIC_ char* get_myname(void);
523 Return true if a string could be a pure IP address.
525 _PUBLIC_ bool is_ipaddress(const char *str);
528 Interpret an internet address or name into an IP address in 4 byte form.
530 _PUBLIC_ uint32_t interpret_addr(const char *str);
533 A convenient addition to interpret_addr().
535 _PUBLIC_ struct in_addr interpret_addr2(const char *str);
538 Check if an IP is the 0.0.0.0.
540 _PUBLIC_ bool is_zero_ip(struct in_addr ip);
543 Are two IPs on the same subnet?
545 _PUBLIC_ bool same_net(struct in_addr ip1,struct in_addr ip2,struct in_addr mask);
548 Check if a process exists. Does this work on all unixes?
550 _PUBLIC_ bool process_exists_by_pid(pid_t pid);
553 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
554 is dealt with in posix.c
556 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type);
559 * Write dump of binary data to the log file.
561 * The data is only written if the log level is at least level.
563 _PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
566 * Write dump of binary data to the log file.
568 * The data is only written if the log level is at least level.
569 * 16 zero bytes in a row are ommited
571 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len);
574 malloc that aborts with smb_panic on fail or zero size.
576 _PUBLIC_ void *smb_xmalloc(size_t size);
579 Memdup with smb_panic on fail.
581 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size);
584 strdup that aborts on malloc fail.
586 _PUBLIC_ char *smb_xstrdup(const char *s);
589 Like strdup but for memory.
591 _PUBLIC_ void *memdup(const void *p, size_t size);
594 * Write a password to the log file.
596 * @note Only actually does something if DEBUG_PASSWORD was defined during
599 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
602 * see if a range of memory is all zero. A NULL pointer is considered
605 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size);
608 realloc an array, checking for integer overflow in the array size
610 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail);
612 /* The following definitions come from lib/util/fsusage.c */
616 * Retrieve amount of free disk space.
617 * this does all of the system specific guff to get the free disk space.
618 * It is derived from code in the GNU fileutils package, but has been
619 * considerably mangled for use here
621 * results are returned in *dfree and *dsize, in 512 byte units
623 _PUBLIC_ int sys_fsusage(const char *path, uint64_t *dfree, uint64_t *dsize);
625 /* The following definitions come from lib/util/ms_fnmatch.c */
630 * @brief MS-style Filename matching
633 /* protocol types. It assumes that higher protocols include lower protocols
634 as subsets. FIXME: Move to one of the smb-specific headers */
635 enum protocol_types {
645 int ms_fnmatch(const char *pattern, const char *string, enum protocol_types protocol);
647 /** a generic fnmatch function - uses for non-CIFS pattern matching */
648 int gen_fnmatch(const char *pattern, const char *string);
650 /* The following definitions come from lib/util/mutex.c */
654 register a set of mutex/rwlock handlers.
655 Should only be called once in the execution of smbd.
657 _PUBLIC_ bool register_mutex_handlers(const char *name, struct mutex_ops *ops);
659 /* The following definitions come from lib/util/idtree.c */
663 initialise a idr tree. The context return value must be passed to
664 all subsequent idr calls. To destroy the idr tree use talloc_free()
667 _PUBLIC_ struct idr_context *idr_init(TALLOC_CTX *mem_ctx);
670 allocate the next available id, and assign 'ptr' into its slot.
671 you can retrieve later this pointer using idr_find()
673 _PUBLIC_ int idr_get_new(struct idr_context *idp, void *ptr, int limit);
676 allocate a new id, giving the first available value greater than or
677 equal to the given starting id
679 _PUBLIC_ int idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id, int limit);
682 allocate a new id randomly in the given range
684 _PUBLIC_ int idr_get_new_random(struct idr_context *idp, void *ptr, int limit);
687 find a pointer value previously set with idr_get_new given an id
689 _PUBLIC_ void *idr_find(struct idr_context *idp, int id);
692 remove an id from the idr tree
694 _PUBLIC_ int idr_remove(struct idr_context *idp, int id);
696 /* The following definitions come from lib/util/become_daemon.c */
699 Become a daemon, discarding the controlling terminal.
701 _PUBLIC_ void become_daemon(bool fork);
704 * Load a ini-style file.
706 bool pm_process( const char *fileName,
707 bool (*sfunc)(const char *, void *),
708 bool (*pfunc)(const char *, const char *, void *),
712 * Add-on to talloc_get_type
714 _PUBLIC_ void *talloc_check_name_abort(const void *ptr, const char *name);
715 #define talloc_get_type_abort(ptr, type) \
716 (type *)talloc_check_name_abort(ptr, #type)
718 #endif /* _SAMBA_UTIL_H_ */