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
36 #if (__GLIBC__ > 2) || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)
37 # include <bits/types.h>
39 # define __FD_SETSIZE 16384
42 #ifdef HAVE_STANDARDS_H
43 #include <standards.h>
51 #if defined(_MSC_VER) || defined(__MINGW32__)
52 #include "win32_replace.h"
58 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
59 which causes a warning storm on irix */
60 #undef HAVE_INTTYPES_H
62 #define __STDC_FORMAT_MACROS
66 #ifndef __PRI64_PREFIX
68 # define __PRI64_PREFIX "l"
70 # define __PRI64_PREFIX "ll"
74 /* Decimal notation. */
85 # define PRId64 __PRI64_PREFIX "d"
98 # define PRIi64 __PRI64_PREFIX "i"
111 # define PRIu64 __PRI64_PREFIX "u"
118 #ifdef HAVE_STRINGS_H
122 #ifdef HAVE_SYS_TYPES_H
123 #include <sys/types.h>
131 #ifndef HAVE_STRERROR
132 extern char *sys_errlist[];
133 #define strerror(i) sys_errlist[i]
136 #ifndef HAVE_ERRNO_DECL
141 #define strdup rep_strdup
142 char *rep_strdup(const char *s);
146 #define memmove rep_memmove
147 void *rep_memmove(void *dest,const void *src,int size);
151 #define mktime rep_mktime
152 /* prototype is in "system/time.h" */
156 #define timegm rep_timegm
157 /* prototype is in "system/time.h" */
161 #define utime rep_utime
162 /* prototype is in "system/time.h" */
166 #define utimes rep_utimes
167 /* prototype is in "system/time.h" */
171 #define strlcpy rep_strlcpy
172 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
176 #define strlcat rep_strlcat
177 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
180 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
182 #define strndup rep_strndup
183 char *rep_strndup(const char *s, size_t n);
186 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
188 #define strnlen rep_strnlen
189 size_t rep_strnlen(const char *s, size_t n);
192 #if !HAVE_DECL_ENVIRON
194 #include <crt_externs.h>
195 #define environ (*_NSGetEnviron())
197 extern char **environ;
202 #define setenv rep_setenv
203 int rep_setenv(const char *name, const char *value, int overwrite);
205 #ifndef HAVE_SETENV_DECL
206 int setenv(const char *name, const char *value, int overwrite);
210 #ifndef HAVE_UNSETENV
211 #define unsetenv rep_unsetenv
212 int rep_unsetenv(const char *name);
216 #define seteuid rep_seteuid
217 int rep_seteuid(uid_t);
221 #define setegid rep_setegid
222 int rep_setegid(gid_t);
225 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
227 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
229 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
230 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
234 #define chown rep_chown
235 int rep_chown(const char *path, uid_t uid, gid_t gid);
239 #define chroot rep_chroot
240 int rep_chroot(const char *dirname);
244 #define link rep_link
245 int rep_link(const char *oldpath, const char *newpath);
248 #ifndef HAVE_READLINK
249 #define readlink rep_readlink
250 ssize_t rep_readlink(const char *path, char *buf, size_t bufsize);
254 #define symlink rep_symlink
255 int rep_symlink(const char *oldpath, const char *newpath);
258 #ifndef HAVE_REALPATH
259 #define realpath rep_realpath
260 char *rep_realpath(const char *path, char *resolved_path);
264 #define lchown rep_lchown
265 int rep_lchown(const char *fname,uid_t uid,gid_t gid);
268 #ifndef HAVE_SETLINEBUF
269 #define setlinebuf rep_setlinebuf
270 void rep_setlinebuf(FILE *);
273 #ifndef HAVE_STRCASESTR
274 #define strcasestr rep_strcasestr
275 char *rep_strcasestr(const char *haystack, const char *needle);
278 #ifndef HAVE_STRTOK_R
279 #define strtok_r rep_strtok_r
280 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
284 #define strtoll rep_strtoll
285 long long int rep_strtoll(const char *str, char **endptr, int base);
288 #ifndef HAVE_STRTOULL
289 #define strtoull rep_strtoull
290 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
293 #ifndef HAVE_FTRUNCATE
294 #define ftruncate rep_ftruncate
295 int rep_ftruncate(int,off_t);
298 #ifndef HAVE_INITGROUPS
299 #define initgroups rep_initgroups
300 int rep_initgroups(char *name, gid_t id);
303 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
304 #define bzero(a,b) memset((a),'\0',(b))
308 #define dlerror rep_dlerror
309 char *rep_dlerror(void);
313 #define dlopen rep_dlopen
314 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
315 void *rep_dlopen(const char *name, unsigned int flags);
317 void *rep_dlopen(const char *name, int flags);
322 #define dlsym rep_dlsym
323 void *rep_dlsym(void *handle, const char *symbol);
327 #define dlclose rep_dlclose
328 int rep_dlclose(void *handle);
331 #ifndef HAVE_SOCKETPAIR
332 #define socketpair rep_socketpair
333 /* prototype is in system/network.h */
336 #ifndef PRINTF_ATTRIBUTE
337 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
338 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
339 * the parameter containing the format, and a2 the index of the first
340 * argument. Note that some gcc 2.x versions don't handle this
342 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
344 #define PRINTF_ATTRIBUTE(a1, a2)
349 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
350 #define _DEPRECATED_ __attribute__ ((deprecated))
356 #ifndef HAVE_VASPRINTF
357 #define vasprintf rep_vasprintf
358 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
361 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
362 #define snprintf rep_snprintf
363 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
366 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
367 #define vsnprintf rep_vsnprintf
368 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
371 #ifndef HAVE_ASPRINTF
372 #define asprintf rep_asprintf
373 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
378 #define vsyslog rep_vsyslog
379 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
383 /* we used to use these fns, but now we have good replacements
384 for snprintf and vsnprintf */
385 #define slprintf snprintf
390 #ifdef HAVE___VA_COPY
391 #define va_copy(dest, src) __va_copy(dest, src)
393 #define va_copy(dest, src) (dest) = (src)
397 #ifndef HAVE_VOLATILE
401 #ifndef HAVE_COMPARISON_FN_T
402 typedef int (*comparison_fn_t)(const void *, const void *);
405 #ifdef REPLACE_STRPTIME
406 #define strptime rep_strptime
408 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
412 #define dup2 rep_dup2
413 int rep_dup2(int oldfd, int newfd);
416 /* Load header file for dynamic linking stuff */
428 #define RTLD_GLOBAL 0
431 #ifndef HAVE_SECURE_MKSTEMP
432 #define mkstemp(path) rep_mkstemp(path)
433 int rep_mkstemp(char *temp);
437 #define mkdtemp rep_mkdtemp
438 char *rep_mkdtemp(char *template);
442 #define pread rep_pread
443 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
444 #define LIBREPLACE_PREAD_REPLACED 1
446 #define LIBREPLACE_PREAD_NOT_REPLACED 1
450 #define pwrite rep_pwrite
451 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
452 #define LIBREPLACE_PWRITE_REPLACED 1
454 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
457 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
458 #define inet_ntoa rep_inet_ntoa
459 /* prototype is in "system/network.h" */
462 #ifndef HAVE_INET_PTON
463 #define inet_pton rep_inet_pton
464 /* prototype is in "system/network.h" */
467 #ifndef HAVE_INET_NTOP
468 #define inet_ntop rep_inet_ntop
469 /* prototype is in "system/network.h" */
472 #ifndef HAVE_INET_ATON
473 #define inet_aton rep_inet_aton
474 /* prototype is in "system/network.h" */
478 #define connect rep_connect
479 /* prototype is in "system/network.h" */
482 #ifndef HAVE_GETHOSTBYNAME
483 #define gethostbyname rep_gethostbyname
484 /* prototype is in "system/network.h" */
487 #ifndef HAVE_GETIFADDRS
488 #define getifaddrs rep_getifaddrs
489 /* prototype is in "system/network.h" */
492 #ifndef HAVE_FREEIFADDRS
493 #define freeifaddrs rep_freeifaddrs
494 /* prototype is in "system/network.h" */
501 #ifdef HAVE_SYS_PARAM_H
502 #include <sys/param.h>
505 /* The extra casts work around common compiler bugs. */
506 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
507 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
508 It is necessary at least when t == time_t. */
509 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
510 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
511 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
514 #define UINT16_MAX 65535
518 #define UINT32_MAX (4294967295U)
522 #define UINT64_MAX ((uint64_t)-1)
530 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
533 #ifdef HAVE_STDBOOL_H
537 #if !defined(HAVE_BOOL)
546 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
548 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
549 * Tru64 needs _BOOL_EXISTS
550 * AIX needs _BOOL,_TRUE,_FALSE
562 #ifndef __bool_true_false_are_defined
563 #define __bool_true_false_are_defined
580 #ifndef HAVE_FUNCTION_MACRO
581 #ifdef HAVE_func_MACRO
582 #define __FUNCTION__ __func__
584 #define __FUNCTION__ ("")
590 #define MIN(a,b) ((a)<(b)?(a):(b))
594 #define MAX(a,b) ((a)>(b)?(a):(b))
597 #if !defined(HAVE_VOLATILE)
602 this is a warning hack. The idea is to use this everywhere that we
603 get the "discarding const" warning from gcc. That doesn't actually
604 fix the problem of course, but it means that when we do get to
605 cleaning them up we can do it by searching the code for
608 It also means that other error types aren't as swamped by the noise
609 of hundreds of const warnings, so we are more likely to notice when
612 Please only add more uses of this macro when you find it
613 _really_ hard to fix const warnings. Our aim is to eventually use
614 this function in only a very few places.
616 Also, please call this via the discard_const_p() macro interface, as that
617 makes the return type safe.
619 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
621 /** Type-safe version of discard_const */
622 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
625 #define __STRING(x) #x
628 #ifndef __STRINGSTRING
629 #define __STRINGSTRING(x) __STRING(x)
633 #define __LINESTR__ __STRINGSTRING(__LINE__)
637 #define __location__ __FILE__ ":" __LINESTR__
643 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
646 * zero a structure given a pointer to the structure
648 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
651 * zero a structure given a pointer to the structure - no zero check
653 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
655 /* zero an array - note that sizeof(array) must work - ie. it must not be a
657 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
660 * work out how many elements there are in a static array
662 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
665 * pointer difference macro
667 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
674 #define QSORT_CAST (__compar_fn_t)
678 #define QSORT_CAST (int (*)(const void *, const void *))
682 #define PATH_MAX 1024
685 #ifndef MAX_DNS_NAME_LENGTH
686 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
690 char *ufc_crypt(const char *key, const char *salt);
691 #define crypt ufc_crypt
698 #endif /* _LIBREPLACE_REPLACE_H */