source/include/smb_macros.h

   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 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 FSP_BELONGS_CONN(fsp,conn) do {\
  81                         extern struct current_user current_user;\
  82                         if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
  83                                 return(ERROR_DOS(ERRDOS,ERRbadfid));\
  84                         } while(0)
  85
  86 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
  87
  88 #define CHECK_FSP(fsp,conn) do {\
  89                         extern struct current_user current_user;\
  90                         if (!FNUM_OK(fsp,conn)) \
  91                                 return(ERROR_DOS(ERRDOS,ERRbadfid)); \
  92                         else if((fsp)->fd == -1) \
  93                                 return(ERROR_DOS(ERRDOS,ERRbadaccess));\
  94                         } while(0)
  95
  96 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
  97                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
  98 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
  99                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
 100
 101 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
 102                                 return(CACHED_ERROR(fsp))
 103
 104 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
 105                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
 106
 107 /* the service number for the [globals] defaults */
 108 #define GLOBAL_SECTION_SNUM     (-1)
 109 /* translates a connection number into a service number */
 110 #define SNUM(conn)              ((conn)?(conn)->service:GLOBAL_SECTION_SNUM)
 111
 112
 113 /* access various service details */
 114 #define SERVICE(snum)      (lp_servicename(snum))
 115 #define PRINTERNAME(snum)  (lp_printername(snum))
 116 #define CAN_WRITE(conn)    (!conn->read_only)
 117 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
 118 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
 119 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
 120 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
 121 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
 122 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
 123 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
 124 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
 125 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
 126 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
 127 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
 128
 129 /*
 130  * Used by the stat cache code to check if a returned
 131  * stat structure is valid.
 132  */
 133
 134 #define VALID_STAT(st) ((st).st_nlink != 0)
 135 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
 136
 137 #ifndef MIN
 138 #define MIN(a,b) ((a)<(b)?(a):(b))
 139 #endif
 140 #ifndef MAX
 141 #define MAX(a,b) ((a)>(b)?(a):(b))
 142 #endif
 143
 144 #ifndef ABS
 145 #define ABS(a) ((a)>0?(a):(-(a)))
 146 #endif
 147
 148 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 149    structures. We cannot define these as actual structures
 150    due to possible differences in structure packing
 151    on different machines/compilers. */
 152
 153 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 154 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 155 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 156 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
 157 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 158 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 159 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 160 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 161
 162 /* Macro to cache an error in a write_bmpx_struct */
 163 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
 164                 w->wr_discard = True, -1)
 165 /* Macro to test if an error has been cached for this fnum */
 166 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
 167                 (fsp)->wbmpx_ptr->wr_discard)
 168 /* Macro to turn the cached error into an error packet */
 169 #define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
 170
 171 /* these are the datagram types */
 172 #define DGRAM_DIRECT_UNIQUE 0x10
 173
 174 #define ERROR_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,False,__LINE__,__FILE__)
 175 #define ERROR_FORCE_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,True,__LINE__,__FILE__)
 176 #define ERROR_NT(status) error_packet(outbuf,status,0,0,False,__LINE__,__FILE__)
 177 #define ERROR_BOTH(status,class,code) error_packet(outbuf,status,class,code,False,__LINE__,__FILE__)
 178
 179 /* this is how errors are generated */
 180 #define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,__LINE__,__FILE__)
 181
 182 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
 183
 184 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 185 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 186 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 187
 188 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
 189 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
 190
 191 /* Note that chain_size must be available as an extern int to this macro. */
 192 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
 193
 194 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
 195 #define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = (len&0x10000)>>16; \
 196         buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF; } while (0)
 197
 198 /*******************************************************************
 199 find the difference in milliseconds between two struct timeval
 200 values
 201 ********************************************************************/
 202
 203 #define TvalDiff(tvalold,tvalnew) \
 204   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
 205          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
 206
 207 /****************************************************************************
 208 true if two IP addresses are equal
 209 ****************************************************************************/
 210
 211 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 212 #define ip_service_equal(ip1,ip2) ( ((ip1).ip.s_addr == (ip2).ip.s_addr) && ((ip1).port == (ip2).port) )
 213
 214 /*****************************************************************
 215  splits out the last subkey of a key
 216  *****************************************************************/
 217
 218 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 219         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 220
 221 /****************************************************************************
 222  Used by dptr_zero.
 223 ****************************************************************************/
 224
 225 #define DPTR_MASK ((uint32)(((uint32)1)<<31))
 226
 227 /****************************************************************************
 228  Return True if the offset is at zero.
 229 ****************************************************************************/
 230
 231 #define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
 232
 233 /*******************************************************************
 234 copy an IP address from one buffer to another
 235 ********************************************************************/
 236
 237 #define putip(dest,src) memcpy(dest,src,4)
 238
 239 /*******************************************************************
 240  Return True if a server has CIFS UNIX capabilities.
 241 ********************************************************************/
 242
 243 #define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
 244
 245 /****************************************************************************
 246  Make a filename into unix format.
 247 ****************************************************************************/
 248
 249 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
 250 #define unix_format(fname) string_replace(fname,'\\','/')
 251 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
 252
 253 /****************************************************************************
 254  Make a file into DOS format.
 255 ****************************************************************************/
 256
 257 #define dos_format(fname) string_replace(fname,'/','\\')
 258
 259 /*****************************************************************************
 260  Check to see if we are a DO for this domain
 261 *****************************************************************************/
 262
 263 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC)
 264
 265 #endif /* _SMB_MACROS_H */