4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2001, 2002, 2003 Bernie Innocenti <bernie@codewiz.org>
34 * \brief Additional support macros for compiler independance
36 * \author Bernie Innocenti <bernie@codewiz.org>
39 #ifndef BERTOS_COMPILER_H
40 #define BERTOS_COMPILER_H
42 #include <cpu/detect.h>
45 #if defined __GNUC__ && defined __GNUC_MINOR__
46 #define GNUC_PREREQ(maj, min) \
47 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
49 #define GNUC_PREREQ(maj, min) 0
52 /* Some CW versions do not allow enabling C99 from the settings panel. */
53 #if defined(__MWERKS__)
57 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
58 #define COMPILER_C99 1
60 #define COMPILER_C99 0
64 /** Concatenate two different preprocessor tokens (allowing macros to expand) */
65 #define PP_CAT(x,y) PP_CAT__(x,y)
66 #define PP_CAT__(x,y) x ## y
67 #define PP_CAT3(x,y,z) PP_CAT(PP_CAT(x,y),z)
68 #define PP_CAT4(x,y,z,w) PP_CAT(PP_CAT3(x,y,z),w)
69 #define PP_CAT5(x,y,z,w,j) PP_CAT(PP_CAT4(x,y,z,w),j)
71 /** String-ize a token (allowing macros to expand) */
72 #define PP_STRINGIZE(x) PP_STRINGIZE__(x)
73 #define PP_STRINGIZE__(x) #x
79 #define COUNT_PARMS2(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _, ...) _
80 #define COUNT_PARMS(...) \
81 COUNT_PARMS2(11 , ## __VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
85 * #define foo_init(...) PP_CAT(foo_init_, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
89 #define COUNT_PARMS2(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _, ...) _
90 #define COUNT_PARMS(args...) \
91 COUNT_PARMS2(11 , ## args, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
95 * #define foo_init(args...) PP_CAT(foo_init_, COUNT_PARMS(args)) (args)
100 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
102 #pragma language=extended
106 #define COMPILER_VARIADIC_MACROS 1
108 #define INTERRUPT(x) __irq __arm void x (void)
109 #define INLINE static inline
111 /* Include some standard C89/C99 stuff */
118 // IAR has size_t as built-in type, but does not define this symbol.
119 #define _SIZE_T_DEFINED
121 #define INTERRUPT(x) interrupt [x]
122 #define REGISTER shortad
123 #define INLINE /* unsupported */
126 * Imported from <longjmp.h>. Unfortunately, we can't just include
127 * this header because it typedefs jmp_buf to be an array of chars.
128 * This would allow the compiler to place the buffer on an odd address.
129 * The CPU _should_ be able to perform word accesses to
130 * unaligned data, but there are *BUGS* in the 80196KC with
131 * some combinations of opcodes and addressing modes. One of
132 * these, "ST SP,[?GR]+" is used in the longjmp() implementation
133 * provided by the IAR compiler ANSI C library. When ?GR contains
134 * an odd address, surprisingly the CPU will copy the high order
135 * byte of the source operand (SP) in the low order byte of the
136 * destination operand (the memory location pointed to by ?GR).
138 * We also need to replace the library setjmp()/longjmp() with
139 * our own versions because the IAR implementation "forgets" to
140 * save the contents of local registers (?LR).
144 void *sp; /* Stack pointer */
145 void *return_addr; /* Return address */
146 int lr[6]; /* 6 local registers */
149 typedef struct _JMP_BUF jmp_buf[1];
151 int setjmp(jmp_buf env);
152 void longjmp(jmp_buf env, int val);
154 /* Fake bool support */
157 typedef unsigned char bool;
160 #error Unsupported CPU
163 #elif defined(_MSC_VER) /* Win32 emulation support */
165 /* MSVC doesn't provide <stdbool.h>. */
170 #endif /* !__cplusplus */
172 /* These C99 functions are oddly named in MSVCRT32.lib */
173 #define snprintf _snprintf
174 #define vsnprintf _vsnprintf
176 /* MSVC doesn't support C99's __func__, but has a similar extension. */
177 #define __func__ __FUNCTION__
179 /* MSVC doesn't support C99's inline keyword */
181 #define INLINE __inline
184 #elif defined(__GNUC__)
186 /* Compiler features */
187 #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
188 #define COMPILER_TYPEOF 1
189 #define COMPILER_STATEMENT_EXPRESSIONS 1
192 #define FORMAT(type,fmt,first) __attribute__((__format__(type, fmt, first)))
193 #define NORETURN __attribute__((__noreturn__))
194 #define UNUSED_ARG(type,arg) __attribute__((__unused__)) type arg
195 #define UNUSED_VAR(type,name) __attribute__((__unused__)) type name
196 #define USED_VAR(type,name) __attribute__((__used__)) type name
197 #define INLINE static inline __attribute__((__always_inline__))
198 #define NOINLINE __attribute__((noinline))
199 #define LIKELY(x) __builtin_expect(!!(x), 1)
200 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
201 #define PURE_FUNC __attribute__((pure))
202 #define CONST_FUNC __attribute__((const))
203 #define UNUSED_FUNC __attribute__((unused))
204 #define USED_FUNC __attribute__((__used__))
205 #define RESTRICT __restrict__
206 #define MUST_CHECK __attribute__((warn_unused_result))
207 #define PACKED __attribute__((packed))
208 #if CPU_ARM | CPU_CM3
209 #define NAKED __attribute__((naked))
215 * Force compiler to realod context variable.
217 #define MEMORY_BARRIER asm volatile ("" : : : "memory")
220 #define DEPRECATED __attribute__((__deprecated__))
224 #define UNREACHABLE() __builtin_unreachable()
228 #define ASSERT_TYPE_EQUAL(var1, var2) \
229 STATIC_ASSERT(__builtin_types_compatible_p(typeof(var1), typeof(var2)))
230 #define ASSERT_TYPE_IS(var, type) \
231 STATIC_ASSERT(__builtin_types_compatible_p(typeof(var), type))
234 /* Include some standard C89/C99 stuff */
239 #include <sys/types.h> /* for ssize_t */
244 * Disallow some C++ keywords as identifiers in C programs,
245 * for improved portability.
247 #pragma GCC poison new delete class template typename
248 #pragma GCC poison private protected public operator
249 #pragma GCC poison friend mutable using namespace
250 #pragma GCC poison cin cout cerr clog
255 #elif defined(__MWERKS__)
257 /* Compiler features */
258 #define COMPILER_VARIADIC_MACROS 1
259 #define COMPILER_TYPEOF 1
260 #define COMPILER_STATEMENT_EXPRESSIONS 1
262 #define typeof __typeof__
264 #define UNUSED_ARG(type,arg) type
270 // CodeWarrior has size_t as built-in type, but does not define this symbol.
271 #define _SIZE_T_DEFINED
274 #error unknown compiler
278 /* Defaults for compiler extensions. */
281 * \def COMPILER_VARIADIC_MACROS
282 * Support for macros with variable arguments.
284 #ifndef COMPILER_VARIADIC_MACROS
285 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
289 * \def COMPILER_TYPEOF
290 * Support for dynamic type identification.
292 #ifndef COMPILER_TYPEOF
293 #define COMPILER_TYPEOF 0
297 * \def COMPILER_STATEMENT_EXPRESSIONS
298 * Support for statement expressions.
300 #ifndef COMPILER_STATEMENT_EXPRESSIONS
301 #define COMPILER_STATEMENT_EXPRESSIONS 0
304 /* A few defaults for missing compiler features. */
306 #define INLINE static inline
309 #define NOINLINE /* nothing */
312 #define NORETURN /* nothing */
315 #define FORMAT(type,fmt,first) /* nothing */
318 #define DEPRECATED /* nothing */
321 #define UNUSED_ARG(type,arg) type arg
324 #define UNUSED_VAR(type,name) type name
327 #define USED_VAR(type,name) type name
330 #define REGISTER /* nothing */
336 #define UNLIKELY(x) x
339 #define PURE_FUNC /* nothing */
342 #define CONST_FUNC /* nothing */
345 #define UNUSED_FUNC /* nothing */
348 #define USED_FUNC /* nothing */
351 #define RESTRICT /* nothing */
354 #define MUST_CHECK /* nothing */
357 #define PACKED /* nothing */
359 #ifndef MEMORY_BARRIER
360 #define MEMORY_BARRIER /* nothing */
361 #warning No memory barrier defined for select compiler. If you use the kernel check it.
364 #define UNREACHABLE() for (;;)
368 /* Misc definitions */
370 #define NULL (void *)0
376 /* Support for hybrid C/C++ applications. */
378 #define EXTERN_C extern "C"
379 #define EXTERN_C_BEGIN extern "C" {
380 #define EXTERN_C_END }
381 #define EXTERN_CONST extern const
382 #define CONST_CAST(TYPE,EXPR) (const_cast<TYPE>(EXPR))
384 #define EXTERN_C extern
385 #define EXTERN_C_BEGIN /* nothing */
386 #define EXTERN_C_END /* nothing */
387 #define EXTERN_CONST const
388 #define CONST_CAST(TYPE,EXPR) ((TYPE)(EXPR)) /* FIXME: How can we suppress the warning in C? */
392 #if defined(_MSC_VER) \
393 || ((defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) && CPU_I196)
395 * \name ISO C99 fixed-size types
397 * These should be in <stdint.h>, but a few compilers lack them.
400 typedef signed char int8_t;
401 typedef unsigned char uint8_t;
402 typedef short int int16_t;
403 typedef unsigned short int uint16_t;
404 typedef long int int32_t; /* _WIN64 safe */
405 typedef unsigned long int uint32_t; /* _WIN64 safe */
408 typedef __int64 int64_t;
409 typedef unsigned __int64 uint64_t;
411 typedef long long int64_t;
412 typedef unsigned long long uint64_t;
416 /* This is the standard location. */
422 * The ATmega8 has a very small Flash, so we can't afford
423 * to link in support routines for 32bit integer arithmetic.
425 typedef int16_t ticks_t; /**< Type for time expressed in ticks. */
426 typedef int16_t mtime_t; /**< Type for time expressed in milliseconds. */
427 typedef int16_t utime_t; /**< Type for time expressed in microseconds. */
428 #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
429 #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
430 #define MTIME_INFINITE 0x7FFFL
432 typedef int32_t ticks_t; /**< Type for time expressed in ticks. */
434 typedef int32_t utime_t; /**< Type for time expressed in microseconds. */
435 #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
437 #ifndef DEVLIB_MTIME_DEFINED
438 #define DEVLIB_MTIME_DEFINED 1 /* Resolve conflict with <os/hptime.h> */
439 typedef int32_t mtime_t; /**< Type for time expressed in milliseconds. */
440 #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
441 #define MTIME_INFINITE 0x7FFFFFFFL
445 /** Bulk storage large enough for both pointers or integers. */
446 typedef void * iptr_t;
448 /** Bulk storage large enough for both pointers to constants or integers. */
449 typedef const void * const_iptr_t;
451 typedef unsigned char sigbit_t; /**< Type for signal bits. */
452 typedef unsigned char sigmask_t; /**< Type for signal masks. */
456 * \name Standard type definitions.
458 * These should be in <sys/types.h> or <stddef.h>, but many compilers
459 * and C libraries lack them.
461 * We check for some common definitions to avoid redefinitions:
463 * glibc, avr-libc: _SIZE_T_DEFINED, __ssize_t_defined
464 * Darwin libc: _BSD_SIZE_T_DEFINED_, _SIZE_T
469 #if !(defined(size_t) || defined(_SIZE_T_DEFINED) || defined(_BSD_SIZE_T_DEFINED_) \
472 /* 32bit or 64bit (32bit for _WIN64). */
473 typedef unsigned long size_t;
479 #if !(defined(ssize_t) || defined(_SSIZE_T) || defined(__ssize_t_defined))
481 /* 32bit or 64bit (32bit for _WIN64). */
482 typedef long ssize_t;
483 #elif CPU_ARM || CPU_CM3
486 /* 16bit (missing in avr-libc's sys/types.h). */
496 * \name Types for hardware registers.
498 * Only use these types for registers whose contents can
499 * be changed asynchronously by external hardware.
504 /* Registers can be accessed only through 16-bit pointers */
505 typedef volatile uint16_t reg16_t;
507 typedef volatile uint8_t reg8_t;
508 typedef volatile uint16_t reg16_t;
509 typedef volatile uint32_t reg32_t;
514 /* Quasi-ANSI macros */
517 * Return the byte offset of the member \a m in struct \a s.
519 * \note This macro should be defined in "stddef.h" and is sometimes
520 * compiler-specific (g++ has a builtin for it).
522 #define offsetof(s,m) (size_t)&(((s *)0)->m)
526 * Count the number of elements in the static array \a a.
528 * \note This macro is non-standard, but implements a very common idiom
530 #define countof(a) (sizeof(a) / sizeof(*(a)))
534 * Return the alignment in memory of a generic data type.
536 * \note We need to worry about alignment when allocating memory that
537 * will be used later by unknown objects (e.g., malloc()) or, more
538 * generally, whenever creating generic container types.
540 #define alignof(type) offsetof(struct { char c; type member; }, member)
544 * Cast a member of a structure out to the containing structure.
546 * \param ptr the pointer to the member.
547 * \param type the type of the container struct this is embedded in.
548 * \param member the name of the member within the struct.
550 #if COMPILER_TYPEOF && COMPILER_STATEMENT_EXPRESSIONS
551 #define containerof(ptr, type, member) ({ \
552 typeof( ((type *)0)->member ) *_mptr = (ptr); /* type check */ \
553 (type *)(void *)((char *)_mptr - offsetof(type, member)); \
556 #define containerof(ptr, type, member) \
557 ( (type *)(void *)((char *)(ptr) - offsetof(type, member)) )
560 /** Issue a compilation error if the \a condition is false */
561 #define STATIC_ASSERT(condition) \
562 UNUSED_VAR(extern char, STATIC_ASSERTION_FAILED__[(condition) ? 1 : -1])
564 #ifndef ASSERT_TYPE_EQUAL
565 /** Ensure two variables have the same type. */
566 #define ASSERT_TYPE_EQUAL(var1, var2) \
567 do { (void)(&(var1) == &(var2)); } while(0)
570 #ifndef ASSERT_TYPE_IS
571 /** Ensure variable is of specified type. */
572 #define ASSERT_TYPE_IS(var, type) \
573 do { (void)(&(var) == (type *)0); } while(0)
576 #endif /* BERTOS_COMPILER_H */