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