Adjust for DevLib.
[bertos.git] / compiler.h
index bf96ecb57d014ee6068de798094643ba5d2cefa6..9acdfccc85b7e5fd80d6c50b012d691c337e0d53 100755 (executable)
@@ -1,9 +1,9 @@
 /*!
  * \file
  * <!--
- * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
- * Copyright 2001,2002,2003 Bernardo Innocenti <bernie@codewiz.org>
- * All Rights Reserved.
+ * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2001, 2002, 2003 Bernardo Innocenti <bernie@codewiz.org>
+ * This file is part of DevLib - See devlib/README for information.
  * -->
  *
  * \version $Id$
 
 /*
  * $Log$
+ * Revision 1.15  2004/08/13 03:23:26  bernie
+ * Adjust a few MSVC tweaks from older projects.
+ *
+ * Revision 1.14  2004/08/10 06:56:29  bernie
+ * RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
+ *
+ * Revision 1.13  2004/08/02 20:20:29  aleph
+ * Merge from project_ks
+ *
+ * Revision 1.12  2004/08/01 01:21:17  bernie
+ * LIKELY(), UNLIKELY(): New compiler-specific macros.
+ *
+ * Revision 1.11  2004/07/30 14:34:10  rasky
+ * Vari fix per documentazione e commenti
+ * Aggiunte PP_CATn e STATIC_ASSERT
+ *
+ * Revision 1.10  2004/07/30 14:15:53  rasky
+ * Nuovo supporto unificato per detect della CPU
+ *
+ * Revision 1.9  2004/07/29 22:57:09  bernie
+ * vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
+ *
+ * Revision 1.8  2004/07/20 23:43:39  bernie
+ * Use attribute((always_inline)) to force inlining.  This fixes the much
+ * hated need of redundant prototypes for inline functions.
+ *
+ * Revision 1.7  2004/07/20 23:26:48  bernie
+ * Fix two errors introduced by previous commit.
+ *
+ * Revision 1.6  2004/07/20 23:12:43  bernie
+ * *** empty log message ***
+ *
+ * Revision 1.5  2004/07/20 17:08:03  bernie
+ * Cleanup documentation
+ *
+ * Revision 1.4  2004/06/27 15:20:26  aleph
+ * Change UNUSED() macro to accept two arguments: type and name;
+ * Add macro GNUC_PREREQ to detect GCC version during build;
+ * Some spacing cleanups and typo fix
+ *
+ * Revision 1.3  2004/06/06 18:00:39  bernie
+ * PP_CAT(): New macro.
+ *
+ * Revision 1.2  2004/06/03 11:27:09  bernie
+ * Add dual-license information.
+ *
  * Revision 1.1  2004/05/23 17:48:35  bernie
  * Add top-level files.
  *
 #define COMPILER_H
 
 #include "arch_config.h"
+#include "cpu_detect.h"
+
+
+#if defined __GNUC__ && defined __GNUC_MINOR__
+       #define GNUC_PREREQ(maj, min) \
+               ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
+#else
+       #define GNUC_PREREQ(maj, min) 0
+#endif
 
 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
        #pragma language=extended
-       #define INTERRUPT(x)    interrupt [x]
-       #define REGISTER                shortad
-       #define ATOMIC                  monitor
-
-       /* GCC attributes */
-       #define FORMAT(type,fmt,first) /* nothing */
-       #define NORETURN               /* nothing */
-       #define UNUSED(arg)            arg
+       #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.
        int setjmp(jmp_buf env);
        void longjmp(jmp_buf env, int val);
 
-       #ifndef __cplusplus
-               #define true 1
-               #define false 0
-               typedef unsigned char bool;
-       #endif /* !__cplusplus */
+       /* Fake bool support */
+       #define true (1==1)
+       #define false (1!=1)
+       typedef unsigned char bool;
 
 #elif defined(_MSC_VER) /* Win32 emulation support */
 
        #include <setjmp.h>
        #include <time.h> /* for time_t */
-       #define float double
-
-       #define REGISTER                /* nothing */
-       #define INTERRUPT(x)    /* nothing */
-
-       /* GCC attributes */
-       #define FORMAT(type,fmt,first) /* nothing */
-       #define NORETURN               /* nothing */
-       #define UNUSED(arg)            arg
-       #define INLINE static inline
-
-       #ifdef __cplusplus
-               extern "C" {
-       #endif
-                       void SchedulerIdle(void);
-       #ifdef __cplusplus
-               }
-       #endif
 
-       /* Ouch, ReleaseSemaphore() conflicts with a WIN32 call ;-( */
-       #define ReleaseSemaphore KReleaseSemaphore
+       /* FIXME: I can't remember why exactly this was needed (NdBernie) */
+       #define float double
 
+       /* Fake bool support */
        #ifndef __cplusplus
                #define true 1
                #define false 0
                typedef int bool;
        #endif /* !__cplusplus */
 
