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_WARN(condition, message) \
  80     ((condition) ? (void)0 : \
  81      DEBUG(0, ("WARNING: %s: %s\n", #condition, message)))
  82
  83 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  84
  85 /* these are useful macros for checking validity of handles */
  86 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  87 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  88 /* you must add the following extern declaration to files using this macro
  89  * (do not add it to the macro as that causes nested extern declaration warnings)
  90  * extern struct current_user current_user;
  91  */
  92 #define FSP_BELONGS_CONN(fsp,conn) do {\
  93                         if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
  94                                 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
  95                         } while(0)
  96
  97 #define FNUM_OK(fsp,c) ((fsp) && !(fsp)->is_directory && (c)==(fsp)->conn && current_user.vuid==(fsp)->vuid)
  98
  99 /* you must add the following extern declaration to files using this macro
 100  * (do not add it to the macro as that causes nested extern declaration warnings)
 101  * extern struct current_user current_user;
 102  */
 103 #define CHECK_FSP(fsp,conn) do {\
 104                         if (!(fsp) || !(conn)) \
 105                                 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
 106                         else if (((conn) != (fsp)->conn) || current_user.vuid != (fsp)->vuid) \
 107                                 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
 108                         else if ((fsp)->is_directory) \
 109                                 return ERROR_NT(NT_STATUS_INVALID_DEVICE_REQUEST); \
 110                         else if ((fsp)->fh->fd == -1) \
 111                                 return ERROR_NT(NT_STATUS_ACCESS_DENIED); \
 112                         (fsp)->num_smb_operations++;\
 113                         } while(0)
 114
 115 #define CHECK_READ(fsp,inbuf) (((fsp)->fh->fd != -1) && ((fsp)->can_read || \
 116                         ((SVAL((inbuf),smb_flg2) & FLAGS2_READ_PERMIT_EXECUTE) && \
 117                          (fsp->access_mask & FILE_EXECUTE))))
 118
 119 #define CHECK_WRITE(fsp) ((fsp)->can_write && ((fsp)->fh->fd != -1))
 120
 121 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
 122                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
 123
 124 /* the service number for the [globals] defaults */
 125 #define GLOBAL_SECTION_SNUM     (-1)
 126 /* translates a connection number into a service number */
 127 #define SNUM(conn)              ((conn)?(conn)->params->service:GLOBAL_SECTION_SNUM)
 128
 129
 130 /* access various service details */
 131 #define SERVICE(snum)      (lp_servicename(snum))
 132 #define PRINTERNAME(snum)  (lp_printername(snum))
 133 #define CAN_WRITE(conn)    (!conn->read_only)
 134 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
 135 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
 136 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
 137 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
 138 #define CAN_PRINT(conn)    ((conn) && lp_print_ok(SNUM(conn)))
 139 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden(SNUM(conn)))
 140 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system(SNUM(conn)))
 141 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive(SNUM(conn)))
 142 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
 143 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
 144 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
 145
 146 /*
 147  * Used by the stat cache code to check if a returned
 148  * stat structure is valid.
 149  */
 150
 151 #define VALID_STAT(st) ((st).st_nlink != 0)
 152 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
 153 #define SET_STAT_INVALID(st) ((st).st_nlink = 0)
 154
 155 #ifndef MIN
 156 #define MIN(a,b) ((a)<(b)?(a):(b))
 157 #endif
 158 #ifndef MAX
 159 #define MAX(a,b) ((a)>(b)?(a):(b))
 160 #endif
 161
 162 #ifndef ABS
 163 #define ABS(a) ((a)>0?(a):(-(a)))
 164 #endif
 165
 166 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 167    structures. We cannot define these as actual structures
 168    due to possible differences in structure packing
 169    on different machines/compilers. */
 170
 171 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 172 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 173 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 174 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
 175 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 176 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 177 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 178 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 179
 180 /* Macro to test if an error has been cached for this fnum */
 181 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
 182                 (fsp)->wbmpx_ptr->wr_discard)
 183 /* Macro to turn the cached error into an error packet */
 184 #define CACHED_ERROR(fsp) cached_error_packet(outbuf,fsp,__LINE__,__FILE__)
 185
 186 #define ERROR_DOS(class,code) error_packet(outbuf,class,code,NT_STATUS_OK,__LINE__,__FILE__)
 187 #define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
 188 #define ERROR_FORCE_NT(status) error_packet(outbuf,-1,-1,status,__LINE__,__FILE__)
 189 #define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
 190
 191 /* this is how errors are generated */
 192 #define UNIXERROR(defclass,deferror) unix_error_packet(outbuf,defclass,deferror,NT_STATUS_OK,__LINE__,__FILE__)
 193
 194 /* these are the datagram types */
 195 #define DGRAM_DIRECT_UNIQUE 0x10
 196
 197 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
 198
 199 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 200 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 201 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 202
 203 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
 204 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
 205
 206 /* Note that chain_size must be available as an extern int to this macro. */
 207 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
 208
 209 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
 210 #define _smb_setlen(buf,len) do { buf[0] = 0; buf[1] = (len&0x10000)>>16; \
 211         buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF; } while (0)
 212
 213 /*******************************************************************
 214 find the difference in milliseconds between two struct timeval
 215 values
 216 ********************************************************************/
 217
 218 #define TvalDiff(tvalold,tvalnew) \
 219   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
 220          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
 221
 222 /****************************************************************************
 223 true if two IP addresses are equal
 224 ****************************************************************************/
 225
 226 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 227 #define ip_service_equal(ip1,ip2) ( ((ip1).ip.s_addr == (ip2).ip.s_addr) && ((ip1).port == (ip2).port) )
 228
 229 /*****************************************************************
 230  splits out the last subkey of a key
 231  *****************************************************************/
 232
 233 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 234         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 235
 236 /****************************************************************************
 237  Return True if the offset is at zero.
 238 ****************************************************************************/
 239
 240 #define dptr_zero(buf) (IVAL(buf,1) == 0)
 241
 242 /*******************************************************************
 243 copy an IP address from one buffer to another
 244 ********************************************************************/
 245
 246 #define putip(dest,src) memcpy(dest,src,4)
 247
 248 /*******************************************************************
 249  Return True if a server has CIFS UNIX capabilities.
 250 ********************************************************************/
 251
 252 #define SERVER_HAS_UNIX_CIFS(c) ((c)->capabilities & CAP_UNIX)
 253
 254 /****************************************************************************
 255  Make a filename into unix format.
 256 ****************************************************************************/
 257
 258 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
 259 #define unix_format(fname) string_replace(fname,'\\','/')
 260 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
 261
 262 /****************************************************************************
 263  Make a file into DOS format.
 264 ****************************************************************************/
 265
 266 #define dos_format(fname) string_replace(fname,'/','\\')
 267
 268 /*****************************************************************************
 269  Check to see if we are a DC for this domain
 270 *****************************************************************************/
 271
 272 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC)
 273
 274 /*****************************************************************************
 275  Safe allocation macros.
 276 *****************************************************************************/
 277
 278 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
 279 #define SMB_REALLOC(p,s) Realloc((p),(s),True)  /* Always frees p on error or s == 0 */
 280 #define SMB_REALLOC_KEEP_OLD_ON_ERROR(p,s) Realloc((p),(s),False) /* Never frees p on error or s == 0 */
 281 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count),True) /* Always frees p on error or s == 0 */
 282 #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 */
 283 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
 284 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
 285 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
 286
 287 /* limiting size of ipc replies */
 288 #define SMB_REALLOC_LIMIT(ptr,size) (char *)SMB_REALLOC(ptr,MAX((size),4*1024))
 289
 290 /* The new talloc is paranoid malloc checker safe. */
 291
 292 #define TALLOC(ctx, size) talloc_named_const(ctx, size, __location__)
 293 #define TALLOC_P(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
 294 #define TALLOC_ARRAY(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
 295 #define TALLOC_MEMDUP(ctx, ptr, size) _talloc_memdup(ctx, ptr, size, __location__)
 296 #define TALLOC_ZERO(ctx, size) _talloc_zero(ctx, size, __location__)
 297 #define TALLOC_ZERO_P(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
 298 #define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
 299 #define TALLOC_REALLOC(ctx, ptr, count) _talloc_realloc(ctx, ptr, count, __location__)
 300 #define TALLOC_REALLOC_ARRAY(ctx, ptr, type, count) (type *)_talloc_realloc_array(ctx, ptr, sizeof(type), count, #type)
 301 #define talloc_destroy(ctx) talloc_free(ctx)
 302 #define TALLOC_FREE(ctx) do { if ((ctx) != NULL) {talloc_free(ctx); ctx=NULL;} } while(0)
 303
 304 /* only define PARANOID_MALLOC_CHECKER with --enable-developer and not compiling
 305    the smbmount utils */
 306
 307 #if defined(DEVELOPER) && !defined(SMBMOUNT_MALLOC)
 308 #  define PARANOID_MALLOC_CHECKER 1
 309 #endif
 310
 311 #if defined(PARANOID_MALLOC_CHECKER)
 312
 313 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem_((ps),sizeof(type),(count))
 314 #define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem_((ps),(size),1)
 315
 316 /* Get medieval on our ass about malloc.... */
 317
 318 /* Restrictions on malloc/realloc/calloc. */
 319 #ifdef malloc
 320 #undef malloc
 321 #endif
 322 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
 323
 324 #ifdef realloc
 325 #undef realloc
 326 #endif
 327 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
 328
 329 #ifdef calloc
 330 #undef calloc
 331 #endif
 332 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
 333
 334 #ifdef strndup
 335 #undef strndup
 336 #endif
 337 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 338
 339 #ifdef strdup
 340 #undef strdup
 341 #endif
 342 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 343
 344 #define SMB_MALLOC(s) malloc_(s)
 345 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
 346
 347 #define SMB_STRDUP(s) smb_xstrdup(s)
 348 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
 349
 350 #else
 351
 352 #define _STRING_LINE_(s)    #s
 353 #define _STRING_LINE2_(s)   _STRING_LINE_(s)
 354 #define __LINESTR__       _STRING_LINE2_(__LINE__)
 355 #define __location__ __FILE__ ":" __LINESTR__
 356
 357 #define PRS_ALLOC_MEM(ps, type, count) (type *)prs_alloc_mem((ps),sizeof(type),(count))
 358 #define PRS_ALLOC_MEM_VOID(ps, size) prs_alloc_mem((ps),(size),1)
 359
 360 /* Regular malloc code. */
 361
 362 #define SMB_MALLOC(s) malloc(s)
 363 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
 364
 365 #define SMB_STRDUP(s) strdup(s)
 366 #define SMB_STRNDUP(s,n) strndup(s,n)
 367
 368 #endif
 369
 370 #define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
 371 do { \
 372         *(array) = ((mem_ctx) != NULL) ? \
 373                 TALLOC_REALLOC_ARRAY(mem_ctx, (*(array)), type, (*(num))+1) : \
 374                 SMB_REALLOC_ARRAY((*(array)), type, (*(num))+1); \
 375         SMB_ASSERT((*(array)) != NULL); \
 376         (*(array))[*(num)] = (elem); \
 377         (*(num)) += 1; \
 378 } while (0)
 379
 380 #define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
 381         add_to_large_array((mem_ctx), sizeof(type), &(elem), (void *)(array), (num), (size));
 382
 383 #endif /* _SMB_MACROS_H */