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 #ifndef HAVE_STRERROR
125 extern char *sys_errlist
[];
126 #define strerror(i) sys_errlist[i]
129 #ifndef HAVE_ERRNO_DECL
134 #define strdup rep_strdup
135 char *rep_strdup(const char *s
);
139 #define memmove rep_memmove
140 void *rep_memmove(void *dest
,const void *src
,int size
);
144 #define memmem rep_memmem
145 void *rep_memmem(const void *haystack
, size_t haystacklen
,
146 const void *needle
, size_t needlelen
);
150 #define mktime rep_mktime
151 /* prototype is in "system/time.h" */
155 #define timegm rep_timegm
156 /* prototype is in "system/time.h" */
160 #define utime rep_utime
161 /* prototype is in "system/time.h" */
165 #define utimes rep_utimes
166 /* prototype is in "system/time.h" */
170 #define strlcpy rep_strlcpy
171 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
175 #define strlcat rep_strlcat
176 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
179 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
181 #define strndup rep_strndup
182 char *rep_strndup(const char *s
, size_t n
);
185 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
187 #define strnlen rep_strnlen
188 size_t rep_strnlen(const char *s
, size_t n
);
191 #if !HAVE_DECL_ENVIRON
193 #include <crt_externs.h>
194 #define environ (*_NSGetEnviron())
196 extern char **environ
;
201 #define setenv rep_setenv
202 int rep_setenv(const char *name
, const char *value
, int overwrite
);
204 #ifndef HAVE_SETENV_DECL
205 int setenv(const char *name
, const char *value
, int overwrite
);
209 #ifndef HAVE_UNSETENV
210 #define unsetenv rep_unsetenv
211 int rep_unsetenv(const char *name
);
215 #define seteuid rep_seteuid
216 int rep_seteuid(uid_t
);
220 #define setegid rep_setegid
221 int rep_setegid(gid_t
);
224 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
226 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
228 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
229 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
233 #define chown rep_chown
234 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
238 #define chroot rep_chroot
239 int rep_chroot(const char *dirname
);
243 #define link rep_link
244 int rep_link(const char *oldpath
, const char *newpath
);
247 #ifndef HAVE_READLINK
248 #define readlink rep_readlink
249 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
253 #define symlink rep_symlink
254 int rep_symlink(const char *oldpath
, const char *newpath
);
257 #ifndef HAVE_REALPATH
258 #define realpath rep_realpath
259 char *rep_realpath(const char *path
, char *resolved_path
);
263 #define lchown rep_lchown
264 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
271 #ifndef HAVE_SETLINEBUF
272 #define setlinebuf rep_setlinebuf
273 void rep_setlinebuf(FILE *);
276 #ifndef HAVE_STRCASESTR
277 #define strcasestr rep_strcasestr
278 char *rep_strcasestr(const char *haystack
, const char *needle
);
281 #ifndef HAVE_STRTOK_R
282 #define strtok_r rep_strtok_r
283 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
287 #define strtoll rep_strtoll
288 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
291 #ifndef HAVE_STRTOULL
292 #define strtoull rep_strtoull
293 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
296 #ifndef HAVE_FTRUNCATE
297 #define ftruncate rep_ftruncate
298 int rep_ftruncate(int,off_t
);
301 #ifndef HAVE_INITGROUPS
302 #define initgroups rep_initgroups
303 int rep_initgroups(char *name
, gid_t id
);
306 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
307 #define bzero(a,b) memset((a),'\0',(b))
311 #define dlerror rep_dlerror
312 char *rep_dlerror(void);
316 #define dlopen rep_dlopen
317 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
318 void *rep_dlopen(const char *name
, unsigned int flags
);
320 void *rep_dlopen(const char *name
, int flags
);
325 #define dlsym rep_dlsym
326 void *rep_dlsym(void *handle
, const char *symbol
);
330 #define dlclose rep_dlclose
331 int rep_dlclose(void *handle
);
334 #ifndef HAVE_SOCKETPAIR
335 #define socketpair rep_socketpair
336 /* prototype is in system/network.h */
339 #ifndef PRINTF_ATTRIBUTE
340 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
341 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
342 * the parameter containing the format, and a2 the index of the first
343 * argument. Note that some gcc 2.x versions don't handle this
345 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
347 #define PRINTF_ATTRIBUTE(a1, a2)
352 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
353 #define _DEPRECATED_ __attribute__ ((deprecated))
359 #ifndef HAVE_VASPRINTF
360 #define vasprintf rep_vasprintf
361 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
364 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
365 #define snprintf rep_snprintf
366 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
369 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
370 #define vsnprintf rep_vsnprintf
371 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
374 #ifndef HAVE_ASPRINTF
375 #define asprintf rep_asprintf
376 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
381 #define vsyslog rep_vsyslog
382 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
386 /* we used to use these fns, but now we have good replacements
387 for snprintf and vsnprintf */
388 #define slprintf snprintf
393 #ifdef HAVE___VA_COPY
394 #define va_copy(dest, src) __va_copy(dest, src)
396 #define va_copy(dest, src) (dest) = (src)
400 #ifndef HAVE_VOLATILE
404 #ifndef HAVE_COMPARISON_FN_T
405 typedef int (*comparison_fn_t
)(const void *, const void *);
408 #ifdef REPLACE_STRPTIME
409 #define strptime rep_strptime
411 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
415 #define dup2 rep_dup2
416 int rep_dup2(int oldfd
, int newfd
);
419 /* Load header file for dynamic linking stuff */
431 #define RTLD_GLOBAL 0
434 #ifndef HAVE_SECURE_MKSTEMP
435 #define mkstemp(path) rep_mkstemp(path)
436 int rep_mkstemp(char *temp
);
440 #define mkdtemp rep_mkdtemp
441 char *rep_mkdtemp(char *template);
445 #define pread rep_pread
446 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
447 #define LIBREPLACE_PREAD_REPLACED 1
449 #define LIBREPLACE_PREAD_NOT_REPLACED 1
453 #define pwrite rep_pwrite
454 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
455 #define LIBREPLACE_PWRITE_REPLACED 1
457 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
460 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
461 #define inet_ntoa rep_inet_ntoa
462 /* prototype is in "system/network.h" */
465 #ifndef HAVE_INET_PTON
466 #define inet_pton rep_inet_pton
467 /* prototype is in "system/network.h" */
470 #ifndef HAVE_INET_NTOP
471 #define inet_ntop rep_inet_ntop
472 /* prototype is in "system/network.h" */
475 #ifndef HAVE_INET_ATON
476 #define inet_aton rep_inet_aton
477 /* prototype is in "system/network.h" */
481 #define connect rep_connect
482 /* prototype is in "system/network.h" */
485 #ifndef HAVE_GETHOSTBYNAME
486 #define gethostbyname rep_gethostbyname
487 /* prototype is in "system/network.h" */
490 #ifndef HAVE_GETIFADDRS
491 #define getifaddrs rep_getifaddrs
492 /* prototype is in "system/network.h" */
495 #ifndef HAVE_FREEIFADDRS
496 #define freeifaddrs rep_freeifaddrs
497 /* prototype is in "system/network.h" */
504 #ifdef HAVE_SYS_PARAM_H
505 #include <sys/param.h>
508 /* The extra casts work around common compiler bugs. */
509 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
510 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
511 It is necessary at least when t == time_t. */
512 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
513 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
514 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
517 #define UINT16_MAX 65535
521 #define UINT32_MAX (4294967295U)
525 #define UINT64_MAX ((uint64_t)-1)
533 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
536 #ifdef HAVE_STDBOOL_H
540 #if !defined(HAVE_BOOL)
548 #if !defined(HAVE_INTPTR_T)
549 typedef long long intptr_t ;
552 #if !defined(HAVE_UINTPTR_T)
553 typedef unsigned long long uintptr_t ;
556 #if !defined(HAVE_PTRDIFF_T)
557 typedef unsigned long long ptrdiff_t ;
561 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
563 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
564 * Tru64 needs _BOOL_EXISTS
565 * AIX needs _BOOL,_TRUE,_FALSE
577 #ifndef __bool_true_false_are_defined
578 #define __bool_true_false_are_defined
595 #ifndef HAVE_FUNCTION_MACRO
596 #ifdef HAVE_func_MACRO
597 #define __FUNCTION__ __func__
599 #define __FUNCTION__ ("")
605 #define MIN(a,b) ((a)<(b)?(a):(b))
609 #define MAX(a,b) ((a)>(b)?(a):(b))
612 #if !defined(HAVE_VOLATILE)
617 this is a warning hack. The idea is to use this everywhere that we
618 get the "discarding const" warning from gcc. That doesn't actually
619 fix the problem of course, but it means that when we do get to
620 cleaning them up we can do it by searching the code for
623 It also means that other error types aren't as swamped by the noise
624 of hundreds of const warnings, so we are more likely to notice when
627 Please only add more uses of this macro when you find it
628 _really_ hard to fix const warnings. Our aim is to eventually use
629 this function in only a very few places.
631 Also, please call this via the discard_const_p() macro interface, as that
632 makes the return type safe.
634 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
636 /** Type-safe version of discard_const */
637 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
640 #define __STRING(x) #x
643 #ifndef __STRINGSTRING
644 #define __STRINGSTRING(x) __STRING(x)
648 #define __LINESTR__ __STRINGSTRING(__LINE__)
652 #define __location__ __FILE__ ":" __LINESTR__
658 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
661 * zero a structure given a pointer to the structure
663 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
666 * zero a structure given a pointer to the structure - no zero check
668 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
670 /* zero an array - note that sizeof(array) must work - ie. it must not be a
672 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
675 * work out how many elements there are in a static array
677 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
680 * pointer difference macro
682 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
689 #define QSORT_CAST (__compar_fn_t)
693 #define QSORT_CAST (int (*)(const void *, const void *))
697 #define PATH_MAX 1024
700 #ifndef MAX_DNS_NAME_LENGTH
701 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
705 char *ufc_crypt(const char *key
, const char *salt
);
706 #define crypt ufc_crypt
713 /* these macros gain us a few percent of speed on gcc */
715 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
716 as its first argument */
718 #define likely(x) __builtin_expect(!!(x), 1)
721 #define unlikely(x) __builtin_expect(!!(x), 0)
725 #define likely(x) (x)
728 #define unlikely(x) (x)
732 #ifndef HAVE_FDATASYNC
733 #define fdatasync(fd) fsync(fd)
736 #endif /* _LIBREPLACE_REPLACE_H */