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 #define __STDC_FORMAT_MACROS
  56 #include <inttypes.h>
  57 #endif
  58
  59 #ifndef __PRI64_PREFIX
  60 # if __WORDSIZE == 64
  61 #  define __PRI64_PREFIX        "l"
  62 # else
  63 #  define __PRI64_PREFIX        "ll"
  64 # endif
  65 #endif
  66
  67 /* Decimal notation.  */
  68 #ifndef PRId8
  69 # define PRId8          "d"
  70 #endif
  71 #ifndef PRId16
  72 # define PRId16         "d"
  73 #endif
  74 #ifndef PRId32
  75 # define PRId32         "d"
  76 #endif
  77 #ifndef PRId64
  78 # define PRId64         __PRI64_PREFIX "d"
  79 #endif
  80
  81 #ifndef PRIi8
  82 # define PRIi8          "i"
  83 #endif
  84 #ifndef PRIi8
  85 # define PRIi16         "i"
  86 #endif
  87 #ifndef PRIi8
  88 # define PRIi32         "i"
  89 #endif
  90 #ifndef PRIi8
  91 # define PRIi64         __PRI64_PREFIX "i"
  92 #endif
  93
  94 #ifndef PRIu8
  95 # define PRIu8          "u"
  96 #endif
  97 #ifndef PRIu16
  98 # define PRIu16         "u"
  99 #endif
 100 #ifndef PRIu32
 101 # define PRIu32         "u"
 102 #endif
 103 #ifndef PRIu64
 104 # define PRIu64         __PRI64_PREFIX "u"
 105 #endif
 106
 107 #ifdef HAVE_STRING_H
 108 #include <string.h>
 109 #endif
 110
 111 #ifdef HAVE_STRINGS_H
 112 #include <strings.h>
 113 #endif
 114
 115 #ifdef HAVE_SYS_TYPES_H
 116 #include <sys/types.h>
 117 #endif
 118
 119 #if STDC_HEADERS
 120 #include <stdlib.h>
 121 #include <stddef.h>
 122 #endif
 123
 124 #ifndef HAVE_STRERROR
 125 extern char *sys_errlist[];
 126 #define strerror(i) sys_errlist[i]
 127 #endif
 128
 129 #ifndef HAVE_ERRNO_DECL
 130 extern int errno;
 131 #endif
 132
 133 #ifndef HAVE_STRDUP
 134 #define strdup rep_strdup
 135 char *rep_strdup(const char *s);
 136 #endif
 137
 138 #ifndef HAVE_MEMMOVE
 139 #define memmove rep_memmove
 140 void *rep_memmove(void *dest,const void *src,int size);
 141 #endif
 142
 143 #ifndef HAVE_MKTIME
 144 #define mktime rep_mktime
 145 /* prototype is in "system/time.h" */
 146 #endif
 147
 148 #ifndef HAVE_TIMEGM
 149 #define timegm rep_timegm
 150 /* prototype is in "system/time.h" */
 151 #endif
 152
 153 #ifndef HAVE_UTIME
 154 #define utime rep_utime
 155 /* prototype is in "system/time.h" */
 156 #endif
 157
 158 #ifndef HAVE_UTIMES
 159 #define utimes rep_utimes
 160 /* prototype is in "system/time.h" */
 161 #endif
 162
 163 #ifndef HAVE_STRLCPY
 164 #define strlcpy rep_strlcpy
 165 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
 166 #endif
 167
 168 #ifndef HAVE_STRLCAT
 169 #define strlcat rep_strlcat
 170 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
 171 #endif
 172
 173 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 174 #undef HAVE_STRNDUP
 175 #define strndup rep_strndup
 176 char *rep_strndup(const char *s, size_t n);
 177 #endif
 178
 179 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
 180 #undef HAVE_STRNLEN
 181 #define strnlen rep_strnlen
 182 size_t rep_strnlen(const char *s, size_t n);
 183 #endif
 184
 185 #if !HAVE_DECL_ENVIRON
 186 #ifdef __APPLE__
 187 #include <crt_externs.h>
 188 #define environ (*_NSGetEnviron())
 189 #else
 190 extern char **environ;
 191 #endif
 192 #endif
 193
 194 #ifndef HAVE_SETENV
 195 #define setenv rep_setenv
 196 int rep_setenv(const char *name, const char *value, int overwrite);
 197 #else
 198 #ifndef HAVE_SETENV_DECL
 199 int setenv(const char *name, const char *value, int overwrite);
 200 #endif
 201 #endif
 202
 203 #ifndef HAVE_UNSETENV
 204 #define unsetenv rep_unsetenv
 205 int rep_unsetenv(const char *name);
 206 #endif
 207
 208 #ifndef HAVE_SETEUID
 209 #define seteuid rep_seteuid
 210 int rep_seteuid(uid_t);
 211 #endif
 212
 213 #ifndef HAVE_SETEGID
 214 #define setegid rep_setegid
 215 int rep_setegid(gid_t);
 216 #endif
 217
 218 #ifndef HAVE_SETLINEBUF
 219 #define setlinebuf rep_setlinebuf
 220 void rep_setlinebuf(FILE *);
 221 #endif
 222
 223 #ifndef HAVE_STRCASESTR
 224 #define strcasestr rep_strcasestr
 225 char *rep_strcasestr(const char *haystack, const char *needle);
 226 #endif
 227
 228 #ifndef HAVE_STRTOK_R
 229 #define strtok_r rep_strtok_r
 230 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
 231 #endif
 232
 233 #ifndef HAVE_STRTOLL
 234 #define strtoll rep_strtoll
 235 long long int rep_strtoll(const char *str, char **endptr, int base);
 236 #endif
 237
 238 #ifndef HAVE_STRTOULL
 239 #define strtoull rep_strtoull
 240 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
 241 #endif
 242
 243 #ifndef HAVE_FTRUNCATE
 244 #define ftruncate rep_ftruncate
 245 int rep_ftruncate(int,off_t);
 246 #endif
 247
 248 #ifndef HAVE_INITGROUPS
 249 #define initgroups rep_initgroups
 250 int rep_initgroups(char *name, gid_t id);
 251 #endif
 252
 253 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 254 #define bzero(a,b) memset((a),'\0',(b))
 255 #endif
 256
 257 #ifndef HAVE_DLERROR
 258 #define dlerror rep_dlerror
 259 char *rep_dlerror(void);
 260 #endif
 261
 262 #ifndef HAVE_DLOPEN
 263 #define dlopen rep_dlopen
 264 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
 265 void *rep_dlopen(const char *name, unsigned int flags);
 266 #else
 267 void *rep_dlopen(const char *name, int flags);
 268 #endif
 269 #endif
 270
 271 #ifndef HAVE_DLSYM
 272 #define dlsym rep_dlsym
 273 void *rep_dlsym(void *handle, const char *symbol);
 274 #endif
 275
 276 #ifndef HAVE_DLCLOSE
 277 #define dlclose rep_dlclose
 278 int rep_dlclose(void *handle);
 279 #endif
 280
 281 #ifndef HAVE_SOCKETPAIR
 282 #define socketpair rep_socketpair
 283 /* prototype is in system/network.h */
 284 #endif
 285
 286 #ifndef PRINTF_ATTRIBUTE
 287 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 288 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
 289  * the parameter containing the format, and a2 the index of the first
 290  * argument. Note that some gcc 2.x versions don't handle this
 291  * properly **/
 292 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
 293 #else
 294 #define PRINTF_ATTRIBUTE(a1, a2)
 295 #endif
 296 #endif
 297
 298 #ifndef _DEPRECATED_
 299 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 300 #define _DEPRECATED_ __attribute__ ((deprecated))
 301 #else
 302 #define _DEPRECATED_
 303 #endif
 304 #endif
 305
 306 #ifndef HAVE_VASPRINTF
 307 #define vasprintf rep_vasprintf
 308 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 309 #endif
 310
 311 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 312 #define snprintf rep_snprintf
 313 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 314 #endif
 315
 316 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 317 #define vsnprintf rep_vsnprintf
 318 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
 319 #endif
 320
 321 #ifndef HAVE_ASPRINTF
 322 #define asprintf rep_asprintf
 323 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 324 #endif
 325
 326 #ifndef HAVE_VSYSLOG
 327 #ifdef HAVE_SYSLOG
 328 #define vsyslog rep_vsyslog
 329 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
 330 #endif
 331 #endif
 332
 333 /* we used to use these fns, but now we have good replacements
 334    for snprintf and vsnprintf */
 335 #define slprintf snprintf
 336
 337
 338 #ifndef HAVE_VA_COPY
 339 #undef va_copy
 340 #ifdef HAVE___VA_COPY
 341 #define va_copy(dest, src) __va_copy(dest, src)
 342 #else
 343 #define va_copy(dest, src) (dest) = (src)
 344 #endif
 345 #endif
 346
 347 #ifndef HAVE_VOLATILE
 348 #define volatile
 349 #endif
 350
 351 #ifndef HAVE_COMPARISON_FN_T
 352 typedef int (*comparison_fn_t)(const void *, const void *);
 353 #endif
 354
 355 #ifdef REPLACE_STRPTIME
 356 #define strptime rep_strptime
 357 struct tm;
 358 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
 359 #endif
 360
 361 /* Load header file for dynamic linking stuff */
 362 #ifdef HAVE_DLFCN_H
 363 #include <dlfcn.h>
 364 #endif
 365
 366 #ifndef RTLD_LAZY
 367 #define RTLD_LAZY 0
 368 #endif
 369 #ifndef RTLD_NOW
 370 #define RTLD_NOW 0
 371 #endif
 372 #ifndef RTLD_GLOBAL
 373 #define RTLD_GLOBAL 0
 374 #endif
 375
 376 #ifndef HAVE_SECURE_MKSTEMP
 377 #define mkstemp(path) rep_mkstemp(path)
 378 int rep_mkstemp(char *temp);
 379 #endif
 380
 381 #ifndef HAVE_MKDTEMP
 382 #define mkdtemp rep_mkdtemp
 383 char *rep_mkdtemp(char *template);
 384 #endif
 385
 386 #ifndef HAVE_PREAD
 387 #define pread rep_pread
 388 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
 389 #endif
 390
 391 #ifndef HAVE_PWRITE
 392 #define pwrite rep_pwrite
 393 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
 394 #endif
 395
 396 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
 397 #define inet_ntoa rep_inet_ntoa
 398 /* prototype is in "system/network.h" */
 399 #endif
 400
 401 #ifndef HAVE_INET_PTON
 402 #define inet_pton rep_inet_pton
 403 /* prototype is in "system/network.h" */
 404 #endif
 405
 406 #ifndef HAVE_INET_NTOP
 407 #define inet_ntop rep_inet_ntop
 408 /* prototype is in "system/network.h" */
 409 #endif
 410
 411 #ifndef HAVE_INET_ATON
 412 #define inet_aton rep_inet_aton
 413 /* prototype is in "system/network.h" */
 414 #endif
 415
 416 #ifndef HAVE_CONNECT
 417 #define connect rep_connect
 418 /* prototype is in "system/network.h" */
 419 #endif
 420
 421 #ifndef HAVE_GETHOSTBYNAME
 422 #define gethostbyname rep_gethostbyname
 423 /* prototype is in "system/network.h" */
 424 #endif
 425
 426 #ifndef HAVE_GETIFADDRS
 427 #define getifaddrs rep_getifaddrs
 428 /* prototype is in "system/network.h" */
 429 #endif
 430
 431 #ifndef HAVE_FREEIFADDRS
 432 #define freeifaddrs rep_freeifaddrs
 433 /* prototype is in "system/network.h" */
 434 #endif
 435
 436 #ifdef HAVE_LIMITS_H
 437 #include <limits.h>
 438 #endif
 439
 440 #ifdef HAVE_SYS_PARAM_H
 441 #include <sys/param.h>
 442 #endif
 443
 444 /* The extra casts work around common compiler bugs.  */
 445 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 446 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 447    It is necessary at least when t == time_t.  */
 448 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
 449                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 450 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
 451
 452 #ifndef HOST_NAME_MAX
 453 #define HOST_NAME_MAX 255
 454 #endif
 455
 456 /*
 457  * Some older systems seem not to have MAXHOSTNAMELEN
 458  * defined.
 459  */
 460 #ifndef MAXHOSTNAMELEN
 461 #define MAXHOSTNAMELEN HOST_NAME_MAX
 462 #endif
 463
 464 #ifndef UINT16_MAX
 465 #define UINT16_MAX 65535
 466 #endif
 467
 468 #ifndef UINT32_MAX
 469 #define UINT32_MAX (4294967295U)
 470 #endif
 471
 472 #ifndef UINT64_MAX
 473 #define UINT64_MAX ((uint64_t)-1)
 474 #endif
 475
 476 #ifndef CHAR_BIT
 477 #define CHAR_BIT 8
 478 #endif
 479
 480 #ifndef INT32_MAX
 481 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
 482 #endif
 483
 484 #ifdef HAVE_STDBOOL_H
 485 #include <stdbool.h>
 486 #endif
 487
 488 #if !defined(HAVE_BOOL)
 489 #ifdef HAVE__Bool
 490 #define bool _Bool
 491 #else
 492 typedef int bool;
 493 #endif
 494 #endif
 495
 496 /*
 497  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
 498  *
 499  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
 500  * Tru64 needs _BOOL_EXISTS
 501  * AIX needs _BOOL,_TRUE,_FALSE
 502  */
 503 #ifndef BOOL_DEFINED
 504 #define BOOL_DEFINED
 505 #endif
 506 #ifndef _BOOL_EXISTS
 507 #define _BOOL_EXISTS
 508 #endif
 509 #ifndef _BOOL
 510 #define _BOOL
 511 #endif
 512
 513 #ifndef __bool_true_false_are_defined
 514 #define __bool_true_false_are_defined
 515 #endif
 516
 517 #ifndef true
 518 #define true (1)
 519 #endif
 520 #ifndef false
 521 #define false (0)
 522 #endif
 523
 524 #ifndef _TRUE
 525 #define _TRUE true
 526 #endif
 527 #ifndef _FALSE
 528 #define _FALSE false
 529 #endif
 530
 531 #ifndef HAVE_FUNCTION_MACRO
 532 #ifdef HAVE_func_MACRO
 533 #define __FUNCTION__ __func__
 534 #else
 535 #define __FUNCTION__ ("")
 536 #endif
 537 #endif
 538
 539
 540 #ifndef MIN
 541 #define MIN(a,b) ((a)<(b)?(a):(b))
 542 #endif
 543
 544 #ifndef MAX
 545 #define MAX(a,b) ((a)>(b)?(a):(b))
 546 #endif
 547
 548 #if !defined(HAVE_VOLATILE)
 549 #define volatile
 550 #endif
 551
 552 /**
 553   this is a warning hack. The idea is to use this everywhere that we
 554   get the "discarding const" warning from gcc. That doesn't actually
 555   fix the problem of course, but it means that when we do get to
 556   cleaning them up we can do it by searching the code for
 557   discard_const.
 558
 559   It also means that other error types aren't as swamped by the noise
 560   of hundreds of const warnings, so we are more likely to notice when
 561   we get new errors.
 562
 563   Please only add more uses of this macro when you find it
 564   _really_ hard to fix const warnings. Our aim is to eventually use
 565   this function in only a very few places.
 566
 567   Also, please call this via the discard_const_p() macro interface, as that
 568   makes the return type safe.
 569 */
 570 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
 571
 572 /** Type-safe version of discard_const */
 573 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 574
 575 #ifndef __STRING
 576 #define __STRING(x)    #x
 577 #endif
 578
 579 #ifndef __STRINGSTRING
 580 #define __STRINGSTRING(x) __STRING(x)
 581 #endif
 582
 583 #ifndef __LINESTR__
 584 #define __LINESTR__ __STRINGSTRING(__LINE__)
 585 #endif
 586
 587 #ifndef __location__
 588 #define __location__ __FILE__ ":" __LINESTR__
 589 #endif
 590
 591 /**
 592  * zero a structure
 593  */
 594 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
 595
 596 /**
 597  * zero a structure given a pointer to the structure
 598  */
 599 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
 600
 601 /**
 602  * zero a structure given a pointer to the structure - no zero check
 603  */
 604 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
 605
 606 /* zero an array - note that sizeof(array) must work - ie. it must not be a
 607    pointer */
 608 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
 609
 610 /**
 611  * work out how many elements there are in a static array
 612  */
 613 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
 614
 615 /**
 616  * pointer difference macro
 617  */
 618 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
 619
 620 #if MMAP_BLACKLIST
 621 #undef HAVE_MMAP
 622 #endif
 623
 624 #ifdef __COMPAR_FN_T
 625 #define QSORT_CAST (__compar_fn_t)
 626 #endif
 627
 628 #ifndef QSORT_CAST
 629 #define QSORT_CAST (int (*)(const void *, const void *))
 630 #endif
 631
 632 #ifndef PATH_MAX
 633 #define PATH_MAX 1024
 634 #endif
 635
 636 #ifndef MAX_DNS_NAME_LENGTH
 637 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
 638 #endif
 639
 640 #ifndef HAVE_CRYPT
 641 char *ufc_crypt(const char *key, const char *salt);
 642 #define crypt ufc_crypt
 643 #else
 644 #ifdef HAVE_CRYPT_H
 645 #include <crypt.h>
 646 #endif
 647 #endif
 648
 649 #endif /* _LIBREPLACE_REPLACE_H */