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