source/include/smb_macros.h

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    SMB parameters and setup
   5    Copyright (C) Andrew Tridgell 1992-1999
   6    Copyright (C) John H Terpstra 1996-1999
   7    Copyright (C) Luke Kenneth Casson Leighton 1996-1999
   8    Copyright (C) Paul Ashton 1998 - 1999
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25 #ifndef _SMB_MACROS_H
  26 #define _SMB_MACROS_H
  27
  28 /* Misc bit macros */
  29 #define BOOLSTR(b) ((b) ? "Yes" : "No")
  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 /* free memory if the pointer is valid and zero the pointer */
  40 #ifndef SAFE_FREE
  41 #define SAFE_FREE(x) do { if ((x) != NULL) {free((x)); (x)=NULL;} } while(0)
  42 #endif
  43
  44 /* zero a structure */
  45 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
  46
  47 /* zero a structure given a pointer to the structure */
  48 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
  49
  50 /* zero a structure given a pointer to the structure - no zero check */
  51 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
  52
  53 /* zero an array - note that sizeof(array) must work - ie. it must not be a
  54    pointer */
  55 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
  56
  57 /* pointer difference macro */
  58 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
  59
  60 /* work out how many elements there are in a static array */
  61 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
  62
  63 /* assert macros */
  64 #define SMB_ASSERT(b) ((b)?(void)0: \
  65         (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
  66                  __FILE__, __LINE__)), smb_panic("assert failed")))
  67 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  68
  69 /* these are useful macros for checking validity of handles */
  70 #define OPEN_FSP(fsp)    ((fsp) && !(fsp)->is_directory)
  71 #define OPEN_CONN(conn)    ((conn) && (conn)->open)
  72 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  73 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  74 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
  75
  76 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
  77                                 return(ERROR_DOS(ERRDOS,ERRbadfid)); \
  78                         else if((fsp)->fd == -1) \
  79                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
  80
  81 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
  82                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
  83 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
  84                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
  85
  86 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
  87                                 return(CACHED_ERROR(fsp))
  88
  89 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
  90                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
  91
  92 /* translates a connection number into a service number */
  93 #define SNUM(conn)         ((conn)?(conn)->service:-1)
  94
  95 /* access various service details */
  96 #define SERVICE(snum)      (lp_servicename(snum))
  97 #define PRINTCAP           (lp_printcapname())
  98 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
  99 #define PRINTERNAME(snum)  (lp_printername(snum))
 100 #define CAN_WRITE(conn)    (!conn->read_only)
 101 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
 102 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
 103 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
 104 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
 105 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
 106 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
 107 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
 108 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
 109 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list))
 110 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list))
 111 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list))
 112
 113 /*
 114  * Used by the stat cache code to check if a returned
 115  * stat structure is valid.
 116  */
 117
 118 #define VALID_STAT(st) ((st).st_nlink != 0)
 119 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
 120
 121 #define SMBENCRYPT()       (lp_encrypted_passwords())
 122
 123 #ifndef MIN
 124 #define MIN(a,b) ((a)<(b)?(a):(b))
 125 #endif
 126 #ifndef MAX
 127 #define MAX(a,b) ((a)>(b)?(a):(b))
 128 #endif
 129
 130 #ifndef ABS
 131 #define ABS(a) ((a)>0?(a):(-(a)))
 132 #endif
 133
 134 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 135    structures. We cannot define these as actual structures
 136    due to possible differences in structure packing
 137    on different machines/compilers. */
 138
 139 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 140 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 141 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 142 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
 143 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 144 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 145 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 146 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 147
 148 /* Macro to cache an error in a write_bmpx_struct */
 149 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
 150                 w->wr_discard = True, -1)
 151 /* Macro to test if an error has been cached for this fnum */
 152 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
 153                 (fsp)->wbmpx_ptr->wr_discard)
 154 /* Macro to turn the cached error into an error packet */
 155 #define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
 156
 157 /* these are the datagram types */
 158 #define DGRAM_DIRECT_UNIQUE 0x10
 159
 160 #define ERROR_NT(status) error_packet(outbuf,status,0,0,__LINE__,__FILE__)
 161 #define ERROR_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,__LINE__,__FILE__)
 162 #define ERROR_BOTH(nterr,class,x) error_packet(outbuf,nterr,class,x,__LINE__,__FILE__)
 163
 164 /* this is how errors are generated */
 165 #define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,__LINE__,__FILE__)
 166
 167 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
 168
 169 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 170 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 171 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 172
 173 /* Note that chain_size must be available as an extern int to this macro. */
 174 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
 175
 176 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
 177 #define _smb_setlen(buf,len) buf[0] = 0; buf[1] = (len&0x10000)>>16; \
 178         buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF;
 179
 180 /*******************************************************************
 181 find the difference in milliseconds between two struct timeval
 182 values
 183 ********************************************************************/
 184
 185 #define TvalDiff(tvalold,tvalnew) \
 186   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
 187          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
 188
 189 /****************************************************************************
 190 true if two IP addresses are equal
 191 ****************************************************************************/
 192
 193 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 194
 195 /*****************************************************************
 196  splits out the last subkey of a key
 197  *****************************************************************/
 198
 199 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 200         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 201
 202 /****************************************************************************
 203  Used by dptr_zero.
 204 ****************************************************************************/
 205
 206 #define DPTR_MASK ((uint32)(((uint32)1)<<31))
 207
 208 /****************************************************************************
 209  Return True if the offset is at zero.
 210 ****************************************************************************/
 211
 212 #define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
 213
 214 /*******************************************************************
 215 copy an IP address from one buffer to another
 216 ********************************************************************/
 217
 218 #define putip(dest,src) memcpy(dest,src,4)
 219
 220
 221 /*******************************************************************
 222  Return True if a server has CIFS UNIX capabilities.
 223 ********************************************************************/
 224
 225 #define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
 226
 227 /****************************************************************************
 228  Make a filename into unix format.
 229 ****************************************************************************/
 230
 231 #define unix_format(fname) string_replace(fname,'\\','/')
 232
 233 /****************************************************************************
 234  Make a file into DOS format.
 235 ****************************************************************************/
 236
 237 #define dos_format(fname) string_replace(fname,'/','\\')
 238
 239 /*******************************************************************
 240  vfs stat wrapper that calls dos_to_unix.
 241 ********************************************************************/
 242
 243 #define vfs_stat(conn, fname, st) ((conn)->vfs_ops.stat((conn), dos_to_unix_static((fname)),(st)))
 244
 245 /*******************************************************************
 246  vfs lstat wrapper that calls dos_to_unix.
 247 ********************************************************************/
 248
 249 #define vfs_lstat(conn, fname, st) ((conn)->vfs_ops.lstat((conn), dos_to_unix_static((fname)),(st)))
 250
 251 /*******************************************************************
 252  vfs fstat wrapper that calls dos_to_unix.
 253 ********************************************************************/
 254
 255 #define vfs_fstat(fsp, fd, st) ((fsp)->conn->vfs_ops.fstat((fsp),(fd),(st)))
 256
 257 /*******************************************************************
 258  vfs rmdir wrapper that calls dos_to_unix.
 259 ********************************************************************/
 260
 261 #define vfs_rmdir(conn,fname) ((conn)->vfs_ops.rmdir((conn),dos_to_unix_static((fname))))
 262
 263 /*******************************************************************
 264  vfs Unlink wrapper that calls dos_to_unix.
 265 ********************************************************************/
 266
 267 #define vfs_unlink(conn, fname) ((conn)->vfs_ops.unlink((conn),dos_to_unix_static((fname))))
 268
 269 /*******************************************************************
 270  vfs chmod wrapper that calls dos_to_unix.
 271 ********************************************************************/
 272
 273 #define vfs_chmod(conn,fname,mode) ((conn)->vfs_ops.chmod((conn),dos_to_unix_static((fname)),(mode)))
 274
 275 /*******************************************************************
 276  vfs chown wrapper that calls dos_to_unix.
 277 ********************************************************************/
 278
 279 #define vfs_chown(conn,fname,uid,gid) ((conn)->vfs_ops.chown((conn),dos_to_unix_static((fname)),(uid),(gid)))
 280
 281 /*******************************************************************
 282  A wrapper for vfs_chdir().
 283 ********************************************************************/
 284
 285 #define vfs_chdir(conn,fname) ((conn)->vfs_ops.chdir((conn),dos_to_unix_static((fname))))
 286
 287 #endif /* _SMB_MACROS_H */