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