1 #ifndef _INCLUDES_H
2 #define _INCLUDES_H
3 /*
4    Unix SMB/CIFS implementation.
5    Machine customisation and include handling
6    Copyright (C) Andrew Tridgell 1994-1998
7    Copyright (C) 2002 by Martin Pool <mbp@samba.org>
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 3 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, see <http://www.gnu.org/licenses/>.
21 */
22 
23 #include "../replace/replace.h"
24 
25 /* make sure we have included the correct config.h */
26 #ifndef NO_CONFIG_H /* for some tests */
27 #ifndef CONFIG_H_IS_FROM_SAMBA
28 #error "make sure you have removed all config.h files from standalone builds!"
29 #error "the included config.h isn't from samba!"
30 #endif
31 #endif /* NO_CONFIG_H */
32 
33 /* only do the C++ reserved word check when we compile
34    to include --with-developer since too many systems
35    still have comflicts with their header files (e.g. IRIX 6.4) */
36 
37 #if !defined(__cplusplus) && defined(DEVELOPER) && defined(__linux__)
38 #define class #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
39 #define private #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
40 #define public #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
41 #define protected #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
42 #define template #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
43 #define this #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
44 #define new #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
45 #define delete #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
46 #define friend #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
47 #endif
48 
49 #include "local.h"
50 
51 #ifdef SUNOS4
52 /* on SUNOS4 termios.h conflicts with sys/ioctl.h */
53 #undef HAVE_TERMIOS_H
54 #endif
55 
56 #ifdef RELIANTUNIX
57 /*
58  * <unistd.h> has to be included before any other to get
59  * large file support on Reliant UNIX. Yes, it's broken :-).
60  */
61 #ifdef HAVE_UNISTD_H
62 #include <unistd.h>
63 #endif
64 #endif /* RELIANTUNIX */
65 
66 #include "system/dir.h"
67 #include "system/locale.h"
68 #include "system/time.h"
69 #include "system/wait.h"
70 
71 #ifndef HAVE_KRB5_H
72 #undef HAVE_KRB5
73 #endif
74 
75 #ifndef HAVE_LDAP_H
76 #undef HAVE_LDAP
77 #endif
78 
79 #ifdef HAVE_SYS_ATTRIBUTES_H
80 #include <sys/attributes.h>
81 #endif
82 
83 #ifndef ENOATTR
84 #if defined(ENODATA)
85 #define ENOATTR ENODATA
86 #else
87 #define ENOATTR ENOENT
88 #endif
89 #endif
90 
91 #ifdef HAVE_SYS_UIO_H
92 #include <sys/uio.h>
93 #endif
94 
95 #ifdef HAVE_LANGINFO_H
96 #include <langinfo.h>
97 #endif
98 
99 #ifdef HAVE_NETGROUP_H
100 #include <netgroup.h>
101 #endif
102 
103 /* Special macros that are no-ops except when run under Valgrind on
104  * x86.  They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
105 #ifdef HAVE_VALGRIND_MEMCHECK_H
106         /* memcheck.h includes valgrind.h */
107 #include <valgrind/memcheck.h>
108 #elif defined(HAVE_VALGRIND_H)
109 #include <valgrind.h>
110 #endif
111 
112 /* we support ADS if we want it and have krb5 and ldap libs */
113 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
114 #define HAVE_ADS
115 #endif
116 
117 /*
118  * Define additional missing types
119  */
120 #if defined(AIX)
121 typedef sig_atomic_t SIG_ATOMIC_T;
122 #else
123 typedef sig_atomic_t volatile SIG_ATOMIC_T;
124 #endif
125 
126 #ifndef uchar
127 #define uchar unsigned char
128 #endif
129 
130 /*
131  * Types for devices, inodes and offsets.
132  */
133 
134 #ifndef SMB_DEV_T
135 # define SMB_DEV_T dev_t
136 #endif
137 
138 #ifndef LARGE_SMB_DEV_T
139 #  if (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
140 #    define LARGE_SMB_DEV_T 1
141 #  endif
142 #endif
143 
144 #ifdef LARGE_SMB_DEV_T
145 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
146 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
147 #else
148 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
149 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
150 #endif
151 
152 /*
153  * Setup the correctly sized inode type.
154  */
155 
156 #ifndef SMB_INO_T
157 #    define SMB_INO_T ino_t
158 #endif
159 
160 #ifndef LARGE_SMB_INO_T
161 #  if (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
162 #    define LARGE_SMB_INO_T 1
163 #  endif
164 #endif
165 
166 #ifdef LARGE_SMB_INO_T
167 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, v)
168 #define INO_T_VAL(p, ofs) ((SMB_INO_T)BVAL(p, ofs))
169 #else
170 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, ((uint64_t)(v)) & UINT32_MAX)
171 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
172 #endif
173 
174 /* TODO: remove this macros */
175 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
176 #define BIG_UINT(p, ofs) BVAL(p, ofs)
177 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
178 
179 /* this should really be a 64 bit type if possible */
180 typedef uint64_t br_off;
181 
182 #define SMB_OFF_T_BITS (sizeof(off_t)*8)
183 
184 /*
185  * Set the define that tells us if we can do 64 bit
186  * NT SMB calls.
187  */
188 
189 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
190 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
191 #define IVAL_TO_SMB_OFF_T(buf,off) ((off_t)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
192 
193 /* Is birthtime real, or was it calculated ? */
194 #define ST_EX_IFLAG_CALCULATED_BTIME		(1 << 0)
195 #define ST_EX_IFLAG_CALCULATED_ITIME		(1 << 1)
196 #define ST_EX_IFLAG_CALCULATED_FILE_ID		(1 << 2)
197 
198 /*
199  * Type for stat structure.
200  */
201 
202 struct stat_ex {
203 	dev_t		st_ex_dev;
204 	ino_t		st_ex_ino;
205 	uint64_t	st_ex_file_id;
206 	mode_t		st_ex_mode;
207 	nlink_t		st_ex_nlink;
208 	uid_t		st_ex_uid;
209 	gid_t		st_ex_gid;
210 	dev_t		st_ex_rdev;
211 	off_t		st_ex_size;
212 	struct timespec st_ex_atime;
213 	struct timespec st_ex_mtime;
214 	struct timespec st_ex_ctime;
215 	struct timespec st_ex_btime; /* birthtime */
216 	/*
217 	 * Immutable original birth time aka instantiation time. Set when a file
218 	 * is created, never changes thereafter. May not be set by the client.
219 	 */
220 	struct timespec st_ex_itime; /* instantiation time */
221 
222 	blksize_t	st_ex_blksize;
223 	blkcnt_t	st_ex_blocks;
224 
225 	uint32_t	st_ex_flags;
226 	uint32_t	st_ex_iflags;
227 };
228 
229 typedef struct stat_ex SMB_STRUCT_STAT;
230 
231 enum timestamp_set_resolution {
232 	TIMESTAMP_SET_SECONDS = 0,
233 	TIMESTAMP_SET_MSEC,
234 	TIMESTAMP_SET_NT_OR_BETTER
235 };
236 
237 /* Our own fstrings */
238 
239 /*
240                   --------------
241                  /              \
242                 /      REST      \
243                /        IN        \
244               /       PEACE        \
245              /                      \
246              | The infamous pstring |
247              |                      |
248              |                      |
249              |      7 December      |
250              |                      |
251              |         2007         |
252             *|     *  *  *          | *
253    _________)/\\_//(\/(/\)/\//\/\///|_)_______
254 */
255 
256 #ifndef FSTRING_LEN
257 #define FSTRING_LEN 256
258 typedef char fstring[FSTRING_LEN];
259 #endif
260 
261 /* debug.h need to be included before samba_util.h for the macro SMB_ASSERT */
262 #include "../lib/util/debug.h"
263 
264 /* Lists, trees, caching, database... */
265 #include "../lib/util/samba_util.h"
266 #include "../lib/util/util_net.h"
267 #include "../lib/util/attr.h"
268 #include "../lib/util/tsort.h"
269 #include "../lib/util/dlinklist.h"
270 
271 #include <talloc.h>
272 #include <tevent.h>
273 
274 #include "../lib/util/data_blob.h"
275 #include "../lib/util/time.h"
276 #include "../lib/util/debug_s3.h"
277 
278 #include "../libcli/util/ntstatus.h"
279 #include "../libcli/util/error.h"
280 #include "../lib/util/charset/charset.h"
281 #include "dynconfig/dynconfig.h"
282 #include "locking.h"
283 #include "smb_perfcount.h"
284 #include "smb.h"
285 #include "../lib/util/byteorder.h"
286 
287 #include "../lib/util/samba_modules.h"
288 #include "../lib/util/talloc_stack.h"
289 #include "../lib/util/smb_threads.h"
290 #include "../lib/util/smb_threads_internal.h"
291 
292 /* samba_setXXid functions. */
293 #include "../lib/util/setid.h"
294 
295 /***** prototypes *****/
296 #ifndef NO_PROTO_H
297 #include "proto.h"
298 #endif
299 
300 #include "lib/param/loadparm.h"
301 
302 /* String routines */
303 
304 #include "srvstr.h"
305 #include "safe_string.h"
306 
307 #ifndef SIGCLD
308 #define SIGCLD SIGCHLD
309 #endif
310 
311 #ifndef SIGRTMIN
312 #define SIGRTMIN NSIG
313 #endif
314 
315 
316 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
317 #define ULTRIX_AUTH 1
318 #endif
319 
320 /* yuck, I'd like a better way of doing this */
321 #define DIRP_SIZE (256 + 32)
322 
323 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
324    given the socket IO pattern that Samba uses */
325 #ifdef TCP_NODELAY
326 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
327 #else
328 #define DEFAULT_SOCKET_OPTIONS ""
329 #endif
330 
331 /* dmalloc -- free heap debugger (dmalloc.org).  This should be near
332  * the *bottom* of include files so as not to conflict. */
333 #ifdef ENABLE_DMALLOC
334 #  include <dmalloc.h>
335 #elif ENABLE_JEMALLOC
336 #  include <jemalloc/jemalloc.h>
337 #endif
338 
339 
340 #define MAX_SEC_CTX_DEPTH 8    /* Maximum number of security contexts */
341 
342 
343 /* add varargs prototypes with printf checking */
344 /*PRINTFLIKE1 */
345 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
346 /*PRINTFLIKE2 */
347 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
348 
349 /* PRINTFLIKE2 */
350 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
351 
352 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
353 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
354 
355 /*
356  * Veritas File System.  Often in addition to native.
357  * Quotas different.
358  */
359 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
360 #define VXFS_QUOTA
361 #endif
362 
363 #ifdef TRUE
364 #undef TRUE
365 #endif
366 #define TRUE __ERROR__XX__DONT_USE_TRUE
367 
368 #ifdef FALSE
369 #undef FALSE
370 #endif
371 #define FALSE __ERROR__XX__DONT_USE_FALSE
372 
373 void dump_core(void) _NORETURN_;
374 void exit_server(const char *const reason) _NORETURN_;
375 void exit_server_cleanly(const char *const reason) _NORETURN_;
376 
377 #define BASE_RID (0x000003E8L)
378 
379 #endif /* _INCLUDES_H */
380