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>
39 /* Needs to be defined before std*.h and string*.h are included */
40 #define __STDC_WANT_LIB_EXT1__ 1
47 #ifndef HAVE_DECL_EWOULDBLOCK
48 #define EWOULDBLOCK EAGAIN
51 #if defined(_MSC_VER) || defined(__MINGW32__)
52 #include "win32_replace.h"
56 #ifdef HAVE_INTTYPES_H
57 #define __STDC_FORMAT_MACROS
59 #elif defined(HAVE_STDINT_H)
61 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
62 which causes a warning storm on irix */
63 #undef HAVE_INTTYPES_H
70 #ifndef __PRI64_PREFIX
71 # if __WORDSIZE == 64 && ! defined __APPLE__
72 # define __PRI64_PREFIX "l"
74 # define __PRI64_PREFIX "ll"
78 /* Decimal notation. */
89 # define PRId64 __PRI64_PREFIX "d"
102 # define PRIi64 __PRI64_PREFIX "i"
115 # define PRIu64 __PRI64_PREFIX "u"
128 # define SCNd64 __PRI64_PREFIX "d"
141 # define SCNi64 __PRI64_PREFIX "i"
154 # define SCNu64 __PRI64_PREFIX "u"
157 #ifdef HAVE_BSD_STRING_H
158 #include <bsd/string.h>
161 #ifdef HAVE_BSD_UNISTD_H
162 #include <bsd/unistd.h>
173 #ifdef HAVE_STRINGS_H
177 #ifdef HAVE_SYS_TYPES_H
178 #include <sys/types.h>
181 #ifdef HAVE_SYS_SYSMACROS_H
182 #include <sys/sysmacros.h>
185 #ifdef HAVE_SETPROCTITLE_H
186 #include <setproctitle.h>
194 #ifdef HAVE_LINUX_TYPES_H
196 * This is needed as some broken header files require this to be included early
198 #include <linux/types.h>
201 #ifndef HAVE_STRERROR
202 extern char *sys_errlist[];
203 #define strerror(i) sys_errlist[i]
206 #ifndef HAVE_ERRNO_DECL
211 #define strdup rep_strdup
212 char *rep_strdup(const char *s);
216 #define memmove rep_memmove
217 void *rep_memmove(void *dest,const void *src,int size);
221 #define memmem rep_memmem
222 void *rep_memmem(const void *haystack, size_t haystacklen,
223 const void *needle, size_t needlelen);
226 #ifndef HAVE_MEMALIGN
227 #define memalign rep_memalign
228 void *rep_memalign(size_t boundary, size_t size);
232 #define mktime rep_mktime
233 /* prototype is in "system/time.h" */
237 #define timegm rep_timegm
238 /* prototype is in "system/time.h" */
242 #define utime rep_utime
243 /* prototype is in "system/time.h" */
247 #define utimes rep_utimes
248 /* prototype is in "system/time.h" */
252 #define strlcpy rep_strlcpy
253 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
257 #define strlcat rep_strlcat
258 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
261 #ifndef HAVE_CLOSEFROM
262 #define closefrom rep_closefrom
263 int rep_closefrom(int lower);
267 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
269 #define strndup rep_strndup
270 char *rep_strndup(const char *s, size_t n);
273 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
275 #define strnlen rep_strnlen
276 size_t rep_strnlen(const char *s, size_t n);
279 #if !defined(HAVE_DECL_ENVIRON)
281 # include <crt_externs.h>
282 # define environ (*_NSGetEnviron())
283 # else /* __APPLE__ */
284 extern char **environ;
285 # endif /* __APPLE */
286 #endif /* !defined(HAVE_DECL_ENVIRON) */
289 #define setenv rep_setenv
290 int rep_setenv(const char *name, const char *value, int overwrite);
292 #ifndef HAVE_SETENV_DECL
293 int setenv(const char *name, const char *value, int overwrite);
297 #ifndef HAVE_UNSETENV
298 #define unsetenv rep_unsetenv
299 int rep_unsetenv(const char *name);
303 #define seteuid rep_seteuid
304 int rep_seteuid(uid_t);
308 #define setegid rep_setegid
309 int rep_setegid(gid_t);
312 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
314 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
316 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
317 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
321 #define chown rep_chown
322 int rep_chown(const char *path, uid_t uid, gid_t gid);
326 #define chroot rep_chroot
327 int rep_chroot(const char *dirname);
331 #define link rep_link
332 int rep_link(const char *oldpath, const char *newpath);
335 #ifndef HAVE_READLINK
336 #define readlink rep_readlink
337 ssize_t rep_readlink(const char *path, char *buf, size_t bufsize);
341 #define symlink rep_symlink
342 int rep_symlink(const char *oldpath, const char *newpath);
345 #ifndef HAVE_REALPATH
346 #define realpath rep_realpath
347 char *rep_realpath(const char *path, char *resolved_path);
351 #define lchown rep_lchown
352 int rep_lchown(const char *fname,uid_t uid,gid_t gid);
359 #ifndef HAVE_SETLINEBUF
360 #define setlinebuf rep_setlinebuf
361 void rep_setlinebuf(FILE *);
364 #ifndef HAVE_STRCASESTR
365 #define strcasestr rep_strcasestr
366 char *rep_strcasestr(const char *haystack, const char *needle);
370 #define strsep rep_strsep
371 char *rep_strsep(char **pps, const char *delim);
374 #ifndef HAVE_STRTOK_R
375 #define strtok_r rep_strtok_r
376 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
382 #define strtoll rep_strtoll
383 long long int rep_strtoll(const char *str, char **endptr, int base);
385 #ifdef HAVE_BSD_STRTOLL
386 #define strtoll rep_strtoll
387 long long int rep_strtoll(const char *str, char **endptr, int base);
391 #ifndef HAVE_STRTOULL
392 #define strtoull rep_strtoull
393 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
395 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
396 #define strtoull rep_strtoull
397 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
401 #ifndef HAVE_FTRUNCATE
402 #define ftruncate rep_ftruncate
403 int rep_ftruncate(int,off_t);
406 #ifndef HAVE_INITGROUPS
407 #define initgroups rep_initgroups
408 int rep_initgroups(char *name, gid_t id);
411 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
412 #define bzero(a,b) memset((a),'\0',(b))
416 #define dlerror rep_dlerror
417 char *rep_dlerror(void);
421 #define dlopen rep_dlopen
422 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
423 void *rep_dlopen(const char *name, unsigned int flags);
425 void *rep_dlopen(const char *name, int flags);
430 #define dlsym rep_dlsym
431 void *rep_dlsym(void *handle, const char *symbol);
435 #define dlclose rep_dlclose
436 int rep_dlclose(void *handle);
439 #ifndef HAVE_SOCKETPAIR
440 #define socketpair rep_socketpair
441 /* prototype is in system/network.h */
444 #ifndef PRINTF_ATTRIBUTE
445 #ifdef HAVE___ATTRIBUTE__
446 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
447 * the parameter containing the format, and a2 the index of the first
448 * argument. Note that some gcc 2.x versions don't handle this
450 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
452 #define PRINTF_ATTRIBUTE(a1, a2)
457 #ifdef HAVE___ATTRIBUTE__
458 #define _DEPRECATED_ __attribute__ ((deprecated))
464 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
465 #define vdprintf rep_vdprintf
466 int rep_vdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
469 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
470 #define dprintf rep_dprintf
471 int rep_dprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
474 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
475 #define vasprintf rep_vasprintf
476 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
479 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
480 #define snprintf rep_snprintf
481 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
484 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
485 #define vsnprintf rep_vsnprintf
486 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
489 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
490 #define asprintf rep_asprintf
491 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
494 #if !defined(HAVE_C99_VSNPRINTF)
495 #ifdef REPLACE_BROKEN_PRINTF
497 * We do not redefine printf by default
498 * as it breaks the build if system headers
499 * use __attribute__((format(printf, 3, 0)))
500 * instead of __attribute__((format(__printf__, 3, 0)))
502 #define printf rep_printf
504 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
507 #if !defined(HAVE_C99_VSNPRINTF)
508 #define fprintf rep_fprintf
509 int rep_fprintf(FILE *stream, const char *, ...) PRINTF_ATTRIBUTE(2,3);
514 #define vsyslog rep_vsyslog
515 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
519 /* we used to use these fns, but now we have good replacements
520 for snprintf and vsnprintf */
521 #define slprintf snprintf
526 #ifdef HAVE___VA_COPY
527 #define va_copy(dest, src) __va_copy(dest, src)
529 #define va_copy(dest, src) (dest) = (src)
533 #ifndef HAVE_VOLATILE
537 #ifndef HAVE_COMPARISON_FN_T
538 typedef int (*comparison_fn_t)(const void *, const void *);
541 #ifndef HAVE_WORKING_STRPTIME
542 #define strptime rep_strptime
544 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
548 #define dup2 rep_dup2
549 int rep_dup2(int oldfd, int newfd);
552 /* Load header file for dynamic linking stuff */
564 #define RTLD_GLOBAL 0
567 #ifndef HAVE_SECURE_MKSTEMP
568 #define mkstemp(path) rep_mkstemp(path)
569 int rep_mkstemp(char *temp);
573 #define mkdtemp rep_mkdtemp
574 char *rep_mkdtemp(char *template);
578 #define pread rep_pread
579 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
580 #define LIBREPLACE_PREAD_REPLACED 1
582 #define LIBREPLACE_PREAD_NOT_REPLACED 1
586 #define pwrite rep_pwrite
587 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
588 #define LIBREPLACE_PWRITE_REPLACED 1
590 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
593 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
594 #define inet_ntoa rep_inet_ntoa
595 /* prototype is in "system/network.h" */
598 #ifndef HAVE_INET_PTON
599 #define inet_pton rep_inet_pton
600 /* prototype is in "system/network.h" */
603 #ifndef HAVE_INET_NTOP
604 #define inet_ntop rep_inet_ntop
605 /* prototype is in "system/network.h" */
608 #ifndef HAVE_INET_ATON
609 #define inet_aton rep_inet_aton
610 /* prototype is in "system/network.h" */
614 #define connect rep_connect
615 /* prototype is in "system/network.h" */
618 #ifndef HAVE_GETHOSTBYNAME
619 #define gethostbyname rep_gethostbyname
620 /* prototype is in "system/network.h" */
623 #ifndef HAVE_GETIFADDRS
624 #define getifaddrs rep_getifaddrs
625 /* prototype is in "system/network.h" */
628 #ifndef HAVE_FREEIFADDRS
629 #define freeifaddrs rep_freeifaddrs
630 /* prototype is in "system/network.h" */
633 #ifndef HAVE_GET_CURRENT_DIR_NAME
634 #define get_current_dir_name rep_get_current_dir_name
635 char *rep_get_current_dir_name(void);
638 #if (!defined(HAVE_STRERROR_R) || !defined(STRERROR_R_XSI_NOT_GNU))
639 #define strerror_r rep_strerror_r
640 int rep_strerror_r(int errnum, char *buf, size_t buflen);
643 #if !defined(HAVE_CLOCK_GETTIME)
644 #define clock_gettime rep_clock_gettime
651 #ifdef HAVE_SYS_PARAM_H
652 #include <sys/param.h>
655 /* The extra casts work around common compiler bugs. */
656 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
657 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
658 It is necessary at least when t == time_t. */
659 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
660 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
661 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
664 #define UINT16_MAX 65535
668 #define UINT32_MAX (4294967295U)
672 #define UINT64_MAX ((uint64_t)-1)
676 #define INT64_MAX 9223372036854775807LL
684 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
687 #ifdef HAVE_STDBOOL_H
691 #if !defined(HAVE_BOOL)
699 #if !defined(HAVE_INTPTR_T)
700 typedef long long intptr_t ;
701 #define __intptr_t_defined
704 #if !defined(HAVE_UINTPTR_T)
705 typedef unsigned long long uintptr_t ;
706 #define __uintptr_t_defined
709 #if !defined(HAVE_PTRDIFF_T)
710 typedef unsigned long long ptrdiff_t ;
714 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
716 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
717 * Tru64 needs _BOOL_EXISTS
718 * AIX needs _BOOL,_TRUE,_FALSE
730 #ifndef __bool_true_false_are_defined
731 #define __bool_true_false_are_defined
748 #ifndef HAVE_FUNCTION_MACRO
749 #ifdef HAVE_func_MACRO
750 #define __FUNCTION__ __func__
752 #define __FUNCTION__ ("")
758 #define MIN(a,b) ((a)<(b)?(a):(b))
762 #define MAX(a,b) ((a)>(b)?(a):(b))
765 #if !defined(HAVE_VOLATILE)
770 this is a warning hack. The idea is to use this everywhere that we
771 get the "discarding const" warning from gcc. That doesn't actually
772 fix the problem of course, but it means that when we do get to
773 cleaning them up we can do it by searching the code for
776 It also means that other error types aren't as swamped by the noise
777 of hundreds of const warnings, so we are more likely to notice when
780 Please only add more uses of this macro when you find it
781 _really_ hard to fix const warnings. Our aim is to eventually use
782 this function in only a very few places.
784 Also, please call this via the discard_const_p() macro interface, as that
785 makes the return type safe.
787 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
789 /** Type-safe version of discard_const */
790 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
793 #define __STRING(x) #x
796 #ifndef __STRINGSTRING
797 #define __STRINGSTRING(x) __STRING(x)
801 #define __LINESTR__ __STRINGSTRING(__LINE__)
805 #define __location__ __FILE__ ":" __LINESTR__
811 #define ZERO_STRUCT(x) memset_s((char *)&(x), sizeof(x), 0, sizeof(x))
814 * Zero a structure given a pointer to the structure.
816 #define ZERO_STRUCTP(x) do { \
818 memset_s((char *)(x), sizeof(*(x)), 0, sizeof(*(x))); \
823 * Zero a structure given a pointer to the structure - no zero check
825 #define ZERO_STRUCTPN(x) memset_s((char *)(x), sizeof(*(x)), 0, sizeof(*(x)))
828 * Zero an array - note that sizeof(array) must work - ie. it must not be a
831 #define ZERO_ARRAY(x) memset_s((char *)(x), sizeof(x), 0, sizeof(x))
834 * Work out how many elements there are in a static array.
836 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
839 * Pointer difference macro
841 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
844 #define QSORT_CAST (__compar_fn_t)
848 #define QSORT_CAST (int (*)(const void *, const void *))
852 #define PATH_MAX 1024
855 #ifndef MAX_DNS_NAME_LENGTH
856 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
860 char *ufc_crypt(const char *key, const char *salt);
861 #define crypt ufc_crypt
868 /* these macros gain us a few percent of speed on gcc */
870 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
871 as its first argument */
873 #define likely(x) __builtin_expect(!!(x), 1)
876 #define unlikely(x) __builtin_expect(!!(x), 0)
880 #define likely(x) (x)
883 #define unlikely(x) (x)
887 #ifndef HAVE_FDATASYNC
888 #define fdatasync(fd) fsync(fd)
889 #elif !defined(HAVE_DECL_FDATASYNC)
893 /* these are used to mark symbols as local to a shared lib, or
894 * publicly available via the shared lib API */
896 #ifdef HAVE_VISIBILITY_ATTR
897 #define _PUBLIC_ __attribute__((visibility("default")))
904 #ifdef HAVE_VISIBILITY_ATTR
905 # define _PRIVATE_ __attribute__((visibility("hidden")))
912 #define poll rep_poll
913 /* prototype is in "system/network.h" */
916 #ifndef HAVE_GETPEEREID
917 #define getpeereid rep_getpeereid
918 int rep_getpeereid(int s, uid_t *uid, gid_t *gid);
922 #define usleep rep_usleep
923 typedef long useconds_t;
924 int usleep(useconds_t);
927 #ifndef HAVE_SETPROCTITLE
928 #define setproctitle rep_setproctitle
929 void rep_setproctitle(const char *fmt, ...) PRINTF_ATTRIBUTE(1, 2);
932 #ifndef HAVE_SETPROCTITLE_INIT
933 #define setproctitle_init rep_setproctitle_init
934 void rep_setproctitle_init(int argc, char *argv[], char *envp[]);
937 #ifndef HAVE_MEMSET_S
938 #define memset_s rep_memset_s
939 int rep_memset_s(void *dest, size_t destsz, int ch, size_t count);
942 #ifndef HAVE_GETPROGNAME
943 #define getprogname rep_getprogname
944 const char *rep_getprogname(void);
948 # ifdef HAVE_FALLTHROUGH_ATTRIBUTE
949 # define FALL_THROUGH __attribute__ ((fallthrough))
950 # else /* HAVE_FALLTHROUGH_ATTRIBUTE */
951 # define FALL_THROUGH ((void)0)
952 # endif /* HAVE_FALLTHROUGH_ATTRIBUTE */
953 #endif /* FALL_THROUGH */
955 bool nss_wrapper_enabled(void);
956 bool nss_wrapper_hosts_enabled(void);
957 bool socket_wrapper_enabled(void);
958 bool uid_wrapper_enabled(void);
960 /* Needed for Solaris atomic_add_XX functions. */
961 #if defined(HAVE_SYS_ATOMIC_H)
962 #include <sys/atomic.h>
965 #endif /* _LIBREPLACE_REPLACE_H */