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