source: trunk/samba/source/lib/replace/replace.h @ 30

Last change on this file since 30 was 30, checked in by Paul Smedley, 14 years ago

Code updated to Samba 3.0.25rc2 level

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