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>
40 * Needs to be defined before std*.h and string*.h are included
41 * As it's also needed when Python.h is the first header we
42 * require a global -D__STDC_WANT_LIB_EXT1__=1
44 #ifndef __STDC_WANT_LIB_EXT1__
45 #error -D__STDC_WANT_LIB_EXT1__=1 required
53 #ifndef HAVE_DECL_EWOULDBLOCK
54 #define EWOULDBLOCK EAGAIN
57 #if defined(_MSC_VER) || defined(__MINGW32__)
58 #include "win32_replace.h"
62 #ifdef HAVE_INTTYPES_H
63 #define __STDC_FORMAT_MACROS
65 #elif defined(HAVE_STDINT_H)
67 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
68 which causes a warning storm on irix */
69 #undef HAVE_INTTYPES_H
76 #ifndef __PRI64_PREFIX
77 # if __WORDSIZE == 64 && ! defined __APPLE__
78 # define __PRI64_PREFIX "l"
80 # define __PRI64_PREFIX "ll"
84 /* Decimal notation. */
95 # define PRId64 __PRI64_PREFIX "d"
108 # define PRIi64 __PRI64_PREFIX "i"
121 # define PRIu64 __PRI64_PREFIX "u"
134 # define SCNd64 __PRI64_PREFIX "d"
147 # define SCNi64 __PRI64_PREFIX "i"
160 # define SCNu64 __PRI64_PREFIX "u"
163 #ifdef HAVE_BSD_STRING_H
164 #include <bsd/string.h>
167 #ifdef HAVE_BSD_UNISTD_H
168 #include <bsd/unistd.h>
179 #ifdef HAVE_STRINGS_H
183 #ifdef HAVE_SYS_TYPES_H
184 #include <sys/types.h>
187 #ifdef HAVE_SYS_SYSMACROS_H
188 #include <sys/sysmacros.h>
191 #ifdef HAVE_SETPROCTITLE_H
192 #include <setproctitle.h>
200 #ifdef HAVE_LINUX_TYPES_H
202 * This is needed as some broken header files require this to be included early
204 #include <linux/types.h>
207 #ifndef HAVE_STRERROR
208 extern char *sys_errlist
[];
209 #define strerror(i) sys_errlist[i]
212 #ifndef HAVE_ERRNO_DECL
217 #define strdup rep_strdup
218 char *rep_strdup(const char *s
);
222 #define memmove rep_memmove
223 void *rep_memmove(void *dest
,const void *src
,int size
);
227 #define memmem rep_memmem
228 void *rep_memmem(const void *haystack
, size_t haystacklen
,
229 const void *needle
, size_t needlelen
);
232 #ifndef HAVE_MEMALIGN
233 #define memalign rep_memalign
234 void *rep_memalign(size_t boundary
, size_t size
);
238 #define mktime rep_mktime
239 /* prototype is in "system/time.h" */
243 #define timegm rep_timegm
244 /* prototype is in "system/time.h" */
248 #define utime rep_utime
249 /* prototype is in "system/time.h" */
253 #define utimes rep_utimes
254 /* prototype is in "system/time.h" */
258 #define strlcpy rep_strlcpy
259 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
263 #define strlcat rep_strlcat
264 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
267 #ifndef HAVE_CLOSEFROM
268 #define closefrom rep_closefrom
269 int rep_closefrom(int lower
);
273 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
275 #define strndup rep_strndup
276 char *rep_strndup(const char *s
, size_t n
);
279 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
281 #define strnlen rep_strnlen
282 size_t rep_strnlen(const char *s
, size_t n
);
285 #if !defined(HAVE_DECL_ENVIRON)
287 # include <crt_externs.h>
288 # define environ (*_NSGetEnviron())
289 # else /* __APPLE__ */
290 extern char **environ
;
291 # endif /* __APPLE */
292 #endif /* !defined(HAVE_DECL_ENVIRON) */
295 #define setenv rep_setenv
296 int rep_setenv(const char *name
, const char *value
, int overwrite
);
298 #ifndef HAVE_SETENV_DECL
299 int setenv(const char *name
, const char *value
, int overwrite
);
303 #ifndef HAVE_UNSETENV
304 #define unsetenv rep_unsetenv
305 int rep_unsetenv(const char *name
);
309 #define seteuid rep_seteuid
310 int rep_seteuid(uid_t
);
314 #define setegid rep_setegid
315 int rep_setegid(gid_t
);
318 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
320 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
322 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
323 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
327 #define chown rep_chown
328 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
332 #define chroot rep_chroot
333 int rep_chroot(const char *dirname
);
337 #define link rep_link
338 int rep_link(const char *oldpath
, const char *newpath
);
341 #ifndef HAVE_READLINK
342 #define readlink rep_readlink
343 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
347 #define symlink rep_symlink
348 int rep_symlink(const char *oldpath
, const char *newpath
);
351 #ifndef HAVE_REALPATH
352 #define realpath rep_realpath
353 char *rep_realpath(const char *path
, char *resolved_path
);
357 #define lchown rep_lchown
358 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
365 #ifndef HAVE_SETLINEBUF
366 #define setlinebuf rep_setlinebuf
367 void rep_setlinebuf(FILE *);
370 #ifndef HAVE_STRCASESTR
371 #define strcasestr rep_strcasestr
372 char *rep_strcasestr(const char *haystack
, const char *needle
);
376 #define strsep rep_strsep
377 char *rep_strsep(char **pps
, const char *delim
);
380 #ifndef HAVE_STRTOK_R
381 #define strtok_r rep_strtok_r
382 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
388 #define strtoll rep_strtoll
389 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
391 #ifdef HAVE_BSD_STRTOLL
392 #define strtoll rep_strtoll
393 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
397 #ifndef HAVE_STRTOULL
398 #define strtoull rep_strtoull
399 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
401 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
402 #define strtoull rep_strtoull
403 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
407 #ifndef HAVE_FTRUNCATE
408 #define ftruncate rep_ftruncate
409 int rep_ftruncate(int,off_t
);
412 #ifndef HAVE_INITGROUPS
413 #define initgroups rep_initgroups
414 int rep_initgroups(char *name
, gid_t id
);
417 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
418 #define bzero(a,b) memset((a),'\0',(b))
422 #define dlerror rep_dlerror
423 char *rep_dlerror(void);
427 #define dlopen rep_dlopen
428 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
429 void *rep_dlopen(const char *name
, unsigned int flags
);
431 void *rep_dlopen(const char *name
, int flags
);
436 #define dlsym rep_dlsym
437 void *rep_dlsym(void *handle
, const char *symbol
);
441 #define dlclose rep_dlclose
442 int rep_dlclose(void *handle
);
445 #ifndef HAVE_SOCKETPAIR
446 #define socketpair rep_socketpair
447 /* prototype is in system/network.h */
450 /* for old gcc releases that don't have the feature test macro __has_attribute */
451 #ifndef __has_attribute
452 #define __has_attribute(x) 0
455 #ifndef PRINTF_ATTRIBUTE
456 #if __has_attribute(format) || (__GNUC__ >= 3)
457 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
458 * the parameter containing the format, and a2 the index of the first
459 * argument. Note that some gcc 2.x versions don't handle this
461 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
463 #define PRINTF_ATTRIBUTE(a1, a2)
468 #if __has_attribute(deprecated) || (__GNUC__ >= 3)
469 #define _DEPRECATED_ __attribute__ ((deprecated))
475 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
476 #define vdprintf rep_vdprintf
477 int rep_vdprintf(int fd
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
480 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
481 #define dprintf rep_dprintf
482 int rep_dprintf(int fd
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
485 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
486 #define vasprintf rep_vasprintf
487 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
490 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
491 #define snprintf rep_snprintf
492 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
495 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
496 #define vsnprintf rep_vsnprintf
497 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
500 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
501 #define asprintf rep_asprintf
502 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
505 #if !defined(HAVE_C99_VSNPRINTF)
506 #ifdef REPLACE_BROKEN_PRINTF
508 * We do not redefine printf by default
509 * as it breaks the build if system headers
510 * use __attribute__((format(printf, 3, 0)))
511 * instead of __attribute__((format(__printf__, 3, 0)))
513 #define printf rep_printf
515 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
518 #if !defined(HAVE_C99_VSNPRINTF)
519 #define fprintf rep_fprintf
520 int rep_fprintf(FILE *stream
, const char *, ...) PRINTF_ATTRIBUTE(2,3);
525 #define vsyslog rep_vsyslog
526 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
530 /* we used to use these fns, but now we have good replacements
531 for snprintf and vsnprintf */
532 #define slprintf snprintf
537 #ifdef HAVE___VA_COPY
538 #define va_copy(dest, src) __va_copy(dest, src)
540 #define va_copy(dest, src) (dest) = (src)
544 #ifndef HAVE_VOLATILE
548 #ifndef HAVE_COMPARISON_FN_T
549 typedef int (*comparison_fn_t
)(const void *, const void *);
552 #ifndef HAVE_WORKING_STRPTIME
553 #define strptime rep_strptime
555 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
559 #define dup2 rep_dup2
560 int rep_dup2(int oldfd
, int newfd
);
563 /* Load header file for dynamic linking stuff */
575 #define RTLD_GLOBAL 0
578 #ifndef HAVE_SECURE_MKSTEMP
579 #define mkstemp(path) rep_mkstemp(path)
580 int rep_mkstemp(char *temp
);
584 #define mkdtemp rep_mkdtemp
585 char *rep_mkdtemp(char *template);
589 #define pread rep_pread
590 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
591 #define LIBREPLACE_PREAD_REPLACED 1
593 #define LIBREPLACE_PREAD_NOT_REPLACED 1
597 #define pwrite rep_pwrite
598 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
599 #define LIBREPLACE_PWRITE_REPLACED 1
601 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
604 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
605 #define inet_ntoa rep_inet_ntoa
606 /* prototype is in "system/network.h" */
609 #ifndef HAVE_INET_PTON
610 #define inet_pton rep_inet_pton
611 /* prototype is in "system/network.h" */
614 #ifndef HAVE_INET_NTOP
615 #define inet_ntop rep_inet_ntop
616 /* prototype is in "system/network.h" */
619 #ifndef HAVE_INET_ATON
620 #define inet_aton rep_inet_aton
621 /* prototype is in "system/network.h" */
625 #define connect rep_connect
626 /* prototype is in "system/network.h" */
629 #ifndef HAVE_GETHOSTBYNAME
630 #define gethostbyname rep_gethostbyname
631 /* prototype is in "system/network.h" */
634 #ifndef HAVE_GETIFADDRS
635 #define getifaddrs rep_getifaddrs
636 /* prototype is in "system/network.h" */
639 #ifndef HAVE_FREEIFADDRS
640 #define freeifaddrs rep_freeifaddrs
641 /* prototype is in "system/network.h" */
644 #ifndef HAVE_GET_CURRENT_DIR_NAME
645 #define get_current_dir_name rep_get_current_dir_name
646 char *rep_get_current_dir_name(void);
649 #if (!defined(HAVE_STRERROR_R) || !defined(STRERROR_R_XSI_NOT_GNU))
650 #define strerror_r rep_strerror_r
651 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
654 #if !defined(HAVE_CLOCK_GETTIME)
655 #define clock_gettime rep_clock_gettime
662 #ifdef HAVE_SYS_PARAM_H
663 #include <sys/param.h>
666 /* The extra casts work around common compiler bugs. */
667 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
668 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
669 It is necessary at least when t == time_t. */
670 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
671 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
672 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
675 #define UINT16_MAX 65535
679 #define UINT32_MAX (4294967295U)
683 #define UINT64_MAX ((uint64_t)-1)
687 #define INT64_MAX 9223372036854775807LL
695 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
698 #ifdef HAVE_STDBOOL_H
702 #if !defined(HAVE_BOOL)
710 #if !defined(HAVE_INTPTR_T)
711 typedef long long intptr_t ;
712 #define __intptr_t_defined
715 #if !defined(HAVE_UINTPTR_T)
716 typedef unsigned long long uintptr_t ;
717 #define __uintptr_t_defined
720 #if !defined(HAVE_PTRDIFF_T)
721 typedef unsigned long long ptrdiff_t ;
725 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
727 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
728 * Tru64 needs _BOOL_EXISTS
729 * AIX needs _BOOL,_TRUE,_FALSE
741 #ifndef __bool_true_false_are_defined
742 #define __bool_true_false_are_defined
759 #ifndef HAVE_FUNCTION_MACRO
760 #ifdef HAVE_func_MACRO
761 #define __FUNCTION__ __func__
763 #define __FUNCTION__ ("")
769 #define MIN(a,b) ((a)<(b)?(a):(b))
773 #define MAX(a,b) ((a)>(b)?(a):(b))
776 #if !defined(HAVE_VOLATILE)
781 this is a warning hack. The idea is to use this everywhere that we
782 get the "discarding const" warning from gcc. That doesn't actually
783 fix the problem of course, but it means that when we do get to
784 cleaning them up we can do it by searching the code for
787 It also means that other error types aren't as swamped by the noise
788 of hundreds of const warnings, so we are more likely to notice when
791 Please only add more uses of this macro when you find it
792 _really_ hard to fix const warnings. Our aim is to eventually use
793 this function in only a very few places.
795 Also, please call this via the discard_const_p() macro interface, as that
796 makes the return type safe.
798 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
800 /** Type-safe version of discard_const */
801 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
804 #define __STRING(x) #x
807 #ifndef __STRINGSTRING
808 #define __STRINGSTRING(x) __STRING(x)
812 #define __LINESTR__ __STRINGSTRING(__LINE__)
816 #define __location__ __FILE__ ":" __LINESTR__
822 #define ZERO_STRUCT(x) memset_s((char *)&(x), sizeof(x), 0, sizeof(x))
825 * Zero a structure given a pointer to the structure.
827 #define ZERO_STRUCTP(x) do { \
829 memset_s((char *)(x), sizeof(*(x)), 0, sizeof(*(x))); \
834 * Zero a structure given a pointer to the structure - no zero check
836 #define ZERO_STRUCTPN(x) memset_s((char *)(x), sizeof(*(x)), 0, sizeof(*(x)))
839 * Zero an array - note that sizeof(array) must work - ie. it must not be a
842 #define ZERO_ARRAY(x) memset_s((char *)(x), sizeof(x), 0, sizeof(x))
845 * Zero a given len of an array
847 #define ZERO_ARRAY_LEN(x, l) memset_s((char *)(x), (l), 0, (l))
850 * Work out how many elements there are in a static array.
855 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
858 * Remove an array element by moving the rest one down
860 #define ARRAY_DEL_ELEMENT(a,i,n) \
861 if((i)<((n)-1)){memmove(&((a)[(i)]),&((a)[(i)+1]),(sizeof(*(a))*((n)-(i)-1)));}
864 * Pointer difference macro
866 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
869 #define QSORT_CAST (__compar_fn_t)
873 #define QSORT_CAST (int (*)(const void *, const void *))
877 #define PATH_MAX 1024
880 #ifndef MAX_DNS_NAME_LENGTH
881 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
888 /* these macros gain us a few percent of speed on gcc */
890 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
891 as its first argument */
893 #define likely(x) __builtin_expect(!!(x), 1)
896 #define unlikely(x) __builtin_expect(!!(x), 0)
900 #define likely(x) (x)
903 #define unlikely(x) (x)
907 #ifndef HAVE_FDATASYNC
908 #define fdatasync(fd) fsync(fd)
909 #elif !defined(HAVE_DECL_FDATASYNC)
913 /* these are used to mark symbols as local to a shared lib, or
914 * publicly available via the shared lib API */
916 #ifdef HAVE_VISIBILITY_ATTR
917 #define _PUBLIC_ __attribute__((visibility("default")))
924 #ifdef HAVE_VISIBILITY_ATTR
925 # define _PRIVATE_ __attribute__((visibility("hidden")))
932 #define poll rep_poll
933 /* prototype is in "system/network.h" */
936 #ifndef HAVE_GETPEEREID
937 #define getpeereid rep_getpeereid
938 int rep_getpeereid(int s
, uid_t
*uid
, gid_t
*gid
);
942 #define usleep rep_usleep
943 typedef long useconds_t
;
944 int usleep(useconds_t
);
947 #ifndef HAVE_SETPROCTITLE
948 #define setproctitle rep_setproctitle
949 void rep_setproctitle(const char *fmt
, ...) PRINTF_ATTRIBUTE(1, 2);
952 #ifndef HAVE_SETPROCTITLE_INIT
953 #define setproctitle_init rep_setproctitle_init
954 void rep_setproctitle_init(int argc
, char *argv
[], char *envp
[]);
957 #ifndef HAVE_MEMSET_S
958 #define memset_s rep_memset_s
959 int rep_memset_s(void *dest
, size_t destsz
, int ch
, size_t count
);
962 #ifndef HAVE_GETPROGNAME
963 #define getprogname rep_getprogname
964 const char *rep_getprogname(void);
968 # ifdef HAVE_FALLTHROUGH_ATTRIBUTE
969 # define FALL_THROUGH __attribute__ ((fallthrough))
970 # else /* HAVE_FALLTHROUGH_ATTRIBUTE */
971 # define FALL_THROUGH ((void)0)
972 # endif /* HAVE_FALLTHROUGH_ATTRIBUTE */
973 #endif /* FALL_THROUGH */
975 bool nss_wrapper_enabled(void);
976 bool nss_wrapper_hosts_enabled(void);
977 bool socket_wrapper_enabled(void);
978 bool uid_wrapper_enabled(void);
980 /* Needed for Solaris atomic_add_XX functions. */
981 #if defined(HAVE_SYS_ATOMIC_H)
982 #include <sys/atomic.h>
985 #endif /* _LIBREPLACE_REPLACE_H */