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"
30 #include "system/passwd.h"
41 * @brief Misc utility functions
45 Find a suitable temporary directory. The result should be copied immediately
46 as it may be overwritten by a subsequent call.
48 _PUBLIC_
const char *tmpdir(void)
51 if ((p
= getenv("TMPDIR")))
58 Create a tmp file, open it and immediately unlink it.
59 If dir is NULL uses tmpdir()
60 Returns the file descriptor or -1 on error.
62 int create_unlink_tmp(const char *dir
)
71 fname
= talloc_asprintf(talloc_tos(), "%s/listenerlock_XXXXXX", dir
);
81 if (unlink(fname
) == -1) {
82 int sys_errno
= errno
;
94 Check if a file exists - call vfs_file_exist for samba files.
96 _PUBLIC_
bool file_exist(const char *fname
)
100 if (stat(fname
, &st
) != 0) {
104 return ((S_ISREG(st
.st_mode
)) || (S_ISFIFO(st
.st_mode
)));
108 Check a files mod time.
111 _PUBLIC_
time_t file_modtime(const char *fname
)
115 if (stat(fname
,&st
) != 0)
122 Check if a directory exists.
125 _PUBLIC_
bool directory_exist(const char *dname
)
130 if (stat(dname
,&st
) != 0) {
134 ret
= S_ISDIR(st
.st_mode
);
141 * Try to create the specified directory if it didn't exist.
143 * @retval true if the directory already existed and has the right permissions
144 * or was successfully created.
146 _PUBLIC_
bool directory_create_or_exist(const char *dname
, uid_t uid
,
152 ret
= lstat(dname
, &st
);
156 if (errno
!= ENOENT
) {
157 DEBUG(0, ("lstat failed on directory %s: %s\n",
158 dname
, strerror(errno
)));
162 /* Create directory */
163 old_umask
= umask(0);
164 ret
= mkdir(dname
, dir_perms
);
165 if (ret
== -1 && errno
!= EEXIST
) {
166 DEBUG(0, ("mkdir failed on directory "
174 ret
= lstat(dname
, &st
);
176 DEBUG(0, ("lstat failed on created directory %s: %s\n",
177 dname
, strerror(errno
)));
182 /* Check ownership and permission on existing directory */
183 if (!S_ISDIR(st
.st_mode
)) {
184 DEBUG(0, ("directory %s isn't a directory\n",
188 if (st
.st_uid
!= uid
&& !uwrap_enabled()) {
189 DEBUG(0, ("invalid ownership on directory "
193 if ((st
.st_mode
& 0777) != dir_perms
) {
194 DEBUG(0, ("invalid permissions on directory "
195 "'%s': has 0%o should be 0%o\n", dname
,
196 (st
.st_mode
& 0777), dir_perms
));
205 Sleep for a specified number of milliseconds.
208 _PUBLIC_
void smb_msleep(unsigned int t
)
210 #if defined(HAVE_NANOSLEEP)
215 ts
.tv_nsec
= 1000000*(t
%1000);
219 ret
= nanosleep(&ts
, &ts
);
220 } while (ret
< 0 && errno
== EINTR
&& (ts
.tv_sec
> 0 || ts
.tv_nsec
> 0));
222 unsigned int tdiff
=0;
223 struct timeval tval
,t1
,t2
;
230 tval
.tv_sec
= (t
-tdiff
)/1000;
231 tval
.tv_usec
= 1000*((t
-tdiff
)%1000);
233 /* Never wait for more than 1 sec. */
234 if (tval
.tv_sec
> 1) {
241 select(0,&fds
,NULL
,NULL
,&tval
);
244 if (t2
.tv_sec
< t1
.tv_sec
) {
245 /* Someone adjusted time... */
249 tdiff
= usec_time_diff(&t2
,&t1
)/1000;
255 Get my own name, return in talloc'ed storage.
258 _PUBLIC_
char *get_myname(TALLOC_CTX
*ctx
)
261 char hostname
[HOST_NAME_MAX
];
263 /* get my host name */
264 if (gethostname(hostname
, sizeof(hostname
)) == -1) {
265 DEBUG(0,("gethostname failed\n"));
269 /* Ensure null termination. */
270 hostname
[sizeof(hostname
)-1] = '\0';
272 /* split off any parts after an initial . */
273 p
= strchr_m(hostname
, '.');
278 return talloc_strdup(ctx
, hostname
);
282 Check if a process exists. Does this work on all unixes?
285 _PUBLIC_
bool process_exists_by_pid(pid_t pid
)
287 /* Doing kill with a non-positive pid causes messages to be
288 * sent to places we don't want. */
290 return(kill(pid
,0) == 0 || errno
!= ESRCH
);
294 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
295 is dealt with in posix.c
298 _PUBLIC_
bool fcntl_lock(int fd
, int op
, off_t offset
, off_t count
, int type
)
303 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd
,op
,(double)offset
,(double)count
,type
));
306 lock
.l_whence
= SEEK_SET
;
307 lock
.l_start
= offset
;
311 ret
= fcntl(fd
,op
,&lock
);
313 if (ret
== -1 && errno
!= 0)
314 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno
,strerror(errno
)));
319 (lock
.l_type
!= F_UNLCK
) &&
321 (lock
.l_pid
!= getpid())) {
322 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd
,(int)lock
.l_pid
));
326 /* it must be not locked or locked by me */
330 /* a lock set or unset */
332 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
333 (double)offset
,(double)count
,op
,type
,strerror(errno
)));
337 /* everything went OK */
338 DEBUG(8,("fcntl_lock: Lock call successful\n"));
343 static void debugadd_cb(const char *buf
, void *private_data
)
345 int *plevel
= (int *)private_data
;
346 DEBUGADD(*plevel
, ("%s", buf
));
349 void print_asc_cb(const uint8_t *buf
, int len
,
350 void (*cb
)(const char *buf
, void *private_data
),
357 for (i
=0; i
<len
; i
++) {
358 s
[0] = isprint(buf
[i
]) ? buf
[i
] : '.';
363 void print_asc(int level
, const uint8_t *buf
,int len
)
365 print_asc_cb(buf
, len
, debugadd_cb
, &level
);
369 * Write dump of binary data to a callback
371 void dump_data_cb(const uint8_t *buf
, int len
,
372 bool omit_zero_bytes
,
373 void (*cb
)(const char *buf
, void *private_data
),
377 static const uint8_t empty
[16] = { 0, };
378 bool skipped
= false;
386 if ((omit_zero_bytes
== true) &&
389 (memcmp(&buf
[i
], &empty
, 16) == 0))
396 snprintf(tmp
, sizeof(tmp
), "[%04X] ", i
);
397 cb(tmp
, private_data
);
401 snprintf(tmp
, sizeof(tmp
), "%02X ", (int)buf
[i
]);
402 cb(tmp
, private_data
);
405 cb(" ", private_data
);
409 print_asc_cb(&buf
[i
-16], 8, cb
, private_data
);
410 cb(" ", private_data
);
411 print_asc_cb(&buf
[i
-8], 8, cb
, private_data
);
412 cb("\n", private_data
);
414 if ((omit_zero_bytes
== true) &&
416 (memcmp(&buf
[i
], &empty
, 16) == 0)) {
418 cb("skipping zero buffer bytes\n",
429 cb(" ", private_data
);
431 cb(" ", private_data
);
434 cb(" ", private_data
);
437 print_asc_cb(&buf
[i
-(i
%16)], n
, cb
, private_data
);
438 cb(" ", private_data
);
441 print_asc_cb(&buf
[i
-n
], n
, cb
, private_data
);
443 cb("\n", private_data
);
449 * Write dump of binary data to the log file.
451 * The data is only written if the log level is at least level.
453 _PUBLIC_
void dump_data(int level
, const uint8_t *buf
, int len
)
455 if (!DEBUGLVL(level
)) {
458 dump_data_cb(buf
, len
, false, debugadd_cb
, &level
);
462 * Write dump of binary data to the log file.
464 * The data is only written if the log level is at least level.
465 * 16 zero bytes in a row are omitted
467 _PUBLIC_
void dump_data_skip_zeros(int level
, const uint8_t *buf
, int len
)
469 if (!DEBUGLVL(level
)) {
472 dump_data_cb(buf
, len
, true, debugadd_cb
, &level
);
475 static void fprintf_cb(const char *buf
, void *private_data
)
477 FILE *f
= (FILE *)private_data
;
478 fprintf(f
, "%s", buf
);
481 void dump_data_file(const uint8_t *buf
, int len
, bool omit_zero_bytes
,
484 dump_data_cb(buf
, len
, omit_zero_bytes
, fprintf_cb
, f
);
488 malloc that aborts with smb_panic on fail or zero size.
491 _PUBLIC_
void *smb_xmalloc(size_t size
)
495 smb_panic("smb_xmalloc: called with zero size.\n");
496 if ((p
= malloc(size
)) == NULL
)
497 smb_panic("smb_xmalloc: malloc fail.\n");
502 Memdup with smb_panic on fail.
505 _PUBLIC_
void *smb_xmemdup(const void *p
, size_t size
)
508 p2
= smb_xmalloc(size
);
514 strdup that aborts on malloc fail.
517 char *smb_xstrdup(const char *s
)
519 #if defined(PARANOID_MALLOC_CHECKER)
526 #define strdup rep_strdup
529 char *s1
= strdup(s
);
530 #if defined(PARANOID_MALLOC_CHECKER)
534 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
537 smb_panic("smb_xstrdup: malloc failed");
544 strndup that aborts on malloc fail.
547 char *smb_xstrndup(const char *s
, size_t n
)
549 #if defined(PARANOID_MALLOC_CHECKER)
555 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
557 #define strndup rep_strndup
560 char *s1
= strndup(s
, n
);
561 #if defined(PARANOID_MALLOC_CHECKER)
565 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
568 smb_panic("smb_xstrndup: malloc failed");
576 Like strdup but for memory.
579 _PUBLIC_
void *memdup(const void *p
, size_t size
)
592 * Write a password to the log file.
594 * @note Only actually does something if DEBUG_PASSWORD was defined during
597 _PUBLIC_
void dump_data_pw(const char *msg
, const uint8_t * data
, size_t len
)
599 #ifdef DEBUG_PASSWORD
600 DEBUG(11, ("%s", msg
));
601 if (data
!= NULL
&& len
> 0)
603 dump_data(11, data
, len
);
610 * see if a range of memory is all zero. A NULL pointer is considered
613 _PUBLIC_
bool all_zero(const uint8_t *ptr
, size_t size
)
616 if (!ptr
) return true;
617 for (i
=0;i
<size
;i
++) {
618 if (ptr
[i
]) return false;
624 realloc an array, checking for integer overflow in the array size
626 _PUBLIC_
void *realloc_array(void *ptr
, size_t el_size
, unsigned count
, bool free_on_fail
)
628 #define MAX_MALLOC_SIZE 0x7fffffff
630 count
>= MAX_MALLOC_SIZE
/el_size
) {
636 return malloc(el_size
* count
);
638 return realloc(ptr
, el_size
* count
);
641 /****************************************************************************
643 ****************************************************************************/
645 void *malloc_array(size_t el_size
, unsigned int count
)
647 return realloc_array(NULL
, el_size
, count
, false);
650 /****************************************************************************
652 ****************************************************************************/
654 void *memalign_array(size_t el_size
, size_t align
, unsigned int count
)
656 if (count
*el_size
>= MAX_MALLOC_SIZE
) {
660 return memalign(align
, el_size
*count
);
663 /****************************************************************************
665 ****************************************************************************/
667 void *calloc_array(size_t size
, size_t nmemb
)
669 if (nmemb
>= MAX_MALLOC_SIZE
/size
) {
672 if (size
== 0 || nmemb
== 0) {
675 return calloc(nmemb
, size
);
679 Trim the specified elements off the front and back of a string.
681 _PUBLIC_
bool trim_string(char *s
, const char *front
, const char *back
)
688 /* Ignore null or empty strings. */
689 if (!s
|| (s
[0] == '\0'))
692 front_len
= front
? strlen(front
) : 0;
693 back_len
= back
? strlen(back
) : 0;
698 while (len
&& strncmp(s
, front
, front_len
)==0) {
699 /* Must use memmove here as src & dest can
700 * easily overlap. Found by valgrind. JRA. */
701 memmove(s
, s
+front_len
, (len
-front_len
)+1);
708 while ((len
>= back_len
) && strncmp(s
+len
-back_len
,back
,back_len
)==0) {
709 s
[len
-back_len
]='\0';
718 Find the number of 'c' chars in a string
720 _PUBLIC_ _PURE_
size_t count_chars(const char *s
, char c
)
725 if (*s
== c
) count
++;
733 * Routine to get hex characters and turn them into a byte array.
734 * the array can be variable length.
735 * - "0xnn" or "0Xnn" is specially catered for.
736 * - The first non-hex-digit character (apart from possibly leading "0x"
737 * finishes the conversion and skips the rest of the input.
738 * - A single hex-digit character at the end of the string is skipped.
740 * valid examples: "0A5D15"; "0x123456"
742 _PUBLIC_
size_t strhex_to_str(char *p
, size_t p_len
, const char *strhex
, size_t strhex_len
)
745 size_t num_chars
= 0;
746 uint8_t lonybble
, hinybble
;
747 const char *hexchars
= "0123456789ABCDEF";
748 char *p1
= NULL
, *p2
= NULL
;
750 /* skip leading 0x prefix */
751 if (strncasecmp(strhex
, "0x", 2) == 0) {
752 i
+= 2; /* skip two chars */
755 for (; i
+1 < strhex_len
&& strhex
[i
] != 0 && strhex
[i
+1] != 0; i
++) {
756 p1
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]));
761 i
++; /* next hex digit */
763 p2
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]));
768 /* get the two nybbles */
769 hinybble
= PTR_DIFF(p1
, hexchars
);
770 lonybble
= PTR_DIFF(p2
, hexchars
);
772 if (num_chars
>= p_len
) {
776 p
[num_chars
] = (hinybble
<< 4) | lonybble
;
786 * Parse a hex string and return a data blob.
788 _PUBLIC_ _PURE_ DATA_BLOB
strhex_to_data_blob(TALLOC_CTX
*mem_ctx
, const char *strhex
)
790 DATA_BLOB ret_blob
= data_blob_talloc(mem_ctx
, NULL
, strlen(strhex
)/2+1);
792 ret_blob
.length
= strhex_to_str((char *)ret_blob
.data
, ret_blob
.length
,
800 * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
802 _PUBLIC_
void hex_encode_buf(char *dst
, const uint8_t *src
, size_t srclen
)
805 for (i
=0; i
<srclen
; i
++) {
806 snprintf(dst
+ i
*2, 3, "%02X", src
[i
]);
809 * Ensure 0-termination for 0-length buffers
811 dst
[srclen
*2] = '\0';
815 * Routine to print a buffer as HEX digits, into an allocated string.
817 _PUBLIC_
void hex_encode(const unsigned char *buff_in
, size_t len
, char **out_hex_buffer
)
821 *out_hex_buffer
= malloc_array_p(char, (len
*2)+1);
822 hex_buffer
= *out_hex_buffer
;
823 hex_encode_buf(hex_buffer
, buff_in
, len
);
827 * talloc version of hex_encode()
829 _PUBLIC_
char *hex_encode_talloc(TALLOC_CTX
*mem_ctx
, const unsigned char *buff_in
, size_t len
)
833 hex_buffer
= talloc_array(mem_ctx
, char, (len
*2)+1);
837 hex_encode_buf(hex_buffer
, buff_in
, len
);
838 talloc_set_name_const(hex_buffer
, hex_buffer
);
843 varient of strcmp() that handles NULL ptrs
845 _PUBLIC_
int strcmp_safe(const char *s1
, const char *s2
)
850 if (s1
== NULL
|| s2
== NULL
) {
853 return strcmp(s1
, s2
);
858 return the number of bytes occupied by a buffer in ASCII format
859 the result includes the null termination
862 _PUBLIC_
size_t ascii_len_n(const char *src
, size_t n
)
866 len
= strnlen(src
, n
);
875 Set a boolean variable from the text value stored in the passed string.
876 Returns true in success, false if the passed string does not correctly
880 _PUBLIC_
bool set_boolean(const char *boolean_string
, bool *boolean
)
882 if (strwicmp(boolean_string
, "yes") == 0 ||
883 strwicmp(boolean_string
, "true") == 0 ||
884 strwicmp(boolean_string
, "on") == 0 ||
885 strwicmp(boolean_string
, "1") == 0) {
888 } else if (strwicmp(boolean_string
, "no") == 0 ||
889 strwicmp(boolean_string
, "false") == 0 ||
890 strwicmp(boolean_string
, "off") == 0 ||
891 strwicmp(boolean_string
, "0") == 0) {
899 return the number of bytes occupied by a buffer in CH_UTF16 format
900 the result includes the null termination
902 _PUBLIC_
size_t utf16_len(const void *buf
)
906 for (len
= 0; SVAL(buf
,len
); len
+= 2) ;
912 return the number of bytes occupied by a buffer in CH_UTF16 format
913 the result includes the null termination
916 _PUBLIC_
size_t utf16_len_n(const void *src
, size_t n
)
920 for (len
= 0; (len
+2 < n
) && SVAL(src
, len
); len
+= 2) ;
931 * @brief String utilities.
934 static bool next_token_internal_talloc(TALLOC_CTX
*ctx
,
953 /* default to simple separators */
958 /* find the first non sep char, if left-trimming is requested */
960 while (*s
&& strchr_m(sep
,*s
)) {
970 /* When restarting we need to go from here. */
973 /* Work out the length needed. */
974 for (quoted
= false; *s
&&
975 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
983 /* We started with len = 1 so we have space for the nul. */
984 *pp_buff
= talloc_array(ctx
, char, len
);
989 /* copy over the token */
992 for (quoted
= false; *s
&&
993 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
1001 *ptr
= (*s
) ? s
+1 : s
;
1007 bool next_token_talloc(TALLOC_CTX
*ctx
,
1012 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, true);
1016 * Get the next token from a string, return false if none found. Handles
1017 * double-quotes. This version does not trim leading separator characters
1018 * before looking for a token.
1021 bool next_token_no_ltrim_talloc(TALLOC_CTX
*ctx
,
1026 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, false);
1030 * Get the next token from a string, return False if none found.
1031 * Handles double-quotes.
1033 * Based on a routine by GJC@VILLAGE.COM.
1034 * Extensively modified by Andrew.Tridgell@anu.edu.au
1036 _PUBLIC_
bool next_token(const char **ptr
,char *buff
, const char *sep
, size_t bufsize
)
1047 /* default to simple separators */
1051 /* find the first non sep char */
1052 while (*s
&& strchr_m(sep
,*s
))
1059 /* copy over the token */
1060 for (quoted
= false; len
< bufsize
&& *s
&& (quoted
|| !strchr_m(sep
,*s
)); s
++) {
1069 *ptr
= (*s
) ? s
+1 : s
;
1075 struct anonymous_shared_header
{
1082 /* Map a shared memory buffer of at least nelem counters. */
1083 void *anonymous_shared_allocate(size_t orig_bufsz
)
1087 size_t pagesz
= getpagesize();
1089 size_t bufsz
= orig_bufsz
;
1090 struct anonymous_shared_header
*hdr
;
1092 bufsz
+= sizeof(*hdr
);
1094 /* round up to full pages */
1095 pagecnt
= bufsz
/ pagesz
;
1096 if (bufsz
% pagesz
) {
1099 bufsz
= pagesz
* pagecnt
;
1101 if (orig_bufsz
>= bufsz
) {
1109 buf
= mmap(NULL
, bufsz
, PROT_READ
|PROT_WRITE
, MAP_ANON
|MAP_SHARED
,
1110 -1 /* fd */, 0 /* offset */);
1112 buf
= mmap(NULL
, bufsz
, PROT_READ
|PROT_WRITE
, MAP_FILE
|MAP_SHARED
,
1113 open("/dev/zero", O_RDWR
), 0 /* offset */);
1116 if (buf
== MAP_FAILED
) {
1120 hdr
= (struct anonymous_shared_header
*)buf
;
1121 hdr
->u
.length
= bufsz
;
1123 ptr
= (void *)(&hdr
[1]);
1128 void *anonymous_shared_resize(void *ptr
, size_t new_size
, bool maymove
)
1132 size_t pagesz
= getpagesize();
1135 struct anonymous_shared_header
*hdr
;
1143 hdr
= (struct anonymous_shared_header
*)ptr
;
1145 if (hdr
->u
.length
> (new_size
+ sizeof(*hdr
))) {
1150 bufsz
= new_size
+ sizeof(*hdr
);
1152 /* round up to full pages */
1153 pagecnt
= bufsz
/ pagesz
;
1154 if (bufsz
% pagesz
) {
1157 bufsz
= pagesz
* pagecnt
;
1159 if (new_size
>= bufsz
) {
1165 if (bufsz
<= hdr
->u
.length
) {
1170 flags
= MREMAP_MAYMOVE
;
1173 buf
= mremap(hdr
, hdr
->u
.length
, bufsz
, flags
);
1175 if (buf
== MAP_FAILED
) {
1180 hdr
= (struct anonymous_shared_header
*)buf
;
1181 hdr
->u
.length
= bufsz
;
1183 ptr
= (void *)(&hdr
[1]);
1192 void anonymous_shared_free(void *ptr
)
1194 struct anonymous_shared_header
*hdr
;
1200 hdr
= (struct anonymous_shared_header
*)ptr
;
1204 munmap(hdr
, hdr
->u
.length
);
1208 /* used when you want a debugger started at a particular point in the
1209 code. Mostly useful in code that runs as a child process, where
1210 normal gdb attach is harder to organise.
1212 void samba_start_debugger(void)
1215 if (asprintf(&cmd
, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
1218 if (system(cmd
) == -1) {