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
7 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
8 Copyright (C) James J Myers 2003
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "system/network.h"
26 #include "system/filesys.h"
27 #include "system/locale.h"
28 #include "system/shmem.h"
36 #if defined(UID_WRAPPER)
37 #if !defined(UID_WRAPPER_REPLACE) && !defined(UID_WRAPPER_NOT_REPLACE)
38 #define UID_WRAPPER_REPLACE
39 #include "../uid_wrapper/uid_wrapper.h"
42 #define uwrap_enabled() 0
47 * @brief Misc utility functions
51 Find a suitable temporary directory. The result should be copied immediately
52 as it may be overwritten by a subsequent call.
54 _PUBLIC_ const char *tmpdir(void)
57 if ((p = getenv("TMPDIR")))
64 Check if a file exists - call vfs_file_exist for samba files.
66 _PUBLIC_ bool file_exist(const char *fname)
70 if (stat(fname, &st) != 0) {
74 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
78 Check a files mod time.
81 _PUBLIC_ time_t file_modtime(const char *fname)
85 if (stat(fname,&st) != 0)
92 Check if a directory exists.
95 _PUBLIC_ bool directory_exist(const char *dname)
100 if (stat(dname,&st) != 0) {
104 ret = S_ISDIR(st.st_mode);
111 * Try to create the specified directory if it didn't exist.
113 * @retval true if the directory already existed and has the right permissions
114 * or was successfully created.
116 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
122 old_umask = umask(0);
123 if (lstat(dname, &st) == -1) {
124 if (errno == ENOENT) {
125 /* Create directory */
126 if (mkdir(dname, dir_perms) == -1) {
127 DEBUG(0, ("error creating directory "
134 DEBUG(0, ("lstat failed on directory %s: %s\n",
135 dname, strerror(errno)));
140 /* Check ownership and permission on existing directory */
141 if (!S_ISDIR(st.st_mode)) {
142 DEBUG(0, ("directory %s isn't a directory\n",
147 if (st.st_uid != uid && !uwrap_enabled()) {
148 DEBUG(0, ("invalid ownership on directory "
153 if ((st.st_mode & 0777) != dir_perms) {
154 DEBUG(0, ("invalid permissions on directory "
155 "'%s': has 0%o should be 0%o\n", dname,
156 (st.st_mode & 0777), dir_perms));
166 Sleep for a specified number of milliseconds.
169 _PUBLIC_ void smb_msleep(unsigned int t)
171 #if defined(HAVE_NANOSLEEP)
176 ts.tv_nsec = 1000000*(t%1000);
180 ret = nanosleep(&ts, &ts);
181 } while (ret < 0 && errno == EINTR && (ts.tv_sec > 0 || ts.tv_nsec > 0));
183 unsigned int tdiff=0;
184 struct timeval tval,t1,t2;
191 tval.tv_sec = (t-tdiff)/1000;
192 tval.tv_usec = 1000*((t-tdiff)%1000);
194 /* Never wait for more than 1 sec. */
195 if (tval.tv_sec > 1) {
202 select(0,&fds,NULL,NULL,&tval);
205 if (t2.tv_sec < t1.tv_sec) {
206 /* Someone adjusted time... */
210 tdiff = usec_time_diff(&t2,&t1)/1000;
216 Get my own name, return in talloc'ed storage.
219 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
222 char hostname[HOST_NAME_MAX];
224 /* get my host name */
225 if (gethostname(hostname, sizeof(hostname)) == -1) {
226 DEBUG(0,("gethostname failed\n"));
230 /* Ensure null termination. */
231 hostname[sizeof(hostname)-1] = '\0';
233 /* split off any parts after an initial . */
234 p = strchr_m(hostname, '.');
239 return talloc_strdup(ctx, hostname);
243 Check if a process exists. Does this work on all unixes?
246 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
248 /* Doing kill with a non-positive pid causes messages to be
249 * sent to places we don't want. */
251 return(kill(pid,0) == 0 || errno != ESRCH);
255 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
256 is dealt with in posix.c
259 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
264 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
267 lock.l_whence = SEEK_SET;
268 lock.l_start = offset;
272 ret = fcntl(fd,op,&lock);
274 if (ret == -1 && errno != 0)
275 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
280 (lock.l_type != F_UNLCK) &&
282 (lock.l_pid != getpid())) {
283 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
287 /* it must be not locked or locked by me */
291 /* a lock set or unset */
293 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
294 (double)offset,(double)count,op,type,strerror(errno)));
298 /* everything went OK */
299 DEBUG(8,("fcntl_lock: Lock call successful\n"));
304 static void debugadd_cb(const char *buf, void *private_data)
306 int *plevel = (int *)private_data;
307 DEBUGADD(*plevel, ("%s", buf));
310 void print_asc_cb(const uint8_t *buf, int len,
311 void (*cb)(const char *buf, void *private_data),
318 for (i=0; i<len; i++) {
319 s[0] = isprint(buf[i]) ? buf[i] : '.';
324 void print_asc(int level, const uint8_t *buf,int len)
326 print_asc_cb(buf, len, debugadd_cb, &level);
330 * Write dump of binary data to a callback
332 void dump_data_cb(const uint8_t *buf, int len,
333 bool omit_zero_bytes,
334 void (*cb)(const char *buf, void *private_data),
338 static const uint8_t empty[16] = { 0, };
339 bool skipped = false;
347 if ((omit_zero_bytes == true) &&
350 (memcmp(&buf[i], &empty, 16) == 0))
357 snprintf(tmp, sizeof(tmp), "[%04X] ", i);
358 cb(tmp, private_data);
362 snprintf(tmp, sizeof(tmp), "%02X ", (int)buf[i]);
363 cb(tmp, private_data);
366 cb(" ", private_data);
370 print_asc_cb(&buf[i-16], 8, cb, private_data);
371 cb(" ", private_data);
372 print_asc_cb(&buf[i-8], 8, cb, private_data);
373 cb("\n", private_data);
375 if ((omit_zero_bytes == true) &&
377 (memcmp(&buf[i], &empty, 16) == 0)) {
379 cb("skipping zero buffer bytes\n",
390 cb(" ", private_data);
392 cb(" ", private_data);
395 cb(" ", private_data);
398 print_asc_cb(&buf[i-(i%16)], n, cb, private_data);
399 cb(" ", private_data);
402 print_asc_cb(&buf[i-n], n, cb, private_data);
404 cb("\n", private_data);
410 * Write dump of binary data to the log file.
412 * The data is only written if the log level is at least level.
414 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
416 if (!DEBUGLVL(level)) {
419 dump_data_cb(buf, len, false, debugadd_cb, &level);
423 * Write dump of binary data to the log file.
425 * The data is only written if the log level is at least level.
426 * 16 zero bytes in a row are omitted
428 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
430 if (!DEBUGLVL(level)) {
433 dump_data_cb(buf, len, true, debugadd_cb, &level);
438 malloc that aborts with smb_panic on fail or zero size.
441 _PUBLIC_ void *smb_xmalloc(size_t size)
445 smb_panic("smb_xmalloc: called with zero size.\n");
446 if ((p = malloc(size)) == NULL)
447 smb_panic("smb_xmalloc: malloc fail.\n");
452 Memdup with smb_panic on fail.
455 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
458 p2 = smb_xmalloc(size);
464 strdup that aborts on malloc fail.
467 char *smb_xstrdup(const char *s)
469 #if defined(PARANOID_MALLOC_CHECKER)
476 #define strdup rep_strdup
479 char *s1 = strdup(s);
480 #if defined(PARANOID_MALLOC_CHECKER)
484 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
487 smb_panic("smb_xstrdup: malloc failed");
494 strndup that aborts on malloc fail.
497 char *smb_xstrndup(const char *s, size_t n)
499 #if defined(PARANOID_MALLOC_CHECKER)
505 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
507 #define strndup rep_strndup
510 char *s1 = strndup(s, n);
511 #if defined(PARANOID_MALLOC_CHECKER)
515 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
518 smb_panic("smb_xstrndup: malloc failed");
526 Like strdup but for memory.
529 _PUBLIC_ void *memdup(const void *p, size_t size)
542 * Write a password to the log file.
544 * @note Only actually does something if DEBUG_PASSWORD was defined during
547 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
549 #ifdef DEBUG_PASSWORD
550 DEBUG(11, ("%s", msg));
551 if (data != NULL && len > 0)
553 dump_data(11, data, len);
560 * see if a range of memory is all zero. A NULL pointer is considered
563 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
566 if (!ptr) return true;
567 for (i=0;i<size;i++) {
568 if (ptr[i]) return false;
574 realloc an array, checking for integer overflow in the array size
576 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
578 #define MAX_MALLOC_SIZE 0x7fffffff
580 count >= MAX_MALLOC_SIZE/el_size) {
586 return malloc(el_size * count);
588 return realloc(ptr, el_size * count);
591 /****************************************************************************
593 ****************************************************************************/
595 void *malloc_array(size_t el_size, unsigned int count)
597 return realloc_array(NULL, el_size, count, false);
601 Trim the specified elements off the front and back of a string.
603 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
610 /* Ignore null or empty strings. */
611 if (!s || (s[0] == '\0'))
614 front_len = front? strlen(front) : 0;
615 back_len = back? strlen(back) : 0;
620 while (len && strncmp(s, front, front_len)==0) {
621 /* Must use memmove here as src & dest can
622 * easily overlap. Found by valgrind. JRA. */
623 memmove(s, s+front_len, (len-front_len)+1);
630 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
631 s[len-back_len]='\0';
640 Find the number of 'c' chars in a string
642 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
647 if (*s == c) count++;
655 Routine to get hex characters and turn them into a 16 byte array.
656 the array can be variable length, and any non-hex-numeric
657 characters are skipped. "0xnn" or "0Xnn" is specially catered
660 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
664 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
667 size_t num_chars = 0;
668 uint8_t lonybble, hinybble;
669 const char *hexchars = "0123456789ABCDEF";
670 char *p1 = NULL, *p2 = NULL;
672 /* skip leading 0x prefix */
673 if (strncasecmp(strhex, "0x", 2) == 0) {
674 i += 2; /* skip two chars */
677 for (; i < strhex_len && strhex[i] != 0; i++) {
678 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
681 i++; /* next hex digit */
683 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
686 /* get the two nybbles */
687 hinybble = PTR_DIFF(p1, hexchars);
688 lonybble = PTR_DIFF(p2, hexchars);
690 if (num_chars >= p_len) {
694 p[num_chars] = (hinybble << 4) | lonybble;
704 * Parse a hex string and return a data blob.
706 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
708 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
710 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
719 * Routine to print a buffer as HEX digits, into an allocated string.
721 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
726 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
727 hex_buffer = *out_hex_buffer;
729 for (i = 0; i < len; i++)
730 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
734 * talloc version of hex_encode()
736 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
741 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
746 for (i = 0; i < len; i++)
747 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
749 talloc_set_name_const(hex_buffer, hex_buffer);
754 varient of strcmp() that handles NULL ptrs
756 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
761 if (s1 == NULL || s2 == NULL) {
764 return strcmp(s1, s2);
769 return the number of bytes occupied by a buffer in ASCII format
770 the result includes the null termination
773 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
777 len = strnlen(src, n);
786 Set a boolean variable from the text value stored in the passed string.
787 Returns true in success, false if the passed string does not correctly
791 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
793 if (strwicmp(boolean_string, "yes") == 0 ||
794 strwicmp(boolean_string, "true") == 0 ||
795 strwicmp(boolean_string, "on") == 0 ||
796 strwicmp(boolean_string, "1") == 0) {
799 } else if (strwicmp(boolean_string, "no") == 0 ||
800 strwicmp(boolean_string, "false") == 0 ||
801 strwicmp(boolean_string, "off") == 0 ||
802 strwicmp(boolean_string, "0") == 0) {
810 return the number of bytes occupied by a buffer in CH_UTF16 format
811 the result includes the null termination
813 _PUBLIC_ size_t utf16_len(const void *buf)
817 for (len = 0; SVAL(buf,len); len += 2) ;
823 return the number of bytes occupied by a buffer in CH_UTF16 format
824 the result includes the null termination
827 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
831 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
842 * @brief String utilities.
845 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
864 /* default to simple separators */
869 /* find the first non sep char, if left-trimming is requested */
871 while (*s && strchr_m(sep,*s)) {
881 /* When restarting we need to go from here. */
884 /* Work out the length needed. */
885 for (quoted = false; *s &&
886 (quoted || !strchr_m(sep,*s)); s++) {
894 /* We started with len = 1 so we have space for the nul. */
895 *pp_buff = talloc_array(ctx, char, len);
900 /* copy over the token */
903 for (quoted = false; *s &&
904 (quoted || !strchr_m(sep,*s)); s++) {
912 *ptr = (*s) ? s+1 : s;
918 bool next_token_talloc(TALLOC_CTX *ctx,
923 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
927 * Get the next token from a string, return false if none found. Handles
928 * double-quotes. This version does not trim leading separator characters
929 * before looking for a token.
932 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
937 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
941 * Get the next token from a string, return False if none found.
942 * Handles double-quotes.
944 * Based on a routine by GJC@VILLAGE.COM.
945 * Extensively modified by Andrew.Tridgell@anu.edu.au
947 _PUBLIC_ bool next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
958 /* default to simple separators */
962 /* find the first non sep char */
963 while (*s && strchr_m(sep,*s))
970 /* copy over the token */
971 for (quoted = false; len < bufsize && *s && (quoted || !strchr_m(sep,*s)); s++) {
980 *ptr = (*s) ? s+1 : s;
986 struct anonymous_shared_header {
993 /* Map a shared memory buffer of at least nelem counters. */
994 void *anonymous_shared_allocate(size_t orig_bufsz)
998 size_t pagesz = getpagesize();
1000 size_t bufsz = orig_bufsz;
1001 struct anonymous_shared_header *hdr;
1003 bufsz += sizeof(*hdr);
1005 /* round up to full pages */
1006 pagecnt = bufsz / pagesz;
1007 if (bufsz % pagesz) {
1010 bufsz = pagesz * pagecnt;
1012 if (orig_bufsz >= bufsz) {
1020 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED,
1021 -1 /* fd */, 0 /* offset */);
1023 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_FILE|MAP_SHARED,
1024 open("/dev/zero", O_RDWR), 0 /* offset */);
1027 if (buf == MAP_FAILED) {
1031 hdr = (struct anonymous_shared_header *)buf;
1032 hdr->u.length = bufsz;
1034 ptr = (void *)(&hdr[1]);
1039 void anonymous_shared_free(void *ptr)
1041 struct anonymous_shared_header *hdr;
1047 hdr = (struct anonymous_shared_header *)ptr;
1051 munmap(hdr, hdr->u.length);
1055 /* used when you want a debugger started at a particular point in the
1056 code. Mostly useful in code that runs as a child process, where
1057 normal gdb attach is harder to organise.
1059 void samba_start_debugger(void)
1062 if (asprintf(&cmd, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
1065 if (system(cmd) == -1) {