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 #include <inttypes.h>
  56 #endif
  57
  58 #ifdef HAVE_STRING_H
  59 #include <string.h>
  60 #endif
  61
  62 #ifdef HAVE_STRINGS_H
  63 #include <strings.h>
  64 #endif
  65
  66 #ifdef HAVE_SYS_TYPES_H
  67 #include <sys/types.h>
  68 #endif
  69
  70 #if STDC_HEADERS
  71 #include <stdlib.h>
  72 #include <stddef.h>
  73 #endif
  74
  75 #ifndef HAVE_STRERROR
  76 extern char *sys_errlist[];
  77 #define strerror(i) sys_errlist[i]
  78 #endif
  79
  80 #ifndef HAVE_ERRNO_DECL
  81 extern int errno;
  82 #endif
  83
  84 #ifndef HAVE_STRDUP
  85 #define strdup rep_strdup
  86 char *rep_strdup(const char *s);
  87 #endif
  88
  89 #ifndef HAVE_MEMMOVE
  90 #define memmove rep_memmove
  91 void *rep_memmove(void *dest,const void *src,int size);
  92 #endif
  93
  94 #ifndef HAVE_MKTIME
  95 #define mktime rep_mktime
  96 /* prototype is in "system/time.h" */
  97 #endif
  98
  99 #ifndef HAVE_TIMEGM
 100 #define timegm rep_timegm
 101 /* prototype is in "system/time.h" */
 102 #endif
 103
 104 #ifndef HAVE_UTIME
 105 #define utime rep_utime
 106 /* prototype is in "system/time.h" */
 107 #endif
 108
 109 #ifndef HAVE_UTIMES
 110 #define utimes rep_utimes
 111 /* prototype is in "system/time.h" */
 112 #endif
 113
 114 #ifndef HAVE_STRLCPY
 115 #define strlcpy rep_strlcpy
 116 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
 117 #endif
 118
 119 #ifndef HAVE_STRLCAT
 120 #define strlcat rep_strlcat
 121 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
 122 #endif
 123
 124 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 125 #undef HAVE_STRNDUP
 126 #define strndup rep_strndup
 127 char *rep_strndup(const char *s, size_t n);
 128 #endif
 129
 130 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
 131 #undef HAVE_STRNLEN
 132 #define strnlen rep_strnlen
 133 size_t rep_strnlen(const char *s, size_t n);
 134 #endif
 135
 136 #ifndef HAVE_SETENV
 137 #define setenv rep_setenv
 138 int rep_setenv(const char *name, const char *value, int overwrite);
 139 #else
 140 #ifndef HAVE_SETENV_DECL
 141 int setenv(const char *name, const char *value, int overwrite);
 142 #endif
 143 #endif
 144
 145 #ifndef HAVE_UNSETENV
 146 #define unsetenv rep_unsetenv
 147 int rep_unsetenv(const char *name);
 148 #endif
 149
 150 #ifndef HAVE_SETEUID
 151 #define seteuid rep_seteuid
 152 int rep_seteuid(uid_t);
 153 #endif
 154
 155 #ifndef HAVE_SETEGID
 156 #define setegid rep_setegid
 157 int rep_setegid(gid_t);
 158 #endif
 159
 160 #ifndef HAVE_SETLINEBUF
 161 #define setlinebuf rep_setlinebuf
 162 void rep_setlinebuf(FILE *);
 163 #endif
 164
 165 #ifndef HAVE_STRCASESTR
 166 #define strcasestr rep_strcasestr
 167 char *rep_strcasestr(const char *haystack, const char *needle);
 168 #endif
 169
 170 #ifndef HAVE_STRTOK_R
 171 #define strtok_r rep_strtok_r
 172 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
 173 #endif
 174
 175 #ifndef HAVE_STRTOLL
 176 #define strtoll rep_strtoll
 177 long long int rep_strtoll(const char *str, char **endptr, int base);
 178 #endif
 179
 180 #ifndef HAVE_STRTOULL
 181 #define strtoull rep_strtoull
 182 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
 183 #endif
 184
 185 #ifndef HAVE_FTRUNCATE
 186 #define ftruncate rep_ftruncate
 187 int rep_ftruncate(int,off_t);
 188 #endif
 189
 190 #ifndef HAVE_INITGROUPS
 191 #define initgroups rep_initgroups
 192 int rep_initgroups(char *name, gid_t id);
 193 #endif
 194
 195 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
 196 #define bzero(a,b) memset((a),'\0',(b))
 197 #endif
 198
 199 #ifndef HAVE_DLERROR
 200 #define dlerror rep_dlerror
 201 char *rep_dlerror(void);
 202 #endif
 203
 204 #ifndef HAVE_DLOPEN
 205 #define dlopen rep_dlopen
 206 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
 207 void *rep_dlopen(const char *name, unsigned int flags);
 208 #else
 209 void *rep_dlopen(const char *name, int flags);
 210 #endif
 211 #endif
 212
 213 #ifndef HAVE_DLSYM
 214 #define dlsym rep_dlsym
 215 void *rep_dlsym(void *handle, const char *symbol);
 216 #endif
 217
 218 #ifndef HAVE_DLCLOSE
 219 #define dlclose rep_dlclose
 220 int rep_dlclose(void *handle);
 221 #endif
 222
 223 #ifndef HAVE_SOCKETPAIR
 224 #define socketpair rep_socketpair
 225 /* prototype is in system/network.h */
 226 #endif
 227
 228 #ifndef PRINTF_ATTRIBUTE
 229 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 230 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
 231  * the parameter containing the format, and a2 the index of the first
 232  * argument. Note that some gcc 2.x versions don't handle this
 233  * properly **/
 234 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
 235 #else
 236 #define PRINTF_ATTRIBUTE(a1, a2)
 237 #endif
 238 #endif
 239
 240 #ifndef _DEPRECATED_
 241 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
 242 #define _DEPRECATED_ __attribute__ ((deprecated))
 243 #else
 244 #define _DEPRECATED_
 245 #endif
 246 #endif
 247
 248 #ifndef HAVE_VASPRINTF
 249 #define vasprintf rep_vasprintf
 250 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 251 #endif
 252
 253 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 254 #define snprintf rep_snprintf
 255 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
 256 #endif
 257
 258 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
 259 #define vsnprintf rep_vsnprintf
 260 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
 261 #endif
 262
 263 #ifndef HAVE_ASPRINTF
 264 #define asprintf rep_asprintf
 265 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
 266 #endif
 267
 268 #ifndef HAVE_VSYSLOG
 269 #ifdef HAVE_SYSLOG
 270 #define vsyslog rep_vsyslog
 271 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
 272 #endif
 273 #endif
 274
 275 /* we used to use these fns, but now we have good replacements
 276    for snprintf and vsnprintf */
 277 #define slprintf snprintf
 278
 279
 280 #ifndef HAVE_VA_COPY
 281 #undef va_copy
 282 #ifdef HAVE___VA_COPY
 283 #define va_copy(dest, src) __va_copy(dest, src)
 284 #else
 285 #define va_copy(dest, src) (dest) = (src)
 286 #endif
 287 #endif
 288
 289 #ifndef HAVE_VOLATILE
 290 #define volatile
 291 #endif
 292
 293 #ifndef HAVE_COMPARISON_FN_T
 294 typedef int (*comparison_fn_t)(const void *, const void *);
 295 #endif
 296
 297 #ifdef REPLACE_STRPTIME
 298 #define strptime rep_strptime
 299 struct tm;
 300 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
 301 #endif
 302
 303 /* Load header file for dynamic linking stuff */
 304 #ifdef HAVE_DLFCN_H
 305 #include <dlfcn.h>
 306 #endif
 307
 308 #ifndef RTLD_LAZY
 309 #define RTLD_LAZY 0
 310 #endif
 311 #ifndef RTLD_NOW
 312 #define RTLD_NOW 0
 313 #endif
 314 #ifndef RTLD_GLOBAL
 315 #define RTLD_GLOBAL 0
 316 #endif
 317
 318 #ifndef HAVE_SECURE_MKSTEMP
 319 #define mkstemp(path) rep_mkstemp(path)
 320 int rep_mkstemp(char *temp);
 321 #endif
 322
 323 #ifndef HAVE_MKDTEMP
 324 #define mkdtemp rep_mkdtemp
 325 char *rep_mkdtemp(char *template);
 326 #endif
 327
 328 #ifndef HAVE_PREAD
 329 #define pread rep_pread
 330 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
 331 #endif
 332
 333 #ifndef HAVE_PWRITE
 334 #define pwrite rep_pwrite
 335 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
 336 #endif
 337
 338 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
 339 #define inet_ntoa rep_inet_ntoa
 340 /* prototype is in "system/network.h" */
 341 #endif
 342
 343 #ifndef HAVE_INET_PTON
 344 #define inet_pton rep_inet_pton
 345 /* prototype is in "system/network.h" */
 346 #endif
 347
 348 #ifndef HAVE_INET_NTOP
 349 #define inet_ntop rep_inet_ntop
 350 /* prototype is in "system/network.h" */
 351 #endif
 352
 353 #ifndef HAVE_INET_ATON
 354 #define inet_aton rep_inet_aton
 355 /* prototype is in "system/network.h" */
 356 #endif
 357
 358 #ifndef HAVE_CONNECT
 359 #define connect rep_connect
 360 /* prototype is in "system/network.h" */
 361 #endif
 362
 363 #ifndef HAVE_GETHOSTBYNAME
 364 #define gethostbyname rep_gethostbyname
 365 /* prototype is in "system/network.h" */
 366 #endif
 367
 368 #ifndef HAVE_GETIFADDRS
 369 #define getifaddrs rep_getifaddrs
 370 /* prototype is in "system/network.h" */
 371 #endif
 372
 373 #ifndef HAVE_FREEIFADDRS
 374 #define freeifaddrs rep_freeifaddrs
 375 /* prototype is in "system/network.h" */
 376 #endif
 377
 378 #ifdef HAVE_LIMITS_H
 379 #include <limits.h>
 380 #endif
 381
 382 #ifdef HAVE_SYS_PARAM_H
 383 #include <sys/param.h>
 384 #endif
 385
 386 /* The extra casts work around common compiler bugs.  */
 387 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 388 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 389    It is necessary at least when t == time_t.  */
 390 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
 391                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 392 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
 393
 394 #ifndef HOST_NAME_MAX
 395 #define HOST_NAME_MAX 255
 396 #endif
 397
 398 /*
 399  * Some older systems seem not to have MAXHOSTNAMELEN
 400  * defined.
 401  */
 402 #ifndef MAXHOSTNAMELEN
 403 #define MAXHOSTNAMELEN HOST_NAME_MAX
 404 #endif
 405
 406 #ifndef UINT16_MAX
 407 #define UINT16_MAX 65535
 408 #endif
 409
 410 #ifndef UINT32_MAX
 411 #define UINT32_MAX (4294967295U)
 412 #endif
 413
 414 #ifndef UINT64_MAX
 415 #define UINT64_MAX ((uint64_t)-1)
 416 #endif
 417
 418 #ifndef CHAR_BIT
 419 #define CHAR_BIT 8
 420 #endif
 421
 422 #ifndef INT32_MAX
 423 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
 424 #endif
 425
 426 #ifdef HAVE_STDBOOL_H
 427 #include <stdbool.h>
 428 #endif
 429
 430 #if !defined(HAVE_BOOL)
 431 #ifdef HAVE__Bool
 432 #define bool _Bool
 433 #else
 434 typedef int bool;
 435 #endif
 436 #endif
 437
 438 /*
 439  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
 440  *
 441  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
 442  * Tru64 needs _BOOL_EXISTS
 443  * AIX needs _BOOL,_TRUE,_FALSE
 444  */
 445 #ifndef BOOL_DEFINED
 446 #define BOOL_DEFINED
 447 #endif
 448 #ifndef _BOOL_EXISTS
 449 #define _BOOL_EXISTS
 450 #endif
 451 #ifndef _BOOL
 452 #define _BOOL
 453 #endif
 454
 455 #ifndef __bool_true_false_are_defined
 456 #define __bool_true_false_are_defined
 457 #endif
 458
 459 #ifndef true
 460 #define true (1)
 461 #endif
 462 #ifndef false
 463 #define false (0)
 464 #endif
 465
 466 #ifndef _TRUE
 467 #define _TRUE true
 468 #endif
 469 #ifndef _FALSE
 470 #define _FALSE false
 471 #endif
 472
 473 #ifndef HAVE_FUNCTION_MACRO
 474 #ifdef HAVE_func_MACRO
 475 #define __FUNCTION__ __func__
 476 #else
 477 #define __FUNCTION__ ("")
 478 #endif
 479 #endif
 480
 481
 482 #ifndef MIN
 483 #define MIN(a,b) ((a)<(b)?(a):(b))
 484 #endif
 485
 486 #ifndef MAX
 487 #define MAX(a,b) ((a)>(b)?(a):(b))
 488 #endif
 489
 490 #if !defined(HAVE_VOLATILE)
 491 #define volatile
 492 #endif
 493
 494 /**
 495   this is a warning hack. The idea is to use this everywhere that we
 496   get the "discarding const" warning from gcc. That doesn't actually
 497   fix the problem of course, but it means that when we do get to
 498   cleaning them up we can do it by searching the code for
 499   discard_const.
 500
 501   It also means that other error types aren't as swamped by the noise
 502   of hundreds of const warnings, so we are more likely to notice when
 503   we get new errors.
 504
 505   Please only add more uses of this macro when you find it
 506   _really_ hard to fix const warnings. Our aim is to eventually use
 507   this function in only a very few places.
 508
 509   Also, please call this via the discard_const_p() macro interface, as that
 510   makes the return type safe.
 511 */
 512 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
 513
 514 /** Type-safe version of discard_const */
 515 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 516
 517 #ifndef __STRING
 518 #define __STRING(x)    #x
 519 #endif
 520
 521 #ifndef __STRINGSTRING
 522 #define __STRINGSTRING(x) __STRING(x)
 523 #endif
 524
 525 #ifndef __LINESTR__
 526 #define __LINESTR__ __STRINGSTRING(__LINE__)
 527 #endif
 528
 529 #ifndef __location__
 530 #define __location__ __FILE__ ":" __LINESTR__
 531 #endif
 532
 533 /**
 534  * zero a structure
 535  */
 536 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
 537
 538 /**
 539  * zero a structure given a pointer to the structure
 540  */
 541 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
 542
 543 /**
 544  * zero a structure given a pointer to the structure - no zero check
 545  */
 546 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
 547
 548 /* zero an array - note that sizeof(array) must work - ie. it must not be a
 549    pointer */
 550 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
 551
 552 /**
 553  * work out how many elements there are in a static array
 554  */
 555 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
 556
 557 /**
 558  * pointer difference macro
 559  */
 560 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
 561
 562 #if MMAP_BLACKLIST
 563 #undef HAVE_MMAP
 564 #endif
 565
 566 #ifdef __COMPAR_FN_T
 567 #define QSORT_CAST (__compar_fn_t)
 568 #endif
 569
 570 #ifndef QSORT_CAST
 571 #define QSORT_CAST (int (*)(const void *, const void *))
 572 #endif
 573
 574 #ifndef PATH_MAX
 575 #define PATH_MAX 1024
 576 #endif
 577
 578 #ifndef MAX_DNS_NAME_LENGTH
 579 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
 580 #endif
 581
 582 #endif /* _LIBREPLACE_REPLACE_H */