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 mktime rep_mktime
145 /* prototype is in "system/time.h" */
149 #define timegm rep_timegm
150 /* prototype is in "system/time.h" */
154 #define utime rep_utime
155 /* prototype is in "system/time.h" */
159 #define utimes rep_utimes
160 /* prototype is in "system/time.h" */
164 #define strlcpy rep_strlcpy
165 size_t rep_strlcpy(char *d
, const char *s
, size_t bufsize
);
169 #define strlcat rep_strlcat
170 size_t rep_strlcat(char *d
, const char *s
, size_t bufsize
);
173 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
175 #define strndup rep_strndup
176 char *rep_strndup(const char *s
, size_t n
);
179 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
181 #define strnlen rep_strnlen
182 size_t rep_strnlen(const char *s
, size_t n
);
185 #if !HAVE_DECL_ENVIRON
187 #include <crt_externs.h>
188 #define environ (*_NSGetEnviron())
190 extern char **environ
;
195 #define setenv rep_setenv
196 int rep_setenv(const char *name
, const char *value
, int overwrite
);
198 #ifndef HAVE_SETENV_DECL
199 int setenv(const char *name
, const char *value
, int overwrite
);
203 #ifndef HAVE_UNSETENV
204 #define unsetenv rep_unsetenv
205 int rep_unsetenv(const char *name
);
209 #define seteuid rep_seteuid
210 int rep_seteuid(uid_t
);
214 #define setegid rep_setegid
215 int rep_setegid(gid_t
);
218 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
220 int setresuid(uid_t ruid
, uid_t euid
, uid_t suid
);
222 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
223 int setresgid(gid_t rgid
, gid_t egid
, gid_t sgid
);
227 #define chown rep_chown
228 int rep_chown(const char *path
, uid_t uid
, gid_t gid
);
232 #define chroot rep_chroot
233 int rep_chroot(const char *dirname
);
237 #define link rep_link
238 int rep_link(const char *oldpath
, const char *newpath
);
241 #ifndef HAVE_READLINK
242 #define readlink rep_readlink
243 ssize_t
rep_readlink(const char *path
, char *buf
, size_t bufsize
);
247 #define symlink rep_symlink
248 int rep_symlink(const char *oldpath
, const char *newpath
);
251 #ifndef HAVE_REALPATH
252 #define realpath rep_realpath
253 char *rep_realpath(const char *path
, char *resolved_path
);
257 #define lchown rep_lchown
258 int rep_lchown(const char *fname
,uid_t uid
,gid_t gid
);
261 #ifndef HAVE_SETLINEBUF
262 #define setlinebuf rep_setlinebuf
263 void rep_setlinebuf(FILE *);
266 #ifndef HAVE_STRCASESTR
267 #define strcasestr rep_strcasestr
268 char *rep_strcasestr(const char *haystack
, const char *needle
);
271 #ifndef HAVE_STRTOK_R
272 #define strtok_r rep_strtok_r
273 char *rep_strtok_r(char *s
, const char *delim
, char **save_ptr
);
277 #define strtoll rep_strtoll
278 long long int rep_strtoll(const char *str
, char **endptr
, int base
);
281 #ifndef HAVE_STRTOULL
282 #define strtoull rep_strtoull
283 unsigned long long int rep_strtoull(const char *str
, char **endptr
, int base
);
286 #ifndef HAVE_FTRUNCATE
287 #define ftruncate rep_ftruncate
288 int rep_ftruncate(int,off_t
);
291 #ifndef HAVE_INITGROUPS
292 #define initgroups rep_initgroups
293 int rep_initgroups(char *name
, gid_t id
);
296 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
297 #define bzero(a,b) memset((a),'\0',(b))
301 #define dlerror rep_dlerror
302 char *rep_dlerror(void);
306 #define dlopen rep_dlopen
307 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
308 void *rep_dlopen(const char *name
, unsigned int flags
);
310 void *rep_dlopen(const char *name
, int flags
);
315 #define dlsym rep_dlsym
316 void *rep_dlsym(void *handle
, const char *symbol
);
320 #define dlclose rep_dlclose
321 int rep_dlclose(void *handle
);
324 #ifndef HAVE_SOCKETPAIR
325 #define socketpair rep_socketpair
326 /* prototype is in system/network.h */
329 #ifndef PRINTF_ATTRIBUTE
330 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
331 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
332 * the parameter containing the format, and a2 the index of the first
333 * argument. Note that some gcc 2.x versions don't handle this
335 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
337 #define PRINTF_ATTRIBUTE(a1, a2)
342 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
343 #define _DEPRECATED_ __attribute__ ((deprecated))
349 #ifndef HAVE_VASPRINTF
350 #define vasprintf rep_vasprintf
351 int rep_vasprintf(char **ptr
, const char *format
, va_list ap
) PRINTF_ATTRIBUTE(2,0);
354 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
355 #define snprintf rep_snprintf
356 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
359 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
360 #define vsnprintf rep_vsnprintf
361 int rep_vsnprintf(char *,size_t ,const char *, va_list ap
) PRINTF_ATTRIBUTE(3,0);
364 #ifndef HAVE_ASPRINTF
365 #define asprintf rep_asprintf
366 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
371 #define vsyslog rep_vsyslog
372 void rep_vsyslog (int facility_priority
, const char *format
, va_list arglist
) PRINTF_ATTRIBUTE(2,0);
376 /* we used to use these fns, but now we have good replacements
377 for snprintf and vsnprintf */
378 #define slprintf snprintf
383 #ifdef HAVE___VA_COPY
384 #define va_copy(dest, src) __va_copy(dest, src)
386 #define va_copy(dest, src) (dest) = (src)
390 #ifndef HAVE_VOLATILE
394 #ifndef HAVE_COMPARISON_FN_T
395 typedef int (*comparison_fn_t
)(const void *, const void *);
398 #ifdef REPLACE_STRPTIME
399 #define strptime rep_strptime
401 char *rep_strptime(const char *buf
, const char *format
, struct tm
*tm
);
405 #define dup2 rep_dup2
406 int rep_dup2(int oldfd
, int newfd
);
409 /* Load header file for dynamic linking stuff */
421 #define RTLD_GLOBAL 0
424 #ifndef HAVE_SECURE_MKSTEMP
425 #define mkstemp(path) rep_mkstemp(path)
426 int rep_mkstemp(char *temp
);
430 #define mkdtemp rep_mkdtemp
431 char *rep_mkdtemp(char *template);
435 #define pread rep_pread
436 ssize_t
rep_pread(int __fd
, void *__buf
, size_t __nbytes
, off_t __offset
);
437 #define LIBREPLACE_PREAD_REPLACED 1
439 #define LIBREPLACE_PREAD_NOT_REPLACED 1
443 #define pwrite rep_pwrite
444 ssize_t
rep_pwrite(int __fd
, const void *__buf
, size_t __nbytes
, off_t __offset
);
445 #define LIBREPLACE_PWRITE_REPLACED 1
447 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
450 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
451 #define inet_ntoa rep_inet_ntoa
452 /* prototype is in "system/network.h" */
455 #ifndef HAVE_INET_PTON
456 #define inet_pton rep_inet_pton
457 /* prototype is in "system/network.h" */
460 #ifndef HAVE_INET_NTOP
461 #define inet_ntop rep_inet_ntop
462 /* prototype is in "system/network.h" */
465 #ifndef HAVE_INET_ATON
466 #define inet_aton rep_inet_aton
467 /* prototype is in "system/network.h" */
471 #define connect rep_connect
472 /* prototype is in "system/network.h" */
475 #ifndef HAVE_GETHOSTBYNAME
476 #define gethostbyname rep_gethostbyname
477 /* prototype is in "system/network.h" */
480 #ifndef HAVE_GETIFADDRS
481 #define getifaddrs rep_getifaddrs
482 /* prototype is in "system/network.h" */
485 #ifndef HAVE_FREEIFADDRS
486 #define freeifaddrs rep_freeifaddrs
487 /* prototype is in "system/network.h" */
494 #ifdef HAVE_SYS_PARAM_H
495 #include <sys/param.h>
498 /* The extra casts work around common compiler bugs. */
499 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
500 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
501 It is necessary at least when t == time_t. */
502 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
503 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
504 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
507 #define UINT16_MAX 65535
511 #define UINT32_MAX (4294967295U)
515 #define UINT64_MAX ((uint64_t)-1)
523 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
526 #ifdef HAVE_STDBOOL_H
530 #if !defined(HAVE_BOOL)
538 #if !defined(HAVE_INTPTR_T)
539 typedef long long intptr_t ;
542 #if !defined(HAVE_UINTPTR_T)
543 typedef unsigned long long uintptr_t ;
546 #if !defined(HAVE_PTRDIFF_T)
547 typedef unsigned long long ptrdiff_t ;
551 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
553 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
554 * Tru64 needs _BOOL_EXISTS
555 * AIX needs _BOOL,_TRUE,_FALSE
567 #ifndef __bool_true_false_are_defined
568 #define __bool_true_false_are_defined
585 #ifndef HAVE_FUNCTION_MACRO
586 #ifdef HAVE_func_MACRO
587 #define __FUNCTION__ __func__
589 #define __FUNCTION__ ("")
595 #define MIN(a,b) ((a)<(b)?(a):(b))
599 #define MAX(a,b) ((a)>(b)?(a):(b))
602 #if !defined(HAVE_VOLATILE)
607 this is a warning hack. The idea is to use this everywhere that we
608 get the "discarding const" warning from gcc. That doesn't actually
609 fix the problem of course, but it means that when we do get to
610 cleaning them up we can do it by searching the code for
613 It also means that other error types aren't as swamped by the noise
614 of hundreds of const warnings, so we are more likely to notice when
617 Please only add more uses of this macro when you find it
618 _really_ hard to fix const warnings. Our aim is to eventually use
619 this function in only a very few places.
621 Also, please call this via the discard_const_p() macro interface, as that
622 makes the return type safe.
624 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
626 /** Type-safe version of discard_const */
627 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
630 #define __STRING(x) #x
633 #ifndef __STRINGSTRING
634 #define __STRINGSTRING(x) __STRING(x)
638 #define __LINESTR__ __STRINGSTRING(__LINE__)
642 #define __location__ __FILE__ ":" __LINESTR__
648 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
651 * zero a structure given a pointer to the structure
653 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
656 * zero a structure given a pointer to the structure - no zero check
658 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
660 /* zero an array - note that sizeof(array) must work - ie. it must not be a
662 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
665 * work out how many elements there are in a static array
667 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
670 * pointer difference macro
672 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
679 #define QSORT_CAST (__compar_fn_t)
683 #define QSORT_CAST (int (*)(const void *, const void *))
687 #define PATH_MAX 1024
690 #ifndef MAX_DNS_NAME_LENGTH
691 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
695 char *ufc_crypt(const char *key
, const char *salt
);
696 #define crypt ufc_crypt
703 #endif /* _LIBREPLACE_REPLACE_H */