2 Unix SMB/Netbios implementation.
4 SMB parameters and setup
5 Copyright (C) Andrew Tridgell 1992-1998
6 Copyright (C) John H Terpstra 1996-1998
7 Copyright (C) Luke Kenneth Casson Leighton 1996-1998
8 Copyright (C) Paul Ashton 1998
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.
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.
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.
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)
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)
37 /* for readability... */
38 #define IS_DOS_READONLY(test_mode) (((test_mode) & aRONLY) != 0)
39 #define IS_DOS_DIR(test_mode) (((test_mode) & aDIR) != 0)
40 #define IS_DOS_ARCHIVE(test_mode) (((test_mode) & aARCH) != 0)
41 #define IS_DOS_SYSTEM(test_mode) (((test_mode) & aSYSTEM) != 0)
42 #define IS_DOS_HIDDEN(test_mode) (((test_mode) & aHIDDEN) != 0)
44 /* zero a structure */
45 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
47 /* zero a structure given a pointer to the structure */
48 #define ZERO_STRUCTP(x) { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); }
50 /* zero an array - note that sizeof(array) must work - ie. it must not be a
52 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
54 /* pointer difference macro */
55 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
58 #define SMB_ASSERT(b) ((b)?(void)0: \
59 (DEBUG(0,("PANIC: assert failed at %s(%d)\n", \
60 __FILE__, __LINE__)), smb_panic("assert failed")))
61 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
63 /* these are useful macros for checking validity of handles */
64 #define OPEN_FSP(fsp) ((fsp) && (fsp)->open && !(fsp)->is_directory)
65 #define OPEN_CONN(conn) ((conn) && (conn)->open)
66 #define IS_IPC(conn) ((conn) && (conn)->ipc)
67 #define IS_PRINT(conn) ((conn) && (conn)->printer)
68 #define FNUM_OK(fsp,c) (OPEN_FSP(fsp) && (c)==(fsp)->conn)
70 #define CHECK_FSP(fsp,conn) if (!FNUM_OK(fsp,conn)) \
71 return(ERROR(ERRDOS,ERRbadfid))
72 #define CHECK_READ(fsp) if (!(fsp)->can_read) \
73 return(ERROR(ERRDOS,ERRbadaccess))
74 #define CHECK_WRITE(fsp) if (!(fsp)->can_write) \
75 return(ERROR(ERRDOS,ERRbadaccess))
76 #define CHECK_ERROR(fsp) if (HAS_CACHED_ERROR(fsp)) \
77 return(CACHED_ERROR(fsp))
79 /* translates a connection number into a service number */
80 #define SNUM(conn) ((conn)?(conn)->service:-1)
82 /* access various service details */
83 #define SERVICE(snum) (lp_servicename(snum))
84 #define PRINTCAP (lp_printcapname())
85 #define PRINTCOMMAND(snum) (lp_printcommand(snum))
86 #define PRINTERNAME(snum) (lp_printername(snum))
87 #define CAN_WRITE(conn) (!conn->read_only)
88 #define VALID_SNUM(snum) (lp_snum_ok(snum))
89 #define GUEST_OK(snum) (VALID_SNUM(snum) && lp_guest_ok(snum))
90 #define GUEST_ONLY(snum) (VALID_SNUM(snum) && lp_guest_only(snum))
91 #define CAN_SETDIR(snum) (!lp_no_set_dir(snum))
92 #define CAN_PRINT(conn) ((conn) && lp_print_ok((conn)->service))
93 #define MAP_HIDDEN(conn) ((conn) && lp_map_hidden((conn)->service))
94 #define MAP_SYSTEM(conn) ((conn) && lp_map_system((conn)->service))
95 #define MAP_ARCHIVE(conn) ((conn) && lp_map_archive((conn)->service))
96 #define IS_HIDDEN_PATH(conn,path) ((conn) && is_in_path((path),(conn)->hide_list))
97 #define IS_VETO_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_list))
98 #define IS_VETO_OPLOCK_PATH(conn,path) ((conn) && is_in_path((path),(conn)->veto_oplock_list))
101 * Used by the stat cache code to check if a returned
102 * stat structure is valid.
105 #define VALID_STAT(st) (st.st_nlink != 0)
106 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR(st.st_mode))
108 #define SMBENCRYPT() (lp_encrypted_passwords())
111 #define MIN(a,b) ((a)<(b)?(a):(b))
114 #define MAX(a,b) ((a)>(b)?(a):(b))
118 #define ABS(a) ((a)>0?(a):(-(a)))
121 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
122 structures. We cannot define these as actual structures
123 due to possible differences in structure packing
124 on different machines/compilers. */
126 #define SMB_LPID_OFFSET(indx) (10 * (indx))
127 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
128 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
129 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
130 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
131 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
132 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
134 /* Macro to cache an error in a write_bmpx_struct */
135 #define CACHE_ERROR(w,c,e) ((w)->wr_errclass = (c), (w)->wr_error = (e), \
136 w->wr_discard = True, -1)
137 /* Macro to test if an error has been cached for this fnum */
138 #define HAS_CACHED_ERROR(fsp) ((fsp)->open && (fsp)->wbmpx_ptr && \
139 (fsp)->wbmpx_ptr->wr_discard)
140 /* Macro to turn the cached error into an error packet */
141 #define CACHED_ERROR(fsp) cached_error_packet(inbuf,outbuf,fsp,__LINE__)
143 /* these are the datagram types */
144 #define DGRAM_DIRECT_UNIQUE 0x10
146 #define ERROR(class,x) error_packet(inbuf,outbuf,class,x,__LINE__)
148 /* this is how errors are generated */
149 #define UNIXERROR(defclass,deferror) unix_error_packet(inbuf,outbuf,defclass,deferror,__LINE__)
151 #define SMB_ROUNDUP(x,g) (((x)+((g)-1))&~((g)-1))
153 #endif /* _SMB_MACROS_H */