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