s3-libsmb/libsmb_file.c: replace cli_read_old() with cli_read()
[Samba/gebeck_regimport.git] / source3 / include / includes.h
blobac29b7d90150de482fa8530da0a17c5df603078e
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 /* mutually exclusive (SuSE 8.2) */
141 #if HAVE_ATTR_XATTR_H
142 #include <attr/xattr.h>
143 #elif HAVE_SYS_XATTR_H
144 #include <sys/xattr.h>
145 #endif
147 #ifdef HAVE_SYS_EA_H
148 #include <sys/ea.h>
149 #endif
151 #ifdef HAVE_SYS_EXTATTR_H
152 #include <sys/extattr.h>
153 #endif
155 #ifdef HAVE_SYS_UIO_H
156 #include <sys/uio.h>
157 #endif
159 #if HAVE_LANGINFO_H
160 #include <langinfo.h>
161 #endif
163 #if HAVE_NETGROUP_H
164 #include <netgroup.h>
165 #endif
167 #if defined(HAVE_AIO_H) && defined(WITH_AIO)
168 #include <aio.h>
169 #endif
171 /* Special macros that are no-ops except when run under Valgrind on
172 * x86. They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
173 #if HAVE_VALGRIND_MEMCHECK_H
174 /* memcheck.h includes valgrind.h */
175 #include <valgrind/memcheck.h>
176 #elif HAVE_VALGRIND_H
177 #include <valgrind.h>
178 #endif
180 /* we support ADS if we want it and have krb5 and ldap libs */
181 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
182 #define HAVE_ADS
183 #endif
186 * Define additional missing types
188 #if defined(AIX)
189 typedef sig_atomic_t SIG_ATOMIC_T;
190 #else
191 typedef sig_atomic_t volatile SIG_ATOMIC_T;
192 #endif
194 #ifndef uchar
195 #define uchar unsigned char
196 #endif
199 Samba needs type definitions for int16, int32, uint16 and uint32.
201 Normally these are signed and unsigned 16 and 32 bit integers, but
202 they actually only need to be at least 16 and 32 bits
203 respectively. Thus if your word size is 8 bytes just defining them
204 as signed and unsigned int will work.
207 #ifndef uint8
208 #define uint8 uint8_t
209 #endif
211 #if !defined(int16) && !defined(HAVE_INT16_FROM_RPC_RPC_H)
212 # define int16 int16_t
213 /* needed to work around compile issue on HP-UX 11.x */
214 # define _INT16 1
215 #endif
218 * Note we duplicate the size tests in the unsigned
219 * case as int16 may be a typedef from rpc/rpc.h
223 #if !defined(uint16) && !defined(HAVE_UINT16_FROM_RPC_RPC_H)
224 # define uint16 uint16_t
225 #endif
227 #if !defined(int32) && !defined(HAVE_INT32_FROM_RPC_RPC_H)
228 # define int32 int32_t
229 # ifndef _INT32
230 /* needed to work around compile issue on HP-UX 11.x */
231 # define _INT32 1
232 # endif
233 #endif
236 * Note we duplicate the size tests in the unsigned
237 * case as int32 may be a typedef from rpc/rpc.h
240 #if !defined(uint32) && !defined(HAVE_UINT32_FROM_RPC_RPC_H)
241 # define uint32 uint32_t
242 #endif
245 * check for 8 byte long long
248 #if !defined(uint64)
249 # define uint64 uint64_t
250 #endif
252 #if !defined(int64)
253 # define int64 int64_t
254 #endif
258 * Types for devices, inodes and offsets.
261 #ifndef SMB_DEV_T
262 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)
263 # define SMB_DEV_T dev64_t
264 # else
265 # define SMB_DEV_T dev_t
266 # endif
267 #endif
269 #ifndef LARGE_SMB_DEV_T
270 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)) || (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
271 # define LARGE_SMB_DEV_T 1
272 # endif
273 #endif
275 #ifdef LARGE_SMB_DEV_T
276 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
277 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
278 #else
279 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
280 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
281 #endif
284 * Setup the correctly sized inode type.
287 #ifndef SMB_INO_T
288 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)
289 # define SMB_INO_T ino64_t
290 # else
291 # define SMB_INO_T ino_t
292 # endif
293 #endif
295 #ifndef LARGE_SMB_INO_T
296 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)) || (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
297 # define LARGE_SMB_INO_T 1
298 # endif
299 #endif
301 #ifdef LARGE_SMB_INO_T
302 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, v)
303 #define INO_T_VAL(p, ofs) ((SMB_INO_T)BVAL(p, ofs))
304 #else
305 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, ((uint64_t)(v)) & UINT32_MAX)
306 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
307 #endif
309 #ifndef SMB_OFF_T
310 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)
311 # define SMB_OFF_T off64_t
312 # else
313 # define SMB_OFF_T off_t
314 # endif
315 #endif
317 /* TODO: remove this macros */
318 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
319 #define BIG_UINT(p, ofs) BVAL(p, ofs)
320 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
322 /* this should really be a 64 bit type if possible */
323 typedef uint64_t br_off;
325 #define SMB_OFF_T_BITS (sizeof(SMB_OFF_T)*8)
328 * Set the define that tells us if we can do 64 bit
329 * NT SMB calls.
332 #ifndef LARGE_SMB_OFF_T
333 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)) || (defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T == 8))
334 # define LARGE_SMB_OFF_T 1
335 # endif
336 #endif
338 #ifdef LARGE_SMB_OFF_T
339 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
340 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
341 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
342 #else
343 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,v),SIVAL(p,(ofs)+4,0))
344 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,v),SIVAL(p,ofs,0))
345 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint32)(IVAL((buf),(off)))) & 0xFFFFFFFF )))
346 #endif
348 #ifndef HAVE_BLKSIZE_T
349 /* This is mainly for HP/UX which defines st_blksize as long */
350 typedef long blksize_t;
351 #endif
353 #ifndef HAVE_BLKCNT_T
354 /* This is mainly for HP/UX which doesn't have blkcnt_t */
355 typedef long blkcnt_t;
356 #endif
359 * Type for stat structure.
362 struct stat_ex {
363 dev_t st_ex_dev;
364 ino_t st_ex_ino;
365 mode_t st_ex_mode;
366 nlink_t st_ex_nlink;
367 uid_t st_ex_uid;
368 gid_t st_ex_gid;
369 dev_t st_ex_rdev;
370 off_t st_ex_size;
371 struct timespec st_ex_atime;
372 struct timespec st_ex_mtime;
373 struct timespec st_ex_ctime;
374 struct timespec st_ex_btime; /* birthtime */
375 /* Is birthtime real, or was it calculated ? */
376 bool st_ex_calculated_birthtime;
377 blksize_t st_ex_blksize;
378 blkcnt_t st_ex_blocks;
380 uint32_t st_ex_flags;
381 uint32_t st_ex_mask;
384 * Add space for VFS internal extensions. The initial user of this
385 * would be the onefs modules, passing the snapid from the stat calls
386 * to the file_id_create call. Maybe we'll have to expand this later,
387 * but the core of Samba should never look at this field.
389 uint64_t vfs_private;
392 typedef struct stat_ex SMB_STRUCT_STAT;
395 * Type for dirent structure.
398 #ifndef SMB_STRUCT_DIRENT
399 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIRENT64)
400 # define SMB_STRUCT_DIRENT struct dirent64
401 # else
402 # define SMB_STRUCT_DIRENT struct dirent
403 # endif
404 #endif
407 * Type for DIR structure.
410 #ifndef SMB_STRUCT_DIR
411 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIR64)
412 # define SMB_STRUCT_DIR DIR64
413 # else
414 # define SMB_STRUCT_DIR DIR
415 # endif
416 #endif
419 * Defines for 64 bit fcntl locks.
422 #ifndef SMB_STRUCT_FLOCK
423 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
424 # define SMB_STRUCT_FLOCK struct flock64
425 # else
426 # define SMB_STRUCT_FLOCK struct flock
427 # endif
428 #endif
430 #ifndef SMB_F_SETLKW
431 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
432 # define SMB_F_SETLKW F_SETLKW64
433 # else
434 # define SMB_F_SETLKW F_SETLKW
435 # endif
436 #endif
438 #ifndef SMB_F_SETLK
439 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
440 # define SMB_F_SETLK F_SETLK64
441 # else
442 # define SMB_F_SETLK F_SETLK
443 # endif
444 #endif
446 #ifndef SMB_F_GETLK
447 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
448 # define SMB_F_GETLK F_GETLK64
449 # else
450 # define SMB_F_GETLK F_GETLK
451 # endif
452 #endif
455 * Type for aiocb structure.
458 #ifndef SMB_STRUCT_AIOCB
459 # if defined(WITH_AIO)
460 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_AIOCB64)
461 # define SMB_STRUCT_AIOCB struct aiocb64
462 # else
463 # define SMB_STRUCT_AIOCB struct aiocb
464 # endif
465 # else
466 # define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
467 # endif
468 #endif
470 enum timestamp_set_resolution {
471 TIMESTAMP_SET_SECONDS = 0,
472 TIMESTAMP_SET_MSEC,
473 TIMESTAMP_SET_NT_OR_BETTER
476 /* Our own fstrings */
479 --------------
481 / REST \
482 / IN \
483 / PEACE \
485 | The infamous pstring |
488 | 7 December |
490 | 2007 |
491 *| * * * | *
492 _________)/\\_//(\/(/\)/\//\/\///|_)_______
495 #ifndef FSTRING_LEN
496 #define FSTRING_LEN 256
497 typedef char fstring[FSTRING_LEN];
498 #endif
500 /* Lists, trees, caching, database... */
501 #include "../lib/util/util.h"
502 #include "../lib/util/util_net.h"
503 #include "../lib/util/xfile.h"
504 #include "../lib/util/memory.h"
505 #include "../lib/util/attr.h"
506 #include "../lib/util/tsort.h"
507 #include "../lib/util/dlinklist.h"
509 #include <talloc.h>
511 #include "event.h"
513 #include "../lib/util/data_blob.h"
514 #include "../lib/util/time.h"
515 #include "../lib/util/debug.h"
516 #include "../lib/util/debug_s3.h"
518 #include "../libcli/util/ntstatus.h"
519 #include "../libcli/util/error.h"
520 #include "../lib/util/charset/charset.h"
521 #include "dynconfig/dynconfig.h"
522 #include "locking.h"
523 #include "smb_perfcount.h"
524 #include "smb.h"
525 #include "../lib/util/byteorder.h"
527 #include "module.h"
528 #include "../lib/util/talloc_stack.h"
529 #include "../lib/util/smb_threads.h"
530 #include "../lib/util/smb_threads_internal.h"
532 /***** prototypes *****/
533 #ifndef NO_PROTO_H
534 #include "proto.h"
535 #endif
537 /* String routines */
539 #include "srvstr.h"
540 #include "safe_string.h"
542 #ifndef SIGCLD
543 #define SIGCLD SIGCHLD
544 #endif
546 #ifndef SIGRTMIN
547 #define SIGRTMIN NSIG
548 #endif
550 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
551 #define OSF1_ENH_SEC 1
552 #endif
554 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
555 #define ULTRIX_AUTH 1
556 #endif
558 /* yuck, I'd like a better way of doing this */
559 #define DIRP_SIZE (256 + 32)
561 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
562 given the socket IO pattern that Samba uses */
563 #ifdef TCP_NODELAY
564 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
565 #else
566 #define DEFAULT_SOCKET_OPTIONS ""
567 #endif
569 /* dmalloc -- free heap debugger (dmalloc.org). This should be near
570 * the *bottom* of include files so as not to conflict. */
571 #ifdef ENABLE_DMALLOC
572 # include <dmalloc.h>
573 #endif
576 #define MAX_SEC_CTX_DEPTH 8 /* Maximum number of security contexts */
579 #ifdef GLIBC_HACK_FCNTL64
580 /* this is a gross hack. 64 bit locking is completely screwed up on
581 i386 Linux in glibc 2.1.95 (which ships with RedHat 7.0). This hack
582 "fixes" the problem with the current 2.4.0test kernels
584 #define fcntl fcntl64
585 #undef F_SETLKW
586 #undef F_SETLK
587 #define F_SETLK 13
588 #define F_SETLKW 14
589 #endif
592 /* add varargs prototypes with printf checking */
593 /*PRINTFLIKE2 */
594 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
595 /*PRINTFLIKE1 */
596 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
597 /*PRINTFLIKE2 */
598 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
600 /* PRINTFLIKE2 */
601 void sys_adminlog(int priority, const char *format_str, ...) PRINTF_ATTRIBUTE(2,3);
603 /* PRINTFLIKE2 */
604 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
606 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
608 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
609 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
612 * Veritas File System. Often in addition to native.
613 * Quotas different.
615 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
616 #define VXFS_QUOTA
617 #endif
619 #ifndef XATTR_CREATE
620 #define XATTR_CREATE 0x1 /* set value, fail if attr already exists */
621 #endif
623 #ifndef XATTR_REPLACE
624 #define XATTR_REPLACE 0x2 /* set value, fail if attr does not exist */
625 #endif
627 #ifdef TRUE
628 #undef TRUE
629 #endif
630 #define TRUE __ERROR__XX__DONT_USE_TRUE
632 #ifdef FALSE
633 #undef FALSE
634 #endif
635 #define FALSE __ERROR__XX__DONT_USE_FALSE
637 /* If we have blacklisted mmap() try to avoid using it accidentally by
638 undefining the HAVE_MMAP symbol. */
640 #ifdef MMAP_BLACKLIST
641 #undef HAVE_MMAP
642 #endif
644 void dump_core(void) _NORETURN_;
645 void exit_server(const char *const reason) _NORETURN_;
646 void exit_server_cleanly(const char *const reason) _NORETURN_;
647 void exit_server_fault(void) _NORETURN_;
649 /* samba3 doesn't use uwrap yet */
650 #define uwrap_enabled() 0
652 #define BASE_RID (0x000003E8L)
654 #endif /* _INCLUDES_H */