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 BITSETB(ptr,bit) ((((char *)ptr)[0] & (1<<(bit)))!=0)
  30 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
  31
  32 /* for readability... */
  33 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
  34 #define IS_DOS_DIR(test_mode)      (((test_mode) & aDIR) != 0)
  35 #define IS_DOS_ARCHIVE(test_mode)  (((test_mode) & aARCH) != 0)
  36 #define IS_DOS_SYSTEM(test_mode)   (((test_mode) & aSYSTEM) != 0)
  37 #define IS_DOS_HIDDEN(test_mode)   (((test_mode) & aHIDDEN) != 0)
  38
  39 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
  40
  41 /**
  42  * Free memory if the pointer and zero the pointer.
  43  *
  44  * @note You are explicitly allowed to pass NULL pointers -- they will
  45  * always be ignored.
  46  **/
  47 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
  48 #endif
  49
  50 /* zero a structure */
  51 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
  52
  53 /* zero a structure given a pointer to the structure */
  54 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
  55
  56 /* zero a structure given a pointer to the structure - no zero check */
  57 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
  58
  59 /* zero an array - note that sizeof(array) must work - ie. it must not be a
  60    pointer */
  61 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
  62
  63 /* pointer difference macro */
  64 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
  65
  66 /* work out how many elements there are in a static array */
  67 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
  68
  69 /* assert macros */
  70 #define SMB_ASSERT(b) do { if (!(b)) { \
  71         DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
  72         smb_panic("assert failed"); }} while (0)
  73
  74 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  75
  76 /* the service number for the [globals] defaults */
  77 #define GLOBAL_SECTION_SNUM     (-1)
  78 /* translates a connection number into a service number */
  79 #define SNUM(conn)              ((conn)?(conn)->service:GLOBAL_SECTION_SNUM)
  80
  81
  82 /* access various service details */
  83 #define SERVICE(snum)      (lp_servicename(snum))
  84 #define PRINTERNAME_NOTUSED(snum)  (lp_printername(snum))
  85 #define CAN_WRITE(conn)    (!conn->read_only)
  86 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
  87 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
  88
  89 /*
  90  * Used by the stat cache code to check if a returned
  91  * stat structure is valid.
  92  */
  93
  94 #define VALID_STAT(st) ((st).st_nlink != 0)
  95 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_mode))
  96
  97 #ifndef MIN
  98 #define MIN(a,b) ((a)<(b)?(a):(b))
  99 #endif
 100 #ifndef MAX
 101 #define MAX(a,b) ((a)>(b)?(a):(b))
 102 #endif
 103
 104 #ifndef ABS
 105 #define ABS(a) ((a)>0?(a):(-(a)))
 106 #endif
 107
 108 /* these are the datagram types */
 109 #define DGRAM_DIRECT_UNIQUE 0x10
 110
 111
 112 /* REWRITE TODO: remove these smb_xxx macros */
 113 #define smb_buf(buf) (((char *)(buf)) + MIN_SMB_SIZE + CVAL(buf,HDR_WCT+4)*2)
 114
 115 #define smb_len(buf) (PVAL(buf,3)|(PVAL(buf,2)<<8)|(PVAL(buf,1)<<16))
 116 #define _smb_setlen(buf,len) do {(buf)[0] = 0; (buf)[1] = ((len)&0x10000)>>16; \
 117         (buf)[2] = ((len)&0xFF00)>>8; (buf)[3] = (len)&0xFF;} while (0)
 118
 119 /*******************************************************************
 120 find the difference in milliseconds between two struct timeval
 121 values
 122 ********************************************************************/
 123
 124 #define TvalDiff(tvalold,tvalnew) \
 125   (((tvalnew)->tv_sec - (tvalold)->tv_sec)*1000 +  \
 126          ((int)(tvalnew)->tv_usec - (int)(tvalold)->tv_usec)/1000)
 127
 128 /****************************************************************************
 129 true if two IP addresses are equal
 130 ****************************************************************************/
 131
 132 #define ip_equal(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 133
 134 /*****************************************************************
 135  splits out the last subkey of a key
 136  *****************************************************************/
 137
 138 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 139         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 140
 141 /****************************************************************************
 142  Used by dptr_zero.
 143 ****************************************************************************/
 144
 145 #define DPTR_MASK ((uint32_t)(((uint32_t)1)<<31))
 146
 147 /****************************************************************************
 148  Return True if the offset is at zero.
 149 ****************************************************************************/
 150
 151 #define dptr_zero(buf) ((IVAL(buf,1)&~DPTR_MASK) == 0)
 152
 153 /*******************************************************************
 154 copy an IP address from one buffer to another
 155 ********************************************************************/
 156
 157 #define putip(dest,src) memcpy(dest,src,4)
 158
 159 /*******************************************************************
 160  Return True if a server has CIFS UNIX capabilities.
 161 ********************************************************************/
 162
 163 #define SERVER_HAS_UNIX_CIFS(c) (cli_state_has_unix_cifs(c))
 164
 165 /****************************************************************************
 166  Make a filename into unix format.
 167 ****************************************************************************/
 168
 169 #define unix_format(fname) string_replace(fname,'\\','/')
 170 #define unix_format_w(fname) string_replace_w(fname, UCS2_CHAR('\\'), UCS2_CHAR('/'))
 171
 172 /****************************************************************************
 173  Make a file into DOS format.
 174 ****************************************************************************/
 175
 176 #define dos_format(fname) string_replace(fname,'/','\\')
 177
 178 #endif /* _SMB_MACROS_H */