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