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_SYS_SYSMACROS_H
175 #include <sys/sysmacros.h>
178 #ifdef HAVE_SETPROCTITLE_H
179 #include <setproctitle.h>
187 #ifdef HAVE_LINUX_TYPES_H
189 * This is needed as some broken header files require this to be included early
191 #include <linux/types.h>
194 #ifndef HAVE_STRERROR
195 extern char *sys_errlist
[];
196 #define strerror(i) sys_errlist[i]
199 #ifndef HAVE_ERRNO_DECL
204 #define strdup rep_strdup
205 char *rep_strdup(const char *s
);
209 #define memmove rep_memmove
210 void *rep_memmove(void *dest
,const void *src
,int size
);
214 #define memmem rep_memmem
215 void *rep_memmem(const void *haystack
, size_t haystacklen
,
216 const void *needle
, size_t needlelen
);
219 #ifndef HAVE_MEMALIGN
220 #define memalign rep_memalign
221 void *rep_memalign(size_t boundary
, size_t size
);
225 #define mktime rep_mktime
226 /* prototype is in "system/time.h" */
230 #define timegm rep_timegm
231 /* prototype is in "system/time.h" */
235 #define utime rep_utime
236 /* prototype is in "system/time.h" */
240 #define utimes rep_utimes
241 /* prototype is in "system/time.h" */
245 #define strlcpy rep_strlcpy
246 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
250 #define strlcat rep_strlcat
251 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
254 #ifndef HAVE_CLOSEFROM
255 #define closefrom rep_closefrom
256 int rep_closefrom(int lower
);
260 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
262 #define strndup rep_strndup
263 char *rep_strndup(const char *s
, size_t n
);
266 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
268 #define strnlen rep_strnlen
269 size_t rep_strnlen(const char *s
, size_t n
);
272 #if !HAVE_DECL_ENVIRON
274 #include <crt_externs.h>
275 #define environ (*_NSGetEnviron())
277 extern char **environ
;
282 #define setenv rep_setenv
283 int rep_setenv(const char *name
, const char *value
, int overwrite
);
285 #ifndef HAVE_SETENV_DECL
286 int setenv(const char *name
, const char *value
, int overwrite
);
290 #ifndef HAVE_UNSETENV
291 #define unsetenv rep_unsetenv
292 int rep_unsetenv(const char *name
);
296 #define seteuid rep_seteuid
297 int rep_seteuid(uid_t
);
301 #define setegid rep_setegid
302 int rep_setegid(gid_t
);
305 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
307 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
309 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
310 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
314 #define chown rep_chown
315 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
319 #define chroot rep_chroot
320 int rep_chroot(const char *dirname
);
324 #define link rep_link
325 int rep_link(const char *oldpath
, const char *newpath
);
328 #ifndef HAVE_READLINK
329 #define readlink rep_readlink
330 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
334 #define symlink rep_symlink
335 int rep_symlink(const char *oldpath
, const char *newpath
);
338 #ifndef HAVE_REALPATH
339 #define realpath rep_realpath
340 char *rep_realpath(const char *path
, char *resolved_path
);
344 #define lchown rep_lchown
345 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
352 #ifndef HAVE_SETLINEBUF
353 #define setlinebuf rep_setlinebuf
354 void rep_setlinebuf(FILE *);
357 #ifndef HAVE_STRCASESTR
358 #define strcasestr rep_strcasestr
359 char *rep_strcasestr(const char *haystack
, const char *needle
);
363 #define strsep rep_strsep
364 char *rep_strsep(char **pps
, const char *delim
);
367 #ifndef HAVE_STRTOK_R
368 #define strtok_r rep_strtok_r
369 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
375 #define strtoll rep_strtoll
376 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
378 #ifdef HAVE_BSD_STRTOLL
379 #define strtoll rep_strtoll
380 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
384 #ifndef HAVE_STRTOULL
385 #define strtoull rep_strtoull
386 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
388 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
389 #define strtoull rep_strtoull
390 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
394 #ifndef HAVE_FTRUNCATE
395 #define ftruncate rep_ftruncate
396 int rep_ftruncate(int,off_t
);
399 #ifndef HAVE_INITGROUPS
400 #define initgroups rep_initgroups
401 int rep_initgroups(char *name
, gid_t id
);
404 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
405 #define bzero(a,b) memset((a),'\0',(b))
409 #define dlerror rep_dlerror
410 char *rep_dlerror(void);
414 #define dlopen rep_dlopen
415 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
416 void *rep_dlopen(const char *name
, unsigned int flags
);
418 void *rep_dlopen(const char *name
, int flags
);
423 #define dlsym rep_dlsym
424 void *rep_dlsym(void *handle
, const char *symbol
);
428 #define dlclose rep_dlclose
429 int rep_dlclose(void *handle
);
432 #ifndef HAVE_SOCKETPAIR
433 #define socketpair rep_socketpair
434 /* prototype is in system/network.h */
437 #ifndef PRINTF_ATTRIBUTE
438 #ifdef HAVE___ATTRIBUTE__
439 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
440 * the parameter containing the format, and a2 the index of the first
441 * argument. Note that some gcc 2.x versions don't handle this
443 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
445 #define PRINTF_ATTRIBUTE(a1, a2)
450 #ifdef HAVE___ATTRIBUTE__
451 #define _DEPRECATED_ __attribute__ ((deprecated))
457 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
458 #define vdprintf rep_vdprintf
459 int rep_vdprintf(int fd
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
462 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
463 #define dprintf rep_dprintf
464 int rep_dprintf(int fd
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
467 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
468 #define vasprintf rep_vasprintf
469 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
472 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
473 #define snprintf rep_snprintf
474 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
477 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
478 #define vsnprintf rep_vsnprintf
479 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
482 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
483 #define asprintf rep_asprintf
484 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
487 #if !defined(HAVE_C99_VSNPRINTF)
488 #ifdef REPLACE_BROKEN_PRINTF
490 * We do not redefine printf by default
491 * as it breaks the build if system headers
492 * use __attribute__((format(printf, 3, 0)))
493 * instead of __attribute__((format(__printf__, 3, 0)))
495 #define printf rep_printf
497 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
500 #if !defined(HAVE_C99_VSNPRINTF)
501 #define fprintf rep_fprintf
502 int rep_fprintf(FILE *stream
, const char *, ...) PRINTF_ATTRIBUTE(2,3);
507 #define vsyslog rep_vsyslog
508 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
512 /* we used to use these fns, but now we have good replacements
513 for snprintf and vsnprintf */
514 #define slprintf snprintf
519 #ifdef HAVE___VA_COPY
520 #define va_copy(dest, src) __va_copy(dest, src)
522 #define va_copy(dest, src) (dest) = (src)
526 #ifndef HAVE_VOLATILE
530 #ifndef HAVE_COMPARISON_FN_T
531 typedef int (*comparison_fn_t
)(const void *, const void *);
534 #ifndef HAVE_WORKING_STRPTIME
535 #define strptime rep_strptime
537 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
541 #define dup2 rep_dup2
542 int rep_dup2(int oldfd
, int newfd
);
545 /* Load header file for dynamic linking stuff */
557 #define RTLD_GLOBAL 0
560 #ifndef HAVE_SECURE_MKSTEMP
561 #define mkstemp(path) rep_mkstemp(path)
562 int rep_mkstemp(char *temp
);
566 #define mkdtemp rep_mkdtemp
567 char *rep_mkdtemp(char *template);
571 #define pread rep_pread
572 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
573 #define LIBREPLACE_PREAD_REPLACED 1
575 #define LIBREPLACE_PREAD_NOT_REPLACED 1
579 #define pwrite rep_pwrite
580 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
581 #define LIBREPLACE_PWRITE_REPLACED 1
583 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
586 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
587 #define inet_ntoa rep_inet_ntoa
588 /* prototype is in "system/network.h" */
591 #ifndef HAVE_INET_PTON
592 #define inet_pton rep_inet_pton
593 /* prototype is in "system/network.h" */
596 #ifndef HAVE_INET_NTOP
597 #define inet_ntop rep_inet_ntop
598 /* prototype is in "system/network.h" */
601 #ifndef HAVE_INET_ATON
602 #define inet_aton rep_inet_aton
603 /* prototype is in "system/network.h" */
607 #define connect rep_connect
608 /* prototype is in "system/network.h" */
611 #ifndef HAVE_GETHOSTBYNAME
612 #define gethostbyname rep_gethostbyname
613 /* prototype is in "system/network.h" */
616 #ifndef HAVE_GETIFADDRS
617 #define getifaddrs rep_getifaddrs
618 /* prototype is in "system/network.h" */
621 #ifndef HAVE_FREEIFADDRS
622 #define freeifaddrs rep_freeifaddrs
623 /* prototype is in "system/network.h" */
626 #ifndef HAVE_GET_CURRENT_DIR_NAME
627 #define get_current_dir_name rep_get_current_dir_name
628 char *rep_get_current_dir_name(void);
631 #if (!defined(HAVE_STRERROR_R) || !defined(STRERROR_R_XSI_NOT_GNU))
632 #define strerror_r rep_strerror_r
633 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
636 #if !defined(HAVE_CLOCK_GETTIME)
637 #define clock_gettime rep_clock_gettime
644 #ifdef HAVE_SYS_PARAM_H
645 #include <sys/param.h>
648 /* The extra casts work around common compiler bugs. */
649 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
650 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
651 It is necessary at least when t == time_t. */
652 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
653 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
654 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
657 #define UINT16_MAX 65535
661 #define UINT32_MAX (4294967295U)
665 #define UINT64_MAX ((uint64_t)-1)
669 #define INT64_MAX 9223372036854775807LL
677 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
680 #ifdef HAVE_STDBOOL_H
684 #if !defined(HAVE_BOOL)
692 #if !defined(HAVE_INTPTR_T)
693 typedef long long intptr_t ;
696 #if !defined(HAVE_UINTPTR_T)
697 typedef unsigned long long uintptr_t ;
700 #if !defined(HAVE_PTRDIFF_T)
701 typedef unsigned long long ptrdiff_t ;
705 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
707 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
708 * Tru64 needs _BOOL_EXISTS
709 * AIX needs _BOOL,_TRUE,_FALSE
721 #ifndef __bool_true_false_are_defined
722 #define __bool_true_false_are_defined
739 #ifndef HAVE_FUNCTION_MACRO
740 #ifdef HAVE_func_MACRO
741 #define __FUNCTION__ __func__
743 #define __FUNCTION__ ("")
749 #define MIN(a,b) ((a)<(b)?(a):(b))
753 #define MAX(a,b) ((a)>(b)?(a):(b))
756 #if !defined(HAVE_VOLATILE)
761 this is a warning hack. The idea is to use this everywhere that we
762 get the "discarding const" warning from gcc. That doesn't actually
763 fix the problem of course, but it means that when we do get to
764 cleaning them up we can do it by searching the code for
767 It also means that other error types aren't as swamped by the noise
768 of hundreds of const warnings, so we are more likely to notice when
771 Please only add more uses of this macro when you find it
772 _really_ hard to fix const warnings. Our aim is to eventually use
773 this function in only a very few places.
775 Also, please call this via the discard_const_p() macro interface, as that
776 makes the return type safe.
778 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
780 /** Type-safe version of discard_const */
781 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
784 #define __STRING(x) #x
787 #ifndef __STRINGSTRING
788 #define __STRINGSTRING(x) __STRING(x)
792 #define __LINESTR__ __STRINGSTRING(__LINE__)
796 #define __location__ __FILE__ ":" __LINESTR__
802 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
805 * zero a structure given a pointer to the structure
807 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
810 * zero a structure given a pointer to the structure - no zero check
812 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
814 /* zero an array - note that sizeof(array) must work - ie. it must not be a
816 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
819 * work out how many elements there are in a static array
821 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
824 * pointer difference macro
826 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
833 #define QSORT_CAST (__compar_fn_t)
837 #define QSORT_CAST (int (*)(const void *, const void *))
841 #define PATH_MAX 1024
844 #ifndef MAX_DNS_NAME_LENGTH
845 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
849 char *ufc_crypt(const char *key
, const char *salt
);
850 #define crypt ufc_crypt
857 /* these macros gain us a few percent of speed on gcc */
859 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
860 as its first argument */
862 #define likely(x) __builtin_expect(!!(x), 1)
865 #define unlikely(x) __builtin_expect(!!(x), 0)
869 #define likely(x) (x)
872 #define unlikely(x) (x)
876 #ifndef HAVE_FDATASYNC
877 #define fdatasync(fd) fsync(fd)
878 #elif !defined(HAVE_DECL_FDATASYNC)
882 /* these are used to mark symbols as local to a shared lib, or
883 * publicly available via the shared lib API */
885 #ifdef HAVE_VISIBILITY_ATTR
886 #define _PUBLIC_ __attribute__((visibility("default")))
893 #ifdef HAVE_VISIBILITY_ATTR
894 # define _PRIVATE_ __attribute__((visibility("hidden")))
901 #define poll rep_poll
902 /* prototype is in "system/network.h" */
905 #ifndef HAVE_GETPEEREID
906 #define getpeereid rep_getpeereid
907 int rep_getpeereid(int s
, uid_t
*uid
, gid_t
*gid
);
911 #define usleep rep_usleep
912 typedef long useconds_t
;
913 int usleep(useconds_t
);
916 #ifndef HAVE_SETPROCTITLE
917 #define setproctitle rep_setproctitle
918 void rep_setproctitle(const char *fmt
, ...) PRINTF_ATTRIBUTE(1, 2);
921 #ifndef HAVE_SETPROCTITLE_INIT
922 #define setproctitle_init rep_setproctitle_init
923 void rep_setproctitle_init(int argc
, char *argv
[], char *envp
[]);
925 bool nss_wrapper_enabled(void);
926 bool nss_wrapper_hosts_enabled(void);
927 bool socket_wrapper_enabled(void);
928 bool uid_wrapper_enabled(void);
930 /* Needed for Solaris atomic_add_XX functions. */
931 #if defined(HAVE_SYS_ATOMIC_H)
932 #include <sys/atomic.h>
935 #endif /* _LIBREPLACE_REPLACE_H */