+       /* These C99 functions are oddly named in MSVCRT32.lib */
+       #define snprintf _snprintf
+       #define vsnprintf _vsnprintf
+
 #elif defined(__GNUC__)
 
        /* GCC attributes */
        #define FORMAT(type,fmt,first)  __attribute__((__format__(type, fmt, first)))
        #define NORETURN                __attribute__((__noreturn__))
-       #define UNUSED(arg)             __attribute__((__unused__)) arg
-       //FIXME #define INLINE static inline
-       #define INLINE extern inline
+       #define UNUSED(type,arg)        __attribute__((__unused__)) type arg
+       #define INLINE                  static inline __attribute__((__always_inline__))
+       #define LIKELY(x)               __builtin_expect((x), 1)
+       #define UNLIKELY(x)             __builtin_expect((x), 0)
+       #define RESTRICT                __restrict__
+       #if GNUC_PREREQ(3,1)
+               #define DEPRECATED      __attribute__((__deprecated__))
+       #endif
 
-       #if defined(__i386__)
+       #if CPU_X86
 
                /* hack to avoid conflicts with system type */
                #define sigset_t system_sigset_t
                #include <stdbool.h>
                #undef system_sigset_t
 
-               #define REGISTER                /* nothing */
-               #define INTERRUPT(x)    /* nothing */
-
-               #ifdef __cplusplus
-                       extern "C" {
-               #endif
-                               void SchedulerIdle(void);
-               #ifdef __cplusplus
-                       }
-               #endif
-
-       #elif defined(__AVR__)
+       #elif CPU_AVR
 
                #include <stddef.h>
                #include <stdbool.h>
-               #define FLASH           __attribute__((progmem))
-               #define REGISTER                /* nothing */
 
                /* Missing printf-family functions in avr-libc/stdio.h */
                #include <stdarg.h>
                #include <avr/pgmspace.h>
-               int vsprintf(char *buf, const char *fmt, va_list ap);
                int vsprintf_P(char *buf, const char * PROGMEM fmt, va_list ap);
 
-               /* Support for hardvard architectures */
+               /* Support for harvard architectures */
                #ifdef _PROGMEM
                        #define PGM_READ_CHAR(s) pgm_read_byte(s)
                        #define PGM_FUNC(x) x ## _P
-                       #define PGM_ATTR        PROGMEM
-               #else
-                       #define PGM_READ_CHAR(s) (*(s))
-                       #define PGM_FUNC(x) x
-                       #define PGM_ATTR        /*nop*/
+                       #define PGM_ATTR        PROGMEM
                #endif
 
-       #endif /* CPU */
+       #endif
 
-#elif defined(__MWERKS__) && (defined(__m56800E__) || defined(__m56800__))
+#elif defined(__MWERKS__) && CPU_DSP56K
 
        #include <stdint.h>
        #include <stddef.h>
        #include <stdbool.h>
        #include <setjmp.h>
 
-       #define FLASH           /* nothing */
-       #define REGISTER                /* nothing */
-       #define INTERRUPT(x)    ERROR_NOT_IMPLEMENTED
-       #define SCHEDULER_IDLE  /* nothing */
-       
-       #define INLINE          static inline
-
-       /* GCC attributes */
-       #define FORMAT(type,fmt,first)  /* nothing */
-       #define NORETURN                /* nothing */
-       #define UNUSED(arg)             arg
-
-       /* Support for hardvard architectures */
-       #define PGM_READ_CHAR(s) (*(s))
-       #define PGM_FUNC                /* nothing */
-       #define PGM_ATTR                /* nothing */
-       #define PSTR            /* nothing */
+       // CodeWarrior has size_t as built-in type, but does not define this symbol.
+       #define _SIZE_T_DEFINED
 
 #else
        #error unknown compiler
 #endif
 
+
+/* A few defaults for missing compiler features. */
+#ifndef INLINE
+#define INLINE                 static inline
+#endif
+#ifndef NORETURN
+#define NORETURN               /* nothing */
+#endif
+#ifndef FORMAT
+#define FORMAT(type,fmt,first) /* nothing */
+#endif
+#ifndef DEPRECATED
+#define DEPRECATED             /* nothing */
+#endif
+#ifndef UNUSED
+#define UNUSED(type,arg)       type arg
+#endif
+#ifndef REGISTER
+#define REGISTER               /* nothing */
+#endif
+#ifndef INTERRUPT
+#define INTERRUPT(x)           ERROR_NOT_IMPLEMENTED
+#endif
+#ifndef LIKELY
+#define LIKELY(x)              x
+#endif
+#ifndef UNLIKELY
+#define UNLIKELY(x)            x
+#endif
+#ifndef RESTRICT
+#define RESTRICT
+#endif
+
+/* Support for harvard architectures */
+#ifndef PSTR
+#define PSTR            /* nothing */
+#endif
+#ifndef PGM_READ_CHAR
+#define PGM_READ_CHAR(s) (*(s))
+#endif
+#ifndef PGM_FUNC
+#define PGM_FUNC(x) x
+#endif
+#ifndef PGM_ATTR
+#define PGM_ATTR        /* nothing */
+#endif
+
+
 /* Misc definitions */
 #ifndef NULL
