Move copy_unix_token() from locking/locking.c to lib/util.c.
[kai/samba.git] / source3 / include / includes.h
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 #if defined(HAVE_RPC_RPC_H)
72 /*
73  * Check for AUTH_ERROR define conflict with rpc/rpc.h in prot.h.
74  */
75 #if defined(HAVE_SYS_SECURITY_H) && defined(HAVE_RPC_AUTH_ERROR_CONFLICT)
76 #undef AUTH_ERROR
77 #endif
78 /*
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.
84  */
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
93
94 #if defined(HAVE_YP_GET_DEFAULT_DOMAIN) && defined(HAVE_SETNETGRENT) && defined(HAVE_ENDNETGRENT) && defined(HAVE_GETNETGRENT)
95 #define HAVE_NETGROUP 1
96 #endif
97
98 #if defined (HAVE_NETGROUP)
99 #if defined(HAVE_RPCSVC_YP_PROT_H)
100 /*
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.
106  */
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 */
119
120 #ifndef HAVE_KRB5_H
121 #undef HAVE_KRB5
122 #endif
123
124 #ifndef HAVE_LDAP_H
125 #undef HAVE_LDAP
126 #endif
127
128 #if HAVE_SYS_ATTRIBUTES_H
129 #include <sys/attributes.h>
130 #endif
131
132 #ifndef ENOATTR
133 #if defined(ENODATA)
134 #define ENOATTR ENODATA
135 #else
136 #define ENOATTR ENOENT
137 #endif
138 #endif
139
140 #ifdef HAVE_SYS_UIO_H
141 #include <sys/uio.h>
142 #endif
143
144 #if HAVE_LANGINFO_H
145 #include <langinfo.h>
146 #endif
147
148 #if HAVE_NETGROUP_H
149 #include <netgroup.h>
150 #endif
151
152 #if defined(HAVE_AIO_H) && defined(HAVE_AIO)
153 #include <aio.h>
154 #endif
155
156 /* Special macros that are no-ops except when run under Valgrind on
157  * x86.  They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
158 #if HAVE_VALGRIND_MEMCHECK_H
159         /* memcheck.h includes valgrind.h */
160 #include <valgrind/memcheck.h>
161 #elif HAVE_VALGRIND_H
162 #include <valgrind.h>
163 #endif
164
165 /* we support ADS if we want it and have krb5 and ldap libs */
166 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
167 #define HAVE_ADS
168 #endif
169
170 /*
171  * Define additional missing types
172  */
173 #if defined(AIX)
174 typedef sig_atomic_t SIG_ATOMIC_T;
175 #else
176 typedef sig_atomic_t volatile SIG_ATOMIC_T;
177 #endif
178
179 #ifndef uchar
180 #define uchar unsigned char
181 #endif
182
183 /*
184    Samba needs type definitions for int16, int32, uint16 and uint32.
185
186    Normally these are signed and unsigned 16 and 32 bit integers, but
187    they actually only need to be at least 16 and 32 bits
188    respectively. Thus if your word size is 8 bytes just defining them
189    as signed and unsigned int will work.
190 */
191
192 #ifndef uint8
193 #define uint8 uint8_t
194 #endif
195
196 #if !defined(int16) && !defined(HAVE_INT16_FROM_RPC_RPC_H)
197 #  define int16 int16_t
198    /* needed to work around compile issue on HP-UX 11.x */
199 #  define _INT16        1
200 #endif
201
202 /*
203  * Note we duplicate the size tests in the unsigned 
204  * case as int16 may be a typedef from rpc/rpc.h
205  */
206
207
208 #if !defined(uint16) && !defined(HAVE_UINT16_FROM_RPC_RPC_H)
209 #  define uint16 uint16_t
210 #endif
211
212 #if !defined(int32) && !defined(HAVE_INT32_FROM_RPC_RPC_H)
213 #  define int32 int32_t
214 #  ifndef _INT32
215      /* needed to work around compile issue on HP-UX 11.x */
216 #    define _INT32      1
217 #  endif
218 #endif
219
220 /*
221  * Note we duplicate the size tests in the unsigned 
222  * case as int32 may be a typedef from rpc/rpc.h
223  */
224
225 #if !defined(uint32) && !defined(HAVE_UINT32_FROM_RPC_RPC_H)
226 #  define uint32 uint32_t
227 #endif
228
229 /*
230  * check for 8 byte long long
231  */
232
233 #if !defined(uint64)
234 #  define uint64 uint64_t
235 #endif
236
237 #if !defined(int64)
238 #  define int64 int64_t
239 #endif
240
241
242 /*
243  * Types for devices, inodes and offsets.
244  */
245
246 #ifndef SMB_DEV_T
247 # define SMB_DEV_T dev_t
248 #endif
249
250 #ifndef LARGE_SMB_DEV_T
251 #  if (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
252 #    define LARGE_SMB_DEV_T 1
253 #  endif
254 #endif
255
256 #ifdef LARGE_SMB_DEV_T
257 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
258 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
259 #else 
260 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
261 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
262 #endif
263
264 /*
265  * Setup the correctly sized inode type.
266  */
267
268 #ifndef SMB_INO_T
269 #    define SMB_INO_T ino_t
270 #endif
271
272 #ifndef LARGE_SMB_INO_T
273 #  if (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
274 #    define LARGE_SMB_INO_T 1
275 #  endif
276 #endif
277
278 #ifdef LARGE_SMB_INO_T
279 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, v)
280 #define INO_T_VAL(p, ofs) ((SMB_INO_T)BVAL(p, ofs))
281 #else 
282 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, ((uint64_t)(v)) & UINT32_MAX)
283 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
284 #endif
285
286 /* TODO: remove this macros */
287 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
288 #define BIG_UINT(p, ofs) BVAL(p, ofs)
289 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
290
291 /* this should really be a 64 bit type if possible */
292 typedef uint64_t br_off;
293
294 #define SMB_OFF_T_BITS (sizeof(off_t)*8)
295
296 /*
297  * Set the define that tells us if we can do 64 bit
298  * NT SMB calls.
299  */
300
301 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
302 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
303 #define IVAL_TO_SMB_OFF_T(buf,off) ((off_t)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
304
305 /*
306  * Type for stat structure.
307  */
308
309 struct stat_ex {
310         dev_t           st_ex_dev;
311         ino_t           st_ex_ino;
312         mode_t          st_ex_mode;
313         nlink_t         st_ex_nlink;
314         uid_t           st_ex_uid;
315         gid_t           st_ex_gid;
316         dev_t           st_ex_rdev;
317         off_t           st_ex_size;
318         struct timespec st_ex_atime;
319         struct timespec st_ex_mtime;
320         struct timespec st_ex_ctime;
321         struct timespec st_ex_btime; /* birthtime */
322         /* Is birthtime real, or was it calculated ? */
323         bool            st_ex_calculated_birthtime;
324         blksize_t       st_ex_blksize;
325         blkcnt_t        st_ex_blocks;
326
327         uint32_t        st_ex_flags;
328         uint32_t        st_ex_mask;
329
330         /*
331          * Add space for VFS internal extensions. The initial user of this
332          * would be the onefs modules, passing the snapid from the stat calls
333          * to the file_id_create call. Maybe we'll have to expand this later,
334          * but the core of Samba should never look at this field.
335          */
336         uint64_t vfs_private;
337 };
338
339 typedef struct stat_ex SMB_STRUCT_STAT;
340
341 /*
342  * Type for aiocb structure.
343  */
344
345 #ifndef SMB_STRUCT_AIOCB
346 #  if defined(HAVE_AIO)
347 #      define SMB_STRUCT_AIOCB struct aiocb
348 #  else
349 #    define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
350 #  endif
351 #endif
352
353 enum timestamp_set_resolution {
354         TIMESTAMP_SET_SECONDS = 0,
355         TIMESTAMP_SET_MSEC,
356         TIMESTAMP_SET_NT_OR_BETTER
357 };
358
359 /* Our own fstrings */
360
361 /*
362                   --------------
363                  /              \
364                 /      REST      \
365                /        IN        \
366               /       PEACE        \
367              /                      \
368              | The infamous pstring |
369              |                      |
370              |                      |
371              |      7 December      |
372              |                      |
373              |         2007         |
374             *|     *  *  *          | *
375    _________)/\\_//(\/(/\)/\//\/\///|_)_______
376 */
377
378 #ifndef FSTRING_LEN
379 #define FSTRING_LEN 256
380 typedef char fstring[FSTRING_LEN];
381 #endif
382
383 /* Lists, trees, caching, database... */
384 #include "../lib/util/samba_util.h"
385 #include "../lib/util/util_net.h"
386 #include "../lib/util/xfile.h"
387 #include "../lib/util/memory.h"
388 #include "../lib/util/attr.h"
389 #include "../lib/util/tsort.h"
390 #include "../lib/util/dlinklist.h"
391
392 #include <talloc.h>
393
394 #include "event.h"
395
396 #include "../lib/util/data_blob.h"
397 #include "../lib/util/time.h"
398 #include "../lib/util/debug.h"
399 #include "../lib/util/debug_s3.h"
400
401 #include "../libcli/util/ntstatus.h"
402 #include "../libcli/util/error.h"
403 #include "../lib/util/charset/charset.h"
404 #include "dynconfig/dynconfig.h"
405 #include "locking.h"
406 #include "smb_perfcount.h"
407 #include "smb.h"
408 #include "../lib/util/byteorder.h"
409
410 #include "../lib/util/samba_modules.h"
411 #include "../lib/util/talloc_stack.h"
412 #include "../lib/util/smb_threads.h"
413 #include "../lib/util/smb_threads_internal.h"
414
415 /* samba_setXXid functions. */
416 #include "../lib/util/setid.h"
417
418 /***** prototypes *****/
419 #ifndef NO_PROTO_H
420 #include "proto.h"
421 #endif
422
423 /* String routines */
424
425 #include "srvstr.h"
426 #include "safe_string.h"
427
428 #ifndef SIGCLD
429 #define SIGCLD SIGCHLD
430 #endif
431
432 #ifndef SIGRTMIN
433 #define SIGRTMIN NSIG
434 #endif
435
436 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
437 #define OSF1_ENH_SEC 1
438 #endif
439
440 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
441 #define ULTRIX_AUTH 1
442 #endif
443
444 /* yuck, I'd like a better way of doing this */
445 #define DIRP_SIZE (256 + 32)
446
447 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
448    given the socket IO pattern that Samba uses */
449 #ifdef TCP_NODELAY
450 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
451 #else
452 #define DEFAULT_SOCKET_OPTIONS ""
453 #endif
454
455 /* dmalloc -- free heap debugger (dmalloc.org).  This should be near
456  * the *bottom* of include files so as not to conflict. */
457 #ifdef ENABLE_DMALLOC
458 #  include <dmalloc.h>
459 #endif
460
461
462 #define MAX_SEC_CTX_DEPTH 8    /* Maximum number of security contexts */
463
464
465 /* add varargs prototypes with printf checking */
466 /*PRINTFLIKE2 */
467 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
468 /*PRINTFLIKE1 */
469 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
470 /*PRINTFLIKE2 */
471 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
472
473 /* PRINTFLIKE2 */
474 void sys_adminlog(int priority, const char *format_str, ...) PRINTF_ATTRIBUTE(2,3);
475
476 /* PRINTFLIKE2 */
477 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
478
479 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
480
481 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
482 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
483
484 /*
485  * Veritas File System.  Often in addition to native.
486  * Quotas different.
487  */
488 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
489 #define VXFS_QUOTA
490 #endif
491
492 #ifdef TRUE
493 #undef TRUE
494 #endif
495 #define TRUE __ERROR__XX__DONT_USE_TRUE
496
497 #ifdef FALSE
498 #undef FALSE
499 #endif
500 #define FALSE __ERROR__XX__DONT_USE_FALSE
501
502 /* If we have blacklisted mmap() try to avoid using it accidentally by
503    undefining the HAVE_MMAP symbol. */
504
505 #ifdef MMAP_BLACKLIST
506 #undef HAVE_MMAP
507 #endif
508
509 void dump_core(void) _NORETURN_;
510 void exit_server(const char *const reason) _NORETURN_;
511 void exit_server_cleanly(const char *const reason) _NORETURN_;
512
513 #define BASE_RID (0x000003E8L)
514
515 #endif /* _INCLUDES_H */