Samba3: Include util.h header file rather than having custom prototypes.
[kai/samba.git] / source3 / 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 3 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, see <http://www.gnu.org/licenses/>.
21 */
22
23 #ifndef _SMB_MACROS_H
24 #define _SMB_MACROS_H
25
26 /* Misc bit macros */
27 #define BOOLSTR(b) ((b) ? "Yes" : "No")
28 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
29
30 /* for readability... */
31 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
32 #define IS_DOS_DIR(test_mode)      (((test_mode) & aDIR) != 0)
33 #define IS_DOS_ARCHIVE(test_mode)  (((test_mode) & aARCH) != 0)
34 #define IS_DOS_SYSTEM(test_mode)   (((test_mode) & aSYSTEM) != 0)
35 #define IS_DOS_HIDDEN(test_mode)   (((test_mode) & aHIDDEN) != 0)
36
37 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
38
39 /**
40  * Free memory if the pointer and zero the pointer.
41  *
42  * @note You are explicitly allowed to pass NULL pointers -- they will
43  * always be ignored.
44  **/
45 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
46 #endif
47
48
49
50 #define SMB_WARN(condition, message) \
51     ((condition) ? (void)0 : \
52      DEBUG(0, ("WARNING: %s: %s\n", #condition, message)))
53
54 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
55
56 /* these are useful macros for checking validity of handles */
57 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
58 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
59 /* you must add the following extern declaration to files using this macro
60  * (do not add it to the macro as that causes nested extern declaration warnings)
61  * extern struct current_user current_user;
62  */
63 #define FSP_BELONGS_CONN(fsp,conn) do {\
64                         if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
65                                 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
66                         } while(0)
67
68 #define CHECK_READ(fsp,inbuf) (((fsp)->fh->fd != -1) && ((fsp)->can_read || \
69                         ((SVAL((inbuf),smb_flg2) & FLAGS2_READ_PERMIT_EXECUTE) && \
70                          (fsp->access_mask & FILE_EXECUTE))))
71
72 #define CHECK_WRITE(fsp) ((fsp)->can_write && ((fsp)->fh->fd != -1))
73
74 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
75                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
76
77 /* the service number for the [globals] defaults */ 
78 #define GLOBAL_SECTION_SNUM     (-1)
79 /* translates a connection number into a service number */
80 #define SNUM(conn)              ((conn)?(conn)->params->service:GLOBAL_SECTION_SNUM)
81
82
83 /* access various service details */
84 #define SERVICE(snum)      (lp_servicename(snum))
85 #define PRINTERNAME(snum)  (lp_printername(snum))
86 #define CAN_WRITE(conn)    (!conn->read_only)
87 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
88 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
89 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
90 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
91 #define CAN_PRINT(conn)    ((conn) && lp_print_ok(SNUM(conn)))
92 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden(SNUM(conn)))
93 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system(SNUM(conn)))
94 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive(SNUM(conn)))
95 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
96 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
97 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
98
99 /* 
100  * Used by the stat cache code to check if a returned
101  * stat structure is valid.
102  */
103
104 #define VALID_STAT(st) ((st).st_nlink != 0)  
105 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
106 #define SET_STAT_INVALID(st) ((st).st_nlink = 0)
107
108 #ifndef MIN
109 #define MIN(a,b) ((a)<(b)?(a):(b))
110 #endif
111 #ifndef MAX
112 #define MAX(a,b) ((a)>(b)?(a):(b))
113 #endif
114
115 #ifndef ABS
116 #define ABS(a) ((a)>0?(a):(-(a)))
117 #endif
118
119 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
120    structures. We cannot define these as actual structures
121    due to possible differences in structure packing
122    on different machines/compilers. */
123
124 #define SMB_LPID_OFFSET(indx) (10 * (indx))
125 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
126 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
127 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
128 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
129 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
130 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
131 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
132
133 #define ERROR_DOS(class,code) error_packet(outbuf,class,code,NT_STATUS_OK,__LINE__,__FILE__)
134 #define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
135 #define ERROR_FORCE_NT(status) error_packet(outbuf,-1,-1,status,__LINE__,__FILE__)
136 #define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
137
138 #define reply_nterror(req,status) reply_nt_error(req,status,__LINE__,__FILE__)
139 #define reply_force_nterror(req,status) reply_force_nt_error(req,status,__LINE__,__FILE__)
140 #define reply_doserror(req,eclass,ecode) reply_dos_error(req,eclass,ecode,__LINE__,__FILE__)
141 #define reply_botherror(req,status,eclass,ecode) reply_both_error(req,eclass,ecode,status,__LINE__,__FILE__)
142 #define reply_unixerror(req,defclass,deferror) reply_unix_error(req,defclass,deferror,NT_STATUS_OK,__LINE__,__FILE__)
143
144 #if 0
145 /* defined in IDL */
146 /* these are the datagram types */
147 #define DGRAM_DIRECT_UNIQUE 0x10
148 #endif
149
150 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
151
152 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
153 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
154 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
155
156 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
157 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
158
159 /* Note that chain_size must be available as an extern int to this macro. */
160 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
161
162 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
163 #define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = ((len)&0x10000)>>16; \
164         buf[2] = ((len)&0xFF00)>>8; buf[3] = (len)&0xFF; } while (0)
165
166 #define smb_len_large(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|(PVAL(buf,1)<<16))
167 #define _smb_setlen_large(buf,len) do { buf[0] = 0; buf[1] = ((len)&0xFF0000)>>16; \
168         buf[2] = ((len)&0xFF00)>>8; buf[3] = (len)&0xFF; } while (0)
169
170 #define ENCRYPTION_REQUIRED(conn) ((conn) ? ((conn)->encrypt_level == Required) : false)
171 #define IS_CONN_ENCRYPTED(conn) ((conn) ? (conn)->encrypted_tid : false)
172
173 /*******************************************************************
174 find the difference in milliseconds between two struct timeval
175 values
176 ********************************************************************/
177
178 #define TvalDiff(tvalold,tvalnew) \
179   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
180          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
181
182 /****************************************************************************
183 true if two IPv4 addresses are equal
184 ****************************************************************************/
185
186 #define ip_equal_v4(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
187
188 /*****************************************************************
189  splits out the last subkey of a key
190  *****************************************************************/  
191
192 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
193         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
194
195 /****************************************************************************
196  Return True if the offset is at zero.
197 ****************************************************************************/
198
199 #define dptr_zero(buf) (IVAL(buf,1) == 0)
200
201 /*******************************************************************
202 copy an IP address from one buffer to another
203 ********************************************************************/
204
205 #define putip(dest,src) memcpy(dest,src,4)
206
207 /*******************************************************************
208  Return True if a server has CIFS UNIX capabilities.
209 ********************************************************************/
210
211 #define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
212
213 /****************************************************************************
214  Make a filename into unix format.
215 ****************************************************************************/
216
217 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
218 #define unix_format(fname) string_replace(fname,'\\','/')
219 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
220
221 /****************************************************************************
222  Make a file into DOS format.
223 ****************************************************************************/
224
225 #define dos_format(fname) string_replace(fname,'/','\\')
226
227 /*****************************************************************************
228  Check to see if we are a DC for this domain
229 *****************************************************************************/
230
231 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC) 
232
233 /*****************************************************************************
234  Safe allocation macros.
235 *****************************************************************************/
236
237 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
238 #define SMB_MEMALIGN_ARRAY(type,align,count) (type *)memalign_array(sizeof(type),align,(count))
239 #define SMB_REALLOC(p,s) Realloc((p),(s),True)  /* Always frees p on error or s == 0 */
240 #define SMB_REALLOC_KEEP_OLD_ON_ERROR(p,s) Realloc((p),(s),False) /* Never frees p on error or s == 0 */
241 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count),True) /* Always frees p on error or s == 0 */
242 #define SMB_REALLOC_ARRAY_KEEP_OLD_ON_ERROR(p,type,count) (type *)realloc_array((p),sizeof(type),(count),False) /* Never frees p on error or s == 0 */
243 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
244 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
245 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
246
247 /* The new talloc is paranoid malloc checker safe. */
248
249 #if 0
250
251 Disable these now we have checked all code paths and ensured
252 NULL returns on zero request. JRA.
253
254 #define TALLOC(ctx, size) talloc_zeronull(ctx, size, __location__)
255 #define TALLOC_P(ctx, type) (type *)talloc_zeronull(ctx, sizeof(type), #type)
256 #define TALLOC_ARRAY(ctx, type, count) (type *)_talloc_array_zeronull(ctx, sizeof(type), count, #type)
257 #define TALLOC_MEMDUP(ctx, ptr, size) _talloc_memdup_zeronull(ctx, ptr, size, __location__)
258 #define TALLOC_ZERO(ctx, size) _talloc_zero_zeronull(ctx, size, __location__)
259 #define TALLOC_ZERO_P(ctx, type) (type *)_talloc_zero_zeronull(ctx, sizeof(type), #type)
260 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)_talloc_zero_array_zeronull(ctx, sizeof(type), count, #type)
261 #define TALLOC_SIZE(ctx, size) talloc_zeronull(ctx, size, __location__)
262 #define TALLOC_ZERO_SIZE(ctx, size) _talloc_zero_zeronull(ctx, size, __location__)
263
264 #else
265
266 #define TALLOC(ctx, size) talloc_named_const(ctx, size, __location__)
267 #define TALLOC_P(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
268 #define TALLOC_ARRAY(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
269 #define TALLOC_MEMDUP(ctx, ptr, size) _talloc_memdup(ctx, ptr, size, __location__)
270 #define TALLOC_ZERO(ctx, size) _talloc_zero(ctx, size, __location__)
271 #define TALLOC_ZERO_P(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
272 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
273 #define TALLOC_SIZE(ctx, size) talloc_named_const(ctx, size, __location__)
274 #define TALLOC_ZERO_SIZE(ctx, size) _talloc_zero(ctx, size, __location__)
275
276 #endif
277
278 #define TALLOC_REALLOC(ctx, ptr, count) _talloc_realloc(ctx, ptr, count, __location__)
279 #define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)_talloc_realloc_array(ctx, ptr, sizeof(type), count, #type)
280 #define talloc_destroy(ctx) talloc_free(ctx)
281 #define TALLOC_FREE(ctx) do { if ((ctx) != NULL) {talloc_free(ctx); ctx=NULL;} } while(0)
282
283 /* only define PARANOID_MALLOC_CHECKER with --enable-developer */
284
285 #if defined(DEVELOPER)
286 #  define PARANOID_MALLOC_CHECKER 1
287 #endif
288
289 #if defined(PARANOID_MALLOC_CHECKER)
290
291 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
292
293 /* Get medieval on our ass about malloc.... */
294
295 /* Restrictions on malloc/realloc/calloc. */
296 #ifdef malloc
297 #undef malloc
298 #endif
299 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
300
301 #ifdef realloc
302 #undef realloc
303 #endif
304 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
305
306 #ifdef calloc
307 #undef calloc
308 #endif
309 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
310
311 #ifdef strndup
312 #undef strndup
313 #endif
314 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
315
316 #ifdef strdup
317 #undef strdup
318 #endif
319 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
320
321 #define SMB_MALLOC(s) malloc_(s)
322 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
323
324 #define SMB_STRDUP(s) smb_xstrdup(s)
325 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
326
327 #else
328
329 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
330
331 /* Regular malloc code. */
332
333 #define SMB_MALLOC(s) malloc(s)
334 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
335
336 #define SMB_STRDUP(s) strdup(s)
337 #define SMB_STRNDUP(s,n) strndup(s,n)
338
339 #endif
340
341 #define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
342 do { \
343         *(array) = ((mem_ctx) != NULL) ? \
344                 TALLOC_REALLOC_ARRAY(mem_ctx, (*(array)), type, (*(num))+1) : \
345                 SMB_REALLOC_ARRAY((*(array)), type, (*(num))+1); \
346         SMB_ASSERT((*(array)) != NULL); \
347         (*(array))[*(num)] = (elem); \
348         (*(num)) += 1; \
349 } while (0)
350
351 #define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
352         add_to_large_array((mem_ctx), sizeof(type), &(elem), (void *)(array), (num), (size));
353
354 #ifndef ISDOT
355 #define ISDOT(p) (*(p) == '.' && *((p) + 1) == '\0')
356 #endif /* ISDOT */
357
358 #ifndef ISDOTDOT
359 #define ISDOTDOT(p) (*(p) == '.' && *((p) + 1) == '.' && *((p) + 2) == '\0')
360 #endif /* ISDOTDOT */
361
362 #ifndef toupper_ascii_fast
363 /* Warning - this must only be called with 0 <= c < 128. IT WILL
364  * GIVE GARBAGE if c > 128 or c < 0. JRA.
365  */
366 extern char toupper_ascii_fast_table[];
367 #define toupper_ascii_fast(c) toupper_ascii_fast_table[(unsigned int)(c)];
368 #endif
369
370 #endif /* _SMB_MACROS_H */