2 Unix SMB/CIFS implementation.
3 SMB parameters and setup
4 Copyright (C) Andrew Tridgell 1992-1999
5 Copyright (C) John H Terpstra 1996-1999
6 Copyright (C) Luke Kenneth Casson Leighton 1996-1999
7 Copyright (C) Paul Ashton 1998 - 1999
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #define BOOLSTR(b) ((b) ? "Yes" : "No")
29 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
31 /* for readability... */
32 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
33 #define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
34 #define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
35 #define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
36 #define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
38 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
41 * Free memory if the pointer and zero the pointer.
43 * @note You are explicitly allowed to pass NULL pointers -- they will
46 #define SAFE_FREE(x) do { if ((x) != NULL) {free(CONST_DISCARD(void *, (x))); x=NULL;} } while(0)
49 /* zero a structure */
50 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
52 /* zero a structure given a pointer to the structure */
53 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
55 /* zero a structure given a pointer to the structure - no zero check */
56 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
58 /* zero an array - note that sizeof(array) must work - ie. it must not be a
60 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
62 /* pointer difference macro */
63 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
65 /* work out how many elements there are in a static array */
66 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
70 #define SMB_ASSERT(b) ( (b) ? (void)0 : \
71 (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
72 __FILE__, __LINE__)), smb_panic("assert failed")))
74 /* redefine the assert macro for non-developer builds */
75 #define SMB_ASSERT(b) ( (b) ? (void)0 : \
76 (DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__))))
79 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
81 /* these are useful macros for checking validity of handles */
82 #define OPEN_FSP(fsp) ((fsp) && !(fsp)->is_directory)
83 #define OPEN_CONN(conn) ((conn) && (conn)->open)
84 #define IS_IPC(conn) ((conn) && (conn)->ipc)
85 #define IS_PRINT(conn) ((conn) && (conn)->printer)
86 /* you must add the following extern declaration to files using this macro
87 * extern struct current_user current_user;
89 #define FSP_BELONGS_CONN(fsp,conn) do {\
90 if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
91 return(ERROR_DOS(ERRDOS,ERRbadfid));\
94 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
96 /* you must add the following extern declaration to files using this macro
97 * extern struct current_user current_user;
99 #define CHECK_FSP(fsp,conn) do {\
100 if (!FNUM_OK(fsp,conn)) \
101 return(ERROR_DOS(ERRDOS,ERRbadfid)); \
102 else if((fsp)->fd == -1) \
103 return(ERROR_DOS(ERRDOS,ERRbadaccess));\
104 (fsp)->num_smb_operations++;\
107 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
108 return(ERROR_DOS(ERRDOS,ERRbadaccess))
109 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
110 return(ERROR_DOS(ERRDOS,ERRbadaccess))
112 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
113 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
115 /* the service number for the [globals] defaults */
116 #define GLOBAL_SECTION_SNUM (-1)
117 /* translates a connection number into a service number */
118 #define SNUM(conn) ((conn)?(conn)->service:GLOBAL_SECTION_SNUM)
121 /* access various service details */
122 #define SERVICE(snum) (lp_servicename(snum))
123 #define PRINTERNAME(snum) (lp_printername(snum))
124 #define CAN_WRITE(conn) (!conn->read_only)
125 #define VALID_SNUM(snum) (lp_snum_ok(snum))
126 #define GUEST_OK(snum) (VALID_SNUM(snum) && lp_guest_ok(snum))
127 #define GUEST_ONLY(snum) (VALID_SNUM(snum) && lp_guest_only(snum))
128 #define CAN_SETDIR(snum) (!lp_no_set_dir(snum))
129 #define CAN_PRINT(conn) ((conn) && lp_print_ok((conn)->service))
130 #define MAP_HIDDEN(conn) ((conn) && lp_map_hidden((conn)->service))
131 #define MAP_SYSTEM(conn) ((conn) && lp_map_system((conn)->service))
132 #define MAP_ARCHIVE(conn) ((conn) && lp_map_archive((conn)->service))
133 #define IS_HIDDEN_PATH(conn,path) ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
134 #define IS_VETO_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
135 #define IS_VETO_OPLOCK_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
138 * Used by the stat cache code to check if a returned
139 * stat structure is valid.
142 #define VALID_STAT(st) ((st).st_nlink != 0)
143 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
146 #define MIN(a,b) ((a)<(b)?(a):(b))
149 #define MAX(a,b) ((a)>(b)?(a):(b))
153 #define ABS(a) ((a)>0?(a):(-(a)))
156 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
157 structures. We cannot define these as actual structures
158 due to possible differences in structure packing
159 on different machines/compilers. */
161 #define SMB_LPID_OFFSET(indx) (10 * (indx))
162 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
163 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
164 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
165 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
166 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
167 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
168 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
170 /* Macro to test if an error has been cached for this fnum */
171 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
172 (fsp)->wbmpx_ptr->wr_discard)
173 /* Macro to turn the cached error into an error packet */
174 #define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
176 #define ERROR_DOS(class,code) error_packet(outbuf,class,code,NT_STATUS_OK,__LINE__,__FILE__)
177 #define ERROR_FORCE_DOS(class,code) error_packet(outbuf,class,code,NT_STATUS_INVALID,__LINE__,__FILE__)
178 #define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
179 #define ERROR_FORCE_NT(status) error_packet(outbuf,-1,-1,status,__LINE__,__FILE__)
180 #define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
182 /* this is how errors are generated */
183 #define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,NT_STATUS_OK,__LINE__,__FILE__)
185 /* these are the datagram types */
186 #define DGRAM_DIRECT_UNIQUE 0x10
188 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
190 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
191 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
192 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
194 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
195 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
197 /* Note that chain_size must be available as an extern int to this macro. */
198 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
200 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
201 #define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = (len&0x10000)>>16; \
202 buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF; } while (0)
204 /*******************************************************************
205 find the difference in milliseconds between two struct timeval
207 ********************************************************************/
209 #define TvalDiff(tvalold,tvalnew) \
210 (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 + \
211 ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
213 /****************************************************************************
214 true if two IP addresses are equal
215 ****************************************************************************/
217 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
218 #define ip_service_equal(ip1,ip2) ( ((ip1).ip.s_addr == (ip2).ip.s_addr) && ((ip1).port == (ip2).port) )
220 /*****************************************************************
221 splits out the last subkey of a key
222 *****************************************************************/
224 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
225 split_at_last_component(full_keyname, key_name, '\\', subkey_name)
227 /****************************************************************************
228 Return True if the offset is at zero.
229 ****************************************************************************/
231 #define dptr_zero(buf) (IVAL(buf,1) == 0)
233 /*******************************************************************
234 copy an IP address from one buffer to another
235 ********************************************************************/
237 #define putip(dest,src) memcpy(dest,src,4)
239 /*******************************************************************
240 Return True if a server has CIFS UNIX capabilities.
241 ********************************************************************/
243 #define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
245 /****************************************************************************
246 Make a filename into unix format.
247 ****************************************************************************/
249 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
250 #define unix_format(fname) string_replace(fname,'\\','/')
251 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
253 /****************************************************************************
254 Make a file into DOS format.
255 ****************************************************************************/
257 #define dos_format(fname) string_replace(fname,'/','\\')
259 /*****************************************************************************
260 Check to see if we are a DO for this domain
261 *****************************************************************************/
263 #define IS_DC (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC)
265 /*****************************************************************************
266 Safe allocation macros.
267 *****************************************************************************/
269 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
270 #define SMB_REALLOC(p,s) Realloc((p),(s))
271 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count))
272 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
273 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
274 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
276 /* limiting size of ipc replies */
277 #define SMB_REALLOC_LIMIT(ptr,size) SMB_REALLOC(ptr,MAX((size),4*1024))
279 /* The new talloc is paranoid malloc checker safe. */
281 #define TALLOC(ctx, size) talloc_named_const(ctx, size, __location__)
282 #define TALLOC_P(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
283 #define TALLOC_ARRAY(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
284 #define TALLOC_MEMDUP(ctx, ptr, size) _talloc_memdup(ctx, ptr, size, __location__)
285 #define TALLOC_ZERO(ctx, size) _talloc_zero(ctx, size, __location__)
286 #define TALLOC_ZERO_P(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
287 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
288 #define TALLOC_REALLOC(ctx, ptr, count) _talloc_realloc(ctx, ptr, count, __location__)
289 #define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)_talloc_realloc_array(ctx, ptr, sizeof(type), count, #type)
290 #define talloc_destroy(ctx) talloc_free(ctx)
292 #define PARANOID_MALLOC_CHECKER 1
294 #if defined(PARANOID_MALLOC_CHECKER)
296 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
297 #define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem_((ps),(size),1)
299 /* Get medieval on our ass about malloc.... */
301 /* Restrictions on malloc/realloc/calloc. */
305 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
310 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
315 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
320 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
325 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
327 #define SMB_MALLOC(s) malloc_(s)
328 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
330 #define SMB_STRDUP(s) smb_xstrdup(s)
331 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
335 #define _STRING_LINE_(s) #s
336 #define _STRING_LINE2_(s) _STRING_LINE_(s)
337 #define __LINESTR__ _STRING_LINE2_(__LINE__)
338 #define __location__ __FILE__ ":" __LINESTR__
340 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
341 #define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem((ps),(size),1)
343 /* Regular malloc code. */
345 #define SMB_MALLOC(s) malloc(s)
346 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
348 #define SMB_STRDUP(s) strdup(s)
349 #define SMB_STRNDUP(s,n) strndup(s,n)
353 #define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
355 *(array) = ((mem_ctx) != NULL) ? \
356 TALLOC_REALLOC_ARRAY(mem_ctx, (*(array)), type, (*(num))+1) : \
357 SMB_REALLOC_ARRAY((*(array)), type, (*(num))+1); \
358 SMB_ASSERT((*(array)) != NULL); \
359 (*(array))[*(num)] = (elem); \
363 #define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
364 add_to_large_array((mem_ctx), sizeof(type), &(elem), (void **)(array), (num), (size));
366 #endif /* _SMB_MACROS_H */