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
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);
219 #define chown rep_chown
220 int rep_chown(const char *path, uid_t uid, gid_t gid);
224 #define link rep_link
225 int rep_link(const char *oldpath, const char *newpath);
228 #ifndef HAVE_READLINK
229 #define readlink rep_readlink
230 int rep_readlink(const char *path, char *buf, size_t bufsize);
234 #define symlink rep_symlink
235 int rep_symlink(const char *oldpath, const char *newpath);
239 #ifndef HAVE_SETLINEBUF
240 #define setlinebuf rep_setlinebuf
241 void rep_setlinebuf(FILE *);
244 #ifndef HAVE_STRCASESTR
245 #define strcasestr rep_strcasestr
246 char *rep_strcasestr(const char *haystack, const char *needle);
249 #ifndef HAVE_STRTOK_R
250 #define strtok_r rep_strtok_r
251 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
255 #define strtoll rep_strtoll
256 long long int rep_strtoll(const char *str, char **endptr, int base);
259 #ifndef HAVE_STRTOULL
260 #define strtoull rep_strtoull
261 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
264 #ifndef HAVE_FTRUNCATE
265 #define ftruncate rep_ftruncate
266 int rep_ftruncate(int,off_t);
269 #ifndef HAVE_INITGROUPS
270 #define initgroups rep_initgroups
271 int rep_initgroups(char *name, gid_t id);
274 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
275 #define bzero(a,b) memset((a),'\0',(b))
279 #define dlerror rep_dlerror
280 char *rep_dlerror(void);
284 #define dlopen rep_dlopen
285 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
286 void *rep_dlopen(const char *name, unsigned int flags);
288 void *rep_dlopen(const char *name, int flags);
293 #define dlsym rep_dlsym
294 void *rep_dlsym(void *handle, const char *symbol);
298 #define dlclose rep_dlclose
299 int rep_dlclose(void *handle);
302 #ifndef HAVE_SOCKETPAIR
303 #define socketpair rep_socketpair
304 /* prototype is in system/network.h */
307 #ifndef PRINTF_ATTRIBUTE
308 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
309 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
310 * the parameter containing the format, and a2 the index of the first
311 * argument. Note that some gcc 2.x versions don't handle this
313 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
315 #define PRINTF_ATTRIBUTE(a1, a2)
320 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
321 #define _DEPRECATED_ __attribute__ ((deprecated))
327 #ifndef HAVE_VASPRINTF
328 #define vasprintf rep_vasprintf
329 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
332 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
333 #define snprintf rep_snprintf
334 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
337 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
338 #define vsnprintf rep_vsnprintf
339 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
342 #ifndef HAVE_ASPRINTF
343 #define asprintf rep_asprintf
344 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
349 #define vsyslog rep_vsyslog
350 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
354 /* we used to use these fns, but now we have good replacements
355 for snprintf and vsnprintf */
356 #define slprintf snprintf
361 #ifdef HAVE___VA_COPY
362 #define va_copy(dest, src) __va_copy(dest, src)
364 #define va_copy(dest, src) (dest) = (src)
368 #ifndef HAVE_VOLATILE
372 #ifndef HAVE_COMPARISON_FN_T
373 typedef int (*comparison_fn_t)(const void *, const void *);
376 #ifdef REPLACE_STRPTIME
377 #define strptime rep_strptime
379 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
382 /* Load header file for dynamic linking stuff */
394 #define RTLD_GLOBAL 0
397 #ifndef HAVE_SECURE_MKSTEMP
398 #define mkstemp(path) rep_mkstemp(path)
399 int rep_mkstemp(char *temp);
403 #define mkdtemp rep_mkdtemp
404 char *rep_mkdtemp(char *template);
408 #define pread rep_pread
409 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
413 #define pwrite rep_pwrite
414 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
417 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
418 #define inet_ntoa rep_inet_ntoa
419 /* prototype is in "system/network.h" */
422 #ifndef HAVE_INET_PTON
423 #define inet_pton rep_inet_pton
424 /* prototype is in "system/network.h" */
427 #ifndef HAVE_INET_NTOP
428 #define inet_ntop rep_inet_ntop
429 /* prototype is in "system/network.h" */
432 #ifndef HAVE_INET_ATON
433 #define inet_aton rep_inet_aton
434 /* prototype is in "system/network.h" */
438 #define connect rep_connect
439 /* prototype is in "system/network.h" */
442 #ifndef HAVE_GETHOSTBYNAME
443 #define gethostbyname rep_gethostbyname
444 /* prototype is in "system/network.h" */
447 #ifndef HAVE_GETIFADDRS
448 #define getifaddrs rep_getifaddrs
449 /* prototype is in "system/network.h" */
452 #ifndef HAVE_FREEIFADDRS
453 #define freeifaddrs rep_freeifaddrs
454 /* prototype is in "system/network.h" */
461 #ifdef HAVE_SYS_PARAM_H
462 #include <sys/param.h>
465 /* The extra casts work around common compiler bugs. */
466 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
467 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
468 It is necessary at least when t == time_t. */
469 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
470 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
471 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
473 #ifndef HOST_NAME_MAX
474 #define HOST_NAME_MAX 255
478 * Some older systems seem not to have MAXHOSTNAMELEN
481 #ifndef MAXHOSTNAMELEN
482 #define MAXHOSTNAMELEN HOST_NAME_MAX
486 #define UINT16_MAX 65535
490 #define UINT32_MAX (4294967295U)
494 #define UINT64_MAX ((uint64_t)-1)
502 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
505 #ifdef HAVE_STDBOOL_H
509 #if !defined(HAVE_BOOL)
518 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
520 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
521 * Tru64 needs _BOOL_EXISTS
522 * AIX needs _BOOL,_TRUE,_FALSE
534 #ifndef __bool_true_false_are_defined
535 #define __bool_true_false_are_defined
552 #ifndef HAVE_FUNCTION_MACRO
553 #ifdef HAVE_func_MACRO
554 #define __FUNCTION__ __func__
556 #define __FUNCTION__ ("")
562 #define MIN(a,b) ((a)<(b)?(a):(b))
566 #define MAX(a,b) ((a)>(b)?(a):(b))
569 #if !defined(HAVE_VOLATILE)
574 this is a warning hack. The idea is to use this everywhere that we
575 get the "discarding const" warning from gcc. That doesn't actually
576 fix the problem of course, but it means that when we do get to
577 cleaning them up we can do it by searching the code for
580 It also means that other error types aren't as swamped by the noise
581 of hundreds of const warnings, so we are more likely to notice when
584 Please only add more uses of this macro when you find it
585 _really_ hard to fix const warnings. Our aim is to eventually use
586 this function in only a very few places.
588 Also, please call this via the discard_const_p() macro interface, as that
589 makes the return type safe.
591 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
593 /** Type-safe version of discard_const */
594 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
597 #define __STRING(x) #x
600 #ifndef __STRINGSTRING
601 #define __STRINGSTRING(x) __STRING(x)
605 #define __LINESTR__ __STRINGSTRING(__LINE__)
609 #define __location__ __FILE__ ":" __LINESTR__
615 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
618 * zero a structure given a pointer to the structure
620 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
623 * zero a structure given a pointer to the structure - no zero check
625 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
627 /* zero an array - note that sizeof(array) must work - ie. it must not be a
629 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
632 * work out how many elements there are in a static array
634 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
637 * pointer difference macro
639 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
646 #define QSORT_CAST (__compar_fn_t)
650 #define QSORT_CAST (int (*)(const void *, const void *))
654 #define PATH_MAX 1024
657 #ifndef MAX_DNS_NAME_LENGTH
658 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
662 char *ufc_crypt(const char *key, const char *salt);
663 #define crypt ufc_crypt
670 #endif /* _LIBREPLACE_REPLACE_H */