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