lib:replace: Add getprogname()
[Samba.git] / lib / replace / replace.h
blob732a822685824cdeeea95cdaa0c9309a5d1b96a2
1 /*
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
12 ** under the LGPL
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
31 #ifndef NO_CONFIG_H
32 #include "config.h"
33 #endif
35 #ifdef HAVE_STANDARDS_H
36 #include <standards.h>
37 #endif
39 /* Needs to be defined before std*.h and string*.h are included */
40 #define __STDC_WANT_LIB_EXT1__ 1
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <stdarg.h>
45 #include <errno.h>
47 #ifndef HAVE_DECL_EWOULDBLOCK
48 #define EWOULDBLOCK EAGAIN
49 #endif
51 #if defined(_MSC_VER) || defined(__MINGW32__)
52 #include "win32_replace.h"
53 #endif
56 #ifdef HAVE_INTTYPES_H
57 #define __STDC_FORMAT_MACROS
58 #include <inttypes.h>
59 #elif HAVE_STDINT_H
60 #include <stdint.h>
61 /* force off HAVE_INTTYPES_H so that roken doesn't try to include both,
62 which causes a warning storm on irix */
63 #undef HAVE_INTTYPES_H
64 #endif
66 #ifdef HAVE_MALLOC_H
67 #include <malloc.h>
68 #endif
70 #ifndef __PRI64_PREFIX
71 # if __WORDSIZE == 64 && ! defined __APPLE__
72 # define __PRI64_PREFIX "l"
73 # else
74 # define __PRI64_PREFIX "ll"
75 # endif
76 #endif
78 /* Decimal notation. */
79 #ifndef PRId8
80 # define PRId8 "d"
81 #endif
82 #ifndef PRId16
83 # define PRId16 "d"
84 #endif
85 #ifndef PRId32
86 # define PRId32 "d"
87 #endif
88 #ifndef PRId64
89 # define PRId64 __PRI64_PREFIX "d"
90 #endif
92 #ifndef PRIi8
93 # define PRIi8 "i"
94 #endif
95 #ifndef PRIi16
96 # define PRIi16 "i"
97 #endif
98 #ifndef PRIi32
99 # define PRIi32 "i"
100 #endif
101 #ifndef PRIi64
102 # define PRIi64 __PRI64_PREFIX "i"
103 #endif
105 #ifndef PRIu8
106 # define PRIu8 "u"
107 #endif
108 #ifndef PRIu16
109 # define PRIu16 "u"
110 #endif
111 #ifndef PRIu32
112 # define PRIu32 "u"
113 #endif
114 #ifndef PRIu64
115 # define PRIu64 __PRI64_PREFIX "u"
116 #endif
118 #ifndef SCNd8
119 # define SCNd8 "hhd"
120 #endif
121 #ifndef SCNd16
122 # define SCNd16 "hd"
123 #endif
124 #ifndef SCNd32
125 # define SCNd32 "d"
126 #endif
127 #ifndef SCNd64
128 # define SCNd64 __PRI64_PREFIX "d"
129 #endif
131 #ifndef SCNi8
132 # define SCNi8 "hhi"
133 #endif
134 #ifndef SCNi16
135 # define SCNi16 "hi"
136 #endif
137 #ifndef SCNi32
138 # define SCNi32 "i"
139 #endif
140 #ifndef SCNi64
141 # define SCNi64 __PRI64_PREFIX "i"
142 #endif
144 #ifndef SCNu8
145 # define SCNu8 "hhu"
146 #endif
147 #ifndef SCNu16
148 # define SCNu16 "hu"
149 #endif
150 #ifndef SCNu32
151 # define SCNu32 "u"
152 #endif
153 #ifndef SCNu64
154 # define SCNu64 __PRI64_PREFIX "u"
155 #endif
157 #ifdef HAVE_BSD_STRING_H
158 #include <bsd/string.h>
159 #endif
161 #ifdef HAVE_BSD_UNISTD_H
162 #include <bsd/unistd.h>
163 #endif
165 #ifdef HAVE_STRING_H
166 #include <string.h>
167 #endif
169 #ifdef HAVE_STRINGS_H
170 #include <strings.h>
171 #endif
173 #ifdef HAVE_SYS_TYPES_H
174 #include <sys/types.h>
175 #endif
177 #ifdef HAVE_SYS_SYSMACROS_H
178 #include <sys/sysmacros.h>
179 #endif
181 #ifdef HAVE_SETPROCTITLE_H
182 #include <setproctitle.h>
183 #endif
185 #if STDC_HEADERS
186 #include <stdlib.h>
187 #include <stddef.h>
188 #endif
190 #ifdef HAVE_LINUX_TYPES_H
192 * This is needed as some broken header files require this to be included early
194 #include <linux/types.h>
195 #endif
197 #ifndef HAVE_STRERROR
198 extern char *sys_errlist[];
199 #define strerror(i) sys_errlist[i]
200 #endif
202 #ifndef HAVE_ERRNO_DECL
203 extern int errno;
204 #endif
206 #ifndef HAVE_STRDUP
207 #define strdup rep_strdup
208 char *rep_strdup(const char *s);
209 #endif
211 #ifndef HAVE_MEMMOVE
212 #define memmove rep_memmove
213 void *rep_memmove(void *dest,const void *src,int size);
214 #endif
216 #ifndef HAVE_MEMMEM
217 #define memmem rep_memmem
218 void *rep_memmem(const void *haystack, size_t haystacklen,
219 const void *needle, size_t needlelen);
220 #endif
222 #ifndef HAVE_MEMALIGN
223 #define memalign rep_memalign
224 void *rep_memalign(size_t boundary, size_t size);
225 #endif
227 #ifndef HAVE_MKTIME
228 #define mktime rep_mktime
229 /* prototype is in "system/time.h" */
230 #endif
232 #ifndef HAVE_TIMEGM
233 #define timegm rep_timegm
234 /* prototype is in "system/time.h" */
235 #endif
237 #ifndef HAVE_UTIME
238 #define utime rep_utime
239 /* prototype is in "system/time.h" */
240 #endif
242 #ifndef HAVE_UTIMES
243 #define utimes rep_utimes
244 /* prototype is in "system/time.h" */
245 #endif
247 #ifndef HAVE_STRLCPY
248 #define strlcpy rep_strlcpy
249 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
250 #endif
252 #ifndef HAVE_STRLCAT
253 #define strlcat rep_strlcat
254 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
255 #endif
257 #ifndef HAVE_CLOSEFROM
258 #define closefrom rep_closefrom
259 int rep_closefrom(int lower);
260 #endif
263 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
264 #undef HAVE_STRNDUP
265 #define strndup rep_strndup
266 char *rep_strndup(const char *s, size_t n);
267 #endif
269 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
270 #undef HAVE_STRNLEN
271 #define strnlen rep_strnlen
272 size_t rep_strnlen(const char *s, size_t n);
273 #endif
275 #if !HAVE_DECL_ENVIRON
276 #ifdef __APPLE__
277 #include <crt_externs.h>
278 #define environ (*_NSGetEnviron())
279 #else
280 extern char **environ;
281 #endif
282 #endif
284 #ifndef HAVE_SETENV
285 #define setenv rep_setenv
286 int rep_setenv(const char *name, const char *value, int overwrite);
287 #else
288 #ifndef HAVE_SETENV_DECL
289 int setenv(const char *name, const char *value, int overwrite);
290 #endif
291 #endif
293 #ifndef HAVE_UNSETENV
294 #define unsetenv rep_unsetenv
295 int rep_unsetenv(const char *name);
296 #endif
298 #ifndef HAVE_SETEUID
299 #define seteuid rep_seteuid
300 int rep_seteuid(uid_t);
301 #endif
303 #ifndef HAVE_SETEGID
304 #define setegid rep_setegid
305 int rep_setegid(gid_t);
306 #endif
308 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
309 /* stupid glibc */
310 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
311 #endif
312 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
313 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
314 #endif
316 #ifndef HAVE_CHOWN
317 #define chown rep_chown
318 int rep_chown(const char *path, uid_t uid, gid_t gid);
319 #endif
321 #ifndef HAVE_CHROOT
322 #define chroot rep_chroot
323 int rep_chroot(const char *dirname);
324 #endif
326 #ifndef HAVE_LINK
327 #define link rep_link
328 int rep_link(const char *oldpath, const char *newpath);
329 #endif
331 #ifndef HAVE_READLINK
332 #define readlink rep_readlink
333 ssize_t rep_readlink(const char *path, char *buf, size_t bufsize);
334 #endif
336 #ifndef HAVE_SYMLINK
337 #define symlink rep_symlink
338 int rep_symlink(const char *oldpath, const char *newpath);
339 #endif
341 #ifndef HAVE_REALPATH
342 #define realpath rep_realpath
343 char *rep_realpath(const char *path, char *resolved_path);
344 #endif
346 #ifndef HAVE_LCHOWN
347 #define lchown rep_lchown
348 int rep_lchown(const char *fname,uid_t uid,gid_t gid);
349 #endif
351 #ifdef HAVE_UNIX_H
352 #include <unix.h>
353 #endif
355 #ifndef HAVE_SETLINEBUF
356 #define setlinebuf rep_setlinebuf
357 void rep_setlinebuf(FILE *);
358 #endif
360 #ifndef HAVE_STRCASESTR
361 #define strcasestr rep_strcasestr
362 char *rep_strcasestr(const char *haystack, const char *needle);
363 #endif
365 #ifndef HAVE_STRSEP
366 #define strsep rep_strsep
367 char *rep_strsep(char **pps, const char *delim);
368 #endif
370 #ifndef HAVE_STRTOK_R
371 #define strtok_r rep_strtok_r
372 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
373 #endif
377 #ifndef HAVE_STRTOLL
378 #define strtoll rep_strtoll
379 long long int rep_strtoll(const char *str, char **endptr, int base);
380 #else
381 #ifdef HAVE_BSD_STRTOLL
382 #define strtoll rep_strtoll
383 long long int rep_strtoll(const char *str, char **endptr, int base);
384 #endif
385 #endif
387 #ifndef HAVE_STRTOULL
388 #define strtoull rep_strtoull
389 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
390 #else
391 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
392 #define strtoull rep_strtoull
393 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
394 #endif
395 #endif
397 #ifndef HAVE_FTRUNCATE
398 #define ftruncate rep_ftruncate
399 int rep_ftruncate(int,off_t);
400 #endif
402 #ifndef HAVE_INITGROUPS
403 #define initgroups rep_initgroups
404 int rep_initgroups(char *name, gid_t id);
405 #endif
407 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
408 #define bzero(a,b) memset((a),'\0',(b))
409 #endif
411 #ifndef HAVE_DLERROR
412 #define dlerror rep_dlerror
413 char *rep_dlerror(void);
414 #endif
416 #ifndef HAVE_DLOPEN
417 #define dlopen rep_dlopen
418 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
419 void *rep_dlopen(const char *name, unsigned int flags);
420 #else
421 void *rep_dlopen(const char *name, int flags);
422 #endif
423 #endif
425 #ifndef HAVE_DLSYM
426 #define dlsym rep_dlsym
427 void *rep_dlsym(void *handle, const char *symbol);
428 #endif
430 #ifndef HAVE_DLCLOSE
431 #define dlclose rep_dlclose
432 int rep_dlclose(void *handle);
433 #endif
435 #ifndef HAVE_SOCKETPAIR
436 #define socketpair rep_socketpair
437 /* prototype is in system/network.h */
438 #endif
440 #ifndef PRINTF_ATTRIBUTE
441 #ifdef HAVE___ATTRIBUTE__
442 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
443 * the parameter containing the format, and a2 the index of the first
444 * argument. Note that some gcc 2.x versions don't handle this
445 * properly **/
446 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
447 #else
448 #define PRINTF_ATTRIBUTE(a1, a2)
449 #endif
450 #endif
452 #ifndef _DEPRECATED_
453 #ifdef HAVE___ATTRIBUTE__
454 #define _DEPRECATED_ __attribute__ ((deprecated))
455 #else
456 #define _DEPRECATED_
457 #endif
458 #endif
460 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
461 #define vdprintf rep_vdprintf
462 int rep_vdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
463 #endif
465 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
466 #define dprintf rep_dprintf
467 int rep_dprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
468 #endif
470 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
471 #define vasprintf rep_vasprintf
472 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
473 #endif
475 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
476 #define snprintf rep_snprintf
477 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
478 #endif
480 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
481 #define vsnprintf rep_vsnprintf
482 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
483 #endif
485 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
486 #define asprintf rep_asprintf
487 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
488 #endif
490 #if !defined(HAVE_C99_VSNPRINTF)
491 #ifdef REPLACE_BROKEN_PRINTF
493 * We do not redefine printf by default
494 * as it breaks the build if system headers
495 * use __attribute__((format(printf, 3, 0)))
496 * instead of __attribute__((format(__printf__, 3, 0)))
498 #define printf rep_printf
499 #endif
500 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
501 #endif
503 #if !defined(HAVE_C99_VSNPRINTF)
504 #define fprintf rep_fprintf
505 int rep_fprintf(FILE *stream, const char *, ...) PRINTF_ATTRIBUTE(2,3);
506 #endif
508 #ifndef HAVE_VSYSLOG
509 #ifdef HAVE_SYSLOG
510 #define vsyslog rep_vsyslog
511 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
512 #endif
513 #endif
515 /* we used to use these fns, but now we have good replacements
516 for snprintf and vsnprintf */
517 #define slprintf snprintf
520 #ifndef HAVE_VA_COPY
521 #undef va_copy
522 #ifdef HAVE___VA_COPY
523 #define va_copy(dest, src) __va_copy(dest, src)
524 #else
525 #define va_copy(dest, src) (dest) = (src)
526 #endif
527 #endif
529 #ifndef HAVE_VOLATILE
530 #define volatile
531 #endif
533 #ifndef HAVE_COMPARISON_FN_T
534 typedef int (*comparison_fn_t)(const void *, const void *);
535 #endif
537 #ifndef HAVE_WORKING_STRPTIME
538 #define strptime rep_strptime
539 struct tm;
540 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
541 #endif
543 #ifndef HAVE_DUP2
544 #define dup2 rep_dup2
545 int rep_dup2(int oldfd, int newfd);
546 #endif
548 /* Load header file for dynamic linking stuff */
549 #ifdef HAVE_DLFCN_H
550 #include <dlfcn.h>
551 #endif
553 #ifndef RTLD_LAZY
554 #define RTLD_LAZY 0
555 #endif
556 #ifndef RTLD_NOW
557 #define RTLD_NOW 0
558 #endif
559 #ifndef RTLD_GLOBAL
560 #define RTLD_GLOBAL 0
561 #endif
563 #ifndef HAVE_SECURE_MKSTEMP
564 #define mkstemp(path) rep_mkstemp(path)
565 int rep_mkstemp(char *temp);
566 #endif
568 #ifndef HAVE_MKDTEMP
569 #define mkdtemp rep_mkdtemp
570 char *rep_mkdtemp(char *template);
571 #endif
573 #ifndef HAVE_PREAD
574 #define pread rep_pread
575 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
576 #define LIBREPLACE_PREAD_REPLACED 1
577 #else
578 #define LIBREPLACE_PREAD_NOT_REPLACED 1
579 #endif
581 #ifndef HAVE_PWRITE
582 #define pwrite rep_pwrite
583 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
584 #define LIBREPLACE_PWRITE_REPLACED 1
585 #else
586 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
587 #endif
589 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
590 #define inet_ntoa rep_inet_ntoa
591 /* prototype is in "system/network.h" */
592 #endif
594 #ifndef HAVE_INET_PTON
595 #define inet_pton rep_inet_pton
596 /* prototype is in "system/network.h" */
597 #endif
599 #ifndef HAVE_INET_NTOP
600 #define inet_ntop rep_inet_ntop
601 /* prototype is in "system/network.h" */
602 #endif
604 #ifndef HAVE_INET_ATON
605 #define inet_aton rep_inet_aton
606 /* prototype is in "system/network.h" */
607 #endif
609 #ifndef HAVE_CONNECT
610 #define connect rep_connect
611 /* prototype is in "system/network.h" */
612 #endif
614 #ifndef HAVE_GETHOSTBYNAME
615 #define gethostbyname rep_gethostbyname
616 /* prototype is in "system/network.h" */
617 #endif
619 #ifndef HAVE_GETIFADDRS
620 #define getifaddrs rep_getifaddrs
621 /* prototype is in "system/network.h" */
622 #endif
624 #ifndef HAVE_FREEIFADDRS
625 #define freeifaddrs rep_freeifaddrs
626 /* prototype is in "system/network.h" */
627 #endif
629 #ifndef HAVE_GET_CURRENT_DIR_NAME
630 #define get_current_dir_name rep_get_current_dir_name
631 char *rep_get_current_dir_name(void);
632 #endif
634 #if (!defined(HAVE_STRERROR_R) || !defined(STRERROR_R_XSI_NOT_GNU))
635 #define strerror_r rep_strerror_r
636 int rep_strerror_r(int errnum, char *buf, size_t buflen);
637 #endif
639 #if !defined(HAVE_CLOCK_GETTIME)
640 #define clock_gettime rep_clock_gettime
641 #endif
643 #ifdef HAVE_LIMITS_H
644 #include <limits.h>
645 #endif
647 #ifdef HAVE_SYS_PARAM_H
648 #include <sys/param.h>
649 #endif
651 /* The extra casts work around common compiler bugs. */
652 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
653 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
654 It is necessary at least when t == time_t. */
655 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
656 ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
657 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
659 #ifndef UINT16_MAX
660 #define UINT16_MAX 65535
661 #endif
663 #ifndef UINT32_MAX
664 #define UINT32_MAX (4294967295U)
665 #endif
667 #ifndef UINT64_MAX
668 #define UINT64_MAX ((uint64_t)-1)
669 #endif
671 #ifndef INT64_MAX
672 #define INT64_MAX 9223372036854775807LL
673 #endif
675 #ifndef CHAR_BIT
676 #define CHAR_BIT 8
677 #endif
679 #ifndef INT32_MAX
680 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
681 #endif
683 #ifdef HAVE_STDBOOL_H
684 #include <stdbool.h>
685 #endif
687 #if !defined(HAVE_BOOL)
688 #ifdef HAVE__Bool
689 #define bool _Bool
690 #else
691 typedef int bool;
692 #endif
693 #endif
695 #if !defined(HAVE_INTPTR_T)
696 typedef long long intptr_t ;
697 #define __intptr_t_defined
698 #endif
700 #if !defined(HAVE_UINTPTR_T)
701 typedef unsigned long long uintptr_t ;
702 #define __uintptr_t_defined
703 #endif
705 #if !defined(HAVE_PTRDIFF_T)
706 typedef unsigned long long ptrdiff_t ;
707 #endif
710 * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
712 * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
713 * Tru64 needs _BOOL_EXISTS
714 * AIX needs _BOOL,_TRUE,_FALSE
716 #ifndef BOOL_DEFINED
717 #define BOOL_DEFINED
718 #endif
719 #ifndef _BOOL_EXISTS
720 #define _BOOL_EXISTS
721 #endif
722 #ifndef _BOOL
723 #define _BOOL
724 #endif
726 #ifndef __bool_true_false_are_defined
727 #define __bool_true_false_are_defined
728 #endif
730 #ifndef true
731 #define true (1)
732 #endif
733 #ifndef false
734 #define false (0)
735 #endif
737 #ifndef _TRUE
738 #define _TRUE true
739 #endif
740 #ifndef _FALSE
741 #define _FALSE false
742 #endif
744 #ifndef HAVE_FUNCTION_MACRO
745 #ifdef HAVE_func_MACRO
746 #define __FUNCTION__ __func__
747 #else
748 #define __FUNCTION__ ("")
749 #endif
750 #endif
753 #ifndef MIN
754 #define MIN(a,b) ((a)<(b)?(a):(b))
755 #endif
757 #ifndef MAX
758 #define MAX(a,b) ((a)>(b)?(a):(b))
759 #endif
761 #if !defined(HAVE_VOLATILE)
762 #define volatile
763 #endif
766 this is a warning hack. The idea is to use this everywhere that we
767 get the "discarding const" warning from gcc. That doesn't actually
768 fix the problem of course, but it means that when we do get to
769 cleaning them up we can do it by searching the code for
770 discard_const.
772 It also means that other error types aren't as swamped by the noise
773 of hundreds of const warnings, so we are more likely to notice when
774 we get new errors.
776 Please only add more uses of this macro when you find it
777 _really_ hard to fix const warnings. Our aim is to eventually use
778 this function in only a very few places.
780 Also, please call this via the discard_const_p() macro interface, as that
781 makes the return type safe.
783 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
785 /** Type-safe version of discard_const */
786 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
788 #ifndef __STRING
789 #define __STRING(x) #x
790 #endif
792 #ifndef __STRINGSTRING
793 #define __STRINGSTRING(x) __STRING(x)
794 #endif
796 #ifndef __LINESTR__
797 #define __LINESTR__ __STRINGSTRING(__LINE__)
798 #endif
800 #ifndef __location__
801 #define __location__ __FILE__ ":" __LINESTR__
802 #endif
804 /**
805 * zero a structure
807 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
809 /**
810 * zero a structure given a pointer to the structure
812 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
814 /**
815 * zero a structure given a pointer to the structure - no zero check
817 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
819 /* zero an array - note that sizeof(array) must work - ie. it must not be a
820 pointer */
821 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
824 * work out how many elements there are in a static array
826 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
828 /**
829 * pointer difference macro
831 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
833 #if MMAP_BLACKLIST
834 #undef HAVE_MMAP
835 #endif
837 #ifdef __COMPAR_FN_T
838 #define QSORT_CAST (__compar_fn_t)
839 #endif
841 #ifndef QSORT_CAST
842 #define QSORT_CAST (int (*)(const void *, const void *))
843 #endif
845 #ifndef PATH_MAX
846 #define PATH_MAX 1024
847 #endif
849 #ifndef MAX_DNS_NAME_LENGTH
850 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
851 #endif
853 #ifndef HAVE_CRYPT
854 char *ufc_crypt(const char *key, const char *salt);
855 #define crypt ufc_crypt
856 #else
857 #ifdef HAVE_CRYPT_H
858 #include <crypt.h>
859 #endif
860 #endif
862 /* these macros gain us a few percent of speed on gcc */
863 #if (__GNUC__ >= 3)
864 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
865 as its first argument */
866 #ifndef likely
867 #define likely(x) __builtin_expect(!!(x), 1)
868 #endif
869 #ifndef unlikely
870 #define unlikely(x) __builtin_expect(!!(x), 0)
871 #endif
872 #else
873 #ifndef likely
874 #define likely(x) (x)
875 #endif
876 #ifndef unlikely
877 #define unlikely(x) (x)
878 #endif
879 #endif
881 #ifndef HAVE_FDATASYNC
882 #define fdatasync(fd) fsync(fd)
883 #elif !defined(HAVE_DECL_FDATASYNC)
884 int fdatasync(int );
885 #endif
887 /* these are used to mark symbols as local to a shared lib, or
888 * publicly available via the shared lib API */
889 #ifndef _PUBLIC_
890 #ifdef HAVE_VISIBILITY_ATTR
891 #define _PUBLIC_ __attribute__((visibility("default")))
892 #else
893 #define _PUBLIC_
894 #endif
895 #endif
897 #ifndef _PRIVATE_
898 #ifdef HAVE_VISIBILITY_ATTR
899 # define _PRIVATE_ __attribute__((visibility("hidden")))
900 #else
901 # define _PRIVATE_
902 #endif
903 #endif
905 #ifndef HAVE_POLL
906 #define poll rep_poll
907 /* prototype is in "system/network.h" */
908 #endif
910 #ifndef HAVE_GETPEEREID
911 #define getpeereid rep_getpeereid
912 int rep_getpeereid(int s, uid_t *uid, gid_t *gid);
913 #endif
915 #ifndef HAVE_USLEEP
916 #define usleep rep_usleep
917 typedef long useconds_t;
918 int usleep(useconds_t);
919 #endif
921 #ifndef HAVE_SETPROCTITLE
922 #define setproctitle rep_setproctitle
923 void rep_setproctitle(const char *fmt, ...) PRINTF_ATTRIBUTE(1, 2);
924 #endif
926 #ifndef HAVE_SETPROCTITLE_INIT
927 #define setproctitle_init rep_setproctitle_init
928 void rep_setproctitle_init(int argc, char *argv[], char *envp[]);
929 #endif
931 #ifndef HAVE_MEMSET_S
932 #define memset_s rep_memset_s
933 int rep_memset_s(void *dest, size_t destsz, int ch, size_t count);
934 #endif
936 #ifndef HAVE_GETPROGNAME
937 #define getprogname rep_getprogname
938 const char *rep_getprogname(void);
939 #endif
941 #ifndef FALL_THROUGH
942 # ifdef HAVE_FALLTHROUGH_ATTRIBUTE
943 # define FALL_THROUGH __attribute__ ((fallthrough))
944 # else /* HAVE_FALLTHROUGH_ATTRIBUTE */
945 # define FALL_THROUGH ((void)0)
946 # endif /* HAVE_FALLTHROUGH_ATTRIBUTE */
947 #endif /* FALL_THROUGH */
949 bool nss_wrapper_enabled(void);
950 bool nss_wrapper_hosts_enabled(void);
951 bool socket_wrapper_enabled(void);
952 bool uid_wrapper_enabled(void);
954 /* Needed for Solaris atomic_add_XX functions. */
955 #if defined(HAVE_SYS_ATOMIC_H)
956 #include <sys/atomic.h>
957 #endif
959 #endif /* _LIBREPLACE_REPLACE_H */