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