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