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"
36 * @brief Misc utility functions
40 Find a suitable temporary directory. The result should be copied immediately
41 as it may be overwritten by a subsequent call.
43 _PUBLIC_
const char *tmpdir(void)
46 if ((p
= getenv("TMPDIR")))
53 Check if a file exists - call vfs_file_exist for samba files.
55 _PUBLIC_
bool file_exist(const char *fname
)
59 if (stat(fname
, &st
) != 0) {
63 return ((S_ISREG(st
.st_mode
)) || (S_ISFIFO(st
.st_mode
)));
67 Check a files mod time.
70 _PUBLIC_
time_t file_modtime(const char *fname
)
74 if (stat(fname
,&st
) != 0)
81 Check if a directory exists.
84 _PUBLIC_
bool directory_exist(const char *dname
)
89 if (stat(dname
,&st
) != 0) {
93 ret
= S_ISDIR(st
.st_mode
);
100 * Try to create the specified directory if it didn't exist.
102 * @retval true if the directory already existed and has the right permissions
103 * or was successfully created.
105 _PUBLIC_
bool directory_create_or_exist(const char *dname
, uid_t uid
,
111 old_umask
= umask(0);
112 if (lstat(dname
, &st
) == -1) {
113 if (errno
== ENOENT
) {
114 /* Create directory */
115 if (mkdir(dname
, dir_perms
) == -1) {
116 DEBUG(0, ("error creating directory "
123 DEBUG(0, ("lstat failed on directory %s: %s\n",
124 dname
, strerror(errno
)));
129 /* Check ownership and permission on existing directory */
130 if (!S_ISDIR(st
.st_mode
)) {
131 DEBUG(0, ("directory %s isn't a directory\n",
136 if (st
.st_uid
!= uid
&& !uwrap_enabled()) {
137 DEBUG(0, ("invalid ownership on directory "
142 if ((st
.st_mode
& 0777) != dir_perms
) {
143 DEBUG(0, ("invalid permissions on directory "
154 Sleep for a specified number of milliseconds.
157 _PUBLIC_
void msleep(unsigned int t
)
161 tval
.tv_sec
= t
/1000;
162 tval
.tv_usec
= 1000*(t
%1000);
163 /* this should be the real select - do NOT replace
165 select(0,NULL
,NULL
,NULL
,&tval
);
169 Get my own name, return in talloc'ed storage.
172 _PUBLIC_
char *get_myname(TALLOC_CTX
*ctx
)
175 char hostname
[HOST_NAME_MAX
];
177 /* get my host name */
178 if (gethostname(hostname
, sizeof(hostname
)) == -1) {
179 DEBUG(0,("gethostname failed\n"));
183 /* Ensure null termination. */
184 hostname
[sizeof(hostname
)-1] = '\0';
186 /* split off any parts after an initial . */
187 p
= strchr_m(hostname
, '.');
192 return talloc_strdup(ctx
, hostname
);
196 Check if a process exists. Does this work on all unixes?
199 _PUBLIC_
bool process_exists_by_pid(pid_t pid
)
201 /* Doing kill with a non-positive pid causes messages to be
202 * sent to places we don't want. */
204 return(kill(pid
,0) == 0 || errno
!= ESRCH
);
208 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
209 is dealt with in posix.c
212 _PUBLIC_
bool fcntl_lock(int fd
, int op
, off_t offset
, off_t count
, int type
)
217 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd
,op
,(double)offset
,(double)count
,type
));
220 lock
.l_whence
= SEEK_SET
;
221 lock
.l_start
= offset
;
225 ret
= fcntl(fd
,op
,&lock
);
227 if (ret
== -1 && errno
!= 0)
228 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno
,strerror(errno
)));
233 (lock
.l_type
!= F_UNLCK
) &&
235 (lock
.l_pid
!= getpid())) {
236 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd
,(int)lock
.l_pid
));
240 /* it must be not locked or locked by me */
244 /* a lock set or unset */
246 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
247 (double)offset
,(double)count
,op
,type
,strerror(errno
)));
251 /* everything went OK */
252 DEBUG(8,("fcntl_lock: Lock call successful\n"));
257 void print_asc(int level
, const uint8_t *buf
,int len
)
261 DEBUGADD(level
,("%c", isprint(buf
[i
])?buf
[i
]:'.'));
265 * Write dump of binary data to the log file.
267 * The data is only written if the log level is at least level.
269 static void _dump_data(int level
, const uint8_t *buf
, int len
,
270 bool omit_zero_bytes
)
273 static const uint8_t empty
[16] = { 0, };
274 bool skipped
= false;
278 if (!DEBUGLVL(level
)) return;
283 if ((omit_zero_bytes
== true) &&
286 (memcmp(&buf
[i
], &empty
, 16) == 0))
293 DEBUGADD(level
,("[%04X] ",i
));
297 DEBUGADD(level
,("%02X ",(int)buf
[i
]));
299 if (i
%8 == 0) DEBUGADD(level
,(" "));
302 print_asc(level
,&buf
[i
-16],8); DEBUGADD(level
,(" "));
303 print_asc(level
,&buf
[i
-8],8); DEBUGADD(level
,("\n"));
305 if ((omit_zero_bytes
== true) &&
307 (memcmp(&buf
[i
], &empty
, 16) == 0)) {
309 DEBUGADD(level
,("skipping zero buffer bytes\n"));
319 DEBUGADD(level
,(" "));
320 if (n
>8) DEBUGADD(level
,(" "));
321 while (n
--) DEBUGADD(level
,(" "));
323 print_asc(level
,&buf
[i
-(i
%16)],n
); DEBUGADD(level
,( " " ));
325 if (n
>0) print_asc(level
,&buf
[i
-n
],n
);
326 DEBUGADD(level
,("\n"));
332 * Write dump of binary data to the log file.
334 * The data is only written if the log level is at least level.
336 _PUBLIC_
void dump_data(int level
, const uint8_t *buf
, int len
)
338 _dump_data(level
, buf
, len
, false);
342 * Write dump of binary data to the log file.
344 * The data is only written if the log level is at least level.
345 * 16 zero bytes in a row are ommited
347 _PUBLIC_
void dump_data_skip_zeros(int level
, const uint8_t *buf
, int len
)
349 _dump_data(level
, buf
, len
, true);
354 malloc that aborts with smb_panic on fail or zero size.
357 _PUBLIC_
void *smb_xmalloc(size_t size
)
361 smb_panic("smb_xmalloc: called with zero size.\n");
362 if ((p
= malloc(size
)) == NULL
)
363 smb_panic("smb_xmalloc: malloc fail.\n");
368 Memdup with smb_panic on fail.
371 _PUBLIC_
void *smb_xmemdup(const void *p
, size_t size
)
374 p2
= smb_xmalloc(size
);
380 strdup that aborts on malloc fail.
383 char *smb_xstrdup(const char *s
)
385 #if defined(PARANOID_MALLOC_CHECKER)
392 #define strdup rep_strdup
395 char *s1
= strdup(s
);
396 #if defined(PARANOID_MALLOC_CHECKER)
400 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
403 smb_panic("smb_xstrdup: malloc failed");
410 strndup that aborts on malloc fail.
413 char *smb_xstrndup(const char *s
, size_t n
)
415 #if defined(PARANOID_MALLOC_CHECKER)
421 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
423 #define strndup rep_strndup
426 char *s1
= strndup(s
, n
);
427 #if defined(PARANOID_MALLOC_CHECKER)
431 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
434 smb_panic("smb_xstrndup: malloc failed");
442 Like strdup but for memory.
445 _PUBLIC_
void *memdup(const void *p
, size_t size
)
458 * Write a password to the log file.
460 * @note Only actually does something if DEBUG_PASSWORD was defined during
463 _PUBLIC_
void dump_data_pw(const char *msg
, const uint8_t * data
, size_t len
)
465 #ifdef DEBUG_PASSWORD
466 DEBUG(11, ("%s", msg
));
467 if (data
!= NULL
&& len
> 0)
469 dump_data(11, data
, len
);
476 * see if a range of memory is all zero. A NULL pointer is considered
479 _PUBLIC_
bool all_zero(const uint8_t *ptr
, size_t size
)
482 if (!ptr
) return true;
483 for (i
=0;i
<size
;i
++) {
484 if (ptr
[i
]) return false;
490 realloc an array, checking for integer overflow in the array size
492 _PUBLIC_
void *realloc_array(void *ptr
, size_t el_size
, unsigned count
, bool free_on_fail
)
494 #define MAX_MALLOC_SIZE 0x7fffffff
496 count
>= MAX_MALLOC_SIZE
/el_size
) {
502 return malloc(el_size
* count
);
504 return realloc(ptr
, el_size
* count
);
507 /****************************************************************************
509 ****************************************************************************/
511 void *malloc_array(size_t el_size
, unsigned int count
)
513 return realloc_array(NULL
, el_size
, count
, false);
517 Trim the specified elements off the front and back of a string.
519 _PUBLIC_
bool trim_string(char *s
, const char *front
, const char *back
)
526 /* Ignore null or empty strings. */
527 if (!s
|| (s
[0] == '\0'))
530 front_len
= front
? strlen(front
) : 0;
531 back_len
= back
? strlen(back
) : 0;
536 while (len
&& strncmp(s
, front
, front_len
)==0) {
537 /* Must use memmove here as src & dest can
538 * easily overlap. Found by valgrind. JRA. */
539 memmove(s
, s
+front_len
, (len
-front_len
)+1);
546 while ((len
>= back_len
) && strncmp(s
+len
-back_len
,back
,back_len
)==0) {
547 s
[len
-back_len
]='\0';
556 Find the number of 'c' chars in a string
558 _PUBLIC_ _PURE_
size_t count_chars(const char *s
, char c
)
563 if (*s
== c
) count
++;
571 Routine to get hex characters and turn them into a 16 byte array.
572 the array can be variable length, and any non-hex-numeric
573 characters are skipped. "0xnn" or "0Xnn" is specially catered
576 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
580 _PUBLIC_
size_t strhex_to_str(char *p
, size_t p_len
, const char *strhex
, size_t strhex_len
)
583 size_t num_chars
= 0;
584 uint8_t lonybble
, hinybble
;
585 const char *hexchars
= "0123456789ABCDEF";
586 char *p1
= NULL
, *p2
= NULL
;
588 /* skip leading 0x prefix */
589 if (strncasecmp(strhex
, "0x", 2) == 0) {
590 i
+= 2; /* skip two chars */
593 for (; i
< strhex_len
&& strhex
[i
] != 0; i
++) {
594 if (!(p1
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]))))
597 i
++; /* next hex digit */
599 if (!(p2
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]))))
602 /* get the two nybbles */
603 hinybble
= PTR_DIFF(p1
, hexchars
);
604 lonybble
= PTR_DIFF(p2
, hexchars
);
606 if (num_chars
>= p_len
) {
610 p
[num_chars
] = (hinybble
<< 4) | lonybble
;
620 * Parse a hex string and return a data blob.
622 _PUBLIC_ _PURE_ DATA_BLOB
strhex_to_data_blob(TALLOC_CTX
*mem_ctx
, const char *strhex
)
624 DATA_BLOB ret_blob
= data_blob_talloc(mem_ctx
, NULL
, strlen(strhex
)/2+1);
626 ret_blob
.length
= strhex_to_str((char *)ret_blob
.data
, ret_blob
.length
,
635 * Routine to print a buffer as HEX digits, into an allocated string.
637 _PUBLIC_
void hex_encode(const unsigned char *buff_in
, size_t len
, char **out_hex_buffer
)
642 *out_hex_buffer
= malloc_array_p(char, (len
*2)+1);
643 hex_buffer
= *out_hex_buffer
;
645 for (i
= 0; i
< len
; i
++)
646 slprintf(&hex_buffer
[i
*2], 3, "%02X", buff_in
[i
]);
650 * talloc version of hex_encode()
652 _PUBLIC_
char *hex_encode_talloc(TALLOC_CTX
*mem_ctx
, const unsigned char *buff_in
, size_t len
)
657 hex_buffer
= talloc_array(mem_ctx
, char, (len
*2)+1);
662 for (i
= 0; i
< len
; i
++)
663 slprintf(&hex_buffer
[i
*2], 3, "%02X", buff_in
[i
]);
665 talloc_set_name_const(hex_buffer
, hex_buffer
);
670 varient of strcmp() that handles NULL ptrs
672 _PUBLIC_
int strcmp_safe(const char *s1
, const char *s2
)
677 if (s1
== NULL
|| s2
== NULL
) {
680 return strcmp(s1
, s2
);
685 return the number of bytes occupied by a buffer in ASCII format
686 the result includes the null termination
689 _PUBLIC_
size_t ascii_len_n(const char *src
, size_t n
)
693 len
= strnlen(src
, n
);
702 Set a boolean variable from the text value stored in the passed string.
703 Returns true in success, false if the passed string does not correctly
707 _PUBLIC_
bool set_boolean(const char *boolean_string
, bool *boolean
)
709 if (strwicmp(boolean_string
, "yes") == 0 ||
710 strwicmp(boolean_string
, "true") == 0 ||
711 strwicmp(boolean_string
, "on") == 0 ||
712 strwicmp(boolean_string
, "1") == 0) {
715 } else if (strwicmp(boolean_string
, "no") == 0 ||
716 strwicmp(boolean_string
, "false") == 0 ||
717 strwicmp(boolean_string
, "off") == 0 ||
718 strwicmp(boolean_string
, "0") == 0) {
726 return the number of bytes occupied by a buffer in CH_UTF16 format
727 the result includes the null termination
729 _PUBLIC_
size_t utf16_len(const void *buf
)
733 for (len
= 0; SVAL(buf
,len
); len
+= 2) ;
739 return the number of bytes occupied by a buffer in CH_UTF16 format
740 the result includes the null termination
743 _PUBLIC_
size_t utf16_len_n(const void *src
, size_t n
)
747 for (len
= 0; (len
+2 < n
) && SVAL(src
, len
); len
+= 2) ;
758 * @brief String utilities.
761 static bool next_token_internal_talloc(TALLOC_CTX
*ctx
,
780 /* default to simple separators */
785 /* find the first non sep char, if left-trimming is requested */
787 while (*s
&& strchr_m(sep
,*s
)) {
797 /* When restarting we need to go from here. */
800 /* Work out the length needed. */
801 for (quoted
= false; *s
&&
802 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
810 /* We started with len = 1 so we have space for the nul. */
811 *pp_buff
= talloc_array(ctx
, char, len
);
816 /* copy over the token */
819 for (quoted
= false; *s
&&
820 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
828 *ptr
= (*s
) ? s
+1 : s
;
834 bool next_token_talloc(TALLOC_CTX
*ctx
,
839 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, true);
843 * Get the next token from a string, return false if none found. Handles
844 * double-quotes. This version does not trim leading separator characters
845 * before looking for a token.
848 bool next_token_no_ltrim_talloc(TALLOC_CTX
*ctx
,
853 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, false);