X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=cfg%2Fcompiler.h;h=9f5462b3aa8ccacfc5c9f6ecb9fd5686c3bcd0fb;hb=e40b7f1ecfc7be6267192d54b0650960dda84d6d;hp=45f4d92d46cb7f0b148f3695f05b111d4bc32c36;hpb=6bf26ad78b32851d9dd56fbf68356bcbdded590e;p=bertos.git

diff --git a/cfg/compiler.h b/cfg/compiler.h
index 45f4d92d..9f5462b3 100755
--- a/cfg/compiler.h
+++ b/cfg/compiler.h
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
@@ -14,28 +14,76 @@
 
 /*#*
  *#* $Log$
- *#* Revision 1.1  2005/04/11 19:04:13  bernie
- *#* Move top-level headers to cfg/ subdir.
+ *#* Revision 1.22  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.21  2006/07/19 12:53:43  bernie
+ *#* Prune log.
+ *#*
+ *#* Revision 1.20  2006/06/10 05:36:15  bernie
+ *#* Convert to new Doxygen comments.
+ *#*
+ *#* Revision 1.19  2006/04/11 00:07:33  bernie
+ *#* Implemenent MF_SAVESEL flag.
+ *#*
+ *#* Revision 1.18  2006/03/22 13:34:34  bernie
+ *#* MSVC support.
+ *#*
+ *#* Revision 1.17  2006/03/22 09:48:35  bernie
+ *#* Formatting.
+ *#*
+ *#* Revision 1.16  2006/03/20 17:48:09  bernie
+ *#* Fix for avr-libc; INTERRUPT(): Remove macro.
+ *#*
+ *#* Revision 1.15  2006/03/13 02:06:25  bernie
+ *#* containerof(): New macro.
+ *#*
+ *#* Revision 1.14  2006/02/23 08:36:33  bernie
+ *#* Emulate __func__ on MSVC.
+ *#*
+ *#* Revision 1.13  2006/02/23 07:37:37  bernie
+ *#* Compile fix for MSVC.
  *#*
- *#* 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.12  2006/02/21 16:06:31  bernie
+ *#* Fix ssize_t redefinitions on glibc systems.
  *#*
- *#* Revision 1.43  2005/03/01 23:15:12  bernie
- *#* Remove compatibility hack.
+ *#* Revision 1.11  2006/02/20 14:34:58  bernie
+ *#* Use portable type checking.
  *#*
- *#* Revision 1.42  2005/02/16 20:28:46  bernie
- *#* Move PGM macros to mware/pgm.h
+ *#* Revision 1.10  2006/02/15 09:12:01  bernie
+ *#* Fixes for ARM/IAR support.
  *#*
- *#* Revision 1.41  2005/01/22 04:19:22  bernie
- *#* MTIME_INFINITE: New constant.
+ *#* Revision 1.9  2006/02/10 12:38:00  bernie
+ *#* Add support for ARM on IAR.
  *#*
- *#* Revision 1.40  2005/01/20 18:46:04  aleph
- *#* Add progmem datatypes; PSTR() definition.
+ *#* Revision 1.8  2006/01/16 03:27:49  bernie
+ *#* Rename sig_t to sigbit_t to avoid clash with POSIX.
+ *#*
+ *#* Revision 1.7  2005/11/27 23:33:05  bernie
+ *#* Drop avr-libc hack for missing stdint.h.
+ *#*
+ *#* 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.
  *#*/
 #ifndef DEVLIB_COMPILER_H
 #define DEVLIB_COMPILER_H
 
-#include "cpu_detect.h"
+#include <cfg/cpu_detect.h>
 
 
 #if defined __GNUC__ && defined __GNUC_MINOR__
@@ -57,57 +105,80 @@
 #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
 
-	typedef struct _JMP_BUF jmp_buf[1];
+		#define INTERRUPT(x)  __irq __arm void x (void)
+		#define INLINE        static inline
 
-	int setjmp(jmp_buf env);
-	void longjmp(jmp_buf env, int val);
+		/* Include some standard C89/C99 stuff */
+		#include <stddef.h>
+		#include <stdint.h>
+		#include <stdbool.h>
 
-	/* Fake bool support */
-	#define true (1==1)
-	#define false (1!=1)
-	typedef unsigned char bool;
+	#elif CPU_I196
+
+		// IAR has size_t as built-in type, but does not define this symbol.
+		#define _SIZE_T_DEFINED
+
+		#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 */
+		};
+
+		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 */
 
@@ -122,6 +193,14 @@
 	#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 */
