source4/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 2 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, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #ifndef NO_CONFIG_H /* for some tests */
  25 #include "config.h"
  26 #include "smb_build.h"
  27 #endif
  28
  29 #include "local.h"
  30
  31 #if (__GNUC__ >= 3)
  32 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
  33  * the parameter containing the format, and a2 the index of the first
  34  * argument. Note that some gcc 2.x versions don't handle this
  35  * properly **/
  36 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
  37 #else
  38 #define PRINTF_ATTRIBUTE(a1, a2)
  39 #endif
  40
  41 #ifdef __GNUC__
  42 /** gcc attribute used on function parameters so that it does not emit
  43  * warnings about them being unused. **/
  44 #  define UNUSED(param) param __attribute__ ((unused))
  45 #else
  46 #  define UNUSED(param) param
  47 /** Feel free to add definitions for other compilers here. */
  48 #endif
  49
  50 #include <sys/types.h>
  51 #include <stdio.h>
  52 #include <stdlib.h>
  53 #include <stddef.h>
  54
  55 #ifdef HAVE_STDINT_H
  56 #include <stdint.h>
  57 #endif
  58
  59 #ifdef HAVE_STRING_H
  60 #include <string.h>
  61 #endif
  62
  63 #include <signal.h>
  64 #include <errno.h>
  65
  66 #ifdef HAVE_STDARG_H
  67 #include <stdarg.h>
  68 #else
  69 #include <varargs.h>
  70 #endif
  71
  72 /* we support ADS if we want it and have krb5 and ldap libs */
  73 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
  74 #define HAVE_ADS
  75 #endif
  76
  77 /*
  78  * Define VOLATILE if needed.
  79  */
  80
  81 #if defined(HAVE_VOLATILE)
  82 #define VOLATILE volatile
  83 #else
  84 #define VOLATILE
  85 #endif
  86
  87 /*
  88    Samba needs type definitions for
  89    int8_t,  int16_t,  int32_t, int64_t
  90    uint8_t, uint16_t, uint32_t and uint64_t.
  91
  92    Normally these are signed and unsigned 8, 16, 32 and 64 bit integers, but
  93    they actually only need to be at least 8, 16, 32 and 64 bits
  94    respectively. Thus if your word size is 8 bytes just defining them
  95    as signed and unsigned int will work.
  96 */
  97
  98 #if !defined(int8)
  99 #define int8 int8_t
 100 #endif
 101
 102 #if !defined(uint8)
 103 #define uint8 uint8_t
 104 #endif
 105
 106 #if !defined(int16)
 107 #define int16 int16_t
 108 #endif
 109
 110 #if !defined(uint16)
 111 #define uint16 uint16_t
 112 #endif
 113
 114 #if !defined(int32)
 115 #define int32 int32_t
 116 #endif
 117
 118 #if !defined(uint32)
 119 #define uint32 uint32_t
 120 #endif
 121
 122 #if !defined(int64)
 123 #define int64 int64_t
 124 #endif
 125
 126 #if !defined(uint64)
 127 #define uint64 uint64_t
 128 #endif
 129
 130 #define False (0)
 131 #define True (1)
 132 #define Auto (2)
 133
 134 typedef int BOOL;
 135
 136 /*
 137   we use struct ipv4_addr to avoid having to include all the
 138   system networking headers everywhere
 139 */
 140 struct ipv4_addr {
 141         uint32_t addr;
 142 };
 143
 144 #ifndef HAVE_STRERROR
 145 extern char *sys_errlist[];
 146 #define strerror(i) sys_errlist[i]
 147 #endif
 148
 149 #ifndef HAVE_ERRNO_DECL
 150 extern int errno;
 151 #endif
 152
 153 /* Lists, trees, caching, database... */
 154 #include "version.h"
 155 #include "xfile.h"
 156 #include "talloc.h"
 157 #include "lib/ldb/include/ldb.h"
 158 #include "lib/tdb/include/tdb.h"
 159 #include "lib/tdb/include/spinlock.h"
 160 #include "lib/tdb/include/tdbutil.h"
 161 #include "db_wrap.h"
 162 #include "nt_status.h"
 163 #include "trans2.h"
 164 #include "nterr.h"
 165 #include "charset.h"
 166 #include "debug.h"
 167 #include "doserr.h"
 168 #include "enums.h"
 169 #include "pstring.h"
 170 #include "smb_macros.h"
 171 #include "rpc_secdes.h"
 172 #include "smb.h"
 173 #include "ads.h"
 174 #include "lib/socket/socket.h"
 175 #include "libcli/ldap/ldap.h"
 176 #include "nameserv.h"
 177 #include "byteorder.h"
 178 #include "module.h"
 179 #include "mutex.h"
 180 #include "librpc/ndr/libndr.h"
 181 #include "librpc/ndr/ndr_sec.h"
 182 #include "librpc/gen_ndr/ndr_misc.h"
 183 #include "librpc/gen_ndr/ndr_dcerpc.h"
 184 #include "librpc/rpc/dcerpc.h"
 185 #include "librpc/gen_ndr/ndr_dcom.h"
 186 #include "lib/dcom/common/dcom.h"
 187 #include "smb_interfaces.h"
 188 #include "smbd/server.h"
 189 #include "smbd/service.h"
 190 #include "structs.h"
 191 #include "ntvfs/ntvfs.h"
 192 #include "cli_context.h"
 193 #include "nsswitch/winbind_client.h"
 194
 195 #define malloc_p(type) (type *)malloc(sizeof(type))
 196 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
 197 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
 198
 199 #ifndef HAVE_COMPARISON_FN_T
 200 typedef int (*comparison_fn_t)(const void *, const void *);
 201 #endif
 202
 203 /***** automatically generated prototypes *****/
 204 #define _PRINTF_ATTRIBUTE(a1, a2) PRINTF_ATTRIBUTE(a1, a2)
 205 #include "proto.h"
 206 #undef _PRINTF_ATTRIBUTE
 207 #define _PRINTF_ATTRIBUTE(a1, a2)
 208
 209 /* String routines */
 210
 211 #include "safe_string.h"
 212
 213 #ifdef __COMPAR_FN_T
 214 #define QSORT_CAST (__compar_fn_t)
 215 #endif
 216
 217 #ifndef QSORT_CAST
 218 #define QSORT_CAST (int (*)(const void *, const void *))
 219 #endif
 220
 221 #ifndef HAVE_PIPE
 222 #define SYNC_DNS 1
 223 #endif
 224
 225 #ifndef HAVE_STRDUP
 226 char *strdup(const char *s);
 227 #endif
 228
 229 #ifndef HAVE_MEMMOVE
 230 void *memmove(void *dest,const void *src,int size);
 231 #endif
 232
 233 #ifndef HAVE_MKTIME
 234 time_t mktime(struct tm *t);
 235 #endif
 236
 237 #ifndef HAVE_STRLCPY
 238 size_t strlcpy(char *d, const char *s, size_t bufsize);
 239 #endif
 240
 241 #ifndef HAVE_STRLCAT
 242 size_t strlcat(char *d, const char *s, size_t bufsize);
 243 #endif
 244
 245 #ifndef HAVE_STRNDUP
 246 char *strndup(const char *s, size_t n);
 247 #endif
 248
 249 #ifndef HAVE_STRNLEN
 250 size_t strnlen(const char *s, size_t n);
 251 #endif
 252
 253 #ifndef HAVE_STRTOUL
 254 unsigned long strtoul(const char *nptr, char **endptr, int base);
 255 #endif
 256
 257 #ifndef HAVE_SETENV
 258 int setenv(const char *name, const char *value, int overwrite);
 259 #endif
 260
 261 #ifndef HAVE_VASPRINTF_DECL
 262 int vasprintf(char **ptr, const char *format, va_list ap);
 263 #endif
 264
 265 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 266 #define bzero(a,b) memset((a),'\0',(b))
 267 #endif
 268
 269 extern int DEBUGLEVEL;
 270
 271 /* add varargs prototypes with printf checking */
 272 #ifndef HAVE_SNPRINTF_DECL
 273 int snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 274 #endif
 275 #ifndef HAVE_ASPRINTF_DECL
 276 int asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 277 #endif
 278
 279
 280 /* we used to use these fns, but now we have good replacements
 281    for snprintf and vsnprintf */
 282 #define slprintf snprintf
 283
 284
 285 /* we need to use __va_copy() on some platforms */
 286 #ifdef HAVE_VA_COPY
 287 #define VA_COPY(dest, src) __va_copy(dest, src)
 288 #else
 289 #define VA_COPY(dest, src) (dest) = (src)
 290 #endif
 291
 292 #if defined(VALGRIND)
 293 #define strlen(x) valgrind_strlen(x)
 294 #endif
 295
 296 #define TALLOC_ABORT(reason) smb_panic(reason)
 297
 298
 299 /*
 300   this is a warning hack. The idea is to use this everywhere that we
 301   get the "discarding const" warning from gcc. That doesn't actually
 302   fix the problem of course, but it means that when we do get to
 303   cleaning them up we can do it by searching the code for
 304   discard_const.
 305
 306   It also means that other error types aren't as swamped by the noise
 307   of hundreds of const warnings, so we are more likely to notice when
 308   we get new errors.
 309
 310   Please only add more uses of this macro when you find it
 311   _really_ hard to fix const warnings. Our aim is to eventually use
 312   this function in only a very few places.
 313
 314   Also, please call this via the discard_const_p() macro interface, as that
 315   makes the return type safe.
 316 */
 317 #ifdef HAVE_INTPTR_T
 318 #define discard_const(ptr) ((void *)((intptr_t)(ptr)))
 319 #else
 320 #define discard_const(ptr) ((void *)(ptr))
 321 #endif
 322 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 323
 324 #endif /* _INCLUDES_H */
 325