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 #ifndef SMB_OFF_T
 302 #    define SMB_OFF_T off_t
 303 #endif
 304
 305 /* TODO: remove this macros */
 306 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
 307 #define BIG_UINT(p, ofs) BVAL(p, ofs)
 308 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
 309
 310 /* this should really be a 64 bit type if possible */
 311 typedef uint64_t br_off;
 312
 313 #define SMB_OFF_T_BITS (sizeof(SMB_OFF_T)*8)
 314
 315 /*
 316  * Set the define that tells us if we can do 64 bit
 317  * NT SMB calls.
 318  */
 319
 320 #ifndef LARGE_SMB_OFF_T
 321 #  if (defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T == 8))
 322 #    define LARGE_SMB_OFF_T 1
 323 #  endif
 324 #endif
 325
 326 #ifdef LARGE_SMB_OFF_T
 327 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
 328 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
 329 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
 330 #else
 331 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,v),SIVAL(p,(ofs)+4,0))
 332 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,v),SIVAL(p,ofs,0))
 333 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint32)(IVAL((buf),(off)))) & 0xFFFFFFFF )))
 334 #endif
 335
 336 #ifndef HAVE_BLKSIZE_T
 337 /* This is mainly for HP/UX which defines st_blksize as long */
 338 typedef long blksize_t;
 339 #endif
 340
 341 #ifndef HAVE_BLKCNT_T
 342 /* This is mainly for HP/UX which doesn't have blkcnt_t */
 343 typedef long blkcnt_t;
 344 #endif
 345
 346 /*
 347  * Type for stat structure.
 348  */
 349
 350 struct stat_ex {
 351         dev_t           st_ex_dev;
 352         ino_t           st_ex_ino;
 353         mode_t          st_ex_mode;
 354         nlink_t         st_ex_nlink;
 355         uid_t           st_ex_uid;
 356         gid_t           st_ex_gid;
 357         dev_t           st_ex_rdev;
 358         off_t           st_ex_size;
 359         struct timespec st_ex_atime;
 360         struct timespec st_ex_mtime;
 361         struct timespec st_ex_ctime;
 362         struct timespec st_ex_btime; /* birthtime */
 363         /* Is birthtime real, or was it calculated ? */
 364         bool            st_ex_calculated_birthtime;
 365         blksize_t       st_ex_blksize;
 366         blkcnt_t        st_ex_blocks;
 367
 368         uint32_t        st_ex_flags;
 369         uint32_t        st_ex_mask;
 370
 371         /*
 372          * Add space for VFS internal extensions. The initial user of this
 373          * would be the onefs modules, passing the snapid from the stat calls
 374          * to the file_id_create call. Maybe we'll have to expand this later,
 375          * but the core of Samba should never look at this field.
 376          */
 377         uint64_t vfs_private;
 378 };
 379
 380 typedef struct stat_ex SMB_STRUCT_STAT;
 381
 382 /*
 383  * Type for dirent structure.
 384  */
 385
 386 #ifndef SMB_STRUCT_DIRENT
 387 #    define SMB_STRUCT_DIRENT struct dirent
 388 #endif
 389
 390 /*
 391  * Type for DIR structure.
 392  */
 393
 394 #ifndef SMB_STRUCT_DIR
 395 #    define SMB_STRUCT_DIR DIR
 396 #endif
 397
 398 /*
 399  * Defines for 64 bit fcntl locks.
 400  */
 401
 402 #ifndef SMB_STRUCT_FLOCK
 403 #    define SMB_STRUCT_FLOCK struct flock
 404 #endif
 405
 406 #ifndef SMB_F_SETLKW
 407 #    define SMB_F_SETLKW F_SETLKW
 408 #endif
 409
 410 #ifndef SMB_F_SETLK
 411 #    define SMB_F_SETLK F_SETLK
 412 #endif
 413
 414 #ifndef SMB_F_GETLK
 415 #    define SMB_F_GETLK F_GETLK
 416 #endif
 417
 418 /*
 419  * Type for aiocb structure.
 420  */
 421
 422 #ifndef SMB_STRUCT_AIOCB
 423 #  if defined(WITH_AIO)
 424 #      define SMB_STRUCT_AIOCB struct aiocb
 425 #  else
 426 #    define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
 427 #  endif
 428 #endif
 429
 430 enum timestamp_set_resolution {
 431         TIMESTAMP_SET_SECONDS = 0,
 432         TIMESTAMP_SET_MSEC,
 433         TIMESTAMP_SET_NT_OR_BETTER
 434 };
 435
 436 /* Our own fstrings */
 437
 438 /*
 439                   --------------
 440                  /              \
 441                 /      REST      \
 442                /        IN        \
 443               /       PEACE        \
 444              /                      \
 445              | The infamous pstring |
 446              |                      |
 447              |                      |
 448              |      7 December      |
 449              |                      |
 450              |         2007         |
 451             *|     *  *  *          | *
 452    _________)/\\_//(\/(/\)/\//\/\///|_)_______
 453 */
 454
 455 #ifndef FSTRING_LEN
 456 #define FSTRING_LEN 256
 457 typedef char fstring[FSTRING_LEN];
 458 #endif
 459
 460 /* Lists, trees, caching, database... */
 461 #include "../lib/util/samba_util.h"
 462 #include "../lib/util/util_net.h"
 463 #include "../lib/util/xfile.h"
 464 #include "../lib/util/memory.h"
 465 #include "../lib/util/attr.h"
 466 #include "../lib/util/tsort.h"
 467 #include "../lib/util/dlinklist.h"
 468
 469 #include <talloc.h>
 470
 471 #include "event.h"
 472
 473 #include "../lib/util/data_blob.h"
 474 #include "../lib/util/time.h"
 475 #include "../lib/util/debug.h"
 476 #include "../lib/util/debug_s3.h"
 477
 478 #include "../libcli/util/ntstatus.h"
 479 #include "../libcli/util/error.h"
 480 #include "../lib/util/charset/charset.h"
 481 #include "dynconfig/dynconfig.h"
 482 #include "locking.h"
 483 #include "smb_perfcount.h"
 484 #include "smb.h"
 485 #include "../lib/util/byteorder.h"
 486
 487 #include "../lib/util/samba_modules.h"
 488 #include "../lib/util/talloc_stack.h"
 489 #include "../lib/util/smb_threads.h"
 490 #include "../lib/util/smb_threads_internal.h"
 491
 492 /***** prototypes *****/
 493 #ifndef NO_PROTO_H
 494 #include "proto.h"
 495 #endif
 496
 497 /* String routines */
 498
 499 #include "srvstr.h"
 500 #include "safe_string.h"
 501
 502 #ifndef SIGCLD
 503 #define SIGCLD SIGCHLD
 504 #endif
 505
 506 #ifndef SIGRTMIN
 507 #define SIGRTMIN NSIG
 508 #endif
 509
 510 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
 511 #define OSF1_ENH_SEC 1
 512 #endif
 513
 514 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
 515 #define ULTRIX_AUTH 1
 516 #endif
 517
 518 /* yuck, I'd like a better way of doing this */
 519 #define DIRP_SIZE (256 + 32)
 520
 521 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
 522    given the socket IO pattern that Samba uses */
 523 #ifdef TCP_NODELAY
 524 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
 525 #else
 526 #define DEFAULT_SOCKET_OPTIONS ""
 527 #endif
 528
 529 /* dmalloc -- free heap debugger (dmalloc.org).  This should be near
 530  * the *bottom* of include files so as not to conflict. */
 531 #ifdef ENABLE_DMALLOC
 532 #  include <dmalloc.h>
 533 #endif
 534
 535
 536 #define MAX_SEC_CTX_DEPTH 8    /* Maximum number of security contexts */
 537
 538
 539 #ifdef GLIBC_HACK_FCNTL64
 540 /* this is a gross hack. 64 bit locking is completely screwed up on
 541    i386 Linux in glibc 2.1.95 (which ships with RedHat 7.0). This hack
 542    "fixes" the problem with the current 2.4.0test kernels
 543 */
 544 #define fcntl fcntl64
 545 #undef F_SETLKW
 546 #undef F_SETLK
 547 #define F_SETLK 13
 548 #define F_SETLKW 14
 549 #endif
 550
 551
 552 /* add varargs prototypes with printf checking */
 553 /*PRINTFLIKE2 */
 554 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
 555 /*PRINTFLIKE1 */
 556 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
 557 /*PRINTFLIKE2 */
 558 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 559
 560 /* PRINTFLIKE2 */
 561 void sys_adminlog(int priority, const char *format_str, ...) PRINTF_ATTRIBUTE(2,3);
 562
 563 /* PRINTFLIKE2 */
 564 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 565
 566 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 567
 568 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 569 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 570
 571 /*
 572  * Veritas File System.  Often in addition to native.
 573  * Quotas different.
 574  */
 575 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
 576 #define VXFS_QUOTA
 577 #endif
 578
 579 #ifndef XATTR_CREATE
 580 #define XATTR_CREATE  0x1       /* set value, fail if attr already exists */
 581 #endif
 582
 583 #ifndef XATTR_REPLACE
 584 #define XATTR_REPLACE 0x2       /* set value, fail if attr does not exist */
 585 #endif
 586
 587 #ifdef TRUE
 588 #undef TRUE
 589 #endif
 590 #define TRUE __ERROR__XX__DONT_USE_TRUE
 591
 592 #ifdef FALSE
 593 #undef FALSE
 594 #endif
 595 #define FALSE __ERROR__XX__DONT_USE_FALSE
 596
 597 /* If we have blacklisted mmap() try to avoid using it accidentally by
 598    undefining the HAVE_MMAP symbol. */
 599
 600 #ifdef MMAP_BLACKLIST
 601 #undef HAVE_MMAP
 602 #endif
 603
 604 void dump_core(void) _NORETURN_;
 605 void exit_server(const char *const reason) _NORETURN_;
 606 void exit_server_cleanly(const char *const reason) _NORETURN_;
 607
 608 #define BASE_RID (0x000003E8L)
 609
 610 #endif /* _INCLUDES_H */