source3/include/smb_macros.h

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    SMB parameters and setup
   5    Copyright (C) Andrew Tridgell 1992-1999
   6    Copyright (C) John H Terpstra 1996-1999
   7    Copyright (C) Luke Kenneth Casson Leighton 1996-1999
   8    Copyright (C) Paul Ashton 1998 - 1999
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25 #ifndef _SMB_MACROS_H
  26 #define _SMB_MACROS_H
  27
  28 /* Misc bit macros */
  29 #define BOOLSTR(b) ((b) ? "Yes" : "No")
  30 #define BITSETB(ptr,bit) ((((char *)ptr)[0] & (1<<(bit)))!=0)
  31 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
  32
  33 #define IS_BITS_SET_ALL(var,bit) (((var)&(bit))==(bit))
  34 #define IS_BITS_SET_SOME(var,bit) (((var)&(bit))!=0)
  35 #define IS_BITS_CLR_ALL(var,bit) (((var)&(bit))==0)
  36 #define IS_BITS_CLR_SOME(var,bit) (((var)&(bit))!=(bit))
  37
  38 /* for readability... */
  39 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
  40 #define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
  41 #define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
  42 #define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
  43 #define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
  44
  45 /* zero a structure */
  46 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
  47
  48 /* zero a structure given a pointer to the structure */
  49 #define ZERO_STRUCTP(x) { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); }
  50
  51 /* zero an array - note that sizeof(array) must work - ie. it must not be a
  52    pointer */
  53 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
  54
  55 /* pointer difference macro */
  56 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
  57
  58 /* assert macros */
  59 #define SMB_ASSERT(b) ((b)?(void)0: \
  60         (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
  61                  __FILE__, __LINE__)), smb_panic("assert failed")))
  62 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  63
  64 /* these are useful macros for checking validity of handles */
  65 #define OPEN_FSP(fsp)    ((fsp) && (fsp)->open && !(fsp)->is_directory)
  66 #define OPEN_CONN(conn)    ((conn) && (conn)->open)
  67 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  68 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  69 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
  70
  71 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
  72                                return(ERROR(ERRDOS,ERRbadfid))
  73 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
  74                                return(ERROR(ERRDOS,ERRbadaccess))
  75 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
  76                                return(ERROR(ERRDOS,ERRbadaccess))
  77 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
  78                                return(CACHED_ERROR(fsp))
  79
  80 /* translates a connection number into a service number */
  81 #define SNUM(conn)         ((conn)?(conn)->service:-1)
  82
  83 /* access various service details */
  84 #define SERVICE(snum)      (lp_servicename(snum))
  85 #define PRINTCAP           (lp_printcapname())
  86 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
  87 #define PRINTERNAME(snum)  (lp_printername(snum))
  88 #define CAN_WRITE(conn)    (!conn->read_only)
  89 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
  90 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
  91 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
  92 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
  93 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
  94 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
  95 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
  96 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
  97 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list))
  98 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list))
  99 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list))
 100
 101 /*
 102  * Used by the stat cache code to check if a returned
 103  * stat structure is valid.
 104  */
 105
 106 #define VALID_STAT(st) (st.st_nlink != 0)
 107 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR(st.st_mode))
 108
 109 #define SMBENCRYPT()       (lp_encrypted_passwords())
 110
 111 #ifndef MIN
 112 #define MIN(a,b) ((a)<(b)?(a):(b))
 113 #endif
 114 #ifndef MAX
 115 #define MAX(a,b) ((a)>(b)?(a):(b))
 116 #endif
 117
 118 #ifndef ABS
 119 #define ABS(a) ((a)>0?(a):(-(a)))
 120 #endif
 121
 122 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 123    structures. We cannot define these as actual structures
 124    due to possible differences in structure packing
 125    on different machines/compilers. */
 126
 127 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 128 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 129 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 130 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 131 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 132 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 133 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 134
 135 /* Macro to cache an error in a write_bmpx_struct */
 136 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
 137                             w->wr_discard = True, -1)
 138 /* Macro to test if an error has been cached for this fnum */
 139 #define HAS_CACHED_ERROR(fsp) ((fsp)->open && (fsp)->wbmpx_ptr && \
 140                                 (fsp)->wbmpx_ptr->wr_discard)
 141 /* Macro to turn the cached error into an error packet */
 142 #define CACHED_ERROR(fsp) cached_error_packet(inbuf,outbuf,fsp,__LINE__)
 143
 144 /* these are the datagram types */
 145 #define DGRAM_DIRECT_UNIQUE 0x10
 146
 147 #define ERROR(class,x) error_packet(inbuf,outbuf,class,x,__LINE__)
 148
 149 /* this is how errors are generated */
 150 #define UNIXERROR(defclass,deferror) unix_error_packet(inbuf,outbuf,defclass,deferror,__LINE__)
 151
 152 #define SMB_ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
 153
 154 #endif /* _SMB_MACROS_H */