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 "
165 Sleep for a specified number of milliseconds.
168 _PUBLIC_
void smb_msleep(unsigned int t
)
170 #if defined(HAVE_NANOSLEEP)
175 ts
.tv_nsec
= 1000000*(t
%1000);
179 ret
= nanosleep(&ts
, &ts
);
180 } while (ret
< 0 && errno
== EINTR
&& (ts
.tv_sec
> 0 || ts
.tv_nsec
> 0));
182 unsigned int tdiff
=0;
183 struct timeval tval
,t1
,t2
;
190 tval
.tv_sec
= (t
-tdiff
)/1000;
191 tval
.tv_usec
= 1000*((t
-tdiff
)%1000);
193 /* Never wait for more than 1 sec. */
194 if (tval
.tv_sec
> 1) {
201 select(0,&fds
,NULL
,NULL
,&tval
);
204 if (t2
.tv_sec
< t1
.tv_sec
) {
205 /* Someone adjusted time... */
209 tdiff
= usec_time_diff(&t2
,&t1
)/1000;
215 Get my own name, return in talloc'ed storage.
218 _PUBLIC_
char *get_myname(TALLOC_CTX
*ctx
)
221 char hostname
[HOST_NAME_MAX
];
223 /* get my host name */
224 if (gethostname(hostname
, sizeof(hostname
)) == -1) {
225 DEBUG(0,("gethostname failed\n"));
229 /* Ensure null termination. */
230 hostname
[sizeof(hostname
)-1] = '\0';
232 /* split off any parts after an initial . */
233 p
= strchr_m(hostname
, '.');
238 return talloc_strdup(ctx
, hostname
);
242 Check if a process exists. Does this work on all unixes?
245 _PUBLIC_
bool process_exists_by_pid(pid_t pid
)
247 /* Doing kill with a non-positive pid causes messages to be
248 * sent to places we don't want. */
250 return(kill(pid
,0) == 0 || errno
!= ESRCH
);
254 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
255 is dealt with in posix.c
258 _PUBLIC_
bool fcntl_lock(int fd
, int op
, off_t offset
, off_t count
, int type
)
263 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd
,op
,(double)offset
,(double)count
,type
));
266 lock
.l_whence
= SEEK_SET
;
267 lock
.l_start
= offset
;
271 ret
= fcntl(fd
,op
,&lock
);
273 if (ret
== -1 && errno
!= 0)
274 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno
,strerror(errno
)));
279 (lock
.l_type
!= F_UNLCK
) &&
281 (lock
.l_pid
!= getpid())) {
282 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd
,(int)lock
.l_pid
));
286 /* it must be not locked or locked by me */
290 /* a lock set or unset */
292 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
293 (double)offset
,(double)count
,op
,type
,strerror(errno
)));
297 /* everything went OK */
298 DEBUG(8,("fcntl_lock: Lock call successful\n"));
303 void print_asc(int level
, const uint8_t *buf
,int len
)
307 DEBUGADD(level
,("%c", isprint(buf
[i
])?buf
[i
]:'.'));
311 * Write dump of binary data to the log file.
313 * The data is only written if the log level is at least level.
315 static void _dump_data(int level
, const uint8_t *buf
, int len
,
316 bool omit_zero_bytes
)
319 static const uint8_t empty
[16] = { 0, };
320 bool skipped
= false;
324 if (!DEBUGLVL(level
)) return;
329 if ((omit_zero_bytes
== true) &&
332 (memcmp(&buf
[i
], &empty
, 16) == 0))
339 DEBUGADD(level
,("[%04X] ",i
));
343 DEBUGADD(level
,("%02X ",(int)buf
[i
]));
345 if (i
%8 == 0) DEBUGADD(level
,(" "));
348 print_asc(level
,&buf
[i
-16],8); DEBUGADD(level
,(" "));
349 print_asc(level
,&buf
[i
-8],8); DEBUGADD(level
,("\n"));
351 if ((omit_zero_bytes
== true) &&
353 (memcmp(&buf
[i
], &empty
, 16) == 0)) {
355 DEBUGADD(level
,("skipping zero buffer bytes\n"));
365 DEBUGADD(level
,(" "));
366 if (n
>8) DEBUGADD(level
,(" "));
367 while (n
--) DEBUGADD(level
,(" "));
369 print_asc(level
,&buf
[i
-(i
%16)],n
); DEBUGADD(level
,( " " ));
371 if (n
>0) print_asc(level
,&buf
[i
-n
],n
);
372 DEBUGADD(level
,("\n"));
378 * Write dump of binary data to the log file.
380 * The data is only written if the log level is at least level.
382 _PUBLIC_
void dump_data(int level
, const uint8_t *buf
, int len
)
384 _dump_data(level
, buf
, len
, false);
388 * Write dump of binary data to the log file.
390 * The data is only written if the log level is at least level.
391 * 16 zero bytes in a row are omitted
393 _PUBLIC_
void dump_data_skip_zeros(int level
, const uint8_t *buf
, int len
)
395 _dump_data(level
, buf
, len
, true);
400 malloc that aborts with smb_panic on fail or zero size.
403 _PUBLIC_
void *smb_xmalloc(size_t size
)
407 smb_panic("smb_xmalloc: called with zero size.\n");
408 if ((p
= malloc(size
)) == NULL
)
409 smb_panic("smb_xmalloc: malloc fail.\n");
414 Memdup with smb_panic on fail.
417 _PUBLIC_
void *smb_xmemdup(const void *p
, size_t size
)
420 p2
= smb_xmalloc(size
);
426 strdup that aborts on malloc fail.
429 char *smb_xstrdup(const char *s
)
431 #if defined(PARANOID_MALLOC_CHECKER)
438 #define strdup rep_strdup
441 char *s1
= strdup(s
);
442 #if defined(PARANOID_MALLOC_CHECKER)
446 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
449 smb_panic("smb_xstrdup: malloc failed");
456 strndup that aborts on malloc fail.
459 char *smb_xstrndup(const char *s
, size_t n
)
461 #if defined(PARANOID_MALLOC_CHECKER)
467 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
469 #define strndup rep_strndup
472 char *s1
= strndup(s
, n
);
473 #if defined(PARANOID_MALLOC_CHECKER)
477 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
480 smb_panic("smb_xstrndup: malloc failed");
488 Like strdup but for memory.
491 _PUBLIC_
void *memdup(const void *p
, size_t size
)
504 * Write a password to the log file.
506 * @note Only actually does something if DEBUG_PASSWORD was defined during
509 _PUBLIC_
void dump_data_pw(const char *msg
, const uint8_t * data
, size_t len
)
511 #ifdef DEBUG_PASSWORD
512 DEBUG(11, ("%s", msg
));
513 if (data
!= NULL
&& len
> 0)
515 dump_data(11, data
, len
);
522 * see if a range of memory is all zero. A NULL pointer is considered
525 _PUBLIC_
bool all_zero(const uint8_t *ptr
, size_t size
)
528 if (!ptr
) return true;
529 for (i
=0;i
<size
;i
++) {
530 if (ptr
[i
]) return false;
536 realloc an array, checking for integer overflow in the array size
538 _PUBLIC_
void *realloc_array(void *ptr
, size_t el_size
, unsigned count
, bool free_on_fail
)
540 #define MAX_MALLOC_SIZE 0x7fffffff
542 count
>= MAX_MALLOC_SIZE
/el_size
) {
548 return malloc(el_size
* count
);
550 return realloc(ptr
, el_size
* count
);
553 /****************************************************************************
555 ****************************************************************************/
557 void *malloc_array(size_t el_size
, unsigned int count
)
559 return realloc_array(NULL
, el_size
, count
, false);
563 Trim the specified elements off the front and back of a string.
565 _PUBLIC_
bool trim_string(char *s
, const char *front
, const char *back
)
572 /* Ignore null or empty strings. */
573 if (!s
|| (s
[0] == '\0'))
576 front_len
= front
? strlen(front
) : 0;
577 back_len
= back
? strlen(back
) : 0;
582 while (len
&& strncmp(s
, front
, front_len
)==0) {
583 /* Must use memmove here as src & dest can
584 * easily overlap. Found by valgrind. JRA. */
585 memmove(s
, s
+front_len
, (len
-front_len
)+1);
592 while ((len
>= back_len
) && strncmp(s
+len
-back_len
,back
,back_len
)==0) {
593 s
[len
-back_len
]='\0';
602 Find the number of 'c' chars in a string
604 _PUBLIC_ _PURE_
size_t count_chars(const char *s
, char c
)
609 if (*s
== c
) count
++;
617 Routine to get hex characters and turn them into a 16 byte array.
618 the array can be variable length, and any non-hex-numeric
619 characters are skipped. "0xnn" or "0Xnn" is specially catered
622 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
626 _PUBLIC_
size_t strhex_to_str(char *p
, size_t p_len
, const char *strhex
, size_t strhex_len
)
629 size_t num_chars
= 0;
630 uint8_t lonybble
, hinybble
;
631 const char *hexchars
= "0123456789ABCDEF";
632 char *p1
= NULL
, *p2
= NULL
;
634 /* skip leading 0x prefix */
635 if (strncasecmp(strhex
, "0x", 2) == 0) {
636 i
+= 2; /* skip two chars */
639 for (; i
< strhex_len
&& strhex
[i
] != 0; i
++) {
640 if (!(p1
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]))))
643 i
++; /* next hex digit */
645 if (!(p2
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]))))
648 /* get the two nybbles */
649 hinybble
= PTR_DIFF(p1
, hexchars
);
650 lonybble
= PTR_DIFF(p2
, hexchars
);
652 if (num_chars
>= p_len
) {
656 p
[num_chars
] = (hinybble
<< 4) | lonybble
;
666 * Parse a hex string and return a data blob.
668 _PUBLIC_ _PURE_ DATA_BLOB
strhex_to_data_blob(TALLOC_CTX
*mem_ctx
, const char *strhex
)
670 DATA_BLOB ret_blob
= data_blob_talloc(mem_ctx
, NULL
, strlen(strhex
)/2+1);
672 ret_blob
.length
= strhex_to_str((char *)ret_blob
.data
, ret_blob
.length
,
681 * Routine to print a buffer as HEX digits, into an allocated string.
683 _PUBLIC_
void hex_encode(const unsigned char *buff_in
, size_t len
, char **out_hex_buffer
)
688 *out_hex_buffer
= malloc_array_p(char, (len
*2)+1);
689 hex_buffer
= *out_hex_buffer
;
691 for (i
= 0; i
< len
; i
++)
692 slprintf(&hex_buffer
[i
*2], 3, "%02X", buff_in
[i
]);
696 * talloc version of hex_encode()
698 _PUBLIC_
char *hex_encode_talloc(TALLOC_CTX
*mem_ctx
, const unsigned char *buff_in
, size_t len
)
703 hex_buffer
= talloc_array(mem_ctx
, char, (len
*2)+1);
708 for (i
= 0; i
< len
; i
++)
709 slprintf(&hex_buffer
[i
*2], 3, "%02X", buff_in
[i
]);
711 talloc_set_name_const(hex_buffer
, hex_buffer
);
716 varient of strcmp() that handles NULL ptrs
718 _PUBLIC_
int strcmp_safe(const char *s1
, const char *s2
)
723 if (s1
== NULL
|| s2
== NULL
) {
726 return strcmp(s1
, s2
);
731 return the number of bytes occupied by a buffer in ASCII format
732 the result includes the null termination
735 _PUBLIC_
size_t ascii_len_n(const char *src
, size_t n
)
739 len
= strnlen(src
, n
);
748 Set a boolean variable from the text value stored in the passed string.
749 Returns true in success, false if the passed string does not correctly
753 _PUBLIC_
bool set_boolean(const char *boolean_string
, bool *boolean
)
755 if (strwicmp(boolean_string
, "yes") == 0 ||
756 strwicmp(boolean_string
, "true") == 0 ||
757 strwicmp(boolean_string
, "on") == 0 ||
758 strwicmp(boolean_string
, "1") == 0) {
761 } else if (strwicmp(boolean_string
, "no") == 0 ||
762 strwicmp(boolean_string
, "false") == 0 ||
763 strwicmp(boolean_string
, "off") == 0 ||
764 strwicmp(boolean_string
, "0") == 0) {
772 return the number of bytes occupied by a buffer in CH_UTF16 format
773 the result includes the null termination
775 _PUBLIC_
size_t utf16_len(const void *buf
)
779 for (len
= 0; SVAL(buf
,len
); len
+= 2) ;
785 return the number of bytes occupied by a buffer in CH_UTF16 format
786 the result includes the null termination
789 _PUBLIC_
size_t utf16_len_n(const void *src
, size_t n
)
793 for (len
= 0; (len
+2 < n
) && SVAL(src
, len
); len
+= 2) ;
804 * @brief String utilities.
807 static bool next_token_internal_talloc(TALLOC_CTX
*ctx
,
826 /* default to simple separators */
831 /* find the first non sep char, if left-trimming is requested */
833 while (*s
&& strchr_m(sep
,*s
)) {
843 /* When restarting we need to go from here. */
846 /* Work out the length needed. */
847 for (quoted
= false; *s
&&
848 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
856 /* We started with len = 1 so we have space for the nul. */
857 *pp_buff
= talloc_array(ctx
, char, len
);
862 /* copy over the token */
865 for (quoted
= false; *s
&&
866 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
874 *ptr
= (*s
) ? s
+1 : s
;
880 bool next_token_talloc(TALLOC_CTX
*ctx
,
885 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, true);
889 * Get the next token from a string, return false if none found. Handles
890 * double-quotes. This version does not trim leading separator characters
891 * before looking for a token.
894 bool next_token_no_ltrim_talloc(TALLOC_CTX
*ctx
,
899 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, false);
902 /* Map a shared memory buffer of at least nelem counters. */
903 void *allocate_anonymous_shared(size_t bufsz
)
906 size_t pagesz
= getpagesize();
908 if (bufsz
% pagesz
) {
909 bufsz
= (bufsz
+ pagesz
) % pagesz
; /* round up to pagesz */
914 buf
= mmap(NULL
, bufsz
, PROT_READ
|PROT_WRITE
, MAP_ANON
|MAP_SHARED
,
915 -1 /* fd */, 0 /* offset */);
917 buf
= mmap(NULL
, bufsz
, PROT_READ
|PROT_WRITE
, MAP_FILE
|MAP_SHARED
,
918 open("/dev/zero", O_RDWR
), 0 /* offset */);
921 if (buf
== MAP_FAILED
) {
930 /* used when you want a debugger started at a particular point in the
931 code. Mostly useful in code that runs as a child process, where
932 normal gdb attach is harder to organise.
934 void samba_start_debugger(void)
937 if (asprintf(&cmd
, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
940 if (system(cmd
) == -1) {