source3/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 3 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, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _SMB_MACROS_H
  24 #define _SMB_MACROS_H
  25
  26 /* Misc bit macros */
  27 #define BOOLSTR(b) ((b) ? "Yes" : "No")
  28 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
  29
  30 /* for readability... */
  31 #define IS_DOS_READONLY(test_mode) (((test_mode) & FILE_ATTRIBUTE_READONLY) != 0)
  32 #define IS_DOS_DIR(test_mode)      (((test_mode) & FILE_ATTRIBUTE_DIRECTORY) != 0)
  33 #define IS_DOS_ARCHIVE(test_mode)  (((test_mode) & FILE_ATTRIBUTE_ARCHIVE) != 0)
  34 #define IS_DOS_SYSTEM(test_mode)   (((test_mode) & FILE_ATTRIBUTE_SYSTEM) != 0)
  35 #define IS_DOS_HIDDEN(test_mode)   (((test_mode) & FILE_ATTRIBUTE_HIDDEN) != 0)
  36
  37 #define SMB_WARN(condition, message) \
  38     ((condition) ? (void)0 : \
  39      DEBUG(0, ("WARNING: %s: %s\n", #condition, message)))
  40
  41 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  42
  43 /* these are useful macros for checking validity of handles */
  44 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  45 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  46 /* you must add the following extern declaration to files using this macro
  47  * (do not add it to the macro as that causes nested extern declaration warnings)
  48  * extern struct current_user current_user;
  49  */
  50 #define FSP_BELONGS_CONN(fsp,conn) do {\
  51                         if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
  52                                 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
  53                         } while(0)
  54
  55 #define CHECK_READ(fsp,req) (((fsp)->fh->fd != -1) && ((fsp)->can_read || \
  56                         ((req->flags2 & FLAGS2_READ_PERMIT_EXECUTE) && \
  57                          (fsp->access_mask & FILE_EXECUTE))))
  58
  59 /* An IOCTL readability check (validating read access
  60  * when the IOCTL code requires it)
  61  * http://social.technet.microsoft.com/wiki/contents/articles/24653.decoding-io-control-codes-ioctl-fsctl-and-deviceiocodes-with-table-of-known-values.aspx
  62  * ). On Windows servers, this is done by the IO manager, which is unaware of
  63  * the "if execute is granted then also grant read" arrangement.
  64  */
  65 #define CHECK_READ_IOCTL(fsp, req) (((fsp)->fh->fd != -1) && ((fsp)->can_read))
  66
  67 #define CHECK_WRITE(fsp) ((fsp)->can_write && ((fsp)->fh->fd != -1))
  68
  69 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
  70                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
  71
  72 /* the service number for the [globals] defaults */
  73 #define GLOBAL_SECTION_SNUM     (-1)
  74 /* translates a connection number into a service number */
  75 #define SNUM(conn)              ((conn)?(conn)->params->service:GLOBAL_SECTION_SNUM)
  76
  77
  78 /* access various service details */
  79 #define CAN_WRITE(conn)    (!conn->read_only)
  80 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
  81 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
  82 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
  83 #define CAN_PRINT(conn)    ((conn) && lp_printable(SNUM(conn)))
  84 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden(SNUM(conn)))
  85 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system(SNUM(conn)))
  86 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive(SNUM(conn)))
  87 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
  88 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
  89 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
  90
  91 /*
  92  * Used by the stat cache code to check if a returned
  93  * stat structure is valid.
  94  */
  95
  96 #define VALID_STAT(st) ((st).st_ex_nlink != 0)
  97 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_ex_mode))
  98 #define SET_STAT_INVALID(st) ((st).st_ex_nlink = 0)
  99
 100 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 101    structures. We cannot define these as actual structures
 102    due to possible differences in structure packing
 103    on different machines/compilers. */
 104
 105 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 106 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 107 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 108 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
 109 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 110 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 111 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 112 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 113
 114 #define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
 115 #define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
 116
 117 #define reply_nterror(req,status) reply_nt_error(req,status,__LINE__,__FILE__)
 118 #define reply_force_doserror(req,eclass,ecode) reply_force_dos_error(req,eclass,ecode,__LINE__,__FILE__)
 119 #define reply_botherror(req,status,eclass,ecode) reply_both_error(req,eclass,ecode,status,__LINE__,__FILE__)
 120
 121 #if 0
 122 /* defined in IDL */
 123 /* these are the datagram types */
 124 #define DGRAM_DIRECT_UNIQUE 0x10
 125 #endif
 126
 127 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
 128
 129 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 130 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 131 #define smb_buf_const(buf) (((const char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 132 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 133
 134 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
 135 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
 136 #define smbreq_bufrem(req, p) (req->buflen - PTR_DIFF(p, req->buf))
 137
 138
 139 /* Note that chain_size must be available as an extern int to this macro. */
 140 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4))
 141
 142 #define smb_len(buf) smb_len_nbt(buf)
 143 #define _smb_setlen(buf, len) _smb_setlen_nbt(buf, len)
 144 #define smb_setlen(buf, len) smb_setlen_nbt(buf, len)
 145
 146 #define smb_len_large(buf) smb_len_tcp(buf)
 147 #define _smb_setlen_large(buf, len) _smb_setlen_tcp(buf, len)
 148
 149 #define ENCRYPTION_REQUIRED(conn) ((conn) ? ((conn)->encrypt_level == SMB_SIGNING_REQUIRED) : false)
 150 #define IS_CONN_ENCRYPTED(conn) ((conn) ? (conn)->encrypted_tid : false)
 151
 152 /****************************************************************************
 153 true if two IPv4 addresses are equal
 154 ****************************************************************************/
 155
 156 #define ip_equal_v4(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 157
 158 /*****************************************************************
 159  splits out the last subkey of a key
 160  *****************************************************************/
 161
 162 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 163         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 164
 165 /****************************************************************************
 166  Return True if the offset is at zero.
 167 ****************************************************************************/
 168
 169 #define dptr_zero(buf) (IVAL(buf,1) == 0)
 170
 171 /*******************************************************************
 172 copy an IP address from one buffer to another
 173 ********************************************************************/
 174
 175 #define putip(dest,src) memcpy(dest,src,4)
 176
 177 /*******************************************************************
 178  Return True if a server has CIFS UNIX capabilities.
 179 ********************************************************************/
 180
 181 #define SERVER_HAS_UNIX_CIFS(c) (smb1cli_conn_capabilities(c->conn) & CAP_UNIX)
 182
 183 /****************************************************************************
 184  Make a filename into unix format.
 185 ****************************************************************************/
 186
 187 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
 188 #define unix_format(fname) string_replace(fname,'\\','/')
 189
 190 /****************************************************************************
 191  Make a file into DOS format.
 192 ****************************************************************************/
 193
 194 #define dos_format(fname) string_replace(fname,'/','\\')
 195
 196 /*****************************************************************************
 197  Check to see if we are a DC for this domain
 198 *****************************************************************************/
 199
 200 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC || lp_server_role() == ROLE_ACTIVE_DIRECTORY_DC)
 201
 202 /*
 203  * If you add any entries to KERBEROS_VERIFY defines, please modify the below expressions
 204  * so they remain accurate.
 205  */
 206 #define USE_KERBEROS_KEYTAB (KERBEROS_VERIFY_SECRETS != lp_kerberos_method())
 207 #define USE_SYSTEM_KEYTAB \
 208     ((KERBEROS_VERIFY_SECRETS_AND_KEYTAB == lp_kerberos_method()) || \
 209      (KERBEROS_VERIFY_SYSTEM_KEYTAB == lp_kerberos_method()))
 210
 211 /*****************************************************************************
 212  Safe allocation macros.
 213 *****************************************************************************/
 214
 215 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
 216 #define SMB_MEMALIGN_ARRAY(type,align,count) (type *)memalign_array(sizeof(type),align,(count))
 217 #define SMB_REALLOC(p,s) Realloc((p),(s),True)  /* Always frees p on error or s == 0 */
 218 #define SMB_REALLOC_KEEP_OLD_ON_ERROR(p,s) Realloc((p),(s),False) /* Never frees p on error or s == 0 */
 219 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count),True) /* Always frees p on error or s == 0 */
 220 #define SMB_REALLOC_ARRAY_KEEP_OLD_ON_ERROR(p,type,count) (type *)realloc_array((p),sizeof(type),(count),False) /* Never frees p on error or s == 0 */
 221 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
 222 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
 223 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
 224
 225 #define TALLOC(ctx, size) talloc_named_const(ctx, size, __location__)
 226 #define TALLOC_ZERO(ctx, size) _talloc_zero(ctx, size, __location__)
 227 #define TALLOC_SIZE(ctx, size) talloc_named_const(ctx, size, __location__)
 228 #define TALLOC_ZERO_SIZE(ctx, size) _talloc_zero(ctx, size, __location__)
 229
 230 #define TALLOC_REALLOC(ctx, ptr, count) _talloc_realloc(ctx, ptr, count, __location__)
 231 #define talloc_destroy(ctx) talloc_free(ctx)
 232 #ifndef TALLOC_FREE
 233 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
 234 #endif
 235
 236 /* only define PARANOID_MALLOC_CHECKER with --enable-developer */
 237
 238 #if defined(DEVELOPER)
 239 #  define PARANOID_MALLOC_CHECKER 1
 240 #endif
 241
 242 #if defined(PARANOID_MALLOC_CHECKER)
 243
 244 /* Get medieval on our ass about malloc.... */
 245
 246 /* Restrictions on malloc/realloc/calloc. */
 247 #ifdef malloc
 248 #undef malloc
 249 #endif
 250 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
 251
 252 #ifdef realloc
 253 #undef realloc
 254 #endif
 255 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
 256
 257 #ifdef calloc
 258 #undef calloc
 259 #endif
 260 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
 261
 262 #ifdef strndup
 263 #undef strndup
 264 #endif
 265 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 266
 267 #ifdef strdup
 268 #undef strdup
 269 #endif
 270 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 271
 272 #define SMB_MALLOC(s) malloc_(s)
 273 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
 274
 275 #define SMB_STRDUP(s) smb_xstrdup(s)
 276 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
 277
 278 #else
 279
 280 /* Regular malloc code. */
 281
 282 #define SMB_MALLOC(s) malloc(s)
 283 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
 284
 285 #define SMB_STRDUP(s) strdup(s)
 286 #define SMB_STRNDUP(s,n) strndup(s,n)
 287
 288 #endif
 289
 290 #define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
 291 do { \
 292         *(array) = ((mem_ctx) != NULL) ? \
 293                 talloc_realloc(mem_ctx, (*(array)), type, (*(num))+1) : \
 294                 SMB_REALLOC_ARRAY((*(array)), type, (*(num))+1); \
 295         SMB_ASSERT((*(array)) != NULL); \
 296         (*(array))[*(num)] = (elem); \
 297         (*(num)) += 1; \
 298 } while (0)
 299
 300 #define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
 301         add_to_large_array((mem_ctx), sizeof(type), &(elem), (void *)(array), (num), (size));
 302
 303 #define trans_oob(bufsize, offset, length) \
 304         smb_buffer_oob(bufsize, offset, length)
 305
 306 #endif /* _SMB_MACROS_H */