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