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 BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
  30
  31 /* for readability... */
  32 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
  33 #define IS_DOS_DIR(test_mode)      (((test_mode) & aDIR) != 0)
  34 #define IS_DOS_ARCHIVE(test_mode)  (((test_mode) & aARCH) != 0)
  35 #define IS_DOS_SYSTEM(test_mode)   (((test_mode) & aSYSTEM) != 0)
  36 #define IS_DOS_HIDDEN(test_mode)   (((test_mode) & aHIDDEN) != 0)
  37
  38 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
  39
  40 /**
  41  * Free memory if the pointer and zero the pointer.
  42  *
  43  * @note You are explicitly allowed to pass NULL pointers -- they will
  44  * always be ignored.
  45  **/
  46 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
  47 #endif
  48
  49 /* zero a structure */
  50 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
  51
  52 /* zero a structure given a pointer to the structure */
  53 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
  54
  55 /* zero a structure given a pointer to the structure - no zero check */
  56 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
  57
  58 /* zero an array - note that sizeof(array) must work - ie. it must not be a
  59    pointer */
  60 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
  61
  62 /* pointer difference macro */
  63 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
  64
  65 /* work out how many elements there are in a static array */
  66 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
  67
  68 /* assert macros */
  69 #ifdef DEVELOPER
  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 #else
  74 /* redefine the assert macro for non-developer builds */
  75 #define SMB_ASSERT(b) ( (b) ? (void)0 : \
  76         (DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)))
  77 #endif
  78
  79 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  80
  81 /* these are useful macros for checking validity of handles */
  82 #define OPEN_FSP(fsp)    ((fsp) && !(fsp)->is_directory)
  83 #define OPEN_CONN(conn)    ((conn) && (conn)->open)
  84 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  85 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  86 #define FSP_BELONGS_CONN(fsp,conn) do {\
  87                         extern struct current_user current_user;\
  88                         if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
  89                                 return(ERROR_DOS(ERRDOS,ERRbadfid));\
  90                         } while(0)
  91
  92 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
  93
  94 #define CHECK_FSP(fsp,conn) do {\
  95                         extern struct current_user current_user;\
  96                         if (!FNUM_OK(fsp,conn)) \
  97                                 return(ERROR_DOS(ERRDOS,ERRbadfid)); \
  98                         else if((fsp)->fd == -1) \
  99                                 return(ERROR_DOS(ERRDOS,ERRbadaccess));\
 100                         } while(0)
 101
 102 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
 103                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
 104 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
 105                                 return(ERROR_DOS(ERRDOS,ERRbadaccess))
 106
 107 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
 108                                 return(CACHED_ERROR(fsp))
 109
 110 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
 111                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
 112
 113 /* the service number for the [globals] defaults */
 114 #define GLOBAL_SECTION_SNUM     (-1)
 115 /* translates a connection number into a service number */
 116 #define SNUM(conn)              ((conn)?(conn)->service:GLOBAL_SECTION_SNUM)
 117
 118
 119 /* access various service details */
 120 #define SERVICE(snum)      (lp_servicename(snum))
 121 #define PRINTERNAME(snum)  (lp_printername(snum))
 122 #define CAN_WRITE(conn)    (!conn->read_only)
 123 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
 124 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
 125 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
 126 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
 127 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
 128 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
 129 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
 130 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
 131 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
 132 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
 133 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
 134
 135 /*
 136  * Used by the stat cache code to check if a returned
 137  * stat structure is valid.
 138  */
 139
 140 #define VALID_STAT(st) ((st).st_nlink != 0)
 141 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
 142
 143 #ifndef MIN
 144 #define MIN(a,b) ((a)<(b)?(a):(b))
 145 #endif
 146 #ifndef MAX
 147 #define MAX(a,b) ((a)>(b)?(a):(b))
 148 #endif
 149
 150 #ifndef ABS
 151 #define ABS(a) ((a)>0?(a):(-(a)))
 152 #endif
 153
 154 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 155    structures. We cannot define these as actual structures
 156    due to possible differences in structure packing
 157    on different machines/compilers. */
 158
 159 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 160 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 161 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 162 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
 163 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 164 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 165 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 166 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 167
 168 /* Macro to cache an error in a write_bmpx_struct */
 169 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
 170                 w->wr_discard = True, -1)
 171 /* Macro to test if an error has been cached for this fnum */
 172 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
 173                 (fsp)->wbmpx_ptr->wr_discard)
 174 /* Macro to turn the cached error into an error packet */
 175 #define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
 176
 177 /* these are the datagram types */
 178 #define DGRAM_DIRECT_UNIQUE 0x10
 179
 180 #define ERROR_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,False,__LINE__,__FILE__)
 181 #define ERROR_FORCE_DOS(class,code) error_packet(outbuf,NT_STATUS_OK,class,code,True,__LINE__,__FILE__)
 182 #define ERROR_NT(status) error_packet(outbuf,status,0,0,False,__LINE__,__FILE__)
 183 #define ERROR_BOTH(status,class,code) error_packet(outbuf,status,class,code,False,__LINE__,__FILE__)
 184
 185 /* this is how errors are generated */
 186 #define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,__LINE__,__FILE__)
 187
 188 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
 189
 190 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 191 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 192 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 193
 194 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
 195 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
 196
 197 /* Note that chain_size must be available as an extern int to this macro. */
 198 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
 199
 200 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
 201 #define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = (len&0x10000)>>16; \
 202         buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF; } while (0)
 203
 204 /*******************************************************************
 205 find the difference in milliseconds between two struct timeval
 206 values
 207 ********************************************************************/
 208
 209 #define TvalDiff(tvalold,tvalnew) \
 210   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
 211          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
 212
 213 /****************************************************************************
 214 true if two IP addresses are equal
 215 ****************************************************************************/
 216
 217 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 218 #define ip_service_equal(ip1,ip2) ( ((ip1).ip.s_addr == (ip2).ip.s_addr) && ((ip1).port == (ip2).port) )
 219
 220 /*****************************************************************
 221  splits out the last subkey of a key
 222  *****************************************************************/
 223
 224 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 225         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 226
 227 /****************************************************************************
 228  Used by dptr_zero.
 229 ****************************************************************************/
 230
 231 #define DPTR_MASK ((uint32)(((uint32)1)<<31))
 232
 233 /****************************************************************************
 234  Return True if the offset is at zero.
 235 ****************************************************************************/
 236
 237 #define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
 238
 239 /*******************************************************************
 240 copy an IP address from one buffer to another
 241 ********************************************************************/
 242
 243 #define putip(dest,src) memcpy(dest,src,4)
 244
 245 /*******************************************************************
 246  Return True if a server has CIFS UNIX capabilities.
 247 ********************************************************************/
 248
 249 #define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
 250
 251 /****************************************************************************
 252  Make a filename into unix format.
 253 ****************************************************************************/
 254
 255 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
 256 #define unix_format(fname) string_replace(fname,'\\','/')
 257 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
 258
 259 /****************************************************************************
 260  Make a file into DOS format.
 261 ****************************************************************************/
 262
 263 #define dos_format(fname) string_replace(fname,'/','\\')
 264
 265 /*****************************************************************************
 266  Check to see if we are a DO for this domain
 267 *****************************************************************************/
 268
 269 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC)
 270
 271 /*****************************************************************************
 272  Safe allocation macros.
 273 *****************************************************************************/
 274
 275 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
 276 #define SMB_REALLOC(p,s) Realloc((p),(s))
 277 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count))
 278 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
 279 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
 280 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
 281
 282 /* limiting size of ipc replies */
 283 #define SMB_REALLOC_LIMIT(ptr,size) SMB_REALLOC(ptr,MAX((size),4*1024))
 284
 285 /* #define PARANOID_MALLOC_CHECKER 1 */
 286
 287 #if defined(PARANOID_MALLOC_CHECKER)
 288
 289 #define TALLOC(ctx, size) talloc_((ctx),(size))
 290 #define TALLOC_P(ctx, type) (type *)talloc_((ctx),sizeof(type))
 291 #define TALLOC_ARRAY(ctx, type, count) (type *)talloc_array_((ctx),sizeof(type),(count))
 292 #define TALLOC_MEMDUP(ctx, ptr, size) talloc_memdup_((ctx),(ptr),(size))
 293 #define TALLOC_ZERO(ctx, size) talloc_zero_((ctx),(size))
 294 #define TALLOC_ZERO_P(ctx, type) (type *)talloc_zero_((ctx),sizeof(type))
 295 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)talloc_zero_array_((ctx),sizeof(type),(count))
 296 #define TALLOC_REALLOC(ctx, ptr, count) talloc_realloc_((ctx),(ptr),(count))
 297 #define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)talloc_realloc_array_((ctx),(ptr),sizeof(type),(count))
 298
 299 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
 300
 301 /* Get medieval on our ass about malloc.... */
 302
 303 /* Restrictions on malloc/realloc/calloc. */
 304 #ifdef malloc
 305 #undef malloc
 306 #endif
 307 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
 308
 309 #ifdef realloc
 310 #undef realloc
 311 #endif
 312 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
 313
 314 #ifdef calloc
 315 #undef calloc
 316 #endif
 317 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
 318
 319 #ifdef strndup
 320 #undef strndup
 321 #endif
 322 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 323
 324 #ifdef strdup
 325 #undef strdup
 326 #endif
 327 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 328
 329 #define SMB_MALLOC(s) malloc_(s)
 330 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
 331
 332 #define SMB_STRDUP(s) smb_xstrdup(s)
 333 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
 334
 335 #else
 336
 337 #define TALLOC(ctx, size) talloc((ctx),(size))
 338 #define TALLOC_P(ctx, type) (type *)talloc((ctx),sizeof(type))
 339 #define TALLOC_ARRAY(ctx, type, count) (type *)talloc_array((ctx),sizeof(type),(count))
 340 #define TALLOC_MEMDUP(ctx, ptr, size) talloc_memdup((ctx),(ptr),(size))
 341 #define TALLOC_ZERO(ctx, size) talloc_zero((ctx),(size))
 342 #define TALLOC_ZERO_P(ctx, type) (type *)talloc_zero((ctx),sizeof(type))
 343 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)talloc_zero_array((ctx),sizeof(type),(count))
 344 #define TALLOC_REALLOC(ctx, ptr, count) talloc_realloc((ctx),(ptr),(count))
 345 #define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)talloc_realloc_array((ctx),(ptr),sizeof(type),(count))
 346
 347 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
 348
 349 /* Regular malloc code. */
 350
 351 #define SMB_MALLOC(s) malloc(s)
 352 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
 353
 354 #define SMB_STRDUP(s) strdup(s)
 355 #define SMB_STRNDUP(s,n) strndup(s,n)
 356
 357 #endif
 358
 359 #endif /* _SMB_MACROS_H */