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
9 ** NOTE! The following LGPL license applies to the replace
10 ** library. This does NOT imply that all of Samba is released
13 This library is free software; you can redistribute it and/or
14 modify it under the terms of the GNU Lesser General Public
15 License as published by the Free Software Foundation; either
16 version 3 of the License, or (at your option) any later version.
18 This library is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
23 You should have received a copy of the GNU Lesser General Public
24 License along with this library; if not, see <http://www.gnu.org/licenses/>.
27 #ifndef _LIBREPLACE_REPLACE_H
28 #define _LIBREPLACE_REPLACE_H
34 #ifdef HAVE_STANDARDS_H
35 #include <standards.h>
43 #if defined(_MSC_VER) || defined(__MINGW32__)
44 #include "win32_replace.h"
48 #define QSORT_CAST (__compar_fn_t)
52 #define QSORT_CAST (int (*)(const void *, const void *))
57 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
58 which causes a warning storm on irix */
59 #undef HAVE_INTTYPES_H
72 #ifdef HAVE_SYS_TYPES_H
73 #include <sys/types.h>
82 this is a warning hack. The idea is to use this everywhere that we
83 get the "discarding const" warning from gcc. That doesn't actually
84 fix the problem of course, but it means that when we do get to
85 cleaning them up we can do it by searching the code for
88 It also means that other error types aren't as swamped by the noise
89 of hundreds of const warnings, so we are more likely to notice when
92 Please only add more uses of this macro when you find it
93 _really_ hard to fix const warnings. Our aim is to eventually use
94 this function in only a very few places.
96 Also, please call this via the discard_const_p() macro interface, as that
97 makes the return type safe.
99 #define discard_const(ptr) ((void *)((intptr_t)(ptr)))
101 /** Type-safe version of discard_const */
102 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
104 #ifndef HAVE_STRERROR
105 extern char *sys_errlist[];
106 #define strerror(i) sys_errlist[i]
109 #ifndef HAVE_ERRNO_DECL
114 #define strdup rep_strdup
115 char *rep_strdup(const char *s);
119 #define memmove rep_memmove
120 void *rep_memmove(void *dest,const void *src,int size);
123 #if !defined(HAVE_MKTIME) || !defined(HAVE_TIMEGM)
124 #include "system/time.h"
128 #define mktime rep_mktime
129 time_t rep_mktime(struct tm *t);
134 #define timegm rep_timegm
135 time_t rep_timegm(struct tm *tm);
139 #define strlcpy rep_strlcpy
140 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
144 #define strlcat rep_strlcat
145 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
148 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
150 #define strndup rep_strndup
151 char *rep_strndup(const char *s, size_t n);
154 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
156 #define strnlen rep_strnlen
157 size_t rep_strnlen(const char *s, size_t n);
161 #define setenv rep_setenv
162 int rep_setenv(const char *name, const char *value, int overwrite);
164 #ifndef HAVE_SETENV_DECL
165 int setenv(const char *name, const char *value, int overwrite);
169 #ifndef HAVE_UNSETENV
170 #define unsetenv rep_unsetenv
171 int rep_unsetenv(const char *name);
175 #define seteuid rep_seteuid
176 int rep_seteuid(uid_t);
180 #define setegid rep_setegid
181 int rep_setegid(gid_t);
184 #ifndef HAVE_SETLINEBUF
185 #define setlinebuf rep_setlinebuf
186 void rep_setlinebuf(FILE *);
189 #ifndef HAVE_STRCASESTR
190 #define strcasestr rep_strcasestr
191 char *rep_strcasestr(const char *haystack, const char *needle);
194 #ifndef HAVE_STRTOK_R
195 #define strtok_r rep_strtok_r
196 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
200 #define strtoll rep_strtoll
201 long long int rep_strtoll(const char *str, char **endptr, int base);
204 #ifndef HAVE_STRTOULL
205 #define strtoull rep_strtoull
206 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
209 #ifndef HAVE_FTRUNCATE
210 #define ftruncate rep_ftruncate
211 int rep_ftruncate(int,off_t);
214 #ifndef HAVE_INITGROUPS
215 #define initgroups rep_initgroups
216 int rep_initgroups(char *name, gid_t id);
219 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
220 #define bzero(a,b) memset((a),'\0',(b))
224 #define dlerror rep_dlerror
225 char *rep_dlerror(void);
229 #define dlopen rep_dlopen
230 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
231 void *rep_dlopen(const char *name, unsigned int flags);
233 void *rep_dlopen(const char *name, int flags);
238 #define dlsym rep_dlsym
239 void *rep_dlsym(void *handle, const char *symbol);
243 #define dlclose rep_dlclose
244 int rep_dlclose(void *handle);
247 #ifndef HAVE_SOCKETPAIR
248 #define socketpair rep_socketpair
249 int rep_socketpair(int d, int type, int protocol, int sv[2]);
252 #ifndef PRINTF_ATTRIBUTE
253 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
254 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
255 * the parameter containing the format, and a2 the index of the first
256 * argument. Note that some gcc 2.x versions don't handle this
258 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
260 #define PRINTF_ATTRIBUTE(a1, a2)
265 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
266 #define _DEPRECATED_ __attribute__ ((deprecated))
272 #ifndef HAVE_VASPRINTF
273 #define vasprintf rep_vasprintf
274 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
277 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
278 #define snprintf rep_snprintf
279 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
282 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
283 #define vsnprintf rep_vsnprintf
284 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
287 #ifndef HAVE_ASPRINTF
288 #define asprintf rep_asprintf
289 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
294 #define vsyslog rep_vsyslog
295 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
299 /* we used to use these fns, but now we have good replacements
300 for snprintf and vsnprintf */
301 #define slprintf snprintf
306 #ifdef HAVE___VA_COPY
307 #define va_copy(dest, src) __va_copy(dest, src)
309 #define va_copy(dest, src) (dest) = (src)
313 #ifndef HAVE_VOLATILE
317 #ifndef HAVE_COMPARISON_FN_T
318 typedef int (*comparison_fn_t)(const void *, const void *);
321 #ifdef REPLACE_STRPTIME
322 #define strptime rep_strptime
324 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
327 /* Load header file for dynamic linking stuff */
339 #define RTLD_GLOBAL 0
342 #ifndef HAVE_SECURE_MKSTEMP
343 #define mkstemp(path) rep_mkstemp(path)
344 int rep_mkstemp(char *temp);
348 #define mkdtemp rep_mkdtemp
349 char *rep_mkdtemp(char *template);
353 #define pread rep_pread
354 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
358 #define pwrite rep_pwrite
359 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
366 /* The extra casts work around common compiler bugs. */
367 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
368 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
369 It is necessary at least when t == time_t. */
370 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
371 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
372 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
374 #ifndef HOST_NAME_MAX
375 #define HOST_NAME_MAX 64
379 * Some older systems seem not to have MAXHOSTNAMELEN
382 #ifndef MAXHOSTNAMELEN
383 #define MAXHOSTNAMELEN HOST_NAME_MAX
387 #define UINT16_MAX 65535
391 #define UINT32_MAX (4294967295U)
395 #define UINT64_MAX ((uint64_t)-1)
403 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
406 #ifdef HAVE_STDBOOL_H
410 #if !defined(HAVE_BOOL)
419 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
421 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
422 * Tru64 needs _BOOL_EXISTS
423 * AIX needs _BOOL,_TRUE,_FALSE
435 #ifndef __bool_true_false_are_defined
436 #define __bool_true_false_are_defined
453 #ifndef HAVE_FUNCTION_MACRO
454 #ifdef HAVE_func_MACRO
455 #define __FUNCTION__ __func__
457 #define __FUNCTION__ ("")
461 #ifdef HAVE_SYS_PARAM_H
462 #include <sys/param.h>
466 #define MIN(a,b) ((a)<(b)?(a):(b))
470 #define MAX(a,b) ((a)>(b)?(a):(b))
474 #define __STRING(x) #x
477 #ifndef __STRINGSTRING
478 #define __STRINGSTRING(x) __STRING(x)
482 #define __LINESTR__ __STRINGSTRING(__LINE__)
486 #define __location__ __FILE__ ":" __LINESTR__
492 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
495 * zero a structure given a pointer to the structure
497 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
500 * zero a structure given a pointer to the structure - no zero check
502 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
504 /* zero an array - note that sizeof(array) must work - ie. it must not be a
506 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
509 * work out how many elements there are in a static array
511 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
514 * pointer difference macro
516 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
522 #endif /* _LIBREPLACE_REPLACE_H */