Move sys_readlink() to libreplace.
[ira/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
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_SETLINEBUF
234 #define setlinebuf rep_setlinebuf
235 void rep_setlinebuf(FILE *);
236 #endif
237
238 #ifndef HAVE_STRCASESTR
239 #define strcasestr rep_strcasestr
240 char *rep_strcasestr(const char *haystack, const char *needle);
241 #endif
242
243 #ifndef HAVE_STRTOK_R
244 #define strtok_r rep_strtok_r
245 char *rep_strtok_r(char *s, const char *delim, char **save_ptr);
246 #endif
247
248 #ifndef HAVE_STRTOLL
249 #define strtoll rep_strtoll
250 long long int rep_strtoll(const char *str, char **endptr, int base);
251 #endif
252
253 #ifndef HAVE_STRTOULL
254 #define strtoull rep_strtoull
255 unsigned long long int rep_strtoull(const char *str, char **endptr, int base);
256 #endif
257
258 #ifndef HAVE_FTRUNCATE
259 #define ftruncate rep_ftruncate
260 int rep_ftruncate(int,off_t);
261 #endif
262
263 #ifndef HAVE_INITGROUPS
264 #define initgroups rep_initgroups
265 int rep_initgroups(char *name, gid_t id);
266 #endif
267
268 #if !defined(HAVE_BZERO) && defined(HAVE_MEMSET)
269 #define bzero(a,b) memset((a),'\0',(b))
270 #endif
271
272 #ifndef HAVE_DLERROR
273 #define dlerror rep_dlerror
274 char *rep_dlerror(void);
275 #endif
276
277 #ifndef HAVE_DLOPEN
278 #define dlopen rep_dlopen
279 #ifdef DLOPEN_TAKES_UNSIGNED_FLAGS
280 void *rep_dlopen(const char *name, unsigned int flags);
281 #else
282 void *rep_dlopen(const char *name, int flags);
283 #endif
284 #endif
285
286 #ifndef HAVE_DLSYM
287 #define dlsym rep_dlsym
288 void *rep_dlsym(void *handle, const char *symbol);
289 #endif
290
291 #ifndef HAVE_DLCLOSE
292 #define dlclose rep_dlclose
293 int rep_dlclose(void *handle);
294 #endif
295
296 #ifndef HAVE_SOCKETPAIR
297 #define socketpair rep_socketpair
298 /* prototype is in system/network.h */
299 #endif
300
301 #ifndef PRINTF_ATTRIBUTE
302 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
303 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
304  * the parameter containing the format, and a2 the index of the first
305  * argument. Note that some gcc 2.x versions don't handle this
306  * properly **/
307 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
308 #else
309 #define PRINTF_ATTRIBUTE(a1, a2)
310 #endif
311 #endif
312
313 #ifndef _DEPRECATED_
314 #if (__GNUC__ >= 3) && (__GNUC_MINOR__ >= 1 )
315 #define _DEPRECATED_ __attribute__ ((deprecated))
316 #else
317 #define _DEPRECATED_
318 #endif
319 #endif
320
321 #ifndef HAVE_VASPRINTF
322 #define vasprintf rep_vasprintf
323 int rep_vasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
324 #endif
325
326 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
327 #define snprintf rep_snprintf
328 int rep_snprintf(char *,size_t ,const char *, ...) PRINTF_ATTRIBUTE(3,4);
329 #endif
330
331 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
332 #define vsnprintf rep_vsnprintf
333 int rep_vsnprintf(char *,size_t ,const char *, va_list ap) PRINTF_ATTRIBUTE(3,0);
334 #endif
335
336 #ifndef HAVE_ASPRINTF
337 #define asprintf rep_asprintf
338 int rep_asprintf(char **,const char *, ...) PRINTF_ATTRIBUTE(2,3);
339 #endif
340
341 #ifndef HAVE_VSYSLOG
342 #ifdef HAVE_SYSLOG
343 #define vsyslog rep_vsyslog
344 void rep_vsyslog (int facility_priority, const char *format, va_list arglist) PRINTF_ATTRIBUTE(2,0);
345 #endif
346 #endif
347
348 /* we used to use these fns, but now we have good replacements
349    for snprintf and vsnprintf */
350 #define slprintf snprintf
351
352
353 #ifndef HAVE_VA_COPY
354 #undef va_copy
355 #ifdef HAVE___VA_COPY
356 #define va_copy(dest, src) __va_copy(dest, src)
357 #else
358 #define va_copy(dest, src) (dest) = (src)
359 #endif
360 #endif
361
362 #ifndef HAVE_VOLATILE
363 #define volatile
364 #endif
365
366 #ifndef HAVE_COMPARISON_FN_T
367 typedef int (*comparison_fn_t)(const void *, const void *);
368 #endif
369
370 #ifdef REPLACE_STRPTIME
371 #define strptime rep_strptime
372 struct tm;
373 char *rep_strptime(const char *buf, const char *format, struct tm *tm);
374 #endif
375
376 /* Load header file for dynamic linking stuff */
377 #ifdef HAVE_DLFCN_H
378 #include <dlfcn.h>
379 #endif
380
381 #ifndef RTLD_LAZY
382 #define RTLD_LAZY 0
383 #endif
384 #ifndef RTLD_NOW
385 #define RTLD_NOW 0
386 #endif
387 #ifndef RTLD_GLOBAL
388 #define RTLD_GLOBAL 0
389 #endif
390
391 #ifndef HAVE_SECURE_MKSTEMP
392 #define mkstemp(path) rep_mkstemp(path)
393 int rep_mkstemp(char *temp);
394 #endif
395
396 #ifndef HAVE_MKDTEMP
397 #define mkdtemp rep_mkdtemp
398 char *rep_mkdtemp(char *template);
399 #endif
400
401 #ifndef HAVE_PREAD
402 #define pread rep_pread
403 ssize_t rep_pread(int __fd, void *__buf, size_t __nbytes, off_t __offset);
404 #endif
405
406 #ifndef HAVE_PWRITE
407 #define pwrite rep_pwrite
408 ssize_t rep_pwrite(int __fd, const void *__buf, size_t __nbytes, off_t __offset);
409 #endif
410
411 #if !defined(HAVE_INET_NTOA) || defined(REPLACE_INET_NTOA)
412 #define inet_ntoa rep_inet_ntoa
413 /* prototype is in "system/network.h" */
414 #endif
415
416 #ifndef HAVE_INET_PTON
417 #define inet_pton rep_inet_pton
418 /* prototype is in "system/network.h" */
419 #endif
420
421 #ifndef HAVE_INET_NTOP
422 #define inet_ntop rep_inet_ntop
423 /* prototype is in "system/network.h" */
424 #endif
425
426 #ifndef HAVE_INET_ATON
427 #define inet_aton rep_inet_aton
428 /* prototype is in "system/network.h" */
429 #endif
430
431 #ifndef HAVE_CONNECT
432 #define connect rep_connect
433 /* prototype is in "system/network.h" */
434 #endif
435
436 #ifndef HAVE_GETHOSTBYNAME
437 #define gethostbyname rep_gethostbyname
438 /* prototype is in "system/network.h" */
439 #endif
440
441 #ifndef HAVE_GETIFADDRS
442 #define getifaddrs rep_getifaddrs
443 /* prototype is in "system/network.h" */
444 #endif
445
446 #ifndef HAVE_FREEIFADDRS
447 #define freeifaddrs rep_freeifaddrs
448 /* prototype is in "system/network.h" */
449 #endif
450
451 #ifdef HAVE_LIMITS_H
452 #include <limits.h>
453 #endif
454
455 #ifdef HAVE_SYS_PARAM_H
456 #include <sys/param.h>
457 #endif
458
459 /* The extra casts work around common compiler bugs.  */
460 #define _TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
461 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
462    It is necessary at least when t == time_t.  */
463 #define _TYPE_MINIMUM(t) ((t) (_TYPE_SIGNED (t) \
464                               ? ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
465 #define _TYPE_MAXIMUM(t) ((t) (~ (t) 0 - _TYPE_MINIMUM (t)))
466
467 #ifndef HOST_NAME_MAX
468 #define HOST_NAME_MAX 255
469 #endif
470
471 /*
472  * Some older systems seem not to have MAXHOSTNAMELEN
473  * defined.
474  */
475 #ifndef MAXHOSTNAMELEN
476 #define MAXHOSTNAMELEN HOST_NAME_MAX
477 #endif
478
479 #ifndef UINT16_MAX
480 #define UINT16_MAX 65535
481 #endif
482
483 #ifndef UINT32_MAX
484 #define UINT32_MAX (4294967295U)
485 #endif
486
487 #ifndef UINT64_MAX
488 #define UINT64_MAX ((uint64_t)-1)
489 #endif
490
491 #ifndef CHAR_BIT
492 #define CHAR_BIT 8
493 #endif
494
495 #ifndef INT32_MAX
496 #define INT32_MAX _TYPE_MAXIMUM(int32_t)
497 #endif
498
499 #ifdef HAVE_STDBOOL_H
500 #include <stdbool.h>
501 #endif
502
503 #if !defined(HAVE_BOOL)
504 #ifdef HAVE__Bool
505 #define bool _Bool
506 #else
507 typedef int bool;
508 #endif
509 #endif
510
511 /*
512  * to prevent <rpcsvc/yp_prot.h> from doing a redefine of 'bool'
513  *
514  * IRIX, HPUX, MacOS 10 and Solaris need BOOL_DEFINED
515  * Tru64 needs _BOOL_EXISTS
516  * AIX needs _BOOL,_TRUE,_FALSE
517  */
518 #ifndef BOOL_DEFINED
519 #define BOOL_DEFINED
520 #endif
521 #ifndef _BOOL_EXISTS
522 #define _BOOL_EXISTS
523 #endif
524 #ifndef _BOOL
525 #define _BOOL
526 #endif
527
528 #ifndef __bool_true_false_are_defined
529 #define __bool_true_false_are_defined
530 #endif
531
532 #ifndef true
533 #define true (1)
534 #endif
535 #ifndef false
536 #define false (0)
537 #endif
538
539 #ifndef _TRUE
540 #define _TRUE true
541 #endif
542 #ifndef _FALSE
543 #define _FALSE false
544 #endif
545
546 #ifndef HAVE_FUNCTION_MACRO
547 #ifdef HAVE_func_MACRO
548 #define __FUNCTION__ __func__
549 #else
550 #define __FUNCTION__ ("")
551 #endif
552 #endif
553
554
555 #ifndef MIN
556 #define MIN(a,b) ((a)<(b)?(a):(b))
557 #endif
558
559 #ifndef MAX
560 #define MAX(a,b) ((a)>(b)?(a):(b))
561 #endif
562
563 #if !defined(HAVE_VOLATILE)
564 #define volatile
565 #endif
566
567 /**
568   this is a warning hack. The idea is to use this everywhere that we
569   get the "discarding const" warning from gcc. That doesn't actually
570   fix the problem of course, but it means that when we do get to
571   cleaning them up we can do it by searching the code for
572   discard_const.
573
574   It also means that other error types aren't as swamped by the noise
575   of hundreds of const warnings, so we are more likely to notice when
576   we get new errors.
577
578   Please only add more uses of this macro when you find it
579   _really_ hard to fix const warnings. Our aim is to eventually use
580   this function in only a very few places.
581
582   Also, please call this via the discard_const_p() macro interface, as that
583   makes the return type safe.
584 */
585 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
586
587 /** Type-safe version of discard_const */
588 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
589
590 #ifndef __STRING
591 #define __STRING(x)    #x
592 #endif
593
594 #ifndef __STRINGSTRING
595 #define __STRINGSTRING(x) __STRING(x)
596 #endif
597
598 #ifndef __LINESTR__
599 #define __LINESTR__ __STRINGSTRING(__LINE__)
600 #endif
601
602 #ifndef __location__
603 #define __location__ __FILE__ ":" __LINESTR__
604 #endif
605
606 /** 
607  * zero a structure 
608  */
609 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
610
611 /** 
612  * zero a structure given a pointer to the structure 
613  */
614 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
615
616 /** 
617  * zero a structure given a pointer to the structure - no zero check 
618  */
619 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
620
621 /* zero an array - note that sizeof(array) must work - ie. it must not be a
622    pointer */
623 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
624
625 /**
626  * work out how many elements there are in a static array 
627  */
628 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
629
630 /** 
631  * pointer difference macro 
632  */
633 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
634
635 #if MMAP_BLACKLIST
636 #undef HAVE_MMAP
637 #endif
638
639 #ifdef __COMPAR_FN_T
640 #define QSORT_CAST (__compar_fn_t)
641 #endif
642
643 #ifndef QSORT_CAST
644 #define QSORT_CAST (int (*)(const void *, const void *))
645 #endif
646
647 #ifndef PATH_MAX
648 #define PATH_MAX 1024
649 #endif
650
651 #ifndef MAX_DNS_NAME_LENGTH
652 #define MAX_DNS_NAME_LENGTH 256 /* Actually 255 but +1 for terminating null. */
653 #endif
654
655 #ifndef HAVE_CRYPT
656 char *ufc_crypt(const char *key, const char *salt);
657 #define crypt ufc_crypt
658 #else
659 #ifdef HAVE_CRYPT_H
660 #include <crypt.h>
661 #endif
662 #endif
663
664 #endif /* _LIBREPLACE_REPLACE_H */