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"
51 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
52 which causes a warning storm on irix */
53 #undef HAVE_INTTYPES_H
55 #define __STDC_FORMAT_MACROS
59 #ifndef __PRI64_PREFIX
61 # define __PRI64_PREFIX "l"
63 # define __PRI64_PREFIX "ll"
67 /* Decimal notation. */
78 # define PRId64 __PRI64_PREFIX "d"
91 # define PRIi64 __PRI64_PREFIX "i"
104 # define PRIu64 __PRI64_PREFIX "u"
111 #ifdef HAVE_STRINGS_H
115 #ifdef HAVE_SYS_TYPES_H
116 #include <sys/types.h>
124 #ifdef HAVE_LINUX_TYPES_H
126 * This is needed as some broken header files require this to be included early
128 #include <linux/types.h>
131 #ifndef HAVE_STRERROR
132 extern char *sys_errlist
[];
133 #define strerror(i) sys_errlist[i]
136 #ifndef HAVE_ERRNO_DECL
141 #define strdup rep_strdup
142 char *rep_strdup(const char *s
);
146 #define memmove rep_memmove
147 void *rep_memmove(void *dest
,const void *src
,int size
);
151 #define memmem rep_memmem
152 void *rep_memmem(const void *haystack
, size_t haystacklen
,
153 const void *needle
, size_t needlelen
);
157 #define mktime rep_mktime
158 /* prototype is in "system/time.h" */
162 #define timegm rep_timegm
163 /* prototype is in "system/time.h" */
167 #define utime rep_utime
168 /* prototype is in "system/time.h" */
172 #define utimes rep_utimes
173 /* prototype is in "system/time.h" */
177 #define strlcpy rep_strlcpy
178 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
182 #define strlcat rep_strlcat
183 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
186 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
188 #define strndup rep_strndup
189 char *rep_strndup(const char *s
, size_t n
);
192 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
194 #define strnlen rep_strnlen
195 size_t rep_strnlen(const char *s
, size_t n
);
198 #if !HAVE_DECL_ENVIRON
200 #include <crt_externs.h>
201 #define environ (*_NSGetEnviron())
203 extern char **environ
;
208 #define setenv rep_setenv
209 int rep_setenv(const char *name
, const char *value
, int overwrite
);
211 #ifndef HAVE_SETENV_DECL
212 int setenv(const char *name
, const char *value
, int overwrite
);
216 #ifndef HAVE_UNSETENV
217 #define unsetenv rep_unsetenv
218 int rep_unsetenv(const char *name
);
222 #define seteuid rep_seteuid
223 int rep_seteuid(uid_t
);
227 #define setegid rep_setegid
228 int rep_setegid(gid_t
);
231 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
233 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
235 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
236 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
240 #define chown rep_chown
241 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
245 #define chroot rep_chroot
246 int rep_chroot(const char *dirname
);
250 #define link rep_link
251 int rep_link(const char *oldpath
, const char *newpath
);
254 #ifndef HAVE_READLINK
255 #define readlink rep_readlink
256 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
260 #define symlink rep_symlink
261 int rep_symlink(const char *oldpath
, const char *newpath
);
264 #ifndef HAVE_REALPATH
265 #define realpath rep_realpath
266 char *rep_realpath(const char *path
, char *resolved_path
);
270 #define lchown rep_lchown
271 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
278 #ifndef HAVE_SETLINEBUF
279 #define setlinebuf rep_setlinebuf
280 void rep_setlinebuf(FILE *);
283 #ifndef HAVE_STRCASESTR
284 #define strcasestr rep_strcasestr
285 char *rep_strcasestr(const char *haystack
, const char *needle
);
288 #ifndef HAVE_STRTOK_R
289 #define strtok_r rep_strtok_r
290 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
296 #define strtoll rep_strtoll
297 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
299 #ifdef HAVE_BSD_STRTOLL
300 #define strtoll rep_strtoll
301 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
305 #ifndef HAVE_STRTOULL
306 #define strtoull rep_strtoull
307 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
309 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
310 #define strtoull rep_strtoull
311 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
315 #ifndef HAVE_FTRUNCATE
316 #define ftruncate rep_ftruncate
317 int rep_ftruncate(int,off_t
);
320 #ifndef HAVE_INITGROUPS
321 #define initgroups rep_initgroups
322 int rep_initgroups(char *name
, gid_t id
);
325 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
326 #define bzero(a,b) memset((a),'\0',(b))
330 #define dlerror rep_dlerror
331 char *rep_dlerror(void);
335 #define dlopen rep_dlopen
336 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
337 void *rep_dlopen(const char *name
, unsigned int flags
);
339 void *rep_dlopen(const char *name
, int flags
);
344 #define dlsym rep_dlsym
345 void *rep_dlsym(void *handle
, const char *symbol
);
349 #define dlclose rep_dlclose
350 int rep_dlclose(void *handle
);
353 #ifndef HAVE_SOCKETPAIR
354 #define socketpair rep_socketpair
355 /* prototype is in system/network.h */
358 #ifndef HAVE_VDPRINTF
359 #define vdprintf rep_vdprintf
360 int rep_vdprintf(int fd
, const char *format
, va_list ap
);
364 #define dprintf rep_dprintf
365 int rep_dprintf(int fd
, const char *format
, ...);
368 #ifndef PRINTF_ATTRIBUTE
369 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
370 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
371 * the parameter containing the format, and a2 the index of the first
372 * argument. Note that some gcc 2.x versions don't handle this
374 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
376 #define PRINTF_ATTRIBUTE(a1, a2)
381 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
382 #define _DEPRECATED_ __attribute__ ((deprecated))
388 #ifndef HAVE_VASPRINTF
389 #define vasprintf rep_vasprintf
390 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
393 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
394 #define snprintf rep_snprintf
395 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
398 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
399 #define vsnprintf rep_vsnprintf
400 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
403 #ifndef HAVE_ASPRINTF
404 #define asprintf rep_asprintf
405 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
410 #define vsyslog rep_vsyslog
411 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
415 /* we used to use these fns, but now we have good replacements
416 for snprintf and vsnprintf */
417 #define slprintf snprintf
422 #ifdef HAVE___VA_COPY
423 #define va_copy(dest, src) __va_copy(dest, src)
425 #define va_copy(dest, src) (dest) = (src)
429 #ifndef HAVE_VOLATILE
433 #ifndef HAVE_COMPARISON_FN_T
434 typedef int (*comparison_fn_t
)(const void *, const void *);
437 #ifdef REPLACE_STRPTIME
438 #define strptime rep_strptime
440 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
444 #define dup2 rep_dup2
445 int rep_dup2(int oldfd
, int newfd
);
448 /* Load header file for dynamic linking stuff */
460 #define RTLD_GLOBAL 0
463 #ifndef HAVE_SECURE_MKSTEMP
464 #define mkstemp(path) rep_mkstemp(path)
465 int rep_mkstemp(char *temp
);
469 #define mkdtemp rep_mkdtemp
470 char *rep_mkdtemp(char *template);
474 #define pread rep_pread
475 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
476 #define LIBREPLACE_PREAD_REPLACED 1
478 #define LIBREPLACE_PREAD_NOT_REPLACED 1
482 #define pwrite rep_pwrite
483 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
484 #define LIBREPLACE_PWRITE_REPLACED 1
486 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
489 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
490 #define inet_ntoa rep_inet_ntoa
491 /* prototype is in "system/network.h" */
494 #ifndef HAVE_INET_PTON
495 #define inet_pton rep_inet_pton
496 /* prototype is in "system/network.h" */
499 #ifndef HAVE_INET_NTOP
500 #define inet_ntop rep_inet_ntop
501 /* prototype is in "system/network.h" */
504 #ifndef HAVE_INET_ATON
505 #define inet_aton rep_inet_aton
506 /* prototype is in "system/network.h" */
510 #define connect rep_connect
511 /* prototype is in "system/network.h" */
514 #ifndef HAVE_GETHOSTBYNAME
515 #define gethostbyname rep_gethostbyname
516 /* prototype is in "system/network.h" */
519 #ifndef HAVE_GETIFADDRS
520 #define getifaddrs rep_getifaddrs
521 /* prototype is in "system/network.h" */
524 #ifndef HAVE_FREEIFADDRS
525 #define freeifaddrs rep_freeifaddrs
526 /* prototype is in "system/network.h" */
529 #ifndef HAVE_GET_CURRENT_DIR_NAME
530 #define get_current_dir_name rep_get_current_dir_name
531 char *rep_get_current_dir_name(void);
534 #if !defined(HAVE_STRERROR_R) || !defined(STRERROR_R_PROTO_COMPATIBLE)
536 #define strerror_r rep_strerror_r
537 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
540 #if !defined(HAVE_CLOCK_GETTIME)
541 #define clock_gettime rep_clock_gettime
548 #ifdef HAVE_SYS_PARAM_H
549 #include <sys/param.h>
552 /* The extra casts work around common compiler bugs. */
553 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
554 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
555 It is necessary at least when t == time_t. */
556 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
557 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
558 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
561 #define UINT16_MAX 65535
565 #define UINT32_MAX (4294967295U)
569 #define UINT64_MAX ((uint64_t)-1)
577 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
580 #ifdef HAVE_STDBOOL_H
584 #if !defined(HAVE_BOOL)
592 #if !defined(HAVE_INTPTR_T)
593 typedef long long intptr_t ;
596 #if !defined(HAVE_UINTPTR_T)
597 typedef unsigned long long uintptr_t ;
600 #if !defined(HAVE_PTRDIFF_T)
601 typedef unsigned long long ptrdiff_t ;
605 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
607 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
608 * Tru64 needs _BOOL_EXISTS
609 * AIX needs _BOOL,_TRUE,_FALSE
621 #ifndef __bool_true_false_are_defined
622 #define __bool_true_false_are_defined
639 #ifndef HAVE_FUNCTION_MACRO
640 #ifdef HAVE_func_MACRO
641 #define __FUNCTION__ __func__
643 #define __FUNCTION__ ("")
649 #define MIN(a,b) ((a)<(b)?(a):(b))
653 #define MAX(a,b) ((a)>(b)?(a):(b))
656 #if !defined(HAVE_VOLATILE)
661 this is a warning hack. The idea is to use this everywhere that we
662 get the "discarding const" warning from gcc. That doesn't actually
663 fix the problem of course, but it means that when we do get to
664 cleaning them up we can do it by searching the code for
667 It also means that other error types aren't as swamped by the noise
668 of hundreds of const warnings, so we are more likely to notice when
671 Please only add more uses of this macro when you find it
672 _really_ hard to fix const warnings. Our aim is to eventually use
673 this function in only a very few places.
675 Also, please call this via the discard_const_p() macro interface, as that
676 makes the return type safe.
678 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
680 /** Type-safe version of discard_const */
681 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
684 #define __STRING(x) #x
687 #ifndef __STRINGSTRING
688 #define __STRINGSTRING(x) __STRING(x)
692 #define __LINESTR__ __STRINGSTRING(__LINE__)
696 #define __location__ __FILE__ ":" __LINESTR__
702 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
705 * zero a structure given a pointer to the structure
707 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
710 * zero a structure given a pointer to the structure - no zero check
712 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
714 /* zero an array - note that sizeof(array) must work - ie. it must not be a
716 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
719 * work out how many elements there are in a static array
721 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
724 * pointer difference macro
726 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
733 #define QSORT_CAST (__compar_fn_t)
737 #define QSORT_CAST (int (*)(const void *, const void *))
741 #define PATH_MAX 1024
744 #ifndef MAX_DNS_NAME_LENGTH
745 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
749 char *ufc_crypt(const char *key
, const char *salt
);
750 #define crypt ufc_crypt
757 /* these macros gain us a few percent of speed on gcc */
759 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
760 as its first argument */
762 #define likely(x) __builtin_expect(!!(x), 1)
765 #define unlikely(x) __builtin_expect(!!(x), 0)
769 #define likely(x) (x)
772 #define unlikely(x) (x)
776 #ifndef HAVE_FDATASYNC
777 #define fdatasync(fd) fsync(fd)
778 #elif !defined(HAVE_DECL_FDATASYNC)
782 /* these are used to mark symbols as local to a shared lib, or
783 * publicly available via the shared lib API */
785 #ifdef HAVE_VISIBILITY_ATTR
786 #define _PUBLIC_ __attribute__((visibility("default")))
793 #ifdef HAVE_VISIBILITY_ATTR
794 # define _PRIVATE_ __attribute__((visibility("hidden")))
801 #define poll rep_poll
802 /* prototype is in "system/network.h" */
805 #endif /* _LIBREPLACE_REPLACE_H */