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