2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2001-2002
6 Copyright (C) Simo Sorce 2001-2011
7 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
8 Copyright (C) James J Myers 2003
9 Copyright (C) Volker Lendecke 2010
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include "system/network.h"
27 #include "system/filesys.h"
28 #include "system/locale.h"
29 #include "system/shmem.h"
37 #if defined(UID_WRAPPER)
38 #if !defined(UID_WRAPPER_REPLACE) && !defined(UID_WRAPPER_NOT_REPLACE)
39 #define UID_WRAPPER_REPLACE
40 #include "../uid_wrapper/uid_wrapper.h"
43 #define uwrap_enabled() 0
48 * @brief Misc utility functions
52 Find a suitable temporary directory. The result should be copied immediately
53 as it may be overwritten by a subsequent call.
55 _PUBLIC_ const char *tmpdir(void)
58 if ((p = getenv("TMPDIR")))
65 Create a tmp file, open it and immediately unlink it.
66 If dir is NULL uses tmpdir()
67 Returns the file descriptor or -1 on error.
69 int create_unlink_tmp(const char *dir)
78 fname = talloc_asprintf(talloc_tos(), "%s/listenerlock_XXXXXX", dir);
88 if (unlink(fname) == -1) {
89 int sys_errno = errno;
101 Check if a file exists - call vfs_file_exist for samba files.
103 _PUBLIC_ bool file_exist(const char *fname)
107 if (stat(fname, &st) != 0) {
111 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
115 Check a files mod time.
118 _PUBLIC_ time_t file_modtime(const char *fname)
122 if (stat(fname,&st) != 0)
129 Check if a directory exists.
132 _PUBLIC_ bool directory_exist(const char *dname)
137 if (stat(dname,&st) != 0) {
141 ret = S_ISDIR(st.st_mode);
148 * Try to create the specified directory if it didn't exist.
150 * @retval true if the directory already existed and has the right permissions
151 * or was successfully created.
153 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
159 old_umask = umask(0);
160 if (lstat(dname, &st) == -1) {
161 if (errno == ENOENT) {
162 /* Create directory */
163 if (mkdir(dname, dir_perms) == -1) {
164 DEBUG(0, ("error creating directory "
171 DEBUG(0, ("lstat failed on directory %s: %s\n",
172 dname, strerror(errno)));
177 /* Check ownership and permission on existing directory */
178 if (!S_ISDIR(st.st_mode)) {
179 DEBUG(0, ("directory %s isn't a directory\n",
184 if (st.st_uid != uid && !uwrap_enabled()) {
185 DEBUG(0, ("invalid ownership on directory "
190 if ((st.st_mode & 0777) != dir_perms) {
191 DEBUG(0, ("invalid permissions on directory "
192 "'%s': has 0%o should be 0%o\n", dname,
193 (st.st_mode & 0777), dir_perms));
203 Sleep for a specified number of milliseconds.
206 _PUBLIC_ void smb_msleep(unsigned int t)
208 #if defined(HAVE_NANOSLEEP)
213 ts.tv_nsec = 1000000*(t%1000);
217 ret = nanosleep(&ts, &ts);
218 } while (ret < 0 && errno == EINTR && (ts.tv_sec > 0 || ts.tv_nsec > 0));
220 unsigned int tdiff=0;
221 struct timeval tval,t1,t2;
228 tval.tv_sec = (t-tdiff)/1000;
229 tval.tv_usec = 1000*((t-tdiff)%1000);
231 /* Never wait for more than 1 sec. */
232 if (tval.tv_sec > 1) {
239 select(0,&fds,NULL,NULL,&tval);
242 if (t2.tv_sec < t1.tv_sec) {
243 /* Someone adjusted time... */
247 tdiff = usec_time_diff(&t2,&t1)/1000;
253 Get my own name, return in talloc'ed storage.
256 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
259 char hostname[HOST_NAME_MAX];
261 /* get my host name */
262 if (gethostname(hostname, sizeof(hostname)) == -1) {
263 DEBUG(0,("gethostname failed\n"));
267 /* Ensure null termination. */
268 hostname[sizeof(hostname)-1] = '\0';
270 /* split off any parts after an initial . */
271 p = strchr_m(hostname, '.');
276 return talloc_strdup(ctx, hostname);
280 Check if a process exists. Does this work on all unixes?
283 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
285 /* Doing kill with a non-positive pid causes messages to be
286 * sent to places we don't want. */
288 return(kill(pid,0) == 0 || errno != ESRCH);
292 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
293 is dealt with in posix.c
296 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
301 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
304 lock.l_whence = SEEK_SET;
305 lock.l_start = offset;
309 ret = fcntl(fd,op,&lock);
311 if (ret == -1 && errno != 0)
312 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
317 (lock.l_type != F_UNLCK) &&
319 (lock.l_pid != getpid())) {
320 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
324 /* it must be not locked or locked by me */
328 /* a lock set or unset */
330 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
331 (double)offset,(double)count,op,type,strerror(errno)));
335 /* everything went OK */
336 DEBUG(8,("fcntl_lock: Lock call successful\n"));
341 static void debugadd_cb(const char *buf, void *private_data)
343 int *plevel = (int *)private_data;
344 DEBUGADD(*plevel, ("%s", buf));
347 void print_asc_cb(const uint8_t *buf, int len,
348 void (*cb)(const char *buf, void *private_data),
355 for (i=0; i<len; i++) {
356 s[0] = isprint(buf[i]) ? buf[i] : '.';
361 void print_asc(int level, const uint8_t *buf,int len)
363 print_asc_cb(buf, len, debugadd_cb, &level);
367 * Write dump of binary data to a callback
369 void dump_data_cb(const uint8_t *buf, int len,
370 bool omit_zero_bytes,
371 void (*cb)(const char *buf, void *private_data),
375 static const uint8_t empty[16] = { 0, };
376 bool skipped = false;
384 if ((omit_zero_bytes == true) &&
387 (memcmp(&buf[i], &empty, 16) == 0))
394 snprintf(tmp, sizeof(tmp), "[%04X] ", i);
395 cb(tmp, private_data);
399 snprintf(tmp, sizeof(tmp), "%02X ", (int)buf[i]);
400 cb(tmp, private_data);
403 cb(" ", private_data);
407 print_asc_cb(&buf[i-16], 8, cb, private_data);
408 cb(" ", private_data);
409 print_asc_cb(&buf[i-8], 8, cb, private_data);
410 cb("\n", private_data);
412 if ((omit_zero_bytes == true) &&
414 (memcmp(&buf[i], &empty, 16) == 0)) {
416 cb("skipping zero buffer bytes\n",
427 cb(" ", private_data);
429 cb(" ", private_data);
432 cb(" ", private_data);
435 print_asc_cb(&buf[i-(i%16)], n, cb, private_data);
436 cb(" ", private_data);
439 print_asc_cb(&buf[i-n], n, cb, private_data);
441 cb("\n", private_data);
447 * Write dump of binary data to the log file.
449 * The data is only written if the log level is at least level.
451 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
453 if (!DEBUGLVL(level)) {
456 dump_data_cb(buf, len, false, debugadd_cb, &level);
460 * Write dump of binary data to the log file.
462 * The data is only written if the log level is at least level.
463 * 16 zero bytes in a row are omitted
465 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
467 if (!DEBUGLVL(level)) {
470 dump_data_cb(buf, len, true, debugadd_cb, &level);
475 malloc that aborts with smb_panic on fail or zero size.
478 _PUBLIC_ void *smb_xmalloc(size_t size)
482 smb_panic("smb_xmalloc: called with zero size.\n");
483 if ((p = malloc(size)) == NULL)
484 smb_panic("smb_xmalloc: malloc fail.\n");
489 Memdup with smb_panic on fail.
492 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
495 p2 = smb_xmalloc(size);
501 strdup that aborts on malloc fail.
504 char *smb_xstrdup(const char *s)
506 #if defined(PARANOID_MALLOC_CHECKER)
513 #define strdup rep_strdup
516 char *s1 = strdup(s);
517 #if defined(PARANOID_MALLOC_CHECKER)
521 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
524 smb_panic("smb_xstrdup: malloc failed");
531 strndup that aborts on malloc fail.
534 char *smb_xstrndup(const char *s, size_t n)
536 #if defined(PARANOID_MALLOC_CHECKER)
542 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
544 #define strndup rep_strndup
547 char *s1 = strndup(s, n);
548 #if defined(PARANOID_MALLOC_CHECKER)
552 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
555 smb_panic("smb_xstrndup: malloc failed");
563 Like strdup but for memory.
566 _PUBLIC_ void *memdup(const void *p, size_t size)
579 * Write a password to the log file.
581 * @note Only actually does something if DEBUG_PASSWORD was defined during
584 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
586 #ifdef DEBUG_PASSWORD
587 DEBUG(11, ("%s", msg));
588 if (data != NULL && len > 0)
590 dump_data(11, data, len);
597 * see if a range of memory is all zero. A NULL pointer is considered
600 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
603 if (!ptr) return true;
604 for (i=0;i<size;i++) {
605 if (ptr[i]) return false;
611 realloc an array, checking for integer overflow in the array size
613 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
615 #define MAX_MALLOC_SIZE 0x7fffffff
617 count >= MAX_MALLOC_SIZE/el_size) {
623 return malloc(el_size * count);
625 return realloc(ptr, el_size * count);
628 /****************************************************************************
630 ****************************************************************************/
632 void *malloc_array(size_t el_size, unsigned int count)
634 return realloc_array(NULL, el_size, count, false);
638 Trim the specified elements off the front and back of a string.
640 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
647 /* Ignore null or empty strings. */
648 if (!s || (s[0] == '\0'))
651 front_len = front? strlen(front) : 0;
652 back_len = back? strlen(back) : 0;
657 while (len && strncmp(s, front, front_len)==0) {
658 /* Must use memmove here as src & dest can
659 * easily overlap. Found by valgrind. JRA. */
660 memmove(s, s+front_len, (len-front_len)+1);
667 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
668 s[len-back_len]='\0';
677 Find the number of 'c' chars in a string
679 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
684 if (*s == c) count++;
692 Routine to get hex characters and turn them into a 16 byte array.
693 the array can be variable length, and any non-hex-numeric
694 characters are skipped. "0xnn" or "0Xnn" is specially catered
697 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
701 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
704 size_t num_chars = 0;
705 uint8_t lonybble, hinybble;
706 const char *hexchars = "0123456789ABCDEF";
707 char *p1 = NULL, *p2 = NULL;
709 /* skip leading 0x prefix */
710 if (strncasecmp(strhex, "0x", 2) == 0) {
711 i += 2; /* skip two chars */
714 for (; i < strhex_len && strhex[i] != 0; i++) {
715 p1 = strchr(hexchars, toupper((unsigned char)strhex[i]));
720 i++; /* next hex digit */
722 p2 = strchr(hexchars, toupper((unsigned char)strhex[i]));
727 /* get the two nybbles */
728 hinybble = PTR_DIFF(p1, hexchars);
729 lonybble = PTR_DIFF(p2, hexchars);
731 if (num_chars >= p_len) {
735 p[num_chars] = (hinybble << 4) | lonybble;
745 * Parse a hex string and return a data blob.
747 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
749 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
751 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
760 * Routine to print a buffer as HEX digits, into an allocated string.
762 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
767 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
768 hex_buffer = *out_hex_buffer;
770 for (i = 0; i < len; i++)
771 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
775 * talloc version of hex_encode()
777 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
782 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
787 for (i = 0; i < len; i++)
788 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
790 talloc_set_name_const(hex_buffer, hex_buffer);
795 varient of strcmp() that handles NULL ptrs
797 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
802 if (s1 == NULL || s2 == NULL) {
805 return strcmp(s1, s2);
810 return the number of bytes occupied by a buffer in ASCII format
811 the result includes the null termination
814 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
818 len = strnlen(src, n);
827 Set a boolean variable from the text value stored in the passed string.
828 Returns true in success, false if the passed string does not correctly
832 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
834 if (strwicmp(boolean_string, "yes") == 0 ||
835 strwicmp(boolean_string, "true") == 0 ||
836 strwicmp(boolean_string, "on") == 0 ||
837 strwicmp(boolean_string, "1") == 0) {
840 } else if (strwicmp(boolean_string, "no") == 0 ||
841 strwicmp(boolean_string, "false") == 0 ||
842 strwicmp(boolean_string, "off") == 0 ||
843 strwicmp(boolean_string, "0") == 0) {
851 return the number of bytes occupied by a buffer in CH_UTF16 format
852 the result includes the null termination
854 _PUBLIC_ size_t utf16_len(const void *buf)
858 for (len = 0; SVAL(buf,len); len += 2) ;
864 return the number of bytes occupied by a buffer in CH_UTF16 format
865 the result includes the null termination
868 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
872 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
883 * @brief String utilities.
886 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
905 /* default to simple separators */
910 /* find the first non sep char, if left-trimming is requested */
912 while (*s && strchr_m(sep,*s)) {
922 /* When restarting we need to go from here. */
925 /* Work out the length needed. */
926 for (quoted = false; *s &&
927 (quoted || !strchr_m(sep,*s)); s++) {
935 /* We started with len = 1 so we have space for the nul. */
936 *pp_buff = talloc_array(ctx, char, len);
941 /* copy over the token */
944 for (quoted = false; *s &&
945 (quoted || !strchr_m(sep,*s)); s++) {
953 *ptr = (*s) ? s+1 : s;
959 bool next_token_talloc(TALLOC_CTX *ctx,
964 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
968 * Get the next token from a string, return false if none found. Handles
969 * double-quotes. This version does not trim leading separator characters
970 * before looking for a token.
973 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
978 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
982 * Get the next token from a string, return False if none found.
983 * Handles double-quotes.
985 * Based on a routine by GJC@VILLAGE.COM.
986 * Extensively modified by Andrew.Tridgell@anu.edu.au
988 _PUBLIC_ bool next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
999 /* default to simple separators */
1003 /* find the first non sep char */
1004 while (*s && strchr_m(sep,*s))
1011 /* copy over the token */
1012 for (quoted = false; len < bufsize && *s && (quoted || !strchr_m(sep,*s)); s++) {
1021 *ptr = (*s) ? s+1 : s;
1027 struct anonymous_shared_header {
1034 /* Map a shared memory buffer of at least nelem counters. */
1035 void *anonymous_shared_allocate(size_t orig_bufsz)
1039 size_t pagesz = getpagesize();
1041 size_t bufsz = orig_bufsz;
1042 struct anonymous_shared_header *hdr;
1044 bufsz += sizeof(*hdr);
1046 /* round up to full pages */
1047 pagecnt = bufsz / pagesz;
1048 if (bufsz % pagesz) {
1051 bufsz = pagesz * pagecnt;
1053 if (orig_bufsz >= bufsz) {
1061 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED,
1062 -1 /* fd */, 0 /* offset */);
1064 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_FILE|MAP_SHARED,
1065 open("/dev/zero", O_RDWR), 0 /* offset */);
1068 if (buf == MAP_FAILED) {
1072 hdr = (struct anonymous_shared_header *)buf;
1073 hdr->u.length = bufsz;
1075 ptr = (void *)(&hdr[1]);
1080 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove)
1084 size_t pagesz = getpagesize();
1087 struct anonymous_shared_header *hdr;
1095 hdr = (struct anonymous_shared_header *)ptr;
1097 if (hdr->u.length > (new_size + sizeof(*hdr))) {
1102 bufsz = new_size + sizeof(*hdr);
1104 /* round up to full pages */
1105 pagecnt = bufsz / pagesz;
1106 if (bufsz % pagesz) {
1109 bufsz = pagesz * pagecnt;
1111 if (new_size >= bufsz) {
1117 if (bufsz <= hdr->u.length) {
1122 flags = MREMAP_MAYMOVE;
1125 buf = mremap(hdr, hdr->u.length, bufsz, flags);
1127 if (buf == MAP_FAILED) {
1132 hdr = (struct anonymous_shared_header *)buf;
1133 hdr->u.length = bufsz;
1135 ptr = (void *)(&hdr[1]);
1144 void anonymous_shared_free(void *ptr)
1146 struct anonymous_shared_header *hdr;
1152 hdr = (struct anonymous_shared_header *)ptr;
1156 munmap(hdr, hdr->u.length);
1160 /* used when you want a debugger started at a particular point in the
1161 code. Mostly useful in code that runs as a child process, where
1162 normal gdb attach is harder to organise.
1164 void samba_start_debugger(void)
1167 if (asprintf(&cmd, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
1170 if (system(cmd) == -1) {