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
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
66 #ifdef HAVE_SYS_TYPES_H
67 #include <sys/types.h>
76 extern char *sys_errlist[];
77 #define strerror(i) sys_errlist[i]
80 #ifndef HAVE_ERRNO_DECL
85 #define strdup rep_strdup
86 char *rep_strdup(const char *s);
90 #define memmove rep_memmove
91 void *rep_memmove(void *dest,const void *src,int size);
95 #define mktime rep_mktime
96 /* prototype is in "system/time.h" */
100 #define timegm rep_timegm
101 /* prototype is in "system/time.h" */
105 #define strlcpy rep_strlcpy
106 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
110 #define strlcat rep_strlcat
111 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
114 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
116 #define strndup rep_strndup
117 char *rep_strndup(const char *s, size_t n);
120 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
122 #define strnlen rep_strnlen
123 size_t rep_strnlen(const char *s, size_t n);
127 #define setenv rep_setenv
128 int rep_setenv(const char *name, const char *value, int overwrite);
130 #ifndef HAVE_SETENV_DECL
131 int setenv(const char *name, const char *value, int overwrite);
135 #ifndef HAVE_UNSETENV
136 #define unsetenv rep_unsetenv
137 int rep_unsetenv(const char *name);
141 #define seteuid rep_seteuid
142 int rep_seteuid(uid_t);
146 #define setegid rep_setegid
147 int rep_setegid(gid_t);
150 #ifndef HAVE_SETLINEBUF
151 #define setlinebuf rep_setlinebuf
152 void rep_setlinebuf(FILE *);
155 #ifndef HAVE_STRCASESTR
156 #define strcasestr rep_strcasestr
157 char *rep_strcasestr(const char *haystack, const char *needle);
160 #ifndef HAVE_STRTOK_R
161 #define strtok_r rep_strtok_r
162 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
166 #define strtoll rep_strtoll
167 long long int rep_strtoll(const char *str, char **endptr, int base);
170 #ifndef HAVE_STRTOULL
171 #define strtoull rep_strtoull
172 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
175 #ifndef HAVE_FTRUNCATE
176 #define ftruncate rep_ftruncate
177 int rep_ftruncate(int,off_t);
180 #ifndef HAVE_INITGROUPS
181 #define initgroups rep_initgroups
182 int rep_initgroups(char *name, gid_t id);
185 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
186 #define bzero(a,b) memset((a),'\0',(b))
190 #define dlerror rep_dlerror
191 char *rep_dlerror(void);
195 #define dlopen rep_dlopen
196 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
197 void *rep_dlopen(const char *name, unsigned int flags);
199 void *rep_dlopen(const char *name, int flags);
204 #define dlsym rep_dlsym
205 void *rep_dlsym(void *handle, const char *symbol);
209 #define dlclose rep_dlclose
210 int rep_dlclose(void *handle);
213 #ifndef HAVE_SOCKETPAIR
214 #define socketpair rep_socketpair
215 int rep_socketpair(int d, int type, int protocol, int sv[2]);
218 #ifndef PRINTF_ATTRIBUTE
219 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
220 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
221 * the parameter containing the format, and a2 the index of the first
222 * argument. Note that some gcc 2.x versions don't handle this
224 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
226 #define PRINTF_ATTRIBUTE(a1, a2)
231 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
232 #define _DEPRECATED_ __attribute__ ((deprecated))
238 #ifndef HAVE_VASPRINTF
239 #define vasprintf rep_vasprintf
240 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
243 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
244 #define snprintf rep_snprintf
245 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
248 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
249 #define vsnprintf rep_vsnprintf
250 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
253 #ifndef HAVE_ASPRINTF
254 #define asprintf rep_asprintf
255 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
260 #define vsyslog rep_vsyslog
261 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
265 /* we used to use these fns, but now we have good replacements
266 for snprintf and vsnprintf */
267 #define slprintf snprintf
272 #ifdef HAVE___VA_COPY
273 #define va_copy(dest, src) __va_copy(dest, src)
275 #define va_copy(dest, src) (dest) = (src)
279 #ifndef HAVE_VOLATILE
283 #ifndef HAVE_COMPARISON_FN_T
284 typedef int (*comparison_fn_t)(const void *, const void *);
287 #ifdef REPLACE_STRPTIME
288 #define strptime rep_strptime
290 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
293 /* Load header file for dynamic linking stuff */
305 #define RTLD_GLOBAL 0
308 #ifndef HAVE_SECURE_MKSTEMP
309 #define mkstemp(path) rep_mkstemp(path)
310 int rep_mkstemp(char *temp);
314 #define mkdtemp rep_mkdtemp
315 char *rep_mkdtemp(char *template);
319 #define pread rep_pread
320 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
324 #define pwrite rep_pwrite
325 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
328 #ifdef REPLACE_INET_NTOA
329 #define inet_ntoa rep_inet_ntoa
330 /* prototype is in "system/network.h" */
333 #ifndef HAVE_INET_PTON
334 #define inet_pton rep_inet_pton
335 /* prototype is in "system/network.h" */
338 #ifndef HAVE_INET_NTOP
339 #define inet_ntop rep_inet_ntop
340 /* prototype is in "system/network.h" */
343 #ifndef HAVE_GETIFADDRS
344 #define getifaddrs rep_getifaddrs
345 /* prototype is in "system/network.h" */
348 #ifndef HAVE_FREEIFADDRS
349 #define freeifaddrs rep_freeifaddrs
350 /* prototype is in "system/network.h" */
357 #ifdef HAVE_SYS_PARAM_H
358 #include <sys/param.h>
361 /* The extra casts work around common compiler bugs. */
362 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
363 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
364 It is necessary at least when t == time_t. */
365 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
366 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
367 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
369 #ifndef HOST_NAME_MAX
370 #define HOST_NAME_MAX 255
374 * Some older systems seem not to have MAXHOSTNAMELEN
377 #ifndef MAXHOSTNAMELEN
378 #define MAXHOSTNAMELEN HOST_NAME_MAX
382 #define UINT16_MAX 65535
386 #define UINT32_MAX (4294967295U)
390 #define UINT64_MAX ((uint64_t)-1)
398 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
401 #ifdef HAVE_STDBOOL_H
405 #if !defined(HAVE_BOOL)
414 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
416 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
417 * Tru64 needs _BOOL_EXISTS
418 * AIX needs _BOOL,_TRUE,_FALSE
430 #ifndef __bool_true_false_are_defined
431 #define __bool_true_false_are_defined
448 #ifndef HAVE_FUNCTION_MACRO
449 #ifdef HAVE_func_MACRO
450 #define __FUNCTION__ __func__
452 #define __FUNCTION__ ("")
458 #define MIN(a,b) ((a)<(b)?(a):(b))
462 #define MAX(a,b) ((a)>(b)?(a):(b))
465 #if !defined(HAVE_VOLATILE)
470 this is a warning hack. The idea is to use this everywhere that we
471 get the "discarding const" warning from gcc. That doesn't actually
472 fix the problem of course, but it means that when we do get to
473 cleaning them up we can do it by searching the code for
476 It also means that other error types aren't as swamped by the noise
477 of hundreds of const warnings, so we are more likely to notice when
480 Please only add more uses of this macro when you find it
481 _really_ hard to fix const warnings. Our aim is to eventually use
482 this function in only a very few places.
484 Also, please call this via the discard_const_p() macro interface, as that
485 makes the return type safe.
487 #define discard_const(ptr) ((void *)((intptr_t)(ptr)))
489 /** Type-safe version of discard_const */
490 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
493 #define __STRING(x) #x
496 #ifndef __STRINGSTRING
497 #define __STRINGSTRING(x) __STRING(x)
501 #define __LINESTR__ __STRINGSTRING(__LINE__)
505 #define __location__ __FILE__ ":" __LINESTR__
511 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
514 * zero a structure given a pointer to the structure
516 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
519 * zero a structure given a pointer to the structure - no zero check
521 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
523 /* zero an array - note that sizeof(array) must work - ie. it must not be a
525 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
528 * work out how many elements there are in a static array
530 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
533 * pointer difference macro
535 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
542 #define QSORT_CAST (__compar_fn_t)
546 #define QSORT_CAST (int (*)(const void *, const void *))
550 #define PATH_MAX 1024
553 #ifndef MAX_DNS_NAME_LENGTH
554 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
557 #endif /* _LIBREPLACE_REPLACE_H */