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
63 #ifndef __PRI64_PREFIX
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"
111 #ifdef HAVE_BSD_STRING_H
112 #include <bsd/string.h>
115 #ifdef HAVE_BSD_UNISTD_H
116 #include <bsd/unistd.h>
123 #ifdef HAVE_STRINGS_H
127 #ifdef HAVE_SYS_TYPES_H
128 #include <sys/types.h>
136 #ifdef HAVE_LINUX_TYPES_H
138 * This is needed as some broken header files require this to be included early
140 #include <linux/types.h>
143 #ifndef HAVE_STRERROR
144 extern char *sys_errlist
[];
145 #define strerror(i) sys_errlist[i]
148 #ifndef HAVE_ERRNO_DECL
153 #define strdup rep_strdup
154 char *rep_strdup(const char *s
);
158 #define memmove rep_memmove
159 void *rep_memmove(void *dest
,const void *src
,int size
);
163 #define memmem rep_memmem
164 void *rep_memmem(const void *haystack
, size_t haystacklen
,
165 const void *needle
, size_t needlelen
);
168 #ifndef HAVE_MEMALIGN
169 #define memalign rep_memalign
170 void *rep_memalign(size_t boundary
, size_t size
);
174 #define mktime rep_mktime
175 /* prototype is in "system/time.h" */
179 #define timegm rep_timegm
180 /* prototype is in "system/time.h" */
184 #define utime rep_utime
185 /* prototype is in "system/time.h" */
189 #define utimes rep_utimes
190 /* prototype is in "system/time.h" */
194 #define strlcpy rep_strlcpy
195 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
199 #define strlcat rep_strlcat
200 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
203 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
205 #define strndup rep_strndup
206 char *rep_strndup(const char *s
, size_t n
);
209 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
211 #define strnlen rep_strnlen
212 size_t rep_strnlen(const char *s
, size_t n
);
215 #if !HAVE_DECL_ENVIRON
217 #include <crt_externs.h>
218 #define environ (*_NSGetEnviron())
220 extern char **environ
;
225 #define setenv rep_setenv
226 int rep_setenv(const char *name
, const char *value
, int overwrite
);
228 #ifndef HAVE_SETENV_DECL
229 int setenv(const char *name
, const char *value
, int overwrite
);
233 #ifndef HAVE_UNSETENV
234 #define unsetenv rep_unsetenv
235 int rep_unsetenv(const char *name
);
239 #define seteuid rep_seteuid
240 int rep_seteuid(uid_t
);
244 #define setegid rep_setegid
245 int rep_setegid(gid_t
);
248 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
250 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
252 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
253 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
257 #define chown rep_chown
258 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
262 #define chroot rep_chroot
263 int rep_chroot(const char *dirname
);
267 #define link rep_link
268 int rep_link(const char *oldpath
, const char *newpath
);
271 #ifndef HAVE_READLINK
272 #define readlink rep_readlink
273 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
277 #define symlink rep_symlink
278 int rep_symlink(const char *oldpath
, const char *newpath
);
281 #ifndef HAVE_REALPATH
282 #define realpath rep_realpath
283 char *rep_realpath(const char *path
, char *resolved_path
);
287 #define lchown rep_lchown
288 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
295 #ifndef HAVE_SETLINEBUF
296 #define setlinebuf rep_setlinebuf
297 void rep_setlinebuf(FILE *);
300 #ifndef HAVE_STRCASESTR
301 #define strcasestr rep_strcasestr
302 char *rep_strcasestr(const char *haystack
, const char *needle
);
305 #ifndef HAVE_STRTOK_R
306 #define strtok_r rep_strtok_r
307 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
313 #define strtoll rep_strtoll
314 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
316 #ifdef HAVE_BSD_STRTOLL
317 #define strtoll rep_strtoll
318 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
322 #ifndef HAVE_STRTOULL
323 #define strtoull rep_strtoull
324 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
326 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
327 #define strtoull rep_strtoull
328 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
332 #ifndef HAVE_FTRUNCATE
333 #define ftruncate rep_ftruncate
334 int rep_ftruncate(int,off_t
);
337 #ifndef HAVE_INITGROUPS
338 #define initgroups rep_initgroups
339 int rep_initgroups(char *name
, gid_t id
);
342 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
343 #define bzero(a,b) memset((a),'\0',(b))
347 #define dlerror rep_dlerror
348 char *rep_dlerror(void);
352 #define dlopen rep_dlopen
353 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
354 void *rep_dlopen(const char *name
, unsigned int flags
);
356 void *rep_dlopen(const char *name
, int flags
);
361 #define dlsym rep_dlsym
362 void *rep_dlsym(void *handle
, const char *symbol
);
366 #define dlclose rep_dlclose
367 int rep_dlclose(void *handle
);
370 #ifndef HAVE_SOCKETPAIR
371 #define socketpair rep_socketpair
372 /* prototype is in system/network.h */
375 #ifndef HAVE_VDPRINTF
376 #define vdprintf rep_vdprintf
377 int rep_vdprintf(int fd
, const char *format
, va_list ap
);
381 #define dprintf rep_dprintf
382 int rep_dprintf(int fd
, const char *format
, ...);
385 #ifndef PRINTF_ATTRIBUTE
386 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
387 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
388 * the parameter containing the format, and a2 the index of the first
389 * argument. Note that some gcc 2.x versions don't handle this
391 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
393 #define PRINTF_ATTRIBUTE(a1, a2)
398 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
399 #define _DEPRECATED_ __attribute__ ((deprecated))
405 #ifndef HAVE_VASPRINTF
406 #define vasprintf rep_vasprintf
407 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
410 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
411 #define snprintf rep_snprintf
412 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
415 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
416 #define vsnprintf rep_vsnprintf
417 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
420 #ifndef HAVE_ASPRINTF
421 #define asprintf rep_asprintf
422 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
427 #define vsyslog rep_vsyslog
428 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
432 /* we used to use these fns, but now we have good replacements
433 for snprintf and vsnprintf */
434 #define slprintf snprintf
439 #ifdef HAVE___VA_COPY
440 #define va_copy(dest, src) __va_copy(dest, src)
442 #define va_copy(dest, src) (dest) = (src)
446 #ifndef HAVE_VOLATILE
450 #ifndef HAVE_COMPARISON_FN_T
451 typedef int (*comparison_fn_t
)(const void *, const void *);
454 #ifndef HAVE_WORKING_STRPTIME
455 #define strptime rep_strptime
457 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
461 #define dup2 rep_dup2
462 int rep_dup2(int oldfd
, int newfd
);
465 /* Load header file for dynamic linking stuff */
477 #define RTLD_GLOBAL 0
480 #ifndef HAVE_SECURE_MKSTEMP
481 #define mkstemp(path) rep_mkstemp(path)
482 int rep_mkstemp(char *temp
);
486 #define mkdtemp rep_mkdtemp
487 char *rep_mkdtemp(char *template);
491 #define pread rep_pread
492 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
493 #define LIBREPLACE_PREAD_REPLACED 1
495 #define LIBREPLACE_PREAD_NOT_REPLACED 1
499 #define pwrite rep_pwrite
500 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
501 #define LIBREPLACE_PWRITE_REPLACED 1
503 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
506 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
507 #define inet_ntoa rep_inet_ntoa
508 /* prototype is in "system/network.h" */
511 #ifndef HAVE_INET_PTON
512 #define inet_pton rep_inet_pton
513 /* prototype is in "system/network.h" */
516 #ifndef HAVE_INET_NTOP
517 #define inet_ntop rep_inet_ntop
518 /* prototype is in "system/network.h" */
521 #ifndef HAVE_INET_ATON
522 #define inet_aton rep_inet_aton
523 /* prototype is in "system/network.h" */
527 #define connect rep_connect
528 /* prototype is in "system/network.h" */
531 #ifndef HAVE_GETHOSTBYNAME
532 #define gethostbyname rep_gethostbyname
533 /* prototype is in "system/network.h" */
536 #ifndef HAVE_GETIFADDRS
537 #define getifaddrs rep_getifaddrs
538 /* prototype is in "system/network.h" */
541 #ifndef HAVE_FREEIFADDRS
542 #define freeifaddrs rep_freeifaddrs
543 /* prototype is in "system/network.h" */
546 #ifndef HAVE_GET_CURRENT_DIR_NAME
547 #define get_current_dir_name rep_get_current_dir_name
548 char *rep_get_current_dir_name(void);
551 #if !defined(HAVE_STRERROR_R) || !defined(STRERROR_R_PROTO_COMPATIBLE)
553 #define strerror_r rep_strerror_r
554 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
557 #if !defined(HAVE_CLOCK_GETTIME)
558 #define clock_gettime rep_clock_gettime
565 #ifdef HAVE_SYS_PARAM_H
566 #include <sys/param.h>
569 /* The extra casts work around common compiler bugs. */
570 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
571 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
572 It is necessary at least when t == time_t. */
573 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
574 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
575 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
578 #define UINT16_MAX 65535
582 #define UINT32_MAX (4294967295U)
586 #define UINT64_MAX ((uint64_t)-1)
594 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
597 #ifdef HAVE_STDBOOL_H
601 #if !defined(HAVE_BOOL)
609 #if !defined(HAVE_INTPTR_T)
610 typedef long long intptr_t ;
613 #if !defined(HAVE_UINTPTR_T)
614 typedef unsigned long long uintptr_t ;
617 #if !defined(HAVE_PTRDIFF_T)
618 typedef unsigned long long ptrdiff_t ;
622 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
624 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
625 * Tru64 needs _BOOL_EXISTS
626 * AIX needs _BOOL,_TRUE,_FALSE
638 #ifndef __bool_true_false_are_defined
639 #define __bool_true_false_are_defined
656 #ifndef HAVE_FUNCTION_MACRO
657 #ifdef HAVE_func_MACRO
658 #define __FUNCTION__ __func__
660 #define __FUNCTION__ ("")
666 #define MIN(a,b) ((a)<(b)?(a):(b))
670 #define MAX(a,b) ((a)>(b)?(a):(b))
673 #if !defined(HAVE_VOLATILE)
678 this is a warning hack. The idea is to use this everywhere that we
679 get the "discarding const" warning from gcc. That doesn't actually
680 fix the problem of course, but it means that when we do get to
681 cleaning them up we can do it by searching the code for
684 It also means that other error types aren't as swamped by the noise
685 of hundreds of const warnings, so we are more likely to notice when
688 Please only add more uses of this macro when you find it
689 _really_ hard to fix const warnings. Our aim is to eventually use
690 this function in only a very few places.
692 Also, please call this via the discard_const_p() macro interface, as that
693 makes the return type safe.
695 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
697 /** Type-safe version of discard_const */
698 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
701 #define __STRING(x) #x
704 #ifndef __STRINGSTRING
705 #define __STRINGSTRING(x) __STRING(x)
709 #define __LINESTR__ __STRINGSTRING(__LINE__)
713 #define __location__ __FILE__ ":" __LINESTR__
719 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
722 * zero a structure given a pointer to the structure
724 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
727 * zero a structure given a pointer to the structure - no zero check
729 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
731 /* zero an array - note that sizeof(array) must work - ie. it must not be a
733 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
736 * work out how many elements there are in a static array
738 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
741 * pointer difference macro
743 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
750 #define QSORT_CAST (__compar_fn_t)
754 #define QSORT_CAST (int (*)(const void *, const void *))
758 #define PATH_MAX 1024
761 #ifndef MAX_DNS_NAME_LENGTH
762 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
766 char *ufc_crypt(const char *key
, const char *salt
);
767 #define crypt ufc_crypt
774 /* these macros gain us a few percent of speed on gcc */
776 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
777 as its first argument */
779 #define likely(x) __builtin_expect(!!(x), 1)
782 #define unlikely(x) __builtin_expect(!!(x), 0)
786 #define likely(x) (x)
789 #define unlikely(x) (x)
793 #ifndef HAVE_FDATASYNC
794 #define fdatasync(fd) fsync(fd)
795 #elif !defined(HAVE_DECL_FDATASYNC)
799 /* these are used to mark symbols as local to a shared lib, or
800 * publicly available via the shared lib API */
802 #ifdef HAVE_VISIBILITY_ATTR
803 #define _PUBLIC_ __attribute__((visibility("default")))
810 #ifdef HAVE_VISIBILITY_ATTR
811 # define _PRIVATE_ __attribute__((visibility("hidden")))
818 #define poll rep_poll
819 /* prototype is in "system/network.h" */
822 #if !defined(getpass)
823 #ifdef REPLACE_GETPASS
824 #if defined(REPLACE_GETPASS_BY_GETPASSPHRASE)
825 #define getpass(prompt) getpassphrase(prompt)
827 #define getpass(prompt) rep_getpass(prompt)
828 char *rep_getpass(const char *prompt
);
833 #ifndef HAVE_GETPEEREID
834 #define getpeereid rep_getpeereid
835 int rep_getpeereid(int s
, uid_t
*uid
, gid_t
*gid
);
839 #define usleep rep_usleep
840 typedef long useconds_t
;
841 int usleep(useconds_t
);
844 #endif /* _LIBREPLACE_REPLACE_H */