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