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 #ifndef HAVE_DECL_EWOULDBLOCK
45 #define EWOULDBLOCK EAGAIN
48 #if defined(_MSC_VER) || defined(__MINGW32__)
49 #include "win32_replace.h"
53 #ifdef HAVE_INTTYPES_H
54 #define __STDC_FORMAT_MACROS
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
67 #ifndef __PRI64_PREFIX
68 # if __WORDSIZE == 64 && ! defined __APPLE__
69 # define __PRI64_PREFIX "l"
71 # define __PRI64_PREFIX "ll"
75 /* Decimal notation. */
86 # define PRId64 __PRI64_PREFIX "d"
99 # define PRIi64 __PRI64_PREFIX "i"
112 # define PRIu64 __PRI64_PREFIX "u"
125 # define SCNd64 __PRI64_PREFIX "d"
138 # define SCNi64 __PRI64_PREFIX "i"
151 # define SCNu64 __PRI64_PREFIX "u"
154 #ifdef HAVE_BSD_STRING_H
155 #include <bsd/string.h>
158 #ifdef HAVE_BSD_UNISTD_H
159 #include <bsd/unistd.h>
166 #ifdef HAVE_STRINGS_H
170 #ifdef HAVE_SYS_TYPES_H
171 #include <sys/types.h>
174 #ifdef HAVE_SETPROCTITLE_H
175 #include <setproctitle.h>
183 #ifdef HAVE_LINUX_TYPES_H
185 * This is needed as some broken header files require this to be included early
187 #include <linux/types.h>
190 #ifndef HAVE_STRERROR
191 extern char *sys_errlist
[];
192 #define strerror(i) sys_errlist[i]
195 #ifndef HAVE_ERRNO_DECL
200 #define strdup rep_strdup
201 char *rep_strdup(const char *s
);
205 #define memmove rep_memmove
206 void *rep_memmove(void *dest
,const void *src
,int size
);
210 #define memmem rep_memmem
211 void *rep_memmem(const void *haystack
, size_t haystacklen
,
212 const void *needle
, size_t needlelen
);
215 #ifndef HAVE_MEMALIGN
216 #define memalign rep_memalign
217 void *rep_memalign(size_t boundary
, size_t size
);
221 #define mktime rep_mktime
222 /* prototype is in "system/time.h" */
226 #define timegm rep_timegm
227 /* prototype is in "system/time.h" */
231 #define utime rep_utime
232 /* prototype is in "system/time.h" */
236 #define utimes rep_utimes
237 /* prototype is in "system/time.h" */
241 #define strlcpy rep_strlcpy
242 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
246 #define strlcat rep_strlcat
247 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
250 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
252 #define strndup rep_strndup
253 char *rep_strndup(const char *s
, size_t n
);
256 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
258 #define strnlen rep_strnlen
259 size_t rep_strnlen(const char *s
, size_t n
);
262 #if !HAVE_DECL_ENVIRON
264 #include <crt_externs.h>
265 #define environ (*_NSGetEnviron())
267 extern char **environ
;
272 #define setenv rep_setenv
273 int rep_setenv(const char *name
, const char *value
, int overwrite
);
275 #ifndef HAVE_SETENV_DECL
276 int setenv(const char *name
, const char *value
, int overwrite
);
280 #ifndef HAVE_UNSETENV
281 #define unsetenv rep_unsetenv
282 int rep_unsetenv(const char *name
);
286 #define seteuid rep_seteuid
287 int rep_seteuid(uid_t
);
291 #define setegid rep_setegid
292 int rep_setegid(gid_t
);
295 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
297 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
299 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
300 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
304 #define chown rep_chown
305 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
309 #define chroot rep_chroot
310 int rep_chroot(const char *dirname
);
314 #define link rep_link
315 int rep_link(const char *oldpath
, const char *newpath
);
318 #ifndef HAVE_READLINK
319 #define readlink rep_readlink
320 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
324 #define symlink rep_symlink
325 int rep_symlink(const char *oldpath
, const char *newpath
);
328 #ifndef HAVE_REALPATH
329 #define realpath rep_realpath
330 char *rep_realpath(const char *path
, char *resolved_path
);
334 #define lchown rep_lchown
335 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
342 #ifndef HAVE_SETLINEBUF
343 #define setlinebuf rep_setlinebuf
344 void rep_setlinebuf(FILE *);
347 #ifndef HAVE_STRCASESTR
348 #define strcasestr rep_strcasestr
349 char *rep_strcasestr(const char *haystack
, const char *needle
);
352 #ifndef HAVE_STRTOK_R
353 #define strtok_r rep_strtok_r
354 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
360 #define strtoll rep_strtoll
361 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
363 #ifdef HAVE_BSD_STRTOLL
364 #define strtoll rep_strtoll
365 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
369 #ifndef HAVE_STRTOULL
370 #define strtoull rep_strtoull
371 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
373 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
374 #define strtoull rep_strtoull
375 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
379 #ifndef HAVE_FTRUNCATE
380 #define ftruncate rep_ftruncate
381 int rep_ftruncate(int,off_t
);
384 #ifndef HAVE_INITGROUPS
385 #define initgroups rep_initgroups
386 int rep_initgroups(char *name
, gid_t id
);
389 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
390 #define bzero(a,b) memset((a),'\0',(b))
394 #define dlerror rep_dlerror
395 char *rep_dlerror(void);
399 #define dlopen rep_dlopen
400 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
401 void *rep_dlopen(const char *name
, unsigned int flags
);
403 void *rep_dlopen(const char *name
, int flags
);
408 #define dlsym rep_dlsym
409 void *rep_dlsym(void *handle
, const char *symbol
);
413 #define dlclose rep_dlclose
414 int rep_dlclose(void *handle
);
417 #ifndef HAVE_SOCKETPAIR
418 #define socketpair rep_socketpair
419 /* prototype is in system/network.h */
422 #ifndef PRINTF_ATTRIBUTE
423 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
424 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
425 * the parameter containing the format, and a2 the index of the first
426 * argument. Note that some gcc 2.x versions don't handle this
428 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
430 #define PRINTF_ATTRIBUTE(a1, a2)
435 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
436 #define _DEPRECATED_ __attribute__ ((deprecated))
442 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
443 #define vdprintf rep_vdprintf
444 int rep_vdprintf(int fd
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
447 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
448 #define dprintf rep_dprintf
449 int rep_dprintf(int fd
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
452 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
453 #define vasprintf rep_vasprintf
454 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
457 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
458 #define snprintf rep_snprintf
459 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
462 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
463 #define vsnprintf rep_vsnprintf
464 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
467 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
468 #define asprintf rep_asprintf
469 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
472 #if !defined(HAVE_C99_VSNPRINTF)
473 #ifdef REPLACE_BROKEN_PRINTF
475 * We do not redefine printf by default
476 * as it breaks the build if system headers
477 * use __attribute__((format(printf, 3, 0)))
478 * instead of __attribute__((format(__printf__, 3, 0)))
480 #define printf rep_printf
482 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
485 #if !defined(HAVE_C99_VSNPRINTF)
486 #define fprintf rep_fprintf
487 int rep_fprintf(FILE *stream
, const char *, ...) PRINTF_ATTRIBUTE(2,3);
492 #define vsyslog rep_vsyslog
493 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
497 /* we used to use these fns, but now we have good replacements
498 for snprintf and vsnprintf */
499 #define slprintf snprintf
504 #ifdef HAVE___VA_COPY
505 #define va_copy(dest, src) __va_copy(dest, src)
507 #define va_copy(dest, src) (dest) = (src)
511 #ifndef HAVE_VOLATILE
515 #ifndef HAVE_COMPARISON_FN_T
516 typedef int (*comparison_fn_t
)(const void *, const void *);
519 #ifndef HAVE_WORKING_STRPTIME
520 #define strptime rep_strptime
522 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
526 #define dup2 rep_dup2
527 int rep_dup2(int oldfd
, int newfd
);
530 /* Load header file for dynamic linking stuff */
542 #define RTLD_GLOBAL 0
545 #ifndef HAVE_SECURE_MKSTEMP
546 #define mkstemp(path) rep_mkstemp(path)
547 int rep_mkstemp(char *temp
);
551 #define mkdtemp rep_mkdtemp
552 char *rep_mkdtemp(char *template);
556 #define pread rep_pread
557 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
558 #define LIBREPLACE_PREAD_REPLACED 1
560 #define LIBREPLACE_PREAD_NOT_REPLACED 1
564 #define pwrite rep_pwrite
565 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
566 #define LIBREPLACE_PWRITE_REPLACED 1
568 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
571 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
572 #define inet_ntoa rep_inet_ntoa
573 /* prototype is in "system/network.h" */
576 #ifndef HAVE_INET_PTON
577 #define inet_pton rep_inet_pton
578 /* prototype is in "system/network.h" */
581 #ifndef HAVE_INET_NTOP
582 #define inet_ntop rep_inet_ntop
583 /* prototype is in "system/network.h" */
586 #ifndef HAVE_INET_ATON
587 #define inet_aton rep_inet_aton
588 /* prototype is in "system/network.h" */
592 #define connect rep_connect
593 /* prototype is in "system/network.h" */
596 #ifndef HAVE_GETHOSTBYNAME
597 #define gethostbyname rep_gethostbyname
598 /* prototype is in "system/network.h" */
601 #ifndef HAVE_GETIFADDRS
602 #define getifaddrs rep_getifaddrs
603 /* prototype is in "system/network.h" */
606 #ifndef HAVE_FREEIFADDRS
607 #define freeifaddrs rep_freeifaddrs
608 /* prototype is in "system/network.h" */
611 #ifndef HAVE_GET_CURRENT_DIR_NAME
612 #define get_current_dir_name rep_get_current_dir_name
613 char *rep_get_current_dir_name(void);
616 #ifndef HAVE_STRERROR_R
617 #define strerror_r rep_strerror_r
618 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
621 #if !defined(HAVE_CLOCK_GETTIME)
622 #define clock_gettime rep_clock_gettime
629 #ifdef HAVE_SYS_PARAM_H
630 #include <sys/param.h>
633 /* The extra casts work around common compiler bugs. */
634 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
635 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
636 It is necessary at least when t == time_t. */
637 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
638 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
639 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
642 #define UINT16_MAX 65535
646 #define UINT32_MAX (4294967295U)
650 #define UINT64_MAX ((uint64_t)-1)
654 #define INT64_MAX 9223372036854775807LL
662 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
665 #ifdef HAVE_STDBOOL_H
669 #if !defined(HAVE_BOOL)
677 #if !defined(HAVE_INTPTR_T)
678 typedef long long intptr_t ;
681 #if !defined(HAVE_UINTPTR_T)
682 typedef unsigned long long uintptr_t ;
685 #if !defined(HAVE_PTRDIFF_T)
686 typedef unsigned long long ptrdiff_t ;
690 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
692 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
693 * Tru64 needs _BOOL_EXISTS
694 * AIX needs _BOOL,_TRUE,_FALSE
706 #ifndef __bool_true_false_are_defined
707 #define __bool_true_false_are_defined
724 #ifndef HAVE_FUNCTION_MACRO
725 #ifdef HAVE_func_MACRO
726 #define __FUNCTION__ __func__
728 #define __FUNCTION__ ("")
734 #define MIN(a,b) ((a)<(b)?(a):(b))
738 #define MAX(a,b) ((a)>(b)?(a):(b))
741 #if !defined(HAVE_VOLATILE)
746 this is a warning hack. The idea is to use this everywhere that we
747 get the "discarding const" warning from gcc. That doesn't actually
748 fix the problem of course, but it means that when we do get to
749 cleaning them up we can do it by searching the code for
752 It also means that other error types aren't as swamped by the noise
753 of hundreds of const warnings, so we are more likely to notice when
756 Please only add more uses of this macro when you find it
757 _really_ hard to fix const warnings. Our aim is to eventually use
758 this function in only a very few places.
760 Also, please call this via the discard_const_p() macro interface, as that
761 makes the return type safe.
763 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
765 /** Type-safe version of discard_const */
766 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
769 #define __STRING(x) #x
772 #ifndef __STRINGSTRING
773 #define __STRINGSTRING(x) __STRING(x)
777 #define __LINESTR__ __STRINGSTRING(__LINE__)
781 #define __location__ __FILE__ ":" __LINESTR__
787 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
790 * zero a structure given a pointer to the structure
792 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
795 * zero a structure given a pointer to the structure - no zero check
797 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
799 /* zero an array - note that sizeof(array) must work - ie. it must not be a
801 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
804 * work out how many elements there are in a static array
806 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
809 * pointer difference macro
811 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
818 #define QSORT_CAST (__compar_fn_t)
822 #define QSORT_CAST (int (*)(const void *, const void *))
826 #define PATH_MAX 1024
829 #ifndef MAX_DNS_NAME_LENGTH
830 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
834 char *ufc_crypt(const char *key
, const char *salt
);
835 #define crypt ufc_crypt
842 /* these macros gain us a few percent of speed on gcc */
844 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
845 as its first argument */
847 #define likely(x) __builtin_expect(!!(x), 1)
850 #define unlikely(x) __builtin_expect(!!(x), 0)
854 #define likely(x) (x)
857 #define unlikely(x) (x)
861 #ifndef HAVE_FDATASYNC
862 #define fdatasync(fd) fsync(fd)
863 #elif !defined(HAVE_DECL_FDATASYNC)
867 /* these are used to mark symbols as local to a shared lib, or
868 * publicly available via the shared lib API */
870 #ifdef HAVE_VISIBILITY_ATTR
871 #define _PUBLIC_ __attribute__((visibility("default")))
878 #ifdef HAVE_VISIBILITY_ATTR
879 # define _PRIVATE_ __attribute__((visibility("hidden")))
886 #define poll rep_poll
887 /* prototype is in "system/network.h" */
890 #ifndef HAVE_GETPEEREID
891 #define getpeereid rep_getpeereid
892 int rep_getpeereid(int s
, uid_t
*uid
, gid_t
*gid
);
896 #define usleep rep_usleep
897 typedef long useconds_t
;
898 int usleep(useconds_t
);
901 #ifndef HAVE_SETPROCTITLE
902 #define setproctitle rep_setproctitle
903 void rep_setproctitle(const char *fmt
, ...) PRINTF_ATTRIBUTE(1, 2);
906 bool nss_wrapper_enabled(void);
907 bool nss_wrapper_hosts_enabled(void);
908 bool socket_wrapper_enabled(void);
909 bool uid_wrapper_enabled(void);
911 /* Needed for Solaris atomic_add_XX functions. */
912 #if defined(HAVE_SYS_ATOMIC_H)
913 #include <sys/atomic.h>
916 #endif /* _LIBREPLACE_REPLACE_H */