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"
35 * @brief Misc utility functions
39 Find a suitable temporary directory. The result should be copied immediately
40 as it may be overwritten by a subsequent call.
42 _PUBLIC_ const char *tmpdir(void)
45 if ((p = getenv("TMPDIR")))
52 Check if a file exists - call vfs_file_exist for samba files.
54 _PUBLIC_ bool file_exist(const char *fname)
58 if (stat(fname, &st) != 0) {
62 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
66 Check a files mod time.
69 _PUBLIC_ time_t file_modtime(const char *fname)
73 if (stat(fname,&st) != 0)
80 Check if a directory exists.
83 _PUBLIC_ bool directory_exist(const char *dname)
88 if (stat(dname,&st) != 0) {
92 ret = S_ISDIR(st.st_mode);
99 * Try to create the specified directory if it didn't exist.
101 * @retval true if the directory already existed and has the right permissions
102 * or was successfully created.
104 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
110 old_umask = umask(0);
111 if (lstat(dname, &st) == -1) {
112 if (errno == ENOENT) {
113 /* Create directory */
114 if (mkdir(dname, dir_perms) == -1) {
115 DEBUG(0, ("error creating directory "
122 DEBUG(0, ("lstat failed on directory %s: %s\n",
123 dname, strerror(errno)));
128 /* Check ownership and permission on existing directory */
129 if (!S_ISDIR(st.st_mode)) {
130 DEBUG(0, ("directory %s isn't a directory\n",
135 if ((st.st_uid != uid) ||
136 ((st.st_mode & 0777) != dir_perms)) {
137 DEBUG(0, ("invalid permissions on directory "
148 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
154 _PUBLIC_ int set_blocking(int fd, bool set)
158 #define FLAG_TO_SET O_NONBLOCK
161 #define FLAG_TO_SET O_NDELAY
163 #define FLAG_TO_SET FNDELAY
167 if((val = fcntl(fd, F_GETFL, 0)) == -1)
169 if(set) /* Turn blocking on - ie. clear nonblock flag */
173 return fcntl( fd, F_SETFL, val);
179 Sleep for a specified number of milliseconds.
182 _PUBLIC_ void msleep(unsigned int t)
186 tval.tv_sec = t/1000;
187 tval.tv_usec = 1000*(t%1000);
188 /* this should be the real select - do NOT replace
190 select(0,NULL,NULL,NULL,&tval);
194 Get my own name, return in malloc'ed storage.
197 _PUBLIC_ char *get_myname(void)
202 hostname = (char *)malloc(MAXHOSTNAMELEN+1);
205 /* get my host name */
206 if (gethostname(hostname, MAXHOSTNAMELEN+1) == -1) {
207 DEBUG(0,("gethostname failed\n"));
211 /* Ensure null termination. */
212 hostname[MAXHOSTNAMELEN] = '\0';
214 /* split off any parts after an initial . */
215 p = strchr(hostname, '.');
224 Check if a process exists. Does this work on all unixes?
227 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
229 /* Doing kill with a non-positive pid causes messages to be
230 * sent to places we don't want. */
232 return(kill(pid,0) == 0 || errno != ESRCH);
236 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
237 is dealt with in posix.c
240 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
245 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
248 lock.l_whence = SEEK_SET;
249 lock.l_start = offset;
253 ret = fcntl(fd,op,&lock);
255 if (ret == -1 && errno != 0)
256 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
261 (lock.l_type != F_UNLCK) &&
263 (lock.l_pid != getpid())) {
264 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
268 /* it must be not locked or locked by me */
272 /* a lock set or unset */
274 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
275 (double)offset,(double)count,op,type,strerror(errno)));
279 /* everything went OK */
280 DEBUG(8,("fcntl_lock: Lock call successful\n"));
286 void print_asc(int level, const uint8_t *buf,int len)
290 DEBUGADD(level,("%c", isprint(buf[i])?buf[i]:'.'));
294 * Write dump of binary data to the log file.
296 * The data is only written if the log level is at least level.
298 static void _dump_data(int level, const uint8_t *buf, int len,
299 bool omit_zero_bytes)
302 const uint8_t empty[16];
303 bool skipped = false;
307 if (!DEBUGLVL(level)) return;
309 memset(&empty, '\0', 16);
314 if ((omit_zero_bytes == true) &&
317 (memcmp(&buf[i], &empty, 16) == 0))
324 DEBUGADD(level,("[%04X] ",i));
328 DEBUGADD(level,("%02X ",(int)buf[i]));
330 if (i%8 == 0) DEBUGADD(level,(" "));
333 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
334 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
336 if ((omit_zero_bytes == true) &&
338 (memcmp(&buf[i], &empty, 16) == 0)) {
340 DEBUGADD(level,("skipping zero buffer bytes\n"));
350 DEBUGADD(level,(" "));
351 if (n>8) DEBUGADD(level,(" "));
352 while (n--) DEBUGADD(level,(" "));
354 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
356 if (n>0) print_asc(level,&buf[i-n],n);
357 DEBUGADD(level,("\n"));
363 * Write dump of binary data to the log file.
365 * The data is only written if the log level is at least level.
367 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
369 _dump_data(level, buf, len, false);
373 * Write dump of binary data to the log file.
375 * The data is only written if the log level is at least level.
376 * 16 zero bytes in a row are ommited
378 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
380 _dump_data(level, buf, len, true);
385 malloc that aborts with smb_panic on fail or zero size.
388 _PUBLIC_ void *smb_xmalloc(size_t size)
392 smb_panic("smb_xmalloc: called with zero size.\n");
393 if ((p = malloc(size)) == NULL)
394 smb_panic("smb_xmalloc: malloc fail.\n");
399 Memdup with smb_panic on fail.
402 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
405 p2 = smb_xmalloc(size);
411 strdup that aborts on malloc fail.
414 char *smb_xstrdup(const char *s)
416 #if defined(PARANOID_MALLOC_CHECKER)
423 #define strdup rep_strdup
426 char *s1 = strdup(s);
427 #if defined(PARANOID_MALLOC_CHECKER)
431 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
434 smb_panic("smb_xstrdup: malloc failed");
441 strndup that aborts on malloc fail.
444 char *smb_xstrndup(const char *s, size_t n)
446 #if defined(PARANOID_MALLOC_CHECKER)
452 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
454 #define strndup rep_strndup
457 char *s1 = strndup(s, n);
458 #if defined(PARANOID_MALLOC_CHECKER)
462 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
465 smb_panic("smb_xstrndup: malloc failed");
473 Like strdup but for memory.
476 _PUBLIC_ void *memdup(const void *p, size_t size)
489 * Write a password to the log file.
491 * @note Only actually does something if DEBUG_PASSWORD was defined during
494 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
496 #ifdef DEBUG_PASSWORD
497 DEBUG(11, ("%s", msg));
498 if (data != NULL && len > 0)
500 dump_data(11, data, len);
507 * see if a range of memory is all zero. A NULL pointer is considered
510 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
513 if (!ptr) return true;
514 for (i=0;i<size;i++) {
515 if (ptr[i]) return false;
521 realloc an array, checking for integer overflow in the array size
523 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
525 #define MAX_MALLOC_SIZE 0x7fffffff
527 count >= MAX_MALLOC_SIZE/el_size) {
533 return malloc(el_size * count);
535 return realloc(ptr, el_size * count);
538 /****************************************************************************
540 ****************************************************************************/
542 void *malloc_array(size_t el_size, unsigned int count)
544 return realloc_array(NULL, el_size, count, false);
547 _PUBLIC_ void *talloc_check_name_abort(const void *ptr, const char *name)
551 result = talloc_check_name(ptr, name);
555 DEBUG(0, ("Talloc type mismatch, expected %s, got %s\n",
556 name, talloc_get_name(ptr)));
557 smb_panic("talloc type mismatch");
558 /* Keep the compiler happy */