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