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_CHOWN
 219 #define chown rep_chown
 220 int rep_chown(const char *path, uid_t uid, gid_t gid);
 221 #endif
 222
 223 #ifndef HAVE_CHROOT
 224 #define chroot rep_chroot
 225 int rep_chroot(const char *dirname);
 226 #endif
 227
 228 #ifndef HAVE_LINK
 229 #define link rep_link
 230 int rep_link(const char *oldpath, const char *newpath);
 231 #endif
 232
 233 #ifndef HAVE_READLINK
 234 #define readlink rep_readlink
 235 int rep_readlink(const char *path, char *buf, size_t bufsize);
 236 #endif
 237
 238 #ifndef HAVE_SYMLINK
 239 #define symlink rep_symlink
 240 int rep_symlink(const char *oldpath, const char *newpath);
 241 #endif
 242
 243 #ifndef HAVE_REALPATH
 244 #define realpath rep_realpath
 245 char *rep_realpath(const char *path, char *resolved_path);
 246 #endif
 247
 248 #ifndef HAVE_LCHOWN
 249 #define lchown rep_lchown
 250 int rep_lchown(const char *fname,uid_t uid,gid_t gid);
 251 #endif
 252
 253 #ifndef HAVE_SETLINEBUF
 254 #define setlinebuf rep_setlinebuf
 255 void rep_setlinebuf(FILE *);
 256 #endif
 257
 258 #ifndef HAVE_STRCASESTR
 259 #define strcasestr rep_strcasestr
 260 char *rep_strcasestr(const char *haystack, const char *needle);
 261 #endif
 262
 263 #ifndef HAVE_STRTOK_R
 264 #define strtok_r rep_strtok_r
 265 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
 266 #endif
 267
 268 #ifndef HAVE_STRTOLL
 269 #define strtoll rep_strtoll
 270 long long int rep_strtoll(const char *str, char **endptr, int base);
 271 #endif
 272
 273 #ifndef HAVE_STRTOULL
 274 #define strtoull rep_strtoull
 275 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
 276 #endif
 277
 278 #ifndef HAVE_FTRUNCATE
 279 #define ftruncate rep_ftruncate
 280 int rep_ftruncate(int,off_t);
 281 #endif
 282
 283 #ifndef HAVE_INITGROUPS
 284 #define initgroups rep_initgroups
 285 int rep_initgroups(char *name, gid_t id);
 286 #endif
 287
 288 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 289 #define bzero(a,b) memset((a),'\0',(b))
 290 #endif
 291
 292 #ifndef HAVE_DLERROR
 293 #define dlerror rep_dlerror
 294 char *rep_dlerror(void);
 295 #endif
 296
 297 #ifndef HAVE_DLOPEN
 298 #define dlopen rep_dlopen
 299 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
 300 void *rep_dlopen(const char *name, unsigned int flags);
 301 #else
 302 void *rep_dlopen(const char *name, int flags);
 303 #endif
 304 #endif
 305
 306 #ifndef HAVE_DLSYM
 307 #define dlsym rep_dlsym
 308 void *rep_dlsym(void *handle, const char *symbol);
 309 #endif
 310
 311 #ifndef HAVE_DLCLOSE
 312 #define dlclose rep_dlclose
 313 int rep_dlclose(void *handle);
 314 #endif
 315
 316 #ifndef HAVE_SOCKETPAIR
 317 #define socketpair rep_socketpair
 318 /* prototype is in system/network.h */
 319 #endif
 320
 321 #ifndef PRINTF_ATTRIBUTE
 322 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 323 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
 324  * the parameter containing the format, and a2 the index of the first
 325  * argument. Note that some gcc 2.x versions don't handle this
 326  * properly **/
 327 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
 328 #else
 329 #define PRINTF_ATTRIBUTE(a1, a2)
 330 #endif
 331 #endif
 332
 333 #ifndef _DEPRECATED_
 334 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 335 #define _DEPRECATED_ __attribute__ ((deprecated))
 336 #else
 337 #define _DEPRECATED_
 338 #endif
 339 #endif
 340
 341 #ifndef HAVE_VASPRINTF
 342 #define vasprintf rep_vasprintf
 343 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 344 #endif
 345
 346 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 347 #define snprintf rep_snprintf
 348 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 349 #endif
 350
 351 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 352 #define vsnprintf rep_vsnprintf
 353 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
 354 #endif
 355
 356 #ifndef HAVE_ASPRINTF
 357 #define asprintf rep_asprintf
 358 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 359 #endif
 360
 361 #ifndef HAVE_VSYSLOG
 362 #ifdef HAVE_SYSLOG
 363 #define vsyslog rep_vsyslog
 364 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
 365 #endif
 366 #endif
 367
 368 /* we used to use these fns, but now we have good replacements
 369    for snprintf and vsnprintf */
 370 #define slprintf snprintf
 371
 372
 373 #ifndef HAVE_VA_COPY
 374 #undef va_copy
 375 #ifdef HAVE___VA_COPY
 376 #define va_copy(dest, src) __va_copy(dest, src)
 377 #else
 378 #define va_copy(dest, src) (dest) = (src)
 379 #endif
 380 #endif
 381
 382 #ifndef HAVE_VOLATILE
 383 #define volatile
 384 #endif
 385
 386 #ifndef HAVE_COMPARISON_FN_T
 387 typedef int (*comparison_fn_t)(const void *, const void *);
 388 #endif
 389
 390 #ifdef REPLACE_STRPTIME
 391 #define strptime rep_strptime
 392 struct tm;
 393 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
 394 #endif
 395
 396 #ifndef HAVE_DUP2
 397 #define dup2 rep_dup2
 398 int rep_dup2(int oldfd, int newfd);
 399 #endif
 400
 401 /* Load header file for dynamic linking stuff */
 402 #ifdef HAVE_DLFCN_H
 403 #include <dlfcn.h>
 404 #endif
 405
 406 #ifndef RTLD_LAZY
 407 #define RTLD_LAZY 0
 408 #endif
 409 #ifndef RTLD_NOW
 410 #define RTLD_NOW 0
 411 #endif
 412 #ifndef RTLD_GLOBAL
 413 #define RTLD_GLOBAL 0
 414 #endif
 415
 416 #ifndef HAVE_SECURE_MKSTEMP
 417 #define mkstemp(path) rep_mkstemp(path)
 418 int rep_mkstemp(char *temp);
 419 #endif
 420
 421 #ifndef HAVE_MKDTEMP
 422 #define mkdtemp rep_mkdtemp
 423 char *rep_mkdtemp(char *template);
 424 #endif
 425
 426 #ifndef HAVE_PREAD
 427 #define pread rep_pread
 428 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
 429 #endif
 430
 431 #ifndef HAVE_PWRITE
 432 #define pwrite rep_pwrite
 433 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
 434 #endif
 435
 436 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
 437 #define inet_ntoa rep_inet_ntoa
 438 /* prototype is in "system/network.h" */
 439 #endif
 440
 441 #ifndef HAVE_INET_PTON
 442 #define inet_pton rep_inet_pton
 443 /* prototype is in "system/network.h" */
 444 #endif
 445
 446 #ifndef HAVE_INET_NTOP
 447 #define inet_ntop rep_inet_ntop
 448 /* prototype is in "system/network.h" */
 449 #endif
 450
 451 #ifndef HAVE_INET_ATON
 452 #define inet_aton rep_inet_aton
 453 /* prototype is in "system/network.h" */
 454 #endif
 455
 456 #ifndef HAVE_CONNECT
 457 #define connect rep_connect
 458 /* prototype is in "system/network.h" */
 459 #endif
 460
 461 #ifndef HAVE_GETHOSTBYNAME
 462 #define gethostbyname rep_gethostbyname
 463 /* prototype is in "system/network.h" */
 464 #endif
 465
 466 #ifndef HAVE_GETIFADDRS
 467 #define getifaddrs rep_getifaddrs
 468 /* prototype is in "system/network.h" */
 469 #endif
 470
 471 #ifndef HAVE_FREEIFADDRS
 472 #define freeifaddrs rep_freeifaddrs
 473 /* prototype is in "system/network.h" */
 474 #endif
 475
 476 #ifdef HAVE_LIMITS_H
 477 #include <limits.h>
 478 #endif
 479
 480 #ifdef HAVE_SYS_PARAM_H
 481 #include <sys/param.h>
 482 #endif
 483
 484 /* The extra casts work around common compiler bugs.  */
 485 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 486 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 487    It is necessary at least when t == time_t.  */
 488 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
 489                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 490 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
 491
 492 #ifndef HOST_NAME_MAX
 493 #define HOST_NAME_MAX 255
 494 #endif
 495
 496 /*
 497  * Some older systems seem not to have MAXHOSTNAMELEN
 498  * defined.
 499  */
 500 #ifndef MAXHOSTNAMELEN
 501 #define MAXHOSTNAMELEN HOST_NAME_MAX
 502 #endif
 503
 504 #ifndef UINT16_MAX
 505 #define UINT16_MAX 65535
 506 #endif
 507
 508 #ifndef UINT32_MAX
 509 #define UINT32_MAX (4294967295U)
 510 #endif
 511
 512 #ifndef UINT64_MAX
 513 #define UINT64_MAX ((uint64_t)-1)
 514 #endif
 515
 516 #ifndef CHAR_BIT
 517 #define CHAR_BIT 8
 518 #endif
 519
 520 #ifndef INT32_MAX
 521 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
 522 #endif
 523
 524 #ifdef HAVE_STDBOOL_H
 525 #include <stdbool.h>
 526 #endif
 527
 528 #if !defined(HAVE_BOOL)
 529 #ifdef HAVE__Bool
 530 #define bool _Bool
 531 #else
 532 typedef int bool;
 533 #endif
 534 #endif
 535
 536 /*
 537  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
 538  *
 539  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
 540  * Tru64 needs _BOOL_EXISTS
 541  * AIX needs _BOOL,_TRUE,_FALSE
 542  */
 543 #ifndef BOOL_DEFINED
 544 #define BOOL_DEFINED
 545 #endif
 546 #ifndef _BOOL_EXISTS
 547 #define _BOOL_EXISTS
 548 #endif
 549 #ifndef _BOOL
 550 #define _BOOL
 551 #endif
 552
 553 #ifndef __bool_true_false_are_defined
 554 #define __bool_true_false_are_defined
 555 #endif
 556
 557 #ifndef true
 558 #define true (1)
 559 #endif
 560 #ifndef false
 561 #define false (0)
 562 #endif
 563
 564 #ifndef _TRUE
 565 #define _TRUE true
 566 #endif
 567 #ifndef _FALSE
 568 #define _FALSE false
 569 #endif
 570
 571 #ifndef HAVE_FUNCTION_MACRO
 572 #ifdef HAVE_func_MACRO
 573 #define __FUNCTION__ __func__
 574 #else
 575 #define __FUNCTION__ ("")
 576 #endif
 577 #endif
 578
 579
 580 #ifndef MIN
 581 #define MIN(a,b) ((a)<(b)?(a):(b))
 582 #endif
 583
 584 #ifndef MAX
 585 #define MAX(a,b) ((a)>(b)?(a):(b))
 586 #endif
 587
 588 #if !defined(HAVE_VOLATILE)
 589 #define volatile
 590 #endif
 591
 592 /**
 593   this is a warning hack. The idea is to use this everywhere that we
 594   get the "discarding const" warning from gcc. That doesn't actually
 595   fix the problem of course, but it means that when we do get to
 596   cleaning them up we can do it by searching the code for
 597   discard_const.
 598
 599   It also means that other error types aren't as swamped by the noise
 600   of hundreds of const warnings, so we are more likely to notice when
 601   we get new errors.
 602
 603   Please only add more uses of this macro when you find it
 604   _really_ hard to fix const warnings. Our aim is to eventually use
 605   this function in only a very few places.
 606
 607   Also, please call this via the discard_const_p() macro interface, as that
 608   makes the return type safe.
 609 */
 610 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
 611
 612 /** Type-safe version of discard_const */
 613 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 614
 615 #ifndef __STRING
 616 #define __STRING(x)    #x
 617 #endif
 618
 619 #ifndef __STRINGSTRING
 620 #define __STRINGSTRING(x) __STRING(x)
 621 #endif
 622
 623 #ifndef __LINESTR__
 624 #define __LINESTR__ __STRINGSTRING(__LINE__)
 625 #endif
 626
 627 #ifndef __location__
 628 #define __location__ __FILE__ ":" __LINESTR__
 629 #endif
 630
 631 /**
 632  * zero a structure
 633  */
 634 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
 635
 636 /**
 637  * zero a structure given a pointer to the structure
 638  */
 639 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
 640
 641 /**
 642  * zero a structure given a pointer to the structure - no zero check
 643  */
 644 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
 645
 646 /* zero an array - note that sizeof(array) must work - ie. it must not be a
 647    pointer */
 648 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
 649
 650 /**
 651  * work out how many elements there are in a static array
 652  */
 653 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
 654
 655 /**
 656  * pointer difference macro
 657  */
 658 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
 659
 660 #if MMAP_BLACKLIST
 661 #undef HAVE_MMAP
 662 #endif
 663
 664 #ifdef __COMPAR_FN_T
 665 #define QSORT_CAST (__compar_fn_t)
 666 #endif
 667
 668 #ifndef QSORT_CAST
 669 #define QSORT_CAST (int (*)(const void *, const void *))
 670 #endif
 671
 672 #ifndef PATH_MAX
 673 #define PATH_MAX 1024
 674 #endif
 675
 676 #ifndef MAX_DNS_NAME_LENGTH
 677 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
 678 #endif
 679
 680 #ifndef HAVE_CRYPT
 681 char *ufc_crypt(const char *key, const char *salt);
 682 #define crypt ufc_crypt
 683 #else
 684 #ifdef HAVE_CRYPT_H
 685 #include <crypt.h>
 686 #endif
 687 #endif
 688
 689 #endif /* _LIBREPLACE_REPLACE_H */