source/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    Copyright (C) Jeremy Allison 2007.
   9
  10      ** NOTE! The following LGPL license applies to the replace
  11      ** library. This does NOT imply that all of Samba is released
  12      ** under the LGPL
  13
  14    This library is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU Lesser General Public
  16    License as published by the Free Software Foundation; either
  17    version 3 of the License, or (at your option) any later version.
  18
  19    This library is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22    Lesser General Public License for more details.
  23
  24    You should have received a copy of the GNU Lesser General Public
  25    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  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
  49 #ifdef HAVE_STDINT_H
  50 #include <stdint.h>
  51 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
  52    which causes a warning storm on irix */
  53 #undef HAVE_INTTYPES_H
  54 #elif HAVE_INTTYPES_H
  55 #include <inttypes.h>
  56 #endif
  57
  58 #ifdef HAVE_STRING_H
  59 #include <string.h>
  60 #endif
  61
  62 #ifdef HAVE_STRINGS_H
  63 #include <strings.h>
  64 #endif
  65
  66 #ifdef HAVE_SYS_TYPES_H
  67 #include <sys/types.h>
  68 #endif
  69
  70 #if STDC_HEADERS
  71 #include <stdlib.h>
  72 #include <stddef.h>
  73 #endif
  74
  75 #ifndef HAVE_STRERROR
  76 extern char *sys_errlist[];
  77 #define strerror(i) sys_errlist[i]
  78 #endif
  79
  80 #ifndef HAVE_ERRNO_DECL
  81 extern int errno;
  82 #endif
  83
  84 #ifndef HAVE_STRDUP
  85 #define strdup rep_strdup
  86 char *rep_strdup(const char *s);
  87 #endif
  88
  89 #ifndef HAVE_MEMMOVE
  90 #define memmove rep_memmove
  91 void *rep_memmove(void *dest,const void *src,int size);
  92 #endif
  93
  94 #ifndef HAVE_MKTIME
  95 #define mktime rep_mktime
  96 /* prototype is in "system/time.h" */
  97 #endif
  98
  99 #ifndef HAVE_TIMEGM
 100 struct tm;
 101 #define timegm rep_timegm
 102 /* prototype is in "system/time.h" */
 103 #endif
 104
 105 #ifndef HAVE_STRLCPY
 106 #define strlcpy rep_strlcpy
 107 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
 108 #endif
 109
 110 #ifndef HAVE_STRLCAT
 111 #define strlcat rep_strlcat
 112 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
 113 #endif
 114
 115 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 116 #undef HAVE_STRNDUP
 117 #define strndup rep_strndup
 118 char *rep_strndup(const char *s, size_t n);
 119 #endif
 120
 121 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
 122 #undef HAVE_STRNLEN
 123 #define strnlen rep_strnlen
 124 size_t rep_strnlen(const char *s, size_t n);
 125 #endif
 126
 127 #ifndef HAVE_SETENV
 128 #define setenv rep_setenv
 129 int rep_setenv(const char *name, const char *value, int overwrite);
 130 #else
 131 #ifndef HAVE_SETENV_DECL
 132 int setenv(const char *name, const char *value, int overwrite);
 133 #endif
 134 #endif
 135
 136 #ifndef HAVE_UNSETENV
 137 #define unsetenv rep_unsetenv
 138 int rep_unsetenv(const char *name);
 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 initgroups rep_initgroups
 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 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
 198 void *rep_dlopen(const char *name, unsigned int flags);
 199 #else
 200 void *rep_dlopen(const char *name, int flags);
 201 #endif
 202 #endif
 203
 204 #ifndef HAVE_DLSYM
 205 #define dlsym rep_dlsym
 206 void *rep_dlsym(void *handle, const char *symbol);
 207 #endif
 208
 209 #ifndef HAVE_DLCLOSE
 210 #define dlclose rep_dlclose
 211 int rep_dlclose(void *handle);
 212 #endif
 213
 214 #ifndef HAVE_SOCKETPAIR
 215 #define socketpair rep_socketpair
 216 int rep_socketpair(int d, int type, int protocol, int sv[2]);
 217 #endif
 218
 219 #ifndef PRINTF_ATTRIBUTE
 220 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 221 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
 222  * the parameter containing the format, and a2 the index of the first
 223  * argument. Note that some gcc 2.x versions don't handle this
 224  * properly **/
 225 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
 226 #else
 227 #define PRINTF_ATTRIBUTE(a1, a2)
 228 #endif
 229 #endif
 230
 231 #ifndef _DEPRECATED_
 232 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 233 #define _DEPRECATED_ __attribute__ ((deprecated))
 234 #else
 235 #define _DEPRECATED_
 236 #endif
 237 #endif
 238
 239 #ifndef HAVE_VASPRINTF
 240 #define vasprintf rep_vasprintf
 241 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 242 #endif
 243
 244 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 245 #define snprintf rep_snprintf
 246 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 247 #endif
 248
 249 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 250 #define vsnprintf rep_vsnprintf
 251 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
 252 #endif
 253
 254 #ifndef HAVE_ASPRINTF
 255 #define asprintf rep_asprintf
 256 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 257 #endif
 258
 259 #ifndef HAVE_VSYSLOG
 260 #ifdef HAVE_SYSLOG
 261 #define vsyslog rep_vsyslog
 262 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
 263 #endif
 264 #endif
 265
 266 /* we used to use these fns, but now we have good replacements
 267    for snprintf and vsnprintf */
 268 #define slprintf snprintf
 269
 270
 271 #ifndef HAVE_VA_COPY
 272 #undef va_copy
 273 #ifdef HAVE___VA_COPY
 274 #define va_copy(dest, src) __va_copy(dest, src)
 275 #else
 276 #define va_copy(dest, src) (dest) = (src)
 277 #endif
 278 #endif
 279
 280 #ifndef HAVE_VOLATILE
 281 #define volatile
 282 #endif
 283
 284 #ifndef HAVE_COMPARISON_FN_T
 285 typedef int (*comparison_fn_t)(const void *, const void *);
 286 #endif
 287
 288 #ifdef REPLACE_STRPTIME
 289 #define strptime rep_strptime
 290 struct tm;
 291 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
 292 #endif
 293
 294 /* Load header file for dynamic linking stuff */
 295 #ifdef HAVE_DLFCN_H
 296 #include <dlfcn.h>
 297 #endif
 298
 299 #ifndef RTLD_LAZY
 300 #define RTLD_LAZY 0
 301 #endif
 302 #ifndef RTLD_NOW
 303 #define RTLD_NOW 0
 304 #endif
 305 #ifndef RTLD_GLOBAL
 306 #define RTLD_GLOBAL 0
 307 #endif
 308
 309 #ifndef HAVE_SECURE_MKSTEMP
 310 #define mkstemp(path) rep_mkstemp(path)
 311 int rep_mkstemp(char *temp);
 312 #endif
 313
 314 #ifndef HAVE_MKDTEMP
 315 #define mkdtemp rep_mkdtemp
 316 char *rep_mkdtemp(char *template);
 317 #endif
 318
 319 #ifndef HAVE_PREAD
 320 #define pread rep_pread
 321 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
 322 #endif
 323
 324 #ifndef HAVE_PWRITE
 325 #define pwrite rep_pwrite
 326 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
 327 #endif
 328
 329 #ifndef HAVE_INET_PTON
 330 int rep_inet_pton(int af, const char *src, void *dst);
 331 #define inet_pton rep_inet_pton
 332 #endif
 333
 334 #ifndef HAVE_INET_NTOP
 335 #include "system/network.h"
 336 const char *rep_inet_ntop(int af, const void *src, char *dst, socklen_t size);
 337 #define inet_ntop rep_inet_ntop
 338 #endif
 339
 340 #ifdef HAVE_LIMITS_H
 341 #include <limits.h>
 342 #endif
 343
 344 #ifdef HAVE_SYS_PARAM_H
 345 #include <sys/param.h>
 346 #endif
 347
 348 /* The extra casts work around common compiler bugs.  */
 349 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 350 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 351    It is necessary at least when t == time_t.  */
 352 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
 353                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 354 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
 355
 356 #ifndef HOST_NAME_MAX
 357 #define HOST_NAME_MAX 64
 358 #endif
 359
 360 /*
 361  * Some older systems seem not to have MAXHOSTNAMELEN
 362  * defined.
 363  */
 364 #ifndef MAXHOSTNAMELEN
 365 #define MAXHOSTNAMELEN HOST_NAME_MAX
 366 #endif
 367
 368 #ifndef UINT16_MAX
 369 #define UINT16_MAX 65535
 370 #endif
 371
 372 #ifndef UINT32_MAX
 373 #define UINT32_MAX (4294967295U)
 374 #endif
 375
 376 #ifndef UINT64_MAX
 377 #define UINT64_MAX ((uint64_t)-1)
 378 #endif
 379
 380 #ifndef CHAR_BIT
 381 #define CHAR_BIT 8
 382 #endif
 383
 384 #ifndef INT32_MAX
 385 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
 386 #endif
 387
 388 #ifdef HAVE_STDBOOL_H
 389 #include <stdbool.h>
 390 #endif
 391
 392 #if !defined(HAVE_BOOL)
 393 #ifdef HAVE__Bool
 394 #define bool _Bool
 395 #else
 396 typedef int bool;
 397 #endif
 398 #endif
 399
 400 /*
 401  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
 402  *
 403  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
 404  * Tru64 needs _BOOL_EXISTS
 405  * AIX needs _BOOL,_TRUE,_FALSE
 406  */
 407 #ifndef BOOL_DEFINED
 408 #define BOOL_DEFINED
 409 #endif
 410 #ifndef _BOOL_EXISTS
 411 #define _BOOL_EXISTS
 412 #endif
 413 #ifndef _BOOL
 414 #define _BOOL
 415 #endif
 416
 417 #ifndef __bool_true_false_are_defined
 418 #define __bool_true_false_are_defined
 419 #endif
 420
 421 #ifndef true
 422 #define true (1)
 423 #endif
 424 #ifndef false
 425 #define false (0)
 426 #endif
 427
 428 #ifndef _TRUE
 429 #define _TRUE true
 430 #endif
 431 #ifndef _FALSE
 432 #define _FALSE false
 433 #endif
 434
 435 #ifndef HAVE_FUNCTION_MACRO
 436 #ifdef HAVE_func_MACRO
 437 #define __FUNCTION__ __func__
 438 #else
 439 #define __FUNCTION__ ("")
 440 #endif
 441 #endif
 442
 443
 444 #ifndef MIN
 445 #define MIN(a,b) ((a)<(b)?(a):(b))
 446 #endif
 447
 448 #ifndef MAX
 449 #define MAX(a,b) ((a)>(b)?(a):(b))
 450 #endif
 451
 452 /**
 453   this is a warning hack. The idea is to use this everywhere that we
 454   get the "discarding const" warning from gcc. That doesn't actually
 455   fix the problem of course, but it means that when we do get to
 456   cleaning them up we can do it by searching the code for
 457   discard_const.
 458
 459   It also means that other error types aren't as swamped by the noise
 460   of hundreds of const warnings, so we are more likely to notice when
 461   we get new errors.
 462
 463   Please only add more uses of this macro when you find it
 464   _really_ hard to fix const warnings. Our aim is to eventually use
 465   this function in only a very few places.
 466
 467   Also, please call this via the discard_const_p() macro interface, as that
 468   makes the return type safe.
 469 */
 470 #define discard_const(ptr) ((void *)((intptr_t)(ptr)))
 471
 472 /** Type-safe version of discard_const */
 473 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 474
 475 #ifndef __STRING
 476 #define __STRING(x)    #x
 477 #endif
 478
 479 #ifndef __STRINGSTRING
 480 #define __STRINGSTRING(x) __STRING(x)
 481 #endif
 482
 483 #ifndef __LINESTR__
 484 #define __LINESTR__ __STRINGSTRING(__LINE__)
 485 #endif
 486
 487 #ifndef __location__
 488 #define __location__ __FILE__ ":" __LINESTR__
 489 #endif
 490
 491 /**
 492  * zero a structure
 493  */
 494 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
 495
 496 /**
 497  * zero a structure given a pointer to the structure
 498  */
 499 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
 500
 501 /**
 502  * zero a structure given a pointer to the structure - no zero check
 503  */
 504 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
 505
 506 /* zero an array - note that sizeof(array) must work - ie. it must not be a
 507    pointer */
 508 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
 509
 510 /**
 511  * work out how many elements there are in a static array
 512  */
 513 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
 514
 515 /**
 516  * pointer difference macro
 517  */
 518 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
 519
 520 #if MMAP_BLACKLIST
 521 #undef HAVE_MMAP
 522 #endif
 523
 524 #ifdef __COMPAR_FN_T
 525 #define QSORT_CAST (__compar_fn_t)
 526 #endif
 527
 528 #ifndef QSORT_CAST
 529 #define QSORT_CAST (int (*)(const void *, const void *))
 530 #endif
 531
 532 #endif /* _LIBREPLACE_REPLACE_H */