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 /* Special macros that are no-ops except when run under Valgrind on
 153  * x86.  They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
 154 #if HAVE_VALGRIND_MEMCHECK_H
 155         /* memcheck.h includes valgrind.h */
 156 #include <valgrind/memcheck.h>
 157 #elif HAVE_VALGRIND_H
 158 #include <valgrind.h>
 159 #endif
 160
 161 /* we support ADS if we want it and have krb5 and ldap libs */
 162 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
 163 #define HAVE_ADS
 164 #endif
 165
 166 /*
 167  * Define additional missing types
 168  */
 169 #if defined(AIX)
 170 typedef sig_atomic_t SIG_ATOMIC_T;
 171 #else
 172 typedef sig_atomic_t volatile SIG_ATOMIC_T;
 173 #endif
 174
 175 #ifndef uchar
 176 #define uchar unsigned char
 177 #endif
 178
 179 /*
 180  * Types for devices, inodes and offsets.
 181  */
 182
 183 #ifndef SMB_DEV_T
 184 # define SMB_DEV_T dev_t
 185 #endif
 186
 187 #ifndef LARGE_SMB_DEV_T
 188 #  if (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
 189 #    define LARGE_SMB_DEV_T 1
 190 #  endif
 191 #endif
 192
 193 #ifdef LARGE_SMB_DEV_T
 194 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
 195 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
 196 #else
 197 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
 198 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
 199 #endif
 200
 201 /*
 202  * Setup the correctly sized inode type.
 203  */
 204
 205 #ifndef SMB_INO_T
 206 #    define SMB_INO_T ino_t
 207 #endif
 208
 209 #ifndef LARGE_SMB_INO_T
 210 #  if (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
 211 #    define LARGE_SMB_INO_T 1
 212 #  endif
 213 #endif
 214
 215 #ifdef LARGE_SMB_INO_T
 216 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, v)
 217 #define INO_T_VAL(p, ofs) ((SMB_INO_T)BVAL(p, ofs))
 218 #else
 219 #define SINO_T_VAL(p, ofs, v) SBVAL(p, ofs, ((uint64_t)(v)) & UINT32_MAX)
 220 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
 221 #endif
 222
 223 /* TODO: remove this macros */
 224 #define SBIG_UINT(p, ofs, v) SBVAL(p, ofs, v)
 225 #define BIG_UINT(p, ofs) BVAL(p, ofs)
 226 #define IVAL2_TO_SMB_BIG_UINT(p, ofs) BVAL(p, ofs)
 227
 228 /* this should really be a 64 bit type if possible */
 229 typedef uint64_t br_off;
 230
 231 #define SMB_OFF_T_BITS (sizeof(off_t)*8)
 232
 233 /*
 234  * Set the define that tells us if we can do 64 bit
 235  * NT SMB calls.
 236  */
 237
 238 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
 239 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
 240 #define IVAL_TO_SMB_OFF_T(buf,off) ((off_t)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
 241
 242 /*
 243  * Type for stat structure.
 244  */
 245
 246 struct stat_ex {
 247         dev_t           st_ex_dev;
 248         ino_t           st_ex_ino;
 249         mode_t          st_ex_mode;
 250         nlink_t         st_ex_nlink;
 251         uid_t           st_ex_uid;
 252         gid_t           st_ex_gid;
 253         dev_t           st_ex_rdev;
 254         off_t           st_ex_size;
 255         struct timespec st_ex_atime;
 256         struct timespec st_ex_mtime;
 257         struct timespec st_ex_ctime;
 258         struct timespec st_ex_btime; /* birthtime */
 259         /* Is birthtime real, or was it calculated ? */
 260         bool            st_ex_calculated_birthtime;
 261         blksize_t       st_ex_blksize;
 262         blkcnt_t        st_ex_blocks;
 263
 264         uint32_t        st_ex_flags;
 265         uint32_t        st_ex_mask;
 266 };
 267
 268 typedef struct stat_ex SMB_STRUCT_STAT;
 269
 270 enum timestamp_set_resolution {
 271         TIMESTAMP_SET_SECONDS = 0,
 272         TIMESTAMP_SET_MSEC,
 273         TIMESTAMP_SET_NT_OR_BETTER
 274 };
 275
 276 /* Our own fstrings */
 277
 278 /*
 279                   --------------
 280                  /              \
 281                 /      REST      \
 282                /        IN        \
 283               /       PEACE        \
 284              /                      \
 285              | The infamous pstring |
 286              |                      |
 287              |                      |
 288              |      7 December      |
 289              |                      |
 290              |         2007         |
 291             *|     *  *  *          | *
 292    _________)/\\_//(\/(/\)/\//\/\///|_)_______
 293 */
 294
 295 #ifndef FSTRING_LEN
 296 #define FSTRING_LEN 256
 297 typedef char fstring[FSTRING_LEN];
 298 #endif
 299
 300 /* debug.h need to be included before samba_util.h for the macro SMB_ASSERT */
 301 #include "../lib/util/debug.h"
 302
 303 /* Lists, trees, caching, database... */
 304 #include "../lib/util/samba_util.h"
 305 #include "../lib/util/util_net.h"
 306 #include "../lib/util/xfile.h"
 307 #include "../lib/util/memory.h"
 308 #include "../lib/util/attr.h"
 309 #include "../lib/util/tsort.h"
 310 #include "../lib/util/dlinklist.h"
 311
 312 #include <talloc.h>
 313
 314 #include "event.h"
 315
 316 #include "../lib/util/data_blob.h"
 317 #include "../lib/util/time.h"
 318 #include "../lib/util/debug_s3.h"
 319
 320 #include "../libcli/util/ntstatus.h"
 321 #include "../libcli/util/error.h"
 322 #include "../lib/util/charset/charset.h"
 323 #include "dynconfig/dynconfig.h"
 324 #include "locking.h"
 325 #include "smb_perfcount.h"
 326 #include "smb.h"
 327 #include "../lib/util/byteorder.h"
 328
 329 #include "../lib/util/samba_modules.h"
 330 #include "../lib/util/talloc_stack.h"
 331 #include "../lib/util/smb_threads.h"
 332 #include "../lib/util/smb_threads_internal.h"
 333
 334 /* samba_setXXid functions. */
 335 #include "../lib/util/setid.h"
 336
 337 /***** prototypes *****/
 338 #ifndef NO_PROTO_H
 339 #include "proto.h"
 340 #endif
 341
 342 #include "lib/param/loadparm.h"
 343
 344 /* String routines */
 345
 346 #include "srvstr.h"
 347 #include "safe_string.h"
 348
 349 #ifndef SIGCLD
 350 #define SIGCLD SIGCHLD
 351 #endif
 352
 353 #ifndef SIGRTMIN
 354 #define SIGRTMIN NSIG
 355 #endif
 356
 357
 358 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
 359 #define ULTRIX_AUTH 1
 360 #endif
 361
 362 /* yuck, I'd like a better way of doing this */
 363 #define DIRP_SIZE (256 + 32)
 364
 365 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
 366    given the socket IO pattern that Samba uses */
 367 #ifdef TCP_NODELAY
 368 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
 369 #else
 370 #define DEFAULT_SOCKET_OPTIONS ""
 371 #endif
 372
 373 /* dmalloc -- free heap debugger (dmalloc.org).  This should be near
 374  * the *bottom* of include files so as not to conflict. */
 375 #ifdef ENABLE_DMALLOC
 376 #  include <dmalloc.h>
 377 #endif
 378
 379
 380 #define MAX_SEC_CTX_DEPTH 8    /* Maximum number of security contexts */
 381
 382
 383 /* add varargs prototypes with printf checking */
 384 /*PRINTFLIKE2 */
 385 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
 386 /*PRINTFLIKE1 */
 387 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
 388 /*PRINTFLIKE2 */
 389 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 390
 391 /* PRINTFLIKE2 */
 392 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 393
 394 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 395
 396 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 397 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 398
 399 /*
 400  * Veritas File System.  Often in addition to native.
 401  * Quotas different.
 402  */
 403 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
 404 #define VXFS_QUOTA
 405 #endif
 406
 407 #ifdef TRUE
 408 #undef TRUE
 409 #endif
 410 #define TRUE __ERROR__XX__DONT_USE_TRUE
 411
 412 #ifdef FALSE
 413 #undef FALSE
 414 #endif
 415 #define FALSE __ERROR__XX__DONT_USE_FALSE
 416
 417 /* If we have blacklisted mmap() try to avoid using it accidentally by
 418    undefining the HAVE_MMAP symbol. */
 419
 420 #ifdef MMAP_BLACKLIST
 421 #undef HAVE_MMAP
 422 #endif
 423
 424 void dump_core(void) _NORETURN_;
 425 void exit_server(const char *const reason) _NORETURN_;
 426 void exit_server_cleanly(const char *const reason) _NORETURN_;
 427
 428 #define BASE_RID (0x000003E8L)
 429
 430 #endif /* _INCLUDES_H */