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