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
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"
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>
131 #ifdef HAVE_SETPROCTITLE_H
132 #include <setproctitle.h>
140 #ifdef HAVE_LINUX_TYPES_H
142 * This is needed as some broken header files require this to be included early
144 #include <linux/types.h>
147 #ifndef HAVE_STRERROR
148 extern char *sys_errlist
[];
149 #define strerror(i) sys_errlist[i]
152 #ifndef HAVE_ERRNO_DECL
157 #define strdup rep_strdup
158 char *rep_strdup(const char *s
);
162 #define memmove rep_memmove
163 void *rep_memmove(void *dest
,const void *src
,int size
);
167 #define memmem rep_memmem
168 void *rep_memmem(const void *haystack
, size_t haystacklen
,
169 const void *needle
, size_t needlelen
);
172 #ifndef HAVE_MEMALIGN
173 #define memalign rep_memalign
174 void *rep_memalign(size_t boundary
, size_t size
);
178 #define mktime rep_mktime
179 /* prototype is in "system/time.h" */
183 #define timegm rep_timegm
184 /* prototype is in "system/time.h" */
188 #define utime rep_utime
189 /* prototype is in "system/time.h" */
193 #define utimes rep_utimes
194 /* prototype is in "system/time.h" */
198 #define strlcpy rep_strlcpy
199 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
203 #define strlcat rep_strlcat
204 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
207 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
209 #define strndup rep_strndup
210 char *rep_strndup(const char *s
, size_t n
);
213 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
215 #define strnlen rep_strnlen
216 size_t rep_strnlen(const char *s
, size_t n
);
219 #if !HAVE_DECL_ENVIRON
221 #include <crt_externs.h>
222 #define environ (*_NSGetEnviron())
224 extern char **environ
;
229 #define setenv rep_setenv
230 int rep_setenv(const char *name
, const char *value
, int overwrite
);
232 #ifndef HAVE_SETENV_DECL
233 int setenv(const char *name
, const char *value
, int overwrite
);
237 #ifndef HAVE_UNSETENV
238 #define unsetenv rep_unsetenv
239 int rep_unsetenv(const char *name
);
243 #define seteuid rep_seteuid
244 int rep_seteuid(uid_t
);
248 #define setegid rep_setegid
249 int rep_setegid(gid_t
);
252 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
254 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
256 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
257 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
261 #define chown rep_chown
262 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
266 #define chroot rep_chroot
267 int rep_chroot(const char *dirname
);
271 #define link rep_link
272 int rep_link(const char *oldpath
, const char *newpath
);
275 #ifndef HAVE_READLINK
276 #define readlink rep_readlink
277 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
281 #define symlink rep_symlink
282 int rep_symlink(const char *oldpath
, const char *newpath
);
285 #ifndef HAVE_REALPATH
286 #define realpath rep_realpath
287 char *rep_realpath(const char *path
, char *resolved_path
);
291 #define lchown rep_lchown
292 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
299 #ifndef HAVE_SETLINEBUF
300 #define setlinebuf rep_setlinebuf
301 void rep_setlinebuf(FILE *);
304 #ifndef HAVE_STRCASESTR
305 #define strcasestr rep_strcasestr
306 char *rep_strcasestr(const char *haystack
, const char *needle
);
309 #ifndef HAVE_STRTOK_R
310 #define strtok_r rep_strtok_r
311 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
317 #define strtoll rep_strtoll
318 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
320 #ifdef HAVE_BSD_STRTOLL
321 #define strtoll rep_strtoll
322 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
326 #ifndef HAVE_STRTOULL
327 #define strtoull rep_strtoull
328 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
330 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
331 #define strtoull rep_strtoull
332 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
336 #ifndef HAVE_FTRUNCATE
337 #define ftruncate rep_ftruncate
338 int rep_ftruncate(int,off_t
);
341 #ifndef HAVE_INITGROUPS
342 #define initgroups rep_initgroups
343 int rep_initgroups(char *name
, gid_t id
);
346 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
347 #define bzero(a,b) memset((a),'\0',(b))
351 #define dlerror rep_dlerror
352 char *rep_dlerror(void);
356 #define dlopen rep_dlopen
357 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
358 void *rep_dlopen(const char *name
, unsigned int flags
);
360 void *rep_dlopen(const char *name
, int flags
);
365 #define dlsym rep_dlsym
366 void *rep_dlsym(void *handle
, const char *symbol
);
370 #define dlclose rep_dlclose
371 int rep_dlclose(void *handle
);
374 #ifndef HAVE_SOCKETPAIR
375 #define socketpair rep_socketpair
376 /* prototype is in system/network.h */
379 #ifndef PRINTF_ATTRIBUTE
380 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
381 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
382 * the parameter containing the format, and a2 the index of the first
383 * argument. Note that some gcc 2.x versions don't handle this
385 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
387 #define PRINTF_ATTRIBUTE(a1, a2)
392 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
393 #define _DEPRECATED_ __attribute__ ((deprecated))
399 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
400 #define vdprintf rep_vdprintf
401 int rep_vdprintf(int fd
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
404 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
405 #define dprintf rep_dprintf
406 int rep_dprintf(int fd
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
409 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
410 #define vasprintf rep_vasprintf
411 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
414 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
415 #define snprintf rep_snprintf
416 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
419 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
420 #define vsnprintf rep_vsnprintf
421 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
424 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
425 #define asprintf rep_asprintf
426 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
429 #if !defined(HAVE_C99_VSNPRINTF)
430 #ifdef REPLACE_BROKEN_PRINTF
432 * We do not redefine printf by default
433 * as it breaks the build if system headers
434 * use __attribute__((format(printf, 3, 0)))
435 * instead of __attribute__((format(__printf__, 3, 0)))
437 #define printf rep_printf
439 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
442 #if !defined(HAVE_C99_VSNPRINTF)
443 #define fprintf rep_fprintf
444 int rep_fprintf(FILE *stream
, const char *, ...) PRINTF_ATTRIBUTE(2,3);
449 #define vsyslog rep_vsyslog
450 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
454 /* we used to use these fns, but now we have good replacements
455 for snprintf and vsnprintf */
456 #define slprintf snprintf
461 #ifdef HAVE___VA_COPY
462 #define va_copy(dest, src) __va_copy(dest, src)
464 #define va_copy(dest, src) (dest) = (src)
468 #ifndef HAVE_VOLATILE
472 #ifndef HAVE_COMPARISON_FN_T
473 typedef int (*comparison_fn_t
)(const void *, const void *);
476 #ifndef HAVE_WORKING_STRPTIME
477 #define strptime rep_strptime
479 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
483 #define dup2 rep_dup2
484 int rep_dup2(int oldfd
, int newfd
);
487 /* Load header file for dynamic linking stuff */
499 #define RTLD_GLOBAL 0
502 #ifndef HAVE_SECURE_MKSTEMP
503 #define mkstemp(path) rep_mkstemp(path)
504 int rep_mkstemp(char *temp
);
508 #define mkdtemp rep_mkdtemp
509 char *rep_mkdtemp(char *template);
513 #define pread rep_pread
514 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
515 #define LIBREPLACE_PREAD_REPLACED 1
517 #define LIBREPLACE_PREAD_NOT_REPLACED 1
521 #define pwrite rep_pwrite
522 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
523 #define LIBREPLACE_PWRITE_REPLACED 1
525 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
528 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
529 #define inet_ntoa rep_inet_ntoa
530 /* prototype is in "system/network.h" */
533 #ifndef HAVE_INET_PTON
534 #define inet_pton rep_inet_pton
535 /* prototype is in "system/network.h" */
538 #ifndef HAVE_INET_NTOP
539 #define inet_ntop rep_inet_ntop
540 /* prototype is in "system/network.h" */
543 #ifndef HAVE_INET_ATON
544 #define inet_aton rep_inet_aton
545 /* prototype is in "system/network.h" */
549 #define connect rep_connect
550 /* prototype is in "system/network.h" */
553 #ifndef HAVE_GETHOSTBYNAME
554 #define gethostbyname rep_gethostbyname
555 /* prototype is in "system/network.h" */
558 #ifndef HAVE_GETIFADDRS
559 #define getifaddrs rep_getifaddrs
560 /* prototype is in "system/network.h" */
563 #ifndef HAVE_FREEIFADDRS
564 #define freeifaddrs rep_freeifaddrs
565 /* prototype is in "system/network.h" */
568 #ifndef HAVE_GET_CURRENT_DIR_NAME
569 #define get_current_dir_name rep_get_current_dir_name
570 char *rep_get_current_dir_name(void);
573 #if !defined(HAVE_STRERROR_R) && !defined(strerror_r)
574 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
577 #if !defined(HAVE_CLOCK_GETTIME)
578 #define clock_gettime rep_clock_gettime
585 #ifdef HAVE_SYS_PARAM_H
586 #include <sys/param.h>
589 /* The extra casts work around common compiler bugs. */
590 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
591 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
592 It is necessary at least when t == time_t. */
593 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
594 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
595 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
598 #define UINT16_MAX 65535
602 #define UINT32_MAX (4294967295U)
606 #define UINT64_MAX ((uint64_t)-1)
610 #define INT64_MAX 9223372036854775807LL
618 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
621 #ifdef HAVE_STDBOOL_H
625 #if !defined(HAVE_BOOL)
633 #if !defined(HAVE_INTPTR_T)
634 typedef long long intptr_t ;
637 #if !defined(HAVE_UINTPTR_T)
638 typedef unsigned long long uintptr_t ;
641 #if !defined(HAVE_PTRDIFF_T)
642 typedef unsigned long long ptrdiff_t ;
646 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
648 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
649 * Tru64 needs _BOOL_EXISTS
650 * AIX needs _BOOL,_TRUE,_FALSE
662 #ifndef __bool_true_false_are_defined
663 #define __bool_true_false_are_defined
680 #ifndef HAVE_FUNCTION_MACRO
681 #ifdef HAVE_func_MACRO
682 #define __FUNCTION__ __func__
684 #define __FUNCTION__ ("")
690 #define MIN(a,b) ((a)<(b)?(a):(b))
694 #define MAX(a,b) ((a)>(b)?(a):(b))
697 #if !defined(HAVE_VOLATILE)
702 this is a warning hack. The idea is to use this everywhere that we
703 get the "discarding const" warning from gcc. That doesn't actually
704 fix the problem of course, but it means that when we do get to
705 cleaning them up we can do it by searching the code for
708 It also means that other error types aren't as swamped by the noise
709 of hundreds of const warnings, so we are more likely to notice when
712 Please only add more uses of this macro when you find it
713 _really_ hard to fix const warnings. Our aim is to eventually use
714 this function in only a very few places.
716 Also, please call this via the discard_const_p() macro interface, as that
717 makes the return type safe.
719 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
721 /** Type-safe version of discard_const */
722 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
725 #define __STRING(x) #x
728 #ifndef __STRINGSTRING
729 #define __STRINGSTRING(x) __STRING(x)
733 #define __LINESTR__ __STRINGSTRING(__LINE__)
737 #define __location__ __FILE__ ":" __LINESTR__
743 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
746 * zero a structure given a pointer to the structure
748 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
751 * zero a structure given a pointer to the structure - no zero check
753 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
755 /* zero an array - note that sizeof(array) must work - ie. it must not be a
757 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
760 * work out how many elements there are in a static array
762 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
765 * pointer difference macro
767 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
774 #define QSORT_CAST (__compar_fn_t)
778 #define QSORT_CAST (int (*)(const void *, const void *))
782 #define PATH_MAX 1024
785 #ifndef MAX_DNS_NAME_LENGTH
786 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
790 char *ufc_crypt(const char *key
, const char *salt
);
791 #define crypt ufc_crypt
798 /* these macros gain us a few percent of speed on gcc */
800 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
801 as its first argument */
803 #define likely(x) __builtin_expect(!!(x), 1)
806 #define unlikely(x) __builtin_expect(!!(x), 0)
810 #define likely(x) (x)
813 #define unlikely(x) (x)
817 #ifndef HAVE_FDATASYNC
818 #define fdatasync(fd) fsync(fd)
819 #elif !defined(HAVE_DECL_FDATASYNC)
823 /* these are used to mark symbols as local to a shared lib, or
824 * publicly available via the shared lib API */
826 #ifdef HAVE_VISIBILITY_ATTR
827 #define _PUBLIC_ __attribute__((visibility("default")))
834 #ifdef HAVE_VISIBILITY_ATTR
835 # define _PRIVATE_ __attribute__((visibility("hidden")))
842 #define poll rep_poll
843 /* prototype is in "system/network.h" */
846 #if !defined(getpass)
847 #ifdef REPLACE_GETPASS
848 #if defined(REPLACE_GETPASS_BY_GETPASSPHRASE)
849 #define getpass(prompt) getpassphrase(prompt)
851 #define getpass(prompt) rep_getpass(prompt)
852 char *rep_getpass(const char *prompt
);
857 #ifndef HAVE_GETPEEREID
858 #define getpeereid rep_getpeereid
859 int rep_getpeereid(int s
, uid_t
*uid
, gid_t
*gid
);
863 #define usleep rep_usleep
864 typedef long useconds_t
;
865 int usleep(useconds_t
);
868 #ifndef HAVE_SETPROCTITLE
869 #define setproctitle rep_setproctitle
870 void rep_setproctitle(const char *fmt
, ...) PRINTF_ATTRIBUTE(1, 2);
873 #endif /* _LIBREPLACE_REPLACE_H */