Clarify doc for SAFE_FREE.
[ira/wip.git] / source3 / include / smb_macros.h
1 /* 
2    Unix SMB/Netbios 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 BITSETB(ptr,bit) ((((char *)ptr)[0] & (1<<(bit)))!=0)
30 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
31
32 /* for readability... */
33 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
34 #define IS_DOS_DIR(test_mode)      (((test_mode) & aDIR) != 0)
35 #define IS_DOS_ARCHIVE(test_mode)  (((test_mode) & aARCH) != 0)
36 #define IS_DOS_SYSTEM(test_mode)   (((test_mode) & aSYSTEM) != 0)
37 #define IS_DOS_HIDDEN(test_mode)   (((test_mode) & aHIDDEN) != 0)
38
39 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
40
41 /**
42  * Free memory if the pointer and zero the pointer.
43  *
44  * @note You are explicitly allowed to pass NULL pointers -- they will
45  * always be ignored.
46  **/
47 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
48 #endif
49
50 /* zero a structure */
51 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
52
53 /* zero a structure given a pointer to the structure */
54 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
55
56 /* zero a structure given a pointer to the structure - no zero check */
57 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
58
59 /* zero an array - note that sizeof(array) must work - ie. it must not be a 
60    pointer */
61 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
62
63 /* pointer difference macro */
64 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
65
66 /* work out how many elements there are in a static array */
67 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
68
69 /* assert macros */
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")))
73 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
74
75 /* these are useful macros for checking validity of handles */
76 #define OPEN_FSP(fsp)    ((fsp) && !(fsp)->is_directory)
77 #define OPEN_CONN(conn)    ((conn) && (conn)->open)
78 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
79 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
80 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
81
82 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
83                                return(ERROR_DOS(ERRDOS,ERRbadfid)); \
84                             else if((fsp)->fd == -1) \
85                                return(ERROR_DOS(ERRDOS,ERRbadaccess))
86
87 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
88                                return(ERROR_DOS(ERRDOS,ERRbadaccess))
89 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
90                                return(ERROR_DOS(ERRDOS,ERRbadaccess))
91
92 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
93                                                                 return(CACHED_ERROR(fsp))
94
95 /* translates a connection number into a service number */
96 #define SNUM(conn)         ((conn)?(conn)->service:-1)
97
98 /* access various service details */
99 #define SERVICE(snum)      (lp_servicename(snum))
100 #define PRINTCAP           (lp_printcapname())
101 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
102 #define PRINTERNAME(snum)  (lp_printername(snum))
103 #define CAN_WRITE(conn)    (!conn->read_only)
104 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
105 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
106 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
107 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
108 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
109 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
110 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
111 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
112 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list))
113 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list))
114 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list))
115
116 /* 
117  * Used by the stat cache code to check if a returned
118  * stat structure is valid.
119  */
120
121 #define VALID_STAT(st) ((st).st_nlink != 0)  
122 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
123
124 #ifndef MIN
125 #define MIN(a,b) ((a)<(b)?(a):(b))
126 #endif
127 #ifndef MAX
128 #define MAX(a,b) ((a)>(b)?(a):(b))
129 #endif
130
131 #ifndef ABS
132 #define ABS(a) ((a)>0?(a):(-(a)))
133 #endif
134
135 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
136    structures. We cannot define these as actual structures
137    due to possible differences in structure packing
138    on different machines/compilers. */
139
140 #define SMB_LPID_OFFSET(indx) (10 * (indx))
141 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
142 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
143 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
144 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
145 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
146 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
147 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
148
149 /* Macro to cache an error in a write_bmpx_struct */
150 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
151                 w->wr_discard = True, -1)
152 /* Macro to test if an error has been cached for this fnum */
153 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
154                 (fsp)->wbmpx_ptr->wr_discard)
155 /* Macro to turn the cached error into an error packet */
156 #define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
157
158 /* these are the datagram types */
159 #define DGRAM_DIRECT_UNIQUE 0x10
160
161 #define ERROR_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,__LINE__,__FILE__)
162 #define ERROR_NT(status) error_packet(outbuf,status,0,0,__LINE__,__FILE__)
163 #define ERROR_BOTH(status,class,code) error_packet(outbuf,status,class,code,__LINE__,__FILE__)
164
165 /* this is how errors are generated */
166 #define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,__LINE__,__FILE__)
167
168 #define SMB_ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
169 #define SMB_ROUNDUP_ALLOCATION(s) (SMB_ROUNDUP((SMB_OFF_T)((s)+1), ((SMB_OFF_T)SMB_ROUNDUP_ALLOCATION_SIZE)))
170
171 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
172 #define smb_buf(buf) (buf + smb_size + CVAL(buf,smb_wct)*2)
173 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
174
175 /* Note that chain_size must be available as an extern int to this macro. */
176 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
177
178 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
179 #define _smb_setlen(buf,len) buf[0] = 0; buf[1] = (len&0x10000)>>16; \
180         buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF;
181
182 /*******************************************************************
183 find the difference in milliseconds between two struct timeval
184 values
185 ********************************************************************/
186
187 #define TvalDiff(tvalold,tvalnew) \
188   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
189          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
190
191 /****************************************************************************
192 true if two IP addresses are equal
193 ****************************************************************************/
194
195 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
196
197 /*****************************************************************
198  splits out the last subkey of a key
199  *****************************************************************/  
200
201 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
202         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
203
204 /****************************************************************************
205  Used by dptr_zero.
206 ****************************************************************************/
207
208 #define DPTR_MASK ((uint32)(((uint32)1)<<31))
209
210 /****************************************************************************
211  Return True if the offset is at zero.
212 ****************************************************************************/
213
214 #define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
215
216 /*******************************************************************
217 copy an IP address from one buffer to another
218 ********************************************************************/
219
220 #define putip(dest,src) memcpy(dest,src,4)
221
222 /****************************************************************************
223  Make a filename into unix format.
224 ****************************************************************************/
225
226 #define unix_format(fname) string_replace(fname,'\\','/')
227 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
228
229 /****************************************************************************
230  Make a file into DOS format.
231 ****************************************************************************/
232
233 #define dos_format(fname) string_replace(fname,'/','\\')
234
235 /*******************************************************************
236  vfs stat wrapper that calls internal2unix.
237 ********************************************************************/
238
239 #define vfs_stat(conn, fname, st) ((conn)->vfs_ops.stat((conn), fname,(st)))
240
241 /*******************************************************************
242  vfs fstat wrapper
243 ********************************************************************/
244
245 #define vfs_fstat(fsp, fd, st) ((fsp)->conn->vfs_ops.fstat((fsp),(fd),(st)))
246
247 /*******************************************************************
248  vfs rmdir wrapper that calls internal2unix.
249 ********************************************************************/
250
251 #define vfs_rmdir(conn,fname) ((conn)->vfs_ops.rmdir((conn),fname))
252
253 /*******************************************************************
254  vfs Unlink wrapper that calls internal2unix.
255 ********************************************************************/
256
257 #define vfs_unlink(conn, fname) ((conn)->vfs_ops.unlink((conn),fname))
258
259 /*******************************************************************
260  vfs chmod wrapper that calls internal2unix.
261 ********************************************************************/
262
263 #define vfs_chmod(conn,fname,mode) ((conn)->vfs_ops.chmod((conn),fname,(mode)))
264
265 /*******************************************************************
266  vfs chown wrapper that calls internal2unix.
267 ********************************************************************/
268
269 #define vfs_chown(conn,fname,uid,gid) ((conn)->vfs_ops.chown((conn),fname,(uid),(gid)))
270
271 /*******************************************************************
272  A wrapper for vfs_chdir().
273 ********************************************************************/
274
275 #define vfs_chdir(conn,fname) ((conn)->vfs_ops.chdir((conn),fname))
276
277 #endif /* _SMB_MACROS_H */