Doc fixes.
[bertos.git] / cfg / compiler.h
old mode 100755 (executable)
new mode 100644 (file)
index ba64519..a303dc7
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2001, 2002, 2003 Bernardo Innocenti <bernie@codewiz.org>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Additional support macros for compiler independance
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.6  2005/07/19 07:27:31  bernie
- *#* Don't use CPU_REG_BITS from cpu.h to avoid circular header dependendy.
- *#*
- *#* Revision 1.5  2005/06/27 21:24:37  bernie
- *#* ticks_t: New typedef.
- *#*
- *#* Revision 1.4  2005/06/14 06:15:10  bernie
- *#* Add X86_64 support.
- *#*
- *#* Revision 1.3  2005/04/12 01:37:01  bernie
- *#* Metrowerks touchups from HeCo.
- *#*
- *#* Revision 1.2  2005/04/11 19:10:27  bernie
- *#* Include top-level headers from cfg/ subdir.
- *#*
- *#* Revision 1.1  2005/04/11 19:04:13  bernie
- *#* Move top-level headers to cfg/ subdir.
- *#*
- *#* Revision 1.44  2005/03/29 06:39:59  bernie
- *#* setjmp.h, time_t: Remove ancient retrocompatibility; Remove MSVC double to float hack.
- *#*
- *#* Revision 1.43  2005/03/01 23:15:12  bernie
- *#* Remove compatibility hack.
- *#*
- *#* Revision 1.42  2005/02/16 20:28:46  bernie
- *#* Move PGM macros to mware/pgm.h
- *#*
- *#* Revision 1.41  2005/01/22 04:19:22  bernie
- *#* MTIME_INFINITE: New constant.
- *#*
- *#* Revision 1.40  2005/01/20 18:46:04  aleph
- *#* Add progmem datatypes; PSTR() definition.
- *#*/
-#ifndef DEVLIB_COMPILER_H
-#define DEVLIB_COMPILER_H
-
-#include <cfg/cpu_detect.h>
+#ifndef BERTOS_COMPILER_H
+#define BERTOS_COMPILER_H
+
+#include <cpu/detect.h>
 
 
 #if defined __GNUC__ && defined __GNUC_MINOR__
 #endif
 
 
-/*! Concatenate two different preprocessor tokens (allowing macros to expand) */
+/** Concatenate two different preprocessor tokens (allowing macros to expand) */
 #define PP_CAT(x,y)         PP_CAT__(x,y)
 #define PP_CAT__(x,y)       x ## y
 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
 
-/*! String-ize a token (allowing macros to expand) */
+/** String-ize a token (allowing macros to expand) */
 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
 #define PP_STRINGIZE__(x)   #x
 
 
 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
+
        #pragma language=extended
-       #define INTERRUPT(x)  interrupt [x]
-       #define REGISTER      shortad
-       #define INLINE        /* unsupported */
 
-       /*
-        * Imported from <longjmp.h>. Unfortunately, we can't just include
-        * this header because it typedefs jmp_buf to be an array of chars.
-        * This would allow the compiler to place the buffer on an odd address.
-        * The CPU _should_ be able to perform word accesses to
-        * unaligned data, but there are *BUGS* in the 80196KC with
-        * some combinations of opcodes and addressing modes. One of
-        * these, "ST SP,[?GR]+" is used in the longjmp() implementation
-        * provided by the IAR compiler ANSI C library. When ?GR contains
-        * an odd address, surprisingly the CPU will copy the high order
-        * byte of the source operand (SP) in the low order byte of the
-        * destination operand (the memory location pointed to by ?GR).
-        *
-        * We also need to replace the library setjmp()/longjmp() with
-        * our own versions because the IAR implementation "forgets" to
-        * save the contents of local registers (?LR).
-        */
-       struct _JMP_BUF
-       {
-               void *sp;           /* Stack pointer */
-               void *return_addr;  /* Return address */
-               int lr[6];          /* 6 local registers */
-       };
+       #if CPU_ARM
+
+               #define COMPILER_VARIADIC_MACROS 1
+
+               #define INTERRUPT(x)  __irq __arm void x (void)
+               #define INLINE        static inline
+
+               /* Include some standard C89/C99 stuff */
+               #include <stddef.h>
+               #include <stdint.h>
+               #include <stdbool.h>
+
+       #elif CPU_I196
 
-       typedef struct _JMP_BUF jmp_buf[1];
+               // IAR has size_t as built-in type, but does not define this symbol.
+               #define _SIZE_T_DEFINED
 
