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 /* 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
 146
 147 #ifdef HAVE_SYS_EA_H
 148 #include <sys/ea.h>
 149 #endif
 150
 151 #ifdef HAVE_SYS_EXTATTR_H
 152 #include <sys/extattr.h>
 153 #endif
 154
 155 #ifdef HAVE_SYS_UIO_H
 156 #include <sys/uio.h>
 157 #endif
 158
 159 #if HAVE_LANGINFO_H
 160 #include <langinfo.h>
 161 #endif
 162
 163 #if HAVE_NETGROUP_H
 164 #include <netgroup.h>
 165 #endif
 166
 167 #if defined(HAVE_AIO_H) && defined(WITH_AIO)
 168 #include <aio.h>
 169 #endif
 170
 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
 179
 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
 184
 185 /*
 186  * Define additional missing types
 187  */
 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
 193
 194 #ifndef uchar
 195 #define uchar unsigned char
 196 #endif
 197
 198 /*
 199    Samba needs type definitions for int16, int32, uint16 and uint32.
 200
 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.
 205 */
 206
 207 #ifndef uint8
 208 #define uint8 uint8_t
 209 #endif
 210
 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
 216
 217 /*
 218  * Note we duplicate the size tests in the unsigned
 219  * case as int16 may be a typedef from rpc/rpc.h
 220  */
 221
 222
 223 #if !defined(uint16) && !defined(HAVE_UINT16_FROM_RPC_RPC_H)
 224 #  define uint16 uint16_t
 225 #endif
 226
 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
 234
 235 /*
 236  * Note we duplicate the size tests in the unsigned
 237  * case as int32 may be a typedef from rpc/rpc.h
 238  */
 239
 240 #if !defined(uint32) && !defined(HAVE_UINT32_FROM_RPC_RPC_H)
 241 #  define uint32 uint32_t
 242 #endif
 243
 244 /*
 245  * check for 8 byte long long
 246  */
 247
 248 #if !defined(uint64)
 249 #  define uint64 uint64_t
 250 #endif
 251
 252 #if !defined(int64)
 253 #  define int64 int64_t
 254 #endif
 255
 256
 257 /*
 258  * Types for devices, inodes and offsets.
 259  */
 260
 261 #ifndef SMB_DEV_T
 262 # define SMB_DEV_T dev_t
 263 #endif
 264
 265 #ifndef LARGE_SMB_DEV_T
 266 #  if (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
 267 #    define LARGE_SMB_DEV_T 1
 268 #  endif
 269 #endif
 270
 271 #ifdef LARGE_SMB_DEV_T
 272 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
 273 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
 274 #else
 275 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
 276 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
 277 #endif
 278
 279 /*
 280  * Setup the correctly sized inode type.
 281  */
 282
 283 #ifndef SMB_INO_T
 284 #    define SMB_INO_T ino_t
 285 #endif
 286
 287 #ifndef LARGE_SMB_INO_T
 288 #  if (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
 289 #    define LARGE_SMB_INO_T 1
 290 #  endif
 291 #endif
 292
 293 #ifdef LARGE_SMB_INO_T
 294 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, v)
 295 #define INO_T_VAL(p, ofs) ((SMB_INO_T)BVAL(p, ofs))
 296 #else
 297 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, ((uint64_t)(v)) & UINT32_MAX)
 298 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
 299 #endif
 300
 301 /* TODO: remove this macros */
 302 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
 303 #define BIG_UINT(p, ofs) BVAL(p, ofs)
 304 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
 305
 306 /* this should really be a 64 bit type if possible */
 307 typedef uint64_t br_off;
 308
 309 #define SMB_OFF_T_BITS (sizeof(off_t)*8)
 310
 311 /*
 312  * Set the define that tells us if we can do 64 bit
 313  * NT SMB calls.
 314  */
 315
 316 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
 317 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
 318 #define IVAL_TO_SMB_OFF_T(buf,off) ((off_t)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
 319
 320 /*
 321  * Type for stat structure.
 322  */
 323
 324 struct stat_ex {
 325         dev_t           st_ex_dev;
 326         ino_t           st_ex_ino;
 327         mode_t          st_ex_mode;
 328         nlink_t         st_ex_nlink;
 329         uid_t           st_ex_uid;
 330         gid_t           st_ex_gid;
 331         dev_t           st_ex_rdev;
 332         off_t           st_ex_size;
 333         struct timespec st_ex_atime;
 334         struct timespec st_ex_mtime;
 335         struct timespec st_ex_ctime;
 336         struct timespec st_ex_btime; /* birthtime */
 337         /* Is birthtime real, or was it calculated ? */
 338         bool            st_ex_calculated_birthtime;
 339         blksize_t       st_ex_blksize;
 340         blkcnt_t        st_ex_blocks;
 341
 342         uint32_t        st_ex_flags;
 343         uint32_t        st_ex_mask;
 344
 345         /*
 346          * Add space for VFS internal extensions. The initial user of this
 347          * would be the onefs modules, passing the snapid from the stat calls
 348          * to the file_id_create call. Maybe we'll have to expand this later,
 349          * but the core of Samba should never look at this field.
 350          */
 351         uint64_t vfs_private;
 352 };
 353
 354 typedef struct stat_ex SMB_STRUCT_STAT;
 355
 356 /*
 357  * Type for aiocb structure.
 358  */
 359
 360 #ifndef SMB_STRUCT_AIOCB
 361 #  if defined(WITH_AIO)
 362 #      define SMB_STRUCT_AIOCB struct aiocb
 363 #  else
 364 #    define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
 365 #  endif
 366 #endif
 367
 368 enum timestamp_set_resolution {
 369         TIMESTAMP_SET_SECONDS = 0,
 370         TIMESTAMP_SET_MSEC,
 371         TIMESTAMP_SET_NT_OR_BETTER
 372 };
 373
 374 /* Our own fstrings */
 375
 376 /*
 377                   --------------
 378                  /              \
 379                 /      REST      \
 380                /        IN        \
 381               /       PEACE        \
 382              /                      \
 383              | The infamous pstring |
 384              |                      |
 385              |                      |
 386              |      7 December      |
 387              |                      |
 388              |         2007         |
 389             *|     *  *  *          | *
 390    _________)/\\_//(\/(/\)/\//\/\///|_)_______
 391 */
 392
 393 #ifndef FSTRING_LEN
 394 #define FSTRING_LEN 256
 395 typedef char fstring[FSTRING_LEN];
 396 #endif
 397
 398 /* Lists, trees, caching, database... */
 399 #include "../lib/util/samba_util.h"
 400 #include "../lib/util/util_net.h"
 401 #include "../lib/util/xfile.h"
 402 #include "../lib/util/memory.h"
 403 #include "../lib/util/attr.h"
 404 #include "../lib/util/tsort.h"
 405 #include "../lib/util/dlinklist.h"
 406
 407 #include <talloc.h>
 408
 409 #include "event.h"
 410
 411 #include "../lib/util/data_blob.h"
 412 #include "../lib/util/time.h"
 413 #include "../lib/util/debug.h"
 414 #include "../lib/util/debug_s3.h"
 415
 416 #include "../libcli/util/ntstatus.h"
 417 #include "../libcli/util/error.h"
 418 #include "../lib/util/charset/charset.h"
 419 #include "dynconfig/dynconfig.h"
 420 #include "locking.h"
 421 #include "smb_perfcount.h"
 422 #include "smb.h"
 423 #include "../lib/util/byteorder.h"
 424
 425 #include "../lib/util/samba_modules.h"
 426 #include "../lib/util/talloc_stack.h"
 427 #include "../lib/util/smb_threads.h"
 428 #include "../lib/util/smb_threads_internal.h"
 429
 430 /***** prototypes *****/
 431 #ifndef NO_PROTO_H
 432 #include "proto.h"
 433 #endif
 434
 435 /* String routines */
 436
 437 #include "srvstr.h"
 438 #include "safe_string.h"
 439
 440 #ifndef SIGCLD
 441 #define SIGCLD SIGCHLD
 442 #endif
 443
 444 #ifndef SIGRTMIN
 445 #define SIGRTMIN NSIG
 446 #endif
 447
 448 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
 449 #define OSF1_ENH_SEC 1
 450 #endif
 451
 452 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
 453 #define ULTRIX_AUTH 1
 454 #endif
 455
 456 /* yuck, I'd like a better way of doing this */
 457 #define DIRP_SIZE (256 + 32)
 458
 459 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
 460    given the socket IO pattern that Samba uses */
 461 #ifdef TCP_NODELAY
 462 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
 463 #else
 464 #define DEFAULT_SOCKET_OPTIONS ""
 465 #endif
 466
 467 /* dmalloc -- free heap debugger (dmalloc.org).  This should be near
 468  * the *bottom* of include files so as not to conflict. */
 469 #ifdef ENABLE_DMALLOC
 470 #  include <dmalloc.h>
 471 #endif
 472
 473
 474 #define MAX_SEC_CTX_DEPTH 8    /* Maximum number of security contexts */
 475
 476
 477 /* add varargs prototypes with printf checking */
 478 /*PRINTFLIKE2 */
 479 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
 480 /*PRINTFLIKE1 */
 481 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
 482 /*PRINTFLIKE2 */
 483 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 484
 485 /* PRINTFLIKE2 */
 486 void sys_adminlog(int priority, const char *format_str, ...) PRINTF_ATTRIBUTE(2,3);
 487
 488 /* PRINTFLIKE2 */
 489 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 490
 491 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 492
 493 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 494 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 495
 496 /*
 497  * Veritas File System.  Often in addition to native.
 498  * Quotas different.
 499  */
 500 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
 501 #define VXFS_QUOTA
 502 #endif
 503
 504 #ifndef XATTR_CREATE
 505 #define XATTR_CREATE  0x1       /* set value, fail if attr already exists */
 506 #endif
 507
 508 #ifndef XATTR_REPLACE
 509 #define XATTR_REPLACE 0x2       /* set value, fail if attr does not exist */
 510 #endif
 511
 512 #ifdef TRUE
 513 #undef TRUE
 514 #endif
 515 #define TRUE __ERROR__XX__DONT_USE_TRUE
 516
 517 #ifdef FALSE
 518 #undef FALSE
 519 #endif
 520 #define FALSE __ERROR__XX__DONT_USE_FALSE
 521
 522 /* If we have blacklisted mmap() try to avoid using it accidentally by
 523    undefining the HAVE_MMAP symbol. */
 524
 525 #ifdef MMAP_BLACKLIST
 526 #undef HAVE_MMAP
 527 #endif
 528
 529 void dump_core(void) _NORETURN_;
 530 void exit_server(const char *const reason) _NORETURN_;
 531 void exit_server_cleanly(const char *const reason) _NORETURN_;
 532
 533 #define BASE_RID (0x000003E8L)
 534
 535 #endif /* _INCLUDES_H */