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