Remove a pointless CONST_DISCARD
[Samba/gebeck_regimport.git] / source3 / lib / util.c
blobb34625461774339da2c7c8a872a3f885f3032180
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 int trans_num = 0;
65 static enum remote_arch_types ra_type = RA_UNKNOWN;
67 /***********************************************************************
68 Definitions for all names.
69 ***********************************************************************/
71 static char *smb_myname;
72 static char *smb_myworkgroup;
73 static char *smb_scope;
74 static int smb_num_netbios_names;
75 static char **smb_my_netbios_names;
77 /***********************************************************************
78 Allocate and set myname. Ensure upper case.
79 ***********************************************************************/
81 bool set_global_myname(const char *myname)
83 SAFE_FREE(smb_myname);
84 smb_myname = SMB_STRDUP(myname);
85 if (!smb_myname)
86 return False;
87 strupper_m(smb_myname);
88 return True;
91 const char *global_myname(void)
93 return smb_myname;
96 /***********************************************************************
97 Allocate and set myworkgroup. Ensure upper case.
98 ***********************************************************************/
100 bool set_global_myworkgroup(const char *myworkgroup)
102 SAFE_FREE(smb_myworkgroup);
103 smb_myworkgroup = SMB_STRDUP(myworkgroup);
104 if (!smb_myworkgroup)
105 return False;
106 strupper_m(smb_myworkgroup);
107 return True;
110 const char *lp_workgroup(void)
112 return smb_myworkgroup;
115 /***********************************************************************
116 Allocate and set scope. Ensure upper case.
117 ***********************************************************************/
119 bool set_global_scope(const char *scope)
121 SAFE_FREE(smb_scope);
122 smb_scope = SMB_STRDUP(scope);
123 if (!smb_scope)
124 return False;
125 strupper_m(smb_scope);
126 return True;
129 /*********************************************************************
130 Ensure scope is never null string.
131 *********************************************************************/
133 const char *global_scope(void)
135 if (!smb_scope)
136 set_global_scope("");
137 return smb_scope;
140 static void free_netbios_names_array(void)
142 int i;
144 for (i = 0; i < smb_num_netbios_names; i++)
145 SAFE_FREE(smb_my_netbios_names[i]);
147 SAFE_FREE(smb_my_netbios_names);
148 smb_num_netbios_names = 0;
151 static bool allocate_my_netbios_names_array(size_t number)
153 free_netbios_names_array();
155 smb_num_netbios_names = number + 1;
156 smb_my_netbios_names = SMB_MALLOC_ARRAY( char *, smb_num_netbios_names );
158 if (!smb_my_netbios_names)
159 return False;
161 memset(smb_my_netbios_names, '\0', sizeof(char *) * smb_num_netbios_names);
162 return True;
165 static bool set_my_netbios_names(const char *name, int i)
167 SAFE_FREE(smb_my_netbios_names[i]);
169 smb_my_netbios_names[i] = SMB_STRDUP(name);
170 if (!smb_my_netbios_names[i])
171 return False;
172 strupper_m(smb_my_netbios_names[i]);
173 return True;
176 /***********************************************************************
177 Free memory allocated to global objects
178 ***********************************************************************/
180 void gfree_names(void)
182 SAFE_FREE( smb_myname );
183 SAFE_FREE( smb_myworkgroup );
184 SAFE_FREE( smb_scope );
185 free_netbios_names_array();
186 free_local_machine_name();
189 void gfree_all( void )
191 gfree_names();
192 gfree_loadparm();
193 gfree_case_tables();
194 gfree_debugsyms();
195 gfree_charcnv();
196 gfree_interfaces();
198 /* release the talloc null_context memory last */
199 talloc_disable_null_tracking();
202 const char *my_netbios_names(int i)
204 return smb_my_netbios_names[i];
207 bool set_netbios_aliases(const char **str_array)
209 size_t namecount;
211 /* Work out the max number of netbios aliases that we have */
212 for( namecount=0; str_array && (str_array[namecount] != NULL); namecount++ )
215 if ( global_myname() && *global_myname())
216 namecount++;
218 /* Allocate space for the netbios aliases */
219 if (!allocate_my_netbios_names_array(namecount))
220 return False;
222 /* Use the global_myname string first */
223 namecount=0;
224 if ( global_myname() && *global_myname()) {
225 set_my_netbios_names( global_myname(), namecount );
226 namecount++;
229 if (str_array) {
230 size_t i;
231 for ( i = 0; str_array[i] != NULL; i++) {
232 size_t n;
233 bool duplicate = False;
235 /* Look for duplicates */
236 for( n=0; n<namecount; n++ ) {
237 if( strequal( str_array[i], my_netbios_names(n) ) ) {
238 duplicate = True;
239 break;
242 if (!duplicate) {
243 if (!set_my_netbios_names(str_array[i], namecount))
244 return False;
245 namecount++;
249 return True;
252 /****************************************************************************
253 Common name initialization code.
254 ****************************************************************************/
256 bool init_names(void)
258 int n;
260 if (global_myname() == NULL || *global_myname() == '\0') {
261 if (!set_global_myname(myhostname())) {
262 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
263 return False;
267 if (!set_netbios_aliases(lp_netbios_aliases())) {
268 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
269 return False;
272 set_local_machine_name(global_myname(),false);
274 DEBUG( 5, ("Netbios name list:-\n") );
275 for( n=0; my_netbios_names(n); n++ ) {
276 DEBUGADD( 5, ("my_netbios_names[%d]=\"%s\"\n",
277 n, my_netbios_names(n) ) );
280 return( True );
283 /**************************************************************************n
284 Code to cope with username/password auth options from the commandline.
285 Used mainly in client tools.
286 ****************************************************************************/
288 static struct user_auth_info cmdline_auth_info = {
289 NULL, /* username */
290 NULL, /* password */
291 false, /* got_pass */
292 false, /* use_kerberos */
293 Undefined, /* signing state */
294 false, /* smb_encrypt */
295 false /* use machine account */
298 const char *get_cmdline_auth_info_username(void)
300 if (!cmdline_auth_info.username) {
301 return "";
303 return cmdline_auth_info.username;
306 void set_cmdline_auth_info_username(const char *username)
308 SAFE_FREE(cmdline_auth_info.username);
309 cmdline_auth_info.username = SMB_STRDUP(username);
310 if (!cmdline_auth_info.username) {
311 exit(ENOMEM);
315 const char *get_cmdline_auth_info_password(void)
317 if (!cmdline_auth_info.password) {
318 return "";
320 return cmdline_auth_info.password;
323 void set_cmdline_auth_info_password(const char *password)
325 SAFE_FREE(cmdline_auth_info.password);
326 cmdline_auth_info.password = SMB_STRDUP(password);
327 if (!cmdline_auth_info.password) {
328 exit(ENOMEM);
330 cmdline_auth_info.got_pass = true;
333 bool set_cmdline_auth_info_signing_state(const char *arg)
335 cmdline_auth_info.signing_state = -1;
336 if (strequal(arg, "off") || strequal(arg, "no") ||
337 strequal(arg, "false")) {
338 cmdline_auth_info.signing_state = false;
339 } else if (strequal(arg, "on") || strequal(arg, "yes") ||
340 strequal(arg, "true") || strequal(arg, "auto")) {
341 cmdline_auth_info.signing_state = true;
342 } else if (strequal(arg, "force") || strequal(arg, "required") ||
343 strequal(arg, "forced")) {
344 cmdline_auth_info.signing_state = Required;
345 } else {
346 return false;
348 return true;
351 int get_cmdline_auth_info_signing_state(void)
353 return cmdline_auth_info.signing_state;
356 void set_cmdline_auth_info_use_kerberos(bool b)
358 cmdline_auth_info.use_kerberos = b;
361 bool get_cmdline_auth_info_use_kerberos(void)
363 return cmdline_auth_info.use_kerberos;
366 /* This should only be used by lib/popt_common.c JRA */
367 void set_cmdline_auth_info_use_krb5_ticket(void)
369 cmdline_auth_info.use_kerberos = true;
370 cmdline_auth_info.got_pass = true;
373 /* This should only be used by lib/popt_common.c JRA */
374 void set_cmdline_auth_info_smb_encrypt(void)
376 cmdline_auth_info.smb_encrypt = true;
379 void set_cmdline_auth_info_use_machine_account(void)
381 cmdline_auth_info.use_machine_account = true;
384 bool get_cmdline_auth_info_got_pass(void)
386 return cmdline_auth_info.got_pass;
389 bool get_cmdline_auth_info_smb_encrypt(void)
391 return cmdline_auth_info.smb_encrypt;
394 bool get_cmdline_auth_info_use_machine_account(void)
396 return cmdline_auth_info.use_machine_account;
399 bool get_cmdline_auth_info_copy(struct user_auth_info *info)
401 *info = cmdline_auth_info;
402 /* Now re-alloc the strings. */
403 info->username = SMB_STRDUP(get_cmdline_auth_info_username());
404 info->password = SMB_STRDUP(get_cmdline_auth_info_password());
405 if (!info->username || !info->password) {
406 return false;
408 return true;
411 bool set_cmdline_auth_info_machine_account_creds(void)
413 char *pass = NULL;
414 char *account = NULL;
416 if (!get_cmdline_auth_info_use_machine_account()) {
417 return false;
420 if (!secrets_init()) {
421 d_printf("ERROR: Unable to open secrets database\n");
422 return false;
425 if (asprintf(&account, "%s$@%s", global_myname(), lp_realm()) < 0) {
426 return false;
429 pass = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
430 if (!pass) {
431 d_printf("ERROR: Unable to fetch machine password for "
432 "%s in domain %s\n",
433 account, lp_workgroup());
434 SAFE_FREE(account);
435 return false;
438 set_cmdline_auth_info_username(account);
439 set_cmdline_auth_info_password(pass);
441 SAFE_FREE(account);
442 SAFE_FREE(pass);
444 return true;
447 /**************************************************************************n
448 Find a suitable temporary directory. The result should be copied immediately
449 as it may be overwritten by a subsequent call.
450 ****************************************************************************/
452 const char *tmpdir(void)
454 char *p;
455 if ((p = getenv("TMPDIR")))
456 return p;
457 return "/tmp";
460 /****************************************************************************
461 Add a gid to an array of gids if it's not already there.
462 ****************************************************************************/
464 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
465 gid_t **gids, size_t *num_gids)
467 int i;
469 if ((*num_gids != 0) && (*gids == NULL)) {
471 * A former call to this routine has failed to allocate memory
473 return False;
476 for (i=0; i<*num_gids; i++) {
477 if ((*gids)[i] == gid) {
478 return True;
482 *gids = TALLOC_REALLOC_ARRAY(mem_ctx, *gids, gid_t, *num_gids+1);
483 if (*gids == NULL) {
484 *num_gids = 0;
485 return False;
488 (*gids)[*num_gids] = gid;
489 *num_gids += 1;
490 return True;
493 /****************************************************************************
494 Like atoi but gets the value up to the separator character.
495 ****************************************************************************/
497 static const char *Atoic(const char *p, int *n, const char *c)
499 if (!isdigit((int)*p)) {
500 DEBUG(5, ("Atoic: malformed number\n"));
501 return NULL;
504 (*n) = atoi(p);
506 while ((*p) && isdigit((int)*p))
507 p++;
509 if (strchr_m(c, *p) == NULL) {
510 DEBUG(5, ("Atoic: no separator characters (%s) not found\n", c));
511 return NULL;
514 return p;
517 /*************************************************************************
518 Reads a list of numbers.
519 *************************************************************************/
521 const char *get_numlist(const char *p, uint32 **num, int *count)
523 int val;
525 if (num == NULL || count == NULL)
526 return NULL;
528 (*count) = 0;
529 (*num ) = NULL;
531 while ((p = Atoic(p, &val, ":,")) != NULL && (*p) != ':') {
532 *num = SMB_REALLOC_ARRAY((*num), uint32, (*count)+1);
533 if (!(*num)) {
534 return NULL;
536 (*num)[(*count)] = val;
537 (*count)++;
538 p++;
541 return p;
544 /*******************************************************************
545 Check if a file exists - call vfs_file_exist for samba files.
546 ********************************************************************/
548 bool file_exist(const char *fname,SMB_STRUCT_STAT *sbuf)
550 SMB_STRUCT_STAT st;
551 if (!sbuf)
552 sbuf = &st;
554 if (sys_stat(fname,sbuf) != 0)
555 return(False);
557 return((S_ISREG(sbuf->st_mode)) || (S_ISFIFO(sbuf->st_mode)));
560 /*******************************************************************
561 Check if a unix domain socket exists - call vfs_file_exist for samba files.
562 ********************************************************************/
564 bool socket_exist(const char *fname)
566 SMB_STRUCT_STAT st;
567 if (sys_stat(fname,&st) != 0)
568 return(False);
570 return S_ISSOCK(st.st_mode);
573 /*******************************************************************
574 Check a files mod time.
575 ********************************************************************/
577 time_t file_modtime(const char *fname)
579 SMB_STRUCT_STAT st;
581 if (sys_stat(fname,&st) != 0)
582 return(0);
584 return(st.st_mtime);
587 /*******************************************************************
588 Check if a directory exists.
589 ********************************************************************/
591 bool directory_exist(char *dname,SMB_STRUCT_STAT *st)
593 SMB_STRUCT_STAT st2;
594 bool ret;
596 if (!st)
597 st = &st2;
599 if (sys_stat(dname,st) != 0)
600 return(False);
602 ret = S_ISDIR(st->st_mode);
603 if(!ret)
604 errno = ENOTDIR;
605 return ret;
608 /*******************************************************************
609 Returns the size in bytes of the named file.
610 ********************************************************************/
612 SMB_OFF_T get_file_size(char *file_name)
614 SMB_STRUCT_STAT buf;
615 buf.st_size = 0;
616 if(sys_stat(file_name,&buf) != 0)
617 return (SMB_OFF_T)-1;
618 return(buf.st_size);
621 /*******************************************************************
622 Return a string representing an attribute for a file.
623 ********************************************************************/
625 char *attrib_string(uint16 mode)
627 fstring attrstr;
629 attrstr[0] = 0;
631 if (mode & aVOLID) fstrcat(attrstr,"V");
632 if (mode & aDIR) fstrcat(attrstr,"D");
633 if (mode & aARCH) fstrcat(attrstr,"A");
634 if (mode & aHIDDEN) fstrcat(attrstr,"H");
635 if (mode & aSYSTEM) fstrcat(attrstr,"S");
636 if (mode & aRONLY) fstrcat(attrstr,"R");
638 return talloc_strdup(talloc_tos(), attrstr);
641 /*******************************************************************
642 Show a smb message structure.
643 ********************************************************************/
645 void show_msg(char *buf)
647 int i;
648 int bcc=0;
650 if (!DEBUGLVL(5))
651 return;
653 DEBUG(5,("size=%d\nsmb_com=0x%x\nsmb_rcls=%d\nsmb_reh=%d\nsmb_err=%d\nsmb_flg=%d\nsmb_flg2=%d\n",
654 smb_len(buf),
655 (int)CVAL(buf,smb_com),
656 (int)CVAL(buf,smb_rcls),
657 (int)CVAL(buf,smb_reh),
658 (int)SVAL(buf,smb_err),
659 (int)CVAL(buf,smb_flg),
660 (int)SVAL(buf,smb_flg2)));
661 DEBUGADD(5,("smb_tid=%d\nsmb_pid=%d\nsmb_uid=%d\nsmb_mid=%d\n",
662 (int)SVAL(buf,smb_tid),
663 (int)SVAL(buf,smb_pid),
664 (int)SVAL(buf,smb_uid),
665 (int)SVAL(buf,smb_mid)));
666 DEBUGADD(5,("smt_wct=%d\n",(int)CVAL(buf,smb_wct)));
668 for (i=0;i<(int)CVAL(buf,smb_wct);i++)
669 DEBUGADD(5,("smb_vwv[%2d]=%5d (0x%X)\n",i,
670 SVAL(buf,smb_vwv+2*i),SVAL(buf,smb_vwv+2*i)));
672 bcc = (int)SVAL(buf,smb_vwv+2*(CVAL(buf,smb_wct)));
674 DEBUGADD(5,("smb_bcc=%d\n",bcc));
676 if (DEBUGLEVEL < 10)
677 return;
679 if (DEBUGLEVEL < 50)
680 bcc = MIN(bcc, 512);
682 dump_data(10, (uint8 *)smb_buf(buf), bcc);
685 /*******************************************************************
686 Set the length and marker of an encrypted smb packet.
687 ********************************************************************/
689 void smb_set_enclen(char *buf,int len,uint16 enc_ctx_num)
691 _smb_setlen(buf,len);
693 SCVAL(buf,4,0xFF);
694 SCVAL(buf,5,'E');
695 SSVAL(buf,6,enc_ctx_num);
698 /*******************************************************************
699 Set the length and marker of an smb packet.
700 ********************************************************************/
702 void smb_setlen(char *buf,int len)
704 _smb_setlen(buf,len);
706 SCVAL(buf,4,0xFF);
707 SCVAL(buf,5,'S');
708 SCVAL(buf,6,'M');
709 SCVAL(buf,7,'B');
712 /*******************************************************************
713 Setup only the byte count for a smb message.
714 ********************************************************************/
716 int set_message_bcc(char *buf,int num_bytes)
718 int num_words = CVAL(buf,smb_wct);
719 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
720 _smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
721 return (smb_size + num_words*2 + num_bytes);
724 /*******************************************************************
725 Add a data blob to the end of a smb_buf, adjusting bcc and smb_len.
726 Return the bytes added
727 ********************************************************************/
729 ssize_t message_push_blob(uint8 **outbuf, DATA_BLOB blob)
731 size_t newlen = smb_len(*outbuf) + 4 + blob.length;
732 uint8 *tmp;
734 if (!(tmp = TALLOC_REALLOC_ARRAY(NULL, *outbuf, uint8, newlen))) {
735 DEBUG(0, ("talloc failed\n"));
736 return -1;
738 *outbuf = tmp;
740 memcpy(tmp + smb_len(tmp) + 4, blob.data, blob.length);
741 set_message_bcc((char *)tmp, smb_buflen(tmp) + blob.length);
742 return blob.length;
745 /*******************************************************************
746 Reduce a file name, removing .. elements.
747 ********************************************************************/
749 static char *dos_clean_name(TALLOC_CTX *ctx, const char *s)
751 char *p = NULL;
752 char *str = NULL;
754 DEBUG(3,("dos_clean_name [%s]\n",s));
756 /* remove any double slashes */
757 str = talloc_all_string_sub(ctx, s, "\\\\", "\\");
758 if (!str) {
759 return NULL;
762 /* Remove leading .\\ characters */
763 if(strncmp(str, ".\\", 2) == 0) {
764 trim_string(str, ".\\", NULL);
765 if(*str == 0) {
766 str = talloc_strdup(ctx, ".\\");
767 if (!str) {
768 return NULL;
773 while ((p = strstr_m(str,"\\..\\")) != NULL) {
774 char *s1;
776 *p = 0;
777 s1 = p+3;
779 if ((p=strrchr_m(str,'\\')) != NULL) {
780 *p = 0;
781 } else {
782 *str = 0;
784 str = talloc_asprintf(ctx,
785 "%s%s",
786 str,
787 s1);
788 if (!str) {
789 return NULL;
793 trim_string(str,NULL,"\\..");
794 return talloc_all_string_sub(ctx, str, "\\.\\", "\\");
797 /*******************************************************************
798 Reduce a file name, removing .. elements.
799 ********************************************************************/
801 char *unix_clean_name(TALLOC_CTX *ctx, const char *s)
803 char *p = NULL;
804 char *str = NULL;
806 DEBUG(3,("unix_clean_name [%s]\n",s));
808 /* remove any double slashes */
809 str = talloc_all_string_sub(ctx, s, "//","/");
810 if (!str) {
811 return NULL;
814 /* Remove leading ./ characters */
815 if(strncmp(str, "./", 2) == 0) {
816 trim_string(str, "./", NULL);
817 if(*str == 0) {
818 str = talloc_strdup(ctx, "./");
819 if (!str) {
820 return NULL;
825 while ((p = strstr_m(str,"/../")) != NULL) {
826 char *s1;
828 *p = 0;
829 s1 = p+3;
831 if ((p=strrchr_m(str,'/')) != NULL) {
832 *p = 0;
833 } else {
834 *str = 0;
836 str = talloc_asprintf(ctx,
837 "%s%s",
838 str,
839 s1);
840 if (!str) {
841 return NULL;
845 trim_string(str,NULL,"/..");
846 return talloc_all_string_sub(ctx, str, "/./", "/");
849 char *clean_name(TALLOC_CTX *ctx, const char *s)
851 char *str = dos_clean_name(ctx, s);
852 if (!str) {
853 return NULL;
855 return unix_clean_name(ctx, str);
858 /*******************************************************************
859 Close the low 3 fd's and open dev/null in their place.
860 ********************************************************************/
862 void close_low_fds(bool stderr_too)
864 #ifndef VALGRIND
865 int fd;
866 int i;
868 close(0);
869 close(1);
871 if (stderr_too)
872 close(2);
874 /* try and use up these file descriptors, so silly
875 library routines writing to stdout etc won't cause havoc */
876 for (i=0;i<3;i++) {
877 if (i == 2 && !stderr_too)
878 continue;
880 fd = sys_open("/dev/null",O_RDWR,0);
881 if (fd < 0)
882 fd = sys_open("/dev/null",O_WRONLY,0);
883 if (fd < 0) {
884 DEBUG(0,("Can't open /dev/null\n"));
885 return;
887 if (fd != i) {
888 DEBUG(0,("Didn't get file descriptor %d\n",i));
889 return;
892 #endif
895 /*******************************************************************
896 Write data into an fd at a given offset. Ignore seek errors.
897 ********************************************************************/
899 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, SMB_OFF_T pos)
901 size_t total=0;
902 ssize_t ret;
904 if (pos == (SMB_OFF_T)-1) {
905 return write_data(fd, buffer, N);
907 #if defined(HAVE_PWRITE) || defined(HAVE_PRWITE64)
908 while (total < N) {
909 ret = sys_pwrite(fd,buffer + total,N - total, pos);
910 if (ret == -1 && errno == ESPIPE) {
911 return write_data(fd, buffer + total,N - total);
913 if (ret == -1) {
914 DEBUG(0,("write_data_at_offset: write failure. Error = %s\n", strerror(errno) ));
915 return -1;
917 if (ret == 0) {
918 return total;
920 total += ret;
921 pos += ret;
923 return (ssize_t)total;
924 #else
925 /* Use lseek and write_data. */
926 if (sys_lseek(fd, pos, SEEK_SET) == -1) {
927 if (errno != ESPIPE) {
928 return -1;
931 return write_data(fd, buffer, N);
932 #endif
935 /****************************************************************************
936 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
937 else
938 if SYSV use O_NDELAY
939 if BSD use FNDELAY
940 ****************************************************************************/
942 int set_blocking(int fd, bool set)
944 int val;
945 #ifdef O_NONBLOCK
946 #define FLAG_TO_SET O_NONBLOCK
947 #else
948 #ifdef SYSV
949 #define FLAG_TO_SET O_NDELAY
950 #else /* BSD */
951 #define FLAG_TO_SET FNDELAY
952 #endif
953 #endif
955 if((val = sys_fcntl_long(fd, F_GETFL, 0)) == -1)
956 return -1;
957 if(set) /* Turn blocking on - ie. clear nonblock flag */
958 val &= ~FLAG_TO_SET;
959 else
960 val |= FLAG_TO_SET;
961 return sys_fcntl_long( fd, F_SETFL, val);
962 #undef FLAG_TO_SET
965 /*******************************************************************
966 Sleep for a specified number of milliseconds.
967 ********************************************************************/
969 void smb_msleep(unsigned int t)
971 #if defined(HAVE_NANOSLEEP)
972 struct timespec tval;
973 int ret;
975 tval.tv_sec = t/1000;
976 tval.tv_nsec = 1000000*(t%1000);
978 do {
979 errno = 0;
980 ret = nanosleep(&tval, &tval);
981 } while (ret < 0 && errno == EINTR && (tval.tv_sec > 0 || tval.tv_nsec > 0));
982 #else
983 unsigned int tdiff=0;
984 struct timeval tval,t1,t2;
985 fd_set fds;
987 GetTimeOfDay(&t1);
988 t2 = t1;
990 while (tdiff < t) {
991 tval.tv_sec = (t-tdiff)/1000;
992 tval.tv_usec = 1000*((t-tdiff)%1000);
994 /* Never wait for more than 1 sec. */
995 if (tval.tv_sec > 1) {
996 tval.tv_sec = 1;
997 tval.tv_usec = 0;
1000 FD_ZERO(&fds);
1001 errno = 0;
1002 sys_select_intr(0,&fds,NULL,NULL,&tval);
1004 GetTimeOfDay(&t2);
1005 if (t2.tv_sec < t1.tv_sec) {
1006 /* Someone adjusted time... */
1007 t1 = t2;
1010 tdiff = TvalDiff(&t1,&t2);
1012 #endif
1015 /****************************************************************************
1016 Become a daemon, discarding the controlling terminal.
1017 ****************************************************************************/
1019 void become_daemon(bool Fork, bool no_process_group)
1021 if (Fork) {
1022 if (sys_fork()) {
1023 _exit(0);
1027 /* detach from the terminal */
1028 #ifdef HAVE_SETSID
1029 if (!no_process_group) setsid();
1030 #elif defined(TIOCNOTTY)
1031 if (!no_process_group) {
1032 int i = sys_open("/dev/tty", O_RDWR, 0);
1033 if (i != -1) {
1034 ioctl(i, (int) TIOCNOTTY, (char *)0);
1035 close(i);
1038 #endif /* HAVE_SETSID */
1040 /* Close fd's 0,1,2. Needed if started by rsh */
1041 close_low_fds(False); /* Don't close stderr, let the debug system
1042 attach it to the logfile */
1045 bool reinit_after_fork(struct messaging_context *msg_ctx,
1046 bool parent_longlived)
1048 NTSTATUS status;
1050 /* Reset the state of the random
1051 * number generation system, so
1052 * children do not get the same random
1053 * numbers as each other */
1054 set_need_random_reseed();
1056 /* tdb needs special fork handling */
1057 if (tdb_reopen_all(parent_longlived ? 1 : 0) == -1) {
1058 DEBUG(0,("tdb_reopen_all failed.\n"));
1059 return false;
1063 * For clustering, we need to re-init our ctdbd connection after the
1064 * fork
1066 status = messaging_reinit(msg_ctx);
1067 if (!NT_STATUS_IS_OK(status)) {
1068 DEBUG(0,("messaging_reinit() failed: %s\n",
1069 nt_errstr(status)));
1070 return false;
1073 return true;
1076 /****************************************************************************
1077 Put up a yes/no prompt.
1078 ****************************************************************************/
1080 bool yesno(const char *p)
1082 char ans[20];
1083 printf("%s",p);
1085 if (!fgets(ans,sizeof(ans)-1,stdin))
1086 return(False);
1088 if (*ans == 'y' || *ans == 'Y')
1089 return(True);
1091 return(False);
1094 #if defined(PARANOID_MALLOC_CHECKER)
1096 /****************************************************************************
1097 Internal malloc wrapper. Externally visible.
1098 ****************************************************************************/
1100 void *malloc_(size_t size)
1102 if (size == 0) {
1103 return NULL;
1105 #undef malloc
1106 return malloc(size);
1107 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
1110 /****************************************************************************
1111 Internal calloc wrapper. Not externally visible.
1112 ****************************************************************************/
1114 static void *calloc_(size_t count, size_t size)
1116 if (size == 0 || count == 0) {
1117 return NULL;
1119 #undef calloc
1120 return calloc(count, size);
1121 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
1124 /****************************************************************************
1125 Internal realloc wrapper. Not externally visible.
1126 ****************************************************************************/
1128 static void *realloc_(void *ptr, size_t size)
1130 #undef realloc
1131 return realloc(ptr, size);
1132 #define realloc(p,s) __ERROR_DONT_USE_RELLOC_DIRECTLY
1135 #endif /* PARANOID_MALLOC_CHECKER */
1137 /****************************************************************************
1138 Type-safe malloc.
1139 ****************************************************************************/
1141 void *malloc_array(size_t el_size, unsigned int count)
1143 if (count >= MAX_ALLOC_SIZE/el_size) {
1144 return NULL;
1147 if (el_size == 0 || count == 0) {
1148 return NULL;
1150 #if defined(PARANOID_MALLOC_CHECKER)
1151 return malloc_(el_size*count);
1152 #else
1153 return malloc(el_size*count);
1154 #endif
1157 /****************************************************************************
1158 Type-safe memalign
1159 ****************************************************************************/
1161 void *memalign_array(size_t el_size, size_t align, unsigned int count)
1163 if (count >= MAX_ALLOC_SIZE/el_size) {
1164 return NULL;
1167 return sys_memalign(align, el_size*count);
1170 /****************************************************************************
1171 Type-safe calloc.
1172 ****************************************************************************/
1174 void *calloc_array(size_t size, size_t nmemb)
1176 if (nmemb >= MAX_ALLOC_SIZE/size) {
1177 return NULL;
1179 if (size == 0 || nmemb == 0) {
1180 return NULL;
1182 #if defined(PARANOID_MALLOC_CHECKER)
1183 return calloc_(nmemb, size);
1184 #else
1185 return calloc(nmemb, size);
1186 #endif
1189 /****************************************************************************
1190 Expand a pointer to be a particular size.
1191 Note that this version of Realloc has an extra parameter that decides
1192 whether to free the passed in storage on allocation failure or if the
1193 new size is zero.
1195 This is designed for use in the typical idiom of :
1197 p = SMB_REALLOC(p, size)
1198 if (!p) {
1199 return error;
1202 and not to have to keep track of the old 'p' contents to free later, nor
1203 to worry if the size parameter was zero. In the case where NULL is returned
1204 we guarentee that p has been freed.
1206 If free later semantics are desired, then pass 'free_old_on_error' as False which
1207 guarentees that the old contents are not freed on error, even if size == 0. To use
1208 this idiom use :
1210 tmp = SMB_REALLOC_KEEP_OLD_ON_ERROR(p, size);
1211 if (!tmp) {
1212 SAFE_FREE(p);
1213 return error;
1214 } else {
1215 p = tmp;
1218 Changes were instigated by Coverity error checking. JRA.
1219 ****************************************************************************/
1221 void *Realloc(void *p, size_t size, bool free_old_on_error)
1223 void *ret=NULL;
1225 if (size == 0) {
1226 if (free_old_on_error) {
1227 SAFE_FREE(p);
1229 DEBUG(2,("Realloc asked for 0 bytes\n"));
1230 return NULL;
1233 #if defined(PARANOID_MALLOC_CHECKER)
1234 if (!p) {
1235 ret = (void *)malloc_(size);
1236 } else {
1237 ret = (void *)realloc_(p,size);
1239 #else
1240 if (!p) {
1241 ret = (void *)malloc(size);
1242 } else {
1243 ret = (void *)realloc(p,size);
1245 #endif
1247 if (!ret) {
1248 if (free_old_on_error && p) {
1249 SAFE_FREE(p);
1251 DEBUG(0,("Memory allocation error: failed to expand to %d bytes\n",(int)size));
1254 return(ret);
1257 /****************************************************************************
1258 Type-safe realloc.
1259 ****************************************************************************/
1261 void *realloc_array(void *p, size_t el_size, unsigned int count, bool free_old_on_error)
1263 if (count >= MAX_ALLOC_SIZE/el_size) {
1264 if (free_old_on_error) {
1265 SAFE_FREE(p);
1267 return NULL;
1269 return Realloc(p, el_size*count, free_old_on_error);
1272 /****************************************************************************
1273 (Hopefully) efficient array append.
1274 ****************************************************************************/
1276 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
1277 void *element, void *_array, uint32 *num_elements,
1278 ssize_t *array_size)
1280 void **array = (void **)_array;
1282 if (*array_size < 0) {
1283 return;
1286 if (*array == NULL) {
1287 if (*array_size == 0) {
1288 *array_size = 128;
1291 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1292 goto error;
1295 *array = TALLOC(mem_ctx, element_size * (*array_size));
1296 if (*array == NULL) {
1297 goto error;
1301 if (*num_elements == *array_size) {
1302 *array_size *= 2;
1304 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1305 goto error;
1308 *array = TALLOC_REALLOC(mem_ctx, *array,
1309 element_size * (*array_size));
1311 if (*array == NULL) {
1312 goto error;
1316 memcpy((char *)(*array) + element_size*(*num_elements),
1317 element, element_size);
1318 *num_elements += 1;
1320 return;
1322 error:
1323 *num_elements = 0;
1324 *array_size = -1;
1327 /****************************************************************************
1328 Free memory, checks for NULL.
1329 Use directly SAFE_FREE()
1330 Exists only because we need to pass a function pointer somewhere --SSS
1331 ****************************************************************************/
1333 void safe_free(void *p)
1335 SAFE_FREE(p);
1338 /****************************************************************************
1339 Get my own name and IP.
1340 ****************************************************************************/
1342 char *get_myname(TALLOC_CTX *ctx)
1344 char *p;
1345 char hostname[HOST_NAME_MAX];
1347 *hostname = 0;
1349 /* get my host name */
1350 if (gethostname(hostname, sizeof(hostname)) == -1) {
1351 DEBUG(0,("gethostname failed\n"));
1352 return False;
1355 /* Ensure null termination. */
1356 hostname[sizeof(hostname)-1] = '\0';
1358 /* split off any parts after an initial . */
1359 p = strchr_m(hostname,'.');
1360 if (p) {
1361 *p = 0;
1364 return talloc_strdup(ctx, hostname);
1367 /****************************************************************************
1368 Get my own domain name, or "" if we have none.
1369 ****************************************************************************/
1371 char *get_mydnsdomname(TALLOC_CTX *ctx)
1373 const char *domname;
1374 char *p;
1376 domname = get_mydnsfullname();
1377 if (!domname) {
1378 return NULL;
1381 p = strchr_m(domname, '.');
1382 if (p) {
1383 p++;
1384 return talloc_strdup(ctx, p);
1385 } else {
1386 return talloc_strdup(ctx, "");
1390 /****************************************************************************
1391 Interpret a protocol description string, with a default.
1392 ****************************************************************************/
1394 int interpret_protocol(const char *str,int def)
1396 if (strequal(str,"NT1"))
1397 return(PROTOCOL_NT1);
1398 if (strequal(str,"LANMAN2"))
1399 return(PROTOCOL_LANMAN2);
1400 if (strequal(str,"LANMAN1"))
1401 return(PROTOCOL_LANMAN1);
1402 if (strequal(str,"CORE"))
1403 return(PROTOCOL_CORE);
1404 if (strequal(str,"COREPLUS"))
1405 return(PROTOCOL_COREPLUS);
1406 if (strequal(str,"CORE+"))
1407 return(PROTOCOL_COREPLUS);
1409 DEBUG(0,("Unrecognised protocol level %s\n",str));
1411 return(def);
1415 #if (defined(HAVE_NETGROUP) && defined(WITH_AUTOMOUNT))
1416 /******************************************************************
1417 Remove any mount options such as -rsize=2048,wsize=2048 etc.
1418 Based on a fix from <Thomas.Hepper@icem.de>.
1419 Returns a malloc'ed string.
1420 *******************************************************************/
1422 static char *strip_mount_options(TALLOC_CTX *ctx, const char *str)
1424 if (*str == '-') {
1425 const char *p = str;
1426 while(*p && !isspace(*p))
1427 p++;
1428 while(*p && isspace(*p))
1429 p++;
1430 if(*p) {
1431 return talloc_strdup(ctx, p);
1434 return NULL;
1437 /*******************************************************************
1438 Patch from jkf@soton.ac.uk
1439 Split Luke's automount_server into YP lookup and string splitter
1440 so can easily implement automount_path().
1441 Returns a malloc'ed string.
1442 *******************************************************************/
1444 #ifdef WITH_NISPLUS_HOME
1445 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
1447 char *value = NULL;
1449 char *nis_map = (char *)lp_nis_home_map_name();
1451 char buffer[NIS_MAXATTRVAL + 1];
1452 nis_result *result;
1453 nis_object *object;
1454 entry_obj *entry;
1456 snprintf(buffer, sizeof(buffer), "[key=%s],%s", user_name, nis_map);
1457 DEBUG(5, ("NIS+ querystring: %s\n", buffer));
1459 if (result = nis_list(buffer, FOLLOW_PATH|EXPAND_NAME|HARD_LOOKUP, NULL, NULL)) {
1460 if (result->status != NIS_SUCCESS) {
1461 DEBUG(3, ("NIS+ query failed: %s\n", nis_sperrno(result->status)));
1462 } else {
1463 object = result->objects.objects_val;
1464 if (object->zo_data.zo_type == ENTRY_OBJ) {
1465 entry = &object->zo_data.objdata_u.en_data;
1466 DEBUG(5, ("NIS+ entry type: %s\n", entry->en_type));
1467 DEBUG(3, ("NIS+ result: %s\n", entry->en_cols.en_cols_val[1].ec_value.ec_value_val));
1469 value = talloc_strdup(ctx,
1470 entry->en_cols.en_cols_val[1].ec_value.ec_value_val);
1471 if (!value) {
1472 nis_freeresult(result);
1473 return NULL;
1475 value = talloc_string_sub(ctx,
1476 value,
1477 "&",
1478 user_name);
1482 nis_freeresult(result);
1484 if (value) {
1485 value = strip_mount_options(ctx, value);
1486 DEBUG(4, ("NIS+ Lookup: %s resulted in %s\n",
1487 user_name, value));
1489 return value;
1491 #else /* WITH_NISPLUS_HOME */
1493 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
1495 char *value = NULL;
1497 int nis_error; /* returned by yp all functions */
1498 char *nis_result; /* yp_match inits this */
1499 int nis_result_len; /* and set this */
1500 char *nis_domain; /* yp_get_default_domain inits this */
1501 char *nis_map = (char *)lp_nis_home_map_name();
1503 if ((nis_error = yp_get_default_domain(&nis_domain)) != 0) {
1504 DEBUG(3, ("YP Error: %s\n", yperr_string(nis_error)));
1505 return NULL;
1508 DEBUG(5, ("NIS Domain: %s\n", nis_domain));
1510 if ((nis_error = yp_match(nis_domain, nis_map, user_name,
1511 strlen(user_name), &nis_result,
1512 &nis_result_len)) == 0) {
1513 value = talloc_strdup(ctx, nis_result);
1514 if (!value) {
1515 return NULL;
1517 value = strip_mount_options(ctx, value);
1518 } else if(nis_error == YPERR_KEY) {
1519 DEBUG(3, ("YP Key not found: while looking up \"%s\" in map \"%s\"\n",
1520 user_name, nis_map));
1521 DEBUG(3, ("using defaults for server and home directory\n"));
1522 } else {
1523 DEBUG(3, ("YP Error: \"%s\" while looking up \"%s\" in map \"%s\"\n",
1524 yperr_string(nis_error), user_name, nis_map));
1527 if (value) {
1528 DEBUG(4, ("YP Lookup: %s resulted in %s\n", user_name, value));
1530 return value;
1532 #endif /* WITH_NISPLUS_HOME */
1533 #endif
1535 /****************************************************************************
1536 Check if a process exists. Does this work on all unixes?
1537 ****************************************************************************/
1539 bool process_exists(const struct server_id pid)
1541 if (procid_is_me(&pid)) {
1542 return True;
1545 if (procid_is_local(&pid)) {
1546 return (kill(pid.pid,0) == 0 || errno != ESRCH);
1549 #ifdef CLUSTER_SUPPORT
1550 return ctdbd_process_exists(messaging_ctdbd_connection(), pid.vnn,
1551 pid.pid);
1552 #else
1553 return False;
1554 #endif
1557 bool process_exists_by_pid(pid_t pid)
1559 /* Doing kill with a non-positive pid causes messages to be
1560 * sent to places we don't want. */
1561 SMB_ASSERT(pid > 0);
1562 return(kill(pid,0) == 0 || errno != ESRCH);
1565 /*******************************************************************
1566 Convert a uid into a user name.
1567 ********************************************************************/
1569 const char *uidtoname(uid_t uid)
1571 TALLOC_CTX *ctx = talloc_tos();
1572 char *name = NULL;
1573 struct passwd *pass = NULL;
1575 pass = getpwuid_alloc(ctx,uid);
1576 if (pass) {
1577 name = talloc_strdup(ctx,pass->pw_name);
1578 TALLOC_FREE(pass);
1579 } else {
1580 name = talloc_asprintf(ctx,
1581 "%ld",
1582 (long int)uid);
1584 return name;
1587 /*******************************************************************
1588 Convert a gid into a group name.
1589 ********************************************************************/
1591 char *gidtoname(gid_t gid)
1593 struct group *grp;
1595 grp = getgrgid(gid);
1596 if (grp) {
1597 return talloc_strdup(talloc_tos(), grp->gr_name);
1599 else {
1600 return talloc_asprintf(talloc_tos(),
1601 "%d",
1602 (int)gid);
1606 /*******************************************************************
1607 Convert a user name into a uid.
1608 ********************************************************************/
1610 uid_t nametouid(const char *name)
1612 struct passwd *pass;
1613 char *p;
1614 uid_t u;
1616 pass = getpwnam_alloc(NULL, name);
1617 if (pass) {
1618 u = pass->pw_uid;
1619 TALLOC_FREE(pass);
1620 return u;
1623 u = (uid_t)strtol(name, &p, 0);
1624 if ((p != name) && (*p == '\0'))
1625 return u;
1627 return (uid_t)-1;
1630 /*******************************************************************
1631 Convert a name to a gid_t if possible. Return -1 if not a group.
1632 ********************************************************************/
1634 gid_t nametogid(const char *name)
1636 struct group *grp;
1637 char *p;
1638 gid_t g;
1640 g = (gid_t)strtol(name, &p, 0);
1641 if ((p != name) && (*p == '\0'))
1642 return g;
1644 grp = sys_getgrnam(name);
1645 if (grp)
1646 return(grp->gr_gid);
1647 return (gid_t)-1;
1650 /*******************************************************************
1651 Something really nasty happened - panic !
1652 ********************************************************************/
1654 void smb_panic(const char *const why)
1656 char *cmd;
1657 int result;
1659 #ifdef DEVELOPER
1662 if (global_clobber_region_function) {
1663 DEBUG(0,("smb_panic: clobber_region() last called from [%s(%u)]\n",
1664 global_clobber_region_function,
1665 global_clobber_region_line));
1668 #endif
1670 DEBUG(0,("PANIC (pid %llu): %s\n",
1671 (unsigned long long)sys_getpid(), why));
1672 log_stack_trace();
1674 cmd = lp_panic_action();
1675 if (cmd && *cmd) {
1676 DEBUG(0, ("smb_panic(): calling panic action [%s]\n", cmd));
1677 result = system(cmd);
1679 if (result == -1)
1680 DEBUG(0, ("smb_panic(): fork failed in panic action: %s\n",
1681 strerror(errno)));
1682 else
1683 DEBUG(0, ("smb_panic(): action returned status %d\n",
1684 WEXITSTATUS(result)));
1687 dump_core();
1690 /*******************************************************************
1691 Print a backtrace of the stack to the debug log. This function
1692 DELIBERATELY LEAKS MEMORY. The expectation is that you should
1693 exit shortly after calling it.
1694 ********************************************************************/
1696 #ifdef HAVE_LIBUNWIND_H
1697 #include <libunwind.h>
1698 #endif
1700 #ifdef HAVE_EXECINFO_H
1701 #include <execinfo.h>
1702 #endif
1704 #ifdef HAVE_LIBEXC_H
1705 #include <libexc.h>
1706 #endif
1708 void log_stack_trace(void)
1710 #ifdef HAVE_LIBUNWIND
1711 /* Try to use libunwind before any other technique since on ia64
1712 * libunwind correctly walks the stack in more circumstances than
1713 * backtrace.
1715 unw_cursor_t cursor;
1716 unw_context_t uc;
1717 unsigned i = 0;
1719 char procname[256];
1720 unw_word_t ip, sp, off;
1722 procname[sizeof(procname) - 1] = '\0';
1724 if (unw_getcontext(&uc) != 0) {
1725 goto libunwind_failed;
1728 if (unw_init_local(&cursor, &uc) != 0) {
1729 goto libunwind_failed;
1732 DEBUG(0, ("BACKTRACE:\n"));
1734 do {
1735 ip = sp = 0;
1736 unw_get_reg(&cursor, UNW_REG_IP, &ip);
1737 unw_get_reg(&cursor, UNW_REG_SP, &sp);
1739 switch (unw_get_proc_name(&cursor,
1740 procname, sizeof(procname) - 1, &off) ) {
1741 case 0:
1742 /* Name found. */
1743 case -UNW_ENOMEM:
1744 /* Name truncated. */
1745 DEBUGADD(0, (" #%u %s + %#llx [ip=%#llx] [sp=%#llx]\n",
1746 i, procname, (long long)off,
1747 (long long)ip, (long long) sp));
1748 break;
1749 default:
1750 /* case -UNW_ENOINFO: */
1751 /* case -UNW_EUNSPEC: */
1752 /* No symbol name found. */
1753 DEBUGADD(0, (" #%u %s [ip=%#llx] [sp=%#llx]\n",
1754 i, "<unknown symbol>",
1755 (long long)ip, (long long) sp));
1757 ++i;
1758 } while (unw_step(&cursor) > 0);
1760 return;
1762 libunwind_failed:
1763 DEBUG(0, ("unable to produce a stack trace with libunwind\n"));
1765 #elif HAVE_BACKTRACE_SYMBOLS
1766 void *backtrace_stack[BACKTRACE_STACK_SIZE];
1767 size_t backtrace_size;
1768 char **backtrace_strings;
1770 /* get the backtrace (stack frames) */
1771 backtrace_size = backtrace(backtrace_stack,BACKTRACE_STACK_SIZE);
1772 backtrace_strings = backtrace_symbols(backtrace_stack, backtrace_size);
1774 DEBUG(0, ("BACKTRACE: %lu stack frames:\n",
1775 (unsigned long)backtrace_size));
1777 if (backtrace_strings) {
1778 int i;
1780 for (i = 0; i < backtrace_size; i++)
1781 DEBUGADD(0, (" #%u %s\n", i, backtrace_strings[i]));
1783 /* Leak the backtrace_strings, rather than risk what free() might do */
1786 #elif HAVE_LIBEXC
1788 /* The IRIX libexc library provides an API for unwinding the stack. See
1789 * libexc(3) for details. Apparantly trace_back_stack leaks memory, but
1790 * since we are about to abort anyway, it hardly matters.
1793 #define NAMESIZE 32 /* Arbitrary */
1795 __uint64_t addrs[BACKTRACE_STACK_SIZE];
1796 char * names[BACKTRACE_STACK_SIZE];
1797 char namebuf[BACKTRACE_STACK_SIZE * NAMESIZE];
1799 int i;
1800 int levels;
1802 ZERO_ARRAY(addrs);
1803 ZERO_ARRAY(names);
1804 ZERO_ARRAY(namebuf);
1806 /* We need to be root so we can open our /proc entry to walk
1807 * our stack. It also helps when we want to dump core.
1809 become_root();
1811 for (i = 0; i < BACKTRACE_STACK_SIZE; i++) {
1812 names[i] = namebuf + (i * NAMESIZE);
1815 levels = trace_back_stack(0, addrs, names,
1816 BACKTRACE_STACK_SIZE, NAMESIZE - 1);
1818 DEBUG(0, ("BACKTRACE: %d stack frames:\n", levels));
1819 for (i = 0; i < levels; i++) {
1820 DEBUGADD(0, (" #%d 0x%llx %s\n", i, addrs[i], names[i]));
1822 #undef NAMESIZE
1824 #else
1825 DEBUG(0, ("unable to produce a stack trace on this platform\n"));
1826 #endif
1829 /*******************************************************************
1830 A readdir wrapper which just returns the file name.
1831 ********************************************************************/
1833 const char *readdirname(SMB_STRUCT_DIR *p)
1835 SMB_STRUCT_DIRENT *ptr;
1836 char *dname;
1838 if (!p)
1839 return(NULL);
1841 ptr = (SMB_STRUCT_DIRENT *)sys_readdir(p);
1842 if (!ptr)
1843 return(NULL);
1845 dname = ptr->d_name;
1847 #ifdef NEXT2
1848 if (telldir(p) < 0)
1849 return(NULL);
1850 #endif
1852 #ifdef HAVE_BROKEN_READDIR_NAME
1853 /* using /usr/ucb/cc is BAD */
1854 dname = dname - 2;
1855 #endif
1857 return talloc_strdup(talloc_tos(), dname);
1860 /*******************************************************************
1861 Utility function used to decide if the last component
1862 of a path matches a (possibly wildcarded) entry in a namelist.
1863 ********************************************************************/
1865 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive)
1867 const char *last_component;
1869 /* if we have no list it's obviously not in the path */
1870 if((namelist == NULL ) || ((namelist != NULL) && (namelist[0].name == NULL))) {
1871 return False;
1874 DEBUG(8, ("is_in_path: %s\n", name));
1876 /* Get the last component of the unix name. */
1877 last_component = strrchr_m(name, '/');
1878 if (!last_component) {
1879 last_component = name;
1880 } else {
1881 last_component++; /* Go past '/' */
1884 for(; namelist->name != NULL; namelist++) {
1885 if(namelist->is_wild) {
1886 if (mask_match(last_component, namelist->name, case_sensitive)) {
1887 DEBUG(8,("is_in_path: mask match succeeded\n"));
1888 return True;
1890 } else {
1891 if((case_sensitive && (strcmp(last_component, namelist->name) == 0))||
1892 (!case_sensitive && (StrCaseCmp(last_component, namelist->name) == 0))) {
1893 DEBUG(8,("is_in_path: match succeeded\n"));
1894 return True;
1898 DEBUG(8,("is_in_path: match not found\n"));
1899 return False;
1902 /*******************************************************************
1903 Strip a '/' separated list into an array of
1904 name_compare_enties structures suitable for
1905 passing to is_in_path(). We do this for
1906 speed so we can pre-parse all the names in the list
1907 and don't do it for each call to is_in_path().
1908 namelist is modified here and is assumed to be
1909 a copy owned by the caller.
1910 We also check if the entry contains a wildcard to
1911 remove a potentially expensive call to mask_match
1912 if possible.
1913 ********************************************************************/
1915 void set_namearray(name_compare_entry **ppname_array, const char *namelist)
1917 char *name_end;
1918 const char *nameptr = namelist;
1919 int num_entries = 0;
1920 int i;
1922 (*ppname_array) = NULL;
1924 if((nameptr == NULL ) || ((nameptr != NULL) && (*nameptr == '\0')))
1925 return;
1927 /* We need to make two passes over the string. The
1928 first to count the number of elements, the second
1929 to split it.
1932 while(*nameptr) {
1933 if ( *nameptr == '/' ) {
1934 /* cope with multiple (useless) /s) */
1935 nameptr++;
1936 continue;
1938 /* find the next / */
1939 name_end = strchr_m(nameptr, '/');
1941 /* oops - the last check for a / didn't find one. */
1942 if (name_end == NULL)
1943 break;
1945 /* next segment please */
1946 nameptr = name_end + 1;
1947 num_entries++;
1950 if(num_entries == 0)
1951 return;
1953 if(( (*ppname_array) = SMB_MALLOC_ARRAY(name_compare_entry, num_entries + 1)) == NULL) {
1954 DEBUG(0,("set_namearray: malloc fail\n"));
1955 return;
1958 /* Now copy out the names */
1959 nameptr = namelist;
1960 i = 0;
1961 while(*nameptr) {
1962 if ( *nameptr == '/' ) {
1963 /* cope with multiple (useless) /s) */
1964 nameptr++;
1965 continue;
1967 /* find the next / */
1968 if ((name_end = strchr_m(nameptr, '/')) != NULL)
1969 *name_end = 0;
1971 /* oops - the last check for a / didn't find one. */
1972 if(name_end == NULL)
1973 break;
1975 (*ppname_array)[i].is_wild = ms_has_wild(nameptr);
1976 if(((*ppname_array)[i].name = SMB_STRDUP(nameptr)) == NULL) {
1977 DEBUG(0,("set_namearray: malloc fail (1)\n"));
1978 return;
1981 /* next segment please */
1982 nameptr = name_end + 1;
1983 i++;
1986 (*ppname_array)[i].name = NULL;
1988 return;
1991 /****************************************************************************
1992 Routine to free a namearray.
1993 ****************************************************************************/
1995 void free_namearray(name_compare_entry *name_array)
1997 int i;
1999 if(name_array == NULL)
2000 return;
2002 for(i=0; name_array[i].name!=NULL; i++)
2003 SAFE_FREE(name_array[i].name);
2004 SAFE_FREE(name_array);
2007 #undef DBGC_CLASS
2008 #define DBGC_CLASS DBGC_LOCKING
2010 /****************************************************************************
2011 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
2012 is dealt with in posix.c
2013 Returns True if the lock was granted, False otherwise.
2014 ****************************************************************************/
2016 bool fcntl_lock(int fd, int op, SMB_OFF_T offset, SMB_OFF_T count, int type)
2018 SMB_STRUCT_FLOCK lock;
2019 int ret;
2021 DEBUG(8,("fcntl_lock fd=%d op=%d offset=%.0f count=%.0f type=%d\n",
2022 fd,op,(double)offset,(double)count,type));
2024 lock.l_type = type;
2025 lock.l_whence = SEEK_SET;
2026 lock.l_start = offset;
2027 lock.l_len = count;
2028 lock.l_pid = 0;
2030 ret = sys_fcntl_ptr(fd,op,&lock);
2032 if (ret == -1) {
2033 int sav = errno;
2034 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
2035 (double)offset,(double)count,op,type,strerror(errno)));
2036 errno = sav;
2037 return False;
2040 /* everything went OK */
2041 DEBUG(8,("fcntl_lock: Lock call successful\n"));
2043 return True;
2046 /****************************************************************************
2047 Simple routine to query existing file locks. Cruft in NFS and 64->32 bit mapping
2048 is dealt with in posix.c
2049 Returns True if we have information regarding this lock region (and returns
2050 F_UNLCK in *ptype if the region is unlocked). False if the call failed.
2051 ****************************************************************************/
2053 bool fcntl_getlock(int fd, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid)
2055 SMB_STRUCT_FLOCK lock;
2056 int ret;
2058 DEBUG(8,("fcntl_getlock fd=%d offset=%.0f count=%.0f type=%d\n",
2059 fd,(double)*poffset,(double)*pcount,*ptype));
2061 lock.l_type = *ptype;
2062 lock.l_whence = SEEK_SET;
2063 lock.l_start = *poffset;
2064 lock.l_len = *pcount;
2065 lock.l_pid = 0;
2067 ret = sys_fcntl_ptr(fd,SMB_F_GETLK,&lock);
2069 if (ret == -1) {
2070 int sav = errno;
2071 DEBUG(3,("fcntl_getlock: lock request failed at offset %.0f count %.0f type %d (%s)\n",
2072 (double)*poffset,(double)*pcount,*ptype,strerror(errno)));
2073 errno = sav;
2074 return False;
2077 *ptype = lock.l_type;
2078 *poffset = lock.l_start;
2079 *pcount = lock.l_len;
2080 *ppid = lock.l_pid;
2082 DEBUG(3,("fcntl_getlock: fd %d is returned info %d pid %u\n",
2083 fd, (int)lock.l_type, (unsigned int)lock.l_pid));
2084 return True;
2087 #undef DBGC_CLASS
2088 #define DBGC_CLASS DBGC_ALL
2090 /*******************************************************************
2091 Is the name specified one of my netbios names.
2092 Returns true if it is equal, false otherwise.
2093 ********************************************************************/
2095 bool is_myname(const char *s)
2097 int n;
2098 bool ret = False;
2100 for (n=0; my_netbios_names(n); n++) {
2101 if (strequal(my_netbios_names(n), s)) {
2102 ret=True;
2103 break;
2106 DEBUG(8, ("is_myname(\"%s\") returns %d\n", s, ret));
2107 return(ret);
2110 /*******************************************************************
2111 Is the name specified our workgroup/domain.
2112 Returns true if it is equal, false otherwise.
2113 ********************************************************************/
2115 bool is_myworkgroup(const char *s)
2117 bool ret = False;
2119 if (strequal(s, lp_workgroup())) {
2120 ret=True;
2123 DEBUG(8, ("is_myworkgroup(\"%s\") returns %d\n", s, ret));
2124 return(ret);
2127 /*******************************************************************
2128 we distinguish between 2K and XP by the "Native Lan Manager" string
2129 WinXP => "Windows 2002 5.1"
2130 WinXP 64bit => "Windows XP 5.2"
2131 Win2k => "Windows 2000 5.0"
2132 NT4 => "Windows NT 4.0"
2133 Win9x => "Windows 4.0"
2134 Windows 2003 doesn't set the native lan manager string but
2135 they do set the domain to "Windows 2003 5.2" (probably a bug).
2136 ********************************************************************/
2138 void ra_lanman_string( const char *native_lanman )
2140 if ( strcmp( native_lanman, "Windows 2002 5.1" ) == 0 )
2141 set_remote_arch( RA_WINXP );
2142 else if ( strcmp( native_lanman, "Windows XP 5.2" ) == 0 )
2143 set_remote_arch( RA_WINXP64 );
2144 else if ( strcmp( native_lanman, "Windows Server 2003 5.2" ) == 0 )
2145 set_remote_arch( RA_WIN2K3 );
2148 static const char *remote_arch_str;
2150 const char *get_remote_arch_str(void)
2152 if (!remote_arch_str) {
2153 return "UNKNOWN";
2155 return remote_arch_str;
2158 /*******************************************************************
2159 Set the horrid remote_arch string based on an enum.
2160 ********************************************************************/
2162 void set_remote_arch(enum remote_arch_types type)
2164 ra_type = type;
2165 switch( type ) {
2166 case RA_WFWG:
2167 remote_arch_str = "WfWg";
2168 break;
2169 case RA_OS2:
2170 remote_arch_str = "OS2";
2171 break;
2172 case RA_WIN95:
2173 remote_arch_str = "Win95";
2174 break;
2175 case RA_WINNT:
2176 remote_arch_str = "WinNT";
2177 break;
2178 case RA_WIN2K:
2179 remote_arch_str = "Win2K";
2180 break;
2181 case RA_WINXP:
2182 remote_arch_str = "WinXP";
2183 break;
2184 case RA_WINXP64:
2185 remote_arch_str = "WinXP64";
2186 break;
2187 case RA_WIN2K3:
2188 remote_arch_str = "Win2K3";
2189 break;
2190 case RA_VISTA:
2191 remote_arch_str = "Vista";
2192 break;
2193 case RA_SAMBA:
2194 remote_arch_str = "Samba";
2195 break;
2196 case RA_CIFSFS:
2197 remote_arch_str = "CIFSFS";
2198 break;
2199 default:
2200 ra_type = RA_UNKNOWN;
2201 remote_arch_str = "UNKNOWN";
2202 break;
2205 DEBUG(10,("set_remote_arch: Client arch is \'%s\'\n",
2206 remote_arch_str));
2209 /*******************************************************************
2210 Get the remote_arch type.
2211 ********************************************************************/
2213 enum remote_arch_types get_remote_arch(void)
2215 return ra_type;
2218 void print_asc(int level, const unsigned char *buf,int len)
2220 int i;
2221 for (i=0;i<len;i++)
2222 DEBUG(level,("%c", isprint(buf[i])?buf[i]:'.'));
2225 void dump_data(int level, const unsigned char *buf1,int len)
2227 const unsigned char *buf = (const unsigned char *)buf1;
2228 int i=0;
2229 if (len<=0) return;
2231 if (!DEBUGLVL(level)) return;
2233 DEBUGADD(level,("[%03X] ",i));
2234 for (i=0;i<len;) {
2235 DEBUGADD(level,("%02X ",(int)buf[i]));
2236 i++;
2237 if (i%8 == 0) DEBUGADD(level,(" "));
2238 if (i%16 == 0) {
2239 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
2240 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
2241 if (i<len) DEBUGADD(level,("[%03X] ",i));
2244 if (i%16) {
2245 int n;
2246 n = 16 - (i%16);
2247 DEBUGADD(level,(" "));
2248 if (n>8) DEBUGADD(level,(" "));
2249 while (n--) DEBUGADD(level,(" "));
2250 n = MIN(8,i%16);
2251 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
2252 n = (i%16) - n;
2253 if (n>0) print_asc(level,&buf[i-n],n);
2254 DEBUGADD(level,("\n"));
2258 void dump_data_pw(const char *msg, const uchar * data, size_t len)
2260 #ifdef DEBUG_PASSWORD
2261 DEBUG(11, ("%s", msg));
2262 if (data != NULL && len > 0)
2264 dump_data(11, data, len);
2266 #endif
2269 const char *tab_depth(int level, int depth)
2271 if( CHECK_DEBUGLVL(level) ) {
2272 dbgtext("%*s", depth*4, "");
2274 return "";
2277 /*****************************************************************************
2278 Provide a checksum on a string
2280 Input: s - the null-terminated character string for which the checksum
2281 will be calculated.
2283 Output: The checksum value calculated for s.
2284 *****************************************************************************/
2286 int str_checksum(const char *s)
2288 int res = 0;
2289 int c;
2290 int i=0;
2292 while(*s) {
2293 c = *s;
2294 res ^= (c << (i % 15)) ^ (c >> (15-(i%15)));
2295 s++;
2296 i++;
2298 return(res);
2301 /*****************************************************************
2302 Zero a memory area then free it. Used to catch bugs faster.
2303 *****************************************************************/
2305 void zero_free(void *p, size_t size)
2307 memset(p, 0, size);
2308 SAFE_FREE(p);
2311 /*****************************************************************
2312 Set our open file limit to a requested max and return the limit.
2313 *****************************************************************/
2315 int set_maxfiles(int requested_max)
2317 #if (defined(HAVE_GETRLIMIT) && defined(RLIMIT_NOFILE))
2318 struct rlimit rlp;
2319 int saved_current_limit;
2321 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2322 DEBUG(0,("set_maxfiles: getrlimit (1) for RLIMIT_NOFILE failed with error %s\n",
2323 strerror(errno) ));
2324 /* just guess... */
2325 return requested_max;
2329 * Set the fd limit to be real_max_open_files + MAX_OPEN_FUDGEFACTOR to
2330 * account for the extra fd we need
2331 * as well as the log files and standard
2332 * handles etc. Save the limit we want to set in case
2333 * we are running on an OS that doesn't support this limit (AIX)
2334 * which always returns RLIM_INFINITY for rlp.rlim_max.
2337 /* Try raising the hard (max) limit to the requested amount. */
2339 #if defined(RLIM_INFINITY)
2340 if (rlp.rlim_max != RLIM_INFINITY) {
2341 int orig_max = rlp.rlim_max;
2343 if ( rlp.rlim_max < requested_max )
2344 rlp.rlim_max = requested_max;
2346 /* This failing is not an error - many systems (Linux) don't
2347 support our default request of 10,000 open files. JRA. */
2349 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2350 DEBUG(3,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d max files failed with error %s\n",
2351 (int)rlp.rlim_max, strerror(errno) ));
2353 /* Set failed - restore original value from get. */
2354 rlp.rlim_max = orig_max;
2357 #endif
2359 /* Now try setting the soft (current) limit. */
2361 saved_current_limit = rlp.rlim_cur = MIN(requested_max,rlp.rlim_max);
2363 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2364 DEBUG(0,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d files failed with error %s\n",
2365 (int)rlp.rlim_cur, strerror(errno) ));
2366 /* just guess... */
2367 return saved_current_limit;
2370 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2371 DEBUG(0,("set_maxfiles: getrlimit (2) for RLIMIT_NOFILE failed with error %s\n",
2372 strerror(errno) ));
2373 /* just guess... */
2374 return saved_current_limit;
2377 #if defined(RLIM_INFINITY)
2378 if(rlp.rlim_cur == RLIM_INFINITY)
2379 return saved_current_limit;
2380 #endif
2382 if((int)rlp.rlim_cur > saved_current_limit)
2383 return saved_current_limit;
2385 return rlp.rlim_cur;
2386 #else /* !defined(HAVE_GETRLIMIT) || !defined(RLIMIT_NOFILE) */
2388 * No way to know - just guess...
2390 return requested_max;
2391 #endif
2394 /*****************************************************************
2395 Possibly replace mkstemp if it is broken.
2396 *****************************************************************/
2398 int smb_mkstemp(char *name_template)
2400 #if HAVE_SECURE_MKSTEMP
2401 return mkstemp(name_template);
2402 #else
2403 /* have a reasonable go at emulating it. Hope that
2404 the system mktemp() isn't completly hopeless */
2405 char *p = mktemp(name_template);
2406 if (!p)
2407 return -1;
2408 return open(p, O_CREAT|O_EXCL|O_RDWR, 0600);
2409 #endif
2412 /*****************************************************************
2413 malloc that aborts with smb_panic on fail or zero size.
2414 *****************************************************************/
2416 void *smb_xmalloc_array(size_t size, unsigned int count)
2418 void *p;
2419 if (size == 0) {
2420 smb_panic("smb_xmalloc_array: called with zero size");
2422 if (count >= MAX_ALLOC_SIZE/size) {
2423 smb_panic("smb_xmalloc_array: alloc size too large");
2425 if ((p = SMB_MALLOC(size*count)) == NULL) {
2426 DEBUG(0, ("smb_xmalloc_array failed to allocate %lu * %lu bytes\n",
2427 (unsigned long)size, (unsigned long)count));
2428 smb_panic("smb_xmalloc_array: malloc failed");
2430 return p;
2434 Memdup with smb_panic on fail.
2437 void *smb_xmemdup(const void *p, size_t size)
2439 void *p2;
2440 p2 = SMB_XMALLOC_ARRAY(unsigned char,size);
2441 memcpy(p2, p, size);
2442 return p2;
2446 strdup that aborts on malloc fail.
2449 char *smb_xstrdup(const char *s)
2451 #if defined(PARANOID_MALLOC_CHECKER)
2452 #ifdef strdup
2453 #undef strdup
2454 #endif
2455 #endif
2457 #ifndef HAVE_STRDUP
2458 #define strdup rep_strdup
2459 #endif
2461 char *s1 = strdup(s);
2462 #if defined(PARANOID_MALLOC_CHECKER)
2463 #ifdef strdup
2464 #undef strdup
2465 #endif
2466 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
2467 #endif
2468 if (!s1) {
2469 smb_panic("smb_xstrdup: malloc failed");
2471 return s1;
2476 strndup that aborts on malloc fail.
2479 char *smb_xstrndup(const char *s, size_t n)
2481 #if defined(PARANOID_MALLOC_CHECKER)
2482 #ifdef strndup
2483 #undef strndup
2484 #endif
2485 #endif
2487 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
2488 #undef HAVE_STRNDUP
2489 #define strndup rep_strndup
2490 #endif
2492 char *s1 = strndup(s, n);
2493 #if defined(PARANOID_MALLOC_CHECKER)
2494 #ifdef strndup
2495 #undef strndup
2496 #endif
2497 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
2498 #endif
2499 if (!s1) {
2500 smb_panic("smb_xstrndup: malloc failed");
2502 return s1;
2506 vasprintf that aborts on malloc fail
2509 int smb_xvasprintf(char **ptr, const char *format, va_list ap)
2511 int n;
2512 va_list ap2;
2514 VA_COPY(ap2, ap);
2516 n = vasprintf(ptr, format, ap2);
2517 if (n == -1 || ! *ptr) {
2518 smb_panic("smb_xvasprintf: out of memory");
2520 va_end(ap2);
2521 return n;
2524 /*****************************************************************
2525 Like strdup but for memory.
2526 *****************************************************************/
2528 void *memdup(const void *p, size_t size)
2530 void *p2;
2531 if (size == 0)
2532 return NULL;
2533 p2 = SMB_MALLOC(size);
2534 if (!p2)
2535 return NULL;
2536 memcpy(p2, p, size);
2537 return p2;
2540 /*****************************************************************
2541 Get local hostname and cache result.
2542 *****************************************************************/
2544 char *myhostname(void)
2546 static char *ret;
2547 if (ret == NULL) {
2548 /* This is cached forever so
2549 * use NULL talloc ctx. */
2550 ret = get_myname(NULL);
2552 return ret;
2555 /*****************************************************************
2556 A useful function for returning a path in the Samba pid directory.
2557 *****************************************************************/
2559 static char *xx_path(const char *name, const char *rootpath)
2561 char *fname = NULL;
2563 fname = talloc_strdup(talloc_tos(), rootpath);
2564 if (!fname) {
2565 return NULL;
2567 trim_string(fname,"","/");
2569 if (!directory_exist(fname,NULL)) {
2570 mkdir(fname,0755);
2573 return talloc_asprintf(talloc_tos(),
2574 "%s/%s",
2575 fname,
2576 name);
2579 /*****************************************************************
2580 A useful function for returning a path in the Samba lock directory.
2581 *****************************************************************/
2583 char *lock_path(const char *name)
2585 return xx_path(name, lp_lockdir());
2588 /*****************************************************************
2589 A useful function for returning a path in the Samba pid directory.
2590 *****************************************************************/
2592 char *pid_path(const char *name)
2594 return xx_path(name, lp_piddir());
2598 * @brief Returns an absolute path to a file in the Samba lib directory.
2600 * @param name File to find, relative to LIBDIR.
2602 * @retval Pointer to a string containing the full path.
2605 char *lib_path(const char *name)
2607 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_LIBDIR(), name);
2611 * @brief Returns an absolute path to a file in the Samba data directory.
2613 * @param name File to find, relative to CODEPAGEDIR.
2615 * @retval Pointer to a talloc'ed string containing the full path.
2618 char *data_path(const char *name)
2620 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_CODEPAGEDIR(), name);
2623 /*****************************************************************
2624 a useful function for returning a path in the Samba state directory
2625 *****************************************************************/
2627 char *state_path(const char *name)
2629 return xx_path(name, get_dyn_STATEDIR());
2633 * @brief Returns the platform specific shared library extension.
2635 * @retval Pointer to a const char * containing the extension.
2638 const char *shlib_ext(void)
2640 return get_dyn_SHLIBEXT();
2643 /*******************************************************************
2644 Given a filename - get its directory name
2645 NB: Returned in static storage. Caveats:
2646 o If caller wishes to preserve, they should copy.
2647 ********************************************************************/
2649 char *parent_dirname(const char *path)
2651 char *parent;
2653 if (!parent_dirname_talloc(talloc_tos(), path, &parent, NULL)) {
2654 return NULL;
2657 return parent;
2660 bool parent_dirname_talloc(TALLOC_CTX *mem_ctx, const char *dir,
2661 char **parent, const char **name)
2663 char *p;
2664 ptrdiff_t len;
2666 p = strrchr_m(dir, '/'); /* Find final '/', if any */
2668 if (p == NULL) {
2669 if (!(*parent = talloc_strdup(mem_ctx, "."))) {
2670 return False;
2672 if (name) {
2673 *name = "";
2675 return True;
2678 len = p-dir;
2680 if (!(*parent = TALLOC_ARRAY(mem_ctx, char, len+1))) {
2681 return False;
2683 memcpy(*parent, dir, len);
2684 (*parent)[len] = '\0';
2686 if (name) {
2687 *name = p+1;
2689 return True;
2692 /*******************************************************************
2693 Determine if a pattern contains any Microsoft wildcard characters.
2694 *******************************************************************/
2696 bool ms_has_wild(const char *s)
2698 char c;
2700 if (lp_posix_pathnames()) {
2701 /* With posix pathnames no characters are wild. */
2702 return False;
2705 while ((c = *s++)) {
2706 switch (c) {
2707 case '*':
2708 case '?':
2709 case '<':
2710 case '>':
2711 case '"':
2712 return True;
2715 return False;
2718 bool ms_has_wild_w(const smb_ucs2_t *s)
2720 smb_ucs2_t c;
2721 if (!s) return False;
2722 while ((c = *s++)) {
2723 switch (c) {
2724 case UCS2_CHAR('*'):
2725 case UCS2_CHAR('?'):
2726 case UCS2_CHAR('<'):
2727 case UCS2_CHAR('>'):
2728 case UCS2_CHAR('"'):
2729 return True;
2732 return False;
2735 /*******************************************************************
2736 A wrapper that handles case sensitivity and the special handling
2737 of the ".." name.
2738 *******************************************************************/
2740 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive)
2742 if (strcmp(string,"..") == 0)
2743 string = ".";
2744 if (strcmp(pattern,".") == 0)
2745 return False;
2747 return ms_fnmatch(pattern, string, Protocol <= PROTOCOL_LANMAN2, is_case_sensitive) == 0;
2750 /*******************************************************************
2751 A wrapper that handles case sensitivity and the special handling
2752 of the ".." name. Varient that is only called by old search code which requires
2753 pattern translation.
2754 *******************************************************************/
2756 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive)
2758 if (strcmp(string,"..") == 0)
2759 string = ".";
2760 if (strcmp(pattern,".") == 0)
2761 return False;
2763 return ms_fnmatch(pattern, string, True, is_case_sensitive) == 0;
2766 /*******************************************************************
2767 A wrapper that handles a list of patters and calls mask_match()
2768 on each. Returns True if any of the patterns match.
2769 *******************************************************************/
2771 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive)
2773 while (listLen-- > 0) {
2774 if (mask_match(string, *list++, is_case_sensitive))
2775 return True;
2777 return False;
2780 /*********************************************************
2781 Recursive routine that is called by unix_wild_match.
2782 *********************************************************/
2784 static bool unix_do_match(const char *regexp, const char *str)
2786 const char *p;
2788 for( p = regexp; *p && *str; ) {
2790 switch(*p) {
2791 case '?':
2792 str++;
2793 p++;
2794 break;
2796 case '*':
2799 * Look for a character matching
2800 * the one after the '*'.
2802 p++;
2803 if(!*p)
2804 return true; /* Automatic match */
2805 while(*str) {
2807 while(*str && (*p != *str))
2808 str++;
2811 * Patch from weidel@multichart.de. In the case of the regexp
2812 * '*XX*' we want to ensure there are at least 2 'X' characters
2813 * in the string after the '*' for a match to be made.
2817 int matchcount=0;
2820 * Eat all the characters that match, but count how many there were.
2823 while(*str && (*p == *str)) {
2824 str++;
2825 matchcount++;
2829 * Now check that if the regexp had n identical characters that
2830 * matchcount had at least that many matches.
2833 while ( *(p+1) && (*(p+1) == *p)) {
2834 p++;
2835 matchcount--;
2838 if ( matchcount <= 0 )
2839 return false;
2842 str--; /* We've eaten the match char after the '*' */
2844 if(unix_do_match(p, str))
2845 return true;
2847 if(!*str)
2848 return false;
2849 else
2850 str++;
2852 return false;
2854 default:
2855 if(*str != *p)
2856 return false;
2857 str++;
2858 p++;
2859 break;
2863 if(!*p && !*str)
2864 return true;
2866 if (!*p && str[0] == '.' && str[1] == 0)
2867 return true;
2869 if (!*str && *p == '?') {
2870 while (*p == '?')
2871 p++;
2872 return(!*p);
2875 if(!*str && (*p == '*' && p[1] == '\0'))
2876 return true;
2878 return false;
2881 /*******************************************************************
2882 Simple case insensitive interface to a UNIX wildcard matcher.
2883 Returns True if match, False if not.
2884 *******************************************************************/
2886 bool unix_wild_match(const char *pattern, const char *string)
2888 TALLOC_CTX *ctx = talloc_stackframe();
2889 char *p2;
2890 char *s2;
2891 char *p;
2892 bool ret = false;
2894 p2 = talloc_strdup(ctx,pattern);
2895 s2 = talloc_strdup(ctx,string);
2896 if (!p2 || !s2) {
2897 TALLOC_FREE(ctx);
2898 return false;
2900 strlower_m(p2);
2901 strlower_m(s2);
2903 /* Remove any *? and ** from the pattern as they are meaningless */
2904 for(p = p2; *p; p++) {
2905 while( *p == '*' && (p[1] == '?' ||p[1] == '*')) {
2906 memmove(&p[1], &p[2], strlen(&p[2])+1);
2910 if (strequal(p2,"*")) {
2911 TALLOC_FREE(ctx);
2912 return true;
2915 ret = unix_do_match(p2, s2);
2916 TALLOC_FREE(ctx);
2917 return ret;
2920 /**********************************************************************
2921 Converts a name to a fully qualified domain name.
2922 Returns true if lookup succeeded, false if not (then fqdn is set to name)
2923 Note we deliberately use gethostbyname here, not getaddrinfo as we want
2924 to examine the h_aliases and I don't know how to do that with getaddrinfo.
2925 ***********************************************************************/
2927 bool name_to_fqdn(fstring fqdn, const char *name)
2929 char *full = NULL;
2930 struct hostent *hp = gethostbyname(name);
2932 if (!hp || !hp->h_name || !*hp->h_name) {
2933 DEBUG(10,("name_to_fqdn: lookup for %s failed.\n", name));
2934 fstrcpy(fqdn, name);
2935 return false;
2938 /* Find out if the fqdn is returned as an alias
2939 * to cope with /etc/hosts files where the first
2940 * name is not the fqdn but the short name */
2941 if (hp->h_aliases && (! strchr_m(hp->h_name, '.'))) {
2942 int i;
2943 for (i = 0; hp->h_aliases[i]; i++) {
2944 if (strchr_m(hp->h_aliases[i], '.')) {
2945 full = hp->h_aliases[i];
2946 break;
2950 if (full && (StrCaseCmp(full, "localhost.localdomain") == 0)) {
2951 DEBUG(1, ("WARNING: your /etc/hosts file may be broken!\n"));
2952 DEBUGADD(1, (" Specifing the machine hostname for address 127.0.0.1 may lead\n"));
2953 DEBUGADD(1, (" to Kerberos authentication problems as localhost.localdomain\n"));
2954 DEBUGADD(1, (" may end up being used instead of the real machine FQDN.\n"));
2955 full = hp->h_name;
2957 if (!full) {
2958 full = hp->h_name;
2961 DEBUG(10,("name_to_fqdn: lookup for %s -> %s.\n", name, full));
2962 fstrcpy(fqdn, full);
2963 return true;
2966 /**********************************************************************
2967 Extension to talloc_get_type: Abort on type mismatch
2968 ***********************************************************************/
2970 void *talloc_check_name_abort(const void *ptr, const char *name)
2972 void *result;
2974 result = talloc_check_name(ptr, name);
2975 if (result != NULL)
2976 return result;
2978 DEBUG(0, ("Talloc type mismatch, expected %s, got %s\n",
2979 name, talloc_get_name(ptr)));
2980 smb_panic("talloc type mismatch");
2981 /* Keep the compiler happy */
2982 return NULL;
2985 uint32 map_share_mode_to_deny_mode(uint32 share_access, uint32 private_options)
2987 switch (share_access & ~FILE_SHARE_DELETE) {
2988 case FILE_SHARE_NONE:
2989 return DENY_ALL;
2990 case FILE_SHARE_READ:
2991 return DENY_WRITE;
2992 case FILE_SHARE_WRITE:
2993 return DENY_READ;
2994 case FILE_SHARE_READ|FILE_SHARE_WRITE:
2995 return DENY_NONE;
2997 if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_DOS) {
2998 return DENY_DOS;
2999 } else if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_FCB) {
3000 return DENY_FCB;
3003 return (uint32)-1;
3006 pid_t procid_to_pid(const struct server_id *proc)
3008 return proc->pid;
3011 static uint32 my_vnn = NONCLUSTER_VNN;
3013 void set_my_vnn(uint32 vnn)
3015 DEBUG(10, ("vnn pid %d = %u\n", (int)sys_getpid(), (unsigned int)vnn));
3016 my_vnn = vnn;
3019 uint32 get_my_vnn(void)
3021 return my_vnn;
3024 struct server_id pid_to_procid(pid_t pid)
3026 struct server_id result;
3027 result.pid = pid;
3028 #ifdef CLUSTER_SUPPORT
3029 result.vnn = my_vnn;
3030 #endif
3031 return result;
3034 struct server_id procid_self(void)
3036 return pid_to_procid(sys_getpid());
3039 struct server_id server_id_self(void)
3041 return procid_self();
3044 bool procid_equal(const struct server_id *p1, const struct server_id *p2)
3046 if (p1->pid != p2->pid)
3047 return False;
3048 #ifdef CLUSTER_SUPPORT
3049 if (p1->vnn != p2->vnn)
3050 return False;
3051 #endif
3052 return True;
3055 bool cluster_id_equal(const struct server_id *id1,
3056 const struct server_id *id2)
3058 return procid_equal(id1, id2);
3061 bool procid_is_me(const struct server_id *pid)
3063 if (pid->pid != sys_getpid())
3064 return False;
3065 #ifdef CLUSTER_SUPPORT
3066 if (pid->vnn != my_vnn)
3067 return False;
3068 #endif
3069 return True;
3072 struct server_id interpret_pid(const char *pid_string)
3074 #ifdef CLUSTER_SUPPORT
3075 unsigned int vnn, pid;
3076 struct server_id result;
3077 if (sscanf(pid_string, "%u:%u", &vnn, &pid) == 2) {
3078 result.vnn = vnn;
3079 result.pid = pid;
3081 else if (sscanf(pid_string, "%u", &pid) == 1) {
3082 result.vnn = get_my_vnn();
3083 result.pid = pid;
3085 else {
3086 result.vnn = NONCLUSTER_VNN;
3087 result.pid = -1;
3089 return result;
3090 #else
3091 return pid_to_procid(atoi(pid_string));
3092 #endif
3095 char *procid_str(TALLOC_CTX *mem_ctx, const struct server_id *pid)
3097 #ifdef CLUSTER_SUPPORT
3098 if (pid->vnn == NONCLUSTER_VNN) {
3099 return talloc_asprintf(mem_ctx,
3100 "%d",
3101 (int)pid->pid);
3103 else {
3104 return talloc_asprintf(mem_ctx,
3105 "%u:%d",
3106 (unsigned)pid->vnn,
3107 (int)pid->pid);
3109 #else
3110 return talloc_asprintf(mem_ctx,
3111 "%d",
3112 (int)pid->pid);
3113 #endif
3116 char *procid_str_static(const struct server_id *pid)
3118 return procid_str(talloc_tos(), pid);
3121 bool procid_valid(const struct server_id *pid)
3123 return (pid->pid != -1);
3126 bool procid_is_local(const struct server_id *pid)
3128 #ifdef CLUSTER_SUPPORT
3129 return pid->vnn == my_vnn;
3130 #else
3131 return True;
3132 #endif
3135 int this_is_smp(void)
3137 #if defined(HAVE_SYSCONF)
3139 #if defined(SYSCONF_SC_NPROC_ONLN)
3140 return (sysconf(_SC_NPROC_ONLN) > 1) ? 1 : 0;
3141 #elif defined(SYSCONF_SC_NPROCESSORS_ONLN)
3142 return (sysconf(_SC_NPROCESSORS_ONLN) > 1) ? 1 : 0;
3143 #else
3144 return 0;
3145 #endif
3147 #else
3148 return 0;
3149 #endif
3152 /****************************************************************
3153 Check if an offset into a buffer is safe.
3154 If this returns True it's safe to indirect into the byte at
3155 pointer ptr+off.
3156 ****************************************************************/
3158 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3160 const char *end_base = buf_base + buf_len;
3161 char *end_ptr = ptr + off;
3163 if (!buf_base || !ptr) {
3164 return False;
3167 if (end_base < buf_base || end_ptr < ptr) {
3168 return False; /* wrap. */
3171 if (end_ptr < end_base) {
3172 return True;
3174 return False;
3177 /****************************************************************
3178 Return a safe pointer into a buffer, or NULL.
3179 ****************************************************************/
3181 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3183 return is_offset_safe(buf_base, buf_len, ptr, off) ?
3184 ptr + off : NULL;
3187 /****************************************************************
3188 Return a safe pointer into a string within a buffer, or NULL.
3189 ****************************************************************/
3191 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
3193 if (!is_offset_safe(buf_base, buf_len, ptr, off)) {
3194 return NULL;
3196 /* Check if a valid string exists at this offset. */
3197 if (skip_string(buf_base,buf_len, ptr + off) == NULL) {
3198 return NULL;
3200 return ptr + off;
3203 /****************************************************************
3204 Return an SVAL at a pointer, or failval if beyond the end.
3205 ****************************************************************/
3207 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
3210 * Note we use off+1 here, not off+2 as SVAL accesses ptr[0] and ptr[1],
3211 * NOT ptr[2].
3213 if (!is_offset_safe(buf_base, buf_len, ptr, off+1)) {
3214 return failval;
3216 return SVAL(ptr,off);
3219 /****************************************************************
3220 Return an IVAL at a pointer, or failval if beyond the end.
3221 ****************************************************************/
3223 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
3226 * Note we use off+3 here, not off+4 as IVAL accesses
3227 * ptr[0] ptr[1] ptr[2] ptr[3] NOT ptr[4].
3229 if (!is_offset_safe(buf_base, buf_len, ptr, off+3)) {
3230 return failval;
3232 return IVAL(ptr,off);
3235 /****************************************************************
3236 Split DOM\user into DOM and user. Do not mix with winbind variants of that
3237 call (they take care of winbind separator and other winbind specific settings).
3238 ****************************************************************/
3240 void split_domain_user(TALLOC_CTX *mem_ctx,
3241 const char *full_name,
3242 char **domain,
3243 char **user)
3245 const char *p = NULL;
3247 p = strchr_m(full_name, '\\');
3249 if (p != NULL) {
3250 *domain = talloc_strndup(mem_ctx, full_name,
3251 PTR_DIFF(p, full_name));
3252 *user = talloc_strdup(mem_ctx, p+1);
3253 } else {
3254 *domain = talloc_strdup(mem_ctx, "");
3255 *user = talloc_strdup(mem_ctx, full_name);
3259 #if 0
3261 Disable these now we have checked all code paths and ensured
3262 NULL returns on zero request. JRA.
3264 /****************************************************************
3265 talloc wrapper functions that guarentee a null pointer return
3266 if size == 0.
3267 ****************************************************************/
3269 #ifndef MAX_TALLOC_SIZE
3270 #define MAX_TALLOC_SIZE 0x10000000
3271 #endif
3274 * talloc and zero memory.
3275 * - returns NULL if size is zero.
3278 void *_talloc_zero_zeronull(const void *ctx, size_t size, const char *name)
3280 void *p;
3282 if (size == 0) {
3283 return NULL;
3286 p = talloc_named_const(ctx, size, name);
3288 if (p) {
3289 memset(p, '\0', size);
3292 return p;
3296 * memdup with a talloc.
3297 * - returns NULL if size is zero.
3300 void *_talloc_memdup_zeronull(const void *t, const void *p, size_t size, const char *name)
3302 void *newp;
3304 if (size == 0) {
3305 return NULL;
3308 newp = talloc_named_const(t, size, name);
3309 if (newp) {
3310 memcpy(newp, p, size);
3313 return newp;
3317 * alloc an array, checking for integer overflow in the array size.
3318 * - returns NULL if count or el_size are zero.
3321 void *_talloc_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3323 if (count >= MAX_TALLOC_SIZE/el_size) {
3324 return NULL;
3327 if (el_size == 0 || count == 0) {
3328 return NULL;
3331 return talloc_named_const(ctx, el_size * count, name);
3335 * alloc an zero array, checking for integer overflow in the array size
3336 * - returns NULL if count or el_size are zero.
3339 void *_talloc_zero_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3341 if (count >= MAX_TALLOC_SIZE/el_size) {
3342 return NULL;
3345 if (el_size == 0 || count == 0) {
3346 return NULL;
3349 return _talloc_zero(ctx, el_size * count, name);
3353 * Talloc wrapper that returns NULL if size == 0.
3355 void *talloc_zeronull(const void *context, size_t size, const char *name)
3357 if (size == 0) {
3358 return NULL;
3360 return talloc_named_const(context, size, name);
3362 #endif
3364 /* Split a path name into filename and stream name components. Canonicalise
3365 * such that an implicit $DATA token is always explicit.
3367 * The "specification" of this function can be found in the
3368 * run_local_stream_name() function in torture.c, I've tried those
3369 * combinations against a W2k3 server.
3372 NTSTATUS split_ntfs_stream_name(TALLOC_CTX *mem_ctx, const char *fname,
3373 char **pbase, char **pstream)
3375 char *base = NULL;
3376 char *stream = NULL;
3377 char *sname; /* stream name */
3378 const char *stype; /* stream type */
3380 DEBUG(10, ("split_ntfs_stream_name called for [%s]\n", fname));
3382 sname = strchr_m(fname, ':');
3384 if (lp_posix_pathnames() || (sname == NULL)) {
3385 if (pbase != NULL) {
3386 base = talloc_strdup(mem_ctx, fname);
3387 NT_STATUS_HAVE_NO_MEMORY(base);
3389 goto done;
3392 if (pbase != NULL) {
3393 base = talloc_strndup(mem_ctx, fname, PTR_DIFF(sname, fname));
3394 NT_STATUS_HAVE_NO_MEMORY(base);
3397 sname += 1;
3399 stype = strchr_m(sname, ':');
3401 if (stype == NULL) {
3402 sname = talloc_strdup(mem_ctx, sname);
3403 stype = "$DATA";
3405 else {
3406 if (StrCaseCmp(stype, ":$DATA") != 0) {
3408 * If there is an explicit stream type, so far we only
3409 * allow $DATA. Is there anything else allowed? -- vl
3411 DEBUG(10, ("[%s] is an invalid stream type\n", stype));
3412 TALLOC_FREE(base);
3413 return NT_STATUS_OBJECT_NAME_INVALID;
3415 sname = talloc_strndup(mem_ctx, sname, PTR_DIFF(stype, sname));
3416 stype += 1;
3419 if (sname == NULL) {
3420 TALLOC_FREE(base);
3421 return NT_STATUS_NO_MEMORY;
3424 if (sname[0] == '\0') {
3426 * no stream name, so no stream
3428 goto done;
3431 if (pstream != NULL) {
3432 stream = talloc_asprintf(mem_ctx, "%s:%s", sname, stype);
3433 if (stream == NULL) {
3434 TALLOC_FREE(sname);
3435 TALLOC_FREE(base);
3436 return NT_STATUS_NO_MEMORY;
3439 * upper-case the type field
3441 strupper_m(strchr_m(stream, ':')+1);
3444 done:
3445 if (pbase != NULL) {
3446 *pbase = base;
3448 if (pstream != NULL) {
3449 *pstream = stream;
3451 return NT_STATUS_OK;
3454 bool is_valid_policy_hnd(const POLICY_HND *hnd)
3456 POLICY_HND tmp;
3457 ZERO_STRUCT(tmp);
3458 return (memcmp(&tmp, hnd, sizeof(tmp)) != 0);
3461 bool policy_hnd_equal(const struct policy_handle *hnd1,
3462 const struct policy_handle *hnd2)
3464 if (!hnd1 || !hnd2) {
3465 return false;
3468 return (memcmp(hnd1, hnd2, sizeof(*hnd1)) == 0);
3471 /****************************************************************
3472 strip off leading '\\' from a hostname
3473 ****************************************************************/
3475 const char *strip_hostname(const char *s)
3477 if (!s) {
3478 return NULL;
3481 if (strlen_m(s) < 3) {
3482 return s;
3485 if (s[0] == '\\') s++;
3486 if (s[0] == '\\') s++;
3488 return s;