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