source: trunk/samba/source/include/smb_macros.h @ 30

Last change on this file since 30 was 30, checked in by Paul Smedley, 14 years ago

Code updated to Samba 3.0.25rc2 level

File size: 15.1 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 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(x); x=NULL;} } while(0)
47#endif
48
49/* assert macros */
50#ifdef DEVELOPER
51#define SMB_ASSERT(b) ( (b) ? (void)0 : \
52        (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
53                 __FILE__, __LINE__)), smb_panic("assert failed")))
54#else
55/* redefine the assert macro for non-developer builds */
56#define SMB_ASSERT(b) ( (b) ? (void)0 : \
57        (DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__))))
58#endif
59
60#define SMB_WARN(condition, message) \
61    ((condition) ? (void)0 : \
62     DEBUG(0, ("WARNING: %s: %s\n", #condition, message)))
63
64#define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
65
66/* these are useful macros for checking validity of handles */
67#define IS_IPC(conn)       ((conn) && (conn)->ipc)
68#define IS_PRINT(conn)       ((conn) && (conn)->printer)
69/* you must add the following extern declaration to files using this macro
70 * (do not add it to the macro as that causes nested extern declaration warnings)
71 * extern struct current_user current_user;
72 */
73#define FSP_BELONGS_CONN(fsp,conn) do {\
74                        if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
75                                return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
76                        } while(0)
77
78#define FNUM_OK(fsp,c) ((fsp) && !(fsp)->is_directory && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
79
80/* you must add the following extern declaration to files using this macro
81 * (do not add it to the macro as that causes nested extern declaration warnings)
82 * extern struct current_user current_user;
83 */
84#define CHECK_FSP(fsp,conn) do {\
85                        if (!(fsp) || !(conn)) \
86                                return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
87                        else if (((conn) != (fsp)->conn) || current_user.vuid != (fsp)->vuid) \
88                                return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
89                        else if ((fsp)->is_directory) \
90                                return ERROR_NT(NT_STATUS_INVALID_DEVICE_REQUEST); \
91                        else if ((fsp)->fh->fd == -1) \
92                                return ERROR_NT(NT_STATUS_ACCESS_DENIED); \
93                        (fsp)->num_smb_operations++;\
94                        } while(0)
95
96#define CHECK_READ(fsp,inbuf) (((fsp)->fh->fd != -1) && ((fsp)->can_read || \
97                        ((SVAL((inbuf),smb_flg2) & FLAGS2_READ_PERMIT_EXECUTE) && \
98                         (fsp->access_mask & FILE_EXECUTE))))
99
100#define CHECK_WRITE(fsp) ((fsp)->can_write && ((fsp)->fh->fd != -1))
101
102#define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
103                                NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
104
105/* the service number for the [globals] defaults */ 
106#define GLOBAL_SECTION_SNUM     (-1)
107/* translates a connection number into a service number */
108#define SNUM(conn)              ((conn)?(conn)->params->service:GLOBAL_SECTION_SNUM)
109
110
111/* access various service details */
112#define SERVICE(snum)      (lp_servicename(snum))
113#define PRINTERNAME(snum)  (lp_printername(snum))
114#define CAN_WRITE(conn)    (!conn->read_only)
115#define VALID_SNUM(snum)   (lp_snum_ok(snum))
116#define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
117#define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
118#define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
119#define CAN_PRINT(conn)    ((conn) && lp_print_ok(SNUM(conn)))
120#define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden(SNUM(conn)))
121#define MAP_SYSTEM(conn)   ((conn) && lp_map_system(SNUM(conn)))
122#define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive(SNUM(conn)))
123#define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
124#define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
125#define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
126
127/*
128 * Used by the stat cache code to check if a returned
129 * stat structure is valid.
130 */
131
132#define VALID_STAT(st) ((st).st_nlink != 0) 
133#define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
134#define SET_STAT_INVALID(st) ((st).st_nlink = 0)
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 test if an error has been cached for this fnum */
162#define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
163                (fsp)->wbmpx_ptr->wr_discard)
164/* Macro to turn the cached error into an error packet */
165#define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
166
167#define ERROR_DOS(class,code) error_packet(outbuf,class,code,NT_STATUS_OK,__LINE__,__FILE__)
168#define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
169#define ERROR_FORCE_NT(status) error_packet(outbuf,-1,-1,status,__LINE__,__FILE__)
170#define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
171
172/* this is how errors are generated */
173#define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,NT_STATUS_OK,__LINE__,__FILE__)
174
175/* these are the datagram types */
176#define DGRAM_DIRECT_UNIQUE 0x10
177
178#define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
179
180/* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
181#define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
182#define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
183
184/* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
185#define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
186
187/* Note that chain_size must be available as an extern int to this macro. */
188#define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
189
190#define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
191#define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = (len&0x10000)>>16; \
192        buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF; } while (0)
193
194/*******************************************************************
195find the difference in milliseconds between two struct timeval
196values
197********************************************************************/
198
199#define TvalDiff(tvalold,tvalnew) \
200  (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
201         ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
202
203/****************************************************************************
204true if two IP addresses are equal
205****************************************************************************/
206
207#define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
208#define ip_service_equal(ip1,ip2) ( ((ip1).ip.s_addr == (ip2).ip.s_addr) && ((ip1).port == (ip2).port) )
209
210/*****************************************************************
211 splits out the last subkey of a key
212 *****************************************************************/ 
213
214#define reg_get_subkey(full_keyname, key_name, subkey_name) \
215        split_at_last_component(full_keyname, key_name, '\\', subkey_name)
216
217/****************************************************************************
218 Return True if the offset is at zero.
219****************************************************************************/
220
221#define dptr_zero(buf) (IVAL(buf,1) == 0)
222
223/*******************************************************************
224copy an IP address from one buffer to another
225********************************************************************/
226
227#define putip(dest,src) memcpy(dest,src,4)
228
229/*******************************************************************
230 Return True if a server has CIFS UNIX capabilities.
231********************************************************************/
232
233#define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
234
235/****************************************************************************
236 Make a filename into unix format.
237****************************************************************************/
238
239#define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
240#define unix_format(fname) string_replace(fname,'\\','/')
241#define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
242
243/****************************************************************************
244 Make a file into DOS format.
245****************************************************************************/
246
247#define dos_format(fname) string_replace(fname,'/','\\')
248
249/*****************************************************************************
250 Check to see if we are a DC for this domain
251*****************************************************************************/
252
253#define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC)
254
255/*****************************************************************************
256 Safe allocation macros.
257*****************************************************************************/
258
259#define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
260#define SMB_MEMALIGN_ARRAY(type,align,count) (type *)memalign_array(sizeof(type),align,(count))
261#define SMB_REALLOC(p,s) Realloc((p),(s),True)  /* Always frees p on error or s == 0 */
262#define SMB_REALLOC_KEEP_OLD_ON_ERROR(p,s) Realloc((p),(s),False) /* Never frees p on error or s == 0 */
263#define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count),True) /* Always frees p on error or s == 0 */
264#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 */
265#define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
266#define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
267#define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
268
269/* limiting size of ipc replies */
270#define SMB_REALLOC_LIMIT(ptr,size) (char *)SMB_REALLOC(ptr,MAX((size),4*1024))
271
272/* The new talloc is paranoid malloc checker safe. */
273
274#define TALLOC(ctx, size) talloc_named_const(ctx, size, __location__)
275#define TALLOC_P(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
276#define TALLOC_ARRAY(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
277#define TALLOC_MEMDUP(ctx, ptr, size) _talloc_memdup(ctx, ptr, size, __location__)
278#define TALLOC_ZERO(ctx, size) _talloc_zero(ctx, size, __location__)
279#define TALLOC_ZERO_P(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
280#define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
281#define TALLOC_REALLOC(ctx, ptr, count) _talloc_realloc(ctx, ptr, count, __location__)
282#define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)_talloc_realloc_array(ctx, ptr, sizeof(type), count, #type)
283#define talloc_destroy(ctx) talloc_free(ctx)
284#define TALLOC_FREE(ctx) do { if ((ctx) != NULL) {talloc_free(ctx); ctx=NULL;} } while(0)
285
286/* only define PARANOID_MALLOC_CHECKER with --enable-developer and not compiling
287   the smbmount utils */
288
289#if defined(DEVELOPER) && !defined(SMBMOUNT_MALLOC)
290#  define PARANOID_MALLOC_CHECKER 1
291#endif
292
293#if defined(PARANOID_MALLOC_CHECKER)
294
295#define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
296#define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem_((ps),(size),1)
297
298/* Get medieval on our ass about malloc.... */
299
300/* Restrictions on malloc/realloc/calloc. */
301#ifdef malloc
302#undef malloc
303#endif
304#define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
305
306#ifdef realloc
307#undef realloc
308#endif
309#define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
310
311#ifdef calloc
312#undef calloc
313#endif
314#define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
315
316#ifdef strndup
317#undef strndup
318#endif
319#define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
320
321#ifdef strdup
322#undef strdup
323#endif
324#define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
325
326#define SMB_MALLOC(s) malloc_(s)
327#define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
328
329#define SMB_STRDUP(s) smb_xstrdup(s)
330#define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
331
332#else
333
334#define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
335#define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem((ps),(size),1)
336
337/* Regular malloc code. */
338
339#define SMB_MALLOC(s) malloc(s)
340#define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
341
342#define SMB_STRDUP(s) strdup(s)
343#define SMB_STRNDUP(s,n) strndup(s,n)
344
345#endif
346
347#define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
348do { \
349        *(array) = ((mem_ctx) != NULL) ? \
350                TALLOC_REALLOC_ARRAY(mem_ctx, (*(array)), type, (*(num))+1) : \
351                SMB_REALLOC_ARRAY((*(array)), type, (*(num))+1); \
352        SMB_ASSERT((*(array)) != NULL); \
353        (*(array))[*(num)] = (elem); \
354        (*(num)) += 1; \
355} while (0)
356
357#define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
358        add_to_large_array((mem_ctx), sizeof(type), &(elem), (void *)(array), (num), (size));
359
360#ifndef ISDOT
361#define ISDOT(p) (*(p) == '.' && *((p) + 1) == '\0')
362#endif /* ISDOT */
363
364#ifndef ISDOTDOT
365#define ISDOTDOT(p) (*(p) == '.' && *((p) + 1) == '.' && *((p) + 2) == '\0')
366#endif /* ISDOTDOT */
367
368#endif /* _SMB_MACROS_H */
Note: See TracBrowser for help on using the repository browser.