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