2 Unix SMB/CIFS implementation.
4 macros to go along with the lib/replace/ portability layer code
6 Copyright (C) Andrew Tridgell 2005
7 Copyright (C) Jelmer Vernooij 2006-2008
8 Copyright (C) Jeremy Allison 2007.
10 ** NOTE! The following LGPL license applies to the replace
11 ** library. This does NOT imply that all of Samba is released
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.
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.
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/>.
28 #ifndef _LIBREPLACE_REPLACE_H
29 #define _LIBREPLACE_REPLACE_H
35 #ifdef HAVE_STANDARDS_H
36 #include <standards.h>
44 #if defined(_MSC_VER) || defined(__MINGW32__)
45 #include "win32_replace.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
55 #define __STDC_FORMAT_MACROS
59 #ifndef __PRI64_PREFIX
61 # define __PRI64_PREFIX "l"
63 # define __PRI64_PREFIX "ll"
67 /* Decimal notation. */
78 # define PRId64 __PRI64_PREFIX "d"
91 # define PRIi64 __PRI64_PREFIX "i"
104 # define PRIu64 __PRI64_PREFIX "u"
111 #ifdef HAVE_STRINGS_H
115 #ifdef HAVE_SYS_TYPES_H
116 #include <sys/types.h>
124 #ifndef HAVE_STRERROR
125 extern char *sys_errlist
[];
126 #define strerror(i) sys_errlist[i]
129 #ifndef HAVE_ERRNO_DECL
134 #define strdup rep_strdup
135 char *rep_strdup(const char *s
);
139 #define memmove rep_memmove
140 void *rep_memmove(void *dest
,const void *src
,int size
);
144 #define memmem rep_memmem
145 void *rep_memmem(const void *haystack
, size_t haystacklen
,
146 const void *needle
, size_t needlelen
);
150 #define mktime rep_mktime
151 /* prototype is in "system/time.h" */
155 #define timegm rep_timegm
156 /* prototype is in "system/time.h" */
160 #define utime rep_utime
161 /* prototype is in "system/time.h" */
165 #define utimes rep_utimes
166 /* prototype is in "system/time.h" */
170 #define strlcpy rep_strlcpy
171 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
175 #define strlcat rep_strlcat
176 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
179 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
181 #define strndup rep_strndup
182 char *rep_strndup(const char *s
, size_t n
);
185 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
187 #define strnlen rep_strnlen
188 size_t rep_strnlen(const char *s
, size_t n
);
191 #if !HAVE_DECL_ENVIRON
193 #include <crt_externs.h>
194 #define environ (*_NSGetEnviron())
196 extern char **environ
;
201 #define setenv rep_setenv
202 int rep_setenv(const char *name
, const char *value
, int overwrite
);
204 #ifndef HAVE_SETENV_DECL
205 int setenv(const char *name
, const char *value
, int overwrite
);
209 #ifndef HAVE_UNSETENV
210 #define unsetenv rep_unsetenv
211 int rep_unsetenv(const char *name
);
215 #define seteuid rep_seteuid
216 int rep_seteuid(uid_t
);
220 #define setegid rep_setegid
221 int rep_setegid(gid_t
);
224 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
226 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
228 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
229 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
233 #define chown rep_chown
234 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
238 #define chroot rep_chroot
239 int rep_chroot(const char *dirname
);
243 #define link rep_link
244 int rep_link(const char *oldpath
, const char *newpath
);
247 #ifndef HAVE_READLINK
248 #define readlink rep_readlink
249 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
253 #define symlink rep_symlink
254 int rep_symlink(const char *oldpath
, const char *newpath
);
257 #ifndef HAVE_REALPATH
258 #define realpath rep_realpath
259 char *rep_realpath(const char *path
, char *resolved_path
);
263 #define lchown rep_lchown
264 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
271 #ifndef HAVE_SETLINEBUF
272 #define setlinebuf rep_setlinebuf
273 void rep_setlinebuf(FILE *);
276 #ifndef HAVE_STRCASESTR
277 #define strcasestr rep_strcasestr
278 char *rep_strcasestr(const char *haystack
, const char *needle
);
281 #ifndef HAVE_STRTOK_R
282 #define strtok_r rep_strtok_r
283 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
289 #define strtoll rep_strtoll
290 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
292 #ifdef HAVE_BSD_STRTOLL
293 #define strtoll rep_strtoll
294 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
298 #ifndef HAVE_STRTOULL
299 #define strtoull rep_strtoull
300 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
302 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
303 #define strtoull rep_strtoull
304 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
308 #ifndef HAVE_FTRUNCATE
309 #define ftruncate rep_ftruncate
310 int rep_ftruncate(int,off_t
);
313 #ifndef HAVE_INITGROUPS
314 #define initgroups rep_initgroups
315 int rep_initgroups(char *name
, gid_t id
);
318 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
319 #define bzero(a,b) memset((a),'\0',(b))
323 #define dlerror rep_dlerror
324 char *rep_dlerror(void);
328 #define dlopen rep_dlopen
329 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
330 void *rep_dlopen(const char *name
, unsigned int flags
);
332 void *rep_dlopen(const char *name
, int flags
);
337 #define dlsym rep_dlsym
338 void *rep_dlsym(void *handle
, const char *symbol
);
342 #define dlclose rep_dlclose
343 int rep_dlclose(void *handle
);
346 #ifndef HAVE_SOCKETPAIR
347 #define socketpair rep_socketpair
348 /* prototype is in system/network.h */
351 #ifndef HAVE_VDPRINTF
352 #define vdprintf rep_vdprintf
353 int rep_vdprintf(int fd
, const char *format
, va_list ap
);
357 #define dprintf rep_dprintf
358 int rep_dprintf(int fd
, const char *format
, ...);
361 #ifndef PRINTF_ATTRIBUTE
362 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
363 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
364 * the parameter containing the format, and a2 the index of the first
365 * argument. Note that some gcc 2.x versions don't handle this
367 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
369 #define PRINTF_ATTRIBUTE(a1, a2)
374 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
375 #define _DEPRECATED_ __attribute__ ((deprecated))
381 #ifndef HAVE_VASPRINTF
382 #define vasprintf rep_vasprintf
383 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
386 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
387 #define snprintf rep_snprintf
388 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
391 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
392 #define vsnprintf rep_vsnprintf
393 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
396 #ifndef HAVE_ASPRINTF
397 #define asprintf rep_asprintf
398 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
403 #define vsyslog rep_vsyslog
404 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
408 /* we used to use these fns, but now we have good replacements
409 for snprintf and vsnprintf */
410 #define slprintf snprintf
415 #ifdef HAVE___VA_COPY
416 #define va_copy(dest, src) __va_copy(dest, src)
418 #define va_copy(dest, src) (dest) = (src)
422 #ifndef HAVE_VOLATILE
426 #ifndef HAVE_COMPARISON_FN_T
427 typedef int (*comparison_fn_t
)(const void *, const void *);
430 #ifdef REPLACE_STRPTIME
431 #define strptime rep_strptime
433 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
437 #define dup2 rep_dup2
438 int rep_dup2(int oldfd
, int newfd
);
441 /* Load header file for dynamic linking stuff */
453 #define RTLD_GLOBAL 0
456 #ifndef HAVE_SECURE_MKSTEMP
457 #define mkstemp(path) rep_mkstemp(path)
458 int rep_mkstemp(char *temp
);
462 #define mkdtemp rep_mkdtemp
463 char *rep_mkdtemp(char *template);
467 #define pread rep_pread
468 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
469 #define LIBREPLACE_PREAD_REPLACED 1
471 #define LIBREPLACE_PREAD_NOT_REPLACED 1
475 #define pwrite rep_pwrite
476 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
477 #define LIBREPLACE_PWRITE_REPLACED 1
479 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
482 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
483 #define inet_ntoa rep_inet_ntoa
484 /* prototype is in "system/network.h" */
487 #ifndef HAVE_INET_PTON
488 #define inet_pton rep_inet_pton
489 /* prototype is in "system/network.h" */
492 #ifndef HAVE_INET_NTOP
493 #define inet_ntop rep_inet_ntop
494 /* prototype is in "system/network.h" */
497 #ifndef HAVE_INET_ATON
498 #define inet_aton rep_inet_aton
499 /* prototype is in "system/network.h" */
503 #define connect rep_connect
504 /* prototype is in "system/network.h" */
507 #ifndef HAVE_GETHOSTBYNAME
508 #define gethostbyname rep_gethostbyname
509 /* prototype is in "system/network.h" */
512 #ifndef HAVE_GETIFADDRS
513 #define getifaddrs rep_getifaddrs
514 /* prototype is in "system/network.h" */
517 #ifndef HAVE_FREEIFADDRS
518 #define freeifaddrs rep_freeifaddrs
519 /* prototype is in "system/network.h" */
522 #ifndef HAVE_GET_CURRENT_DIR_NAME
523 #define get_current_dir_name rep_get_current_dir_name
524 char *rep_get_current_dir_name(void);
527 #if !defined(HAVE_STRERROR_R) || !defined(STRERROR_R_PROTO_COMPATIBLE)
529 #define strerror_r rep_strerror_r
530 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
533 #if !defined(HAVE_CLOCK_GETTIME)
534 #define clock_gettime rep_clock_gettime
541 #ifdef HAVE_SYS_PARAM_H
542 #include <sys/param.h>
545 /* The extra casts work around common compiler bugs. */
546 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
547 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
548 It is necessary at least when t == time_t. */
549 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
550 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
551 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
554 #define UINT16_MAX 65535
558 #define UINT32_MAX (4294967295U)
562 #define UINT64_MAX ((uint64_t)-1)
570 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
573 #ifdef HAVE_STDBOOL_H
577 #if !defined(HAVE_BOOL)
585 #if !defined(HAVE_INTPTR_T)
586 typedef long long intptr_t ;
589 #if !defined(HAVE_UINTPTR_T)
590 typedef unsigned long long uintptr_t ;
593 #if !defined(HAVE_PTRDIFF_T)
594 typedef unsigned long long ptrdiff_t ;
598 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
600 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
601 * Tru64 needs _BOOL_EXISTS
602 * AIX needs _BOOL,_TRUE,_FALSE
614 #ifndef __bool_true_false_are_defined
615 #define __bool_true_false_are_defined
632 #ifndef HAVE_FUNCTION_MACRO
633 #ifdef HAVE_func_MACRO
634 #define __FUNCTION__ __func__
636 #define __FUNCTION__ ("")
642 #define MIN(a,b) ((a)<(b)?(a):(b))
646 #define MAX(a,b) ((a)>(b)?(a):(b))
649 #if !defined(HAVE_VOLATILE)
654 this is a warning hack. The idea is to use this everywhere that we
655 get the "discarding const" warning from gcc. That doesn't actually
656 fix the problem of course, but it means that when we do get to
657 cleaning them up we can do it by searching the code for
660 It also means that other error types aren't as swamped by the noise
661 of hundreds of const warnings, so we are more likely to notice when
664 Please only add more uses of this macro when you find it
665 _really_ hard to fix const warnings. Our aim is to eventually use
666 this function in only a very few places.
668 Also, please call this via the discard_const_p() macro interface, as that
669 makes the return type safe.
671 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
673 /** Type-safe version of discard_const */
674 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
677 #define __STRING(x) #x
680 #ifndef __STRINGSTRING
681 #define __STRINGSTRING(x) __STRING(x)
685 #define __LINESTR__ __STRINGSTRING(__LINE__)
689 #define __location__ __FILE__ ":" __LINESTR__
695 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
698 * zero a structure given a pointer to the structure
700 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
703 * zero a structure given a pointer to the structure - no zero check
705 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
707 /* zero an array - note that sizeof(array) must work - ie. it must not be a
709 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
712 * work out how many elements there are in a static array
714 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
717 * pointer difference macro
719 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
726 #define QSORT_CAST (__compar_fn_t)
730 #define QSORT_CAST (int (*)(const void *, const void *))
734 #define PATH_MAX 1024
737 #ifndef MAX_DNS_NAME_LENGTH
738 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
742 char *ufc_crypt(const char *key
, const char *salt
);
743 #define crypt ufc_crypt
750 /* these macros gain us a few percent of speed on gcc */
752 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
753 as its first argument */
755 #define likely(x) __builtin_expect(!!(x), 1)
758 #define unlikely(x) __builtin_expect(!!(x), 0)
762 #define likely(x) (x)
765 #define unlikely(x) (x)
769 #ifndef HAVE_FDATASYNC
770 #define fdatasync(fd) fsync(fd)
771 #elif !defined(HAVE_DECL_FDATASYNC)
775 /* these are used to mark symbols as local to a shared lib, or
776 * publicly available via the shared lib API */
778 #ifdef HAVE_VISIBILITY_ATTR
779 #define _PUBLIC_ __attribute__((visibility("default")))
786 #ifdef HAVE_VISIBILITY_ATTR
787 # define _PRIVATE_ __attribute__((visibility("hidden")))
793 #endif /* _LIBREPLACE_REPLACE_H */