source/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 #include <sys/time.h>
  55
  56 #ifdef HAVE_STDINT_H
  57 #include <stdint.h>
  58 #endif
  59
  60 #ifdef HAVE_STRING_H
  61 #include <string.h>
  62 #endif
  63
  64 #include <signal.h>
  65 #include <errno.h>
  66
  67 #ifdef HAVE_STDARG_H
  68 #include <stdarg.h>
  69 #else
  70 #include <varargs.h>
  71 #endif
  72
  73 /* we support ADS if we want it and have krb5 and ldap libs */
  74 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
  75 #define HAVE_ADS
  76 #endif
  77
  78 /*
  79  * Define VOLATILE if needed.
  80  */
  81
  82 #if defined(HAVE_VOLATILE)
  83 #define VOLATILE volatile
  84 #else
  85 #define VOLATILE
  86 #endif
  87
  88 /*
  89    Samba needs type definitions for
  90    int8_t,  int16_t,  int32_t, int64_t
  91    uint8_t, uint16_t, uint32_t and uint64_t.
  92
  93    Normally these are signed and unsigned 8, 16, 32 and 64 bit integers, but
  94    they actually only need to be at least 8, 16, 32 and 64 bits
  95    respectively. Thus if your word size is 8 bytes just defining them
  96    as signed and unsigned int will work.
  97 */
  98
  99 #if !defined(int8)
 100 #define int8 int8_t
 101 #endif
 102
 103 #if !defined(uint8)
 104 #define uint8 uint8_t
 105 #endif
 106
 107 #if !defined(int16)
 108 #define int16 int16_t
 109 #endif
 110
 111 #if !defined(uint16)
 112 #define uint16 uint16_t
 113 #endif
 114
 115 #if !defined(int32)
 116 #define int32 int32_t
 117 #endif
 118
 119 #if !defined(uint32)
 120 #define uint32 uint32_t
 121 #endif
 122
 123 #if !defined(int64)
 124 #define int64 int64_t
 125 #endif
 126
 127 #if !defined(uint64)
 128 #define uint64 uint64_t
 129 #endif
 130
 131 #define False (0)
 132 #define True (1)
 133 #define Auto (2)
 134
 135 typedef int BOOL;
 136
 137 /*
 138   we use struct ipv4_addr to avoid having to include all the
 139   system networking headers everywhere
 140 */
 141 struct ipv4_addr {
 142         uint32_t addr;
 143 };
 144
 145 #ifndef HAVE_STRERROR
 146 extern char *sys_errlist[];
 147 #define strerror(i) sys_errlist[i]
 148 #endif
 149
 150 #ifndef HAVE_ERRNO_DECL
 151 extern int errno;
 152 #endif
 153
 154 /* Lists, trees, caching, database... */
 155 #include "version.h"
 156 #include "xfile.h"
 157 #include "lib/talloc/talloc.h"
 158 #include "nt_status.h"
 159 #include "structs.h"
 160 #include "lib/tdb/include/tdb.h"
 161 #include "lib/tdb/include/spinlock.h"
 162 #include "lib/tdb/include/tdbutil.h"
 163 #include "db_wrap.h"
 164 #include "trans2.h"
 165 #include "nterr.h"
 166 #include "charset.h"
 167 #include "debug.h"
 168 #include "doserr.h"
 169 #include "enums.h"
 170 #include "pstring.h"
 171 #include "smb_macros.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/gen_ndr/ndr_misc.h"
 182 #include "librpc/gen_ndr/ndr_dcerpc.h"
 183 #include "librpc/rpc/dcerpc.h"
 184 #include "lib/dcom/common/dcom.h"
 185 #include "librpc/gen_ndr/ndr_dcom.h"
 186 #include "smb_interfaces.h"
 187 #include "smbd/server.h"
 188 #include "smbd/service.h"
 189 #include "ntvfs/ntvfs.h"
 190 #include "cli_context.h"
 191 #include "nsswitch/winbind_client.h"
 192
 193 #define malloc_p(type) (type *)malloc(sizeof(type))
 194 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
 195 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
 196
 197 #ifndef HAVE_COMPARISON_FN_T
 198 typedef int (*comparison_fn_t)(const void *, const void *);
 199 #endif
 200
 201 /***** automatically generated prototypes *****/
 202 #define _PRINTF_ATTRIBUTE(a1, a2) PRINTF_ATTRIBUTE(a1, a2)
 203 #include "proto.h"
 204 #undef _PRINTF_ATTRIBUTE
 205 #define _PRINTF_ATTRIBUTE(a1, a2)
 206
 207 /* String routines */
 208
 209 #include "safe_string.h"
 210
 211 #ifdef __COMPAR_FN_T
 212 #define QSORT_CAST (__compar_fn_t)
 213 #endif
 214
 215 #ifndef QSORT_CAST
 216 #define QSORT_CAST (int (*)(const void *, const void *))
 217 #endif
 218
 219 #ifndef HAVE_PIPE
 220 #define SYNC_DNS 1
 221 #endif
 222
 223 #ifndef HAVE_STRDUP
 224 char *strdup(const char *s);
 225 #endif
 226
 227 #ifndef HAVE_MEMMOVE
 228 void *memmove(void *dest,const void *src,int size);
 229 #endif
 230
 231 #ifndef HAVE_MKTIME
 232 time_t mktime(struct tm *t);
 233 #endif
 234
 235 #ifndef HAVE_STRLCPY
 236 size_t strlcpy(char *d, const char *s, size_t bufsize);
 237 #endif
 238
 239 #ifndef HAVE_STRLCAT
 240 size_t strlcat(char *d, const char *s, size_t bufsize);
 241 #endif
 242
 243 #ifndef HAVE_STRNDUP
 244 char *strndup(const char *s, size_t n);
 245 #endif
 246
 247 #ifndef HAVE_STRNLEN
 248 size_t strnlen(const char *s, size_t n);
 249 #endif
 250
 251 #ifndef HAVE_STRTOUL
 252 unsigned long strtoul(const char *nptr, char **endptr, int base);
 253 #endif
 254
 255 #ifndef HAVE_SETENV
 256 int setenv(const char *name, const char *value, int overwrite);
 257 #endif
 258
 259 #ifndef HAVE_VASPRINTF_DECL
 260 int vasprintf(char **ptr, const char *format, va_list ap);
 261 #endif
 262
 263 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 264 #define bzero(a,b) memset((a),'\0',(b))
 265 #endif
 266
 267 extern int DEBUGLEVEL;
 268
 269 /* add varargs prototypes with printf checking */
 270 #ifndef HAVE_SNPRINTF_DECL
 271 int snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 272 #endif
 273 #ifndef HAVE_ASPRINTF_DECL
 274 int asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 275 #endif
 276
 277
 278 /* we used to use these fns, but now we have good replacements
 279    for snprintf and vsnprintf */
 280 #define slprintf snprintf
 281
 282
 283 /* we need to use __va_copy() on some platforms */
 284 #ifdef HAVE_VA_COPY
 285 #define VA_COPY(dest, src) __va_copy(dest, src)
 286 #else
 287 #define VA_COPY(dest, src) (dest) = (src)
 288 #endif
 289
 290 #if defined(VALGRIND)
 291 #define strlen(x) valgrind_strlen(x)
 292 #endif
 293
 294 #if 0
 295 /* darn, we can't do this now that we don't link the ldb tools to all the smb libs */
 296 #define TALLOC_ABORT(reason) smb_panic(reason)
 297 #endif
 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
 326 /*
 327   type safe varient of smb_xmalloc()
 328 */
 329 #define smb_xmalloc_p(type) (type *)smb_xmalloc(sizeof(type))
 330