source4/lib/replace/replace.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    macros to go along with the lib/replace/ portability layer code
   5
   6    Copyright (C) Andrew Tridgell 2005
   7    Copyright (C) Jelmer Vernooij 2006
   8
   9      ** NOTE! The following LGPL license applies to the replace
  10      ** library. This does NOT imply that all of Samba is released
  11      ** under the LGPL
  12
  13    This library is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU Lesser General Public
  15    License as published by the Free Software Foundation; either
  16    version 2 of the License, or (at your option) any later version.
  17
  18    This library is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    Lesser General Public License for more details.
  22
  23    You should have received a copy of the GNU Lesser General Public
  24    License along with this library; if not, write to the Free Software
  25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  26 */
  27
  28 #ifndef _LIBREPLACE_REPLACE_H
  29 #define _LIBREPLACE_REPLACE_H
  30
  31 #ifndef NO_CONFIG_H
  32 #include "config.h"
  33 #endif
  34
  35 #ifdef HAVE_STANDARDS_H
  36 #include <standards.h>
  37 #endif
  38
  39 #include <stdio.h>
  40 #include <stdlib.h>
  41 #include <stdarg.h>
  42 #include <errno.h>
  43
  44 #if defined(_MSC_VER) || defined(__MINGW32__)
  45 #include "win32_replace.h"
  46 #endif
  47
  48 #ifdef __COMPAR_FN_T
  49 #define QSORT_CAST (__compar_fn_t)
  50 #endif
  51
  52 #ifndef QSORT_CAST
  53 #define QSORT_CAST (int (*)(const void *, const void *))
  54 #endif
  55
  56 #ifdef HAVE_STDINT_H
  57 #include <stdint.h>
  58 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
  59    which causes a warning storm on irix */
  60 #undef HAVE_INTTYPES_H
  61 #elif HAVE_INTTYPES_H
  62 #include <inttypes.h>
  63 #endif
  64
  65 #ifdef HAVE_STRING_H
  66 #include <string.h>
  67 #endif
  68
  69 #ifdef HAVE_STRINGS_H
  70 #include <strings.h>
  71 #endif
  72
  73 #ifdef HAVE_SYS_TYPES_H
  74 #include <sys/types.h>
  75 #endif
  76
  77 #if STDC_HEADERS
  78 #include <stdlib.h>
  79 #include <stddef.h>
  80 #endif
  81
  82 #ifndef HAVE_STRERROR
  83 extern char *sys_errlist[];
  84 #define strerror(i) sys_errlist[i]
  85 #endif
  86
  87 #ifndef HAVE_ERRNO_DECL
  88 extern int errno;
  89 #endif
  90
  91 #ifndef HAVE_STRDUP
  92 #define strdup rep_strdup
  93 char *rep_strdup(const char *s);
  94 #endif
  95
  96 #ifndef HAVE_MEMMOVE
  97 #define memmove rep_memmove
  98 void *rep_memmove(void *dest,const void *src,int size);
  99 #endif
 100
 101 #if !defined(HAVE_MKTIME) || !defined(HAVE_TIMEGM)
 102 #include "system/time.h"
 103 #endif
 104
 105 #ifndef HAVE_MKTIME
 106 #define mktime rep_mktime
 107 time_t rep_mktime(struct tm *t);
 108 #endif
 109
 110 #ifndef HAVE_TIMEGM
 111 struct tm;
 112 #define timegm rep_timegm
 113 time_t rep_timegm(struct tm *tm);
 114 #endif
 115
 116 #ifndef HAVE_STRLCPY
 117 #define strlcpy rep_strlcpy
 118 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
 119 #endif
 120
 121 #ifndef HAVE_STRLCAT
 122 #define strlcat rep_strlcat
 123 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
 124 #endif
 125
 126 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 127 #undef HAVE_STRNDUP
 128 #define strndup rep_strndup
 129 char *rep_strndup(const char *s, size_t n);
 130 #endif
 131
 132 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
 133 #undef HAVE_STRNLEN
 134 #define strnlen rep_strnlen
 135 size_t rep_strnlen(const char *s, size_t n);
 136 #endif
 137
 138 #ifndef HAVE_SETENV
 139 #define setenv rep_setenv
 140 int rep_setenv(const char *name, const char *value, int overwrite);
 141 #endif
 142
 143 #ifndef HAVE_SETEUID
 144 #define seteuid rep_seteuid
 145 int rep_seteuid(uid_t);
 146 #endif
 147
 148 #ifndef HAVE_SETEGID
 149 #define setegid rep_setegid
 150 int rep_setegid(gid_t);
 151 #endif
 152
 153 #ifndef HAVE_SETLINEBUF
 154 #define setlinebuf rep_setlinebuf
 155 void rep_setlinebuf(FILE *);
 156 #endif
 157
 158 #ifndef HAVE_STRCASESTR
 159 #define strcasestr rep_strcasestr
 160 char *rep_strcasestr(const char *haystack, const char *needle);
 161 #endif
 162
 163 #ifndef HAVE_STRTOK_R
 164 #define strtok_r rep_strtok_r
 165 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
 166 #endif
 167
 168 #ifndef HAVE_STRTOLL
 169 #define strtoll rep_strtoll
 170 long long int rep_strtoll(const char *str, char **endptr, int base);
 171 #endif
 172
 173 #ifndef HAVE_STRTOULL
 174 #define strtoull rep_strtoull
 175 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
 176 #endif
 177
 178 #ifndef HAVE_FTRUNCATE
 179 #define ftruncate rep_ftruncate
 180 int rep_ftruncate(int,off_t);
 181 #endif
 182
 183 #ifndef HAVE_INITGROUPS
 184 #define ftruncate rep_ftruncate
 185 int rep_initgroups(char *name, gid_t id);
 186 #endif
 187
 188 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 189 #define bzero(a,b) memset((a),'\0',(b))
 190 #endif
 191
 192 #ifndef HAVE_DLERROR
 193 #define dlerror rep_dlerror
 194 char *rep_dlerror(void);
 195 #endif
 196
 197 #ifndef HAVE_DLOPEN
 198 #define dlopen rep_dlopen
 199 void *rep_dlopen(const char *name, int flags);
 200 #endif
 201
 202 #ifndef HAVE_DLSYM
 203 #define dlsym rep_dlsym
 204 void *rep_dlsym(void *handle, const char *symbol);
 205 #endif
 206
 207 #ifndef HAVE_DLCLOSE
 208 #define dlclose rep_dlclose
 209 int rep_dlclose(void *handle);
 210 #endif
 211
 212
 213 #ifndef PRINTF_ATTRIBUTE
 214 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 215 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
 216  * the parameter containing the format, and a2 the index of the first
 217  * argument. Note that some gcc 2.x versions don't handle this
 218  * properly **/
 219 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
 220 #else
 221 #define PRINTF_ATTRIBUTE(a1, a2)
 222 #endif
 223 #endif
 224
 225 #ifndef HAVE_VASPRINTF
 226 #define vasprintf rep_vasprintf
 227 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 228 #endif
 229
 230 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 231 #define snprintf rep_snprintf
 232 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 233 #endif
 234
 235 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 236 #define vsnprintf rep_vsnprintf
 237 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
 238 #endif
 239
 240 #ifndef HAVE_ASPRINTF
 241 #define asprintf rep_asprintf
 242 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 243 #endif
 244
 245 #ifndef HAVE_VSYSLOG
 246 #ifdef HAVE_SYSLOG
 247 #define vsyslog rep_vsyslog
 248 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
 249 #endif
 250 #endif
 251
 252 /* we used to use these fns, but now we have good replacements
 253    for snprintf and vsnprintf */
 254 #define slprintf snprintf
 255
 256
 257 #ifndef HAVE_VA_COPY
 258 #undef va_copy
 259 #ifdef HAVE___VA_COPY
 260 #define va_copy(dest, src) __va_copy(dest, src)
 261 #else
 262 #define va_copy(dest, src) (dest) = (src)
 263 #endif
 264 #endif
 265
 266 #ifndef HAVE_VOLATILE
 267 #define volatile
 268 #endif
 269
 270 #ifndef HAVE_COMPARISON_FN_T
 271 typedef int (*comparison_fn_t)(const void *, const void *);
 272 #endif
 273
 274 /* Load header file for dynamic linking stuff */
 275 #ifdef HAVE_DLFCN_H
 276 #include <dlfcn.h>
 277 #endif
 278
 279 #ifndef RTLD_LAZY
 280 #define RTLD_LAZY 0
 281 #endif
 282
 283 #ifndef HAVE_SECURE_MKSTEMP
 284 #define mkstemp(path) rep_mkstemp(path)
 285 int rep_mkstemp(char *temp);
 286 #endif
 287
 288 #ifndef HAVE_MKDTEMP
 289 #define mkdtemp rep_mkdtemp
 290 char *rep_mkdtemp(char *template);
 291 #endif
 292
 293 #ifdef HAVE_LIMITS_H
 294 #include <limits.h>
 295 #endif
 296
 297 /* The extra casts work around common compiler bugs.  */
 298 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 299 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 300    It is necessary at least when t == time_t.  */
 301 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
 302                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 303 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
 304
 305 #ifndef HOST_NAME_MAX
 306 #define HOST_NAME_MAX 64
 307 #endif
 308
 309 #ifndef UINT16_MAX
 310 #define UINT16_MAX 65535
 311 #endif
 312
 313 #ifndef UINT32_MAX
 314 #define UINT32_MAX (4294967295U)
 315 #endif
 316
 317 #ifndef UINT64_MAX
 318 #define UINT64_MAX ((uint64_t)-1)
 319 #endif
 320
 321 #ifndef CHAR_BIT
 322 #define CHAR_BIT 8
 323 #endif
 324
 325 #ifndef INT32_MAX
 326 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
 327 #endif
 328
 329 #ifdef HAVE_STDBOOL_H
 330 #include <stdbool.h>
 331 #endif
 332
 333 #if !defined(HAVE_BOOL)
 334 #ifdef HAVE__Bool
 335 #define bool _Bool
 336 #else
 337 typedef int bool;
 338 #endif
 339 #endif
 340
 341 /*
 342  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
 343  *
 344  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
 345  * Tru64 needs _BOOL_EXISTS
 346  * AIX needs _BOOL,_TRUE,_FALSE
 347  */
 348 #ifndef BOOL_DEFINED
 349 #define BOOL_DEFINED
 350 #endif
 351 #ifndef _BOOL_EXISTS
 352 #define _BOOL_EXISTS
 353 #endif
 354 #ifndef _BOOL
 355 #define _BOOL
 356 #endif
 357
 358 #ifndef __bool_true_false_are_defined
 359 #define __bool_true_false_are_defined
 360 #endif
 361
 362 #ifndef true
 363 #define true (1)
 364 #endif
 365 #ifndef false
 366 #define false (0)
 367 #endif
 368
 369 #ifndef _TRUE
 370 #define _TRUE true
 371 #endif
 372 #ifndef _FALSE
 373 #define _FALSE false
 374 #endif
 375
 376 #ifndef HAVE_FUNCTION_MACRO
 377 #ifdef HAVE_func_MACRO
 378 #define __FUNCTION__ __func__
 379 #else
 380 #define __FUNCTION__ ("")
 381 #endif
 382 #endif
 383
 384 #ifdef HAVE_SYS_PARAM_H
 385 #include <sys/param.h>
 386 #endif
 387
 388 #ifndef MIN
 389 #define MIN(a,b) ((a)<(b)?(a):(b))
 390 #endif
 391
 392 #ifndef MAX
 393 #define MAX(a,b) ((a)>(b)?(a):(b))
 394 #endif
 395
 396 #ifndef __STRING
 397 #define __STRING(x)    #x
 398 #endif
 399
 400 #if MMAP_BLACKLIST
 401 #undef HAVE_MMAP
 402 #endif
 403
 404 #endif /* _LIBREPLACE_REPLACE_H */