8d0dd57064c259b248082337dfbbc668f1be9180
[kai/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
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 #ifndef __PRI64_PREFIX
60 # if __WORDSIZE == 64
61 #  define __PRI64_PREFIX        "l"
62 # else
63 #  define __PRI64_PREFIX        "ll"
64 # endif
65 #endif
66
67 /* Decimal notation.  */
68 #ifndef PRId8
69 # define PRId8          "d"
70 #endif
71 #ifndef PRId16
72 # define PRId16         "d"
73 #endif
74 #ifndef PRId32
75 # define PRId32         "d"
76 #endif
77 #ifndef PRId64
78 # define PRId64         __PRI64_PREFIX "d"
79 #endif
80
81 #ifndef PRIi8
82 # define PRIi8          "i"
83 #endif
84 #ifndef PRIi8
85 # define PRIi16         "i"
86 #endif
87 #ifndef PRIi8
88 # define PRIi32         "i"
89 #endif
90 #ifndef PRIi8
91 # define PRIi64         __PRI64_PREFIX "i"
92 #endif
93
94 #ifndef PRIu8
95 # define PRIu8          "u"
96 #endif
97 #ifndef PRIu16
98 # define PRIu16         "u"
99 #endif
100 #ifndef PRIu32
101 # define PRIu32         "u"
102 #endif
103 #ifndef PRIu64
104 # define PRIu64         __PRI64_PREFIX "u"
105 #endif
106
107 #ifdef HAVE_STRING_H
108 #include <string.h>
109 #endif
110
111 #ifdef HAVE_STRINGS_H
112 #include <strings.h>
113 #endif
114
115 #ifdef HAVE_SYS_TYPES_H
116 #include <sys/types.h>
117 #endif
118
119 #if STDC_HEADERS
120 #include <stdlib.h>
121 #include <stddef.h>
122 #endif
123
124 #ifndef HAVE_STRERROR
125 extern char *sys_errlist[];
126 #define strerror(i) sys_errlist[i]
127 #endif
128
129 #ifndef HAVE_ERRNO_DECL
130 extern int errno;
131 #endif
132
133 #ifndef HAVE_STRDUP
134 #define strdup rep_strdup
135 char *rep_strdup(const char *s);
136 #endif
137
138 #ifndef HAVE_MEMMOVE
139 #define memmove rep_memmove
140 void *rep_memmove(void *dest,const void *src,int size);
141 #endif
142
143 #ifndef HAVE_MKTIME
144 #define mktime rep_mktime
145 /* prototype is in "system/time.h" */
146 #endif
147
148 #ifndef HAVE_TIMEGM
149 #define timegm rep_timegm
150 /* prototype is in "system/time.h" */
151 #endif
152
153 #ifndef HAVE_UTIME
154 #define utime rep_utime
155 /* prototype is in "system/time.h" */
156 #endif
157
158 #ifndef HAVE_UTIMES
159 #define utimes rep_utimes
160 /* prototype is in "system/time.h" */
161 #endif
162
163 #ifndef HAVE_STRLCPY
164 #define strlcpy rep_strlcpy
165 size_t rep_strlcpy(char *d, const char *s, size_t bufsize);
166 #endif
167
168 #ifndef HAVE_STRLCAT
169 #define strlcat rep_strlcat
170 size_t rep_strlcat(char *d, const char *s, size_t bufsize);
171 #endif
172
173 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
174 #undef HAVE_STRNDUP
175 #define strndup rep_strndup
176 char *rep_strndup(const char *s, size_t n);
177 #endif
178
179 #if (defined(BROKEN_STRNLEN) || !defined(HAVE_STRNLEN))
180 #undef HAVE_STRNLEN
181 #define strnlen rep_strnlen
182 size_t rep_strnlen(const char *s, size_t n);
183 #endif
184
185 #if !HAVE_DECL_ENVIRON
186 #ifdef __APPLE__
187 #include <crt_externs.h>
188 #define environ (*_NSGetEnviron())
189 #else
190 extern char **environ;
191 #endif
192 #endif
193
194 #ifndef HAVE_SETENV
195 #define setenv rep_setenv
196 int rep_setenv(const char *name, const char *value, int overwrite);
197 #else
198 #ifndef HAVE_SETENV_DECL
199 int setenv(const char *name, const char *value, int overwrite);
200 #endif
201 #endif
202
203 #ifndef HAVE_UNSETENV
204 #define unsetenv rep_unsetenv
205 int rep_unsetenv(const char *name);
206 #endif
207
208 #ifndef HAVE_SETEUID
209 #define seteuid rep_seteuid
210 int rep_seteuid(uid_t);
211 #endif
212
213 #ifndef HAVE_SETEGID
214 #define setegid rep_setegid
215 int rep_setegid(gid_t);
216 #endif
217
218 #ifndef HAVE_CHOWN
219 #define chown rep_chown
220 int rep_chown(const char *path, uid_t uid, gid_t gid);
221 #endif
222
223 #ifndef HAVE_LINK
224 #define link rep_link
225 int rep_link(const char *oldpath, const char *newpath);
226 #endif
227
228 #ifndef HAVE_READLINK
229 #define readlink rep_readlink
230 int rep_readlink(const char *path, char *buf, size_t bufsize);
231 #endif
232
233 #ifndef HAVE_SYMLINK
234 #define symlink rep_symlink
235 int rep_symlink(const char *oldpath, const char *newpath);
236 #endif
237
238 #ifndef HAVE_REALPATH
239 #define realpath rep_realpath
240 char *rep_realpath(const char *path, char *resolved_path);
241 #endif
242
243 #ifndef HAVE_LCHOWN
244 #define lchown rep_lchown
245 int rep_lchown(const char *fname,uid_t uid,gid_t gid);
246 #endif
247
248 #ifndef HAVE_SETLINEBUF
249 #define setlinebuf rep_setlinebuf
250 void rep_setlinebuf(FILE *);
251 #endif
252
253 #ifndef HAVE_STRCASESTR
254 #define strcasestr rep_strcasestr
255 char *rep_strcasestr(const char *haystack, const char *needle);
256 #endif
257
258 #ifndef HAVE_STRTOK_R
259 #define strtok_r rep_strtok_r
260 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
261 #endif
262
263 #ifndef HAVE_STRTOLL
264 #define strtoll rep_strtoll
265 long long int rep_strtoll(const char *str, char **endptr, int base);
266 #endif
267
268 #ifndef HAVE_STRTOULL
269 #define strtoull rep_strtoull
270 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
271 #endif
272
273 #ifndef HAVE_FTRUNCATE
274 #define ftruncate rep_ftruncate
275 int rep_ftruncate(int,off_t);
276 #endif
277
278 #ifndef HAVE_INITGROUPS
279 #define initgroups rep_initgroups
280 int rep_initgroups(char *name, gid_t id);
281 #endif
282
283 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
284 #define bzero(a,b) memset((a),'\0',(b))
285 #endif
286
287 #ifndef HAVE_DLERROR
288 #define dlerror rep_dlerror
289 char *rep_dlerror(void);
290 #endif
291
292 #ifndef HAVE_DLOPEN
293 #define dlopen rep_dlopen
294 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
295 void *rep_dlopen(const char *name, unsigned int flags);
296 #else
297 void *rep_dlopen(const char *name, int flags);
298 #endif
299 #endif
300
301 #ifndef HAVE_DLSYM
302 #define dlsym rep_dlsym
303 void *rep_dlsym(void *handle, const char *symbol);
304 #endif
305
306 #ifndef HAVE_DLCLOSE
307 #define dlclose rep_dlclose
308 int rep_dlclose(void *handle);
309 #endif
310
311 #ifndef HAVE_SOCKETPAIR
312 #define socketpair rep_socketpair
313 /* prototype is in system/network.h */
314 #endif
315
316 #ifndef PRINTF_ATTRIBUTE
317 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
318 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
319  * the parameter containing the format, and a2 the index of the first
320  * argument. Note that some gcc 2.x versions don't handle this
321  * properly **/
322 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
323 #else
324 #define PRINTF_ATTRIBUTE(a1, a2)
325 #endif
326 #endif
327
328 #ifndef _DEPRECATED_
329 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
330 #define _DEPRECATED_ __attribute__ ((deprecated))
331 #else
332 #define _DEPRECATED_
333 #endif
334 #endif
335
336 #ifndef HAVE_VASPRINTF
337 #define vasprintf rep_vasprintf
338 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
339 #endif
340
341 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
342 #define snprintf rep_snprintf
343 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
344 #endif
345
346 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
347 #define vsnprintf rep_vsnprintf
348 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
349 #endif
350
351 #ifndef HAVE_ASPRINTF
352 #define asprintf rep_asprintf
353 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
354 #endif
355
356 #ifndef HAVE_VSYSLOG
357 #ifdef HAVE_SYSLOG
358 #define vsyslog rep_vsyslog
359 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
360 #endif
361 #endif
362
363 /* we used to use these fns, but now we have good replacements
364    for snprintf and vsnprintf */
365 #define slprintf snprintf
366
367
368 #ifndef HAVE_VA_COPY
369 #undef va_copy
370 #ifdef HAVE___VA_COPY
371 #define va_copy(dest, src) __va_copy(dest, src)
372 #else
373 #define va_copy(dest, src) (dest) = (src)
374 #endif
375 #endif
376
377 #ifndef HAVE_VOLATILE
378 #define volatile
379 #endif
380
381 #ifndef HAVE_COMPARISON_FN_T
382 typedef int (*comparison_fn_t)(const void *, const void *);
383 #endif
384
385 #ifdef REPLACE_STRPTIME
386 #define strptime rep_strptime
387 struct tm;
388 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
389 #endif
390
391 /* Load header file for dynamic linking stuff */
392 #ifdef HAVE_DLFCN_H
393 #include <dlfcn.h>
394 #endif
395
396 #ifndef RTLD_LAZY
397 #define RTLD_LAZY 0
398 #endif
399 #ifndef RTLD_NOW
400 #define RTLD_NOW 0
401 #endif
402 #ifndef RTLD_GLOBAL
403 #define RTLD_GLOBAL 0
404 #endif
405
406 #ifndef HAVE_SECURE_MKSTEMP
407 #define mkstemp(path) rep_mkstemp(path)
408 int rep_mkstemp(char *temp);
409 #endif
410
411 #ifndef HAVE_MKDTEMP
412 #define mkdtemp rep_mkdtemp
413 char *rep_mkdtemp(char *template);
414 #endif
415
416 #ifndef HAVE_PREAD
417 #define pread rep_pread
418 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
419 #endif
420
421 #ifndef HAVE_PWRITE
422 #define pwrite rep_pwrite
423 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
424 #endif
425
426 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
427 #define inet_ntoa rep_inet_ntoa
428 /* prototype is in "system/network.h" */
429 #endif
430
431 #ifndef HAVE_INET_PTON
432 #define inet_pton rep_inet_pton
433 /* prototype is in "system/network.h" */
434 #endif
435
436 #ifndef HAVE_INET_NTOP
437 #define inet_ntop rep_inet_ntop
438 /* prototype is in "system/network.h" */
439 #endif
440
441 #ifndef HAVE_INET_ATON
442 #define inet_aton rep_inet_aton
443 /* prototype is in "system/network.h" */
444 #endif
445
446 #ifndef HAVE_CONNECT
447 #define connect rep_connect
448 /* prototype is in "system/network.h" */
449 #endif
450
451 #ifndef HAVE_GETHOSTBYNAME
452 #define gethostbyname rep_gethostbyname
453 /* prototype is in "system/network.h" */
454 #endif
455
456 #ifndef HAVE_GETIFADDRS
457 #define getifaddrs rep_getifaddrs
458 /* prototype is in "system/network.h" */
459 #endif
460
461 #ifndef HAVE_FREEIFADDRS
462 #define freeifaddrs rep_freeifaddrs
463 /* prototype is in "system/network.h" */
464 #endif
465
466 #ifdef HAVE_LIMITS_H
467 #include <limits.h>
468 #endif
469
470 #ifdef HAVE_SYS_PARAM_H
471 #include <sys/param.h>
472 #endif
473
474 /* The extra casts work around common compiler bugs.  */
475 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
476 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
477    It is necessary at least when t == time_t.  */
478 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
479                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
480 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
481
482 #ifndef HOST_NAME_MAX
483 #define HOST_NAME_MAX 255
484 #endif
485
486 /*
487  * Some older systems seem not to have MAXHOSTNAMELEN
488  * defined.
489  */
490 #ifndef MAXHOSTNAMELEN
491 #define MAXHOSTNAMELEN HOST_NAME_MAX
492 #endif
493
494 #ifndef UINT16_MAX
495 #define UINT16_MAX 65535
496 #endif
497
498 #ifndef UINT32_MAX
499 #define UINT32_MAX (4294967295U)
500 #endif
501
502 #ifndef UINT64_MAX
503 #define UINT64_MAX ((uint64_t)-1)
504 #endif
505
506 #ifndef CHAR_BIT
507 #define CHAR_BIT 8
508 #endif
509
510 #ifndef INT32_MAX
511 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
512 #endif
513
514 #ifdef HAVE_STDBOOL_H
515 #include <stdbool.h>
516 #endif
517
518 #if !defined(HAVE_BOOL)
519 #ifdef HAVE__Bool
520 #define bool _Bool
521 #else
522 typedef int bool;
523 #endif
524 #endif
525
526 /*
527  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
528  *
529  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
530  * Tru64 needs _BOOL_EXISTS
531  * AIX needs _BOOL,_TRUE,_FALSE
532  */
533 #ifndef BOOL_DEFINED
534 #define BOOL_DEFINED
535 #endif
536 #ifndef _BOOL_EXISTS
537 #define _BOOL_EXISTS
538 #endif
539 #ifndef _BOOL
540 #define _BOOL
541 #endif
542
543 #ifndef __bool_true_false_are_defined
544 #define __bool_true_false_are_defined
545 #endif
546
547 #ifndef true
548 #define true (1)
549 #endif
550 #ifndef false
551 #define false (0)
552 #endif
553
554 #ifndef _TRUE
555 #define _TRUE true
556 #endif
557 #ifndef _FALSE
558 #define _FALSE false
559 #endif
560
561 #ifndef HAVE_FUNCTION_MACRO
562 #ifdef HAVE_func_MACRO
563 #define __FUNCTION__ __func__
564 #else
565 #define __FUNCTION__ ("")
566 #endif
567 #endif
568
569
570 #ifndef MIN
571 #define MIN(a,b) ((a)<(b)?(a):(b))
572 #endif
573
574 #ifndef MAX
575 #define MAX(a,b) ((a)>(b)?(a):(b))
576 #endif
577
578 #if !defined(HAVE_VOLATILE)
579 #define volatile
580 #endif
581
582 /**
583   this is a warning hack. The idea is to use this everywhere that we
584   get the "discarding const" warning from gcc. That doesn't actually
585   fix the problem of course, but it means that when we do get to
586   cleaning them up we can do it by searching the code for
587   discard_const.
588
589   It also means that other error types aren't as swamped by the noise
590   of hundreds of const warnings, so we are more likely to notice when
591   we get new errors.
592
593   Please only add more uses of this macro when you find it
594   _really_ hard to fix const warnings. Our aim is to eventually use
595   this function in only a very few places.
596
597   Also, please call this via the discard_const_p() macro interface, as that
598   makes the return type safe.
599 */
600 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
601
602 /** Type-safe version of discard_const */
603 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
604
605 #ifndef __STRING
606 #define __STRING(x)    #x
607 #endif
608
609 #ifndef __STRINGSTRING
610 #define __STRINGSTRING(x) __STRING(x)
611 #endif
612
613 #ifndef __LINESTR__
614 #define __LINESTR__ __STRINGSTRING(__LINE__)
615 #endif
616
617 #ifndef __location__
618 #define __location__ __FILE__ ":" __LINESTR__
619 #endif
620
621 /** 
622  * zero a structure 
623  */
624 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
625
626 /** 
627  * zero a structure given a pointer to the structure 
628  */
629 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
630
631 /** 
632  * zero a structure given a pointer to the structure - no zero check 
633  */
634 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
635
636 /* zero an array - note that sizeof(array) must work - ie. it must not be a
637    pointer */
638 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
639
640 /**
641  * work out how many elements there are in a static array 
642  */
643 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
644
645 /** 
646  * pointer difference macro 
647  */
648 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
649
650 #if MMAP_BLACKLIST
651 #undef HAVE_MMAP
652 #endif
653
654 #ifdef __COMPAR_FN_T
655 #define QSORT_CAST (__compar_fn_t)
656 #endif
657
658 #ifndef QSORT_CAST
659 #define QSORT_CAST (int (*)(const void *, const void *))
660 #endif
661
662 #ifndef PATH_MAX
663 #define PATH_MAX 1024
664 #endif
665
666 #ifndef MAX_DNS_NAME_LENGTH
667 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
668 #endif
669
670 #ifndef HAVE_CRYPT
671 char *ufc_crypt(const char *key, const char *salt);
672 #define crypt ufc_crypt
673 #else
674 #ifdef HAVE_CRYPT_H
675 #include <crypt.h>
676 #endif
677 #endif
678
679 #endif /* _LIBREPLACE_REPLACE_H */