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"
49 #ifdef HAVE_INTTYPES_H
50 #define __STDC_FORMAT_MACROS
54 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
55 which causes a warning storm on irix */
56 #undef HAVE_INTTYPES_H
63 #ifndef __PRI64_PREFIX
64 # if __WORDSIZE == 64 && ! defined __APPLE__
65 # define __PRI64_PREFIX "l"
67 # define __PRI64_PREFIX "ll"
71 /* Decimal notation. */
82 # define PRId64 __PRI64_PREFIX "d"
95 # define PRIi64 __PRI64_PREFIX "i"
108 # define PRIu64 __PRI64_PREFIX "u"
121 # define SCNd64 __PRI64_PREFIX "d"
134 # define SCNi64 __PRI64_PREFIX "i"
147 # define SCNu64 __PRI64_PREFIX "u"
150 #ifdef HAVE_BSD_STRING_H
151 #include <bsd/string.h>
154 #ifdef HAVE_BSD_UNISTD_H
155 #include <bsd/unistd.h>
162 #ifdef HAVE_STRINGS_H
166 #ifdef HAVE_SYS_TYPES_H
167 #include <sys/types.h>
170 #ifdef HAVE_SETPROCTITLE_H
171 #include <setproctitle.h>
179 #ifdef HAVE_LINUX_TYPES_H
181 * This is needed as some broken header files require this to be included early
183 #include <linux/types.h>
186 #ifndef HAVE_STRERROR
187 extern char *sys_errlist
[];
188 #define strerror(i) sys_errlist[i]
191 #ifndef HAVE_ERRNO_DECL
196 #define strdup rep_strdup
197 char *rep_strdup(const char *s
);
201 #define memmove rep_memmove
202 void *rep_memmove(void *dest
,const void *src
,int size
);
206 #define memmem rep_memmem
207 void *rep_memmem(const void *haystack
, size_t haystacklen
,
208 const void *needle
, size_t needlelen
);
211 #ifndef HAVE_MEMALIGN
212 #define memalign rep_memalign
213 void *rep_memalign(size_t boundary
, size_t size
);
217 #define mktime rep_mktime
218 /* prototype is in "system/time.h" */
222 #define timegm rep_timegm
223 /* prototype is in "system/time.h" */
227 #define utime rep_utime
228 /* prototype is in "system/time.h" */
232 #define utimes rep_utimes
233 /* prototype is in "system/time.h" */
237 #define strlcpy rep_strlcpy
238 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
242 #define strlcat rep_strlcat
243 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
246 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
248 #define strndup rep_strndup
249 char *rep_strndup(const char *s
, size_t n
);
252 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
254 #define strnlen rep_strnlen
255 size_t rep_strnlen(const char *s
, size_t n
);
258 #if !HAVE_DECL_ENVIRON
260 #include <crt_externs.h>
261 #define environ (*_NSGetEnviron())
263 extern char **environ
;
268 #define setenv rep_setenv
269 int rep_setenv(const char *name
, const char *value
, int overwrite
);
271 #ifndef HAVE_SETENV_DECL
272 int setenv(const char *name
, const char *value
, int overwrite
);
276 #ifndef HAVE_UNSETENV
277 #define unsetenv rep_unsetenv
278 int rep_unsetenv(const char *name
);
282 #define seteuid rep_seteuid
283 int rep_seteuid(uid_t
);
287 #define setegid rep_setegid
288 int rep_setegid(gid_t
);
291 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
293 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
295 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
296 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
300 #define chown rep_chown
301 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
305 #define chroot rep_chroot
306 int rep_chroot(const char *dirname
);
310 #define link rep_link
311 int rep_link(const char *oldpath
, const char *newpath
);
314 #ifndef HAVE_READLINK
315 #define readlink rep_readlink
316 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
320 #define symlink rep_symlink
321 int rep_symlink(const char *oldpath
, const char *newpath
);
324 #ifndef HAVE_REALPATH
325 #define realpath rep_realpath
326 char *rep_realpath(const char *path
, char *resolved_path
);
330 #define lchown rep_lchown
331 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
338 #ifndef HAVE_SETLINEBUF
339 #define setlinebuf rep_setlinebuf
340 void rep_setlinebuf(FILE *);
343 #ifndef HAVE_STRCASESTR
344 #define strcasestr rep_strcasestr
345 char *rep_strcasestr(const char *haystack
, const char *needle
);
348 #ifndef HAVE_STRTOK_R
349 #define strtok_r rep_strtok_r
350 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
356 #define strtoll rep_strtoll
357 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
359 #ifdef HAVE_BSD_STRTOLL
360 #define strtoll rep_strtoll
361 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
365 #ifndef HAVE_STRTOULL
366 #define strtoull rep_strtoull
367 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
369 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
370 #define strtoull rep_strtoull
371 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
375 #ifndef HAVE_FTRUNCATE
376 #define ftruncate rep_ftruncate
377 int rep_ftruncate(int,off_t
);
380 #ifndef HAVE_INITGROUPS
381 #define initgroups rep_initgroups
382 int rep_initgroups(char *name
, gid_t id
);
385 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
386 #define bzero(a,b) memset((a),'\0',(b))
390 #define dlerror rep_dlerror
391 char *rep_dlerror(void);
395 #define dlopen rep_dlopen
396 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
397 void *rep_dlopen(const char *name
, unsigned int flags
);
399 void *rep_dlopen(const char *name
, int flags
);
404 #define dlsym rep_dlsym
405 void *rep_dlsym(void *handle
, const char *symbol
);
409 #define dlclose rep_dlclose
410 int rep_dlclose(void *handle
);
413 #ifndef HAVE_SOCKETPAIR
414 #define socketpair rep_socketpair
415 /* prototype is in system/network.h */
418 #ifndef PRINTF_ATTRIBUTE
419 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
420 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
421 * the parameter containing the format, and a2 the index of the first
422 * argument. Note that some gcc 2.x versions don't handle this
424 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
426 #define PRINTF_ATTRIBUTE(a1, a2)
431 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
432 #define _DEPRECATED_ __attribute__ ((deprecated))
438 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
439 #define vdprintf rep_vdprintf
440 int rep_vdprintf(int fd
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
443 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
444 #define dprintf rep_dprintf
445 int rep_dprintf(int fd
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
448 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
449 #define vasprintf rep_vasprintf
450 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
453 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
454 #define snprintf rep_snprintf
455 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
458 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
459 #define vsnprintf rep_vsnprintf
460 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
463 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
464 #define asprintf rep_asprintf
465 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
468 #if !defined(HAVE_C99_VSNPRINTF)
469 #ifdef REPLACE_BROKEN_PRINTF
471 * We do not redefine printf by default
472 * as it breaks the build if system headers
473 * use __attribute__((format(printf, 3, 0)))
474 * instead of __attribute__((format(__printf__, 3, 0)))
476 #define printf rep_printf
478 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
481 #if !defined(HAVE_C99_VSNPRINTF)
482 #define fprintf rep_fprintf
483 int rep_fprintf(FILE *stream
, const char *, ...) PRINTF_ATTRIBUTE(2,3);
488 #define vsyslog rep_vsyslog
489 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
493 /* we used to use these fns, but now we have good replacements
494 for snprintf and vsnprintf */
495 #define slprintf snprintf
500 #ifdef HAVE___VA_COPY
501 #define va_copy(dest, src) __va_copy(dest, src)
503 #define va_copy(dest, src) (dest) = (src)
507 #ifndef HAVE_VOLATILE
511 #ifndef HAVE_COMPARISON_FN_T
512 typedef int (*comparison_fn_t
)(const void *, const void *);
515 #ifndef HAVE_WORKING_STRPTIME
516 #define strptime rep_strptime
518 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
522 #define dup2 rep_dup2
523 int rep_dup2(int oldfd
, int newfd
);
526 /* Load header file for dynamic linking stuff */
538 #define RTLD_GLOBAL 0
541 #ifndef HAVE_SECURE_MKSTEMP
542 #define mkstemp(path) rep_mkstemp(path)
543 int rep_mkstemp(char *temp
);
547 #define mkdtemp rep_mkdtemp
548 char *rep_mkdtemp(char *template);
552 #define pread rep_pread
553 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
554 #define LIBREPLACE_PREAD_REPLACED 1
556 #define LIBREPLACE_PREAD_NOT_REPLACED 1
560 #define pwrite rep_pwrite
561 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
562 #define LIBREPLACE_PWRITE_REPLACED 1
564 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
567 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
568 #define inet_ntoa rep_inet_ntoa
569 /* prototype is in "system/network.h" */
572 #ifndef HAVE_INET_PTON
573 #define inet_pton rep_inet_pton
574 /* prototype is in "system/network.h" */
577 #ifndef HAVE_INET_NTOP
578 #define inet_ntop rep_inet_ntop
579 /* prototype is in "system/network.h" */
582 #ifndef HAVE_INET_ATON
583 #define inet_aton rep_inet_aton
584 /* prototype is in "system/network.h" */
588 #define connect rep_connect
589 /* prototype is in "system/network.h" */
592 #ifndef HAVE_GETHOSTBYNAME
593 #define gethostbyname rep_gethostbyname
594 /* prototype is in "system/network.h" */
597 #ifndef HAVE_GETIFADDRS
598 #define getifaddrs rep_getifaddrs
599 /* prototype is in "system/network.h" */
602 #ifndef HAVE_FREEIFADDRS
603 #define freeifaddrs rep_freeifaddrs
604 /* prototype is in "system/network.h" */
607 #ifndef HAVE_GET_CURRENT_DIR_NAME
608 #define get_current_dir_name rep_get_current_dir_name
609 char *rep_get_current_dir_name(void);
612 #ifndef HAVE_STRERROR_R
613 #define strerror_r rep_strerror_r
614 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
617 #if !defined(HAVE_CLOCK_GETTIME)
618 #define clock_gettime rep_clock_gettime
625 #ifdef HAVE_SYS_PARAM_H
626 #include <sys/param.h>
629 /* The extra casts work around common compiler bugs. */
630 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
631 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
632 It is necessary at least when t == time_t. */
633 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
634 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
635 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
638 #define UINT16_MAX 65535
642 #define UINT32_MAX (4294967295U)
646 #define UINT64_MAX ((uint64_t)-1)
650 #define INT64_MAX 9223372036854775807LL
658 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
661 #ifdef HAVE_STDBOOL_H
665 #if !defined(HAVE_BOOL)
673 #if !defined(HAVE_INTPTR_T)
674 typedef long long intptr_t ;
677 #if !defined(HAVE_UINTPTR_T)
678 typedef unsigned long long uintptr_t ;
681 #if !defined(HAVE_PTRDIFF_T)
682 typedef unsigned long long ptrdiff_t ;
686 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
688 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
689 * Tru64 needs _BOOL_EXISTS
690 * AIX needs _BOOL,_TRUE,_FALSE
702 #ifndef __bool_true_false_are_defined
703 #define __bool_true_false_are_defined
720 #ifndef HAVE_FUNCTION_MACRO
721 #ifdef HAVE_func_MACRO
722 #define __FUNCTION__ __func__
724 #define __FUNCTION__ ("")
730 #define MIN(a,b) ((a)<(b)?(a):(b))
734 #define MAX(a,b) ((a)>(b)?(a):(b))
737 #if !defined(HAVE_VOLATILE)
742 this is a warning hack. The idea is to use this everywhere that we
743 get the "discarding const" warning from gcc. That doesn't actually
744 fix the problem of course, but it means that when we do get to
745 cleaning them up we can do it by searching the code for
748 It also means that other error types aren't as swamped by the noise
749 of hundreds of const warnings, so we are more likely to notice when
752 Please only add more uses of this macro when you find it
753 _really_ hard to fix const warnings. Our aim is to eventually use
754 this function in only a very few places.
756 Also, please call this via the discard_const_p() macro interface, as that
757 makes the return type safe.
759 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
761 /** Type-safe version of discard_const */
762 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
765 #define __STRING(x) #x
768 #ifndef __STRINGSTRING
769 #define __STRINGSTRING(x) __STRING(x)
773 #define __LINESTR__ __STRINGSTRING(__LINE__)
777 #define __location__ __FILE__ ":" __LINESTR__
783 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
786 * zero a structure given a pointer to the structure
788 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
791 * zero a structure given a pointer to the structure - no zero check
793 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
795 /* zero an array - note that sizeof(array) must work - ie. it must not be a
797 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
800 * work out how many elements there are in a static array
802 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
805 * pointer difference macro
807 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
814 #define QSORT_CAST (__compar_fn_t)
818 #define QSORT_CAST (int (*)(const void *, const void *))
822 #define PATH_MAX 1024
825 #ifndef MAX_DNS_NAME_LENGTH
826 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
830 char *ufc_crypt(const char *key
, const char *salt
);
831 #define crypt ufc_crypt
838 /* these macros gain us a few percent of speed on gcc */
840 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
841 as its first argument */
843 #define likely(x) __builtin_expect(!!(x), 1)
846 #define unlikely(x) __builtin_expect(!!(x), 0)
850 #define likely(x) (x)
853 #define unlikely(x) (x)
857 #ifndef HAVE_FDATASYNC
858 #define fdatasync(fd) fsync(fd)
859 #elif !defined(HAVE_DECL_FDATASYNC)
863 /* these are used to mark symbols as local to a shared lib, or
864 * publicly available via the shared lib API */
866 #ifdef HAVE_VISIBILITY_ATTR
867 #define _PUBLIC_ __attribute__((visibility("default")))
874 #ifdef HAVE_VISIBILITY_ATTR
875 # define _PRIVATE_ __attribute__((visibility("hidden")))
882 #define poll rep_poll
883 /* prototype is in "system/network.h" */
886 #ifndef HAVE_GETPEEREID
887 #define getpeereid rep_getpeereid
888 int rep_getpeereid(int s
, uid_t
*uid
, gid_t
*gid
);
892 #define usleep rep_usleep
893 typedef long useconds_t
;
894 int usleep(useconds_t
);
897 #ifndef HAVE_SETPROCTITLE
898 #define setproctitle rep_setproctitle
899 void rep_setproctitle(const char *fmt
, ...) PRINTF_ATTRIBUTE(1, 2);
902 #endif /* _LIBREPLACE_REPLACE_H */