PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY():...

[bertos.git] / compiler.h

diff --git a/compiler.h b/compiler.h
index 96f9c9aca723e0501f05007c5ec3ad4f52162000..e27959c7d76090a994e1cfeff16180ae33e353bc 100755 (executable)
--- a/compiler.h
+++ b/compiler.h
@@ -15,6 +15,16 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.22  2004/09/14 21:03:04  bernie
+ *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
+ *#*
+ *#* Revision 1.21  2004/09/06 21:38:31  bernie
+ *#* Misc documentation and style fixes.
+ *#*
+ *#* Revision 1.20  2004/08/29 21:57:58  bernie
+ *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
+ *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
+ *#*
  *#* Revision 1.19  2004/08/25 14:12:08  rasky
  *#* Aggiornato il comment block dei log RCS
  *#*
@@ -150,16 +160,19 @@
        #define NORETURN                __attribute__((__noreturn__))
        #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__
+       #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 RESTRICT                __restrict__
+       #define MUST_CHECK              __attribute__((warn_unused_result))
        #if GNUC_PREREQ(3,1)
-               #define DEPRECATED      __attribute__((__deprecated__))
+               #define DEPRECATED  __attribute__((__deprecated__))
        #endif
 
        #if CPU_X86
 
-               /* hack to avoid conflicts with system type */
+               /* Hack to avoid conflicts with system type */
                #define sigset_t system_sigset_t
                #include <stddef.h>
                #include <setjmp.h>
@@ -228,8 +241,17 @@
 #ifndef UNLIKELY
 #define UNLIKELY(x)            x
 #endif
+#ifndef PURE_FUNC
+#define PURE_FUNC              /* nothing */
+#endif
+#ifndef CONST_FUNC
+#define CONST_FUNC             /* nothing */
+#endif
 #ifndef RESTRICT
-#define RESTRICT
+#define RESTRICT               /* nothing */
+#endif
+#ifndef MUST_CHECK
+#define MUST_CHECK             /* nothing */
 #endif
 
 /* Support for harvard architectures */
@@ -267,7 +289,7 @@
 
 
 /*
- * Standard type definitions
+ * Standard type definitions.
  * These should be in <sys/types.h>, but many compilers lack them.
  */
 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
@@ -278,9 +300,10 @@
        typedef long time_t;
 #endif /* _TIME_T_DEFINED || __time_t_defined */
 
-/*! Storage for pointers and integers */
-/* FIXME: turn this into a typedef? */
-#define IPTR void *
+/*! Bulk storage large enough for both pointers or integers */
+typedef void * iptr_t;
+typedef const void * const_iptr_t;
+#define IPTR iptr_t  /* OBSOLETE */
 
 typedef long utime_t;            /*!< Type for time expressed in microseconds */
 typedef unsigned char sig_t;     /*!< Type for signal bits */
@@ -301,7 +324,7 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages */
        typedef unsigned short int  uint16_t;
        typedef unsigned long int   uint32_t;
        /* \} */
-#elif defined(__GNUC__) && defined(__AVR__)
+#elif defined(__GNUC__) && CPU_AVR
        /* avr-libc is weird... */
        #include <inttypes.h>
 #else
@@ -331,7 +354,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
+        * 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
         *       compiler-specific (g++ has a builtin for it).
@@ -340,11 +363,15 @@ typedef unsigned char page_t;    /*!< Type for banked memory pages */
 #endif
 #ifndef countof
        /*!
-        * Count the number of elements in the static array \a a
+        * Count the number of elements in the static array \a a.
         *
-        * \note This macro is non-standard, but implmenents a very common idiom
+        * \note This macro is non-standard, but implements a very common idiom
         */
        #define countof(a)  (sizeof(a) / sizeof(*(a)))
 #endif
 
+/*! Issue a compilation error if the \a condition is false */
+#define STATIC_ASSERT(condition)  \
+       extern char PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]
+
 #endif /* DEVLIB_COMPILER_H */