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/>.
27 #include "system/network.h"
28 #include "system/filesys.h"
29 #include "system/locale.h"
30 #include "system/shmem.h"
31 #include "system/passwd.h"
32 #include "system/time.h"
33 #include "system/wait.h"
35 #include "samba_util.h"
46 * @brief Misc utility functions
50 Find a suitable temporary directory. The result should be copied immediately
51 as it may be overwritten by a subsequent call.
53 _PUBLIC_ const char *tmpdir(void)
56 if ((p = getenv("TMPDIR")))
63 Create a tmp file, open it and immediately unlink it.
64 If dir is NULL uses tmpdir()
65 Returns the file descriptor or -1 on error.
67 int create_unlink_tmp(const char *dir)
69 size_t len = strlen(dir);
78 len = snprintf(fname, sizeof(fname), "%s/listenerlock_XXXXXX", dir);
79 if (len >= sizeof(fname)) {
83 mask = umask(S_IRWXO | S_IRWXG);
89 if (unlink(fname) == -1) {
90 int sys_errno = errno;
100 Check if a file exists - call vfs_file_exist for samba files.
102 _PUBLIC_ bool file_exist(const char *fname)
106 if (stat(fname, &st) != 0) {
110 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
114 Check a files mod time.
117 _PUBLIC_ time_t file_modtime(const char *fname)
121 if (stat(fname,&st) != 0)
128 Check file permissions.
131 _PUBLIC_ bool file_check_permissions(const char *fname,
145 ret = stat(fname, pst);
147 DEBUG(0, ("stat failed on file '%s': %s\n",
148 fname, strerror(errno)));
152 if (pst->st_uid != uid && !uid_wrapper_enabled()) {
153 DEBUG(0, ("invalid ownership of file '%s': "
154 "owned by uid %u, should be %u\n",
155 fname, (unsigned int)pst->st_uid,
160 if ((pst->st_mode & 0777) != file_perms) {
161 DEBUG(0, ("invalid permissions on file "
162 "'%s': has 0%o should be 0%o\n", fname,
163 (unsigned int)(pst->st_mode & 0777),
164 (unsigned int)file_perms));
172 Check if a directory exists.
175 _PUBLIC_ bool directory_exist(const char *dname)
180 if (stat(dname,&st) != 0) {
184 ret = S_ISDIR(st.st_mode);
191 * Try to create the specified directory if it didn't exist.
193 * @retval true if the directory already existed
194 * or was successfully created.
196 _PUBLIC_ bool directory_create_or_exist(const char *dname,
203 ret = lstat(dname, &st);
208 if (errno != ENOENT) {
209 DEBUG(0, ("lstat failed on directory %s: %s\n",
210 dname, strerror(errno)));
214 /* Create directory */
215 old_umask = umask(0);
216 ret = mkdir(dname, dir_perms);
217 if (ret == -1 && errno != EEXIST) {
218 DEBUG(0, ("mkdir failed on directory "
226 ret = lstat(dname, &st);
228 DEBUG(0, ("lstat failed on created directory %s: %s\n",
229 dname, strerror(errno)));
237 * @brief Try to create a specified directory if it doesn't exist.
239 * The function creates a directory with the given uid and permissions if it
240 * doesn't exist. If it exists it makes sure the uid and permissions are
241 * correct and it will fail if they are different.
243 * @param[in] dname The directory to create.
245 * @param[in] uid The uid the directory needs to belong too.
247 * @param[in] dir_perms The expected permissions of the directory.
249 * @return True on success, false on error.
251 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
259 ok = directory_create_or_exist(dname, dir_perms);
264 rc = lstat(dname, &st);
266 DEBUG(0, ("lstat failed on created directory %s: %s\n",
267 dname, strerror(errno)));
271 /* Check ownership and permission on existing directory */
272 if (!S_ISDIR(st.st_mode)) {
273 DEBUG(0, ("directory %s isn't a directory\n",
277 if (st.st_uid != uid && !uid_wrapper_enabled()) {
278 DEBUG(0, ("invalid ownership on directory "
282 if ((st.st_mode & 0777) != dir_perms) {
283 DEBUG(0, ("invalid permissions on directory "
284 "'%s': has 0%o should be 0%o\n", dname,
285 (unsigned int)(st.st_mode & 0777), (unsigned int)dir_perms));
294 Sleep for a specified number of milliseconds.
297 _PUBLIC_ void smb_msleep(unsigned int t)
299 #if defined(HAVE_NANOSLEEP)
304 ts.tv_nsec = 1000000*(t%1000);
308 ret = nanosleep(&ts, &ts);
309 } while (ret < 0 && errno == EINTR && (ts.tv_sec > 0 || ts.tv_nsec > 0));
311 unsigned int tdiff=0;
312 struct timeval tval,t1,t2;
319 tval.tv_sec = (t-tdiff)/1000;
320 tval.tv_usec = 1000*((t-tdiff)%1000);
322 /* Never wait for more than 1 sec. */
323 if (tval.tv_sec > 1) {
330 select(0,&fds,NULL,NULL,&tval);
333 if (t2.tv_sec < t1.tv_sec) {
334 /* Someone adjusted time... */
338 tdiff = usec_time_diff(&t2,&t1)/1000;
344 Get my own name, return in talloc'ed storage.
347 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
350 char hostname[HOST_NAME_MAX];
352 /* get my host name */
353 if (gethostname(hostname, sizeof(hostname)) == -1) {
354 DEBUG(0,("gethostname failed\n"));
358 /* Ensure null termination. */
359 hostname[sizeof(hostname)-1] = '\0';
361 /* split off any parts after an initial . */
362 p = strchr_m(hostname, '.');
367 return talloc_strdup(ctx, hostname);
371 Check if a process exists. Does this work on all unixes?
374 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
376 /* Doing kill with a non-positive pid causes messages to be
377 * sent to places we don't want. */
381 return(kill(pid,0) == 0 || errno != ESRCH);
385 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
386 is dealt with in posix.c
389 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
394 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
397 lock.l_whence = SEEK_SET;
398 lock.l_start = offset;
402 ret = fcntl(fd,op,&lock);
404 if (ret == -1 && errno != 0)
405 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
410 (lock.l_type != F_UNLCK) &&
412 (lock.l_pid != getpid())) {
413 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
417 /* it must be not locked or locked by me */
421 /* a lock set or unset */
423 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
424 (double)offset,(double)count,op,type,strerror(errno)));
428 /* everything went OK */
429 DEBUG(8,("fcntl_lock: Lock call successful\n"));
434 struct debug_channel_level {
439 static void debugadd_channel_cb(const char *buf, void *private_data)
441 struct debug_channel_level *dcl =
442 (struct debug_channel_level *)private_data;
444 DEBUGADDC(dcl->channel, dcl->level,("%s", buf));
447 static void debugadd_cb(const char *buf, void *private_data)
449 int *plevel = (int *)private_data;
450 DEBUGADD(*plevel, ("%s", buf));
453 void print_asc_cb(const uint8_t *buf, int len,
454 void (*cb)(const char *buf, void *private_data),
461 for (i=0; i<len; i++) {
462 s[0] = isprint(buf[i]) ? buf[i] : '.';
467 void print_asc(int level, const uint8_t *buf,int len)
469 print_asc_cb(buf, len, debugadd_cb, &level);
473 * Write dump of binary data to a callback
475 void dump_data_cb(const uint8_t *buf, int len,
476 bool omit_zero_bytes,
477 void (*cb)(const char *buf, void *private_data),
481 static const uint8_t empty[16] = { 0, };
482 bool skipped = false;
490 if ((omit_zero_bytes == true) &&
493 (memcmp(&buf[i], &empty, 16) == 0))
500 snprintf(tmp, sizeof(tmp), "[%04X] ", i);
501 cb(tmp, private_data);
505 snprintf(tmp, sizeof(tmp), "%02X ", (int)buf[i]);
506 cb(tmp, private_data);
509 cb(" ", private_data);
513 print_asc_cb(&buf[i-16], 8, cb, private_data);
514 cb(" ", private_data);
515 print_asc_cb(&buf[i-8], 8, cb, private_data);
516 cb("\n", private_data);
518 if ((omit_zero_bytes == true) &&
520 (memcmp(&buf[i], &empty, 16) == 0)) {
522 cb("skipping zero buffer bytes\n",
533 cb(" ", private_data);
535 cb(" ", private_data);
538 cb(" ", private_data);
541 print_asc_cb(&buf[i-(i%16)], n, cb, private_data);
542 cb(" ", private_data);
545 print_asc_cb(&buf[i-n], n, cb, private_data);
547 cb("\n", private_data);
553 * Write dump of binary data to the log file.
555 * The data is only written if the log level is at least level.
557 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
559 if (!DEBUGLVL(level)) {
562 dump_data_cb(buf, len, false, debugadd_cb, &level);
566 * Write dump of binary data to the log file.
568 * The data is only written if the log level is at least level for
569 * debug class dbgc_class.
571 _PUBLIC_ void dump_data_dbgc(int dbgc_class, int level, const uint8_t *buf, int len)
573 struct debug_channel_level dcl = { dbgc_class, level };
575 if (!DEBUGLVLC(dbgc_class, level)) {
578 dump_data_cb(buf, len, false, debugadd_channel_cb, &dcl);
582 * Write dump of binary data to the log file.
584 * The data is only written if the log level is at least level.
585 * 16 zero bytes in a row are omitted
587 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
589 if (!DEBUGLVL(level)) {
592 dump_data_cb(buf, len, true, debugadd_cb, &level);
595 static void fprintf_cb(const char *buf, void *private_data)
597 FILE *f = (FILE *)private_data;
598 fprintf(f, "%s", buf);
601 void dump_data_file(const uint8_t *buf, int len, bool omit_zero_bytes,
604 dump_data_cb(buf, len, omit_zero_bytes, fprintf_cb, f);
608 malloc that aborts with smb_panic on fail or zero size.
611 _PUBLIC_ void *smb_xmalloc(size_t size)
615 smb_panic("smb_xmalloc: called with zero size.\n");
616 if ((p = malloc(size)) == NULL)
617 smb_panic("smb_xmalloc: malloc fail.\n");
622 Memdup with smb_panic on fail.
625 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
628 p2 = smb_xmalloc(size);
634 strdup that aborts on malloc fail.
637 char *smb_xstrdup(const char *s)
639 #if defined(PARANOID_MALLOC_CHECKER)
646 #define strdup rep_strdup
649 char *s1 = strdup(s);
650 #if defined(PARANOID_MALLOC_CHECKER)
654 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
657 smb_panic("smb_xstrdup: malloc failed");
664 strndup that aborts on malloc fail.
667 char *smb_xstrndup(const char *s, size_t n)
669 #if defined(PARANOID_MALLOC_CHECKER)
675 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
677 #define strndup rep_strndup
680 char *s1 = strndup(s, n);
681 #if defined(PARANOID_MALLOC_CHECKER)
685 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
688 smb_panic("smb_xstrndup: malloc failed");
696 Like strdup but for memory.
699 _PUBLIC_ void *smb_memdup(const void *p, size_t size)
712 * Write a password to the log file.
714 * @note Only actually does something if DEBUG_PASSWORD was defined during
717 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
719 #ifdef DEBUG_PASSWORD
720 DEBUG(11, ("%s", msg));
721 if (data != NULL && len > 0)
723 dump_data(11, data, len);
730 * see if a range of memory is all zero. A NULL pointer is considered
733 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
736 if (!ptr) return true;
737 for (i=0;i<size;i++) {
738 if (ptr[i]) return false;
744 realloc an array, checking for integer overflow in the array size
746 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
748 #define MAX_MALLOC_SIZE 0x7fffffff
750 count >= MAX_MALLOC_SIZE/el_size) {
756 return malloc(el_size * count);
758 return realloc(ptr, el_size * count);
761 /****************************************************************************
763 ****************************************************************************/
765 void *malloc_array(size_t el_size, unsigned int count)
767 return realloc_array(NULL, el_size, count, false);
770 /****************************************************************************
772 ****************************************************************************/
774 void *memalign_array(size_t el_size, size_t align, unsigned int count)
776 if (count*el_size >= MAX_MALLOC_SIZE) {
780 return memalign(align, el_size*count);
783 /****************************************************************************
785 ****************************************************************************/
787 void *calloc_array(size_t size, size_t nmemb)
789 if (nmemb >= MAX_MALLOC_SIZE/size) {
792 if (size == 0 || nmemb == 0) {
795 return calloc(nmemb, size);
799 Trim the specified elements off the front and back of a string.
801 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
808 /* Ignore null or empty strings. */
809 if (!s || (s[0] == '\0'))
812 front_len = front? strlen(front) : 0;
813 back_len = back? strlen(back) : 0;
818 while (len && strncmp(s, front, front_len)==0) {
819 /* Must use memmove here as src & dest can
820 * easily overlap. Found by valgrind. JRA. */
821 memmove(s, s+front_len, (len-front_len)+1);
828 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
829 s[len-back_len]='\0';
838 Find the number of 'c' chars in a string
840 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
845 if (*s == c) count++;
853 * Routine to get hex characters and turn them into a byte array.
854 * the array can be variable length.
855 * - "0xnn" or "0Xnn" is specially catered for.
856 * - The first non-hex-digit character (apart from possibly leading "0x"
857 * finishes the conversion and skips the rest of the input.
858 * - A single hex-digit character at the end of the string is skipped.
860 * valid examples: "0A5D15"; "0x123456"
862 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
865 size_t num_chars = 0;
866 uint8_t lonybble, hinybble;
867 const char *hexchars = "0123456789ABCDEF";
868 char *p1 = NULL, *p2 = NULL;
870 /* skip leading 0x prefix */
871 if (strncasecmp(strhex, "0x", 2) == 0) {
872 i += 2; /* skip two chars */
875 for (; i+1 < strhex_len && strhex[i] != 0 && strhex[i+1] != 0; i++) {
876 p1 = strchr(hexchars, toupper((unsigned char)strhex[i]));
881 i++; /* next hex digit */
883 p2 = strchr(hexchars, toupper((unsigned char)strhex[i]));
888 /* get the two nybbles */
889 hinybble = PTR_DIFF(p1, hexchars);
890 lonybble = PTR_DIFF(p2, hexchars);
892 if (num_chars >= p_len) {
896 p[num_chars] = (hinybble << 4) | lonybble;
906 * Parse a hex string and return a data blob.
908 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
910 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
912 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
920 * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
922 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen)
925 for (i=0; i<srclen; i++) {
926 snprintf(dst + i*2, 3, "%02X", src[i]);
929 * Ensure 0-termination for 0-length buffers
931 dst[srclen*2] = '\0';
935 * Routine to print a buffer as HEX digits, into an allocated string.
937 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
941 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
942 hex_buffer = *out_hex_buffer;
943 hex_encode_buf(hex_buffer, buff_in, len);
947 * talloc version of hex_encode()
949 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
953 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
957 hex_encode_buf(hex_buffer, buff_in, len);
958 talloc_set_name_const(hex_buffer, hex_buffer);
963 varient of strcmp() that handles NULL ptrs
965 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
970 if (s1 == NULL || s2 == NULL) {
973 return strcmp(s1, s2);
978 return the number of bytes occupied by a buffer in ASCII format
979 the result includes the null termination
982 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
986 len = strnlen(src, n);
994 struct anonymous_shared_header {
1001 /* Map a shared memory buffer of at least nelem counters. */
1002 void *anonymous_shared_allocate(size_t orig_bufsz)
1006 size_t pagesz = getpagesize();
1008 size_t bufsz = orig_bufsz;
1009 struct anonymous_shared_header *hdr;
1011 bufsz += sizeof(*hdr);
1013 /* round up to full pages */
1014 pagecnt = bufsz / pagesz;
1015 if (bufsz % pagesz) {
1018 bufsz = pagesz * pagecnt;
1020 if (orig_bufsz >= bufsz) {
1028 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED,
1029 -1 /* fd */, 0 /* offset */);
1035 fd = open("/dev/zero", O_RDWR);
1040 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_FILE|MAP_SHARED,
1041 fd, 0 /* offset */);
1042 saved_errno = errno;
1044 errno = saved_errno;
1048 if (buf == MAP_FAILED) {
1052 hdr = (struct anonymous_shared_header *)buf;
1053 hdr->u.length = bufsz;
1055 ptr = (void *)(&hdr[1]);
1060 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove)
1064 size_t pagesz = getpagesize();
1067 struct anonymous_shared_header *hdr;
1075 hdr = (struct anonymous_shared_header *)ptr;
1077 if (hdr->u.length > (new_size + sizeof(*hdr))) {
1082 bufsz = new_size + sizeof(*hdr);
1084 /* round up to full pages */
1085 pagecnt = bufsz / pagesz;
1086 if (bufsz % pagesz) {
1089 bufsz = pagesz * pagecnt;
1091 if (new_size >= bufsz) {
1097 if (bufsz <= hdr->u.length) {
1102 flags = MREMAP_MAYMOVE;
1105 buf = mremap(hdr, hdr->u.length, bufsz, flags);
1107 if (buf == MAP_FAILED) {
1112 hdr = (struct anonymous_shared_header *)buf;
1113 hdr->u.length = bufsz;
1115 ptr = (void *)(&hdr[1]);
1124 void anonymous_shared_free(void *ptr)
1126 struct anonymous_shared_header *hdr;
1132 hdr = (struct anonymous_shared_header *)ptr;
1136 munmap(hdr, hdr->u.length);
1140 /* used when you want a debugger started at a particular point in the
1141 code. Mostly useful in code that runs as a child process, where
1142 normal gdb attach is harder to organise.
1144 void samba_start_debugger(void)
1147 if (asprintf(&cmd, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
1150 if (system(cmd) == -1) {