source: vendor/3.6.23/source3/include/smb_macros.h

Last change on this file was 740, checked in by Silvan Scherrer, 13 years ago

Samba Server: update vendor to 3.6.0

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