-       int setjmp(jmp_buf env);
-       void longjmp(jmp_buf env, int val);
+               #define INTERRUPT(x)  interrupt [x]
+               #define REGISTER      shortad
+               #define INLINE        /* unsupported */
 
-       /* Fake bool support */
-       #define true (1==1)
-       #define false (1!=1)
-       typedef unsigned char bool;
+               /*
+                * Imported from <longjmp.h>. Unfortunately, we can't just include
+                * this header because it typedefs jmp_buf to be an array of chars.
+                * This would allow the compiler to place the buffer on an odd address.
+                * The CPU _should_ be able to perform word accesses to
+                * unaligned data, but there are *BUGS* in the 80196KC with
+                * some combinations of opcodes and addressing modes. One of
+                * these, "ST SP,[?GR]+" is used in the longjmp() implementation
+                * provided by the IAR compiler ANSI C library. When ?GR contains
+                * an odd address, surprisingly the CPU will copy the high order
+                * byte of the source operand (SP) in the low order byte of the
+                * destination operand (the memory location pointed to by ?GR).
+                *
+                * We also need to replace the library setjmp()/longjmp() with
+                * our own versions because the IAR implementation "forgets" to
+                * save the contents of local registers (?LR).
+                */
+               struct _JMP_BUF
+               {
+                       void *sp;           /* Stack pointer */
+                       void *return_addr;  /* Return address */
+                       int lr[6];          /* 6 local registers */
+               };
+
+               typedef struct _JMP_BUF jmp_buf[1];
+
+               int setjmp(jmp_buf env);
+               void longjmp(jmp_buf env, int val);
+
+               /* Fake bool support */
+               #define true (1==1)
+               #define false (1!=1)
+               typedef unsigned char bool;
+
+       #else
+               #error Unsupported CPU
+       #endif
 
 #elif defined(_MSC_VER) /* Win32 emulation support */
 
        #define snprintf _snprintf
        #define vsnprintf _vsnprintf
 
+       /* MSVC doesn't support C99's __func__, but has a similar extension. */
+       #define __func__ __FUNCTION__
+
+       /* MSVC doesn't support C99's inline keyword */
+       #ifndef __cplusplus
+               #define INLINE __inline
+       #endif
+
 #elif defined(__GNUC__)
 
        /* Compiler features */
        #define USED_FUNC               __attribute__((__used__))
        #define RESTRICT                __restrict__
        #define MUST_CHECK              __attribute__((warn_unused_result))
+       #define PACKED                  __attribute__((packed))
+       /**
+        * Force compiler to realod context variable.
+        */
+       #define MEMORY_BARRIER           asm volatile ("" : : : "memory")
+
        #if GNUC_PREREQ(3,1)
                #define DEPRECATED  __attribute__((__deprecated__))
        #endif
 
+       #ifndef __cplusplus
+               #define ASSERT_TYPE_EQUAL(var1, var2) \
+                       STATIC_ASSERT(__builtin_types_compatible_p(typeof(var1), typeof(var2)))
+               #define ASSERT_TYPE_IS(var, type) \
+                       STATIC_ASSERT(__builtin_types_compatible_p(typeof(var), type))
+       #endif
+
        /* Include some standard C89/C99 stuff */
        #include <stddef.h>
+       #include <stdint.h>
        #include <stdbool.h>
+       #if !CPU_AVR
+       #include <sys/types.h> /* for ssize_t */
+       #endif
 
        #ifndef __cplusplus
                /*
                #pragma GCC poison cin cout cerr clog
        #endif
 
+
+
 #elif defined(__MWERKS__)
 
        /* Compiler features */
 
        #define UNUSED_ARG(type,arg)    type
 
-       #include <stdint.h>
        #include <stddef.h>
+       #include <stdint.h>
        #include <stdbool.h>
 
        // CodeWarrior has size_t as built-in type, but does not define this symbol.
 
 /* Defaults for compiler extensions. */
 
-/*!
+/**
  * \def COMPILER_VARIADIC_MACROS
  * Support for macros with variable arguments.
  */
 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
 #endif
 
-/*!
+/**
  * \def COMPILER_TYPEOF
- * Support for macros with variable arguments.
+ * Support for dynamic type identification.
  */
 #ifndef COMPILER_TYPEOF
 #define COMPILER_TYPEOF 0
 #endif
 
