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