testprogs: Set functional domain level to 2003.
[Samba.git] / source3 / include / includes.h
blob0715608c32b523625848119d721a3052d828c360
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>
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.
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.
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/>.
23 #include "../replace/replace.h"
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 */
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) */
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
49 #include "local.h"
51 #ifdef SUNOS4
52 /* on SUNOS4 termios.h conflicts with sys/ioctl.h */
53 #undef HAVE_TERMIOS_H
54 #endif
56 #ifdef RELIANTUNIX
58 * <unistd.h> has to be included before any other to get
59 * large file support on Reliant UNIX. Yes, it's broken :-).
61 #ifdef HAVE_UNISTD_H
62 #include <unistd.h>
63 #endif
64 #endif /* RELIANTUNIX */
66 #include "system/dir.h"
67 #include "system/locale.h"
68 #include "system/time.h"
69 #include "system/wait.h"
71 #if defined(HAVE_RPC_RPC_H)
73 * Check for AUTH_ERROR define conflict with rpc/rpc.h in prot.h.
75 #if defined(HAVE_SYS_SECURITY_H) && defined(HAVE_RPC_AUTH_ERROR_CONFLICT)
76 #undef AUTH_ERROR
77 #endif
79 * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
80 * was included above. However <rpc/rpc.h> includes <sys/xti.h> which defines
81 * them again without checking if they already exsist. This generates
82 * two "Redefinition of macro" warnings for every single .c file that is
83 * compiled.
85 #if defined(HPUX) && defined(TCP_NODELAY)
86 #undef TCP_NODELAY
87 #endif
88 #if defined(HPUX) && defined(TCP_MAXSEG)
89 #undef TCP_MAXSEG
90 #endif
91 #include <rpc/rpc.h>
92 #endif
94 #if defined(HAVE_YP_GET_DEFAULT_DOMAIN) && defined(HAVE_SETNETGRENT) && defined(HAVE_ENDNETGRENT) && defined(HAVE_GETNETGRENT)
95 #define HAVE_NETGROUP 1
96 #endif
98 #if defined (HAVE_NETGROUP)
99 #if defined(HAVE_RPCSVC_YP_PROT_H)
101 * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
102 * was included above. However <rpc/rpc.h> includes <sys/xti.h> which defines
103 * them again without checking if they already exsist. This generates
104 * two "Redefinition of macro" warnings for every single .c file that is
105 * compiled.
107 #if defined(HPUX) && defined(TCP_NODELAY)
108 #undef TCP_NODELAY
109 #endif
110 #if defined(HPUX) && defined(TCP_MAXSEG)
111 #undef TCP_MAXSEG
112 #endif
113 #include <rpcsvc/yp_prot.h>
114 #endif
115 #if defined(HAVE_RPCSVC_YPCLNT_H)
116 #include <rpcsvc/ypclnt.h>
117 #endif
118 #endif /* HAVE_NETGROUP */
120 #ifndef HAVE_KRB5_H
121 #undef HAVE_KRB5
122 #endif
124 #ifndef HAVE_LDAP_H
125 #undef HAVE_LDAP
126 #endif
128 #if HAVE_SYS_ATTRIBUTES_H
129 #include <sys/attributes.h>
130 #endif
132 #ifndef ENOATTR
133 #if defined(ENODATA)
134 #define ENOATTR ENODATA
135 #else
136 #define ENOATTR ENOENT
137 #endif
138 #endif
140 #ifdef HAVE_SYS_UIO_H
141 #include <sys/uio.h>
142 #endif
144 #if HAVE_LANGINFO_H
145 #include <langinfo.h>
146 #endif
148 #if HAVE_NETGROUP_H
149 #include <netgroup.h>
150 #endif
152 /* Special macros that are no-ops except when run under Valgrind on
153 * x86. They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
154 #if HAVE_VALGRIND_MEMCHECK_H
155 /* memcheck.h includes valgrind.h */
156 #include <valgrind/memcheck.h>
157 #elif HAVE_VALGRIND_H
158 #include <valgrind.h>
159 #endif
161 /* we support ADS if we want it and have krb5 and ldap libs */
162 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
163 #define HAVE_ADS
164 #endif
167 * Define additional missing types
169 #if defined(AIX)
170 typedef sig_atomic_t SIG_ATOMIC_T;
171 #else
172 typedef sig_atomic_t volatile SIG_ATOMIC_T;
173 #endif
175 #ifndef uchar
176 #define uchar unsigned char
177 #endif
180 Samba needs type definitions for int16, int32, uint16 and uint32.
182 Normally these are signed and unsigned 16 and 32 bit integers, but
183 they actually only need to be at least 16 and 32 bits
184 respectively. Thus if your word size is 8 bytes just defining them
185 as signed and unsigned int will work.
188 #ifndef uint8
189 #define uint8 uint8_t
190 #endif
192 #if !defined(int16) && !defined(HAVE_INT16_FROM_RPC_RPC_H)
193 # define int16 int16_t
194 /* needed to work around compile issue on HP-UX 11.x */
195 # define _INT16 1
196 #endif
199 * Note we duplicate the size tests in the unsigned
200 * case as int16 may be a typedef from rpc/rpc.h
204 #if !defined(uint16) && !defined(HAVE_UINT16_FROM_RPC_RPC_H)
205 # define uint16 uint16_t
206 #endif
208 #if !defined(int32) && !defined(HAVE_INT32_FROM_RPC_RPC_H)
209 # define int32 int32_t
210 # ifndef _INT32
211 /* needed to work around compile issue on HP-UX 11.x */
212 # define _INT32 1
213 # endif
214 #endif
217 * Note we duplicate the size tests in the unsigned
218 * case as int32 may be a typedef from rpc/rpc.h
221 #if !defined(uint32) && !defined(HAVE_UINT32_FROM_RPC_RPC_H)
222 # define uint32 uint32_t
223 #endif
226 * check for 8 byte long long
229 #if !defined(uint64)
230 # define uint64 uint64_t
231 #endif
233 #if !defined(int64)
234 # define int64 int64_t
235 #endif
239 * Types for devices, inodes and offsets.
242 #ifndef SMB_DEV_T
243 # define SMB_DEV_T dev_t
244 #endif
246 #ifndef LARGE_SMB_DEV_T
247 # if (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
248 # define LARGE_SMB_DEV_T 1
249 # endif
250 #endif
252 #ifdef LARGE_SMB_DEV_T
253 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
254 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
255 #else
256 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
257 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
258 #endif
261 * Setup the correctly sized inode type.
264 #ifndef SMB_INO_T
265 # define SMB_INO_T ino_t
266 #endif
268 #ifndef LARGE_SMB_INO_T
269 # if (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
270 # define LARGE_SMB_INO_T 1
271 # endif
272 #endif
274 #ifdef LARGE_SMB_INO_T
275 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, v)
276 #define INO_T_VAL(p, ofs) ((SMB_INO_T)BVAL(p, ofs))
277 #else
278 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, ((uint64_t)(v)) & UINT32_MAX)
279 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
280 #endif
282 /* TODO: remove this macros */
283 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
284 #define BIG_UINT(p, ofs) BVAL(p, ofs)
285 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
287 /* this should really be a 64 bit type if possible */
288 typedef uint64_t br_off;
290 #define SMB_OFF_T_BITS (sizeof(off_t)*8)
293 * Set the define that tells us if we can do 64 bit
294 * NT SMB calls.
297 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
298 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
299 #define IVAL_TO_SMB_OFF_T(buf,off) ((off_t)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
302 * Type for stat structure.
305 struct stat_ex {
306 dev_t st_ex_dev;
307 ino_t st_ex_ino;
308 mode_t st_ex_mode;
309 nlink_t st_ex_nlink;
310 uid_t st_ex_uid;
311 gid_t st_ex_gid;
312 dev_t st_ex_rdev;
313 off_t st_ex_size;
314 struct timespec st_ex_atime;
315 struct timespec st_ex_mtime;
316 struct timespec st_ex_ctime;
317 struct timespec st_ex_btime; /* birthtime */
318 /* Is birthtime real, or was it calculated ? */
319 bool st_ex_calculated_birthtime;
320 blksize_t st_ex_blksize;
321 blkcnt_t st_ex_blocks;
323 uint32_t st_ex_flags;
324 uint32_t st_ex_mask;
327 typedef struct stat_ex SMB_STRUCT_STAT;
329 enum timestamp_set_resolution {
330 TIMESTAMP_SET_SECONDS = 0,
331 TIMESTAMP_SET_MSEC,
332 TIMESTAMP_SET_NT_OR_BETTER
335 /* Our own fstrings */
338 --------------
340 / REST \
341 / IN \
342 / PEACE \
344 | The infamous pstring |
347 | 7 December |
349 | 2007 |
350 *| * * * | *
351 _________)/\\_//(\/(/\)/\//\/\///|_)_______
354 #ifndef FSTRING_LEN
355 #define FSTRING_LEN 256
356 typedef char fstring[FSTRING_LEN];
357 #endif
359 /* Lists, trees, caching, database... */
360 #include "../lib/util/samba_util.h"
361 #include "../lib/util/util_net.h"
362 #include "../lib/util/xfile.h"
363 #include "../lib/util/memory.h"
364 #include "../lib/util/attr.h"
365 #include "../lib/util/tsort.h"
366 #include "../lib/util/dlinklist.h"
368 #include <talloc.h>
370 #include "event.h"
372 #include "../lib/util/data_blob.h"
373 #include "../lib/util/time.h"
374 #include "../lib/util/debug.h"
375 #include "../lib/util/debug_s3.h"
377 #include "../libcli/util/ntstatus.h"
378 #include "../libcli/util/error.h"
379 #include "../lib/util/charset/charset.h"
380 #include "dynconfig/dynconfig.h"
381 #include "locking.h"
382 #include "smb_perfcount.h"
383 #include "smb.h"
384 #include "../lib/util/byteorder.h"
386 #include "../lib/util/samba_modules.h"
387 #include "../lib/util/talloc_stack.h"
388 #include "../lib/util/smb_threads.h"
389 #include "../lib/util/smb_threads_internal.h"
391 /* samba_setXXid functions. */
392 #include "../lib/util/setid.h"
394 /***** prototypes *****/
395 #ifndef NO_PROTO_H
396 #include "proto.h"
397 #endif
399 #include "lib/param/loadparm.h"
401 /* String routines */
403 #include "srvstr.h"
404 #include "safe_string.h"
406 #ifndef SIGCLD
407 #define SIGCLD SIGCHLD
408 #endif
410 #ifndef SIGRTMIN
411 #define SIGRTMIN NSIG
412 #endif
415 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
416 #define ULTRIX_AUTH 1
417 #endif
419 /* yuck, I'd like a better way of doing this */
420 #define DIRP_SIZE (256 + 32)
422 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
423 given the socket IO pattern that Samba uses */
424 #ifdef TCP_NODELAY
425 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
426 #else
427 #define DEFAULT_SOCKET_OPTIONS ""
428 #endif
430 /* dmalloc -- free heap debugger (dmalloc.org). This should be near
431 * the *bottom* of include files so as not to conflict. */
432 #ifdef ENABLE_DMALLOC
433 # include <dmalloc.h>
434 #endif
437 #define MAX_SEC_CTX_DEPTH 8 /* Maximum number of security contexts */
440 /* add varargs prototypes with printf checking */
441 /*PRINTFLIKE2 */
442 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
443 /*PRINTFLIKE1 */
444 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
445 /*PRINTFLIKE2 */
446 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
448 /* PRINTFLIKE2 */
449 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
451 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
453 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
454 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
457 * Veritas File System. Often in addition to native.
458 * Quotas different.
460 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
461 #define VXFS_QUOTA
462 #endif
464 #ifdef TRUE
465 #undef TRUE
466 #endif
467 #define TRUE __ERROR__XX__DONT_USE_TRUE
469 #ifdef FALSE
470 #undef FALSE
471 #endif
472 #define FALSE __ERROR__XX__DONT_USE_FALSE
474 /* If we have blacklisted mmap() try to avoid using it accidentally by
475 undefining the HAVE_MMAP symbol. */
477 #ifdef MMAP_BLACKLIST
478 #undef HAVE_MMAP
479 #endif
481 void dump_core(void) _NORETURN_;
482 void exit_server(const char *const reason) _NORETURN_;
483 void exit_server_cleanly(const char *const reason) _NORETURN_;
485 #define BASE_RID (0x000003E8L)
487 #endif /* _INCLUDES_H */