s3: Add SMB2 performance counters.
[Samba/gebeck_regimport.git] / lib / util / util.c
blobd645f7edc91c7e73081d593f50ac568014055bc6
1 /*
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/>.
24 #include "includes.h"
25 #include "system/network.h"
26 #include "system/filesys.h"
27 #include "system/locale.h"
28 #include "system/shmem.h"
30 #undef malloc
31 #undef strcasecmp
32 #undef strncasecmp
33 #undef strdup
34 #undef realloc
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"
40 #endif
41 #else
42 #define uwrap_enabled() 0
43 #endif
45 /**
46 * @file
47 * @brief Misc utility functions
50 /**
51 Find a suitable temporary directory. The result should be copied immediately
52 as it may be overwritten by a subsequent call.
53 **/
54 _PUBLIC_ const char *tmpdir(void)
56 char *p;
57 if ((p = getenv("TMPDIR")))
58 return p;
59 return "/tmp";
63 /**
64 Check if a file exists - call vfs_file_exist for samba files.
65 **/
66 _PUBLIC_ bool file_exist(const char *fname)
68 struct stat st;
70 if (stat(fname, &st) != 0) {
71 return false;
74 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
77 /**
78 Check a files mod time.
79 **/
81 _PUBLIC_ time_t file_modtime(const char *fname)
83 struct stat st;
85 if (stat(fname,&st) != 0)
86 return(0);
88 return(st.st_mtime);
91 /**
92 Check if a directory exists.
93 **/
95 _PUBLIC_ bool directory_exist(const char *dname)
97 struct stat st;
98 bool ret;
100 if (stat(dname,&st) != 0) {
101 return false;
104 ret = S_ISDIR(st.st_mode);
105 if(!ret)
106 errno = ENOTDIR;
107 return ret;
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,
117 mode_t dir_perms)
119 mode_t old_umask;
120 struct stat st;
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 "
128 "%s: %s\n", dname,
129 strerror(errno)));
130 umask(old_umask);
131 return false;
133 } else {
134 DEBUG(0, ("lstat failed on directory %s: %s\n",
135 dname, strerror(errno)));
136 umask(old_umask);
137 return false;
139 } else {
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",
143 dname));
144 umask(old_umask);
145 return false;
147 if (st.st_uid != uid && !uwrap_enabled()) {
148 DEBUG(0, ("invalid ownership on directory "
149 "%s\n", dname));
150 umask(old_umask);
151 return false;
153 if ((st.st_mode & 0777) != dir_perms) {
154 DEBUG(0, ("invalid permissions on directory "
155 "%s\n", dname));
156 umask(old_umask);
157 return false;
160 return true;
165 Sleep for a specified number of milliseconds.
168 _PUBLIC_ void msleep(unsigned int t)
170 struct timeval tval;
172 tval.tv_sec = t/1000;
173 tval.tv_usec = 1000*(t%1000);
174 /* this should be the real select - do NOT replace
175 with sys_select() */
176 select(0,NULL,NULL,NULL,&tval);
180 Get my own name, return in talloc'ed storage.
183 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
185 char *p;
186 char hostname[HOST_NAME_MAX];
188 /* get my host name */
189 if (gethostname(hostname, sizeof(hostname)) == -1) {
190 DEBUG(0,("gethostname failed\n"));
191 return NULL;
194 /* Ensure null termination. */
195 hostname[sizeof(hostname)-1] = '\0';
197 /* split off any parts after an initial . */
198 p = strchr_m(hostname, '.');
199 if (p) {
200 *p = 0;
203 return talloc_strdup(ctx, hostname);
207 Check if a process exists. Does this work on all unixes?
210 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
212 /* Doing kill with a non-positive pid causes messages to be
213 * sent to places we don't want. */
214 SMB_ASSERT(pid > 0);
215 return(kill(pid,0) == 0 || errno != ESRCH);
219 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
220 is dealt with in posix.c
223 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
225 struct flock lock;
226 int ret;
228 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
230 lock.l_type = type;
231 lock.l_whence = SEEK_SET;
232 lock.l_start = offset;
233 lock.l_len = count;
234 lock.l_pid = 0;
236 ret = fcntl(fd,op,&lock);
238 if (ret == -1 && errno != 0)
239 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
241 /* a lock query */
242 if (op == F_GETLK) {
243 if ((ret != -1) &&
244 (lock.l_type != F_UNLCK) &&
245 (lock.l_pid != 0) &&
246 (lock.l_pid != getpid())) {
247 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
248 return true;
251 /* it must be not locked or locked by me */
252 return false;
255 /* a lock set or unset */
256 if (ret == -1) {
257 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
258 (double)offset,(double)count,op,type,strerror(errno)));
259 return false;
262 /* everything went OK */
263 DEBUG(8,("fcntl_lock: Lock call successful\n"));
265 return true;
268 void print_asc(int level, const uint8_t *buf,int len)
270 int i;
271 for (i=0;i<len;i++)
272 DEBUGADD(level,("%c", isprint(buf[i])?buf[i]:'.'));
276 * Write dump of binary data to the log file.
278 * The data is only written if the log level is at least level.
280 static void _dump_data(int level, const uint8_t *buf, int len,
281 bool omit_zero_bytes)
283 int i=0;
284 static const uint8_t empty[16] = { 0, };
285 bool skipped = false;
287 if (len<=0) return;
289 if (!DEBUGLVL(level)) return;
291 for (i=0;i<len;) {
293 if (i%16 == 0) {
294 if ((omit_zero_bytes == true) &&
295 (i > 0) &&
296 (len > i+16) &&
297 (memcmp(&buf[i], &empty, 16) == 0))
299 i +=16;
300 continue;
303 if (i<len) {
304 DEBUGADD(level,("[%04X] ",i));
308 DEBUGADD(level,("%02X ",(int)buf[i]));
309 i++;
310 if (i%8 == 0) DEBUGADD(level,(" "));
311 if (i%16 == 0) {
313 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
314 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
316 if ((omit_zero_bytes == true) &&
317 (len > i+16) &&
318 (memcmp(&buf[i], &empty, 16) == 0)) {
319 if (!skipped) {
320 DEBUGADD(level,("skipping zero buffer bytes\n"));
321 skipped = true;
327 if (i%16) {
328 int n;
329 n = 16 - (i%16);
330 DEBUGADD(level,(" "));
331 if (n>8) DEBUGADD(level,(" "));
332 while (n--) DEBUGADD(level,(" "));
333 n = MIN(8,i%16);
334 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
335 n = (i%16) - n;
336 if (n>0) print_asc(level,&buf[i-n],n);
337 DEBUGADD(level,("\n"));
343 * Write dump of binary data to the log file.
345 * The data is only written if the log level is at least level.
347 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
349 _dump_data(level, buf, len, false);
353 * Write dump of binary data to the log file.
355 * The data is only written if the log level is at least level.
356 * 16 zero bytes in a row are omitted
358 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
360 _dump_data(level, buf, len, true);
365 malloc that aborts with smb_panic on fail or zero size.
368 _PUBLIC_ void *smb_xmalloc(size_t size)
370 void *p;
371 if (size == 0)
372 smb_panic("smb_xmalloc: called with zero size.\n");
373 if ((p = malloc(size)) == NULL)
374 smb_panic("smb_xmalloc: malloc fail.\n");
375 return p;
379 Memdup with smb_panic on fail.
382 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
384 void *p2;
385 p2 = smb_xmalloc(size);
386 memcpy(p2, p, size);
387 return p2;
391 strdup that aborts on malloc fail.
394 char *smb_xstrdup(const char *s)
396 #if defined(PARANOID_MALLOC_CHECKER)
397 #ifdef strdup
398 #undef strdup
399 #endif
400 #endif
402 #ifndef HAVE_STRDUP
403 #define strdup rep_strdup
404 #endif
406 char *s1 = strdup(s);
407 #if defined(PARANOID_MALLOC_CHECKER)
408 #ifdef strdup
409 #undef strdup
410 #endif
411 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
412 #endif
413 if (!s1) {
414 smb_panic("smb_xstrdup: malloc failed");
416 return s1;
421 strndup that aborts on malloc fail.
424 char *smb_xstrndup(const char *s, size_t n)
426 #if defined(PARANOID_MALLOC_CHECKER)
427 #ifdef strndup
428 #undef strndup
429 #endif
430 #endif
432 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
433 #undef HAVE_STRNDUP
434 #define strndup rep_strndup
435 #endif
437 char *s1 = strndup(s, n);
438 #if defined(PARANOID_MALLOC_CHECKER)
439 #ifdef strndup
440 #undef strndup
441 #endif
442 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
443 #endif
444 if (!s1) {
445 smb_panic("smb_xstrndup: malloc failed");
447 return s1;
453 Like strdup but for memory.
456 _PUBLIC_ void *memdup(const void *p, size_t size)
458 void *p2;
459 if (size == 0)
460 return NULL;
461 p2 = malloc(size);
462 if (!p2)
463 return NULL;
464 memcpy(p2, p, size);
465 return p2;
469 * Write a password to the log file.
471 * @note Only actually does something if DEBUG_PASSWORD was defined during
472 * compile-time.
474 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
476 #ifdef DEBUG_PASSWORD
477 DEBUG(11, ("%s", msg));
478 if (data != NULL && len > 0)
480 dump_data(11, data, len);
482 #endif
487 * see if a range of memory is all zero. A NULL pointer is considered
488 * to be all zero
490 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
492 int i;
493 if (!ptr) return true;
494 for (i=0;i<size;i++) {
495 if (ptr[i]) return false;
497 return true;
501 realloc an array, checking for integer overflow in the array size
503 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
505 #define MAX_MALLOC_SIZE 0x7fffffff
506 if (count == 0 ||
507 count >= MAX_MALLOC_SIZE/el_size) {
508 if (free_on_fail)
509 SAFE_FREE(ptr);
510 return NULL;
512 if (!ptr) {
513 return malloc(el_size * count);
515 return realloc(ptr, el_size * count);
518 /****************************************************************************
519 Type-safe malloc.
520 ****************************************************************************/
522 void *malloc_array(size_t el_size, unsigned int count)
524 return realloc_array(NULL, el_size, count, false);
528 Trim the specified elements off the front and back of a string.
530 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
532 bool ret = false;
533 size_t front_len;
534 size_t back_len;
535 size_t len;
537 /* Ignore null or empty strings. */
538 if (!s || (s[0] == '\0'))
539 return false;
541 front_len = front? strlen(front) : 0;
542 back_len = back? strlen(back) : 0;
544 len = strlen(s);
546 if (front_len) {
547 while (len && strncmp(s, front, front_len)==0) {
548 /* Must use memmove here as src & dest can
549 * easily overlap. Found by valgrind. JRA. */
550 memmove(s, s+front_len, (len-front_len)+1);
551 len -= front_len;
552 ret=true;
556 if (back_len) {
557 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
558 s[len-back_len]='\0';
559 len -= back_len;
560 ret=true;
563 return ret;
567 Find the number of 'c' chars in a string
569 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
571 size_t count = 0;
573 while (*s) {
574 if (*s == c) count++;
575 s ++;
578 return count;
582 Routine to get hex characters and turn them into a 16 byte array.
583 the array can be variable length, and any non-hex-numeric
584 characters are skipped. "0xnn" or "0Xnn" is specially catered
585 for.
587 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
591 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
593 size_t i = 0;
594 size_t num_chars = 0;
595 uint8_t lonybble, hinybble;
596 const char *hexchars = "0123456789ABCDEF";
597 char *p1 = NULL, *p2 = NULL;
599 /* skip leading 0x prefix */
600 if (strncasecmp(strhex, "0x", 2) == 0) {
601 i += 2; /* skip two chars */
604 for (; i < strhex_len && strhex[i] != 0; i++) {
605 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
606 break;
608 i++; /* next hex digit */
610 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
611 break;
613 /* get the two nybbles */
614 hinybble = PTR_DIFF(p1, hexchars);
615 lonybble = PTR_DIFF(p2, hexchars);
617 if (num_chars >= p_len) {
618 break;
621 p[num_chars] = (hinybble << 4) | lonybble;
622 num_chars++;
624 p1 = NULL;
625 p2 = NULL;
627 return num_chars;
630 /**
631 * Parse a hex string and return a data blob.
633 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
635 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
637 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
638 strhex,
639 strlen(strhex));
641 return ret_blob;
646 * Routine to print a buffer as HEX digits, into an allocated string.
648 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
650 int i;
651 char *hex_buffer;
653 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
654 hex_buffer = *out_hex_buffer;
656 for (i = 0; i < len; i++)
657 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
661 * talloc version of hex_encode()
663 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
665 int i;
666 char *hex_buffer;
668 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
669 if (!hex_buffer) {
670 return NULL;
673 for (i = 0; i < len; i++)
674 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
676 talloc_set_name_const(hex_buffer, hex_buffer);
677 return hex_buffer;
681 varient of strcmp() that handles NULL ptrs
683 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
685 if (s1 == s2) {
686 return 0;
688 if (s1 == NULL || s2 == NULL) {
689 return s1?-1:1;
691 return strcmp(s1, s2);
696 return the number of bytes occupied by a buffer in ASCII format
697 the result includes the null termination
698 limited by 'n' bytes
700 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
702 size_t len;
704 len = strnlen(src, n);
705 if (len+1 <= n) {
706 len += 1;
709 return len;
713 Set a boolean variable from the text value stored in the passed string.
714 Returns true in success, false if the passed string does not correctly
715 represent a boolean.
718 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
720 if (strwicmp(boolean_string, "yes") == 0 ||
721 strwicmp(boolean_string, "true") == 0 ||
722 strwicmp(boolean_string, "on") == 0 ||
723 strwicmp(boolean_string, "1") == 0) {
724 *boolean = true;
725 return true;
726 } else if (strwicmp(boolean_string, "no") == 0 ||
727 strwicmp(boolean_string, "false") == 0 ||
728 strwicmp(boolean_string, "off") == 0 ||
729 strwicmp(boolean_string, "0") == 0) {
730 *boolean = false;
731 return true;
733 return false;
737 return the number of bytes occupied by a buffer in CH_UTF16 format
738 the result includes the null termination
740 _PUBLIC_ size_t utf16_len(const void *buf)
742 size_t len;
744 for (len = 0; SVAL(buf,len); len += 2) ;
746 return len + 2;
750 return the number of bytes occupied by a buffer in CH_UTF16 format
751 the result includes the null termination
752 limited by 'n' bytes
754 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
756 size_t len;
758 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
760 if (len+2 <= n) {
761 len += 2;
764 return len;
768 * @file
769 * @brief String utilities.
772 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
773 const char **ptr,
774 char **pp_buff,
775 const char *sep,
776 bool ltrim)
778 const char *s;
779 const char *saved_s;
780 char *pbuf;
781 bool quoted;
782 size_t len=1;
784 *pp_buff = NULL;
785 if (!ptr) {
786 return(false);
789 s = *ptr;
791 /* default to simple separators */
792 if (!sep) {
793 sep = " \t\n\r";
796 /* find the first non sep char, if left-trimming is requested */
797 if (ltrim) {
798 while (*s && strchr_m(sep,*s)) {
799 s++;
803 /* nothing left? */
804 if (!*s) {
805 return false;
808 /* When restarting we need to go from here. */
809 saved_s = s;
811 /* Work out the length needed. */
812 for (quoted = false; *s &&
813 (quoted || !strchr_m(sep,*s)); s++) {
814 if (*s == '\"') {
815 quoted = !quoted;
816 } else {
817 len++;
821 /* We started with len = 1 so we have space for the nul. */
822 *pp_buff = talloc_array(ctx, char, len);
823 if (!*pp_buff) {
824 return false;
827 /* copy over the token */
828 pbuf = *pp_buff;
829 s = saved_s;
830 for (quoted = false; *s &&
831 (quoted || !strchr_m(sep,*s)); s++) {
832 if ( *s == '\"' ) {
833 quoted = !quoted;
834 } else {
835 *pbuf++ = *s;
839 *ptr = (*s) ? s+1 : s;
840 *pbuf = 0;
842 return true;
845 bool next_token_talloc(TALLOC_CTX *ctx,
846 const char **ptr,
847 char **pp_buff,
848 const char *sep)
850 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
854 * Get the next token from a string, return false if none found. Handles
855 * double-quotes. This version does not trim leading separator characters
856 * before looking for a token.
859 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
860 const char **ptr,
861 char **pp_buff,
862 const char *sep)
864 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
867 /* Map a shared memory buffer of at least nelem counters. */
868 void *allocate_anonymous_shared(size_t bufsz)
870 void *buf;
871 size_t pagesz = getpagesize();
873 if (bufsz % pagesz) {
874 bufsz = (bufsz + pagesz) % pagesz; /* round up to pagesz */
877 #ifdef MAP_ANON
878 /* BSD */
879 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED,
880 -1 /* fd */, 0 /* offset */);
881 #else
882 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_FILE|MAP_SHARED,
883 open("/dev/zero", O_RDWR), 0 /* offset */);
884 #endif
886 if (buf == MAP_FAILED) {
887 return NULL;
890 return buf;