-/*!
+/**
  * \def COMPILER_STATEMENT_EXPRESSIONS
- * Support for macros with variable arguments.
+ * Support for statement expressions.
  */
 #ifndef COMPILER_STATEMENT_EXPRESSIONS
 #define COMPILER_STATEMENT_EXPRESSIONS 0
 #ifndef REGISTER
 #define REGISTER               /* nothing */
 #endif
-#ifndef INTERRUPT
-#define INTERRUPT(x)           ERROR_NOT_IMPLEMENTED
-#endif
 #ifndef LIKELY
 #define LIKELY(x)              x
 #endif
 #ifndef MUST_CHECK
 #define MUST_CHECK             /* nothing */
 #endif
+#ifndef PACKED
+#define PACKED                 /* nothing */
+#endif
+#ifndef MEMORY_BARRIER
+#define MEMORY_BARRIER         /* nothing */
+#warning No memory barrier defined for select compiler. If you use the kernel check it.
+#endif
+
 
 /* Misc definitions */
 #ifndef NULL
 #define        EOF   (-1)
 #endif
 
-
 /* Support for hybrid C/C++ applications. */
 #ifdef __cplusplus
        #define EXTERN_C        extern "C"
        #define EXTERN_C_BEGIN  extern "C" {
        #define EXTERN_C_END    }
+       #define EXTERN_CONST    extern const
+       #define CONST_CAST(TYPE,EXPR)   (const_cast<TYPE>(EXPR))
 #else
        #define EXTERN_C        extern
        #define EXTERN_C_BEGIN  /* nothing */
        #define EXTERN_C_END    /* nothing */
+       #define EXTERN_CONST    const
+       #define CONST_CAST(TYPE,EXPR)   ((TYPE)(EXPR)) /* FIXME: How can we suppress the warning in C? */
 #endif
 
 
-#if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
-       /*!
+#if defined(_MSC_VER) \
+       || ((defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) && CPU_I196)
+       /**
         * \name ISO C99 fixed-size types
         *
-        * These should be in <stdint.h>, but many compilers lack them.
+        * These should be in <stdint.h>, but a few compilers lack them.
         * \{
         */
        typedef signed char         int8_t;
                typedef unsigned long long   uint64_t;
        #endif
        /* \} */
-#elif defined(__GNUC__) && CPU_AVR
-       /* avr-libc is weird... (Fixed in avr-libc-1.2, hack to be removed soon) */
-       #include <inttypes.h>
 #else
-       /* This is the correct location. */
+       /* This is the standard location. */
        #include <stdint.h>
 #endif
 
         * The ATmega8 has a very small Flash, so we can't afford
         * to link in support routines for 32bit integer arithmetic.
         */
-       typedef int16_t ticks_t;  /*!< Type for time expressed in ticks. */
-       typedef int16_t mtime_t;  /*!< Type for time expressed in milliseconds. */
-       typedef int16_t utime_t;  /*!< Type for time expressed in microseconds. */
+       typedef int16_t ticks_t;  /**< Type for time expressed in ticks. */
+       typedef int16_t mtime_t;  /**< Type for time expressed in milliseconds. */
+       typedef int16_t utime_t;  /**< Type for time expressed in microseconds. */
        #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
        #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
        #define MTIME_INFINITE 0x7FFFL
 #else
-       typedef int32_t ticks_t;  /*!< Type for time expressed in ticks. */
-       typedef int32_t mtime_t;  /*!< Type for time expressed in milliseconds. */
-       typedef int32_t utime_t;  /*!< Type for time expressed in microseconds. */
-       #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
+       typedef int32_t ticks_t;  /**< Type for time expressed in ticks. */
+
+       typedef int32_t utime_t;  /**< Type for time expressed in microseconds. */
        #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
-       #define MTIME_INFINITE 0x7FFFFFFFL
+
+       #ifndef DEVLIB_MTIME_DEFINED
+               #define DEVLIB_MTIME_DEFINED 1 /* Resolve conflict with <os/hptime.h> */
+               typedef int32_t mtime_t;  /**< Type for time expressed in milliseconds. */
+               #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
+               #define MTIME_INFINITE 0x7FFFFFFFL
+       #endif
 #endif
 
-/*! Bulk storage large enough for both pointers or integers. */
+/** Bulk storage large enough for both pointers or integers. */
 typedef void * iptr_t;
 
-/*! Bulk storage large enough for both pointers to constants or integers. */
+/** Bulk storage large enough for both pointers to constants or integers. */
 typedef const void * const_iptr_t;
 