-#define NULL   0
+#define NULL  0
 #endif
 #ifndef EOF
-#define        EOF             (-1)
+#define        EOF   (-1)
 #endif
 
 
-/* Quasi-ANSI macros
- *
- * offsetof(s,m) - Give the byte offset of the member <m> in struct <s>
- * countof(a) - Count the number of elements in the static array <a>
- */
-#ifndef offsetof
-#define offsetof(s,m)   (size_t)&(((s *)0)->m)
+/* Support for hybrid C/C++ applications. */
+#ifdef __cplusplus
+       #define EXTERN_C_BEGIN  extern "C" {
+       #define EXTERN_C_END    }
+#else
+       #define EXTERN_C_BEGIN  /* nothing */
+       #define EXTERN_C_END    /* nothing */
 #endif
 
+
+/* Quasi-ANSI macros */
+#ifndef offsetof
+       /*! offsetof(s,m) - Return the byte offset of the member \a m in struct \a s */
+       #define offsetof(s,m)   (size_t)&(((s *)0)->m)
+#endif
 #ifndef countof
-#define countof(a) (sizeof(a) / sizeof(*(a)))
+       /*! Count the number of elements in the static array \a a */
+       #define countof(a) (sizeof(a) / sizeof(*(a)))
 #endif
 
+
 /* Simple macros */
-#define ABS(a)         (((a) < 0) ? -(a) : (a))
-#define MIN(a,b)       (((a) < (b)) ? (a) : (b))
-#define MAX(a,b)       (((a) > (b)) ? (a) : (b))
+#if GNUC_PREREQ(2,0)
+       #define ABS(n) ({ \
+               __typeof__(n) _n = (n); \
+               (_n < 0) ? -_n : _n; \
+       })
+       #define MIN(a,b) ({ \
+               __typeof__(a) _a = (a); \
+               __typeof__(b) _b = (b); \
+               (void)(&_a == &_b); /* ensure same type */ \
+               (_a < _b) ? _a : _b; \
+       })
+       #define MAX(a,b) ({ \
+               __typeof__(a) _a = (a); \
+               __typeof__(b) _b = (b); \
+               (void)(&_a == &_b); /* ensure same type */ \
+               (_a > _b) ? _a : _b; \
+       })
+#else /* !GNUC */
+       /* Buggy macros for inferior compilers */
+       #define ABS(a)          (((a) < 0) ? -(a) : (a))
+       #define MIN(a,b)        (((a) < (b)) ? (a) : (b))
+       #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
+#endif /* !GNUC */
 
-/*! Convert a bit value to a binary flag */
 #ifndef BV
+/*! Convert a bit value to a binary flag */
 #define BV(x)  (1<<(x))
 #endif
 
 #define UINT32_LOG2(x) \
        ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 
-/* Type definitions - should go in <sys/types.h> */
+/*! 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) */
+#define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
+#define PP_STRINGIZE__(x)   #x
+
+/*! Issue a compilation error if the \a condition is false */
+#define STATIC_ASSERT(condition)  \
+       extern char PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]
+
+/*
+ * Standard type definitions
+ * These should be in <sys/types.h>, but many compilers lack them.
+ */
 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
-       #define size_t unsigned int
+       typedef unsigned int size_t;
+       typedef int ssize_t;
 #endif
 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
        typedef long time_t;
@@ -254,8 +357,11 @@ typedef unsigned char sig_t;
 typedef unsigned char sigset_t;
 typedef unsigned char page_t;
 
-/* ISO C99 fixed-size types */
 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
+       /*
+        * ISO C99 fixed-size types
+        * These should be in <stdint.h>, but many compilers lack them.
+        */
        typedef signed char         int8_t;
        typedef short int           int16_t;
        typedef long int            int32_t;
@@ -263,12 +369,23 @@ typedef unsigned char page_t;
        typedef unsigned short int  uint16_t;
        typedef unsigned long int   uint32_t;
 #elif defined(__AVR__)
-#      include <inttypes.h>
+       /* TODO: should this detect GCC+AVR combo, or just CPU_AVR? */
+       /* avr-libc is weird... */
+       #include <inttypes.h>
 #else
-#      include <stdint.h>
+       /* This is the correct location. */
+       #include <stdint.h>
 #endif
 
-#if (defined(__m56800E__) || defined(__m56800__))
+/*!
+ * \name Types for hardware registers.
+ *
+ * Only use these types for registers whose contents can
+ * be changed asynchronously by external hardware.
+ *
+ * \{
+ */
+#if CPU_DSP56K
        /* Registers can be accessed only through 16-bit pointers */
        typedef volatile uint16_t  reg16_t;
 #else
@@ -276,5 +393,6 @@ typedef unsigned char page_t;
        typedef volatile uint16_t  reg16_t;
        typedef volatile uint32_t  reg32_t;
 #endif
+/*\}*/
 
 #endif /* COMPILER_H */