Make us clean under valgrind --leak-check=full by using talloc_autofree_context(...
[Samba.git] / source / lib / util.c
blob4b8b5975287506515db6fef49341e77d9645a036
1 /*
2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2001-2007
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/>.
24 #include "includes.h"
26 extern char *global_clobber_region_function;
27 extern unsigned int global_clobber_region_line;
29 /* Max allowable allococation - 256mb - 0x10000000 */
30 #define MAX_ALLOC_SIZE (1024*1024*256)
32 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
33 #ifdef WITH_NISPLUS_HOME
34 #ifdef BROKEN_NISPLUS_INCLUDE_FILES
36 * The following lines are needed due to buggy include files
37 * in Solaris 2.6 which define GROUP in both /usr/include/sys/acl.h and
38 * also in /usr/include/rpcsvc/nis.h. The definitions conflict. JRA.
39 * Also GROUP_OBJ is defined as 0x4 in /usr/include/sys/acl.h and as
40 * an enum in /usr/include/rpcsvc/nis.h.
43 #if defined(GROUP)
44 #undef GROUP
45 #endif
47 #if defined(GROUP_OBJ)
48 #undef GROUP_OBJ
49 #endif
51 #endif /* BROKEN_NISPLUS_INCLUDE_FILES */
53 #include <rpcsvc/nis.h>
55 #endif /* WITH_NISPLUS_HOME */
56 #endif /* HAVE_NETGROUP && WITH_AUTOMOUNT */
58 enum protocol_types Protocol = PROTOCOL_COREPLUS;
60 /* this is used by the chaining code */
61 int chain_size = 0;
63 static enum remote_arch_types ra_type = RA_UNKNOWN;
65 /***********************************************************************
66 Definitions for all names.
67 ***********************************************************************/
69 static char *smb_myname;
70 static char *smb_myworkgroup;
71 static char *smb_scope;
72 static int smb_num_netbios_names;
73 static char **smb_my_netbios_names;
75 /***********************************************************************
76 Allocate and set myname. Ensure upper case.
77 ***********************************************************************/
79 bool set_global_myname(const char *myname)
81 SAFE_FREE(smb_myname);
82 smb_myname = SMB_STRDUP(myname);
83 if (!smb_myname)
84 return False;
85 strupper_m(smb_myname);
86 return True;
89 const char *global_myname(void)
91 return smb_myname;
94 /***********************************************************************
95 Allocate and set myworkgroup. Ensure upper case.
96 ***********************************************************************/
98 bool set_global_myworkgroup(const char *myworkgroup)
100 SAFE_FREE(smb_myworkgroup);
101 smb_myworkgroup = SMB_STRDUP(myworkgroup);
102 if (!smb_myworkgroup)
103 return False;
104 strupper_m(smb_myworkgroup);
105 return True;
108 const char *lp_workgroup(void)
110 return smb_myworkgroup;
113 /***********************************************************************
114 Allocate and set scope. Ensure upper case.
115 ***********************************************************************/
117 bool set_global_scope(const char *scope)
119 SAFE_FREE(smb_scope);
120 smb_scope = SMB_STRDUP(scope);
121 if (!smb_scope)
122 return False;
123 strupper_m(smb_scope);
124 return True;
127 /*********************************************************************
128 Ensure scope is never null string.
129 *********************************************************************/
131 const char *global_scope(void)
133 if (!smb_scope)
134 set_global_scope("");
135 return smb_scope;
138 static void free_netbios_names_array(void)
140 int i;
142 for (i = 0; i < smb_num_netbios_names; i++)
143 SAFE_FREE(smb_my_netbios_names[i]);
145 SAFE_FREE(smb_my_netbios_names);
146 smb_num_netbios_names = 0;
149 static bool allocate_my_netbios_names_array(size_t number)
151 free_netbios_names_array();
153 smb_num_netbios_names = number + 1;
154 smb_my_netbios_names = SMB_MALLOC_ARRAY( char *, smb_num_netbios_names );
156 if (!smb_my_netbios_names)
157 return False;
159 memset(smb_my_netbios_names, '\0', sizeof(char *) * smb_num_netbios_names);
160 return True;
163 static bool set_my_netbios_names(const char *name, int i)
165 SAFE_FREE(smb_my_netbios_names[i]);
167 smb_my_netbios_names[i] = SMB_STRDUP(name);
168 if (!smb_my_netbios_names[i])
169 return False;
170 strupper_m(smb_my_netbios_names[i]);
171 return True;
174 /***********************************************************************
175 Free memory allocated to global objects
176 ***********************************************************************/
178 void gfree_names(void)
180 SAFE_FREE( smb_myname );
181 SAFE_FREE( smb_myworkgroup );
182 SAFE_FREE( smb_scope );
183 free_netbios_names_array();
184 free_local_machine_name();
187 void gfree_all( void )
189 gfree_names();
190 gfree_loadparm();
191 gfree_case_tables();
192 gfree_charcnv();
193 gfree_interfaces();
194 gfree_debugsyms();
197 const char *my_netbios_names(int i)
199 return smb_my_netbios_names[i];
202 bool set_netbios_aliases(const char **str_array)
204 size_t namecount;
206 /* Work out the max number of netbios aliases that we have */
207 for( namecount=0; str_array && (str_array[namecount] != NULL); namecount++ )
210 if ( global_myname() && *global_myname())
211 namecount++;
213 /* Allocate space for the netbios aliases */
214 if (!allocate_my_netbios_names_array(namecount))
215 return False;
217 /* Use the global_myname string first */
218 namecount=0;
219 if ( global_myname() && *global_myname()) {
220 set_my_netbios_names( global_myname(), namecount );
221 namecount++;
224 if (str_array) {
225 size_t i;
226 for ( i = 0; str_array[i] != NULL; i++) {
227 size_t n;
228 bool duplicate = False;
230 /* Look for duplicates */
231 for( n=0; n<namecount; n++ ) {
232 if( strequal( str_array[i], my_netbios_names(n) ) ) {
233 duplicate = True;
234 break;
237 if (!duplicate) {
238 if (!set_my_netbios_names(str_array[i], namecount))
239 return False;
240 namecount++;
244 return True;
247 /****************************************************************************
248 Common name initialization code.
249 ****************************************************************************/
251 bool init_names(void)
253 int n;
255 if (global_myname() == NULL || *global_myname() == '\0') {
256 if (!set_global_myname(myhostname())) {
257 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
258 return False;
262 if (!set_netbios_aliases(lp_netbios_aliases())) {
263 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
264 return False;
267 set_local_machine_name(global_myname(),false);
269 DEBUG( 5, ("Netbios name list:-\n") );
270 for( n=0; my_netbios_names(n); n++ ) {
271 DEBUGADD( 5, ("my_netbios_names[%d]=\"%s\"\n",
272 n, my_netbios_names(n) ) );
275 return( True );
278 /**************************************************************************n
279 Code to cope with username/password auth options from the commandline.
280 Used mainly in client tools.
281 ****************************************************************************/
283 static struct user_auth_info cmdline_auth_info = {
284 NULL, /* username */
285 NULL, /* password */
286 false, /* got_pass */
287 false, /* use_kerberos */
288 Undefined, /* signing state */
289 false, /* smb_encrypt */
290 false /* use machine account */
293 const char *get_cmdline_auth_info_username(void)
295 if (!cmdline_auth_info.username) {
296 return "";
298 return cmdline_auth_info.username;
301 void set_cmdline_auth_info_username(const char *username)
303 SAFE_FREE(cmdline_auth_info.username);
304 cmdline_auth_info.username = SMB_STRDUP(username);
305 if (!cmdline_auth_info.username) {
306 exit(ENOMEM);
310 const char *get_cmdline_auth_info_password(void)
312 if (!cmdline_auth_info.password) {
313 return "";
315 return cmdline_auth_info.password;
318 void set_cmdline_auth_info_password(const char *password)
320 SAFE_FREE(cmdline_auth_info.password);
321 cmdline_auth_info.password = SMB_STRDUP(password);
322 if (!cmdline_auth_info.password) {
323 exit(ENOMEM);
325 cmdline_auth_info.got_pass = true;
328 bool set_cmdline_auth_info_signing_state(const char *arg)
330 cmdline_auth_info.signing_state = -1;
331 if (strequal(arg, "off") || strequal(arg, "no") ||
332 strequal(arg, "false")) {
333 cmdline_auth_info.signing_state = false;
334 } else if (strequal(arg, "on") || strequal(arg, "yes") ||
335 strequal(arg, "true") || strequal(arg, "auto")) {
336 cmdline_auth_info.signing_state = true;
337 } else if (strequal(arg, "force") || strequal(arg, "required") ||
338 strequal(arg, "forced")) {
339 cmdline_auth_info.signing_state = Required;
340 } else {
341 return false;
343 return true;
346 int get_cmdline_auth_info_signing_state(void)
348 return cmdline_auth_info.signing_state;
351 void set_cmdline_auth_info_use_kerberos(bool b)
353 cmdline_auth_info.use_kerberos = b;
356 bool get_cmdline_auth_info_use_kerberos(void)
358 return cmdline_auth_info.use_kerberos;
361 /* This should only be used by lib/popt_common.c JRA */
362 void set_cmdline_auth_info_use_krb5_ticket(void)
364 cmdline_auth_info.use_kerberos = true;
365 cmdline_auth_info.got_pass = true;
368 /* This should only be used by lib/popt_common.c JRA */
369 void set_cmdline_auth_info_smb_encrypt(void)
371 cmdline_auth_info.smb_encrypt = true;
374 void set_cmdline_auth_info_use_machine_account(void)
376 cmdline_auth_info.use_machine_account = true;
379 bool get_cmdline_auth_info_got_pass(void)
381 return cmdline_auth_info.got_pass;
384 bool get_cmdline_auth_info_smb_encrypt(void)
386 return cmdline_auth_info.smb_encrypt;
389 bool get_cmdline_auth_info_use_machine_account(void)
391 return cmdline_auth_info.use_machine_account;
394 bool get_cmdline_auth_info_copy(struct user_auth_info *info)
396 *info = cmdline_auth_info;
397 /* Now re-alloc the strings. */
398 info->username = SMB_STRDUP(get_cmdline_auth_info_username());
399 info->password = SMB_STRDUP(get_cmdline_auth_info_password());
400 if (!info->username || !info->password) {
401 return false;
403 return true;
406 bool set_cmdline_auth_info_machine_account_creds(void)
408 char *pass = NULL;
409 char *account = NULL;
411 if (!get_cmdline_auth_info_use_machine_account()) {
412 return false;
415 if (!secrets_init()) {
416 d_printf("ERROR: Unable to open secrets database\n");
417 return false;
420 if (asprintf(&account, "%s$@%s", global_myname(), lp_realm()) < 0) {
421 return false;
424 pass = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
425 if (!pass) {
426 d_printf("ERROR: Unable to fetch machine password for "
427 "%s in domain %s\n",
428 account, lp_workgroup());
429 SAFE_FREE(account);
430 return false;
433 set_cmdline_auth_info_username(account);
434 set_cmdline_auth_info_password(pass);
436 SAFE_FREE(account);
437 SAFE_FREE(pass);
439 return true;
442 /**************************************************************************n
443 Find a suitable temporary directory. The result should be copied immediately
444 as it may be overwritten by a subsequent call.
445 ****************************************************************************/
447 const char *tmpdir(void)
449 char *p;
450 if ((p = getenv("TMPDIR")))
451 return p;
452 return "/tmp";
455 /****************************************************************************
456 Add a gid to an array of gids if it's not already there.
457 ****************************************************************************/
459 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
460 gid_t **gids, size_t *num_gids)
462 int i;
464 if ((*num_gids != 0) && (*gids == NULL)) {
466 * A former call to this routine has failed to allocate memory
468 return False;
471 for (i=0; i<*num_gids; i++) {
472 if ((*gids)[i] == gid) {
473 return True;
477 *gids = TALLOC_REALLOC_ARRAY(mem_ctx, *gids, gid_t, *num_gids+1);
478 if (*gids == NULL) {
479 *num_gids = 0;
480 return False;
483 (*gids)[*num_gids] = gid;
484 *num_gids += 1;
485 return True;
488 /****************************************************************************
489 Like atoi but gets the value up to the separator character.
490 ****************************************************************************/
492 static const char *Atoic(const char *p, int *n, const char *c)
494 if (!isdigit((int)*p)) {
495 DEBUG(5, ("Atoic: malformed number\n"));
496 return NULL;
499 (*n) = atoi(p);
501 while ((*p) && isdigit((int)*p))
502 p++;
504 if (strchr_m(c, *p) == NULL) {
505 DEBUG(5, ("Atoic: no separator characters (%s) not found\n", c));
506 return NULL;
509 return p;
512 /*************************************************************************
513 Reads a list of numbers.
514 *************************************************************************/
516 const char *get_numlist(const char *p, uint32 **num, int *count)
518 int val;
520 if (num == NULL || count == NULL)
521 return NULL;
523 (*count) = 0;
524 (*num ) = NULL;
526 while ((p = Atoic(p, &val, ":,")) != NULL && (*p) != ':') {
527 *num = SMB_REALLOC_ARRAY((*num), uint32, (*count)+1);
528 if (!(*num)) {
529 return NULL;
531 (*num)[(*count)] = val;
532 (*count)++;
533 p++;
536 return p;
539 /*******************************************************************
540 Check if a file exists - call vfs_file_exist for samba files.
541 ********************************************************************/
543 bool file_exist(const char *fname,SMB_STRUCT_STAT *sbuf)
545 SMB_STRUCT_STAT st;
546 if (!sbuf)
547 sbuf = &st;
549 if (sys_stat(fname,sbuf) != 0)
550 return(False);
552 return((S_ISREG(sbuf->st_mode)) || (S_ISFIFO(sbuf->st_mode)));
555 /*******************************************************************
556 Check if a unix domain socket exists - call vfs_file_exist for samba files.
557 ********************************************************************/
559 bool socket_exist(const char *fname)
561 SMB_STRUCT_STAT st;
562 if (sys_stat(fname,&st) != 0)
563 return(False);
565 return S_ISSOCK(st.st_mode);
568 /*******************************************************************
569 Check a files mod time.
570 ********************************************************************/
572 time_t file_modtime(const char *fname)
574 SMB_STRUCT_STAT st;
576 if (sys_stat(fname,&st) != 0)
577 return(0);
579 return(st.st_mtime);
582 /*******************************************************************
583 Check if a directory exists.
584 ********************************************************************/
586 bool directory_exist(char *dname,SMB_STRUCT_STAT *st)
588 SMB_STRUCT_STAT st2;
589 bool ret;
591 if (!st)
592 st = &st2;
594 if (sys_stat(dname,st) != 0)
595 return(False);
597 ret = S_ISDIR(st->st_mode);
598 if(!ret)
599 errno = ENOTDIR;
600 return ret;
603 /*******************************************************************
604 Returns the size in bytes of the named file.
605 ********************************************************************/
607 SMB_OFF_T get_file_size(char *file_name)
609 SMB_STRUCT_STAT buf;
610 buf.st_size = 0;
611 if(sys_stat(file_name,&buf) != 0)
612 return (SMB_OFF_T)-1;
613 return(buf.st_size);
616 /*******************************************************************
617 Return a string representing an attribute for a file.
618 ********************************************************************/
620 char *attrib_string(uint16 mode)
622 fstring attrstr;
624 attrstr[0] = 0;
626 if (mode & aVOLID) fstrcat(attrstr,"V");
627 if (mode & aDIR) fstrcat(attrstr,"D");
628 if (mode & aARCH) fstrcat(attrstr,"A");
629 if (mode & aHIDDEN) fstrcat(attrstr,"H");
630 if (mode & aSYSTEM) fstrcat(attrstr,"S");
631 if (mode & aRONLY) fstrcat(attrstr,"R");
633 return talloc_strdup(talloc_tos(), attrstr);
636 /*******************************************************************
637 Show a smb message structure.
638 ********************************************************************/
640 void show_msg(char *buf)
642 int i;
643 int bcc=0;
645 if (!DEBUGLVL(5))
646 return;
648 DEBUG(5,("size=%d\nsmb_com=0x%x\nsmb_rcls=%d\nsmb_reh=%d\nsmb_err=%d\nsmb_flg=%d\nsmb_flg2=%d\n",
649 smb_len(buf),
650 (int)CVAL(buf,smb_com),
651 (int)CVAL(buf,smb_rcls),
652 (int)CVAL(buf,smb_reh),
653 (int)SVAL(buf,smb_err),
654 (int)CVAL(buf,smb_flg),
655 (int)SVAL(buf,smb_flg2)));
656 DEBUGADD(5,("smb_tid=%d\nsmb_pid=%d\nsmb_uid=%d\nsmb_mid=%d\n",
657 (int)SVAL(buf,smb_tid),
658 (int)SVAL(buf,smb_pid),
659 (int)SVAL(buf,smb_uid),
660 (int)SVAL(buf,smb_mid)));
661 DEBUGADD(5,("smt_wct=%d\n",(int)CVAL(buf,smb_wct)));
663 for (i=0;i<(int)CVAL(buf,smb_wct);i++)
664 DEBUGADD(5,("smb_vwv[%2d]=%5d (0x%X)\n",i,
665 SVAL(buf,smb_vwv+2*i),SVAL(buf,smb_vwv+2*i)));
667 bcc = (int)SVAL(buf,smb_vwv+2*(CVAL(buf,smb_wct)));
669 DEBUGADD(5,("smb_bcc=%d\n",bcc));
671 if (DEBUGLEVEL < 10)
672 return;
674 if (DEBUGLEVEL < 50)
675 bcc = MIN(bcc, 512);
677 dump_data(10, (uint8 *)smb_buf(buf), bcc);
680 /*******************************************************************
681 Set the length and marker of an encrypted smb packet.
682 ********************************************************************/
684 void smb_set_enclen(char *buf,int len,uint16 enc_ctx_num)
686 _smb_setlen(buf,len);
688 SCVAL(buf,4,0xFF);
689 SCVAL(buf,5,'E');
690 SSVAL(buf,6,enc_ctx_num);
693 /*******************************************************************
694 Set the length and marker of an smb packet.
695 ********************************************************************/
697 void smb_setlen(char *buf,int len)
699 _smb_setlen(buf,len);
701 SCVAL(buf,4,0xFF);
702 SCVAL(buf,5,'S');
703 SCVAL(buf,6,'M');
704 SCVAL(buf,7,'B');
707 /*******************************************************************
708 Setup only the byte count for a smb message.
709 ********************************************************************/
711 int set_message_bcc(char *buf,int num_bytes)
713 int num_words = CVAL(buf,smb_wct);
714 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
715 _smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
716 return (smb_size + num_words*2 + num_bytes);
719 /*******************************************************************
720 Add a data blob to the end of a smb_buf, adjusting bcc and smb_len.
721 Return the bytes added
722 ********************************************************************/
724 ssize_t message_push_blob(uint8 **outbuf, DATA_BLOB blob)
726 size_t newlen = smb_len(*outbuf) + 4 + blob.length;
727 uint8 *tmp;
729 if (!(tmp = TALLOC_REALLOC_ARRAY(NULL, *outbuf, uint8, newlen))) {
730 DEBUG(0, ("talloc failed\n"));
731 return -1;
733 *outbuf = tmp;
735 memcpy(tmp + smb_len(tmp) + 4, blob.data, blob.length);
736 set_message_bcc((char *)tmp, smb_buflen(tmp) + blob.length);
737 return blob.length;
740 /*******************************************************************
741 Reduce a file name, removing .. elements.
742 ********************************************************************/
744 static char *dos_clean_name(TALLOC_CTX *ctx, const char *s)
746 char *p = NULL;
747 char *str = NULL;
749 DEBUG(3,("dos_clean_name [%s]\n",s));
751 /* remove any double slashes */
752 str = talloc_all_string_sub(ctx, s, "\\\\", "\\");
753 if (!str) {
754 return NULL;
757 /* Remove leading .\\ characters */
758 if(strncmp(str, ".\\", 2) == 0) {
759 trim_string(str, ".\\", NULL);
760 if(*str == 0) {
761 str = talloc_strdup(ctx, ".\\");
762 if (!str) {
763 return NULL;
768 while ((p = strstr_m(str,"\\..\\")) != NULL) {
769 char *s1;
771 *p = 0;
772 s1 = p+3;
774 if ((p=strrchr_m(str,'\\')) != NULL) {
775 *p = 0;
776 } else {
777 *str = 0;
779 str = talloc_asprintf(ctx,
780 "%s%s",
781 str,
782 s1);
783 if (!str) {
784 return NULL;
788 trim_string(str,NULL,"\\..");
789 return talloc_all_string_sub(ctx, str, "\\.\\", "\\");
792 /*******************************************************************
793 Reduce a file name, removing .. elements.
794 ********************************************************************/
796 char *unix_clean_name(TALLOC_CTX *ctx, const char *s)
798 char *p = NULL;
799 char *str = NULL;
801 DEBUG(3,("unix_clean_name [%s]\n",s));
803 /* remove any double slashes */
804 str = talloc_all_string_sub(ctx, s, "//","/");
805 if (!str) {
806 return NULL;
809 /* Remove leading ./ characters */
810 if(strncmp(str, "./", 2) == 0) {
811 trim_string(str, "./", NULL);
812 if(*str == 0) {
813 str = talloc_strdup(ctx, "./");
814 if (!str) {
815 return NULL;
820 while ((p = strstr_m(str,"/../")) != NULL) {
821 char *s1;
823 *p = 0;
824 s1 = p+3;
826 if ((p=strrchr_m(str,'/')) != NULL) {
827 *p = 0;
828 } else {
829 *str = 0;
831 str = talloc_asprintf(ctx,
832 "%s%s",
833 str,
834 s1);
835 if (!str) {
836 return NULL;
840 trim_string(str,NULL,"/..");
841 return talloc_all_string_sub(ctx, str, "/./", "/");
844 char *clean_name(TALLOC_CTX *ctx, const char *s)
846 char *str = dos_clean_name(ctx, s);
847 if (!str) {
848 return NULL;
850 return unix_clean_name(ctx, str);
853 /*******************************************************************
854 Close the low 3 fd's and open dev/null in their place.
855 ********************************************************************/
857 void close_low_fds(bool stderr_too)
859 #ifndef VALGRIND
860 int fd;
861 int i;
863 close(0);
864 close(1);
866 if (stderr_too)
867 close(2);
869 /* try and use up these file descriptors, so silly
870 library routines writing to stdout etc won't cause havoc */
871 for (i=0;i<3;i++) {
872 if (i == 2 && !stderr_too)
873 continue;
875 fd = sys_open("/dev/null",O_RDWR,0);
876 if (fd < 0)
877 fd = sys_open("/dev/null",O_WRONLY,0);
878 if (fd < 0) {
879 DEBUG(0,("Can't open /dev/null\n"));
880 return;
882 if (fd != i) {
883 DEBUG(0,("Didn't get file descriptor %d\n",i));
884 return;
887 #endif
890 /*******************************************************************
891 Write data into an fd at a given offset. Ignore seek errors.
892 ********************************************************************/
894 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, SMB_OFF_T pos)
896 size_t total=0;
897 ssize_t ret;
899 if (pos == (SMB_OFF_T)-1) {
900 return write_data(fd, buffer, N);
902 #if defined(HAVE_PWRITE) || defined(HAVE_PRWITE64)
903 while (total < N) {
904 ret = sys_pwrite(fd,buffer + total,N - total, pos);
905 if (ret == -1 && errno == ESPIPE) {
906 return write_data(fd, buffer + total,N - total);
908 if (ret == -1) {
909 DEBUG(0,("write_data_at_offset: write failure. Error = %s\n", strerror(errno) ));
910 return -1;
912 if (ret == 0) {
913 return total;
915 total += ret;
916 pos += ret;
918 return (ssize_t)total;
919 #else
920 /* Use lseek and write_data. */
921 if (sys_lseek(fd, pos, SEEK_SET) == -1) {
922 if (errno != ESPIPE) {
923 return -1;
926 return write_data(fd, buffer, N);
927 #endif
930 /****************************************************************************
931 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
932 else
933 if SYSV use O_NDELAY
934 if BSD use FNDELAY
935 ****************************************************************************/
937 int set_blocking(int fd, bool set)
939 int val;
940 #ifdef O_NONBLOCK
941 #define FLAG_TO_SET O_NONBLOCK
942 #else
943 #ifdef SYSV
944 #define FLAG_TO_SET O_NDELAY
945 #else /* BSD */
946 #define FLAG_TO_SET FNDELAY
947 #endif
948 #endif
950 if((val = sys_fcntl_long(fd, F_GETFL, 0)) == -1)
951 return -1;
952 if(set) /* Turn blocking on - ie. clear nonblock flag */
953 val &= ~FLAG_TO_SET;
954 else
955 val |= FLAG_TO_SET;
956 return sys_fcntl_long( fd, F_SETFL, val);
957 #undef FLAG_TO_SET
960 /*******************************************************************
961 Sleep for a specified number of milliseconds.
962 ********************************************************************/
964 void smb_msleep(unsigned int t)
966 #if defined(HAVE_NANOSLEEP)
967 struct timespec tval;
968 int ret;
970 tval.tv_sec = t/1000;
971 tval.tv_nsec = 1000000*(t%1000);
973 do {
974 errno = 0;
975 ret = nanosleep(&tval, &tval);
976 } while (ret < 0 && errno == EINTR && (tval.tv_sec > 0 || tval.tv_nsec > 0));
977 #else
978 unsigned int tdiff=0;
979 struct timeval tval,t1,t2;
980 fd_set fds;
982 GetTimeOfDay(&t1);
983 t2 = t1;
985 while (tdiff < t) {
986 tval.tv_sec = (t-tdiff)/1000;
987 tval.tv_usec = 1000*((t-tdiff)%1000);
989 /* Never wait for more than 1 sec. */
990 if (tval.tv_sec > 1) {
991 tval.tv_sec = 1;
992 tval.tv_usec = 0;
995 FD_ZERO(&fds);
996 errno = 0;
997 sys_select_intr(0,&fds,NULL,NULL,&tval);
999 GetTimeOfDay(&t2);
1000 if (t2.tv_sec < t1.tv_sec) {
1001 /* Someone adjusted time... */
1002 t1 = t2;
1005 tdiff = TvalDiff(&t1,&t2);
1007 #endif
1010 /****************************************************************************
1011 Become a daemon, discarding the controlling terminal.
1012 ****************************************************************************/
1014 void become_daemon(bool Fork, bool no_process_group)
1016 if (Fork) {
1017 if (sys_fork()) {
1018 _exit(0);
1022 /* detach from the terminal */
1023 #ifdef HAVE_SETSID
1024 if (!no_process_group) setsid();
1025 #elif defined(TIOCNOTTY)
1026 if (!no_process_group) {
1027 int i = sys_open("/dev/tty", O_RDWR, 0);
1028 if (i != -1) {
1029 ioctl(i, (int) TIOCNOTTY, (char *)0);
1030 close(i);
1033 #endif /* HAVE_SETSID */
1035 /* Close fd's 0,1,2. Needed if started by rsh */
1036 close_low_fds(False); /* Don't close stderr, let the debug system
1037 attach it to the logfile */
1040 bool reinit_after_fork(struct messaging_context *msg_ctx,
1041 bool parent_longlived)
1043 NTSTATUS status;
1045 /* Reset the state of the random
1046 * number generation system, so
1047 * children do not get the same random
1048 * numbers as each other */
1049 set_need_random_reseed();
1051 /* tdb needs special fork handling */
1052 if (tdb_reopen_all(parent_longlived ? 1 : 0) == -1) {
1053 DEBUG(0,("tdb_reopen_all failed.\n"));
1054 return false;
1058 * For clustering, we need to re-init our ctdbd connection after the
1059 * fork
1061 status = messaging_reinit(msg_ctx);
1062 if (!NT_STATUS_IS_OK(status)) {
1063 DEBUG(0,("messaging_reinit() failed: %s\n",
1064 nt_errstr(status)));
1065 return false;
1068 return true;
1071 /****************************************************************************
1072 Put up a yes/no prompt.
1073 ****************************************************************************/
1075 bool yesno(const char *p)
1077 char ans[20];
1078 printf("%s",p);
1080 if (!fgets(ans,sizeof(ans)-1,stdin))
1081 return(False);
1083 if (*ans == 'y' || *ans == 'Y')
1084 return(True);
1086 return(False);
1089 #if defined(PARANOID_MALLOC_CHECKER)
1091 /****************************************************************************
1092 Internal malloc wrapper. Externally visible.
1093 ****************************************************************************/
1095 void *malloc_(size_t size)
1097 if (size == 0) {
1098 return NULL;
1100 #undef malloc
1101 return malloc(size);
1102 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
1105 /****************************************************************************
1106 Internal calloc wrapper. Not externally visible.
1107 ****************************************************************************/
1109 static void *calloc_(size_t count, size_t size)
1111 if (size == 0 || count == 0) {
1112 return NULL;
1114 #undef calloc
1115 return calloc(count, size);
1116 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
1119 /****************************************************************************
1120 Internal realloc wrapper. Not externally visible.
1121 ****************************************************************************/
1123 static void *realloc_(void *ptr, size_t size)
1125 #undef realloc
1126 return realloc(ptr, size);
1127 #define realloc(p,s) __ERROR_DONT_USE_RELLOC_DIRECTLY
1130 #endif /* PARANOID_MALLOC_CHECKER */
1132 /****************************************************************************
1133 Type-safe malloc.
1134 ****************************************************************************/
1136 void *malloc_array(size_t el_size, unsigned int count)
1138 if (count >= MAX_ALLOC_SIZE/el_size) {
1139 return NULL;
1142 if (el_size == 0 || count == 0) {
1143 return NULL;
1145 #if defined(PARANOID_MALLOC_CHECKER)
1146 return malloc_(el_size*count);
1147 #else
1148 return malloc(el_size*count);
1149 #endif
1152 /****************************************************************************
1153 Type-safe memalign
1154 ****************************************************************************/
1156 void *memalign_array(size_t el_size, size_t align, unsigned int count)
1158 if (count >= MAX_ALLOC_SIZE/el_size) {
1159 return NULL;
1162 return sys_memalign(align, el_size*count);
1165 /****************************************************************************
1166 Type-safe calloc.
1167 ****************************************************************************/
1169 void *calloc_array(size_t size, size_t nmemb)
1171 if (nmemb >= MAX_ALLOC_SIZE/size) {
1172 return NULL;
1174 if (size == 0 || nmemb == 0) {
1175 return NULL;
1177 #if defined(PARANOID_MALLOC_CHECKER)
1178 return calloc_(nmemb, size);
1179 #else
1180 return calloc(nmemb, size);
1181 #endif
1184 /****************************************************************************
1185 Expand a pointer to be a particular size.
1186 Note that this version of Realloc has an extra parameter that decides
1187 whether to free the passed in storage on allocation failure or if the
1188 new size is zero.
1190 This is designed for use in the typical idiom of :
1192 p = SMB_REALLOC(p, size)
1193 if (!p) {
1194 return error;
1197 and not to have to keep track of the old 'p' contents to free later, nor
1198 to worry if the size parameter was zero. In the case where NULL is returned
1199 we guarentee that p has been freed.
1201 If free later semantics are desired, then pass 'free_old_on_error' as False which
1202 guarentees that the old contents are not freed on error, even if size == 0. To use
1203 this idiom use :
1205 tmp = SMB_REALLOC_KEEP_OLD_ON_ERROR(p, size);
1206 if (!tmp) {
1207 SAFE_FREE(p);
1208 return error;
1209 } else {
1210 p = tmp;
1213 Changes were instigated by Coverity error checking. JRA.
1214 ****************************************************************************/
1216 void *Realloc(void *p, size_t size, bool free_old_on_error)
1218 void *ret=NULL;
1220 if (size == 0) {
1221 if (free_old_on_error) {
1222 SAFE_FREE(p);
1224 DEBUG(2,("Realloc asked for 0 bytes\n"));
1225 return NULL;
1228 #if defined(PARANOID_MALLOC_CHECKER)
1229 if (!p) {
1230 ret = (void *)malloc_(size);
1231 } else {
1232 ret = (void *)realloc_(p,size);
1234 #else
1235 if (!p) {
1236 ret = (void *)malloc(size);
1237 } else {
1238 ret = (void *)realloc(p,size);
1240 #endif
1242 if (!ret) {
1243 if (free_old_on_error && p) {
1244 SAFE_FREE(p);
1246 DEBUG(0,("Memory allocation error: failed to expand to %d bytes\n",(int)size));
1249 return(ret);
1252 /****************************************************************************
1253 Type-safe realloc.
1254 ****************************************************************************/
1256 void *realloc_array(void *p, size_t el_size, unsigned int count, bool free_old_on_error)
1258 if (count >= MAX_ALLOC_SIZE/el_size) {
1259 if (free_old_on_error) {
1260 SAFE_FREE(p);
1262 return NULL;
1264 return Realloc(p, el_size*count, free_old_on_error);
1267 /****************************************************************************
1268 (Hopefully) efficient array append.
1269 ****************************************************************************/
1271 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
1272 void *element, void *_array, uint32 *num_elements,
1273 ssize_t *array_size)
1275 void **array = (void **)_array;
1277 if (*array_size < 0) {
1278 return;
1281 if (*array == NULL) {
1282 if (*array_size == 0) {
1283 *array_size = 128;
1286 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1287 goto error;
1290 *array = TALLOC(mem_ctx, element_size * (*array_size));
1291 if (*array == NULL) {
1292 goto error;
1296 if (*num_elements == *array_size) {
1297 *array_size *= 2;
1299 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1300 goto error;
1303 *array = TALLOC_REALLOC(mem_ctx, *array,
1304 element_size * (*array_size));
1306 if (*array == NULL) {
1307 goto error;
1311 memcpy((char *)(*array) + element_size*(*num_elements),
1312 element, element_size);
1313 *num_elements += 1;
1315 return;
1317 error:
1318 *num_elements = 0;
1319 *array_size = -1;
1322 /****************************************************************************
1323 Free memory, checks for NULL.
1324 Use directly SAFE_FREE()
1325 Exists only because we need to pass a function pointer somewhere --SSS
1326 ****************************************************************************/
1328 void safe_free(void *p)
1330 SAFE_FREE(p);
1333 /****************************************************************************
1334 Get my own name and IP.
1335 ****************************************************************************/
1337 char *get_myname(TALLOC_CTX *ctx)
1339 char *p;
1340 char hostname[HOST_NAME_MAX];
1342 *hostname = 0;
1344 /* get my host name */
1345 if (gethostname(hostname, sizeof(hostname)) == -1) {
1346 DEBUG(0,("gethostname failed\n"));
1347 return False;
1350 /* Ensure null termination. */
1351 hostname[sizeof(hostname)-1] = '\0';
1353 /* split off any parts after an initial . */
1354 p = strchr_m(hostname,'.');
1355 if (p) {
1356 *p = 0;
1359 return talloc_strdup(ctx, hostname);
1362 /****************************************************************************
1363 Get my own domain name, or "" if we have none.
1364 ****************************************************************************/
1366 char *get_mydnsdomname(TALLOC_CTX *ctx)
1368 const char *domname;
1369 char *p;
1371 domname = get_mydnsfullname();
1372 if (!domname) {
1373 return NULL;
1376 p = strchr_m(domname, '.');
1377 if (p) {
1378 p++;
1379 return talloc_strdup(ctx, p);
1380 } else {
1381 return talloc_strdup(ctx, "");
1385 /****************************************************************************
1386 Interpret a protocol description string, with a default.
1387 ****************************************************************************/
1389 int interpret_protocol(const char *str,int def)
1391 if (strequal(str,"NT1"))
1392 return(PROTOCOL_NT1);
1393 if (strequal(str,"LANMAN2"))
1394 return(PROTOCOL_LANMAN2);
1395 if (strequal(str,"LANMAN1"))
1396 return(PROTOCOL_LANMAN1);
1397 if (strequal(str,"CORE"))
1398 return(PROTOCOL_CORE);
1399 if (strequal(str,"COREPLUS"))
1400 return(PROTOCOL_COREPLUS);
1401 if (strequal(str,"CORE+"))
1402 return(PROTOCOL_COREPLUS);
1404 DEBUG(0,("Unrecognised protocol level %s\n",str));
1406 return(def);
1410 #if (defined(HAVE_NETGROUP) && defined(WITH_AUTOMOUNT))
1411 /******************************************************************
1412 Remove any mount options such as -rsize=2048,wsize=2048 etc.
1413 Based on a fix from <Thomas.Hepper@icem.de>.
1414 Returns a malloc'ed string.
1415 *******************************************************************/
1417 static char *strip_mount_options(TALLOC_CTX *ctx, const char *str)
1419 if (*str == '-') {
1420 const char *p = str;
1421 while(*p && !isspace(*p))
1422 p++;
1423 while(*p && isspace(*p))
1424 p++;
1425 if(*p) {
1426 return talloc_strdup(ctx, p);
1429 return NULL;
1432 /*******************************************************************
1433 Patch from jkf@soton.ac.uk
1434 Split Luke's automount_server into YP lookup and string splitter
1435 so can easily implement automount_path().
1436 Returns a malloc'ed string.
1437 *******************************************************************/
1439 #ifdef WITH_NISPLUS_HOME
1440 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
1442 char *value = NULL;
1444 char *nis_map = (char *)lp_nis_home_map_name();
1446 char buffer[NIS_MAXATTRVAL + 1];
1447 nis_result *result;
1448 nis_object *object;
1449 entry_obj *entry;
1451 snprintf(buffer, sizeof(buffer), "[key=%s],%s", user_name, nis_map);
1452 DEBUG(5, ("NIS+ querystring: %s\n", buffer));
1454 if (result = nis_list(buffer, FOLLOW_PATH|EXPAND_NAME|HARD_LOOKUP, NULL, NULL)) {
1455 if (result->status != NIS_SUCCESS) {
1456 DEBUG(3, ("NIS+ query failed: %s\n", nis_sperrno(result->status)));
1457 } else {
1458 object = result->objects.objects_val;
1459 if (object->zo_data.zo_type == ENTRY_OBJ) {
1460 entry = &object->zo_data.objdata_u.en_data;
1461 DEBUG(5, ("NIS+ entry type: %s\n", entry->en_type));
1462 DEBUG(3, ("NIS+ result: %s\n", entry->en_cols.en_cols_val[1].ec_value.ec_value_val));
1464 value = talloc_strdup(ctx,
1465 entry->en_cols.en_cols_val[1].ec_value.ec_value_val);
1466 if (!value) {
1467 nis_freeresult(result);
1468 return NULL;
1470 value = talloc_string_sub(ctx,
1471 value,
1472 "&",
1473 user_name);
1477 nis_freeresult(result);
1479 if (value) {
1480 value = strip_mount_options(ctx, value);
1481 DEBUG(4, ("NIS+ Lookup: %s resulted in %s\n",
1482 user_name, value));
1484 return value;
1486 #else /* WITH_NISPLUS_HOME */
1488 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
1490 char *value = NULL;
1492 int nis_error; /* returned by yp all functions */
1493 char *nis_result; /* yp_match inits this */
1494 int nis_result_len; /* and set this */
1495 char *nis_domain; /* yp_get_default_domain inits this */
1496 char *nis_map = (char *)lp_nis_home_map_name();
1498 if ((nis_error = yp_get_default_domain(&nis_domain)) != 0) {
1499 DEBUG(3, ("YP Error: %s\n", yperr_string(nis_error)));
1500 return NULL;
1503 DEBUG(5, ("NIS Domain: %s\n", nis_domain));
1505 if ((nis_error = yp_match(nis_domain, nis_map, user_name,
1506 strlen(user_name), &nis_result,
1507 &nis_result_len)) == 0) {
1508 value = talloc_strdup(ctx, nis_result);
1509 if (!value) {
1510 return NULL;
1512 value = strip_mount_options(ctx, value);
1513 } else if(nis_error == YPERR_KEY) {
1514 DEBUG(3, ("YP Key not found: while looking up \"%s\" in map \"%s\"\n",
1515 user_name, nis_map));
1516 DEBUG(3, ("using defaults for server and home directory\n"));
1517 } else {
1518 DEBUG(3, ("YP Error: \"%s\" while looking up \"%s\" in map \"%s\"\n",
1519 yperr_string(nis_error), user_name, nis_map));
1522 if (value) {
1523 DEBUG(4, ("YP Lookup: %s resulted in %s\n", user_name, value));
1525 return value;
1527 #endif /* WITH_NISPLUS_HOME */
1528 #endif
1530 /****************************************************************************
1531 Check if a process exists. Does this work on all unixes?
1532 ****************************************************************************/
1534 bool process_exists(const struct server_id pid)
1536 if (procid_is_me(&pid)) {
1537 return True;
1540 if (procid_is_local(&pid)) {
1541 return (kill(pid.pid,0) == 0 || errno != ESRCH);
1544 #ifdef CLUSTER_SUPPORT
1545 return ctdbd_process_exists(messaging_ctdbd_connection(), pid.vnn,
1546 pid.pid);
1547 #else
1548 return False;
1549 #endif
1552 bool process_exists_by_pid(pid_t pid)
1554 /* Doing kill with a non-positive pid causes messages to be
1555 * sent to places we don't want. */
1556 SMB_ASSERT(pid > 0);
1557 return(kill(pid,0) == 0 || errno != ESRCH);
1560 /*******************************************************************
1561 Convert a uid into a user name.
1562 ********************************************************************/
1564 const char *uidtoname(uid_t uid)
1566 TALLOC_CTX *ctx = talloc_tos();
1567 char *name = NULL;
1568 struct passwd *pass = NULL;
1570 pass = getpwuid_alloc(ctx,uid);
1571 if (pass) {
1572 name = talloc_strdup(ctx,pass->pw_name);
1573 TALLOC_FREE(pass);
1574 } else {
1575 name = talloc_asprintf(ctx,
1576 "%ld",
1577 (long int)uid);
1579 return name;
1582 /*******************************************************************
1583 Convert a gid into a group name.
1584 ********************************************************************/
1586 char *gidtoname(gid_t gid)
1588 struct group *grp;
1590 grp = getgrgid(gid);
1591 if (grp) {
1592 return talloc_strdup(talloc_tos(), grp->gr_name);
1594 else {
1595 return talloc_asprintf(talloc_tos(),
1596 "%d",
1597 (int)gid);
1601 /*******************************************************************
1602 Convert a user name into a uid.
1603 ********************************************************************/
1605 uid_t nametouid(const char *name)
1607 struct passwd *pass;
1608 char *p;
1609 uid_t u;
1611 pass = getpwnam_alloc(talloc_autofree_context(), name);
1612 if (pass) {
1613 u = pass->pw_uid;
1614 TALLOC_FREE(pass);
1615 return u;
1618 u = (uid_t)strtol(name, &p, 0);
1619 if ((p != name) && (*p == '\0'))
1620 return u;
1622 return (uid_t)-1;
1625 /*******************************************************************
1626 Convert a name to a gid_t if possible. Return -1 if not a group.
1627 ********************************************************************/
1629 gid_t nametogid(const char *name)
1631 struct group *grp;
1632 char *p;
1633 gid_t g;
1635 g = (gid_t)strtol(name, &p, 0);
1636 if ((p != name) && (*p == '\0'))
1637 return g;
1639 grp = sys_getgrnam(name);
1640 if (grp)
1641 return(grp->gr_gid);
1642 return (gid_t)-1;
1645 /*******************************************************************
1646 Something really nasty happened - panic !
1647 ********************************************************************/
1649 void smb_panic(const char *const why)
1651 char *cmd;
1652 int result;
1654 #ifdef DEVELOPER
1657 if (global_clobber_region_function) {
1658 DEBUG(0,("smb_panic: clobber_region() last called from [%s(%u)]\n",
1659 global_clobber_region_function,
1660 global_clobber_region_line));
1663 #endif
1665 DEBUG(0,("PANIC (pid %llu): %s\n",
1666 (unsigned long long)sys_getpid(), why));
1667 log_stack_trace();
1669 cmd = lp_panic_action();
1670 if (cmd && *cmd) {
1671 DEBUG(0, ("smb_panic(): calling panic action [%s]\n", cmd));
1672 result = system(cmd);
1674 if (result == -1)
1675 DEBUG(0, ("smb_panic(): fork failed in panic action: %s\n",
1676 strerror(errno)));
1677 else
1678 DEBUG(0, ("smb_panic(): action returned status %d\n",
1679 WEXITSTATUS(result)));
1682 dump_core();
1685 /*******************************************************************
1686 Print a backtrace of the stack to the debug log. This function
1687 DELIBERATELY LEAKS MEMORY. The expectation is that you should
1688 exit shortly after calling it.
1689 ********************************************************************/
1691 #ifdef HAVE_LIBUNWIND_H
1692 #include <libunwind.h>
1693 #endif
1695 #ifdef HAVE_EXECINFO_H
1696 #include <execinfo.h>
1697 #endif
1699 #ifdef HAVE_LIBEXC_H
1700 #include <libexc.h>
1701 #endif
1703 void log_stack_trace(void)
1705 #ifdef HAVE_LIBUNWIND
1706 /* Try to use libunwind before any other technique since on ia64
1707 * libunwind correctly walks the stack in more circumstances than
1708 * backtrace.
1710 unw_cursor_t cursor;
1711 unw_context_t uc;
1712 unsigned i = 0;
1714 char procname[256];
1715 unw_word_t ip, sp, off;
1717 procname[sizeof(procname) - 1] = '\0';
1719 if (unw_getcontext(&uc) != 0) {
1720 goto libunwind_failed;
1723 if (unw_init_local(&cursor, &uc) != 0) {
1724 goto libunwind_failed;
1727 DEBUG(0, ("BACKTRACE:\n"));
1729 do {
1730 ip = sp = 0;
1731 unw_get_reg(&cursor, UNW_REG_IP, &ip);
1732 unw_get_reg(&cursor, UNW_REG_SP, &sp);
1734 switch (unw_get_proc_name(&cursor,
1735 procname, sizeof(procname) - 1, &off) ) {
1736 case 0:
1737 /* Name found. */
1738 case -UNW_ENOMEM:
1739 /* Name truncated. */
1740 DEBUGADD(0, (" #%u %s + %#llx [ip=%#llx] [sp=%#llx]\n",
1741 i, procname, (long long)off,
1742 (long long)ip, (long long) sp));
1743 break;
1744 default:
1745 /* case -UNW_ENOINFO: */
1746 /* case -UNW_EUNSPEC: */
1747 /* No symbol name found. */
1748 DEBUGADD(0, (" #%u %s [ip=%#llx] [sp=%#llx]\n",
1749 i, "<unknown symbol>",
1750 (long long)ip, (long long) sp));
1752 ++i;
1753 } while (unw_step(&cursor) > 0);
1755 return;
1757 libunwind_failed:
1758 DEBUG(0, ("unable to produce a stack trace with libunwind\n"));
1760 #elif HAVE_BACKTRACE_SYMBOLS
1761 void *backtrace_stack[BACKTRACE_STACK_SIZE];
1762 size_t backtrace_size;
1763 char **backtrace_strings;
1765 /* get the backtrace (stack frames) */
1766 backtrace_size = backtrace(backtrace_stack,BACKTRACE_STACK_SIZE);
1767 backtrace_strings = backtrace_symbols(backtrace_stack, backtrace_size);
1769 DEBUG(0, ("BACKTRACE: %lu stack frames:\n",
1770 (unsigned long)backtrace_size));
1772 if (backtrace_strings) {
1773 int i;
1775 for (i = 0; i < backtrace_size; i++)
1776 DEBUGADD(0, (" #%u %s\n", i, backtrace_strings[i]));
1778 /* Leak the backtrace_strings, rather than risk what free() might do */
1781 #elif HAVE_LIBEXC
1783 /* The IRIX libexc library provides an API for unwinding the stack. See
1784 * libexc(3) for details. Apparantly trace_back_stack leaks memory, but
1785 * since we are about to abort anyway, it hardly matters.
1788 #define NAMESIZE 32 /* Arbitrary */
1790 __uint64_t addrs[BACKTRACE_STACK_SIZE];
1791 char * names[BACKTRACE_STACK_SIZE];
1792 char namebuf[BACKTRACE_STACK_SIZE * NAMESIZE];
1794 int i;
1795 int levels;
1797 ZERO_ARRAY(addrs);
1798 ZERO_ARRAY(names);
1799 ZERO_ARRAY(namebuf);
1801 /* We need to be root so we can open our /proc entry to walk
1802 * our stack. It also helps when we want to dump core.
1804 become_root();
1806 for (i = 0; i < BACKTRACE_STACK_SIZE; i++) {
1807 names[i] = namebuf + (i * NAMESIZE);
1810 levels = trace_back_stack(0, addrs, names,
1811 BACKTRACE_STACK_SIZE, NAMESIZE - 1);
1813 DEBUG(0, ("BACKTRACE: %d stack frames:\n", levels));
1814 for (i = 0; i < levels; i++) {
1815 DEBUGADD(0, (" #%d 0x%llx %s\n", i, addrs[i], names[i]));
1817 #undef NAMESIZE
1819 #else
1820 DEBUG(0, ("unable to produce a stack trace on this platform\n"));
1821 #endif
1824 /*******************************************************************
1825 A readdir wrapper which just returns the file name.
1826 ********************************************************************/
1828 const char *readdirname(SMB_STRUCT_DIR *p)
1830 SMB_STRUCT_DIRENT *ptr;
1831 char *dname;
1833 if (!p)
1834 return(NULL);
1836 ptr = (SMB_STRUCT_DIRENT *)sys_readdir(p);
1837 if (!ptr)
1838 return(NULL);
1840 dname = ptr->d_name;
1842 #ifdef NEXT2
1843 if (telldir(p) < 0)
1844 return(NULL);
1845 #endif
1847 #ifdef HAVE_BROKEN_READDIR_NAME
1848 /* using /usr/ucb/cc is BAD */
1849 dname = dname - 2;
1850 #endif
1852 return talloc_strdup(talloc_tos(), dname);
1855 /*******************************************************************
1856 Utility function used to decide if the last component
1857 of a path matches a (possibly wildcarded) entry in a namelist.
1858 ********************************************************************/
1860 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive)
1862 const char *last_component;
1864 /* if we have no list it's obviously not in the path */
1865 if((namelist == NULL ) || ((namelist != NULL) && (namelist[0].name == NULL))) {
1866 return False;
1869 DEBUG(8, ("is_in_path: %s\n", name));
1871 /* Get the last component of the unix name. */
1872 last_component = strrchr_m(name, '/');
1873 if (!last_component) {
1874 last_component = name;
1875 } else {
1876 last_component++; /* Go past '/' */
1879 for(; namelist->name != NULL; namelist++) {
1880 if(namelist->is_wild) {
1881 if (mask_match(last_component, namelist->name, case_sensitive)) {
1882 DEBUG(8,("is_in_path: mask match succeeded\n"));
1883 return True;
1885 } else {
1886 if((case_sensitive && (strcmp(last_component, namelist->name) == 0))||
1887 (!case_sensitive && (StrCaseCmp(last_component, namelist->name) == 0))) {
1888 DEBUG(8,("is_in_path: match succeeded\n"));
1889 return True;
1893 DEBUG(8,("is_in_path: match not found\n"));
1894 return False;
1897 /*******************************************************************
1898 Strip a '/' separated list into an array of
1899 name_compare_enties structures suitable for
1900 passing to is_in_path(). We do this for
1901 speed so we can pre-parse all the names in the list
1902 and don't do it for each call to is_in_path().
1903 namelist is modified here and is assumed to be
1904 a copy owned by the caller.
1905 We also check if the entry contains a wildcard to
1906 remove a potentially expensive call to mask_match
1907 if possible.
1908 ********************************************************************/
1910 void set_namearray(name_compare_entry **ppname_array, const char *namelist)
1912 char *name_end;
1913 const char *nameptr = namelist;
1914 int num_entries = 0;
1915 int i;
1917 (*ppname_array) = NULL;
1919 if((nameptr == NULL ) || ((nameptr != NULL) && (*nameptr == '\0')))
1920 return;
1922 /* We need to make two passes over the string. The
1923 first to count the number of elements, the second
1924 to split it.
1927 while(*nameptr) {
1928 if ( *nameptr == '/' ) {
1929 /* cope with multiple (useless) /s) */
1930 nameptr++;
1931 continue;
1933 /* find the next / */
1934 name_end = strchr_m(nameptr, '/');
1936 /* oops - the last check for a / didn't find one. */
1937 if (name_end == NULL)
1938 break;
1940 /* next segment please */
1941 nameptr = name_end + 1;
1942 num_entries++;
1945 if(num_entries == 0)
1946 return;
1948 if(( (*ppname_array) = SMB_MALLOC_ARRAY(name_compare_entry, num_entries + 1)) == NULL) {
1949 DEBUG(0,("set_namearray: malloc fail\n"));
1950 return;
1953 /* Now copy out the names */
1954 nameptr = namelist;
1955 i = 0;
1956 while(*nameptr) {
1957 if ( *nameptr == '/' ) {
1958 /* cope with multiple (useless) /s) */
1959 nameptr++;
1960 continue;
1962 /* find the next / */
1963 if ((name_end = strchr_m(nameptr, '/')) != NULL)
1964 *name_end = 0;
1966 /* oops - the last check for a / didn't find one. */
1967 if(name_end == NULL)
1968 break;
1970 (*ppname_array)[i].is_wild = ms_has_wild(nameptr);
1971 if(((*ppname_array)[i].name = SMB_STRDUP(nameptr)) == NULL) {
1972 DEBUG(0,("set_namearray: malloc fail (1)\n"));
1973 return;
1976 /* next segment please */
1977 nameptr = name_end + 1;
1978 i++;
1981 (*ppname_array)[i].name = NULL;
1983 return;
1986 /****************************************************************************
1987 Routine to free a namearray.
1988 ****************************************************************************/
1990 void free_namearray(name_compare_entry *name_array)
1992 int i;
1994 if(name_array == NULL)
1995 return;
1997 for(i=0; name_array[i].name!=NULL; i++)
1998 SAFE_FREE(name_array[i].name);
1999 SAFE_FREE(name_array);
2002 #undef DBGC_CLASS
2003 #define DBGC_CLASS DBGC_LOCKING
2005 /****************************************************************************
2006 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
2007 is dealt with in posix.c
2008 Returns True if the lock was granted, False otherwise.
2009 ****************************************************************************/
2011 bool fcntl_lock(int fd, int op, SMB_OFF_T offset, SMB_OFF_T count, int type)
2013 SMB_STRUCT_FLOCK lock;
2014 int ret;
2016 DEBUG(8,("fcntl_lock fd=%d op=%d offset=%.0f count=%.0f type=%d\n",
2017 fd,op,(double)offset,(double)count,type));
2019 lock.l_type = type;
2020 lock.l_whence = SEEK_SET;
2021 lock.l_start = offset;
2022 lock.l_len = count;
2023 lock.l_pid = 0;
2025 ret = sys_fcntl_ptr(fd,op,&lock);
2027 if (ret == -1) {
2028 int sav = errno;
2029 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
2030 (double)offset,(double)count,op,type,strerror(errno)));
2031 errno = sav;
2032 return False;
2035 /* everything went OK */
2036 DEBUG(8,("fcntl_lock: Lock call successful\n"));
2038 return True;
2041 /****************************************************************************
2042 Simple routine to query existing file locks. Cruft in NFS and 64->32 bit mapping
2043 is dealt with in posix.c
2044 Returns True if we have information regarding this lock region (and returns
2045 F_UNLCK in *ptype if the region is unlocked). False if the call failed.
2046 ****************************************************************************/
2048 bool fcntl_getlock(int fd, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid)
2050 SMB_STRUCT_FLOCK lock;
2051 int ret;
2053 DEBUG(8,("fcntl_getlock fd=%d offset=%.0f count=%.0f type=%d\n",
2054 fd,(double)*poffset,(double)*pcount,*ptype));
2056 lock.l_type = *ptype;
2057 lock.l_whence = SEEK_SET;
2058 lock.l_start = *poffset;
2059 lock.l_len = *pcount;
2060 lock.l_pid = 0;
2062 ret = sys_fcntl_ptr(fd,SMB_F_GETLK,&lock);
2064 if (ret == -1) {
2065 int sav = errno;
2066 DEBUG(3,("fcntl_getlock: lock request failed at offset %.0f count %.0f type %d (%s)\n",
2067 (double)*poffset,(double)*pcount,*ptype,strerror(errno)));
2068 errno = sav;
2069 return False;
2072 *ptype = lock.l_type;
2073 *poffset = lock.l_start;
2074 *pcount = lock.l_len;
2075 *ppid = lock.l_pid;
2077 DEBUG(3,("fcntl_getlock: fd %d is returned info %d pid %u\n",
2078 fd, (int)lock.l_type, (unsigned int)lock.l_pid));
2079 return True;
2082 #undef DBGC_CLASS
2083 #define DBGC_CLASS DBGC_ALL
2085 /*******************************************************************
2086 Is the name specified one of my netbios names.
2087 Returns true if it is equal, false otherwise.
2088 ********************************************************************/
2090 bool is_myname(const char *s)
2092 int n;
2093 bool ret = False;
2095 for (n=0; my_netbios_names(n); n++) {
2096 if (strequal(my_netbios_names(n), s)) {
2097 ret=True;
2098 break;
2101 DEBUG(8, ("is_myname(\"%s\") returns %d\n", s, ret));
2102 return(ret);
2105 /*******************************************************************
2106 Is the name specified our workgroup/domain.
2107 Returns true if it is equal, false otherwise.
2108 ********************************************************************/
2110 bool is_myworkgroup(const char *s)
2112 bool ret = False;
2114 if (strequal(s, lp_workgroup())) {
2115 ret=True;
2118 DEBUG(8, ("is_myworkgroup(\"%s\") returns %d\n", s, ret));
2119 return(ret);
2122 /*******************************************************************
2123 we distinguish between 2K and XP by the "Native Lan Manager" string
2124 WinXP => "Windows 2002 5.1"
2125 WinXP 64bit => "Windows XP 5.2"
2126 Win2k => "Windows 2000 5.0"
2127 NT4 => "Windows NT 4.0"
2128 Win9x => "Windows 4.0"
2129 Windows 2003 doesn't set the native lan manager string but
2130 they do set the domain to "Windows 2003 5.2" (probably a bug).
2131 ********************************************************************/
2133 void ra_lanman_string( const char *native_lanman )
2135 if ( strcmp( native_lanman, "Windows 2002 5.1" ) == 0 )
2136 set_remote_arch( RA_WINXP );
2137 else if ( strcmp( native_lanman, "Windows XP 5.2" ) == 0 )
2138 set_remote_arch( RA_WINXP64 );
2139 else if ( strcmp( native_lanman, "Windows Server 2003 5.2" ) == 0 )
2140 set_remote_arch( RA_WIN2K3 );
2143 static const char *remote_arch_str;
2145 const char *get_remote_arch_str(void)
2147 if (!remote_arch_str) {
2148 return "UNKNOWN";
2150 return remote_arch_str;
2153 /*******************************************************************
2154 Set the horrid remote_arch string based on an enum.
2155 ********************************************************************/
2157 void set_remote_arch(enum remote_arch_types type)
2159 ra_type = type;
2160 switch( type ) {
2161 case RA_WFWG:
2162 remote_arch_str = "WfWg";
2163 break;
2164 case RA_OS2:
2165 remote_arch_str = "OS2";
2166 break;
2167 case RA_WIN95:
2168 remote_arch_str = "Win95";
2169 break;
2170 case RA_WINNT:
2171 remote_arch_str = "WinNT";
2172 break;
2173 case RA_WIN2K:
2174 remote_arch_str = "Win2K";
2175 break;
2176 case RA_WINXP:
2177 remote_arch_str = "WinXP";
2178 break;
2179 case RA_WINXP64:
2180 remote_arch_str = "WinXP64";
2181 break;
2182 case RA_WIN2K3:
2183 remote_arch_str = "Win2K3";
2184 break;
2185 case RA_VISTA:
2186 remote_arch_str = "Vista";
2187 break;
2188 case RA_SAMBA:
2189 remote_arch_str = "Samba";
2190 break;
2191 case RA_CIFSFS:
2192 remote_arch_str = "CIFSFS";
2193 break;
2194 default:
2195 ra_type = RA_UNKNOWN;
2196 remote_arch_str = "UNKNOWN";
2197 break;
2200 DEBUG(10,("set_remote_arch: Client arch is \'%s\'\n",
2201 remote_arch_str));
2204 /*******************************************************************
2205 Get the remote_arch type.
2206 ********************************************************************/
2208 enum remote_arch_types get_remote_arch(void)
2210 return ra_type;
2213 void print_asc(int level, const unsigned char *buf,int len)
2215 int i;
2216 for (i=0;i<len;i++)
2217 DEBUG(level,("%c", isprint(buf[i])?buf[i]:'.'));
2220 void dump_data(int level, const unsigned char *buf1,int len)
2222 const unsigned char *buf = (const unsigned char *)buf1;
2223 int i=0;
2224 if (len<=0) return;
2226 if (!DEBUGLVL(level)) return;
2228 DEBUGADD(level,("[%03X] ",i));
2229 for (i=0;i<len;) {
2230 DEBUGADD(level,("%02X ",(int)buf[i]));
2231 i++;
2232 if (i%8 == 0) DEBUGADD(level,(" "));
2233 if (i%16 == 0) {
2234 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
2235 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
2236 if (i<len) DEBUGADD(level,("[%03X] ",i));
2239 if (i%16) {
2240 int n;
2241 n = 16 - (i%16);
2242 DEBUGADD(level,(" "));
2243 if (n>8) DEBUGADD(level,(" "));
2244 while (n--) DEBUGADD(level,(" "));
2245 n = MIN(8,i%16);
2246 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
2247 n = (i%16) - n;
2248 if (n>0) print_asc(level,&buf[i-n],n);
2249 DEBUGADD(level,("\n"));
2253 void dump_data_pw(const char *msg, const uchar * data, size_t len)
2255 #ifdef DEBUG_PASSWORD
2256 DEBUG(11, ("%s", msg));
2257 if (data != NULL && len > 0)
2259 dump_data(11, data, len);
2261 #endif
2264 const char *tab_depth(int level, int depth)
2266 if( CHECK_DEBUGLVL(level) ) {
2267 dbgtext("%*s", depth*4, "");
2269 return "";
2272 /*****************************************************************************
2273 Provide a checksum on a string
2275 Input: s - the null-terminated character string for which the checksum
2276 will be calculated.
2278 Output: The checksum value calculated for s.
2279 *****************************************************************************/
2281 int str_checksum(const char *s)
2283 int res = 0;
2284 int c;
2285 int i=0;
2287 while(*s) {
2288 c = *s;
2289 res ^= (c << (i % 15)) ^ (c >> (15-(i%15)));
2290 s++;
2291 i++;
2293 return(res);
2296 /*****************************************************************
2297 Zero a memory area then free it. Used to catch bugs faster.
2298 *****************************************************************/
2300 void zero_free(void *p, size_t size)
2302 memset(p, 0, size);
2303 SAFE_FREE(p);
2306 /*****************************************************************
2307 Set our open file limit to a requested max and return the limit.
2308 *****************************************************************/
2310 int set_maxfiles(int requested_max)
2312 #if (defined(HAVE_GETRLIMIT) && defined(RLIMIT_NOFILE))
2313 struct rlimit rlp;
2314 int saved_current_limit;
2316 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2317 DEBUG(0,("set_maxfiles: getrlimit (1) for RLIMIT_NOFILE failed with error %s\n",
2318 strerror(errno) ));
2319 /* just guess... */
2320 return requested_max;
2324 * Set the fd limit to be real_max_open_files + MAX_OPEN_FUDGEFACTOR to
2325 * account for the extra fd we need
2326 * as well as the log files and standard
2327 * handles etc. Save the limit we want to set in case
2328 * we are running on an OS that doesn't support this limit (AIX)
2329 * which always returns RLIM_INFINITY for rlp.rlim_max.
2332 /* Try raising the hard (max) limit to the requested amount. */
2334 #if defined(RLIM_INFINITY)
2335 if (rlp.rlim_max != RLIM_INFINITY) {
2336 int orig_max = rlp.rlim_max;
2338 if ( rlp.rlim_max < requested_max )
2339 rlp.rlim_max = requested_max;
2341 /* This failing is not an error - many systems (Linux) don't
2342 support our default request of 10,000 open files. JRA. */
2344 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2345 DEBUG(3,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d max files failed with error %s\n",
2346 (int)rlp.rlim_max, strerror(errno) ));
2348 /* Set failed - restore original value from get. */
2349 rlp.rlim_max = orig_max;
2352 #endif
2354 /* Now try setting the soft (current) limit. */
2356 saved_current_limit = rlp.rlim_cur = MIN(requested_max,rlp.rlim_max);
2358 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2359 DEBUG(0,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d files failed with error %s\n",
2360 (int)rlp.rlim_cur, strerror(errno) ));
2361 /* just guess... */
2362 return saved_current_limit;
2365 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2366 DEBUG(0,("set_maxfiles: getrlimit (2) for RLIMIT_NOFILE failed with error %s\n",
2367 strerror(errno) ));
2368 /* just guess... */
2369 return saved_current_limit;
2372 #if defined(RLIM_INFINITY)
2373 if(rlp.rlim_cur == RLIM_INFINITY)
2374 return saved_current_limit;
2375 #endif
2377 if((int)rlp.rlim_cur > saved_current_limit)
2378 return saved_current_limit;
2380 return rlp.rlim_cur;
2381 #else /* !defined(HAVE_GETRLIMIT) || !defined(RLIMIT_NOFILE) */
2383 * No way to know - just guess...
2385 return requested_max;
2386 #endif
2389 /*****************************************************************
2390 Possibly replace mkstemp if it is broken.
2391 *****************************************************************/
2393 int smb_mkstemp(char *name_template)
2395 #if HAVE_SECURE_MKSTEMP
2396 return mkstemp(name_template);
2397 #else
2398 /* have a reasonable go at emulating it. Hope that
2399 the system mktemp() isn't completly hopeless */
2400 char *p = mktemp(name_template);
2401 if (!p)
2402 return -1;
2403 return open(p, O_CREAT|O_EXCL|O_RDWR, 0600);
2404 #endif
2407 /*****************************************************************
2408 malloc that aborts with smb_panic on fail or zero size.
2409 *****************************************************************/
2411 void *smb_xmalloc_array(size_t size, unsigned int count)
2413 void *p;
2414 if (size == 0) {
2415 smb_panic("smb_xmalloc_array: called with zero size");
2417 if (count >= MAX_ALLOC_SIZE/size) {
2418 smb_panic("smb_xmalloc_array: alloc size too large");
2420 if ((p = SMB_MALLOC(size*count)) == NULL) {
2421 DEBUG(0, ("smb_xmalloc_array failed to allocate %lu * %lu bytes\n",
2422 (unsigned long)size, (unsigned long)count));
2423 smb_panic("smb_xmalloc_array: malloc failed");
2425 return p;
2429 Memdup with smb_panic on fail.
2432 void *smb_xmemdup(const void *p, size_t size)
2434 void *p2;
2435 p2 = SMB_XMALLOC_ARRAY(unsigned char,size);
2436 memcpy(p2, p, size);
2437 return p2;
2441 strdup that aborts on malloc fail.
2444 char *smb_xstrdup(const char *s)
2446 #if defined(PARANOID_MALLOC_CHECKER)
2447 #ifdef strdup
2448 #undef strdup
2449 #endif
2450 #endif
2452 #ifndef HAVE_STRDUP
2453 #define strdup rep_strdup
2454 #endif
2456 char *s1 = strdup(s);
2457 #if defined(PARANOID_MALLOC_CHECKER)
2458 #ifdef strdup
2459 #undef strdup
2460 #endif
2461 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
2462 #endif
2463 if (!s1) {
2464 smb_panic("smb_xstrdup: malloc failed");
2466 return s1;
2471 strndup that aborts on malloc fail.
2474 char *smb_xstrndup(const char *s, size_t n)
2476 #if defined(PARANOID_MALLOC_CHECKER)
2477 #ifdef strndup
2478 #undef strndup
2479 #endif
2480 #endif
2482 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
2483 #undef HAVE_STRNDUP
2484 #define strndup rep_strndup
2485 #endif
2487 char *s1 = strndup(s, n);
2488 #if defined(PARANOID_MALLOC_CHECKER)
2489 #ifdef strndup
2490 #undef strndup
2491 #endif
2492 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
2493 #endif
2494 if (!s1) {
2495 smb_panic("smb_xstrndup: malloc failed");
2497 return s1;
2501 vasprintf that aborts on malloc fail
2504 int smb_xvasprintf(char **ptr, const char *format, va_list ap)
2506 int n;
2507 va_list ap2;
2509 VA_COPY(ap2, ap);
2511 n = vasprintf(ptr, format, ap2);
2512 if (n == -1 || ! *ptr) {
2513 smb_panic("smb_xvasprintf: out of memory");
2515 va_end(ap2);
2516 return n;
2519 /*****************************************************************
2520 Like strdup but for memory.
2521 *****************************************************************/
2523 void *memdup(const void *p, size_t size)
2525 void *p2;
2526 if (size == 0)
2527 return NULL;
2528 p2 = SMB_MALLOC(size);
2529 if (!p2)
2530 return NULL;
2531 memcpy(p2, p, size);
2532 return p2;
2535 /*****************************************************************
2536 Get local hostname and cache result.
2537 *****************************************************************/
2539 char *myhostname(void)
2541 static char *ret;
2542 if (ret == NULL) {
2543 /* This is cached forever so
2544 * use autofree talloc ctx. */
2545 ret = get_myname(talloc_autofree_context());
2547 return ret;
2550 /*****************************************************************
2551 A useful function for returning a path in the Samba pid directory.
2552 *****************************************************************/
2554 static char *xx_path(const char *name, const char *rootpath)
2556 char *fname = NULL;
2558 fname = talloc_strdup(talloc_tos(), rootpath);
2559 if (!fname) {
2560 return NULL;
2562 trim_string(fname,"","/");
2564 if (!directory_exist(fname,NULL)) {
2565 mkdir(fname,0755);
2568 return talloc_asprintf(talloc_tos(),
2569 "%s/%s",
2570 fname,
2571 name);
2574 /*****************************************************************
2575 A useful function for returning a path in the Samba lock directory.
2576 *****************************************************************/
2578 char *lock_path(const char *name)
2580 return xx_path(name, lp_lockdir());
2583 /*****************************************************************
2584 A useful function for returning a path in the Samba pid directory.
2585 *****************************************************************/
2587 char *pid_path(const char *name)
2589 return xx_path(name, lp_piddir());
2593 * @brief Returns an absolute path to a file in the Samba lib directory.
2595 * @param name File to find, relative to LIBDIR.
2597 * @retval Pointer to a string containing the full path.
2600 char *lib_path(const char *name)
2602 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_LIBDIR(), name);
2606 * @brief Returns an absolute path to a file in the Samba modules directory.
2608 * @param name File to find, relative to MODULESDIR.
2610 * @retval Pointer to a string containing the full path.
2613 char *modules_path(const char *name)
2615 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_MODULESDIR(), name);
2619 * @brief Returns an absolute path to a file in the Samba data directory.
2621 * @param name File to find, relative to CODEPAGEDIR.
2623 * @retval Pointer to a talloc'ed string containing the full path.
2626 char *data_path(const char *name)
2628 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_CODEPAGEDIR(), name);
2631 /*****************************************************************
2632 a useful function for returning a path in the Samba state directory
2633 *****************************************************************/
2635 char *state_path(const char *name)
2637 return xx_path(name, get_dyn_STATEDIR());
2641 * @brief Returns the platform specific shared library extension.
2643 * @retval Pointer to a const char * containing the extension.
2646 const char *shlib_ext(void)
2648 return get_dyn_SHLIBEXT();
2651 /*******************************************************************
2652 Given a filename - get its directory name
2653 NB: Returned in static storage. Caveats:
2654 o If caller wishes to preserve, they should copy.
2655 ********************************************************************/
2657 char *parent_dirname(const char *path)
2659 char *parent;
2661 if (!parent_dirname_talloc(talloc_tos(), path, &parent, NULL)) {
2662 return NULL;
2665 return parent;
2668 bool parent_dirname_talloc(TALLOC_CTX *mem_ctx, const char *dir,
2669 char **parent, const char **name)
2671 char *p;
2672 ptrdiff_t len;
2674 p = strrchr_m(dir, '/'); /* Find final '/', if any */
2676 if (p == NULL) {
2677 if (!(*parent = talloc_strdup(mem_ctx, "."))) {
2678 return False;
2680 if (name) {
2681 *name = "";
2683 return True;
2686 len = p-dir;
2688 if (!(*parent = TALLOC_ARRAY(mem_ctx, char, len+1))) {
2689 return False;
2691 memcpy(*parent, dir, len);
2692 (*parent)[len] = '\0';
2694 if (name) {
2695 *name = p+1;
2697 return True;
2700 /*******************************************************************
2701 Determine if a pattern contains any Microsoft wildcard characters.
2702 *******************************************************************/
2704 bool ms_has_wild(const char *s)
2706 char c;
2708 if (lp_posix_pathnames()) {
2709 /* With posix pathnames no characters are wild. */
2710 return False;
2713 while ((c = *s++)) {
2714 switch (c) {
2715 case '*':
2716 case '?':
2717 case '<':
2718 case '>':
2719 case '"':
2720 return True;
2723 return False;
2726 bool ms_has_wild_w(const smb_ucs2_t *s)
2728 smb_ucs2_t c;
2729 if (!s) return False;
2730 while ((c = *s++)) {
2731 switch (c) {
2732 case UCS2_CHAR('*'):
2733 case UCS2_CHAR('?'):
2734 case UCS2_CHAR('<'):
2735 case UCS2_CHAR('>'):
2736 case UCS2_CHAR('"'):
2737 return True;
2740 return False;
2743 /*******************************************************************
2744 A wrapper that handles case sensitivity and the special handling
2745 of the ".." name.
2746 *******************************************************************/
2748 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive)
2750 if (strcmp(string,"..") == 0)
2751 string = ".";
2752 if (strcmp(pattern,".") == 0)
2753 return False;
2755 return ms_fnmatch(pattern, string, Protocol <= PROTOCOL_LANMAN2, is_case_sensitive) == 0;
2758 /*******************************************************************
2759 A wrapper that handles case sensitivity and the special handling
2760 of the ".." name. Varient that is only called by old search code which requires
2761 pattern translation.
2762 *******************************************************************/
2764 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive)
2766 if (strcmp(string,"..") == 0)
2767 string = ".";
2768 if (strcmp(pattern,".") == 0)
2769 return False;
2771 return ms_fnmatch(pattern, string, True, is_case_sensitive) == 0;
2774 /*******************************************************************
2775 A wrapper that handles a list of patters and calls mask_match()
2776 on each. Returns True if any of the patterns match.
2777 *******************************************************************/
2779 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive)
2781 while (listLen-- > 0) {
2782 if (mask_match(string, *list++, is_case_sensitive))
2783 return True;
2785 return False;
2788 /*********************************************************
2789 Recursive routine that is called by unix_wild_match.
2790 *********************************************************/
2792 static bool unix_do_match(const char *regexp, const char *str)
2794 const char *p;
2796 for( p = regexp; *p && *str; ) {
2798 switch(*p) {
2799 case '?':
2800 str++;
2801 p++;
2802 break;
2804 case '*':
2807 * Look for a character matching
2808 * the one after the '*'.
2810 p++;
2811 if(!*p)
2812 return true; /* Automatic match */
2813 while(*str) {
2815 while(*str && (*p != *str))
2816 str++;
2819 * Patch from weidel@multichart.de. In the case of the regexp
2820 * '*XX*' we want to ensure there are at least 2 'X' characters
2821 * in the string after the '*' for a match to be made.
2825 int matchcount=0;
2828 * Eat all the characters that match, but count how many there were.
2831 while(*str && (*p == *str)) {
2832 str++;
2833 matchcount++;
2837 * Now check that if the regexp had n identical characters that
2838 * matchcount had at least that many matches.
2841 while ( *(p+1) && (*(p+1) == *p)) {
2842 p++;
2843 matchcount--;
2846 if ( matchcount <= 0 )
2847 return false;
2850 str--; /* We've eaten the match char after the '*' */
2852 if(unix_do_match(p, str))
2853 return true;
2855 if(!*str)
2856 return false;
2857 else
2858 str++;
2860 return false;
2862 default:
2863 if(*str != *p)
2864 return false;
2865 str++;
2866 p++;
2867 break;
2871 if(!*p && !*str)
2872 return true;
2874 if (!*p && str[0] == '.' && str[1] == 0)
2875 return true;
2877 if (!*str && *p == '?') {
2878 while (*p == '?')
2879 p++;
2880 return(!*p);
2883 if(!*str && (*p == '*' && p[1] == '\0'))
2884 return true;
2886 return false;
2889 /*******************************************************************
2890 Simple case insensitive interface to a UNIX wildcard matcher.
2891 Returns True if match, False if not.
2892 *******************************************************************/
2894 bool unix_wild_match(const char *pattern, const char *string)
2896 TALLOC_CTX *ctx = talloc_stackframe();
2897 char *p2;
2898 char *s2;
2899 char *p;
2900 bool ret = false;
2902 p2 = talloc_strdup(ctx,pattern);
2903 s2 = talloc_strdup(ctx,string);
2904 if (!p2 || !s2) {
2905 TALLOC_FREE(ctx);
2906 return false;
2908 strlower_m(p2);
2909 strlower_m(s2);
2911 /* Remove any *? and ** from the pattern as they are meaningless */
2912 for(p = p2; *p; p++) {
2913 while( *p == '*' && (p[1] == '?' ||p[1] == '*')) {
2914 memmove(&p[1], &p[2], strlen(&p[2])+1);
2918 if (strequal(p2,"*")) {
2919 TALLOC_FREE(ctx);
2920 return true;
2923 ret = unix_do_match(p2, s2);
2924 TALLOC_FREE(ctx);
2925 return ret;
2928 /**********************************************************************
2929 Converts a name to a fully qualified domain name.
2930 Returns true if lookup succeeded, false if not (then fqdn is set to name)
2931 Note we deliberately use gethostbyname here, not getaddrinfo as we want
2932 to examine the h_aliases and I don't know how to do that with getaddrinfo.
2933 ***********************************************************************/
2935 bool name_to_fqdn(fstring fqdn, const char *name)
2937 char *full = NULL;
2938 struct hostent *hp = gethostbyname(name);
2940 if (!hp || !hp->h_name || !*hp->h_name) {
2941 DEBUG(10,("name_to_fqdn: lookup for %s failed.\n", name));
2942 fstrcpy(fqdn, name);
2943 return false;
2946 /* Find out if the fqdn is returned as an alias
2947 * to cope with /etc/hosts files where the first
2948 * name is not the fqdn but the short name */
2949 if (hp->h_aliases && (! strchr_m(hp->h_name, '.'))) {
2950 int i;
2951 for (i = 0; hp->h_aliases[i]; i++) {
2952 if (strchr_m(hp->h_aliases[i], '.')) {
2953 full = hp->h_aliases[i];
2954 break;
2958 if (full && (StrCaseCmp(full, "localhost.localdomain") == 0)) {
2959 DEBUG(1, ("WARNING: your /etc/hosts file may be broken!\n"));
2960 DEBUGADD(1, (" Specifing the machine hostname for address 127.0.0.1 may lead\n"));
2961 DEBUGADD(1, (" to Kerberos authentication problems as localhost.localdomain\n"));
2962 DEBUGADD(1, (" may end up being used instead of the real machine FQDN.\n"));
2963 full = hp->h_name;
2965 if (!full) {
2966 full = hp->h_name;
2969 DEBUG(10,("name_to_fqdn: lookup for %s -> %s.\n", name, full));
2970 fstrcpy(fqdn, full);
2971 return true;
2974 /**********************************************************************
2975 Extension to talloc_get_type: Abort on type mismatch
2976 ***********************************************************************/
2978 void *talloc_check_name_abort(const void *ptr, const char *name)
2980 void *result;
2982 result = talloc_check_name(ptr, name);
2983 if (result != NULL)
2984 return result;
2986 DEBUG(0, ("Talloc type mismatch, expected %s, got %s\n",
2987 name, talloc_get_name(ptr)));
2988 smb_panic("talloc type mismatch");
2989 /* Keep the compiler happy */
2990 return NULL;
2993 uint32 map_share_mode_to_deny_mode(uint32 share_access, uint32 private_options)
2995 switch (share_access & ~FILE_SHARE_DELETE) {
2996 case FILE_SHARE_NONE:
2997 return DENY_ALL;
2998 case FILE_SHARE_READ:
2999 return DENY_WRITE;
3000 case FILE_SHARE_WRITE:
3001 return DENY_READ;
3002 case FILE_SHARE_READ|FILE_SHARE_WRITE:
3003 return DENY_NONE;
3005 if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_DOS) {
3006 return DENY_DOS;
3007 } else if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_FCB) {
3008 return DENY_FCB;
3011 return (uint32)-1;
3014 pid_t procid_to_pid(const struct server_id *proc)
3016 return proc->pid;
3019 static uint32 my_vnn = NONCLUSTER_VNN;
3021 void set_my_vnn(uint32 vnn)
3023 DEBUG(10, ("vnn pid %d = %u\n", (int)sys_getpid(), (unsigned int)vnn));
3024 my_vnn = vnn;
3027 uint32 get_my_vnn(void)
3029 return my_vnn;
3032 struct server_id pid_to_procid(pid_t pid)
3034 struct server_id result;
3035 result.pid = pid;
3036 #ifdef CLUSTER_SUPPORT
3037 result.vnn = my_vnn;
3038 #endif
3039 return result;
3042 struct server_id procid_self(void)
3044 return pid_to_procid(sys_getpid());
3047 struct server_id server_id_self(void)
3049 return procid_self();
3052 bool procid_equal(const struct server_id *p1, const struct server_id *p2)
3054 if (p1->pid != p2->pid)
3055 return False;
3056 #ifdef CLUSTER_SUPPORT
3057 if (p1->vnn != p2->vnn)
3058 return False;
3059 #endif
3060 return True;
3063 bool cluster_id_equal(const struct server_id *id1,
3064 const struct server_id *id2)
3066 return procid_equal(id1, id2);
3069 bool procid_is_me(const struct server_id *pid)
3071 if (pid->pid != sys_getpid())
3072 return False;
3073 #ifdef CLUSTER_SUPPORT
3074 if (pid->vnn != my_vnn)
3075 return False;
3076 #endif
3077 return True;
3080 struct server_id interpret_pid(const char *pid_string)
3082 #ifdef CLUSTER_SUPPORT
3083 unsigned int vnn, pid;
3084 struct server_id result;
3085 if (sscanf(pid_string, "%u:%u", &vnn, &pid) == 2) {
3086 result.vnn = vnn;
3087 result.pid = pid;
3089 else if (sscanf(pid_string, "%u", &pid) == 1) {
3090 result.vnn = get_my_vnn();
3091 result.pid = pid;
3093 else {
3094 result.vnn = NONCLUSTER_VNN;
3095 result.pid = -1;
3097 return result;
3098 #else
3099 return pid_to_procid(atoi(pid_string));
3100 #endif
3103 char *procid_str(TALLOC_CTX *mem_ctx, const struct server_id *pid)
3105 #ifdef CLUSTER_SUPPORT
3106 if (pid->vnn == NONCLUSTER_VNN) {
3107 return talloc_asprintf(mem_ctx,
3108 "%d",
3109 (int)pid->pid);
3111 else {
3112 return talloc_asprintf(mem_ctx,
3113 "%u:%d",
3114 (unsigned)pid->vnn,
3115 (int)pid->pid);
3117 #else
3118 return talloc_asprintf(mem_ctx,
3119 "%d",
3120 (int)pid->pid);
3121 #endif
3124 char *procid_str_static(const struct server_id *pid)
3126 return procid_str(talloc_tos(), pid);
3129 bool procid_valid(const struct server_id *pid)
3131 return (pid->pid != -1);
3134 bool procid_is_local(const struct server_id *pid)
3136 #ifdef CLUSTER_SUPPORT
3137 return pid->vnn == my_vnn;
3138 #else
3139 return True;
3140 #endif
3143 int this_is_smp(void)
3145 #if defined(HAVE_SYSCONF)
3147 #if defined(SYSCONF_SC_NPROC_ONLN)
3148 return (sysconf(_SC_NPROC_ONLN) > 1) ? 1 : 0;
3149 #elif defined(SYSCONF_SC_NPROCESSORS_ONLN)
3150 return (sysconf(_SC_NPROCESSORS_ONLN) > 1) ? 1 : 0;
3151 #else
3152 return 0;
3153 #endif
3155 #else
3156 return 0;
3157 #endif
3160 /****************************************************************
3161 Check if an offset into a buffer is safe.
3162 If this returns True it's safe to indirect into the byte at
3163 pointer ptr+off.
3164 ****************************************************************/
3166 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3168 const char *end_base = buf_base + buf_len;
3169 char *end_ptr = ptr + off;
3171 if (!buf_base || !ptr) {
3172 return False;
3175 if (end_base < buf_base || end_ptr < ptr) {
3176 return False; /* wrap. */
3179 if (end_ptr < end_base) {
3180 return True;
3182 return False;
3185 /****************************************************************
3186 Return a safe pointer into a buffer, or NULL.
3187 ****************************************************************/
3189 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3191 return is_offset_safe(buf_base, buf_len, ptr, off) ?
3192 ptr + off : NULL;
3195 /****************************************************************
3196 Return a safe pointer into a string within a buffer, or NULL.
3197 ****************************************************************/
3199 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3201 if (!is_offset_safe(buf_base, buf_len, ptr, off)) {
3202 return NULL;
3204 /* Check if a valid string exists at this offset. */
3205 if (skip_string(buf_base,buf_len, ptr + off) == NULL) {
3206 return NULL;
3208 return ptr + off;
3211 /****************************************************************
3212 Return an SVAL at a pointer, or failval if beyond the end.
3213 ****************************************************************/
3215 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
3218 * Note we use off+1 here, not off+2 as SVAL accesses ptr[0] and ptr[1],
3219 * NOT ptr[2].
3221 if (!is_offset_safe(buf_base, buf_len, ptr, off+1)) {
3222 return failval;
3224 return SVAL(ptr,off);
3227 /****************************************************************
3228 Return an IVAL at a pointer, or failval if beyond the end.
3229 ****************************************************************/
3231 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
3234 * Note we use off+3 here, not off+4 as IVAL accesses
3235 * ptr[0] ptr[1] ptr[2] ptr[3] NOT ptr[4].
3237 if (!is_offset_safe(buf_base, buf_len, ptr, off+3)) {
3238 return failval;
3240 return IVAL(ptr,off);
3243 /****************************************************************
3244 Split DOM\user into DOM and user. Do not mix with winbind variants of that
3245 call (they take care of winbind separator and other winbind specific settings).
3246 ****************************************************************/
3248 void split_domain_user(TALLOC_CTX *mem_ctx,
3249 const char *full_name,
3250 char **domain,
3251 char **user)
3253 const char *p = NULL;
3255 p = strchr_m(full_name, '\\');
3257 if (p != NULL) {
3258 *domain = talloc_strndup(mem_ctx, full_name,
3259 PTR_DIFF(p, full_name));
3260 *user = talloc_strdup(mem_ctx, p+1);
3261 } else {
3262 *domain = talloc_strdup(mem_ctx, "");
3263 *user = talloc_strdup(mem_ctx, full_name);
3267 #if 0
3269 Disable these now we have checked all code paths and ensured
3270 NULL returns on zero request. JRA.
3272 /****************************************************************
3273 talloc wrapper functions that guarentee a null pointer return
3274 if size == 0.
3275 ****************************************************************/
3277 #ifndef MAX_TALLOC_SIZE
3278 #define MAX_TALLOC_SIZE 0x10000000
3279 #endif
3282 * talloc and zero memory.
3283 * - returns NULL if size is zero.
3286 void *_talloc_zero_zeronull(const void *ctx, size_t size, const char *name)
3288 void *p;
3290 if (size == 0) {
3291 return NULL;
3294 p = talloc_named_const(ctx, size, name);
3296 if (p) {
3297 memset(p, '\0', size);
3300 return p;
3304 * memdup with a talloc.
3305 * - returns NULL if size is zero.
3308 void *_talloc_memdup_zeronull(const void *t, const void *p, size_t size, const char *name)
3310 void *newp;
3312 if (size == 0) {
3313 return NULL;
3316 newp = talloc_named_const(t, size, name);
3317 if (newp) {
3318 memcpy(newp, p, size);
3321 return newp;
3325 * alloc an array, checking for integer overflow in the array size.
3326 * - returns NULL if count or el_size are zero.
3329 void *_talloc_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3331 if (count >= MAX_TALLOC_SIZE/el_size) {
3332 return NULL;
3335 if (el_size == 0 || count == 0) {
3336 return NULL;
3339 return talloc_named_const(ctx, el_size * count, name);
3343 * alloc an zero array, checking for integer overflow in the array size
3344 * - returns NULL if count or el_size are zero.
3347 void *_talloc_zero_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3349 if (count >= MAX_TALLOC_SIZE/el_size) {
3350 return NULL;
3353 if (el_size == 0 || count == 0) {
3354 return NULL;
3357 return _talloc_zero(ctx, el_size * count, name);
3361 * Talloc wrapper that returns NULL if size == 0.
3363 void *talloc_zeronull(const void *context, size_t size, const char *name)
3365 if (size == 0) {
3366 return NULL;
3368 return talloc_named_const(context, size, name);
3370 #endif
3372 /* Split a path name into filename and stream name components. Canonicalise
3373 * such that an implicit $DATA token is always explicit.
3375 * The "specification" of this function can be found in the
3376 * run_local_stream_name() function in torture.c, I've tried those
3377 * combinations against a W2k3 server.
3380 NTSTATUS split_ntfs_stream_name(TALLOC_CTX *mem_ctx, const char *fname,
3381 char **pbase, char **pstream)
3383 char *base = NULL;
3384 char *stream = NULL;
3385 char *sname; /* stream name */
3386 const char *stype; /* stream type */
3388 DEBUG(10, ("split_ntfs_stream_name called for [%s]\n", fname));
3390 sname = strchr_m(fname, ':');
3392 if (lp_posix_pathnames() || (sname == NULL)) {
3393 if (pbase != NULL) {
3394 base = talloc_strdup(mem_ctx, fname);
3395 NT_STATUS_HAVE_NO_MEMORY(base);
3397 goto done;
3400 if (pbase != NULL) {
3401 base = talloc_strndup(mem_ctx, fname, PTR_DIFF(sname, fname));
3402 NT_STATUS_HAVE_NO_MEMORY(base);
3405 sname += 1;
3407 stype = strchr_m(sname, ':');
3409 if (stype == NULL) {
3410 sname = talloc_strdup(mem_ctx, sname);
3411 stype = "$DATA";
3413 else {
3414 if (StrCaseCmp(stype, ":$DATA") != 0) {
3416 * If there is an explicit stream type, so far we only
3417 * allow $DATA. Is there anything else allowed? -- vl
3419 DEBUG(10, ("[%s] is an invalid stream type\n", stype));
3420 TALLOC_FREE(base);
3421 return NT_STATUS_OBJECT_NAME_INVALID;
3423 sname = talloc_strndup(mem_ctx, sname, PTR_DIFF(stype, sname));
3424 stype += 1;
3427 if (sname == NULL) {
3428 TALLOC_FREE(base);
3429 return NT_STATUS_NO_MEMORY;
3432 if (sname[0] == '\0') {
3434 * no stream name, so no stream
3436 goto done;
3439 if (pstream != NULL) {
3440 stream = talloc_asprintf(mem_ctx, "%s:%s", sname, stype);
3441 if (stream == NULL) {
3442 TALLOC_FREE(sname);
3443 TALLOC_FREE(base);
3444 return NT_STATUS_NO_MEMORY;
3447 * upper-case the type field
3449 strupper_m(strchr_m(stream, ':')+1);
3452 done:
3453 if (pbase != NULL) {
3454 *pbase = base;
3456 if (pstream != NULL) {
3457 *pstream = stream;
3459 return NT_STATUS_OK;
3462 bool is_valid_policy_hnd(const POLICY_HND *hnd)
3464 POLICY_HND tmp;
3465 ZERO_STRUCT(tmp);
3466 return (memcmp(&tmp, hnd, sizeof(tmp)) != 0);
3469 bool policy_hnd_equal(const struct policy_handle *hnd1,
3470 const struct policy_handle *hnd2)
3472 if (!hnd1 || !hnd2) {
3473 return false;
3476 return (memcmp(hnd1, hnd2, sizeof(*hnd1)) == 0);
3479 /****************************************************************
3480 strip off leading '\\' from a hostname
3481 ****************************************************************/
3483 const char *strip_hostname(const char *s)
3485 if (!s) {
3486 return NULL;
3489 if (strlen_m(s) < 3) {
3490 return s;
3493 if (s[0] == '\\') s++;
3494 if (s[0] == '\\') s++;
3496 return s;