-typedef unsigned char sig_t;     /*!< Type for signal bits. */
-typedef unsigned char sigmask_t; /*!< Type for signal masks. */
-typedef unsigned char page_t;    /*!< Type for banked memory pages. */
+typedef unsigned char sigbit_t;  /**< Type for signal bits. */
+typedef unsigned char sigmask_t; /**< Type for signal masks. */
+typedef unsigned char page_t;    /**< Type for banked memory pages. */
 
 
-/*!
+/**
  * \name Standard type definitions.
  *
  * These should be in <sys/types.h> or <stddef.h>, but many compilers
@@ -371,12 +422,14 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
  *
  * We check for some common definitions to avoid redefinitions:
  *
- *    glibc, avr-libc: _SIZE_T_DEFINED
- *    Darwin libc:     _BSD_SIZE_T_DEFINED_
+ *    glibc, avr-libc: _SIZE_T_DEFINED, __ssize_t_defined
+ *    Darwin libc:     _BSD_SIZE_T_DEFINED_, _SIZE_T
+ *    IAR ARM:         _SIZE_T
  *
  * \{
  */
-#if !(defined(size_t) || defined(_SIZE_T_DEFINED) || defined(_BSD_SIZE_T_DEFINED_))
+#if !(defined(size_t) || defined(_SIZE_T_DEFINED) || defined(_BSD_SIZE_T_DEFINED_) \
+       || defined(_SIZE_T))
        #if CPU_X86
                /* 32bit or 64bit (32bit for _WIN64). */
                typedef unsigned long size_t;
@@ -385,10 +438,12 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
        #endif
 #endif
 
-#if !(defined(ssize_t) || defined(__ssize_t_defined))
+#if !(defined(ssize_t) || defined(_SSIZE_T) || defined(__ssize_t_defined))
        #if CPU_X86
                /* 32bit or 64bit (32bit for _WIN64). */
                typedef long ssize_t;
+       #elif CPU_ARM
+               typedef int ssize_t;
        #elif CPU_AVR
                /* 16bit (missing in avr-libc's sys/types.h). */
                typedef int ssize_t;
@@ -399,7 +454,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 /*\}*/
 
 
-/*!
+/**
  * \name Types for hardware registers.
  *
  * Only use these types for registers whose contents can
@@ -420,7 +475,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 
 /* Quasi-ANSI macros */
 #ifndef offsetof
-       /*!
+       /**
         * Return the byte offset of the member \a m in struct \a s.
         *
         * \note This macro should be defined in "stddef.h" and is sometimes
@@ -429,7 +484,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
        #define offsetof(s,m)  (size_t)&(((s *)0)->m)
 #endif
 #ifndef countof
-       /*!
+       /**
         * Count the number of elements in the static array \a a.
         *
         * \note This macro is non-standard, but implements a very common idiom
@@ -437,8 +492,37 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages. */
        #define countof(a)  (sizeof(a) / sizeof(*(a)))
 #endif
 
-/*! Issue a compilation error if the \a condition is false */
+/**
+ * Cast a member of a structure out to the containing structure.
+ *
+ * \param ptr     the pointer to the member.
+ * \param type    the type of the container struct this is embedded in.
+ * \param member  the name of the member within the struct.
+ */
+#if COMPILER_TYPEOF && COMPILER_STATEMENT_EXPRESSIONS
+       #define containerof(ptr, type, member) ({ \
+               const typeof( ((type *)0)->member ) *_mptr = (ptr); /* type check */ \
+               (type *)((char *)_mptr - offsetof(type, member)); \
+       })
+#else
+       #define containerof(ptr, type, member) \
+               ( (type *)((char *)(ptr) - offsetof(type, member)) )
+#endif
+
+/** Issue a compilation error if the \a condition is false */
 #define STATIC_ASSERT(condition)  \
-       UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
+       UNUSED_VAR(extern char, STATIC_ASSERTION_FAILED__[(condition) ? 1 : -1])
+
+#ifndef ASSERT_TYPE_EQUAL
+       /** Ensure two variables have the same type. */
+       #define ASSERT_TYPE_EQUAL(var1, var2)  \
+                       do { (void)(&(var1) == &(var2)); } while(0)
+#endif
+
+#ifndef ASSERT_TYPE_IS
+       /** Ensure variable is of specified type. */
+       #define ASSERT_TYPE_IS(var, type)  \
+                       do { (void)(&(var) == (type *)0); } while(0)
+#endif
 
-#endif /* DEVLIB_COMPILER_H */
+#endif /* BERTOS_COMPILER_H */