BadVPN – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /**
2 * @file
3 * Support for different processor and compiler architectures
4 */
5  
6 /*
7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without modification,
11 * are permitted provided that the following conditions are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30 * OF SUCH DAMAGE.
31 *
32 * This file is part of the lwIP TCP/IP stack.
33 *
34 * Author: Adam Dunkels <adam@sics.se>
35 *
36 */
37 #ifndef LWIP_HDR_ARCH_H
38 #define LWIP_HDR_ARCH_H
39  
40 #include "arch/cc.h"
41  
42 #ifndef LITTLE_ENDIAN
43 #define LITTLE_ENDIAN 1234
44 #endif
45  
46 #ifndef BIG_ENDIAN
47 #define BIG_ENDIAN 4321
48 #endif
49  
50 /**
51 * @defgroup compiler_abstraction Compiler/platform abstraction
52 * @ingroup sys_layer
53 * All defines related to this section must not be placed in lwipopts.h,
54 * but in arch/cc.h!
55 * These options cannot be \#defined in lwipopts.h since they are not options
56 * of lwIP itself, but options of the lwIP port to your system.
57 * @{
58 */
59  
60 /** Define the byte order of the system.
61 * Needed for conversion of network data to host byte order.
62 * Allowed values: LITTLE_ENDIAN and BIG_ENDIAN
63 */
64 #ifndef BYTE_ORDER
65 #define BYTE_ORDER LITTLE_ENDIAN
66 #endif
67  
68 /** Define random number generator function of your system */
69 #ifdef __DOXYGEN__
70 #define LWIP_RAND() ((u32_t)rand())
71 #endif
72  
73 /** Platform specific diagnostic output.\n
74 * Note the default implementation pulls in printf, which may
75 * in turn pull in a lot of standard libary code. In resource-constrained
76 * systems, this should be defined to something less resource-consuming.
77 */
78 #ifndef LWIP_PLATFORM_DIAG
79 #define LWIP_PLATFORM_DIAG(x) do {printf x;} while(0)
80 #include <stdio.h>
81 #include <stdlib.h>
82 #endif
83  
84 /** Platform specific assertion handling.\n
85 * Note the default implementation pulls in printf, fflush and abort, which may
86 * in turn pull in a lot of standard libary code. In resource-constrained
87 * systems, this should be defined to something less resource-consuming.
88 */
89 #ifndef LWIP_PLATFORM_ASSERT
90 #define LWIP_PLATFORM_ASSERT(x) do {printf("Assertion \"%s\" failed at line %d in %s\n", \
91 x, __LINE__, __FILE__); fflush(NULL); abort();} while(0)
92 #include <stdio.h>
93 #include <stdlib.h>
94 #endif
95  
96 /** Define this to 1 in arch/cc.h of your port if you do not want to
97 * include stddef.h header to get size_t. You need to typedef size_t
98 * by yourself in this case.
99 */
100 #ifndef LWIP_NO_STDDEF_H
101 #define LWIP_NO_STDDEF_H 0
102 #endif
103  
104 #if !LWIP_NO_STDDEF_H
105 #include <stddef.h> /* for size_t */
106 #endif
107  
108 /** Define this to 1 in arch/cc.h of your port if your compiler does not provide
109 * the stdint.h header. You need to typedef the generic types listed in
110 * lwip/arch.h yourself in this case (u8_t, u16_t...).
111 */
112 #ifndef LWIP_NO_STDINT_H
113 #define LWIP_NO_STDINT_H 0
114 #endif
115  
116 /* Define generic types used in lwIP */
117 #if !LWIP_NO_STDINT_H
118 #include <stdint.h>
119 /* stdint.h is C99 which should also provide support for 64-bit integers */
120 #if !defined(LWIP_HAVE_INT64) && defined(UINT64_MAX)
121 #define LWIP_HAVE_INT64 1
122 #endif
123 typedef uint8_t u8_t;
124 typedef int8_t s8_t;
125 typedef uint16_t u16_t;
126 typedef int16_t s16_t;
127 typedef uint32_t u32_t;
128 typedef int32_t s32_t;
129 #if LWIP_HAVE_INT64
130 typedef uint64_t u64_t;
131 typedef int64_t s64_t;
132 #endif
133 typedef uintptr_t mem_ptr_t;
134 #endif
135  
136 /** Define this to 1 in arch/cc.h of your port if your compiler does not provide
137 * the inttypes.h header. You need to define the format strings listed in
138 * lwip/arch.h yourself in this case (X8_F, U16_F...).
139 */
140 #ifndef LWIP_NO_INTTYPES_H
141 #define LWIP_NO_INTTYPES_H 0
142 #endif
143  
144 /* Define (sn)printf formatters for these lwIP types */
145 #if !LWIP_NO_INTTYPES_H
146 #include <inttypes.h>
147 #ifndef X8_F
148 #define X8_F "02" PRIx8
149 #endif
150 #ifndef U16_F
151 #define U16_F PRIu16
152 #endif
153 #ifndef S16_F
154 #define S16_F PRId16
155 #endif
156 #ifndef X16_F
157 #define X16_F PRIx16
158 #endif
159 #ifndef U32_F
160 #define U32_F PRIu32
161 #endif
162 #ifndef S32_F
163 #define S32_F PRId32
164 #endif
165 #ifndef X32_F
166 #define X32_F PRIx32
167 #endif
168 #ifndef SZT_F
169 #define SZT_F PRIuPTR
170 #endif
171 #endif
172  
173 /** Define this to 1 in arch/cc.h of your port if your compiler does not provide
174 * the limits.h header. You need to define the type limits yourself in this case
175 * (e.g. INT_MAX, SSIZE_MAX).
176 */
177 #ifndef LWIP_NO_LIMITS_H
178 #define LWIP_NO_LIMITS_H 0
179 #endif
180  
181 /* Include limits.h? */
182 #if !LWIP_NO_LIMITS_H
183 #include <limits.h>
184 #endif
185  
186 /* Do we need to define ssize_t? This is a compatibility hack:
187 * Unfortunately, this type seems to be unavailable on some systems (even if
188 * sys/types or unistd.h are available).
189 * Being like that, we define it to 'int' if SSIZE_MAX is not defined.
190 */
191 #ifdef SSIZE_MAX
192 /* If SSIZE_MAX is defined, unistd.h should provide the type as well */
193 #ifndef LWIP_NO_UNISTD_H
194 #define LWIP_NO_UNISTD_H 0
195 #endif
196 #if !LWIP_NO_UNISTD_H
197 #include <unistd.h>
198 #endif
199 #else /* SSIZE_MAX */
200 typedef int ssize_t;
201 #define SSIZE_MAX INT_MAX
202 #endif /* SSIZE_MAX */
203  
204 /** C++ const_cast<target_type>(val) equivalent to remove constness from a value (GCC -Wcast-qual) */
205 #ifndef LWIP_CONST_CAST
206 #define LWIP_CONST_CAST(target_type, val) ((target_type)((ptrdiff_t)val))
207 #endif
208  
209 /** Get rid of alignment cast warnings (GCC -Wcast-align) */
210 #ifndef LWIP_ALIGNMENT_CAST
211 #define LWIP_ALIGNMENT_CAST(target_type, val) LWIP_CONST_CAST(target_type, val)
212 #endif
213  
214 /** Get rid of warnings related to pointer-to-numeric and vice-versa casts,
215 * e.g. "conversion from 'u8_t' to 'void *' of greater size"
216 */
217 #ifndef LWIP_PTR_NUMERIC_CAST
218 #define LWIP_PTR_NUMERIC_CAST(target_type, val) LWIP_CONST_CAST(target_type, val)
219 #endif
220  
221 /** Allocates a memory buffer of specified size that is of sufficient size to align
222 * its start address using LWIP_MEM_ALIGN.
223 * You can declare your own version here e.g. to enforce alignment without adding
224 * trailing padding bytes (see LWIP_MEM_ALIGN_BUFFER) or your own section placement
225 * requirements.\n
226 * e.g. if you use gcc and need 32 bit alignment:\n
227 * \#define LWIP_DECLARE_MEMORY_ALIGNED(variable_name, size) u8_t variable_name[size] \_\_attribute\_\_((aligned(4)))\n
228 * or more portable:\n
229 * \#define LWIP_DECLARE_MEMORY_ALIGNED(variable_name, size) u32_t variable_name[(size + sizeof(u32_t) - 1) / sizeof(u32_t)]
230 */
231 #ifndef LWIP_DECLARE_MEMORY_ALIGNED
232 #define LWIP_DECLARE_MEMORY_ALIGNED(variable_name, size) u8_t variable_name[LWIP_MEM_ALIGN_BUFFER(size)]
233 #endif
234  
235 /** Calculate memory size for an aligned buffer - returns the next highest
236 * multiple of MEM_ALIGNMENT (e.g. LWIP_MEM_ALIGN_SIZE(3) and
237 * LWIP_MEM_ALIGN_SIZE(4) will both yield 4 for MEM_ALIGNMENT == 4).
238 */
239 #ifndef LWIP_MEM_ALIGN_SIZE
240 #define LWIP_MEM_ALIGN_SIZE(size) (((size) + MEM_ALIGNMENT - 1U) & ~(MEM_ALIGNMENT-1U))
241 #endif
242  
243 /** Calculate safe memory size for an aligned buffer when using an unaligned
244 * type as storage. This includes a safety-margin on (MEM_ALIGNMENT - 1) at the
245 * start (e.g. if buffer is u8_t[] and actual data will be u32_t*)
246 */
247 #ifndef LWIP_MEM_ALIGN_BUFFER
248 #define LWIP_MEM_ALIGN_BUFFER(size) (((size) + MEM_ALIGNMENT - 1U))
249 #endif
250  
251 /** Align a memory pointer to the alignment defined by MEM_ALIGNMENT
252 * so that ADDR % MEM_ALIGNMENT == 0
253 */
254 #ifndef LWIP_MEM_ALIGN
255 #define LWIP_MEM_ALIGN(addr) ((void *)(((mem_ptr_t)(addr) + MEM_ALIGNMENT - 1) & ~(mem_ptr_t)(MEM_ALIGNMENT-1)))
256 #endif
257  
258 #ifdef __cplusplus
259 extern "C" {
260 #endif
261  
262 /** Packed structs support.
263 * Placed BEFORE declaration of a packed struct.\n
264 * For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
265 * A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
266 */
267 #ifndef PACK_STRUCT_BEGIN
268 #define PACK_STRUCT_BEGIN
269 #endif /* PACK_STRUCT_BEGIN */
270  
271 /** Packed structs support.
272 * Placed AFTER declaration of a packed struct.\n
273 * For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
274 * A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
275 */
276 #ifndef PACK_STRUCT_END
277 #define PACK_STRUCT_END
278 #endif /* PACK_STRUCT_END */
279  
280 /** Packed structs support.
281 * Placed between end of declaration of a packed struct and trailing semicolon.\n
282 * For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
283 * A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
284 */
285 #ifndef PACK_STRUCT_STRUCT
286 #if defined(__GNUC__) || defined(__clang__)
287 #define PACK_STRUCT_STRUCT __attribute__((packed))
288 #else
289 #define PACK_STRUCT_STRUCT
290 #endif
291 #endif /* PACK_STRUCT_STRUCT */
292  
293 /** Packed structs support.
294 * Wraps u32_t and u16_t members.\n
295 * For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
296 * A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
297 */
298 #ifndef PACK_STRUCT_FIELD
299 #define PACK_STRUCT_FIELD(x) x
300 #endif /* PACK_STRUCT_FIELD */
301  
302 /** Packed structs support.
303 * Wraps u8_t members, where some compilers warn that packing is not necessary.\n
304 * For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
305 * A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
306 */
307 #ifndef PACK_STRUCT_FLD_8
308 #define PACK_STRUCT_FLD_8(x) PACK_STRUCT_FIELD(x)
309 #endif /* PACK_STRUCT_FLD_8 */
310  
311 /** Packed structs support.
312 * Wraps members that are packed structs themselves, where some compilers warn that packing is not necessary.\n
313 * For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
314 * A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
315 */
316 #ifndef PACK_STRUCT_FLD_S
317 #define PACK_STRUCT_FLD_S(x) PACK_STRUCT_FIELD(x)
318 #endif /* PACK_STRUCT_FLD_S */
319  
320 /** PACK_STRUCT_USE_INCLUDES==1: Packed structs support using \#include files before and after struct to be packed.\n
321 * The file included BEFORE the struct is "arch/bpstruct.h".\n
322 * The file included AFTER the struct is "arch/epstruct.h".\n
323 * This can be used to implement struct packing on MS Visual C compilers, see
324 * the Win32 port in the lwIP contrib repository for reference.
325 * For examples of packed struct declarations, see include/lwip/prot/ subfolder.\n
326 * A port to GCC/clang is included in lwIP, if you use these compilers there is nothing to do here.
327 */
328 #ifdef __DOXYGEN__
329 #define PACK_STRUCT_USE_INCLUDES
330 #endif
331  
332 /** Eliminates compiler warning about unused arguments (GCC -Wextra -Wunused). */
333 #ifndef LWIP_UNUSED_ARG
334 #define LWIP_UNUSED_ARG(x) (void)x
335 #endif /* LWIP_UNUSED_ARG */
336  
337 /** LWIP_PROVIDE_ERRNO==1: Let lwIP provide ERRNO values and the 'errno' variable.
338 * If this is disabled, cc.h must either define 'errno', include <errno.h>,
339 * define LWIP_ERRNO_STDINCLUDE to get <errno.h> included or
340 * define LWIP_ERRNO_INCLUDE to <errno.h> or equivalent.
341 */
342 #if defined __DOXYGEN__
343 #define LWIP_PROVIDE_ERRNO
344 #endif
345  
346 /**
347 * @}
348 */
349  
350 #ifdef __cplusplus
351 }
352 #endif
353  
354 #endif /* LWIP_HDR_ARCH_H */