lib/replace: replace all *printf function if we replace snprintf (bug #9390)
[metze/samba/wip.git] / lib / replace / replace.h
1 /*
2    Unix SMB/CIFS implementation.
3
4    macros to go along with the lib/replace/ portability layer code
5
6    Copyright (C) Andrew Tridgell 2005
7    Copyright (C) Jelmer Vernooij 2006-2008
8    Copyright (C) Jeremy Allison 2007.
9
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
13
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.
18
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.
23
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/>.
26 */
27
28 #ifndef _LIBREPLACE_REPLACE_H
29 #define _LIBREPLACE_REPLACE_H
30
31 #ifndef NO_CONFIG_H
32 #include "config.h"
33 #endif
34
35 #ifdef HAVE_STANDARDS_H
36 #include <standards.h>
37 #endif
38
39 #include <stdio.h>
40 #include <stdlib.h>
41 #include <stdarg.h>
42 #include <errno.h>
43
44 #if defined(_MSC_VER) || defined(__MINGW32__)
45 #include "win32_replace.h"
46 #endif
47
48
49 #ifdef HAVE_STDINT_H
50 #include <stdint.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
54 #elif HAVE_INTTYPES_H
55 #define __STDC_FORMAT_MACROS
56 #include <inttypes.h>
57 #endif
58
59 #ifdef HAVE_MALLOC_H
60 #include <malloc.h>
61 #endif
62
63 #ifndef __PRI64_PREFIX
64 # if __WORDSIZE == 64 && ! defined __APPLE__
65 #  define __PRI64_PREFIX        "l"
66 # else
67 #  define __PRI64_PREFIX        "ll"
68 # endif
69 #endif
70
71 /* Decimal notation.  */
72 #ifndef PRId8
73 # define PRId8          "d"
74 #endif
75 #ifndef PRId16
76 # define PRId16         "d"
77 #endif
78 #ifndef PRId32
79 # define PRId32         "d"
80 #endif
81 #ifndef PRId64
82 # define PRId64         __PRI64_PREFIX "d"
83 #endif
84
85 #ifndef PRIi8
86 # define PRIi8          "i"
87 #endif
88 #ifndef PRIi16
89 # define PRIi16         "i"
90 #endif
91 #ifndef PRIi32
92 # define PRIi32         "i"
93 #endif
94 #ifndef PRIi64
95 # define PRIi64         __PRI64_PREFIX "i"
96 #endif
97
98 #ifndef PRIu8
99 # define PRIu8          "u"
100 #endif
101 #ifndef PRIu16
102 # define PRIu16         "u"
103 #endif
104 #ifndef PRIu32
105 # define PRIu32         "u"
106 #endif
107 #ifndef PRIu64
108 # define PRIu64         __PRI64_PREFIX "u"
109 #endif
110
111 #ifdef HAVE_BSD_STRING_H
112 #include <bsd/string.h>
113 #endif
114
115 #ifdef HAVE_BSD_UNISTD_H
116 #include <bsd/unistd.h>
117 #endif
118
119 #ifdef HAVE_STRING_H
120 #include <string.h>
121 #endif
122
123 #ifdef HAVE_STRINGS_H
124 #include <strings.h>
125 #endif
126
127 #ifdef HAVE_SYS_TYPES_H
128 #include <sys/types.h>
129 #endif
130
131 #ifdef HAVE_SETPROCTITLE_H
132 #include <setproctitle.h>
133 #endif
134
135 #if STDC_HEADERS
136 #include <stdlib.h>
137 #include <stddef.h>
138 #endif
139
140 #ifdef HAVE_LINUX_TYPES_H
141 /*
142  * This is needed as some broken header files require this to be included early
143  */
144 #include <linux/types.h>
145 #endif
146
147 #ifndef HAVE_STRERROR
148 extern char *sys_errlist[];
149 #define strerror(i) sys_errlist[i]
150 #endif
151
152 #ifndef HAVE_ERRNO_DECL
153 extern int errno;
154 #endif
155
156 #ifndef HAVE_STRDUP
157 #define strdup rep_strdup
158 char *rep_strdup(const char *s);
159 #endif
160
161 #ifndef HAVE_MEMMOVE
162 #define memmove rep_memmove
163 void *rep_memmove(void *dest,const void *src,int size);
164 #endif
165
166 #ifndef HAVE_MEMMEM
167 #define memmem rep_memmem
168 void *rep_memmem(const void *haystack, size_t haystacklen,
169                  const void *needle, size_t needlelen);
170 #endif
171
172 #ifndef HAVE_MEMALIGN
173 #define memalign rep_memalign
174 void *rep_memalign(size_t boundary, size_t size);
175 #endif
176
177 #ifndef HAVE_MKTIME
178 #define mktime rep_mktime
179 /* prototype is in "system/time.h" */
180 #endif
181
182 #ifndef HAVE_TIMEGM
183 #define timegm rep_timegm
184 /* prototype is in "system/time.h" */
185 #endif
186
187 #ifndef HAVE_UTIME
188 #define utime rep_utime
189 /* prototype is in "system/time.h" */
190 #endif
191
192 #ifndef HAVE_UTIMES
193 #define utimes rep_utimes
194 /* prototype is in "system/time.h" */
195 #endif
196
197 #ifndef HAVE_STRLCPY
198 #define strlcpy rep_strlcpy
199 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
200 #endif
201
202 #ifndef HAVE_STRLCAT
203 #define strlcat rep_strlcat
204 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
205 #endif
206
207 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
208 #undef HAVE_STRNDUP
209 #define strndup rep_strndup
210 char *rep_strndup(const char *s, size_t n);
211 #endif
212
213 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
214 #undef HAVE_STRNLEN
215 #define strnlen rep_strnlen
216 size_t rep_strnlen(const char *s, size_t n);
217 #endif
218
219 #if !HAVE_DECL_ENVIRON
220 #ifdef __APPLE__
221 #include <crt_externs.h>
222 #define environ (*_NSGetEnviron())
223 #else
224 extern char **environ;
225 #endif
226 #endif
227
228 #ifndef HAVE_SETENV
229 #define setenv rep_setenv
230 int rep_setenv(const char *name, const char *value, int overwrite);
231 #else
232 #ifndef HAVE_SETENV_DECL
233 int setenv(const char *name, const char *value, int overwrite);
234 #endif
235 #endif
236
237 #ifndef HAVE_UNSETENV
238 #define unsetenv rep_unsetenv
239 int rep_unsetenv(const char *name);
240 #endif
241
242 #ifndef HAVE_SETEUID
243 #define seteuid rep_seteuid
244 int rep_seteuid(uid_t);
245 #endif
246
247 #ifndef HAVE_SETEGID
248 #define setegid rep_setegid
249 int rep_setegid(gid_t);
250 #endif
251
252 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESUID_DECL))
253 /* stupid glibc */
254 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
255 #endif
256 #if (defined(USE_SETRESUID) && !defined(HAVE_SETRESGID_DECL))
257 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
258 #endif
259
260 #ifndef HAVE_CHOWN
261 #define chown rep_chown
262 int rep_chown(const char *path, uid_t uid, gid_t gid);
263 #endif
264
265 #ifndef HAVE_CHROOT
266 #define chroot rep_chroot
267 int rep_chroot(const char *dirname);
268 #endif
269
270 #ifndef HAVE_LINK
271 #define link rep_link
272 int rep_link(const char *oldpath, const char *newpath);
273 #endif
274
275 #ifndef HAVE_READLINK
276 #define readlink rep_readlink
277 ssize_t rep_readlink(const char *path, char *buf, size_t bufsize);
278 #endif
279
280 #ifndef HAVE_SYMLINK
281 #define symlink rep_symlink
282 int rep_symlink(const char *oldpath, const char *newpath);
283 #endif
284
285 #ifndef HAVE_REALPATH
286 #define realpath rep_realpath
287 char *rep_realpath(const char *path, char *resolved_path);
288 #endif
289
290 #ifndef HAVE_LCHOWN
291 #define lchown rep_lchown
292 int rep_lchown(const char *fname,uid_t uid,gid_t gid);
293 #endif
294
295 #ifdef HAVE_UNIX_H
296 #include <unix.h>
297 #endif
298
299 #ifndef HAVE_SETLINEBUF
300 #define setlinebuf rep_setlinebuf
301 void rep_setlinebuf(FILE *);
302 #endif
303
304 #ifndef HAVE_STRCASESTR
305 #define strcasestr rep_strcasestr
306 char *rep_strcasestr(const char *haystack, const char *needle);
307 #endif
308
309 #ifndef HAVE_STRTOK_R
310 #define strtok_r rep_strtok_r
311 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
312 #endif
313
314
315
316 #ifndef HAVE_STRTOLL
317 #define strtoll rep_strtoll
318 long long int rep_strtoll(const char *str, char **endptr, int base);
319 #else
320 #ifdef HAVE_BSD_STRTOLL
321 #define strtoll rep_strtoll
322 long long int rep_strtoll(const char *str, char **endptr, int base);
323 #endif
324 #endif
325
326 #ifndef HAVE_STRTOULL
327 #define strtoull rep_strtoull
328 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
329 #else
330 #ifdef HAVE_BSD_STRTOLL /* yes, it's not HAVE_BSD_STRTOULL */
331 #define strtoull rep_strtoull
332 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
333 #endif
334 #endif
335
336 #ifndef HAVE_FTRUNCATE
337 #define ftruncate rep_ftruncate
338 int rep_ftruncate(int,off_t);
339 #endif
340
341 #ifndef HAVE_INITGROUPS
342 #define initgroups rep_initgroups
343 int rep_initgroups(char *name, gid_t id);
344 #endif
345
346 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
347 #define bzero(a,b) memset((a),'\0',(b))
348 #endif
349
350 #ifndef HAVE_DLERROR
351 #define dlerror rep_dlerror
352 char *rep_dlerror(void);
353 #endif
354
355 #ifndef HAVE_DLOPEN
356 #define dlopen rep_dlopen
357 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
358 void *rep_dlopen(const char *name, unsigned int flags);
359 #else
360 void *rep_dlopen(const char *name, int flags);
361 #endif
362 #endif
363
364 #ifndef HAVE_DLSYM
365 #define dlsym rep_dlsym
366 void *rep_dlsym(void *handle, const char *symbol);
367 #endif
368
369 #ifndef HAVE_DLCLOSE
370 #define dlclose rep_dlclose
371 int rep_dlclose(void *handle);
372 #endif
373
374 #ifndef HAVE_SOCKETPAIR
375 #define socketpair rep_socketpair
376 /* prototype is in system/network.h */
377 #endif
378
379 #ifndef PRINTF_ATTRIBUTE
380 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
381 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
382  * the parameter containing the format, and a2 the index of the first
383  * argument. Note that some gcc 2.x versions don't handle this
384  * properly **/
385 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
386 #else
387 #define PRINTF_ATTRIBUTE(a1, a2)
388 #endif
389 #endif
390
391 #ifndef _DEPRECATED_
392 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
393 #define _DEPRECATED_ __attribute__ ((deprecated))
394 #else
395 #define _DEPRECATED_
396 #endif
397 #endif
398
399 #if !defined(HAVE_VDPRINTF) || !defined(HAVE_C99_VSNPRINTF)
400 #define vdprintf rep_vdprintf
401 int rep_vdprintf(int fd, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
402 #endif
403
404 #if !defined(HAVE_DPRINTF) || !defined(HAVE_C99_VSNPRINTF)
405 #define dprintf rep_dprintf
406 int rep_dprintf(int fd, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
407 #endif
408
409 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
410 #define vasprintf rep_vasprintf
411 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
412 #endif
413
414 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
415 #define snprintf rep_snprintf
416 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
417 #endif
418
419 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
420 #define vsnprintf rep_vsnprintf
421 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
422 #endif
423
424 #if !defined(HAVE_ASPRINTF) || !defined(HAVE_C99_VSNPRINTF)
425 #define asprintf rep_asprintf
426 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
427 #endif
428
429 #if !defined(HAVE_C99_VSNPRINTF)
430 #ifdef REPLACE_BROKEN_PRINTF
431 /*
432  * We do not redefine printf by default
433  * as it breaks the build if system headers
434  * use __attribute__((format(printf, 3, 0)))
435  * instead of __attribute__((format(__printf__, 3, 0)))
436  */
437 #define printf rep_printf
438 #endif
439 int rep_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
440 #endif
441
442 #if !defined(HAVE_C99_VSNPRINTF)
443 #define fprintf rep_fprintf
444 int rep_fprintf(FILE *stream, const char *, ...) PRINTF_ATTRIBUTE(2,3);
445 #endif
446
447 #ifndef HAVE_VSYSLOG
448 #ifdef HAVE_SYSLOG
449 #define vsyslog rep_vsyslog
450 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
451 #endif
452 #endif
453
454 /* we used to use these fns, but now we have good replacements
455    for snprintf and vsnprintf */
456 #define slprintf snprintf
457
458
459 #ifndef HAVE_VA_COPY
460 #undef va_copy
461 #ifdef HAVE___VA_COPY
462 #define va_copy(dest, src) __va_copy(dest, src)
463 #else
464 #define va_copy(dest, src) (dest) = (src)
465 #endif
466 #endif
467
468 #ifndef HAVE_VOLATILE
469 #define volatile
470 #endif
471
472 #ifndef HAVE_COMPARISON_FN_T
473 typedef int (*comparison_fn_t)(const void *, const void *);
474 #endif
475
476 #ifndef HAVE_WORKING_STRPTIME
477 #define strptime rep_strptime
478 struct tm;
479 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
480 #endif
481
482 #ifndef HAVE_DUP2
483 #define dup2 rep_dup2
484 int rep_dup2(int oldfd, int newfd);
485 #endif
486
487 /* Load header file for dynamic linking stuff */
488 #ifdef HAVE_DLFCN_H
489 #include <dlfcn.h>
490 #endif
491
492 #ifndef RTLD_LAZY
493 #define RTLD_LAZY 0
494 #endif
495 #ifndef RTLD_NOW
496 #define RTLD_NOW 0
497 #endif
498 #ifndef RTLD_GLOBAL
499 #define RTLD_GLOBAL 0
500 #endif
501
502 #ifndef HAVE_SECURE_MKSTEMP
503 #define mkstemp(path) rep_mkstemp(path)
504 int rep_mkstemp(char *temp);
505 #endif
506
507 #ifndef HAVE_MKDTEMP
508 #define mkdtemp rep_mkdtemp
509 char *rep_mkdtemp(char *template);
510 #endif
511
512 #ifndef HAVE_PREAD
513 #define pread rep_pread
514 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
515 #define LIBREPLACE_PREAD_REPLACED 1
516 #else
517 #define LIBREPLACE_PREAD_NOT_REPLACED 1
518 #endif
519
520 #ifndef HAVE_PWRITE
521 #define pwrite rep_pwrite
522 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
523 #define LIBREPLACE_PWRITE_REPLACED 1
524 #else
525 #define LIBREPLACE_PWRITE_NOT_REPLACED 1
526 #endif
527
528 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
529 #define inet_ntoa rep_inet_ntoa
530 /* prototype is in "system/network.h" */
531 #endif
532
533 #ifndef HAVE_INET_PTON
534 #define inet_pton rep_inet_pton
535 /* prototype is in "system/network.h" */
536 #endif
537
538 #ifndef HAVE_INET_NTOP
539 #define inet_ntop rep_inet_ntop
540 /* prototype is in "system/network.h" */
541 #endif
542
543 #ifndef HAVE_INET_ATON
544 #define inet_aton rep_inet_aton
545 /* prototype is in "system/network.h" */
546 #endif
547
548 #ifndef HAVE_CONNECT
549 #define connect rep_connect
550 /* prototype is in "system/network.h" */
551 #endif
552
553 #ifndef HAVE_GETHOSTBYNAME
554 #define gethostbyname rep_gethostbyname
555 /* prototype is in "system/network.h" */
556 #endif
557
558 #ifndef HAVE_GETIFADDRS
559 #define getifaddrs rep_getifaddrs
560 /* prototype is in "system/network.h" */
561 #endif
562
563 #ifndef HAVE_FREEIFADDRS
564 #define freeifaddrs rep_freeifaddrs
565 /* prototype is in "system/network.h" */
566 #endif
567
568 #ifndef HAVE_GET_CURRENT_DIR_NAME
569 #define get_current_dir_name rep_get_current_dir_name
570 char *rep_get_current_dir_name(void);
571 #endif
572
573 #if !defined(HAVE_STRERROR_R) || !defined(STRERROR_R_PROTO_COMPATIBLE)
574 #undef strerror_r
575 #define strerror_r rep_strerror_r
576 int rep_strerror_r(int errnum, char *buf, size_t buflen);
577 #endif
578
579 #if !defined(HAVE_CLOCK_GETTIME)
580 #define clock_gettime rep_clock_gettime
581 #endif
582
583 #ifdef HAVE_LIMITS_H
584 #include <limits.h>
585 #endif
586
587 #ifdef HAVE_SYS_PARAM_H
588 #include <sys/param.h>
589 #endif
590
591 /* The extra casts work around common compiler bugs.  */
592 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
593 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
594    It is necessary at least when t == time_t.  */
595 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
596                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
597 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
598
599 #ifndef UINT16_MAX
600 #define UINT16_MAX 65535
601 #endif
602
603 #ifndef UINT32_MAX
604 #define UINT32_MAX (4294967295U)
605 #endif
606
607 #ifndef UINT64_MAX
608 #define UINT64_MAX ((uint64_t)-1)
609 #endif
610
611 #ifndef INT64_MAX
612 #define INT64_MAX 9223372036854775807LL
613 #endif
614
615 #ifndef CHAR_BIT
616 #define CHAR_BIT 8
617 #endif
618
619 #ifndef INT32_MAX
620 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
621 #endif
622
623 #ifdef HAVE_STDBOOL_H
624 #include <stdbool.h>
625 #endif
626
627 #if !defined(HAVE_BOOL)
628 #ifdef HAVE__Bool
629 #define bool _Bool
630 #else
631 typedef int bool;
632 #endif
633 #endif
634
635 #if !defined(HAVE_INTPTR_T)
636 typedef long long intptr_t ;
637 #endif
638
639 #if !defined(HAVE_UINTPTR_T)
640 typedef unsigned long long uintptr_t ;
641 #endif
642
643 #if !defined(HAVE_PTRDIFF_T)
644 typedef unsigned long long ptrdiff_t ;
645 #endif
646
647 /*
648  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
649  *
650  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
651  * Tru64 needs _BOOL_EXISTS
652  * AIX needs _BOOL,_TRUE,_FALSE
653  */
654 #ifndef BOOL_DEFINED
655 #define BOOL_DEFINED
656 #endif
657 #ifndef _BOOL_EXISTS
658 #define _BOOL_EXISTS
659 #endif
660 #ifndef _BOOL
661 #define _BOOL
662 #endif
663
664 #ifndef __bool_true_false_are_defined
665 #define __bool_true_false_are_defined
666 #endif
667
668 #ifndef true
669 #define true (1)
670 #endif
671 #ifndef false
672 #define false (0)
673 #endif
674
675 #ifndef _TRUE
676 #define _TRUE true
677 #endif
678 #ifndef _FALSE
679 #define _FALSE false
680 #endif
681
682 #ifndef HAVE_FUNCTION_MACRO
683 #ifdef HAVE_func_MACRO
684 #define __FUNCTION__ __func__
685 #else
686 #define __FUNCTION__ ("")
687 #endif
688 #endif
689
690
691 #ifndef MIN
692 #define MIN(a,b) ((a)<(b)?(a):(b))
693 #endif
694
695 #ifndef MAX
696 #define MAX(a,b) ((a)>(b)?(a):(b))
697 #endif
698
699 #if !defined(HAVE_VOLATILE)
700 #define volatile
701 #endif
702
703 /**
704   this is a warning hack. The idea is to use this everywhere that we
705   get the "discarding const" warning from gcc. That doesn't actually
706   fix the problem of course, but it means that when we do get to
707   cleaning them up we can do it by searching the code for
708   discard_const.
709
710   It also means that other error types aren't as swamped by the noise
711   of hundreds of const warnings, so we are more likely to notice when
712   we get new errors.
713
714   Please only add more uses of this macro when you find it
715   _really_ hard to fix const warnings. Our aim is to eventually use
716   this function in only a very few places.
717
718   Also, please call this via the discard_const_p() macro interface, as that
719   makes the return type safe.
720 */
721 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
722
723 /** Type-safe version of discard_const */
724 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
725
726 #ifndef __STRING
727 #define __STRING(x)    #x
728 #endif
729
730 #ifndef __STRINGSTRING
731 #define __STRINGSTRING(x) __STRING(x)
732 #endif
733
734 #ifndef __LINESTR__
735 #define __LINESTR__ __STRINGSTRING(__LINE__)
736 #endif
737
738 #ifndef __location__
739 #define __location__ __FILE__ ":" __LINESTR__
740 #endif
741
742 /** 
743  * zero a structure 
744  */
745 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
746
747 /** 
748  * zero a structure given a pointer to the structure 
749  */
750 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
751
752 /** 
753  * zero a structure given a pointer to the structure - no zero check 
754  */
755 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
756
757 /* zero an array - note that sizeof(array) must work - ie. it must not be a
758    pointer */
759 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
760
761 /**
762  * work out how many elements there are in a static array 
763  */
764 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
765
766 /** 
767  * pointer difference macro 
768  */
769 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
770
771 #if MMAP_BLACKLIST
772 #undef HAVE_MMAP
773 #endif
774
775 #ifdef __COMPAR_FN_T
776 #define QSORT_CAST (__compar_fn_t)
777 #endif
778
779 #ifndef QSORT_CAST
780 #define QSORT_CAST (int (*)(const void *, const void *))
781 #endif
782
783 #ifndef PATH_MAX
784 #define PATH_MAX 1024
785 #endif
786
787 #ifndef MAX_DNS_NAME_LENGTH
788 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
789 #endif
790
791 #ifndef HAVE_CRYPT
792 char *ufc_crypt(const char *key, const char *salt);
793 #define crypt ufc_crypt
794 #else
795 #ifdef HAVE_CRYPT_H
796 #include <crypt.h>
797 #endif
798 #endif
799
800 /* these macros gain us a few percent of speed on gcc */
801 #if (__GNUC__ >= 3)
802 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
803    as its first argument */
804 #ifndef likely
805 #define likely(x)   __builtin_expect(!!(x), 1)
806 #endif
807 #ifndef unlikely
808 #define unlikely(x) __builtin_expect(!!(x), 0)
809 #endif
810 #else
811 #ifndef likely
812 #define likely(x) (x)
813 #endif
814 #ifndef unlikely
815 #define unlikely(x) (x)
816 #endif
817 #endif
818
819 #ifndef HAVE_FDATASYNC
820 #define fdatasync(fd) fsync(fd)
821 #elif !defined(HAVE_DECL_FDATASYNC)
822 int fdatasync(int );
823 #endif
824
825 /* these are used to mark symbols as local to a shared lib, or
826  * publicly available via the shared lib API */
827 #ifndef _PUBLIC_
828 #ifdef HAVE_VISIBILITY_ATTR
829 #define _PUBLIC_ __attribute__((visibility("default")))
830 #else
831 #define _PUBLIC_
832 #endif
833 #endif
834
835 #ifndef _PRIVATE_
836 #ifdef HAVE_VISIBILITY_ATTR
837 #  define _PRIVATE_ __attribute__((visibility("hidden")))
838 #else
839 #  define _PRIVATE_
840 #endif
841 #endif
842
843 #ifndef HAVE_POLL
844 #define poll rep_poll
845 /* prototype is in "system/network.h" */
846 #endif
847
848 #if !defined(getpass)
849 #ifdef REPLACE_GETPASS
850 #if defined(REPLACE_GETPASS_BY_GETPASSPHRASE)
851 #define getpass(prompt) getpassphrase(prompt)
852 #else
853 #define getpass(prompt) rep_getpass(prompt)
854 char *rep_getpass(const char *prompt);
855 #endif
856 #endif
857 #endif
858
859 #ifndef HAVE_GETPEEREID
860 #define getpeereid rep_getpeereid
861 int rep_getpeereid(int s, uid_t *uid, gid_t *gid);
862 #endif
863
864 #ifndef HAVE_USLEEP
865 #define usleep rep_usleep
866 typedef long useconds_t;
867 int usleep(useconds_t);
868 #endif
869
870 #ifndef HAVE_SETPROCTITLE
871 #define setproctitle rep_setproctitle
872 void rep_setproctitle(const char *fmt, ...) PRINTF_ATTRIBUTE(1, 2);
873 #endif
874
875 #endif /* _LIBREPLACE_REPLACE_H */