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"
107 #ifdef HAVE_BSD_STRING_H
108 #include <bsd/string.h>
115 #ifdef HAVE_STRINGS_H
119 #ifdef HAVE_SYS_TYPES_H
120 #include <sys/types.h>
128 #ifdef HAVE_LINUX_TYPES_H
130 * This is needed as some broken header files require this to be included early
132 #include <linux/types.h>
135 #ifndef HAVE_STRERROR
136 extern char *sys_errlist
[];
137 #define strerror(i) sys_errlist[i]
140 #ifndef HAVE_ERRNO_DECL
145 #define strdup rep_strdup
146 char *rep_strdup(const char *s
);
150 #define memmove rep_memmove
151 void *rep_memmove(void *dest
,const void *src
,int size
);
155 #define memmem rep_memmem
156 void *rep_memmem(const void *haystack
, size_t haystacklen
,
157 const void *needle
, size_t needlelen
);
161 #define mktime rep_mktime
162 /* prototype is in "system/time.h" */
166 #define timegm rep_timegm
167 /* prototype is in "system/time.h" */
171 #define utime rep_utime
172 /* prototype is in "system/time.h" */
176 #define utimes rep_utimes
177 /* prototype is in "system/time.h" */
181 #define strlcpy rep_strlcpy
182 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
186 #define strlcat rep_strlcat
187 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
190 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
192 #define strndup rep_strndup
193 char *rep_strndup(const char *s
, size_t n
);
196 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
198 #define strnlen rep_strnlen
199 size_t rep_strnlen(const char *s
, size_t n
);
202 #if !HAVE_DECL_ENVIRON
204 #include <crt_externs.h>
205 #define environ (*_NSGetEnviron())
207 extern char **environ
;
212 #define setenv rep_setenv
213 int rep_setenv(const char *name
, const char *value
, int overwrite
);
215 #ifndef HAVE_SETENV_DECL
216 int setenv(const char *name
, const char *value
, int overwrite
);
220 #ifndef HAVE_UNSETENV
221 #define unsetenv rep_unsetenv
222 int rep_unsetenv(const char *name
);
226 #define seteuid rep_seteuid
227 int rep_seteuid(uid_t
);
231 #define setegid rep_setegid
232 int rep_setegid(gid_t
);
235 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
237 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
239 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
240 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
244 #define chown rep_chown
245 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
249 #define chroot rep_chroot
250 int rep_chroot(const char *dirname
);
254 #define link rep_link
255 int rep_link(const char *oldpath
, const char *newpath
);
258 #ifndef HAVE_READLINK
259 #define readlink rep_readlink
260 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
264 #define symlink rep_symlink
265 int rep_symlink(const char *oldpath
, const char *newpath
);
268 #ifndef HAVE_REALPATH
269 #define realpath rep_realpath
270 char *rep_realpath(const char *path
, char *resolved_path
);
274 #define lchown rep_lchown
275 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
282 #ifndef HAVE_SETLINEBUF
283 #define setlinebuf rep_setlinebuf
284 void rep_setlinebuf(FILE *);
287 #ifndef HAVE_STRCASESTR
288 #define strcasestr rep_strcasestr
289 char *rep_strcasestr(const char *haystack
, const char *needle
);
292 #ifndef HAVE_STRTOK_R
293 #define strtok_r rep_strtok_r
294 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
300 #define strtoll rep_strtoll
301 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
303 #ifdef HAVE_BSD_STRTOLL
304 #define strtoll rep_strtoll
305 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
309 #ifndef HAVE_STRTOULL
310 #define strtoull rep_strtoull
311 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
313 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
314 #define strtoull rep_strtoull
315 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
319 #ifndef HAVE_FTRUNCATE
320 #define ftruncate rep_ftruncate
321 int rep_ftruncate(int,off_t
);
324 #ifndef HAVE_INITGROUPS
325 #define initgroups rep_initgroups
326 int rep_initgroups(char *name
, gid_t id
);
329 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
330 #define bzero(a,b) memset((a),'\0',(b))
334 #define dlerror rep_dlerror
335 char *rep_dlerror(void);
339 #define dlopen rep_dlopen
340 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
341 void *rep_dlopen(const char *name
, unsigned int flags
);
343 void *rep_dlopen(const char *name
, int flags
);
348 #define dlsym rep_dlsym
349 void *rep_dlsym(void *handle
, const char *symbol
);
353 #define dlclose rep_dlclose
354 int rep_dlclose(void *handle
);
357 #ifndef HAVE_SOCKETPAIR
358 #define socketpair rep_socketpair
359 /* prototype is in system/network.h */
362 #ifndef HAVE_VDPRINTF
363 #define vdprintf rep_vdprintf
364 int rep_vdprintf(int fd
, const char *format
, va_list ap
);
368 #define dprintf rep_dprintf
369 int rep_dprintf(int fd
, const char *format
, ...);
372 #ifndef PRINTF_ATTRIBUTE
373 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
374 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
375 * the parameter containing the format, and a2 the index of the first
376 * argument. Note that some gcc 2.x versions don't handle this
378 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
380 #define PRINTF_ATTRIBUTE(a1, a2)
385 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
386 #define _DEPRECATED_ __attribute__ ((deprecated))
392 #ifndef HAVE_VASPRINTF
393 #define vasprintf rep_vasprintf
394 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
397 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
398 #define snprintf rep_snprintf
399 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
402 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
403 #define vsnprintf rep_vsnprintf
404 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
407 #ifndef HAVE_ASPRINTF
408 #define asprintf rep_asprintf
409 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
414 #define vsyslog rep_vsyslog
415 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
419 /* we used to use these fns, but now we have good replacements
420 for snprintf and vsnprintf */
421 #define slprintf snprintf
426 #ifdef HAVE___VA_COPY
427 #define va_copy(dest, src) __va_copy(dest, src)
429 #define va_copy(dest, src) (dest) = (src)
433 #ifndef HAVE_VOLATILE
437 #ifndef HAVE_COMPARISON_FN_T
438 typedef int (*comparison_fn_t
)(const void *, const void *);
441 #ifdef REPLACE_STRPTIME
442 #define strptime rep_strptime
444 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
448 #define dup2 rep_dup2
449 int rep_dup2(int oldfd
, int newfd
);
452 /* Load header file for dynamic linking stuff */
464 #define RTLD_GLOBAL 0
467 #ifndef HAVE_SECURE_MKSTEMP
468 #define mkstemp(path) rep_mkstemp(path)
469 int rep_mkstemp(char *temp
);
473 #define mkdtemp rep_mkdtemp
474 char *rep_mkdtemp(char *template);
478 #define pread rep_pread
479 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
480 #define LIBREPLACE_PREAD_REPLACED 1
482 #define LIBREPLACE_PREAD_NOT_REPLACED 1
486 #define pwrite rep_pwrite
487 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
488 #define LIBREPLACE_PWRITE_REPLACED 1
490 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
493 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
494 #define inet_ntoa rep_inet_ntoa
495 /* prototype is in "system/network.h" */
498 #ifndef HAVE_INET_PTON
499 #define inet_pton rep_inet_pton
500 /* prototype is in "system/network.h" */
503 #ifndef HAVE_INET_NTOP
504 #define inet_ntop rep_inet_ntop
505 /* prototype is in "system/network.h" */
508 #ifndef HAVE_INET_ATON
509 #define inet_aton rep_inet_aton
510 /* prototype is in "system/network.h" */
514 #define connect rep_connect
515 /* prototype is in "system/network.h" */
518 #ifndef HAVE_GETHOSTBYNAME
519 #define gethostbyname rep_gethostbyname
520 /* prototype is in "system/network.h" */
523 #ifndef HAVE_GETIFADDRS
524 #define getifaddrs rep_getifaddrs
525 /* prototype is in "system/network.h" */
528 #ifndef HAVE_FREEIFADDRS
529 #define freeifaddrs rep_freeifaddrs
530 /* prototype is in "system/network.h" */
533 #ifndef HAVE_GET_CURRENT_DIR_NAME
534 #define get_current_dir_name rep_get_current_dir_name
535 char *rep_get_current_dir_name(void);
538 #if !defined(HAVE_STRERROR_R) || !defined(STRERROR_R_PROTO_COMPATIBLE)
540 #define strerror_r rep_strerror_r
541 int rep_strerror_r(int errnum
, char *buf
, size_t buflen
);
544 #if !defined(HAVE_CLOCK_GETTIME)
545 #define clock_gettime rep_clock_gettime
552 #ifdef HAVE_SYS_PARAM_H
553 #include <sys/param.h>
556 /* The extra casts work around common compiler bugs. */
557 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
558 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
559 It is necessary at least when t == time_t. */
560 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
561 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
562 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
565 #define UINT16_MAX 65535
569 #define UINT32_MAX (4294967295U)
573 #define UINT64_MAX ((uint64_t)-1)
581 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
584 #ifdef HAVE_STDBOOL_H
588 #if !defined(HAVE_BOOL)
596 #if !defined(HAVE_INTPTR_T)
597 typedef long long intptr_t ;
600 #if !defined(HAVE_UINTPTR_T)
601 typedef unsigned long long uintptr_t ;
604 #if !defined(HAVE_PTRDIFF_T)
605 typedef unsigned long long ptrdiff_t ;
609 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
611 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
612 * Tru64 needs _BOOL_EXISTS
613 * AIX needs _BOOL,_TRUE,_FALSE
625 #ifndef __bool_true_false_are_defined
626 #define __bool_true_false_are_defined
643 #ifndef HAVE_FUNCTION_MACRO
644 #ifdef HAVE_func_MACRO
645 #define __FUNCTION__ __func__
647 #define __FUNCTION__ ("")
653 #define MIN(a,b) ((a)<(b)?(a):(b))
657 #define MAX(a,b) ((a)>(b)?(a):(b))
660 #if !defined(HAVE_VOLATILE)
665 this is a warning hack. The idea is to use this everywhere that we
666 get the "discarding const" warning from gcc. That doesn't actually
667 fix the problem of course, but it means that when we do get to
668 cleaning them up we can do it by searching the code for
671 It also means that other error types aren't as swamped by the noise
672 of hundreds of const warnings, so we are more likely to notice when
675 Please only add more uses of this macro when you find it
676 _really_ hard to fix const warnings. Our aim is to eventually use
677 this function in only a very few places.
679 Also, please call this via the discard_const_p() macro interface, as that
680 makes the return type safe.
682 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
684 /** Type-safe version of discard_const */
685 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
688 #define __STRING(x) #x
691 #ifndef __STRINGSTRING
692 #define __STRINGSTRING(x) __STRING(x)
696 #define __LINESTR__ __STRINGSTRING(__LINE__)
700 #define __location__ __FILE__ ":" __LINESTR__
706 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
709 * zero a structure given a pointer to the structure
711 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
714 * zero a structure given a pointer to the structure - no zero check
716 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
718 /* zero an array - note that sizeof(array) must work - ie. it must not be a
720 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
723 * work out how many elements there are in a static array
725 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
728 * pointer difference macro
730 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
737 #define QSORT_CAST (__compar_fn_t)
741 #define QSORT_CAST (int (*)(const void *, const void *))
745 #define PATH_MAX 1024
748 #ifndef MAX_DNS_NAME_LENGTH
749 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
753 char *ufc_crypt(const char *key
, const char *salt
);
754 #define crypt ufc_crypt
761 /* these macros gain us a few percent of speed on gcc */
763 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
764 as its first argument */
766 #define likely(x) __builtin_expect(!!(x), 1)
769 #define unlikely(x) __builtin_expect(!!(x), 0)
773 #define likely(x) (x)
776 #define unlikely(x) (x)
780 #ifndef HAVE_FDATASYNC
781 #define fdatasync(fd) fsync(fd)
782 #elif !defined(HAVE_DECL_FDATASYNC)
786 /* these are used to mark symbols as local to a shared lib, or
787 * publicly available via the shared lib API */
789 #ifdef HAVE_VISIBILITY_ATTR
790 #define _PUBLIC_ __attribute__((visibility("default")))
797 #ifdef HAVE_VISIBILITY_ATTR
798 # define _PRIVATE_ __attribute__((visibility("hidden")))
805 #define poll rep_poll
806 /* prototype is in "system/network.h" */
809 #if !defined(getpass)
810 #ifdef REPLACE_GETPASS
811 #if defined(REPLACE_GETPASS_BY_GETPASSPHRASE)
812 #define getpass(prompt) getpassphrase(prompt)
814 #define getpass(prompt) rep_getpass(prompt)
815 char *rep_getpass(const char *prompt
);
820 #endif /* _LIBREPLACE_REPLACE_H */