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 Peach 2006
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/>.
26 extern fstring local_machine;
27 extern char *global_clobber_region_function;
28 extern unsigned int global_clobber_region_line;
29 extern fstring remote_arch;
31 /* Max allowable allococation - 256mb - 0x10000000 */
32 #define MAX_ALLOC_SIZE (1024*1024*256)
34 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
35 #ifdef WITH_NISPLUS_HOME
36 #ifdef BROKEN_NISPLUS_INCLUDE_FILES
38 * The following lines are needed due to buggy include files
39 * in Solaris 2.6 which define GROUP in both /usr/include/sys/acl.h and
40 * also in /usr/include/rpcsvc/nis.h. The definitions conflict. JRA.
41 * Also GROUP_OBJ is defined as 0x4 in /usr/include/sys/acl.h and as
42 * an enum in /usr/include/rpcsvc/nis.h.
49 #if defined(GROUP_OBJ)
53 #endif /* BROKEN_NISPLUS_INCLUDE_FILES */
55 #include <rpcsvc/nis.h>
57 #endif /* WITH_NISPLUS_HOME */
58 #endif /* HAVE_NETGROUP && WITH_AUTOMOUNT */
60 enum protocol_types Protocol = PROTOCOL_COREPLUS;
62 /* a default finfo structure to ensure all fields are sensible */
65 /* this is used by the chaining code */
70 static enum remote_arch_types ra_type = RA_UNKNOWN;
71 pstring user_socket_options=DEFAULT_SOCKET_OPTIONS;
73 /***********************************************************************
74 Definitions for all names.
75 ***********************************************************************/
77 static char *smb_myname;
78 static char *smb_myworkgroup;
79 static char *smb_scope;
80 static int smb_num_netbios_names;
81 static char **smb_my_netbios_names;
83 /***********************************************************************
84 Allocate and set myname. Ensure upper case.
85 ***********************************************************************/
87 BOOL set_global_myname(const char *myname)
89 SAFE_FREE(smb_myname);
90 smb_myname = SMB_STRDUP(myname);
93 strupper_m(smb_myname);
97 const char *global_myname(void)
102 /***********************************************************************
103 Allocate and set myworkgroup. Ensure upper case.
104 ***********************************************************************/
106 BOOL set_global_myworkgroup(const char *myworkgroup)
108 SAFE_FREE(smb_myworkgroup);
109 smb_myworkgroup = SMB_STRDUP(myworkgroup);
110 if (!smb_myworkgroup)
112 strupper_m(smb_myworkgroup);
116 const char *lp_workgroup(void)
118 return smb_myworkgroup;
121 /***********************************************************************
122 Allocate and set scope. Ensure upper case.
123 ***********************************************************************/
125 BOOL set_global_scope(const char *scope)
127 SAFE_FREE(smb_scope);
128 smb_scope = SMB_STRDUP(scope);
131 strupper_m(smb_scope);
135 /*********************************************************************
136 Ensure scope is never null string.
137 *********************************************************************/
139 const char *global_scope(void)
142 set_global_scope("");
146 static void free_netbios_names_array(void)
150 for (i = 0; i < smb_num_netbios_names; i++)
151 SAFE_FREE(smb_my_netbios_names[i]);
153 SAFE_FREE(smb_my_netbios_names);
154 smb_num_netbios_names = 0;
157 static BOOL allocate_my_netbios_names_array(size_t number)
159 free_netbios_names_array();
161 smb_num_netbios_names = number + 1;
162 smb_my_netbios_names = SMB_MALLOC_ARRAY( char *, smb_num_netbios_names );
164 if (!smb_my_netbios_names)
167 memset(smb_my_netbios_names, '\0', sizeof(char *) * smb_num_netbios_names);
171 static BOOL set_my_netbios_names(const char *name, int i)
173 SAFE_FREE(smb_my_netbios_names[i]);
175 smb_my_netbios_names[i] = SMB_STRDUP(name);
176 if (!smb_my_netbios_names[i])
178 strupper_m(smb_my_netbios_names[i]);
182 /***********************************************************************
183 Free memory allocated to global objects
184 ***********************************************************************/
186 void gfree_names(void)
188 SAFE_FREE( smb_myname );
189 SAFE_FREE( smb_myworkgroup );
190 SAFE_FREE( smb_scope );
191 free_netbios_names_array();
194 void gfree_all( void )
203 /* release the talloc null_context memory last */
204 talloc_disable_null_tracking();
207 const char *my_netbios_names(int i)
209 return smb_my_netbios_names[i];
212 BOOL set_netbios_aliases(const char **str_array)
216 /* Work out the max number of netbios aliases that we have */
217 for( namecount=0; str_array && (str_array[namecount] != NULL); namecount++ )
220 if ( global_myname() && *global_myname())
223 /* Allocate space for the netbios aliases */
224 if (!allocate_my_netbios_names_array(namecount))
227 /* Use the global_myname string first */
229 if ( global_myname() && *global_myname()) {
230 set_my_netbios_names( global_myname(), namecount );
236 for ( i = 0; str_array[i] != NULL; i++) {
238 BOOL duplicate = False;
240 /* Look for duplicates */
241 for( n=0; n<namecount; n++ ) {
242 if( strequal( str_array[i], my_netbios_names(n) ) ) {
248 if (!set_my_netbios_names(str_array[i], namecount))
257 /****************************************************************************
258 Common name initialization code.
259 ****************************************************************************/
261 BOOL init_names(void)
266 if (global_myname() == NULL || *global_myname() == '\0') {
267 if (!set_global_myname(myhostname())) {
268 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
273 if (!set_netbios_aliases(lp_netbios_aliases())) {
274 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
278 fstrcpy( local_machine, global_myname() );
279 trim_char( local_machine, ' ', ' ' );
280 p = strchr( local_machine, ' ' );
283 strlower_m( local_machine );
285 DEBUG( 5, ("Netbios name list:-\n") );
286 for( n=0; my_netbios_names(n); n++ )
287 DEBUGADD( 5, ( "my_netbios_names[%d]=\"%s\"\n", n, my_netbios_names(n) ) );
292 /**************************************************************************n
293 Find a suitable temporary directory. The result should be copied immediately
294 as it may be overwritten by a subsequent call.
295 ****************************************************************************/
297 const char *tmpdir(void)
300 if ((p = getenv("TMPDIR")))
305 /****************************************************************************
306 Add a gid to an array of gids if it's not already there.
307 ****************************************************************************/
309 BOOL add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
310 gid_t **gids, size_t *num_gids)
314 if ((*num_gids != 0) && (*gids == NULL)) {
316 * A former call to this routine has failed to allocate memory
321 for (i=0; i<*num_gids; i++) {
322 if ((*gids)[i] == gid) {
327 *gids = TALLOC_REALLOC_ARRAY(mem_ctx, *gids, gid_t, *num_gids+1);
333 (*gids)[*num_gids] = gid;
338 /****************************************************************************
339 Like atoi but gets the value up to the separator character.
340 ****************************************************************************/
342 static const char *Atoic(const char *p, int *n, const char *c)
344 if (!isdigit((int)*p)) {
345 DEBUG(5, ("Atoic: malformed number\n"));
351 while ((*p) && isdigit((int)*p))
354 if (strchr_m(c, *p) == NULL) {
355 DEBUG(5, ("Atoic: no separator characters (%s) not found\n", c));
362 /*************************************************************************
363 Reads a list of numbers.
364 *************************************************************************/
366 const char *get_numlist(const char *p, uint32 **num, int *count)
370 if (num == NULL || count == NULL)
376 while ((p = Atoic(p, &val, ":,")) != NULL && (*p) != ':') {
377 *num = SMB_REALLOC_ARRAY((*num), uint32, (*count)+1);
381 (*num)[(*count)] = val;
389 /*******************************************************************
390 Check if a file exists - call vfs_file_exist for samba files.
391 ********************************************************************/
393 BOOL file_exist(const char *fname,SMB_STRUCT_STAT *sbuf)
399 if (sys_stat(fname,sbuf) != 0)
402 return((S_ISREG(sbuf->st_mode)) || (S_ISFIFO(sbuf->st_mode)));
405 /*******************************************************************
406 Check a files mod time.
407 ********************************************************************/
409 time_t file_modtime(const char *fname)
413 if (sys_stat(fname,&st) != 0)
419 /*******************************************************************
420 Check if a directory exists.
421 ********************************************************************/
423 BOOL directory_exist(char *dname,SMB_STRUCT_STAT *st)
431 if (sys_stat(dname,st) != 0)
434 ret = S_ISDIR(st->st_mode);
440 /*******************************************************************
441 Returns the size in bytes of the named file.
442 ********************************************************************/
444 SMB_OFF_T get_file_size(char *file_name)
448 if(sys_stat(file_name,&buf) != 0)
449 return (SMB_OFF_T)-1;
453 /*******************************************************************
454 Return a string representing an attribute for a file.
455 ********************************************************************/
457 char *attrib_string(uint16 mode)
463 if (mode & aVOLID) fstrcat(attrstr,"V");
464 if (mode & aDIR) fstrcat(attrstr,"D");
465 if (mode & aARCH) fstrcat(attrstr,"A");
466 if (mode & aHIDDEN) fstrcat(attrstr,"H");
467 if (mode & aSYSTEM) fstrcat(attrstr,"S");
468 if (mode & aRONLY) fstrcat(attrstr,"R");
470 return talloc_strdup(talloc_tos(), attrstr);
473 /*******************************************************************
474 Show a smb message structure.
475 ********************************************************************/
477 void show_msg(char *buf)
485 DEBUG(5,("size=%d\nsmb_com=0x%x\nsmb_rcls=%d\nsmb_reh=%d\nsmb_err=%d\nsmb_flg=%d\nsmb_flg2=%d\n",
487 (int)CVAL(buf,smb_com),
488 (int)CVAL(buf,smb_rcls),
489 (int)CVAL(buf,smb_reh),
490 (int)SVAL(buf,smb_err),
491 (int)CVAL(buf,smb_flg),
492 (int)SVAL(buf,smb_flg2)));
493 DEBUGADD(5,("smb_tid=%d\nsmb_pid=%d\nsmb_uid=%d\nsmb_mid=%d\n",
494 (int)SVAL(buf,smb_tid),
495 (int)SVAL(buf,smb_pid),
496 (int)SVAL(buf,smb_uid),
497 (int)SVAL(buf,smb_mid)));
498 DEBUGADD(5,("smt_wct=%d\n",(int)CVAL(buf,smb_wct)));
500 for (i=0;i<(int)CVAL(buf,smb_wct);i++)
501 DEBUGADD(5,("smb_vwv[%2d]=%5d (0x%X)\n",i,
502 SVAL(buf,smb_vwv+2*i),SVAL(buf,smb_vwv+2*i)));
504 bcc = (int)SVAL(buf,smb_vwv+2*(CVAL(buf,smb_wct)));
506 DEBUGADD(5,("smb_bcc=%d\n",bcc));
514 dump_data(10, (uint8 *)smb_buf(buf), bcc);
517 /*******************************************************************
518 Set the length and marker of an smb packet.
519 ********************************************************************/
521 void smb_setlen(char *buf,int len)
523 _smb_setlen(buf,len);
531 /*******************************************************************
532 Setup the word count and byte count for a smb message.
533 ********************************************************************/
535 int set_message(char *buf,int num_words,int num_bytes,BOOL zero)
537 if (zero && (num_words || num_bytes)) {
538 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
540 SCVAL(buf,smb_wct,num_words);
541 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
542 smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
543 return (smb_size + num_words*2 + num_bytes);
546 /*******************************************************************
547 Setup only the byte count for a smb message.
548 ********************************************************************/
550 int set_message_bcc(char *buf,int num_bytes)
552 int num_words = CVAL(buf,smb_wct);
553 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
554 smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
555 return (smb_size + num_words*2 + num_bytes);
558 /*******************************************************************
559 Setup only the byte count for a smb message, using the end of the
561 ********************************************************************/
563 int set_message_end(void *outbuf,void *end_ptr)
565 return set_message_bcc((char *)outbuf,PTR_DIFF(end_ptr,smb_buf((char *)outbuf)));
568 /*******************************************************************
569 Add a data blob to the end of a smb_buf, adjusting bcc and smb_len.
570 Return the bytes added
571 ********************************************************************/
573 ssize_t message_push_blob(uint8 **outbuf, DATA_BLOB blob)
575 size_t newlen = smb_len(*outbuf) + 4 + blob.length;
578 if (!(tmp = TALLOC_REALLOC_ARRAY(NULL, *outbuf, uint8, newlen))) {
579 DEBUG(0, ("talloc failed\n"));
584 memcpy(tmp + smb_len(tmp) + 4, blob.data, blob.length);
585 set_message_bcc((char *)tmp, smb_buflen(tmp) + blob.length);
589 /*******************************************************************
590 Reduce a file name, removing .. elements.
591 ********************************************************************/
593 void dos_clean_name(char *s)
597 DEBUG(3,("dos_clean_name [%s]\n",s));
599 /* remove any double slashes */
600 all_string_sub(s, "\\\\", "\\", 0);
602 /* Remove leading .\\ characters */
603 if(strncmp(s, ".\\", 2) == 0) {
604 trim_string(s, ".\\", NULL);
609 while ((p = strstr_m(s,"\\..\\")) != NULL) {
615 if ((p=strrchr_m(s,'\\')) != NULL)
622 trim_string(s,NULL,"\\..");
623 all_string_sub(s, "\\.\\", "\\", 0);
626 /*******************************************************************
627 Reduce a file name, removing .. elements.
628 ********************************************************************/
630 void unix_clean_name(char *s)
634 DEBUG(3,("unix_clean_name [%s]\n",s));
636 /* remove any double slashes */
637 all_string_sub(s, "//","/", 0);
639 /* Remove leading ./ characters */
640 if(strncmp(s, "./", 2) == 0) {
641 trim_string(s, "./", NULL);
646 while ((p = strstr_m(s,"/../")) != NULL) {
652 if ((p=strrchr_m(s,'/')) != NULL)
659 trim_string(s,NULL,"/..");
660 all_string_sub(s, "/./", "/", 0);
663 void clean_name(char *s)
669 /*******************************************************************
670 Close the low 3 fd's and open dev/null in their place.
671 ********************************************************************/
673 void close_low_fds(BOOL stderr_too)
685 /* try and use up these file descriptors, so silly
686 library routines writing to stdout etc won't cause havoc */
688 if (i == 2 && !stderr_too)
691 fd = sys_open("/dev/null",O_RDWR,0);
693 fd = sys_open("/dev/null",O_WRONLY,0);
695 DEBUG(0,("Can't open /dev/null\n"));
699 DEBUG(0,("Didn't get file descriptor %d\n",i));
706 /*******************************************************************
707 Write data into an fd at a given offset. Ignore seek errors.
708 ********************************************************************/
710 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, SMB_OFF_T pos)
715 if (pos == (SMB_OFF_T)-1) {
716 return write_data(fd, buffer, N);
718 #if defined(HAVE_PWRITE) || defined(HAVE_PRWITE64)
720 ret = sys_pwrite(fd,buffer + total,N - total, pos);
721 if (ret == -1 && errno == ESPIPE) {
722 return write_data(fd, buffer + total,N - total);
725 DEBUG(0,("write_data_at_offset: write failure. Error = %s\n", strerror(errno) ));
734 return (ssize_t)total;
736 /* Use lseek and write_data. */
737 if (sys_lseek(fd, pos, SEEK_SET) == -1) {
738 if (errno != ESPIPE) {
742 return write_data(fd, buffer, N);
746 /****************************************************************************
747 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
751 ****************************************************************************/
753 int set_blocking(int fd, BOOL set)
757 #define FLAG_TO_SET O_NONBLOCK
760 #define FLAG_TO_SET O_NDELAY
762 #define FLAG_TO_SET FNDELAY
766 if((val = sys_fcntl_long(fd, F_GETFL, 0)) == -1)
768 if(set) /* Turn blocking on - ie. clear nonblock flag */
772 return sys_fcntl_long( fd, F_SETFL, val);
776 /****************************************************************************
777 Transfer some data between two fd's.
778 ****************************************************************************/
780 #ifndef TRANSFER_BUF_SIZE
781 #define TRANSFER_BUF_SIZE 65536
784 ssize_t transfer_file_internal(int infd, int outfd, size_t n, ssize_t (*read_fn)(int, void *, size_t),
785 ssize_t (*write_fn)(int, const void *, size_t))
791 size_t num_to_read_thistime;
792 size_t num_written = 0;
794 if ((buf = SMB_MALLOC_ARRAY(char, TRANSFER_BUF_SIZE)) == NULL)
798 num_to_read_thistime = MIN((n - total), TRANSFER_BUF_SIZE);
800 read_ret = (*read_fn)(infd, buf, num_to_read_thistime);
801 if (read_ret == -1) {
802 DEBUG(0,("transfer_file_internal: read failure. Error = %s\n", strerror(errno) ));
811 while (num_written < read_ret) {
812 write_ret = (*write_fn)(outfd,buf + num_written, read_ret - num_written);
814 if (write_ret == -1) {
815 DEBUG(0,("transfer_file_internal: write failure. Error = %s\n", strerror(errno) ));
820 return (ssize_t)total;
822 num_written += (size_t)write_ret;
825 total += (size_t)read_ret;
829 return (ssize_t)total;
832 SMB_OFF_T transfer_file(int infd,int outfd,SMB_OFF_T n)
834 return (SMB_OFF_T)transfer_file_internal(infd, outfd, (size_t)n, sys_read, sys_write);
837 /*******************************************************************
838 Sleep for a specified number of milliseconds.
839 ********************************************************************/
841 void smb_msleep(unsigned int t)
843 #if defined(HAVE_NANOSLEEP)
844 struct timespec tval;
847 tval.tv_sec = t/1000;
848 tval.tv_nsec = 1000000*(t%1000);
852 ret = nanosleep(&tval, &tval);
853 } while (ret < 0 && errno == EINTR && (tval.tv_sec > 0 || tval.tv_nsec > 0));
855 unsigned int tdiff=0;
856 struct timeval tval,t1,t2;
863 tval.tv_sec = (t-tdiff)/1000;
864 tval.tv_usec = 1000*((t-tdiff)%1000);
866 /* Never wait for more than 1 sec. */
867 if (tval.tv_sec > 1) {
874 sys_select_intr(0,&fds,NULL,NULL,&tval);
877 if (t2.tv_sec < t1.tv_sec) {
878 /* Someone adjusted time... */
882 tdiff = TvalDiff(&t1,&t2);
887 /****************************************************************************
888 Become a daemon, discarding the controlling terminal.
889 ****************************************************************************/
891 void become_daemon(BOOL Fork, BOOL no_process_group)
899 /* detach from the terminal */
901 if (!no_process_group) setsid();
902 #elif defined(TIOCNOTTY)
903 if (!no_process_group) {
904 int i = sys_open("/dev/tty", O_RDWR, 0);
906 ioctl(i, (int) TIOCNOTTY, (char *)0);
910 #endif /* HAVE_SETSID */
912 /* Close fd's 0,1,2. Needed if started by rsh */
913 close_low_fds(False); /* Don't close stderr, let the debug system
914 attach it to the logfile */
917 /****************************************************************************
918 Put up a yes/no prompt.
919 ****************************************************************************/
926 if (!fgets(ans,sizeof(ans)-1,stdin))
929 if (*ans == 'y' || *ans == 'Y')
935 #if defined(PARANOID_MALLOC_CHECKER)
937 /****************************************************************************
938 Internal malloc wrapper. Externally visible.
939 ****************************************************************************/
941 void *malloc_(size_t size)
948 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
951 /****************************************************************************
952 Internal calloc wrapper. Not externally visible.
953 ****************************************************************************/
955 static void *calloc_(size_t count, size_t size)
957 if (size == 0 || count == 0) {
961 return calloc(count, size);
962 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
965 /****************************************************************************
966 Internal realloc wrapper. Not externally visible.
967 ****************************************************************************/
969 static void *realloc_(void *ptr, size_t size)
972 return realloc(ptr, size);
973 #define realloc(p,s) __ERROR_DONT_USE_RELLOC_DIRECTLY
976 #endif /* PARANOID_MALLOC_CHECKER */
978 /****************************************************************************
980 ****************************************************************************/
982 void *malloc_array(size_t el_size, unsigned int count)
984 if (count >= MAX_ALLOC_SIZE/el_size) {
988 if (el_size == 0 || count == 0) {
991 #if defined(PARANOID_MALLOC_CHECKER)
992 return malloc_(el_size*count);
994 return malloc(el_size*count);
998 /****************************************************************************
1000 ****************************************************************************/
1002 void *memalign_array(size_t el_size, size_t align, unsigned int count)
1004 if (count >= MAX_ALLOC_SIZE/el_size) {
1008 return sys_memalign(align, el_size*count);
1011 /****************************************************************************
1013 ****************************************************************************/
1015 void *calloc_array(size_t size, size_t nmemb)
1017 if (nmemb >= MAX_ALLOC_SIZE/size) {
1020 if (size == 0 || nmemb == 0) {
1023 #if defined(PARANOID_MALLOC_CHECKER)
1024 return calloc_(nmemb, size);
1026 return calloc(nmemb, size);
1030 /****************************************************************************
1031 Expand a pointer to be a particular size.
1032 Note that this version of Realloc has an extra parameter that decides
1033 whether to free the passed in storage on allocation failure or if the
1036 This is designed for use in the typical idiom of :
1038 p = SMB_REALLOC(p, size)
1043 and not to have to keep track of the old 'p' contents to free later, nor
1044 to worry if the size parameter was zero. In the case where NULL is returned
1045 we guarentee that p has been freed.
1047 If free later semantics are desired, then pass 'free_old_on_error' as False which
1048 guarentees that the old contents are not freed on error, even if size == 0. To use
1051 tmp = SMB_REALLOC_KEEP_OLD_ON_ERROR(p, size);
1059 Changes were instigated by Coverity error checking. JRA.
1060 ****************************************************************************/
1062 void *Realloc(void *p, size_t size, BOOL free_old_on_error)
1067 if (free_old_on_error) {
1070 DEBUG(2,("Realloc asked for 0 bytes\n"));
1074 #if defined(PARANOID_MALLOC_CHECKER)
1076 ret = (void *)malloc_(size);
1078 ret = (void *)realloc_(p,size);
1082 ret = (void *)malloc(size);
1084 ret = (void *)realloc(p,size);
1089 if (free_old_on_error && p) {
1092 DEBUG(0,("Memory allocation error: failed to expand to %d bytes\n",(int)size));
1098 /****************************************************************************
1100 ****************************************************************************/
1102 void *realloc_array(void *p, size_t el_size, unsigned int count, BOOL free_old_on_error)
1104 if (count >= MAX_ALLOC_SIZE/el_size) {
1105 if (free_old_on_error) {
1110 return Realloc(p, el_size*count, free_old_on_error);
1113 /****************************************************************************
1114 (Hopefully) efficient array append.
1115 ****************************************************************************/
1117 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
1118 void *element, void *_array, uint32 *num_elements,
1119 ssize_t *array_size)
1121 void **array = (void **)_array;
1123 if (*array_size < 0) {
1127 if (*array == NULL) {
1128 if (*array_size == 0) {
1132 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1136 *array = TALLOC(mem_ctx, element_size * (*array_size));
1137 if (*array == NULL) {
1142 if (*num_elements == *array_size) {
1145 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1149 *array = TALLOC_REALLOC(mem_ctx, *array,
1150 element_size * (*array_size));
1152 if (*array == NULL) {
1157 memcpy((char *)(*array) + element_size*(*num_elements),
1158 element, element_size);
1168 /****************************************************************************
1169 Free memory, checks for NULL.
1170 Use directly SAFE_FREE()
1171 Exists only because we need to pass a function pointer somewhere --SSS
1172 ****************************************************************************/
1174 void safe_free(void *p)
1179 /****************************************************************************
1180 Get my own name and IP.
1181 ****************************************************************************/
1183 BOOL get_myname(char *my_name)
1189 /* get my host name */
1190 if (gethostname(hostname, sizeof(hostname)) == -1) {
1191 DEBUG(0,("gethostname failed\n"));
1195 /* Ensure null termination. */
1196 hostname[sizeof(hostname)-1] = '\0';
1199 /* split off any parts after an initial . */
1200 char *p = strchr_m(hostname,'.');
1205 fstrcpy(my_name,hostname);
1211 /****************************************************************************
1212 Get my own domain name.
1213 ****************************************************************************/
1215 BOOL get_mydnsdomname(fstring my_domname)
1221 if (!get_mydnsfullname(domname)) {
1224 p = strchr_m(domname, '.');
1227 fstrcpy(my_domname, p);
1234 /****************************************************************************
1235 Interpret a protocol description string, with a default.
1236 ****************************************************************************/
1238 int interpret_protocol(const char *str,int def)
1240 if (strequal(str,"NT1"))
1241 return(PROTOCOL_NT1);
1242 if (strequal(str,"LANMAN2"))
1243 return(PROTOCOL_LANMAN2);
1244 if (strequal(str,"LANMAN1"))
1245 return(PROTOCOL_LANMAN1);
1246 if (strequal(str,"CORE"))
1247 return(PROTOCOL_CORE);
1248 if (strequal(str,"COREPLUS"))
1249 return(PROTOCOL_COREPLUS);
1250 if (strequal(str,"CORE+"))
1251 return(PROTOCOL_COREPLUS);
1253 DEBUG(0,("Unrecognised protocol level %s\n",str));
1259 #if (defined(HAVE_NETGROUP) && defined(WITH_AUTOMOUNT))
1260 /******************************************************************
1261 Remove any mount options such as -rsize=2048,wsize=2048 etc.
1262 Based on a fix from <Thomas.Hepper@icem.de>.
1263 *******************************************************************/
1265 static void strip_mount_options( pstring *str)
1269 while(*p && !isspace(*p))
1271 while(*p && isspace(*p))
1276 pstrcpy(tmp_str, p);
1277 pstrcpy(*str, tmp_str);
1282 /*******************************************************************
1283 Patch from jkf@soton.ac.uk
1284 Split Luke's automount_server into YP lookup and string splitter
1285 so can easily implement automount_path().
1286 As we may end up doing both, cache the last YP result.
1287 *******************************************************************/
1289 #ifdef WITH_NISPLUS_HOME
1290 char *automount_lookup(const char *user_name)
1292 static fstring last_key = "";
1293 static pstring last_value = "";
1295 char *nis_map = (char *)lp_nis_home_map_name();
1297 char buffer[NIS_MAXATTRVAL + 1];
1302 if (strcmp(user_name, last_key)) {
1303 slprintf(buffer, sizeof(buffer)-1, "[key=%s],%s", user_name, nis_map);
1304 DEBUG(5, ("NIS+ querystring: %s\n", buffer));
1306 if (result = nis_list(buffer, FOLLOW_PATH|EXPAND_NAME|HARD_LOOKUP, NULL, NULL)) {
1307 if (result->status != NIS_SUCCESS) {
1308 DEBUG(3, ("NIS+ query failed: %s\n", nis_sperrno(result->status)));
1309 fstrcpy(last_key, ""); pstrcpy(last_value, "");
1311 object = result->objects.objects_val;
1312 if (object->zo_data.zo_type == ENTRY_OBJ) {
1313 entry = &object->zo_data.objdata_u.en_data;
1314 DEBUG(5, ("NIS+ entry type: %s\n", entry->en_type));
1315 DEBUG(3, ("NIS+ result: %s\n", entry->en_cols.en_cols_val[1].ec_value.ec_value_val));
1317 pstrcpy(last_value, entry->en_cols.en_cols_val[1].ec_value.ec_value_val);
1318 pstring_sub(last_value, "&", user_name);
1319 fstrcpy(last_key, user_name);
1323 nis_freeresult(result);
1326 strip_mount_options(&last_value);
1328 DEBUG(4, ("NIS+ Lookup: %s resulted in %s\n", user_name, last_value));
1331 #else /* WITH_NISPLUS_HOME */
1333 char *automount_lookup(const char *user_name)
1335 static fstring last_key = "";
1336 static pstring last_value = "";
1338 int nis_error; /* returned by yp all functions */
1339 char *nis_result; /* yp_match inits this */
1340 int nis_result_len; /* and set this */
1341 char *nis_domain; /* yp_get_default_domain inits this */
1342 char *nis_map = (char *)lp_nis_home_map_name();
1344 if ((nis_error = yp_get_default_domain(&nis_domain)) != 0) {
1345 DEBUG(3, ("YP Error: %s\n", yperr_string(nis_error)));
1349 DEBUG(5, ("NIS Domain: %s\n", nis_domain));
1351 if (!strcmp(user_name, last_key)) {
1352 nis_result = last_value;
1353 nis_result_len = strlen(last_value);
1356 if ((nis_error = yp_match(nis_domain, nis_map, user_name, strlen(user_name),
1357 &nis_result, &nis_result_len)) == 0) {
1358 fstrcpy(last_key, user_name);
1359 pstrcpy(last_value, nis_result);
1360 strip_mount_options(&last_value);
1362 } else if(nis_error == YPERR_KEY) {
1364 /* If Key lookup fails user home server is not in nis_map
1365 use default information for server, and home directory */
1367 DEBUG(3, ("YP Key not found: while looking up \"%s\" in map \"%s\"\n",
1368 user_name, nis_map));
1369 DEBUG(3, ("using defaults for server and home directory\n"));
1371 DEBUG(3, ("YP Error: \"%s\" while looking up \"%s\" in map \"%s\"\n",
1372 yperr_string(nis_error), user_name, nis_map));
1376 DEBUG(4, ("YP Lookup: %s resulted in %s\n", user_name, last_value));
1379 #endif /* WITH_NISPLUS_HOME */
1382 /****************************************************************************
1383 Check if a process exists. Does this work on all unixes?
1384 ****************************************************************************/
1386 BOOL process_exists(const struct server_id pid)
1388 if (procid_is_me(&pid)) {
1392 if (procid_is_local(&pid)) {
1393 return (kill(pid.pid,0) == 0 || errno != ESRCH);
1396 #ifdef CLUSTER_SUPPORT
1397 return ctdbd_process_exists(messaging_ctdbd_connection(), pid.vnn,
1404 BOOL process_exists_by_pid(pid_t pid)
1406 /* Doing kill with a non-positive pid causes messages to be
1407 * sent to places we don't want. */
1408 SMB_ASSERT(pid > 0);
1409 return(kill(pid,0) == 0 || errno != ESRCH);
1412 /*******************************************************************
1413 Convert a uid into a user name.
1414 ********************************************************************/
1416 const char *uidtoname(uid_t uid)
1418 TALLOC_CTX *ctx = talloc_tos();
1420 struct passwd *pass = NULL;
1422 pass = getpwuid_alloc(ctx,uid);
1424 name = talloc_strdup(ctx,pass->pw_name);
1427 name = talloc_asprintf(ctx,
1434 /*******************************************************************
1435 Convert a gid into a group name.
1436 ********************************************************************/
1438 char *gidtoname(gid_t gid)
1443 grp = getgrgid(gid);
1445 fstrcpy(name, grp->gr_name);
1448 slprintf(name,sizeof(name) - 1, "%d",(int)gid);
1450 return talloc_strdup(talloc_tos(), name);
1453 /*******************************************************************
1454 Convert a user name into a uid.
1455 ********************************************************************/
1457 uid_t nametouid(const char *name)
1459 struct passwd *pass;
1463 pass = getpwnam_alloc(NULL, name);
1470 u = (uid_t)strtol(name, &p, 0);
1471 if ((p != name) && (*p == '\0'))
1477 /*******************************************************************
1478 Convert a name to a gid_t if possible. Return -1 if not a group.
1479 ********************************************************************/
1481 gid_t nametogid(const char *name)
1487 g = (gid_t)strtol(name, &p, 0);
1488 if ((p != name) && (*p == '\0'))
1491 grp = sys_getgrnam(name);
1493 return(grp->gr_gid);
1497 /*******************************************************************
1498 Something really nasty happened - panic !
1499 ********************************************************************/
1501 void smb_panic(const char *const why)
1509 if (global_clobber_region_function) {
1510 DEBUG(0,("smb_panic: clobber_region() last called from [%s(%u)]\n",
1511 global_clobber_region_function,
1512 global_clobber_region_line));
1517 DEBUG(0,("PANIC (pid %llu): %s\n",
1518 (unsigned long long)sys_getpid(), why));
1521 cmd = lp_panic_action();
1523 DEBUG(0, ("smb_panic(): calling panic action [%s]\n", cmd));
1524 result = system(cmd);
1527 DEBUG(0, ("smb_panic(): fork failed in panic action: %s\n",
1530 DEBUG(0, ("smb_panic(): action returned status %d\n",
1531 WEXITSTATUS(result)));
1537 /*******************************************************************
1538 Print a backtrace of the stack to the debug log. This function
1539 DELIBERATELY LEAKS MEMORY. The expectation is that you should
1540 exit shortly after calling it.
1541 ********************************************************************/
1543 #ifdef HAVE_LIBUNWIND_H
1544 #include <libunwind.h>
1547 #ifdef HAVE_EXECINFO_H
1548 #include <execinfo.h>
1551 #ifdef HAVE_LIBEXC_H
1555 void log_stack_trace(void)
1557 #ifdef HAVE_LIBUNWIND
1558 /* Try to use libunwind before any other technique since on ia64
1559 * libunwind correctly walks the stack in more circumstances than
1562 unw_cursor_t cursor;
1567 unw_word_t ip, sp, off;
1569 procname[sizeof(procname) - 1] = '\0';
1571 if (unw_getcontext(&uc) != 0) {
1572 goto libunwind_failed;
1575 if (unw_init_local(&cursor, &uc) != 0) {
1576 goto libunwind_failed;
1579 DEBUG(0, ("BACKTRACE:\n"));
1583 unw_get_reg(&cursor, UNW_REG_IP, &ip);
1584 unw_get_reg(&cursor, UNW_REG_SP, &sp);
1586 switch (unw_get_proc_name(&cursor,
1587 procname, sizeof(procname) - 1, &off) ) {
1591 /* Name truncated. */
1592 DEBUGADD(0, (" #%u %s + %#llx [ip=%#llx] [sp=%#llx]\n",
1593 i, procname, (long long)off,
1594 (long long)ip, (long long) sp));
1597 /* case -UNW_ENOINFO: */
1598 /* case -UNW_EUNSPEC: */
1599 /* No symbol name found. */
1600 DEBUGADD(0, (" #%u %s [ip=%#llx] [sp=%#llx]\n",
1601 i, "<unknown symbol>",
1602 (long long)ip, (long long) sp));
1605 } while (unw_step(&cursor) > 0);
1610 DEBUG(0, ("unable to produce a stack trace with libunwind\n"));
1612 #elif HAVE_BACKTRACE_SYMBOLS
1613 void *backtrace_stack[BACKTRACE_STACK_SIZE];
1614 size_t backtrace_size;
1615 char **backtrace_strings;
1617 /* get the backtrace (stack frames) */
1618 backtrace_size = backtrace(backtrace_stack,BACKTRACE_STACK_SIZE);
1619 backtrace_strings = backtrace_symbols(backtrace_stack, backtrace_size);
1621 DEBUG(0, ("BACKTRACE: %lu stack frames:\n",
1622 (unsigned long)backtrace_size));
1624 if (backtrace_strings) {
1627 for (i = 0; i < backtrace_size; i++)
1628 DEBUGADD(0, (" #%u %s\n", i, backtrace_strings[i]));
1630 /* Leak the backtrace_strings, rather than risk what free() might do */
1635 /* The IRIX libexc library provides an API for unwinding the stack. See
1636 * libexc(3) for details. Apparantly trace_back_stack leaks memory, but
1637 * since we are about to abort anyway, it hardly matters.
1640 #define NAMESIZE 32 /* Arbitrary */
1642 __uint64_t addrs[BACKTRACE_STACK_SIZE];
1643 char * names[BACKTRACE_STACK_SIZE];
1644 char namebuf[BACKTRACE_STACK_SIZE * NAMESIZE];
1651 ZERO_ARRAY(namebuf);
1653 /* We need to be root so we can open our /proc entry to walk
1654 * our stack. It also helps when we want to dump core.
1658 for (i = 0; i < BACKTRACE_STACK_SIZE; i++) {
1659 names[i] = namebuf + (i * NAMESIZE);
1662 levels = trace_back_stack(0, addrs, names,
1663 BACKTRACE_STACK_SIZE, NAMESIZE - 1);
1665 DEBUG(0, ("BACKTRACE: %d stack frames:\n", levels));
1666 for (i = 0; i < levels; i++) {
1667 DEBUGADD(0, (" #%d 0x%llx %s\n", i, addrs[i], names[i]));
1672 DEBUG(0, ("unable to produce a stack trace on this platform\n"));
1676 /*******************************************************************
1677 A readdir wrapper which just returns the file name.
1678 ********************************************************************/
1680 const char *readdirname(SMB_STRUCT_DIR *p)
1682 SMB_STRUCT_DIRENT *ptr;
1688 ptr = (SMB_STRUCT_DIRENT *)sys_readdir(p);
1692 dname = ptr->d_name;
1699 #ifdef HAVE_BROKEN_READDIR_NAME
1700 /* using /usr/ucb/cc is BAD */
1704 return talloc_strdup(talloc_tos(), dname);
1707 /*******************************************************************
1708 Utility function used to decide if the last component
1709 of a path matches a (possibly wildcarded) entry in a namelist.
1710 ********************************************************************/
1712 BOOL is_in_path(const char *name, name_compare_entry *namelist, BOOL case_sensitive)
1714 const char *last_component;
1716 /* if we have no list it's obviously not in the path */
1717 if((namelist == NULL ) || ((namelist != NULL) && (namelist[0].name == NULL))) {
1721 DEBUG(8, ("is_in_path: %s\n", name));
1723 /* Get the last component of the unix name. */
1724 last_component = strrchr_m(name, '/');
1725 if (!last_component) {
1726 last_component = name;
1728 last_component++; /* Go past '/' */
1731 for(; namelist->name != NULL; namelist++) {
1732 if(namelist->is_wild) {
1733 if (mask_match(last_component, namelist->name, case_sensitive)) {
1734 DEBUG(8,("is_in_path: mask match succeeded\n"));
1738 if((case_sensitive && (strcmp(last_component, namelist->name) == 0))||
1739 (!case_sensitive && (StrCaseCmp(last_component, namelist->name) == 0))) {
1740 DEBUG(8,("is_in_path: match succeeded\n"));
1745 DEBUG(8,("is_in_path: match not found\n"));
1749 /*******************************************************************
1750 Strip a '/' separated list into an array of
1751 name_compare_enties structures suitable for
1752 passing to is_in_path(). We do this for
1753 speed so we can pre-parse all the names in the list
1754 and don't do it for each call to is_in_path().
1755 namelist is modified here and is assumed to be
1756 a copy owned by the caller.
1757 We also check if the entry contains a wildcard to
1758 remove a potentially expensive call to mask_match
1760 ********************************************************************/
1762 void set_namearray(name_compare_entry **ppname_array, char *namelist)
1765 char *nameptr = namelist;
1766 int num_entries = 0;
1769 (*ppname_array) = NULL;
1771 if((nameptr == NULL ) || ((nameptr != NULL) && (*nameptr == '\0')))
1774 /* We need to make two passes over the string. The
1775 first to count the number of elements, the second
1780 if ( *nameptr == '/' ) {
1781 /* cope with multiple (useless) /s) */
1785 /* find the next / */
1786 name_end = strchr_m(nameptr, '/');
1788 /* oops - the last check for a / didn't find one. */
1789 if (name_end == NULL)
1792 /* next segment please */
1793 nameptr = name_end + 1;
1797 if(num_entries == 0)
1800 if(( (*ppname_array) = SMB_MALLOC_ARRAY(name_compare_entry, num_entries + 1)) == NULL) {
1801 DEBUG(0,("set_namearray: malloc fail\n"));
1805 /* Now copy out the names */
1809 if ( *nameptr == '/' ) {
1810 /* cope with multiple (useless) /s) */
1814 /* find the next / */
1815 if ((name_end = strchr_m(nameptr, '/')) != NULL)
1818 /* oops - the last check for a / didn't find one. */
1819 if(name_end == NULL)
1822 (*ppname_array)[i].is_wild = ms_has_wild(nameptr);
1823 if(((*ppname_array)[i].name = SMB_STRDUP(nameptr)) == NULL) {
1824 DEBUG(0,("set_namearray: malloc fail (1)\n"));
1828 /* next segment please */
1829 nameptr = name_end + 1;
1833 (*ppname_array)[i].name = NULL;
1838 /****************************************************************************
1839 Routine to free a namearray.
1840 ****************************************************************************/
1842 void free_namearray(name_compare_entry *name_array)
1846 if(name_array == NULL)
1849 for(i=0; name_array[i].name!=NULL; i++)
1850 SAFE_FREE(name_array[i].name);
1851 SAFE_FREE(name_array);
1855 #define DBGC_CLASS DBGC_LOCKING
1857 /****************************************************************************
1858 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
1859 is dealt with in posix.c
1860 Returns True if the lock was granted, False otherwise.
1861 ****************************************************************************/
1863 BOOL fcntl_lock(int fd, int op, SMB_OFF_T offset, SMB_OFF_T count, int type)
1865 SMB_STRUCT_FLOCK lock;
1868 DEBUG(8,("fcntl_lock fd=%d op=%d offset=%.0f count=%.0f type=%d\n",
1869 fd,op,(double)offset,(double)count,type));
1872 lock.l_whence = SEEK_SET;
1873 lock.l_start = offset;
1877 ret = sys_fcntl_ptr(fd,op,&lock);
1881 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
1882 (double)offset,(double)count,op,type,strerror(errno)));
1887 /* everything went OK */
1888 DEBUG(8,("fcntl_lock: Lock call successful\n"));
1893 /****************************************************************************
1894 Simple routine to query existing file locks. Cruft in NFS and 64->32 bit mapping
1895 is dealt with in posix.c
1896 Returns True if we have information regarding this lock region (and returns
1897 F_UNLCK in *ptype if the region is unlocked). False if the call failed.
1898 ****************************************************************************/
1900 BOOL fcntl_getlock(int fd, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid)
1902 SMB_STRUCT_FLOCK lock;
1905 DEBUG(8,("fcntl_getlock fd=%d offset=%.0f count=%.0f type=%d\n",
1906 fd,(double)*poffset,(double)*pcount,*ptype));
1908 lock.l_type = *ptype;
1909 lock.l_whence = SEEK_SET;
1910 lock.l_start = *poffset;
1911 lock.l_len = *pcount;
1914 ret = sys_fcntl_ptr(fd,SMB_F_GETLK,&lock);
1918 DEBUG(3,("fcntl_getlock: lock request failed at offset %.0f count %.0f type %d (%s)\n",
1919 (double)*poffset,(double)*pcount,*ptype,strerror(errno)));
1924 *ptype = lock.l_type;
1925 *poffset = lock.l_start;
1926 *pcount = lock.l_len;
1929 DEBUG(3,("fcntl_getlock: fd %d is returned info %d pid %u\n",
1930 fd, (int)lock.l_type, (unsigned int)lock.l_pid));
1935 #define DBGC_CLASS DBGC_ALL
1937 /*******************************************************************
1938 Is the name specified one of my netbios names.
1939 Returns true if it is equal, false otherwise.
1940 ********************************************************************/
1942 BOOL is_myname(const char *s)
1947 for (n=0; my_netbios_names(n); n++) {
1948 if (strequal(my_netbios_names(n), s)) {
1953 DEBUG(8, ("is_myname(\"%s\") returns %d\n", s, ret));
1957 /*******************************************************************
1958 Is the name specified our workgroup/domain.
1959 Returns true if it is equal, false otherwise.
1960 ********************************************************************/
1962 BOOL is_myworkgroup(const char *s)
1966 if (strequal(s, lp_workgroup())) {
1970 DEBUG(8, ("is_myworkgroup(\"%s\") returns %d\n", s, ret));
1974 /*******************************************************************
1975 we distinguish between 2K and XP by the "Native Lan Manager" string
1976 WinXP => "Windows 2002 5.1"
1977 WinXP 64bit => "Windows XP 5.2"
1978 Win2k => "Windows 2000 5.0"
1979 NT4 => "Windows NT 4.0"
1980 Win9x => "Windows 4.0"
1981 Windows 2003 doesn't set the native lan manager string but
1982 they do set the domain to "Windows 2003 5.2" (probably a bug).
1983 ********************************************************************/
1985 void ra_lanman_string( const char *native_lanman )
1987 if ( strcmp( native_lanman, "Windows 2002 5.1" ) == 0 )
1988 set_remote_arch( RA_WINXP );
1989 else if ( strcmp( native_lanman, "Windows XP 5.2" ) == 0 )
1990 set_remote_arch( RA_WINXP );
1991 else if ( strcmp( native_lanman, "Windows Server 2003 5.2" ) == 0 )
1992 set_remote_arch( RA_WIN2K3 );
1995 /*******************************************************************
1996 Set the horrid remote_arch string based on an enum.
1997 ********************************************************************/
1999 void set_remote_arch(enum remote_arch_types type)
2004 fstrcpy(remote_arch, "WfWg");
2007 fstrcpy(remote_arch, "OS2");
2010 fstrcpy(remote_arch, "Win95");
2013 fstrcpy(remote_arch, "WinNT");
2016 fstrcpy(remote_arch, "Win2K");
2019 fstrcpy(remote_arch, "WinXP");
2022 fstrcpy(remote_arch, "Win2K3");
2025 fstrcpy(remote_arch, "Vista");
2028 fstrcpy(remote_arch,"Samba");
2031 fstrcpy(remote_arch,"CIFSFS");
2034 ra_type = RA_UNKNOWN;
2035 fstrcpy(remote_arch, "UNKNOWN");
2039 DEBUG(10,("set_remote_arch: Client arch is \'%s\'\n", remote_arch));
2042 /*******************************************************************
2043 Get the remote_arch type.
2044 ********************************************************************/
2046 enum remote_arch_types get_remote_arch(void)
2051 void print_asc(int level, const unsigned char *buf,int len)
2055 DEBUG(level,("%c", isprint(buf[i])?buf[i]:'.'));
2058 void dump_data(int level, const unsigned char *buf1,int len)
2060 const unsigned char *buf = (const unsigned char *)buf1;
2064 if (!DEBUGLVL(level)) return;
2066 DEBUGADD(level,("[%03X] ",i));
2068 DEBUGADD(level,("%02X ",(int)buf[i]));
2070 if (i%8 == 0) DEBUGADD(level,(" "));
2072 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
2073 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
2074 if (i<len) DEBUGADD(level,("[%03X] ",i));
2080 DEBUGADD(level,(" "));
2081 if (n>8) DEBUGADD(level,(" "));
2082 while (n--) DEBUGADD(level,(" "));
2084 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
2086 if (n>0) print_asc(level,&buf[i-n],n);
2087 DEBUGADD(level,("\n"));
2091 void dump_data_pw(const char *msg, const uchar * data, size_t len)
2093 #ifdef DEBUG_PASSWORD
2094 DEBUG(11, ("%s", msg));
2095 if (data != NULL && len > 0)
2097 dump_data(11, data, len);
2102 char *tab_depth(int depth)
2104 static pstring spaces;
2105 memset(spaces, ' ', depth * 4);
2106 spaces[depth * 4] = 0;
2110 /*****************************************************************************
2111 Provide a checksum on a string
2113 Input: s - the null-terminated character string for which the checksum
2116 Output: The checksum value calculated for s.
2117 *****************************************************************************/
2119 int str_checksum(const char *s)
2127 res ^= (c << (i % 15)) ^ (c >> (15-(i%15)));
2134 /*****************************************************************
2135 Zero a memory area then free it. Used to catch bugs faster.
2136 *****************************************************************/
2138 void zero_free(void *p, size_t size)
2144 /*****************************************************************
2145 Set our open file limit to a requested max and return the limit.
2146 *****************************************************************/
2148 int set_maxfiles(int requested_max)
2150 #if (defined(HAVE_GETRLIMIT) && defined(RLIMIT_NOFILE))
2152 int saved_current_limit;
2154 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2155 DEBUG(0,("set_maxfiles: getrlimit (1) for RLIMIT_NOFILE failed with error %s\n",
2158 return requested_max;
2162 * Set the fd limit to be real_max_open_files + MAX_OPEN_FUDGEFACTOR to
2163 * account for the extra fd we need
2164 * as well as the log files and standard
2165 * handles etc. Save the limit we want to set in case
2166 * we are running on an OS that doesn't support this limit (AIX)
2167 * which always returns RLIM_INFINITY for rlp.rlim_max.
2170 /* Try raising the hard (max) limit to the requested amount. */
2172 #if defined(RLIM_INFINITY)
2173 if (rlp.rlim_max != RLIM_INFINITY) {
2174 int orig_max = rlp.rlim_max;
2176 if ( rlp.rlim_max < requested_max )
2177 rlp.rlim_max = requested_max;
2179 /* This failing is not an error - many systems (Linux) don't
2180 support our default request of 10,000 open files. JRA. */
2182 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2183 DEBUG(3,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d max files failed with error %s\n",
2184 (int)rlp.rlim_max, strerror(errno) ));
2186 /* Set failed - restore original value from get. */
2187 rlp.rlim_max = orig_max;
2192 /* Now try setting the soft (current) limit. */
2194 saved_current_limit = rlp.rlim_cur = MIN(requested_max,rlp.rlim_max);
2196 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2197 DEBUG(0,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d files failed with error %s\n",
2198 (int)rlp.rlim_cur, strerror(errno) ));
2200 return saved_current_limit;
2203 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2204 DEBUG(0,("set_maxfiles: getrlimit (2) for RLIMIT_NOFILE failed with error %s\n",
2207 return saved_current_limit;
2210 #if defined(RLIM_INFINITY)
2211 if(rlp.rlim_cur == RLIM_INFINITY)
2212 return saved_current_limit;
2215 if((int)rlp.rlim_cur > saved_current_limit)
2216 return saved_current_limit;
2218 return rlp.rlim_cur;
2219 #else /* !defined(HAVE_GETRLIMIT) || !defined(RLIMIT_NOFILE) */
2221 * No way to know - just guess...
2223 return requested_max;
2227 /*****************************************************************
2228 Possibly replace mkstemp if it is broken.
2229 *****************************************************************/
2231 int smb_mkstemp(char *name_template)
2233 #if HAVE_SECURE_MKSTEMP
2234 return mkstemp(name_template);
2236 /* have a reasonable go at emulating it. Hope that
2237 the system mktemp() isn't completly hopeless */
2238 char *p = mktemp(name_template);
2241 return open(p, O_CREAT|O_EXCL|O_RDWR, 0600);
2245 /*****************************************************************
2246 malloc that aborts with smb_panic on fail or zero size.
2247 *****************************************************************/
2249 void *smb_xmalloc_array(size_t size, unsigned int count)
2253 smb_panic("smb_xmalloc_array: called with zero size");
2255 if (count >= MAX_ALLOC_SIZE/size) {
2256 smb_panic("smb_xmalloc_array: alloc size too large");
2258 if ((p = SMB_MALLOC(size*count)) == NULL) {
2259 DEBUG(0, ("smb_xmalloc_array failed to allocate %lu * %lu bytes\n",
2260 (unsigned long)size, (unsigned long)count));
2261 smb_panic("smb_xmalloc_array: malloc failed");
2267 Memdup with smb_panic on fail.
2270 void *smb_xmemdup(const void *p, size_t size)
2273 p2 = SMB_XMALLOC_ARRAY(unsigned char,size);
2274 memcpy(p2, p, size);
2279 strdup that aborts on malloc fail.
2282 char *smb_xstrdup(const char *s)
2284 #if defined(PARANOID_MALLOC_CHECKER)
2291 #define strdup rep_strdup
2294 char *s1 = strdup(s);
2295 #if defined(PARANOID_MALLOC_CHECKER)
2299 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
2302 smb_panic("smb_xstrdup: malloc failed");
2309 strndup that aborts on malloc fail.
2312 char *smb_xstrndup(const char *s, size_t n)
2314 #if defined(PARANOID_MALLOC_CHECKER)
2320 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
2322 #define strndup rep_strndup
2325 char *s1 = strndup(s, n);
2326 #if defined(PARANOID_MALLOC_CHECKER)
2330 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
2333 smb_panic("smb_xstrndup: malloc failed");
2339 vasprintf that aborts on malloc fail
2342 int smb_xvasprintf(char **ptr, const char *format, va_list ap)
2349 n = vasprintf(ptr, format, ap2);
2350 if (n == -1 || ! *ptr) {
2351 smb_panic("smb_xvasprintf: out of memory");
2356 /*****************************************************************
2357 Like strdup but for memory.
2358 *****************************************************************/
2360 void *memdup(const void *p, size_t size)
2365 p2 = SMB_MALLOC(size);
2368 memcpy(p2, p, size);
2372 /*****************************************************************
2373 Get local hostname and cache result.
2374 *****************************************************************/
2376 char *myhostname(void)
2384 /*****************************************************************
2385 A useful function for returning a path in the Samba lock directory.
2386 *****************************************************************/
2388 char *lock_path(const char *name)
2392 pstrcpy(fname,lp_lockdir());
2393 trim_char(fname,'\0','/');
2395 if (!directory_exist(fname,NULL))
2399 pstrcat(fname,name);
2401 return talloc_strdup(talloc_tos(), fname);
2404 /*****************************************************************
2405 A useful function for returning a path in the Samba pid directory.
2406 *****************************************************************/
2408 char *pid_path(const char *name)
2412 pstrcpy(fname,lp_piddir());
2413 trim_char(fname,'\0','/');
2415 if (!directory_exist(fname,NULL))
2419 pstrcat(fname,name);
2421 return talloc_strdup(talloc_tos(), fname);
2425 * @brief Returns an absolute path to a file in the Samba lib directory.
2427 * @param name File to find, relative to LIBDIR.
2429 * @retval Pointer to a static #pstring containing the full path.
2432 char *lib_path(const char *name)
2434 return talloc_asprintf(talloc_tos(), "%s/%s", dyn_LIBDIR, name);
2438 * @brief Returns the platform specific shared library extension.
2440 * @retval Pointer to a static #fstring containing the extension.
2443 const char *shlib_ext(void)
2445 return dyn_SHLIBEXT;
2448 /*******************************************************************
2449 Given a filename - get its directory name
2450 NB: Returned in static storage. Caveats:
2451 o If caller wishes to preserve, they should copy.
2452 ********************************************************************/
2454 char *parent_dirname(const char *path)
2458 if (!parent_dirname_talloc(talloc_tos(), path, &parent, NULL)) {
2465 BOOL parent_dirname_talloc(TALLOC_CTX *mem_ctx, const char *dir,
2466 char **parent, const char **name)
2471 p = strrchr_m(dir, '/'); /* Find final '/', if any */
2474 if (!(*parent = talloc_strdup(mem_ctx, "."))) {
2485 if (!(*parent = TALLOC_ARRAY(mem_ctx, char, len+1))) {
2488 memcpy(*parent, dir, len);
2489 (*parent)[len] = '\0';
2497 /*******************************************************************
2498 Determine if a pattern contains any Microsoft wildcard characters.
2499 *******************************************************************/
2501 BOOL ms_has_wild(const char *s)
2505 if (lp_posix_pathnames()) {
2506 /* With posix pathnames no characters are wild. */
2510 while ((c = *s++)) {
2523 BOOL ms_has_wild_w(const smb_ucs2_t *s)
2526 if (!s) return False;
2527 while ((c = *s++)) {
2529 case UCS2_CHAR('*'):
2530 case UCS2_CHAR('?'):
2531 case UCS2_CHAR('<'):
2532 case UCS2_CHAR('>'):
2533 case UCS2_CHAR('"'):
2540 /*******************************************************************
2541 A wrapper that handles case sensitivity and the special handling
2543 *******************************************************************/
2545 BOOL mask_match(const char *string, const char *pattern, BOOL is_case_sensitive)
2547 if (strcmp(string,"..") == 0)
2549 if (strcmp(pattern,".") == 0)
2552 return ms_fnmatch(pattern, string, Protocol <= PROTOCOL_LANMAN2, is_case_sensitive) == 0;
2555 /*******************************************************************
2556 A wrapper that handles case sensitivity and the special handling
2557 of the ".." name. Varient that is only called by old search code which requires
2558 pattern translation.
2559 *******************************************************************/
2561 BOOL mask_match_search(const char *string, const char *pattern, BOOL is_case_sensitive)
2563 if (strcmp(string,"..") == 0)
2565 if (strcmp(pattern,".") == 0)
2568 return ms_fnmatch(pattern, string, True, is_case_sensitive) == 0;
2571 /*******************************************************************
2572 A wrapper that handles a list of patters and calls mask_match()
2573 on each. Returns True if any of the patterns match.
2574 *******************************************************************/
2576 BOOL mask_match_list(const char *string, char **list, int listLen, BOOL is_case_sensitive)
2578 while (listLen-- > 0) {
2579 if (mask_match(string, *list++, is_case_sensitive))
2585 /*********************************************************
2586 Recursive routine that is called by unix_wild_match.
2587 *********************************************************/
2589 static bool unix_do_match(const char *regexp, const char *str)
2593 for( p = regexp; *p && *str; ) {
2604 * Look for a character matching
2605 * the one after the '*'.
2609 return true; /* Automatic match */
2612 while(*str && (*p != *str))
2616 * Patch from weidel@multichart.de. In the case of the regexp
2617 * '*XX*' we want to ensure there are at least 2 'X' characters
2618 * in the string after the '*' for a match to be made.
2625 * Eat all the characters that match, but count how many there were.
2628 while(*str && (*p == *str)) {
2634 * Now check that if the regexp had n identical characters that
2635 * matchcount had at least that many matches.
2638 while ( *(p+1) && (*(p+1) == *p)) {
2643 if ( matchcount <= 0 )
2647 str--; /* We've eaten the match char after the '*' */
2649 if(unix_do_match(p, str))
2671 if (!*p && str[0] == '.' && str[1] == 0)
2674 if (!*str && *p == '?') {
2680 if(!*str && (*p == '*' && p[1] == '\0'))
2686 /*******************************************************************
2687 Simple case insensitive interface to a UNIX wildcard matcher.
2688 Returns True if match, False if not.
2689 *******************************************************************/
2691 bool unix_wild_match(const char *pattern, const char *string)
2693 TALLOC_CTX *ctx = talloc_stackframe();
2699 p2 = talloc_strdup(ctx,pattern);
2700 s2 = talloc_strdup(ctx,string);
2708 /* Remove any *? and ** from the pattern as they are meaningless */
2709 for(p = p2; *p; p++) {
2710 while( *p == '*' && (p[1] == '?' ||p[1] == '*')) {
2711 memmove(&p[1], &p[2], strlen(&p[2])+1);
2715 if (strequal(p2,"*")) {
2720 ret = unix_do_match(p2, s2);
2725 /**********************************************************************
2726 Converts a name to a fully qualified domain name.
2727 Returns true if lookup succeeded, false if not (then fqdn is set to name)
2728 Note we deliberately use gethostbyname here, not getaddrinfo as we want
2729 to examine the h_aliases and I don't know how to do that with getaddrinfo.
2730 ***********************************************************************/
2732 bool name_to_fqdn(fstring fqdn, const char *name)
2735 struct hostent *hp = gethostbyname(name);
2737 if (!hp || !hp->h_name || !*hp->h_name) {
2738 DEBUG(10,("name_to_fqdn: lookup for %s failed.\n", name));
2739 fstrcpy(fqdn, name);
2743 /* Find out if the fqdn is returned as an alias
2744 * to cope with /etc/hosts files where the first
2745 * name is not the fqdn but the short name */
2746 if (hp->h_aliases && (! strchr_m(hp->h_name, '.'))) {
2748 for (i = 0; hp->h_aliases[i]; i++) {
2749 if (strchr_m(hp->h_aliases[i], '.')) {
2750 full = hp->h_aliases[i];
2755 if (full && (StrCaseCmp(full, "localhost.localdomain") == 0)) {
2756 DEBUG(1, ("WARNING: your /etc/hosts file may be broken!\n"));
2757 DEBUGADD(1, (" Specifing the machine hostname for address 127.0.0.1 may lead\n"));
2758 DEBUGADD(1, (" to Kerberos authentication problems as localhost.localdomain\n"));
2759 DEBUGADD(1, (" may end up being used instead of the real machine FQDN.\n"));
2766 DEBUG(10,("name_to_fqdn: lookup for %s -> %s.\n", name, full));
2767 fstrcpy(fqdn, full);
2771 /**********************************************************************
2772 Extension to talloc_get_type: Abort on type mismatch
2773 ***********************************************************************/
2775 void *talloc_check_name_abort(const void *ptr, const char *name)
2779 result = talloc_check_name(ptr, name);
2783 DEBUG(0, ("Talloc type mismatch, expected %s, got %s\n",
2784 name, talloc_get_name(ptr)));
2785 smb_panic("talloc type mismatch");
2786 /* Keep the compiler happy */
2793 /*******************************************************************
2794 This routine is a trick to immediately catch errors when debugging
2795 with insure. A xterm with a gdb is popped up when insure catches
2796 a error. It is Linux specific.
2797 ********************************************************************/
2799 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
2804 /* you can get /usr/bin/backtrace from
2805 http://samba.org/ftp/unpacked/junkcode/backtrace */
2806 pstring cmd = "/usr/bin/backtrace %d";
2808 slprintf(pidstr, sizeof(pidstr)-1, "%d", sys_getpid());
2809 pstring_sub(cmd, "%d", pidstr);
2813 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
2814 fn = dlsym(h, "_Insure_trap_error");
2816 if (!h || h == _Insure_trap_error) {
2817 h = dlopen("/usr/local/parasoft/lib.linux2/libinsure.so", RTLD_LAZY);
2818 fn = dlsym(h, "_Insure_trap_error");
2822 ret = fn(a1, a2, a3, a4, a5, a6);
2830 uint32 map_share_mode_to_deny_mode(uint32 share_access, uint32 private_options)
2832 switch (share_access & ~FILE_SHARE_DELETE) {
2833 case FILE_SHARE_NONE:
2835 case FILE_SHARE_READ:
2837 case FILE_SHARE_WRITE:
2839 case FILE_SHARE_READ|FILE_SHARE_WRITE:
2842 if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_DOS) {
2844 } else if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_FCB) {
2851 pid_t procid_to_pid(const struct server_id *proc)
2856 static uint32 my_vnn = NONCLUSTER_VNN;
2858 void set_my_vnn(uint32 vnn)
2860 DEBUG(10, ("vnn pid %d = %u\n", (int)sys_getpid(), (unsigned int)vnn));
2864 uint32 get_my_vnn(void)
2869 struct server_id pid_to_procid(pid_t pid)
2871 struct server_id result;
2873 #ifdef CLUSTER_SUPPORT
2874 result.vnn = my_vnn;
2879 struct server_id procid_self(void)
2881 return pid_to_procid(sys_getpid());
2884 struct server_id server_id_self(void)
2886 return procid_self();
2889 BOOL procid_equal(const struct server_id *p1, const struct server_id *p2)
2891 if (p1->pid != p2->pid)
2893 #ifdef CLUSTER_SUPPORT
2894 if (p1->vnn != p2->vnn)
2900 BOOL cluster_id_equal(const struct server_id *id1,
2901 const struct server_id *id2)
2903 return procid_equal(id1, id2);
2906 BOOL procid_is_me(const struct server_id *pid)
2908 if (pid->pid != sys_getpid())
2910 #ifdef CLUSTER_SUPPORT
2911 if (pid->vnn != my_vnn)
2917 struct server_id interpret_pid(const char *pid_string)
2919 #ifdef CLUSTER_SUPPORT
2920 unsigned int vnn, pid;
2921 struct server_id result;
2922 if (sscanf(pid_string, "%u:%u", &vnn, &pid) == 2) {
2926 else if (sscanf(pid_string, "%u", &pid) == 1) {
2927 result.vnn = NONCLUSTER_VNN;
2931 result.vnn = NONCLUSTER_VNN;
2936 return pid_to_procid(atoi(pid_string));
2940 char *procid_str(TALLOC_CTX *mem_ctx, const struct server_id *pid)
2943 #ifdef CLUSTER_SUPPORT
2944 if (pid->vnn == NONCLUSTER_VNN) {
2945 fstr_sprintf(str, "%d", (int)pid->pid);
2948 fstr_sprintf(str, "%u:%d", (unsigned)pid->vnn, (int)pid->pid);
2951 fstr_sprintf(str, "%d", (int)pid->pid);
2953 return talloc_strdup(mem_ctx, str);
2956 char *procid_str_static(const struct server_id *pid)
2958 return procid_str(talloc_tos(), pid);
2961 BOOL procid_valid(const struct server_id *pid)
2963 return (pid->pid != -1);
2966 BOOL procid_is_local(const struct server_id *pid)
2968 #ifdef CLUSTER_SUPPORT
2969 return pid->vnn == my_vnn;
2975 int this_is_smp(void)
2977 #if defined(HAVE_SYSCONF)
2979 #if defined(SYSCONF_SC_NPROC_ONLN)
2980 return (sysconf(_SC_NPROC_ONLN) > 1) ? 1 : 0;
2981 #elif defined(SYSCONF_SC_NPROCESSORS_ONLN)
2982 return (sysconf(_SC_NPROCESSORS_ONLN) > 1) ? 1 : 0;
2992 /****************************************************************
2993 Check if an offset into a buffer is safe.
2994 If this returns True it's safe to indirect into the byte at
2996 ****************************************************************/
2998 BOOL is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3000 const char *end_base = buf_base + buf_len;
3001 char *end_ptr = ptr + off;
3003 if (!buf_base || !ptr) {
3007 if (end_base < buf_base || end_ptr < ptr) {
3008 return False; /* wrap. */
3011 if (end_ptr < end_base) {
3017 /****************************************************************
3018 Return a safe pointer into a buffer, or NULL.
3019 ****************************************************************/
3021 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3023 return is_offset_safe(buf_base, buf_len, ptr, off) ?
3027 /****************************************************************
3028 Return a safe pointer into a string within a buffer, or NULL.
3029 ****************************************************************/
3031 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3033 if (!is_offset_safe(buf_base, buf_len, ptr, off)) {
3036 /* Check if a valid string exists at this offset. */
3037 if (skip_string(buf_base,buf_len, ptr + off) == NULL) {
3043 /****************************************************************
3044 Return an SVAL at a pointer, or failval if beyond the end.
3045 ****************************************************************/
3047 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
3050 * Note we use off+1 here, not off+2 as SVAL accesses ptr[0] and ptr[1],
3053 if (!is_offset_safe(buf_base, buf_len, ptr, off+1)) {
3056 return SVAL(ptr,off);
3059 /****************************************************************
3060 Return an IVAL at a pointer, or failval if beyond the end.
3061 ****************************************************************/
3063 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
3066 * Note we use off+3 here, not off+4 as IVAL accesses
3067 * ptr[0] ptr[1] ptr[2] ptr[3] NOT ptr[4].
3069 if (!is_offset_safe(buf_base, buf_len, ptr, off+3)) {
3072 return IVAL(ptr,off);
3077 Disable these now we have checked all code paths and ensured
3078 NULL returns on zero request. JRA.
3080 /****************************************************************
3081 talloc wrapper functions that guarentee a null pointer return
3083 ****************************************************************/
3085 #ifndef MAX_TALLOC_SIZE
3086 #define MAX_TALLOC_SIZE 0x10000000
3090 * talloc and zero memory.
3091 * - returns NULL if size is zero.
3094 void *_talloc_zero_zeronull(const void *ctx, size_t size, const char *name)
3102 p = talloc_named_const(ctx, size, name);
3105 memset(p, '\0', size);
3112 * memdup with a talloc.
3113 * - returns NULL if size is zero.
3116 void *_talloc_memdup_zeronull(const void *t, const void *p, size_t size, const char *name)
3124 newp = talloc_named_const(t, size, name);
3126 memcpy(newp, p, size);
3133 * alloc an array, checking for integer overflow in the array size.
3134 * - returns NULL if count or el_size are zero.
3137 void *_talloc_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3139 if (count >= MAX_TALLOC_SIZE/el_size) {
3143 if (el_size == 0 || count == 0) {
3147 return talloc_named_const(ctx, el_size * count, name);
3151 * alloc an zero array, checking for integer overflow in the array size
3152 * - returns NULL if count or el_size are zero.
3155 void *_talloc_zero_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3157 if (count >= MAX_TALLOC_SIZE/el_size) {
3161 if (el_size == 0 || count == 0) {
3165 return _talloc_zero(ctx, el_size * count, name);
3169 * Talloc wrapper that returns NULL if size == 0.
3171 void *talloc_zeronull(const void *context, size_t size, const char *name)
3176 return talloc_named_const(context, size, name);