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 /* memory-allocation-helpers (idea and names from glib) */
  46 #define g_new(type, count) \
  47         ((type *) malloc(sizeof(type) * (count)))
  48 #define g_new0(type, count) \
  49         ((type *) calloc((count), sizeof(type)))
  50 #define g_renew(type, mem, count) \
  51         ((type *) Realloc(mem, sizeof(type) * (count)))
  52
  53 /* zero a structure */
  54 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
  55
  56 /* zero a structure given a pointer to the structure */
  57 #define ZERO_STRUCTP(x) { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); }
  58
  59 /* zero a structure given a pointer to the structure - no zero check */
  60 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
  61
  62 /* zero an array - note that sizeof(array) must work - ie. it must not be a
  63    pointer */
  64 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
  65
  66 /* pointer difference macro */
  67 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
  68
  69 /* assert macros */
  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 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  74
  75 /* these are useful macros for checking validity of handles */
  76 #define OPEN_FSP(fsp)    ((fsp) && !(fsp)->is_directory)
  77 #define OPEN_CONN(conn)    ((conn) && (conn)->open)
  78 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  79 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  80 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
  81
  82 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
  83                                return(ERROR(ERRDOS,ERRbadfid)); \
  84                             else if((fsp)->fd == -1) \
  85                                return(ERROR(ERRDOS,ERRbadaccess))
  86
  87 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
  88                                return(ERROR(ERRDOS,ERRbadaccess))
  89 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
  90                                return(ERROR(ERRDOS,ERRbadaccess))
  91 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
  92                                return(CACHED_ERROR(fsp))
  93
  94 /* translates a connection number into a service number */
  95 #define SNUM(conn)         ((conn)?(conn)->service:-1)
  96
  97 /* access various service details */
  98 #define SERVICE(snum)      (lp_servicename(snum))
  99 #define PRINTCAP           (lp_printcapname())
 100 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
 101 #define PRINTERNAME(snum)  (lp_printername(snum))
 102 #define CAN_WRITE(conn)    (!conn->read_only)
 103 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
 104 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
 105 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
 106 #define CAN_SETDIR(snum)   (!lp_no_set_dir(snum))
 107 #define CAN_PRINT(conn)    ((conn) && lp_print_ok((conn)->service))
 108 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden((conn)->service))
 109 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system((conn)->service))
 110 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive((conn)->service))
 111 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list))
 112 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list))
 113 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list))
 114
 115 /*
 116  * Used by the stat cache code to check if a returned
 117  * stat structure is valid.
 118  */
 119
 120 #define VALID_STAT(st) (st.st_nlink != 0)
 121 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR(st.st_mode))
 122
 123 #define SMBENCRYPT()       (lp_encrypted_passwords())
 124
 125 #ifndef MIN
 126 #define MIN(a,b) ((a)<(b)?(a):(b))
 127 #endif
 128 #ifndef MAX
 129 #define MAX(a,b) ((a)>(b)?(a):(b))
 130 #endif
 131
 132 #ifndef ABS
 133 #define ABS(a) ((a)>0?(a):(-(a)))
 134 #endif
 135
 136 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 137    structures. We cannot define these as actual structures
 138    due to possible differences in structure packing
 139    on different machines/compilers. */
 140
 141 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 142 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 143 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 144 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 145 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 146 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 147 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 148
 149 /* Macro to cache an error in a write_bmpx_struct */
 150 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
 151                             w->wr_discard = True, -1)
 152 /* Macro to test if an error has been cached for this fnum */
 153 #define HAS_CACHED_ERROR(fsp) ((fsp)->wbmpx_ptr && \
 154                                 (fsp)->wbmpx_ptr->wr_discard)
 155 /* Macro to turn the cached error into an error packet */
 156 #define CACHED_ERROR(fsp) cached_error_packet(inbuf,outbuf,fsp,__LINE__)
 157
 158 /* these are the datagram types */
 159 #define DGRAM_DIRECT_UNIQUE 0x10
 160
 161 #define ERROR(class,x) error_packet(inbuf,outbuf,class,x,__LINE__)
 162
 163 /* this is how errors are generated */
 164 #define UNIXERROR(defclass,deferror) unix_error_packet(inbuf,outbuf,defclass,deferror,__LINE__)
 165
 166 #define SMB_ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
 167
 168 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 169 #define smb_buf(buf) (buf + smb_size + CVAL(buf,smb_wct)*2)
 170 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 171
 172 /* Note that chain_size must be available as an extern int to this macro. */
 173 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4) + chain_size)
 174
 175 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|((PVAL(buf,1)&1)<<16))
 176 #define _smb_setlen(buf,len) buf[0] = 0; buf[1] = (len&0x10000)>>16; \
 177         buf[2] = (len&0xFF00)>>8; buf[3] = len&0xFF;
 178
 179 /*******************************************************************
 180 find the difference in milliseconds between two struct timeval
 181 values
 182 ********************************************************************/
 183
 184 #define TvalDiff(tvalold,tvalnew) \
 185   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
 186          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
 187
 188 /****************************************************************************
 189 true if two IP addresses are equal
 190 ****************************************************************************/
 191
 192 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 193
 194 /*****************************************************************
 195  splits out the last subkey of a key
 196  *****************************************************************/
 197
 198 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 199         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 200
 201 /****************************************************************************
 202  Used by dptr_zero.
 203 ****************************************************************************/
 204
 205 #define DPTR_MASK ((uint32)(((uint32)1)<<31))
 206
 207 /****************************************************************************
 208  Return True if the offset is at zero.
 209 ****************************************************************************/
 210
 211 #define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
 212
 213 /*******************************************************************
 214 copy an IP address from one buffer to another
 215 ********************************************************************/
 216
 217 #define putip(dest,src) memcpy(dest,src,4)
 218
 219 /****************************************************************************
 220  Make a filename into unix format.
 221 ****************************************************************************/
 222
 223 #define unix_format(fname) string_replace(fname,'\\','/')
 224
 225 /****************************************************************************
 226  Make a file into DOS format.
 227 ****************************************************************************/
 228
 229 #define dos_format(fname) string_replace(fname,'/','\\')
 230
 231
 232 #endif /* _SMB_MACROS_H */