2000-02-03 07:47:50 +03:00
/*
2002-01-30 09:08:46 +03:00
Unix SMB / CIFS implementation .
2000-02-03 07:47:50 +03:00
SMB parameters and setup
Copyright ( C ) Andrew Tridgell 1992 - 1999
Copyright ( C ) John H Terpstra 1996 - 1999
Copyright ( C ) Luke Kenneth Casson Leighton 1996 - 1999
Copyright ( C ) Paul Ashton 1998 - 1999
This program is free software ; you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation ; either version 2 of the License , or
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU General Public License for more details .
You should have received a copy of the GNU General Public License
along with this program ; if not , write to the Free Software
Foundation , Inc . , 675 Mass Ave , Cambridge , MA 0213 9 , USA .
*/
# ifndef _SMB_MACROS_H
# define _SMB_MACROS_H
/* Misc bit macros */
# define BOOLSTR(b) ((b) ? "Yes" : "No")
# define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
/* for readability... */
# define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
# define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
# define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
# define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
# define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
2002-01-03 06:07:51 +03:00
# ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
2002-01-03 10:49:07 +03:00
/**
* Free memory if the pointer and zero the pointer .
*
* @ note You are explicitly allowed to pass NULL pointers - - they will
* always be ignored .
* */
2005-03-31 09:06:04 +04:00
# define SAFE_FREE(x) do { if ((x) != NULL) {free(CONST_DISCARD(void *, (x))); x=NULL;} } while(0)
2002-01-03 06:07:51 +03:00
# endif
2001-09-17 04:47:40 +04:00
2000-02-03 07:47:50 +03:00
/* zero a structure */
# define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
/* zero a structure given a pointer to the structure */
2001-09-10 15:08:57 +04:00
# define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
2000-02-03 07:47:50 +03:00
/* zero a structure given a pointer to the structure - no zero check */
# define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
/* zero an array - note that sizeof(array) must work - ie. it must not be a
pointer */
# define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
/* pointer difference macro */
# define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
2001-09-06 14:37:21 +04:00
/* work out how many elements there are in a static array */
# define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
2000-02-03 07:47:50 +03:00
/* assert macros */
2000-09-26 18:48:52 +04:00
# define SMB_ASSERT(b) ((b)?(void)0: \
2000-02-03 07:47:50 +03:00
( DEBUG ( 0 , ( " PANIC: assert failed at %s(%d) \n " , \
__FILE__ , __LINE__ ) ) , smb_panic ( " assert failed " ) ) )
# define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a) / sizeof((a)[0])) >= (n))
/* these are useful macros for checking validity of handles */
2000-04-24 23:23:51 +04:00
# define OPEN_FSP(fsp) ((fsp) && !(fsp)->is_directory)
2000-02-03 07:47:50 +03:00
# define OPEN_CONN(conn) ((conn) && (conn)->open)
# define IS_IPC(conn) ((conn) && (conn)->ipc)
# define IS_PRINT(conn) ((conn) && (conn)->printer)
2005-04-06 20:28:04 +04:00
/* you must add the following extern declaration to files using this macro
* extern struct current_user current_user ;
*/
2003-08-08 01:47:46 +04:00
# define FSP_BELONGS_CONN(fsp,conn) do {\
if ( ! ( ( fsp ) & & ( conn ) & & ( ( conn ) = = ( fsp ) - > conn ) & & ( current_user . vuid = = ( fsp ) - > vuid ) ) ) \
return ( ERROR_DOS ( ERRDOS , ERRbadfid ) ) ; \
} while ( 0 )
2003-04-10 02:31:37 +04:00
# define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
2000-02-03 07:47:50 +03:00
2005-04-06 20:28:04 +04:00
/* you must add the following extern declaration to files using this macro
* extern struct current_user current_user ;
*/
2003-04-10 02:31:37 +04:00
# define CHECK_FSP(fsp,conn) do {\
if ( ! FNUM_OK ( fsp , conn ) ) \
2002-09-25 19:19:00 +04:00
return ( ERROR_DOS ( ERRDOS , ERRbadfid ) ) ; \
else if ( ( fsp ) - > fd = = - 1 ) \
2003-04-10 02:31:37 +04:00
return ( ERROR_DOS ( ERRDOS , ERRbadaccess ) ) ; \
2005-04-15 03:32:56 +04:00
( fsp ) - > num_smb_operations + + ; \
2003-04-10 02:31:37 +04:00
} while ( 0 )
2000-04-12 05:25:10 +04:00
2000-02-03 07:47:50 +03:00
# define CHECK_READ(fsp) if (!(fsp)->can_read) \
2002-09-25 19:19:00 +04:00
return ( ERROR_DOS ( ERRDOS , ERRbadaccess ) )
2000-02-03 07:47:50 +03:00
# define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
2002-09-25 19:19:00 +04:00
return ( ERROR_DOS ( ERRDOS , ERRbadaccess ) )
2000-02-03 07:47:50 +03:00
2002-09-25 19:19:00 +04:00
# define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
NT_STATUS_EQUAL ( ( status ) , NT_STATUS_FILE_LOCK_CONFLICT ) )
2001-10-19 04:56:03 +04:00
2003-04-24 07:46:17 +04:00
/* the service number for the [globals] defaults */
# define GLOBAL_SECTION_SNUM (-1)
2000-02-03 07:47:50 +03:00
/* translates a connection number into a service number */
2003-04-24 07:46:17 +04:00
# define SNUM(conn) ((conn)?(conn)->service:GLOBAL_SECTION_SNUM)
2000-02-03 07:47:50 +03:00
/* access various service details */
# define SERVICE(snum) (lp_servicename(snum))
# define PRINTERNAME(snum) (lp_printername(snum))
# define CAN_WRITE(conn) (!conn->read_only)
# define VALID_SNUM(snum) (lp_snum_ok(snum))
# define GUEST_OK(snum) (VALID_SNUM(snum) && lp_guest_ok(snum))
# define GUEST_ONLY(snum) (VALID_SNUM(snum) && lp_guest_only(snum))
# define CAN_SETDIR(snum) (!lp_no_set_dir(snum))
# define CAN_PRINT(conn) ((conn) && lp_print_ok((conn)->service))
# define MAP_HIDDEN(conn) ((conn) && lp_map_hidden((conn)->service))
# define MAP_SYSTEM(conn) ((conn) && lp_map_system((conn)->service))
# define MAP_ARCHIVE(conn) ((conn) && lp_map_archive((conn)->service))
2004-05-07 22:37:47 +04:00
# define IS_HIDDEN_PATH(conn,path) ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
# define IS_VETO_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
# define IS_VETO_OPLOCK_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
2000-02-03 07:47:50 +03:00
/*
* Used by the stat cache code to check if a returned
* stat structure is valid .
*/
2000-10-19 06:58:24 +04:00
# define VALID_STAT(st) ((st).st_nlink != 0)
# define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
2000-02-03 07:47:50 +03:00
# ifndef MIN
# define MIN(a,b) ((a)<(b)?(a):(b))
# endif
# ifndef MAX
# define MAX(a,b) ((a)>(b)?(a):(b))
# endif
# ifndef ABS
# define ABS(a) ((a)>0?(a):(-(a)))
# endif
/* Macros to get at offsets within smb_lkrng and smb_unlkrng
structures . We cannot define these as actual structures
due to possible differences in structure packing
on different machines / compilers . */
# define SMB_LPID_OFFSET(indx) (10 * (indx))
# define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
# define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
2001-11-09 23:34:12 +03:00
# define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
2000-02-03 07:47:50 +03:00
# define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
# define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
# define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
# define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
2001-10-19 04:56:03 +04:00
/* Macro to test if an error has been cached for this fnum */
# define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
( fsp ) - > wbmpx_ptr - > wr_discard )
/* Macro to turn the cached error into an error packet */
# define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
2005-04-02 03:11:28 +04:00
# define ERROR_DOS(class,code) error_packet(outbuf,class,code,NT_STATUS_OK,__LINE__,__FILE__)
# define ERROR_FORCE_DOS(class,code) error_packet(outbuf,class,code,NT_STATUS_INVALID,__LINE__,__FILE__)
# define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
# define ERROR_FORCE_NT(status) error_packet(outbuf,-1,-1,status,__LINE__,__FILE__)
# define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
2000-02-03 07:47:50 +03:00
/* this is how errors are generated */
2005-04-02 03:11:28 +04:00
# define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,NT_STATUS_OK,__LINE__,__FILE__)
/* these are the datagram types */
# define DGRAM_DIRECT_UNIQUE 0x10
2000-02-03 07:47:50 +03:00
2005-03-03 06:43:57 +03:00
# define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r)) / (r))*(r) ) : (x))
2000-02-03 07:47:50 +03:00
/* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
2002-07-15 14:35:28 +04:00
# define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
2000-02-03 07:47:50 +03:00
# define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
2002-07-15 14:35:28 +04:00
/* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
# define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
2000-02-03 07:47:50 +03:00
/* Note that chain_size must be available as an extern int to this macro. */
# define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
# define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
2003-04-14 14:30:38 +04:00
# define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = (len&0x10000)>>16; \
buf [ 2 ] = ( len & 0xFF00 ) > > 8 ; buf [ 3 ] = len & 0xFF ; } while ( 0 )
2000-02-03 07:47:50 +03:00
/*******************************************************************
find the difference in milliseconds between two struct timeval
values
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define TvalDiff(tvalold,tvalnew) \
( ( ( tvalnew ) - > tv_sec - ( tvalold ) - > tv_sec ) * 1000 + \
( ( int ) ( tvalnew ) - > tv_usec - ( int ) ( tvalold ) - > tv_usec ) / 1000 )
/****************************************************************************
true if two IP addresses are equal
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
2003-06-25 21:41:05 +04:00
# define ip_service_equal(ip1,ip2) ( ((ip1).ip.s_addr == (ip2).ip.s_addr) && ((ip1).port == (ip2).port) )
2000-02-03 07:47:50 +03:00
/*****************************************************************
splits out the last subkey of a key
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define reg_get_subkey(full_keyname, key_name, subkey_name) \
split_at_last_component ( full_keyname , key_name , ' \\ ' , subkey_name )
/****************************************************************************
Used by dptr_zero .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define DPTR_MASK ((uint32)(((uint32)1)<<31))
/****************************************************************************
Return True if the offset is at zero .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
/*******************************************************************
copy an IP address from one buffer to another
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define putip(dest,src) memcpy(dest,src,4)
2002-01-16 23:13:28 +03:00
/*******************************************************************
Return True if a server has CIFS UNIX capabilities .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
2000-02-03 07:47:50 +03:00
/****************************************************************************
Make a filename into unix format .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2004-03-03 23:55:59 +03:00
# define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == ' / ')
2000-02-03 07:47:50 +03:00
# define unix_format(fname) string_replace(fname,'\\',' / ')
2001-11-04 21:26:53 +03:00
# define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR(' / '))
2000-02-03 07:47:50 +03:00
/****************************************************************************
Make a file into DOS format .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define dos_format(fname) string_replace(fname,' / ','\\')
2003-06-30 21:24:59 +04:00
/*****************************************************************************
Check to see if we are a DO for this domain
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2003-07-07 09:11:10 +04:00
# define IS_DC (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC)
2003-06-30 21:24:59 +04:00
2004-12-07 21:25:53 +03:00
/*****************************************************************************
Safe allocation macros .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
# define SMB_REALLOC(p,s) Realloc((p),(s))
# define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count))
# define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
# define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
# define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
/* limiting size of ipc replies */
# define SMB_REALLOC_LIMIT(ptr,size) SMB_REALLOC(ptr,MAX((size),4*1024))
/* #define PARANOID_MALLOC_CHECKER 1 */
# if defined(PARANOID_MALLOC_CHECKER)
# define TALLOC(ctx, size) talloc_((ctx),(size))
# define TALLOC_P(ctx, type) (type *)talloc_((ctx),sizeof(type))
# define TALLOC_ARRAY(ctx, type, count) (type *)talloc_array_((ctx),sizeof(type),(count))
# define TALLOC_MEMDUP(ctx, ptr, size) talloc_memdup_((ctx),(ptr),(size))
# define TALLOC_ZERO(ctx, size) talloc_zero_((ctx),(size))
# define TALLOC_ZERO_P(ctx, type) (type *)talloc_zero_((ctx),sizeof(type))
# define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)talloc_zero_array_((ctx),sizeof(type),(count))
# define TALLOC_REALLOC(ctx, ptr, count) talloc_realloc_((ctx),(ptr),(count))
# define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)talloc_realloc_array_((ctx),(ptr),sizeof(type),(count))
# define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
2005-03-24 02:26:33 +03:00
# define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem_((ps),(size),1)
2004-12-07 21:25:53 +03:00
/* Get medieval on our ass about malloc.... */
/* Restrictions on malloc/realloc/calloc. */
# ifdef malloc
# undef malloc
# endif
# define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
# ifdef realloc
# undef realloc
# endif
# define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
# ifdef calloc
# undef calloc
# endif
# define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
# ifdef strndup
# undef strndup
# endif
# define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
# ifdef strdup
# undef strdup
# endif
# define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
# define SMB_MALLOC(s) malloc_(s)
# define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
# define SMB_STRDUP(s) smb_xstrdup(s)
# define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
# else
# define TALLOC(ctx, size) talloc((ctx),(size))
# define TALLOC_P(ctx, type) (type *)talloc((ctx),sizeof(type))
# define TALLOC_ARRAY(ctx, type, count) (type *)talloc_array((ctx),sizeof(type),(count))
# define TALLOC_MEMDUP(ctx, ptr, size) talloc_memdup((ctx),(ptr),(size))
# define TALLOC_ZERO(ctx, size) talloc_zero((ctx),(size))
# define TALLOC_ZERO_P(ctx, type) (type *)talloc_zero((ctx),sizeof(type))
# define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)talloc_zero_array((ctx),sizeof(type),(count))
# define TALLOC_REALLOC(ctx, ptr, count) talloc_realloc((ctx),(ptr),(count))
# define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)talloc_realloc_array((ctx),(ptr),sizeof(type),(count))
# define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
2005-03-24 02:26:33 +03:00
# define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem((ps),(size),1)
2004-12-07 21:25:53 +03:00
/* Regular malloc code. */
# define SMB_MALLOC(s) malloc(s)
# define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
# define SMB_STRDUP(s) strdup(s)
# define SMB_STRNDUP(s,n) strndup(s,n)
# endif
2005-04-10 19:26:37 +04:00
# define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
do { \
* ( array ) = ( ( mem_ctx ) ! = NULL ) ? \
TALLOC_REALLOC_ARRAY ( mem_ctx , ( * ( array ) ) , type , ( * ( num ) ) + 1 ) : \
SMB_REALLOC_ARRAY ( ( * ( array ) ) , type , ( * ( num ) ) + 1 ) ; \
SMB_ASSERT ( ( * ( array ) ) ! = NULL ) ; \
( * ( array ) ) [ * ( num ) ] = ( elem ) ; \
( * ( num ) ) + = 1 ; \
} while ( 0 )
2005-04-15 17:41:49 +04:00
# define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
add_to_large_array ( ( mem_ctx ) , sizeof ( type ) , & ( elem ) , ( void * * ) ( array ) , ( num ) , ( size ) ) ;
2000-02-03 07:47:50 +03:00
# endif /* _SMB_MACROS_H */