@@ -134,27 +213,33 @@
 	#define NORETURN                __attribute__((__noreturn__))
 	#define UNUSED_ARG(type,arg)    __attribute__((__unused__)) type arg
 	#define UNUSED_VAR(type,name)	__attribute__((__unused__)) type name
-	#define USED_VAR(type,name)	__attribute__((__used__)) type name
+	#define USED_VAR(type,name)     __attribute__((__used__)) type name
 	#define INLINE                  static inline __attribute__((__always_inline__))
 	#define LIKELY(x)               __builtin_expect(!!(x), 1)
 	#define UNLIKELY(x)             __builtin_expect(!!(x), 0)
 	#define PURE_FUNC               __attribute__((pure))
 	#define CONST_FUNC              __attribute__((const))
 	#define UNUSED_FUNC             __attribute__((unused))
-	#define USED_FUNC		__attribute__((__used__))
+	#define USED_FUNC               __attribute__((__used__))
 	#define RESTRICT                __restrict__
 	#define MUST_CHECK              __attribute__((warn_unused_result))
 	#if GNUC_PREREQ(3,1)
 		#define DEPRECATED  __attribute__((__deprecated__))
 	#endif
 
-	#if CPU_AVR
-		#include <stddef.h>
-		#include <stdbool.h>
-	#else
-		/* Include some standard C89/C99 stuff */
-		#include <stddef.h>
-		#include <stdbool.h>
+	#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
@@ -168,7 +253,7 @@
 		#pragma GCC poison cin cout cerr clog
 	#endif
 
-#elif defined(__MWERKS__) && CPU_DSP56K
+#elif defined(__MWERKS__)
 
 	/* Compiler features */
 	#define COMPILER_VARIADIC_MACROS 1
@@ -177,8 +262,10 @@
 
 	#define typeof __typeof__
 
-	#include <stdint.h>
+	#define UNUSED_ARG(type,arg)    type
+
 	#include <stddef.h>
+	#include <stdint.h>
 	#include <stdbool.h>
 
 	// CodeWarrior has size_t as built-in type, but does not define this symbol.
@@ -191,7 +278,7 @@
 
 /* Defaults for compiler extensions. */
 
-/*!
+/**
  * \def COMPILER_VARIADIC_MACROS
  * Support for macros with variable arguments.
  */
@@ -199,17 +286,17 @@
 #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
@@ -241,9 +328,6 @@
 #ifndef REGISTER
 #define REGISTER               /* nothing */
 #endif
-#ifndef INTERRUPT
-#define INTERRUPT(x)           ERROR_NOT_IMPLEMENTED
-#endif
 #ifndef LIKELY
 #define LIKELY(x)              x
 #endif
@@ -283,32 +367,42 @@
 	#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 short int           int16_t;
-	typedef long int            int32_t;
 	typedef unsigned char       uint8_t;
+	typedef short int           int16_t;
 	typedef unsigned short int  uint16_t;
-	typedef unsigned long int   uint32_t;
+	typedef long int            int32_t; /* _WIN64 safe */
+	typedef unsigned long int   uint32_t; /* _WIN64 safe */
+
+	#ifdef _MSC_VER
+		typedef __int64              int64_t;
+		typedef unsigned __int64     uint64_t;
+	#else
+		typedef long long            int64_t;
+		typedef unsigned long long   uint64_t;
+	#endif
 	/* \} */
-#elif defined(__GNUC__) && CPU_AVR
-	/* avr-libc is weird... */
-	#include <inttypes.h>
 #else
-	/* This is the correct location. */
+	/* This is the standard location. */
 	#include <stdint.h>
 #endif
 
@@ -317,29 +411,33 @@
 	 * The ATmega8 has a very small Flash, so we can't afford
 	 * to link in support routines for 32bit integer arithmetic.
 	 */
-	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 mtime_t;  /*!< Type for time expressed in milliseconds. */
-	typedef int32_t utime_t;  /*!< Type for time expressed in microseconds. */
+	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)
 	#define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
 	#define MTIME_INFINITE 0x7FFFFFFFL
 #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. */
 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
@@ -347,26 +445,39 @@ 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 CPU_REG_BITS > 32
-		/* 64bit. */
+#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;
-		typedef long ssize_t;
 	#else
-		/* 32bit or 16bit. */
-		typedef unsigned int size_t;
+		#error Unknown CPU
+	#endif
+#endif
+
+#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;
+	#else
+		#error Unknown CPU
 	#endif
 #endif
 /*\}*/
 
 
-/*!
+/**
  * \name Types for hardware registers.
  *
  * Only use these types for registers whose contents can
@@ -387,7 +498,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
@@ -396,7 +507,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
@@ -404,8 +515,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 */