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