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 #if _SAMBA_BUILD_ == 4
27 # define _SAMBA_BUILD_ 3
30 /* make sure we have included the correct config.h */
31 #ifndef NO_CONFIG_H /* for some tests */
32 #ifndef CONFIG_H_IS_FROM_SAMBA
33 #error "make sure you have removed all config.h files from standalone builds!"
34 #error "the included config.h isn't from samba!"
36 #endif /* NO_CONFIG_H */
38 /* only do the C++ reserved word check when we compile
39 to include --with-developer since too many systems
40 still have comflicts with their header files (e.g. IRIX 6.4) */
42 #if !defined(__cplusplus) && defined(DEVELOPER) && defined(__linux__)
43 #define class #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
44 #define private #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
45 #define public #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
46 #define protected #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
47 #define template #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
48 #define this #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
49 #define new #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
50 #define delete #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
51 #define friend #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
57 /* on SUNOS4 termios.h conflicts with sys/ioctl.h */
63 * <unistd.h> has to be included before any other to get
64 * large file support on Reliant UNIX. Yes, it's broken :-).
69 #endif /* RELIANTUNIX */
71 #include "system/dir.h"
72 #include "system/locale.h"
73 #include "system/time.h"
74 #include "system/wait.h"
76 #if defined(HAVE_RPC_RPC_H)
78 * Check for AUTH_ERROR define conflict with rpc/rpc.h in prot.h.
80 #if defined(HAVE_SYS_SECURITY_H) && defined(HAVE_RPC_AUTH_ERROR_CONFLICT)
84 * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
85 * was included above. However <rpc/rpc.h> includes <sys/xti.h> which defines
86 * them again without checking if they already exsist. This generates
87 * two "Redefinition of macro" warnings for every single .c file that is
90 #if defined(HPUX) && defined(TCP_NODELAY)
93 #if defined(HPUX) && defined(TCP_MAXSEG)
99 #if defined(HAVE_YP_GET_DEFAULT_DOMAIN) && defined(HAVE_SETNETGRENT) && defined(HAVE_ENDNETGRENT) && defined(HAVE_GETNETGRENT)
100 #define HAVE_NETGROUP 1
103 #if defined (HAVE_NETGROUP)
104 #if defined(HAVE_RPCSVC_YP_PROT_H)
106 * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
107 * was included above. However <rpc/rpc.h> includes <sys/xti.h> which defines
108 * them again without checking if they already exsist. This generates
109 * two "Redefinition of macro" warnings for every single .c file that is
112 #if defined(HPUX) && defined(TCP_NODELAY)
115 #if defined(HPUX) && defined(TCP_MAXSEG)
118 #include <rpcsvc/yp_prot.h>
120 #if defined(HAVE_RPCSVC_YPCLNT_H)
121 #include <rpcsvc/ypclnt.h>
123 #endif /* HAVE_NETGROUP */
133 #if HAVE_SYS_ATTRIBUTES_H
134 #include <sys/attributes.h>
139 #define ENOATTR ENODATA
141 #define ENOATTR ENOENT
145 /* mutually exclusive (SuSE 8.2) */
146 #if HAVE_ATTR_XATTR_H
147 #include <attr/xattr.h>
148 #elif HAVE_SYS_XATTR_H
149 #include <sys/xattr.h>
156 #ifdef HAVE_SYS_EXTATTR_H
157 #include <sys/extattr.h>
160 #ifdef HAVE_SYS_UIO_H
165 #include <langinfo.h>
169 #include <netgroup.h>
172 #if defined(HAVE_AIO_H) && defined(WITH_AIO)
176 #ifdef WITH_MADVISE_PROTECTED
177 #include <sys/mman.h>
180 /* Special macros that are no-ops except when run under Valgrind on
181 * x86. They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
182 #if HAVE_VALGRIND_MEMCHECK_H
183 /* memcheck.h includes valgrind.h */
184 #include <valgrind/memcheck.h>
185 #elif HAVE_VALGRIND_H
186 #include <valgrind.h>
189 /* we support ADS if we want it and have krb5 and ldap libs */
190 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
195 * Define additional missing types
198 typedef sig_atomic_t SIG_ATOMIC_T
;
200 typedef sig_atomic_t volatile SIG_ATOMIC_T
;
204 #define uchar unsigned char
208 Samba needs type definitions for int16, int32, uint16 and uint32.
210 Normally these are signed and unsigned 16 and 32 bit integers, but
211 they actually only need to be at least 16 and 32 bits
212 respectively. Thus if your word size is 8 bytes just defining them
213 as signed and unsigned int will work.
217 #define uint8 uint8_t
220 #if !defined(int16) && !defined(HAVE_INT16_FROM_RPC_RPC_H)
221 # define int16 int16_t
222 /* needed to work around compile issue on HP-UX 11.x */
227 * Note we duplicate the size tests in the unsigned
228 * case as int16 may be a typedef from rpc/rpc.h
232 #if !defined(uint16) && !defined(HAVE_UINT16_FROM_RPC_RPC_H)
233 # define uint16 uint16_t
236 #if !defined(int32) && !defined(HAVE_INT32_FROM_RPC_RPC_H)
237 # define int32 int32_t
239 /* needed to work around compile issue on HP-UX 11.x */
245 * Note we duplicate the size tests in the unsigned
246 * case as int32 may be a typedef from rpc/rpc.h
249 #if !defined(uint32) && !defined(HAVE_UINT32_FROM_RPC_RPC_H)
250 # define uint32 uint32_t
254 * check for 8 byte long long
258 # define uint64 uint64_t
262 # define int64 int64_t
267 * Types for devices, inodes and offsets.
271 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)
272 # define SMB_DEV_T dev64_t
274 # define SMB_DEV_T dev_t
278 #ifndef LARGE_SMB_DEV_T
279 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)) || (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
280 # define LARGE_SMB_DEV_T 1
284 #ifdef LARGE_SMB_DEV_T
285 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
286 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
288 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
289 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
293 * Setup the correctly sized inode type.
297 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)
298 # define SMB_INO_T ino64_t
300 # define SMB_INO_T ino_t
304 #ifndef LARGE_SMB_INO_T
305 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)) || (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
306 # define LARGE_SMB_INO_T 1
310 #ifdef LARGE_SMB_INO_T
311 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, v)
312 #define INO_T_VAL(p, ofs) ((SMB_INO_T)BVAL(p, ofs))
314 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, ((uint64_t)(v)) & UINT32_MAX)
315 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
319 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)
320 # define SMB_OFF_T off64_t
322 # define SMB_OFF_T off_t
326 /* TODO: remove this macros */
327 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
328 #define BIG_UINT(p, ofs) BVAL(p, ofs)
329 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
331 /* this should really be a 64 bit type if possible */
332 typedef uint64_t br_off
;
334 #define SMB_OFF_T_BITS (sizeof(SMB_OFF_T)*8)
337 * Set the define that tells us if we can do 64 bit
341 #ifndef LARGE_SMB_OFF_T
342 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)) || (defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T == 8))
343 # define LARGE_SMB_OFF_T 1
347 #ifdef LARGE_SMB_OFF_T
348 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
349 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
350 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
352 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,v),SIVAL(p,(ofs)+4,0))
353 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,v),SIVAL(p,ofs,0))
354 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint32)(IVAL((buf),(off)))) & 0xFFFFFFFF )))
357 #ifndef HAVE_BLKSIZE_T
358 /* This is mainly for HP/UX which defines st_blksize as long */
359 typedef long blksize_t
;
362 #ifndef HAVE_BLKCNT_T
363 /* This is mainly for HP/UX which doesn't have blkcnt_t */
364 typedef long blkcnt_t
;
368 * Type for stat structure.
380 struct timespec st_ex_atime
;
381 struct timespec st_ex_mtime
;
382 struct timespec st_ex_ctime
;
383 struct timespec st_ex_btime
; /* birthtime */
384 /* Is birthtime real, or was it calculated ? */
385 bool st_ex_calculated_birthtime
;
386 blksize_t st_ex_blksize
;
387 blkcnt_t st_ex_blocks
;
389 uint32_t st_ex_flags
;
393 * Add space for VFS internal extensions. The initial user of this
394 * would be the onefs modules, passing the snapid from the stat calls
395 * to the file_id_create call. Maybe we'll have to expand this later,
396 * but the core of Samba should never look at this field.
398 uint64_t vfs_private
;
401 typedef struct stat_ex SMB_STRUCT_STAT
;
404 * Type for dirent structure.
407 #ifndef SMB_STRUCT_DIRENT
408 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIRENT64)
409 # define SMB_STRUCT_DIRENT struct dirent64
411 # define SMB_STRUCT_DIRENT struct dirent
416 * Type for DIR structure.
419 #ifndef SMB_STRUCT_DIR
420 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIR64)
421 # define SMB_STRUCT_DIR DIR64
423 # define SMB_STRUCT_DIR DIR
428 * Defines for 64 bit fcntl locks.
431 #ifndef SMB_STRUCT_FLOCK
432 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
433 # define SMB_STRUCT_FLOCK struct flock64
435 # define SMB_STRUCT_FLOCK struct flock
440 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
441 # define SMB_F_SETLKW F_SETLKW64
443 # define SMB_F_SETLKW F_SETLKW
448 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
449 # define SMB_F_SETLK F_SETLK64
451 # define SMB_F_SETLK F_SETLK
456 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
457 # define SMB_F_GETLK F_GETLK64
459 # define SMB_F_GETLK F_GETLK
464 * Type for aiocb structure.
467 #ifndef SMB_STRUCT_AIOCB
468 # if defined(WITH_AIO)
469 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_AIOCB64)
470 # define SMB_STRUCT_AIOCB struct aiocb64
472 # define SMB_STRUCT_AIOCB struct aiocb
475 # define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
479 enum timestamp_set_resolution
{
480 TIMESTAMP_SET_SECONDS
= 0,
482 TIMESTAMP_SET_NT_OR_BETTER
485 /* Our own fstrings */
494 | The infamous pstring |
501 _________)/\\_//(\/(/\)/\//\/\///|_)_______
505 #define FSTRING_LEN 256
506 typedef char fstring
[FSTRING_LEN
];
509 /* Lists, trees, caching, database... */
510 #include "../lib/util/util.h"
511 #include "../lib/util/util_net.h"
512 #include "../lib/util/xfile.h"
513 #include "../lib/util/memory.h"
514 #include "../lib/util/attr.h"
515 #include "../lib/util/tsort.h"
516 #include "../lib/util/dlinklist.h"
518 #include "util_tdb.h"
523 #include "../lib/util/tevent_unix.h"
524 #include "../lib/util/tevent_ntstatus.h"
525 #include "../lib/tsocket/tsocket.h"
527 #include "../lib/util/data_blob.h"
528 #include "../lib/util/time.h"
529 #include "../lib/util/debug.h"
530 #include "../lib/util/debug_s3.h"
532 #include "libads/ads_status.h"
533 #include "../libcli/util/error.h"
534 #include "../lib/util/charset/charset.h"
535 #include "dynconfig.h"
537 #include "smb_perfcount.h"
539 #include "../lib/util/byteorder.h"
544 #include "../lib/util/talloc_stack.h"
545 #include "../lib/util/smb_threads.h"
546 #include "../lib/util/smb_threads_internal.h"
549 * Reasons for cache flush.
552 enum flush_reason_enum
{
557 OPLOCK_RELEASE_FLUSH
,
561 /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
564 /***** prototypes *****/
569 /* String routines */
572 #include "safe_string.h"
575 #define SIGCLD SIGCHLD
579 #define SIGRTMIN NSIG
582 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
583 #define OSF1_ENH_SEC 1
586 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
587 #define ULTRIX_AUTH 1
590 /* yuck, I'd like a better way of doing this */
591 #define DIRP_SIZE (256 + 32)
593 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
594 given the socket IO pattern that Samba uses */
596 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
598 #define DEFAULT_SOCKET_OPTIONS ""
601 /* dmalloc -- free heap debugger (dmalloc.org). This should be near
602 * the *bottom* of include files so as not to conflict. */
603 #ifdef ENABLE_DMALLOC
604 # include <dmalloc.h>
608 #if HAVE_KERNEL_SHARE_MODES
610 #define LOCK_MAND 32 /* This is a mandatory flock */
611 #define LOCK_READ 64 /* ... Which allows concurrent read operations */
612 #define LOCK_WRITE 128 /* ... Which allows concurrent write operations */
613 #define LOCK_RW 192 /* ... Which allows concurrent read & write ops */
617 #define MAX_SEC_CTX_DEPTH 8 /* Maximum number of security contexts */
620 #ifdef GLIBC_HACK_FCNTL64
621 /* this is a gross hack. 64 bit locking is completely screwed up on
622 i386 Linux in glibc 2.1.95 (which ships with RedHat 7.0). This hack
623 "fixes" the problem with the current 2.4.0test kernels
625 #define fcntl fcntl64
633 /* add varargs prototypes with printf checking */
635 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
637 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
639 int d_fprintf(FILE *f
, const char *, ...) PRINTF_ATTRIBUTE(2,3);
642 void sys_adminlog(int priority
, const char *format_str
, ...) PRINTF_ATTRIBUTE(2,3);
645 int fstr_sprintf(fstring s
, const char *fmt
, ...) PRINTF_ATTRIBUTE(2,3);
647 int d_vfprintf(FILE *f
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
649 int smb_xvasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
651 int asprintf_strupper_m(char **strp
, const char *fmt
, ...) PRINTF_ATTRIBUTE(2,3);
652 char *talloc_asprintf_strupper_m(TALLOC_CTX
*t
, const char *fmt
, ...) PRINTF_ATTRIBUTE(2,3);
655 * Veritas File System. Often in addition to native.
658 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
663 #define XATTR_CREATE 0x1 /* set value, fail if attr already exists */
666 #ifndef XATTR_REPLACE
667 #define XATTR_REPLACE 0x2 /* set value, fail if attr does not exist */
673 #define TRUE __ERROR__XX__DONT_USE_TRUE
678 #define FALSE __ERROR__XX__DONT_USE_FALSE
680 /* If we have blacklisted mmap() try to avoid using it accidentally by
681 undefining the HAVE_MMAP symbol. */
683 #ifdef MMAP_BLACKLIST
687 #ifndef CONST_DISCARD
688 #define CONST_DISCARD(type, ptr) ((type) ((void *) (ptr)))
691 void dump_core(void) _NORETURN_
;
692 void exit_server(const char *const reason
) _NORETURN_
;
693 void exit_server_cleanly(const char *const reason
) _NORETURN_
;
694 void exit_server_fault(void) _NORETURN_
;
696 #if defined(HAVE_IPV6)
697 void in6_addr_to_sockaddr_storage(struct sockaddr_storage
*ss
,
701 /* samba3 doesn't use uwrap yet */
702 #define uwrap_enabled() 0
704 #define BASE_RID (0x000003E8L)
706 #endif /* _INCLUDES_H */