9a78718605c62c70012a97a0e8f0edfa49db3aec
[samba.git] / source / include / smb_macros.h
1 /* 
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
8    
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.
13    
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.
18    
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.
22 */
23
24 #ifndef _SMB_MACROS_H
25 #define _SMB_MACROS_H
26
27 /* Misc bit macros */
28 #define BOOLSTR(b) ((b) ? "Yes" : "No")
29 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
30
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)
37
38 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
39
40 /**
41  * Free memory if the pointer and zero the pointer.
42  *
43  * @note You are explicitly allowed to pass NULL pointers -- they will
44  * always be ignored.
45  **/
46 #define SAFE_FREE(x) do { if ((x) != NULL) {free((void *) (x)); x=NULL;} } while(0)
47 #endif
48
49 /* zero a structure */
50 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
51
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)
54
55 /* zero a structure given a pointer to the structure - no zero check */
56 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
57
58 /* zero an array - note that sizeof(array) must work - ie. it must not be a 
59    pointer */
60 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
61
62 /* pointer difference macro */
63 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
64
65 /* work out how many elements there are in a static array */
66 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
67
68 /* assert macros */
69 #define SMB_ASSERT(b) ((b)?(void)0: \
70         (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
71                  __FILE__, __LINE__)), smb_panic("assert failed")))
72 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
73
74 /* these are useful macros for checking validity of handles */
75 #define OPEN_FSP(fsp)    ((fsp) && !(fsp)->is_directory)
76 #define OPEN_CONN(conn)    ((conn) && (conn)->open)
77 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
78 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
79 #define FSP_BELONGS_CONN(fsp,conn) do {\
80                         extern struct current_user current_user;\
81                         if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
82                                 return(ERROR_DOS(ERRDOS,ERRbadfid));\
83                         } while(0)
84
85 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
86
87 #define CHECK_FSP(fsp,conn) do {\
88                         extern struct current_user current_user;\
89                         if (!FNUM_OK(fsp,conn)) \
90                                 return(ERROR_DOS(ERRDOS,ERRbadfid)); \
91                         else if((fsp)->fd == -1) \
92                                 return(ERROR_DOS(ERRDOS,ERRbadaccess));\
93                         } while(0)
94
95 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
96                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
97 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
98                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
99
100 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
101                                 return(CACHED_ERROR(fsp))
102
103 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
104                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
105
106 /* the service number for the [globals] defaults */ 
107 #define GLOBAL_SECTION_SNUM     (-1)
108 /* translates a connection number into a service number */
109 #define SNUM(conn)              ((conn)?(conn)->service:GLOBAL_SECTION_SNUM)
110
111
112 /* access various service details */
113 #define SERVICE(snum)      (lp_servicename(snum))
114 #define PRINTERNAME(snum)  (lp_printername(snum))
115 #define CAN_WRITE(conn)    (!conn->read_only)
116 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
117 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
118 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
119 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
120 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
121 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
122 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
123 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
124 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
125 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
126 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
127
128 /* 
129  * Used by the stat cache code to check if a returned
130  * stat structure is valid.
131  */
132
133 #define VALID_STAT(st) ((st).st_nlink != 0)  
134 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
135
136 #ifndef MIN
137 #define MIN(a,b) ((a)<(b)?(a):(b))
138 #endif
139 #ifndef MAX
140 #define MAX(a,b) ((a)>(b)?(a):(b))
141 #endif
142
143 #ifndef ABS
144 #define ABS(a) ((a)>0?(a):(-(a)))
145 #endif
146
147 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
148    structures. We cannot define these as actual structures
149    due to possible differences in structure packing
150    on different machines/compilers. */
151
152 #define SMB_LPID_OFFSET(indx) (10 * (indx))
153 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
154 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
155 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
156 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
157 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
158 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
159 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
160
161 /* Macro to cache an error in a write_bmpx_struct */
162 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
163                 w->wr_discard = True, -1)
164 /* Macro to test if an error has been cached for this fnum */
165 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
166                 (fsp)->wbmpx_ptr->wr_discard)
167 /* Macro to turn the cached error into an error packet */
168 #define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
169
170 /* these are the datagram types */
171 #define DGRAM_DIRECT_UNIQUE 0x10
172
173 #define ERROR_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,False,__LINE__,__FILE__)
174 #define ERROR_FORCE_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,True,__LINE__,__FILE__)
175 #define ERROR_NT(status) error_packet(outbuf,status,0,0,False,__LINE__,__FILE__)
176 #define ERROR_BOTH(status,class,code) error_packet(outbuf,status,class,code,False,__LINE__,__FILE__)
177
178 /* this is how errors are generated */
179 #define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,__LINE__,__FILE__)
180
181 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
182
183 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
184 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
185 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
186
187 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
188 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
189
190 /* Note that chain_size must be available as an extern int to this macro. */
191 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
192
193 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
194 #define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = (len&0x10000)>>16; \
195         buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF; } while (0)
196
197 /*******************************************************************
198 find the difference in milliseconds between two struct timeval
199 values
200 ********************************************************************/
201
202 #define TvalDiff(tvalold,tvalnew) \
203   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
204          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
205
206 /****************************************************************************
207 true if two IP addresses are equal
208 ****************************************************************************/
209
210 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
211 #define ip_service_equal(ip1,ip2) ( ((ip1).ip.s_addr == (ip2).ip.s_addr) && ((ip1).port == (ip2).port) )
212
213 /*****************************************************************
214  splits out the last subkey of a key
215  *****************************************************************/  
216
217 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
218         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
219
220 /****************************************************************************
221  Used by dptr_zero.
222 ****************************************************************************/
223
224 #define DPTR_MASK ((uint32)(((uint32)1)<<31))
225
226 /****************************************************************************
227  Return True if the offset is at zero.
228 ****************************************************************************/
229
230 #define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
231
232 /*******************************************************************
233 copy an IP address from one buffer to another
234 ********************************************************************/
235
236 #define putip(dest,src) memcpy(dest,src,4)
237
238 /*******************************************************************
239  Return True if a server has CIFS UNIX capabilities.
240 ********************************************************************/
241
242 #define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
243
244 /****************************************************************************
245  Make a filename into unix format.
246 ****************************************************************************/
247
248 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
249 #define unix_format(fname) string_replace(fname,'\\','/')
250 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
251
252 /****************************************************************************
253  Make a file into DOS format.
254 ****************************************************************************/
255
256 #define dos_format(fname) string_replace(fname,'/','\\')
257
258 /*****************************************************************************
259  Check to see if we are a DO for this domain
260 *****************************************************************************/
261
262 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC) 
263
264 /*****************************************************************************
265  Safe allocation macros.
266 *****************************************************************************/
267
268 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
269 #define SMB_REALLOC(p,s) Realloc((p),(s))
270 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count))
271 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
272 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
273 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
274
275 /* limiting size of ipc replies */
276 #define SMB_REALLOC_LIMIT(ptr,size) SMB_REALLOC(ptr,MAX((size),4*1024))
277
278 /* #define PARANOID_MALLOC_CHECKER 1 */
279
280 #if defined(PARANOID_MALLOC_CHECKER)
281
282 #define TALLOC(ctx, size) talloc_((ctx),(size))
283 #define TALLOC_P(ctx, type) (type *)talloc_((ctx),sizeof(type))
284 #define TALLOC_ARRAY(ctx, type, count) (type *)talloc_array_((ctx),sizeof(type),(count))
285 #define TALLOC_MEMDUP(ctx, ptr, size) talloc_memdup_((ctx),(ptr),(size))
286 #define TALLOC_ZERO(ctx, size) talloc_zero_((ctx),(size))
287 #define TALLOC_ZERO_P(ctx, type) (type *)talloc_zero_((ctx),sizeof(type))
288 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)talloc_zero_array_((ctx),sizeof(type),(count))
289 #define TALLOC_REALLOC(ctx, ptr, count) talloc_realloc_((ctx),(ptr),(count))
290 #define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)talloc_realloc_array_((ctx),(ptr),sizeof(type),(count))
291
292 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
293 #define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem_((ps),(size),1)
294
295
296 /* Get medieval on our ass about malloc.... */
297
298 /* Restrictions on malloc/realloc/calloc. */
299 #ifdef malloc
300 #undef malloc
301 #endif
302 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
303
304 #ifdef realloc
305 #undef realloc
306 #endif
307 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
308
309 #ifdef calloc
310 #undef calloc
311 #endif
312 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
313
314 #ifdef strndup
315 #undef strndup
316 #endif
317 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
318
319 #ifdef strdup
320 #undef strdup
321 #endif
322 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
323
324 #define SMB_MALLOC(s) malloc_(s)
325 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
326
327 #define SMB_STRDUP(s) smb_xstrdup(s)
328 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
329
330 #else
331
332 #define TALLOC(ctx, size) talloc((ctx),(size))
333 #define TALLOC_P(ctx, type) (type *)talloc((ctx),sizeof(type))
334 #define TALLOC_ARRAY(ctx, type, count) (type *)talloc_array((ctx),sizeof(type),(count))
335 #define TALLOC_MEMDUP(ctx, ptr, size) talloc_memdup((ctx),(ptr),(size))
336 #define TALLOC_ZERO(ctx, size) talloc_zero((ctx),(size))
337 #define TALLOC_ZERO_P(ctx, type) (type *)talloc_zero((ctx),sizeof(type))
338 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)talloc_zero_array((ctx),sizeof(type),(count))
339 #define TALLOC_REALLOC(ctx, ptr, count) talloc_realloc((ctx),(ptr),(count))
340 #define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)talloc_realloc_array((ctx),(ptr),sizeof(type),(count))
341
342 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
343 #define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem((ps),(size),1)
344
345 /* Regular malloc code. */
346
347 #define SMB_MALLOC(s) malloc(s)
348 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
349
350 #define SMB_STRDUP(s) strdup(s)
351 #define SMB_STRNDUP(s,n) strndup(s,n)
352
353 #endif
354
355 #endif /* _SMB_MACROS_H */