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-2008
   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 #ifdef HAVE_MALLOC_H
  60 #include <malloc.h>
  61 #endif
  62
  63 #ifndef __PRI64_PREFIX
  64 # if __WORDSIZE == 64 && ! defined __APPLE__
  65 #  define __PRI64_PREFIX        "l"
  66 # else
  67 #  define __PRI64_PREFIX        "ll"
  68 # endif
  69 #endif
  70
  71 /* Decimal notation.  */
  72 #ifndef PRId8
  73 # define PRId8          "d"
  74 #endif
  75 #ifndef PRId16
  76 # define PRId16         "d"
  77 #endif
  78 #ifndef PRId32
  79 # define PRId32         "d"
  80 #endif
  81 #ifndef PRId64
  82 # define PRId64         __PRI64_PREFIX "d"
  83 #endif
  84
  85 #ifndef PRIi8
  86 # define PRIi8          "i"
  87 #endif
  88 #ifndef PRIi16
  89 # define PRIi16         "i"
  90 #endif
  91 #ifndef PRIi32
  92 # define PRIi32         "i"
  93 #endif
  94 #ifndef PRIi64
  95 # define PRIi64         __PRI64_PREFIX "i"
  96 #endif
  97
  98 #ifndef PRIu8
  99 # define PRIu8          "u"
 100 #endif
 101 #ifndef PRIu16
 102 # define PRIu16         "u"
 103 #endif
 104 #ifndef PRIu32
 105 # define PRIu32         "u"
 106 #endif
 107 #ifndef PRIu64
 108 # define PRIu64         __PRI64_PREFIX "u"
 109 #endif
 110
 111 #ifdef HAVE_BSD_STRING_H
 112 #include <bsd/string.h>
 113 #endif
 114
 115 #ifdef HAVE_BSD_UNISTD_H
 116 #include <bsd/unistd.h>
 117 #endif
 118
 119 #ifdef HAVE_STRING_H
 120 #include <string.h>
 121 #endif
 122
 123 #ifdef HAVE_STRINGS_H
 124 #include <strings.h>
 125 #endif
 126
 127 #ifdef HAVE_SYS_TYPES_H
 128 #include <sys/types.h>
 129 #endif
 130
 131 #ifdef HAVE_SETPROCTITLE_H
 132 #include <setproctitle.h>
 133 #endif
 134
 135 #if STDC_HEADERS
 136 #include <stdlib.h>
 137 #include <stddef.h>
 138 #endif
 139
 140 #ifdef HAVE_LINUX_TYPES_H
 141 /*
 142  * This is needed as some broken header files require this to be included early
 143  */
 144 #include <linux/types.h>
 145 #endif
 146
 147 #ifndef HAVE_STRERROR
 148 extern char *sys_errlist[];
 149 #define strerror(i) sys_errlist[i]
 150 #endif
 151
 152 #ifndef HAVE_ERRNO_DECL
 153 extern int errno;
 154 #endif
 155
 156 #ifndef HAVE_STRDUP
 157 #define strdup rep_strdup
 158 char *rep_strdup(const char *s);
 159 #endif
 160
 161 #ifndef HAVE_MEMMOVE
 162 #define memmove rep_memmove
 163 void *rep_memmove(void *dest,const void *src,int size);
 164 #endif
 165
 166 #ifndef HAVE_MEMMEM
 167 #define memmem rep_memmem
 168 void *rep_memmem(const void *haystack, size_t haystacklen,
 169                  const void *needle, size_t needlelen);
 170 #endif
 171
 172 #ifndef HAVE_MEMALIGN
 173 #define memalign rep_memalign
 174 void *rep_memalign(size_t boundary, size_t size);
 175 #endif
 176
 177 #ifndef HAVE_MKTIME
 178 #define mktime rep_mktime
 179 /* prototype is in "system/time.h" */
 180 #endif
 181
 182 #ifndef HAVE_TIMEGM
 183 #define timegm rep_timegm
 184 /* prototype is in "system/time.h" */
 185 #endif
 186
 187 #ifndef HAVE_UTIME
 188 #define utime rep_utime
 189 /* prototype is in "system/time.h" */
 190 #endif
 191
 192 #ifndef HAVE_UTIMES
 193 #define utimes rep_utimes
 194 /* prototype is in "system/time.h" */
 195 #endif
 196
 197 #ifndef HAVE_STRLCPY
 198 #define strlcpy rep_strlcpy
 199 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
 200 #endif
 201
 202 #ifndef HAVE_STRLCAT
 203 #define strlcat rep_strlcat
 204 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
 205 #endif
 206
 207 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 208 #undef HAVE_STRNDUP
 209 #define strndup rep_strndup
 210 char *rep_strndup(const char *s, size_t n);
 211 #endif
 212
 213 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
 214 #undef HAVE_STRNLEN
 215 #define strnlen rep_strnlen
 216 size_t rep_strnlen(const char *s, size_t n);
 217 #endif
 218
 219 #if !HAVE_DECL_ENVIRON
 220 #ifdef __APPLE__
 221 #include <crt_externs.h>
 222 #define environ (*_NSGetEnviron())
 223 #else
 224 extern char **environ;
 225 #endif
 226 #endif
 227
 228 #ifndef HAVE_SETENV
 229 #define setenv rep_setenv
 230 int rep_setenv(const char *name, const char *value, int overwrite);
 231 #else
 232 #ifndef HAVE_SETENV_DECL
 233 int setenv(const char *name, const char *value, int overwrite);
 234 #endif
 235 #endif
 236
 237 #ifndef HAVE_UNSETENV
 238 #define unsetenv rep_unsetenv
 239 int rep_unsetenv(const char *name);
 240 #endif
 241
 242 #ifndef HAVE_SETEUID
 243 #define seteuid rep_seteuid
 244 int rep_seteuid(uid_t);
 245 #endif
 246
 247 #ifndef HAVE_SETEGID
 248 #define setegid rep_setegid
 249 int rep_setegid(gid_t);
 250 #endif
 251
 252 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
 253 /* stupid glibc */
 254 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
 255 #endif
 256 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
 257 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
 258 #endif
 259
 260 #ifndef HAVE_CHOWN
 261 #define chown rep_chown
 262 int rep_chown(const char *path, uid_t uid, gid_t gid);
 263 #endif
 264
 265 #ifndef HAVE_CHROOT
 266 #define chroot rep_chroot
 267 int rep_chroot(const char *dirname);
 268 #endif
 269
 270 #ifndef HAVE_LINK
 271 #define link rep_link
 272 int rep_link(const char *oldpath, const char *newpath);
 273 #endif
 274
 275 #ifndef HAVE_READLINK
 276 #define readlink rep_readlink
 277 ssize_t rep_readlink(const char *path, char *buf, size_t bufsize);
 278 #endif
 279
 280 #ifndef HAVE_SYMLINK
 281 #define symlink rep_symlink
 282 int rep_symlink(const char *oldpath, const char *newpath);
 283 #endif
 284
 285 #ifndef HAVE_REALPATH
 286 #define realpath rep_realpath
 287 char *rep_realpath(const char *path, char *resolved_path);
 288 #endif
 289
 290 #ifndef HAVE_LCHOWN
 291 #define lchown rep_lchown
 292 int rep_lchown(const char *fname,uid_t uid,gid_t gid);
 293 #endif
 294
 295 #ifdef HAVE_UNIX_H
 296 #include <unix.h>
 297 #endif
 298
 299 #ifndef HAVE_SETLINEBUF
 300 #define setlinebuf rep_setlinebuf
 301 void rep_setlinebuf(FILE *);
 302 #endif
 303
 304 #ifndef HAVE_STRCASESTR
 305 #define strcasestr rep_strcasestr
 306 char *rep_strcasestr(const char *haystack, const char *needle);
 307 #endif
 308
 309 #ifndef HAVE_STRTOK_R
 310 #define strtok_r rep_strtok_r
 311 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
 312 #endif
 313
 314
 315
 316 #ifndef HAVE_STRTOLL
 317 #define strtoll rep_strtoll
 318 long long int rep_strtoll(const char *str, char **endptr, int base);
 319 #else
 320 #ifdef HAVE_BSD_STRTOLL
 321 #define strtoll rep_strtoll
 322 long long int rep_strtoll(const char *str, char **endptr, int base);
 323 #endif
 324 #endif
 325
 326 #ifndef HAVE_STRTOULL
 327 #define strtoull rep_strtoull
 328 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
 329 #else
 330 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
 331 #define strtoull rep_strtoull
 332 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
 333 #endif
 334 #endif
 335
 336 #ifndef HAVE_FTRUNCATE
 337 #define ftruncate rep_ftruncate
 338 int rep_ftruncate(int,off_t);
 339 #endif
 340
 341 #ifndef HAVE_INITGROUPS
 342 #define initgroups rep_initgroups
 343 int rep_initgroups(char *name, gid_t id);
 344 #endif
 345
 346 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 347 #define bzero(a,b) memset((a),'\0',(b))
 348 #endif
 349
 350 #ifndef HAVE_DLERROR
 351 #define dlerror rep_dlerror
 352 char *rep_dlerror(void);
 353 #endif
 354
 355 #ifndef HAVE_DLOPEN
 356 #define dlopen rep_dlopen
 357 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
 358 void *rep_dlopen(const char *name, unsigned int flags);
 359 #else
 360 void *rep_dlopen(const char *name, int flags);
 361 #endif
 362 #endif
 363
 364 #ifndef HAVE_DLSYM
 365 #define dlsym rep_dlsym
 366 void *rep_dlsym(void *handle, const char *symbol);
 367 #endif
 368
 369 #ifndef HAVE_DLCLOSE
 370 #define dlclose rep_dlclose
 371 int rep_dlclose(void *handle);
 372 #endif
 373
 374 #ifndef HAVE_SOCKETPAIR
 375 #define socketpair rep_socketpair
 376 /* prototype is in system/network.h */
 377 #endif
 378
 379 #ifndef HAVE_VDPRINTF
 380 #define vdprintf rep_vdprintf
 381 int rep_vdprintf(int fd, const char *format, va_list ap);
 382 #endif
 383
 384 #ifndef HAVE_DPRINTF
 385 #define dprintf rep_dprintf
 386 int rep_dprintf(int fd, const char *format, ...);
 387 #endif
 388
 389 #ifndef PRINTF_ATTRIBUTE
 390 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 391 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
 392  * the parameter containing the format, and a2 the index of the first
 393  * argument. Note that some gcc 2.x versions don't handle this
 394  * properly **/
 395 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
 396 #else
 397 #define PRINTF_ATTRIBUTE(a1, a2)
 398 #endif
 399 #endif
 400
 401 #ifndef _DEPRECATED_
 402 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 403 #define _DEPRECATED_ __attribute__ ((deprecated))
 404 #else
 405 #define _DEPRECATED_
 406 #endif
 407 #endif
 408
 409 #ifndef HAVE_VASPRINTF
 410 #define vasprintf rep_vasprintf
 411 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 412 #endif
 413
 414 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 415 #define snprintf rep_snprintf
 416 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 417 #endif
 418
 419 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 420 #define vsnprintf rep_vsnprintf
 421 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
 422 #endif
 423
 424 #ifndef HAVE_ASPRINTF
 425 #define asprintf rep_asprintf
 426 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 427 #endif
 428
 429 #ifndef HAVE_VSYSLOG
 430 #ifdef HAVE_SYSLOG
 431 #define vsyslog rep_vsyslog
 432 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
 433 #endif
 434 #endif
 435
 436 /* we used to use these fns, but now we have good replacements
 437    for snprintf and vsnprintf */
 438 #define slprintf snprintf
 439
 440
 441 #ifndef HAVE_VA_COPY
 442 #undef va_copy
 443 #ifdef HAVE___VA_COPY
 444 #define va_copy(dest, src) __va_copy(dest, src)
 445 #else
 446 #define va_copy(dest, src) (dest) = (src)
 447 #endif
 448 #endif
 449
 450 #ifndef HAVE_VOLATILE
 451 #define volatile
 452 #endif
 453
 454 #ifndef HAVE_COMPARISON_FN_T
 455 typedef int (*comparison_fn_t)(const void *, const void *);
 456 #endif
 457
 458 #ifndef HAVE_WORKING_STRPTIME
 459 #define strptime rep_strptime
 460 struct tm;
 461 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
 462 #endif
 463
 464 #ifndef HAVE_DUP2
 465 #define dup2 rep_dup2
 466 int rep_dup2(int oldfd, int newfd);
 467 #endif
 468
 469 /* Load header file for dynamic linking stuff */
 470 #ifdef HAVE_DLFCN_H
 471 #include <dlfcn.h>
 472 #endif
 473
 474 #ifndef RTLD_LAZY
 475 #define RTLD_LAZY 0
 476 #endif
 477 #ifndef RTLD_NOW
 478 #define RTLD_NOW 0
 479 #endif
 480 #ifndef RTLD_GLOBAL
 481 #define RTLD_GLOBAL 0
 482 #endif
 483
 484 #ifndef HAVE_SECURE_MKSTEMP
 485 #define mkstemp(path) rep_mkstemp(path)
 486 int rep_mkstemp(char *temp);
 487 #endif
 488
 489 #ifndef HAVE_MKDTEMP
 490 #define mkdtemp rep_mkdtemp
 491 char *rep_mkdtemp(char *template);
 492 #endif
 493
 494 #ifndef HAVE_PREAD
 495 #define pread rep_pread
 496 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
 497 #define LIBREPLACE_PREAD_REPLACED 1
 498 #else
 499 #define LIBREPLACE_PREAD_NOT_REPLACED 1
 500 #endif
 501
 502 #ifndef HAVE_PWRITE
 503 #define pwrite rep_pwrite
 504 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
 505 #define LIBREPLACE_PWRITE_REPLACED 1
 506 #else
 507 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
 508 #endif
 509
 510 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
 511 #define inet_ntoa rep_inet_ntoa
 512 /* prototype is in "system/network.h" */
 513 #endif
 514
 515 #ifndef HAVE_INET_PTON
 516 #define inet_pton rep_inet_pton
 517 /* prototype is in "system/network.h" */
 518 #endif
 519
 520 #ifndef HAVE_INET_NTOP
 521 #define inet_ntop rep_inet_ntop
 522 /* prototype is in "system/network.h" */
 523 #endif
 524
 525 #ifndef HAVE_INET_ATON
 526 #define inet_aton rep_inet_aton
 527 /* prototype is in "system/network.h" */
 528 #endif
 529
 530 #ifndef HAVE_CONNECT
 531 #define connect rep_connect
 532 /* prototype is in "system/network.h" */
 533 #endif
 534
 535 #ifndef HAVE_GETHOSTBYNAME
 536 #define gethostbyname rep_gethostbyname
 537 /* prototype is in "system/network.h" */
 538 #endif
 539
 540 #ifndef HAVE_GETIFADDRS
 541 #define getifaddrs rep_getifaddrs
 542 /* prototype is in "system/network.h" */
 543 #endif
 544
 545 #ifndef HAVE_FREEIFADDRS
 546 #define freeifaddrs rep_freeifaddrs
 547 /* prototype is in "system/network.h" */
 548 #endif
 549
 550 #ifndef HAVE_GET_CURRENT_DIR_NAME
 551 #define get_current_dir_name rep_get_current_dir_name
 552 char *rep_get_current_dir_name(void);
 553 #endif
 554
 555 #if !defined(HAVE_STRERROR_R) || !defined(STRERROR_R_PROTO_COMPATIBLE)
 556 #undef strerror_r
 557 #define strerror_r rep_strerror_r
 558 int rep_strerror_r(int errnum, char *buf, size_t buflen);
 559 #endif
 560
 561 #if !defined(HAVE_CLOCK_GETTIME)
 562 #define clock_gettime rep_clock_gettime
 563 #endif
 564
 565 #ifdef HAVE_LIMITS_H
 566 #include <limits.h>
 567 #endif
 568
 569 #ifdef HAVE_SYS_PARAM_H
 570 #include <sys/param.h>
 571 #endif
 572
 573 /* The extra casts work around common compiler bugs.  */
 574 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 575 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 576    It is necessary at least when t == time_t.  */
 577 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
 578                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 579 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
 580
 581 #ifndef UINT16_MAX
 582 #define UINT16_MAX 65535
 583 #endif
 584
 585 #ifndef UINT32_MAX
 586 #define UINT32_MAX (4294967295U)
 587 #endif
 588
 589 #ifndef UINT64_MAX
 590 #define UINT64_MAX ((uint64_t)-1)
 591 #endif
 592
 593 #ifndef INT64_MAX
 594 #define INT64_MAX 9223372036854775807LL
 595 #endif
 596
 597 #ifndef CHAR_BIT
 598 #define CHAR_BIT 8
 599 #endif
 600
 601 #ifndef INT32_MAX
 602 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
 603 #endif
 604
 605 #ifdef HAVE_STDBOOL_H
 606 #include <stdbool.h>
 607 #endif
 608
 609 #if !defined(HAVE_BOOL)
 610 #ifdef HAVE__Bool
 611 #define bool _Bool
 612 #else
 613 typedef int bool;
 614 #endif
 615 #endif
 616
 617 #if !defined(HAVE_INTPTR_T)
 618 typedef long long intptr_t ;
 619 #endif
 620
 621 #if !defined(HAVE_UINTPTR_T)
 622 typedef unsigned long long uintptr_t ;
 623 #endif
 624
 625 #if !defined(HAVE_PTRDIFF_T)
 626 typedef unsigned long long ptrdiff_t ;
 627 #endif
 628
 629 /*
 630  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
 631  *
 632  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
 633  * Tru64 needs _BOOL_EXISTS
 634  * AIX needs _BOOL,_TRUE,_FALSE
 635  */
 636 #ifndef BOOL_DEFINED
 637 #define BOOL_DEFINED
 638 #endif
 639 #ifndef _BOOL_EXISTS
 640 #define _BOOL_EXISTS
 641 #endif
 642 #ifndef _BOOL
 643 #define _BOOL
 644 #endif
 645
 646 #ifndef __bool_true_false_are_defined
 647 #define __bool_true_false_are_defined
 648 #endif
 649
 650 #ifndef true
 651 #define true (1)
 652 #endif
 653 #ifndef false
 654 #define false (0)
 655 #endif
 656
 657 #ifndef _TRUE
 658 #define _TRUE true
 659 #endif
 660 #ifndef _FALSE
 661 #define _FALSE false
 662 #endif
 663
 664 #ifndef HAVE_FUNCTION_MACRO
 665 #ifdef HAVE_func_MACRO
 666 #define __FUNCTION__ __func__
 667 #else
 668 #define __FUNCTION__ ("")
 669 #endif
 670 #endif
 671
 672
 673 #ifndef MIN
 674 #define MIN(a,b) ((a)<(b)?(a):(b))
 675 #endif
 676
 677 #ifndef MAX
 678 #define MAX(a,b) ((a)>(b)?(a):(b))
 679 #endif
 680
 681 #if !defined(HAVE_VOLATILE)
 682 #define volatile
 683 #endif
 684
 685 /**
 686   this is a warning hack. The idea is to use this everywhere that we
 687   get the "discarding const" warning from gcc. That doesn't actually
 688   fix the problem of course, but it means that when we do get to
 689   cleaning them up we can do it by searching the code for
 690   discard_const.
 691
 692   It also means that other error types aren't as swamped by the noise
 693   of hundreds of const warnings, so we are more likely to notice when
 694   we get new errors.
 695
 696   Please only add more uses of this macro when you find it
 697   _really_ hard to fix const warnings. Our aim is to eventually use
 698   this function in only a very few places.
 699
 700   Also, please call this via the discard_const_p() macro interface, as that
 701   makes the return type safe.
 702 */
 703 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
 704
 705 /** Type-safe version of discard_const */
 706 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 707
 708 #ifndef __STRING
 709 #define __STRING(x)    #x
 710 #endif
 711
 712 #ifndef __STRINGSTRING
 713 #define __STRINGSTRING(x) __STRING(x)
 714 #endif
 715
 716 #ifndef __LINESTR__
 717 #define __LINESTR__ __STRINGSTRING(__LINE__)
 718 #endif
 719
 720 #ifndef __location__
 721 #define __location__ __FILE__ ":" __LINESTR__
 722 #endif
 723
 724 /**
 725  * zero a structure
 726  */
 727 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
 728
 729 /**
 730  * zero a structure given a pointer to the structure
 731  */
 732 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
 733
 734 /**
 735  * zero a structure given a pointer to the structure - no zero check
 736  */
 737 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
 738
 739 /* zero an array - note that sizeof(array) must work - ie. it must not be a
 740    pointer */
 741 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
 742
 743 /**
 744  * work out how many elements there are in a static array
 745  */
 746 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
 747
 748 /**
 749  * pointer difference macro
 750  */
 751 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
 752
 753 #if MMAP_BLACKLIST
 754 #undef HAVE_MMAP
 755 #endif
 756
 757 #ifdef __COMPAR_FN_T
 758 #define QSORT_CAST (__compar_fn_t)
 759 #endif
 760
 761 #ifndef QSORT_CAST
 762 #define QSORT_CAST (int (*)(const void *, const void *))
 763 #endif
 764
 765 #ifndef PATH_MAX
 766 #define PATH_MAX 1024
 767 #endif
 768
 769 #ifndef MAX_DNS_NAME_LENGTH
 770 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
 771 #endif
 772
 773 #ifndef HAVE_CRYPT
 774 char *ufc_crypt(const char *key, const char *salt);
 775 #define crypt ufc_crypt
 776 #else
 777 #ifdef HAVE_CRYPT_H
 778 #include <crypt.h>
 779 #endif
 780 #endif
 781
 782 /* these macros gain us a few percent of speed on gcc */
 783 #if (__GNUC__ >= 3)
 784 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
 785    as its first argument */
 786 #ifndef likely
 787 #define likely(x)   __builtin_expect(!!(x), 1)
 788 #endif
 789 #ifndef unlikely
 790 #define unlikely(x) __builtin_expect(!!(x), 0)
 791 #endif
 792 #else
 793 #ifndef likely
 794 #define likely(x) (x)
 795 #endif
 796 #ifndef unlikely
 797 #define unlikely(x) (x)
 798 #endif
 799 #endif
 800
 801 #ifndef HAVE_FDATASYNC
 802 #define fdatasync(fd) fsync(fd)
 803 #elif !defined(HAVE_DECL_FDATASYNC)
 804 int fdatasync(int );
 805 #endif
 806
 807 /* these are used to mark symbols as local to a shared lib, or
 808  * publicly available via the shared lib API */
 809 #ifndef _PUBLIC_
 810 #ifdef HAVE_VISIBILITY_ATTR
 811 #define _PUBLIC_ __attribute__((visibility("default")))
 812 #else
 813 #define _PUBLIC_
 814 #endif
 815 #endif
 816
 817 #ifndef _PRIVATE_
 818 #ifdef HAVE_VISIBILITY_ATTR
 819 #  define _PRIVATE_ __attribute__((visibility("hidden")))
 820 #else
 821 #  define _PRIVATE_
 822 #endif
 823 #endif
 824
 825 #ifndef HAVE_POLL
 826 #define poll rep_poll
 827 /* prototype is in "system/network.h" */
 828 #endif
 829
 830 #if !defined(getpass)
 831 #ifdef REPLACE_GETPASS
 832 #if defined(REPLACE_GETPASS_BY_GETPASSPHRASE)
 833 #define getpass(prompt) getpassphrase(prompt)
 834 #else
 835 #define getpass(prompt) rep_getpass(prompt)
 836 char *rep_getpass(const char *prompt);
 837 #endif
 838 #endif
 839 #endif
 840
 841 #ifndef HAVE_GETPEEREID
 842 #define getpeereid rep_getpeereid
 843 int rep_getpeereid(int s, uid_t *uid, gid_t *gid);
 844 #endif
 845
 846 #ifndef HAVE_USLEEP
 847 #define usleep rep_usleep
 848 typedef long useconds_t;
 849 int usleep(useconds_t);
 850 #endif
 851
 852 #ifndef HAVE_SETPROCTITLE
 853 #define setproctitle rep_setproctitle
 854 void rep_setproctitle(const char *fmt, ...) PRINTF_ATTRIBUTE(1, 2);
 855 #endif
 856
 857 #endif /* _LIBREPLACE_REPLACE_H */