compiler.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2001, 2002, 2003 Bernardo Innocenti <bernie@codewiz.org>
   6  * This file is part of DevLib - See devlib/README for information.
   7  * -->
   8  *
   9  * \version $Id$
  10  *
  11  * \author Bernardo Innocenti <bernie@develer.com>
  12  *
  13  * \brief Additional support macros for compiler independance
  14  */
  15
  16 /*
  17  * $Log$
  18  * Revision 1.12  2004/08/01 01:21:17  bernie
  19  * LIKELY(), UNLIKELY(): New compiler-specific macros.
  20  *
  21  * Revision 1.11  2004/07/30 14:34:10  rasky
  22  * Vari fix per documentazione e commenti
  23  * Aggiunte PP_CATn e STATIC_ASSERT
  24  *
  25  * Revision 1.10  2004/07/30 14:15:53  rasky
  26  * Nuovo supporto unificato per detect della CPU
  27  *
  28  * Revision 1.9  2004/07/29 22:57:09  bernie
  29  * vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
  30  *
  31  * Revision 1.8  2004/07/20 23:43:39  bernie
  32  * Use attribute((always_inline)) to force inlining.  This fixes the much
  33  * hated need of redundant prototypes for inline functions.
  34  *
  35  * Revision 1.7  2004/07/20 23:26:48  bernie
  36  * Fix two errors introduced by previous commit.
  37  *
  38  * Revision 1.6  2004/07/20 23:12:43  bernie
  39  * *** empty log message ***
  40  *
  41  * Revision 1.5  2004/07/20 17:08:03  bernie
  42  * Cleanup documentation
  43  *
  44  * Revision 1.4  2004/06/27 15:20:26  aleph
  45  * Change UNUSED() macro to accept two arguments: type and name;
  46  * Add macro GNUC_PREREQ to detect GCC version during build;
  47  * Some spacing cleanups and typo fix
  48  *
  49  * Revision 1.3  2004/06/06 18:00:39  bernie
  50  * PP_CAT(): New macro.
  51  *
  52  * Revision 1.2  2004/06/03 11:27:09  bernie
  53  * Add dual-license information.
  54  *
  55  * Revision 1.1  2004/05/23 17:48:35  bernie
  56  * Add top-level files.
  57  *
  58  */
  59 #ifndef COMPILER_H
  60 #define COMPILER_H
  61
  62 #include "arch_config.h"
  63 #include "cpu_detect.h"
  64
  65
  66 #if defined __GNUC__ && defined __GNUC_MINOR__
  67         #define GNUC_PREREQ(maj, min) \
  68                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  69 #else
  70         #define GNUC_PREREQ(maj, min) 0
  71 #endif
  72
  73 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
  74         #pragma language=extended
  75         #define INTERRUPT(x)  interrupt [x]
  76         #define REGISTER      shortad
  77         #define INLINE        /* unsupported */
  78
  79         /* Imported from <longjmp.h>. Unfortunately, we can't just include
  80          * this header because it typedefs jmp_buf to be an array of chars.
  81          * This would allow the compiler to place the buffer on an odd address.
  82          * The CPU _should_ be able to perform word accesses to
  83          * unaligned data, but there are *BUGS* in the 80196KC with
  84          * some combinations of opcodes and addressing modes. One of
  85          * these, "ST SP,[?GR]+" is used in the longjmp() implementation
  86          * provided by the IAR compiler ANSI C library. When ?GR contains
  87          * an odd address, surprisingly the CPU will copy the high order
  88          * byte of the source operand (SP) in the low order byte of the
  89          * destination operand (the memory location pointed to by ?GR).
  90          *
  91          * We also need to replace the library setjmp()/longjmp() with
  92          * our own versions because the IAR implementation "forgets" to
  93          * save the contents of local registers (?LR).
  94          */
  95         struct _JMP_BUF
  96         {
  97                 void *  sp;                             /* Stack pointer */
  98                 void *  return_addr;    /* Return address */
  99                 int             lr[6];                  /* 6 local registers */
 100         };
 101
 102         typedef struct _JMP_BUF jmp_buf[1];
 103
 104         int setjmp(jmp_buf env);
 105         void longjmp(jmp_buf env, int val);
 106
 107         /* Fake bool support */
 108         #define true (1==1)
 109         #define false (1!=1)
 110         typedef unsigned char bool;
 111
 112 #elif defined(_MSC_VER) /* Win32 emulation support */
 113
 114         #include <setjmp.h>
 115         #include <time.h> /* for time_t */
 116         #define float double
 117
 118         /* Ouch, ReleaseSemaphore() conflicts with a WIN32 call ;-( */
 119         #define ReleaseSemaphore KReleaseSemaphore
 120
 121         /* Fake bool support */
 122         #ifndef __cplusplus
 123                 #define true 1
 124                 #define false 0
 125                 typedef int bool;
 126         #endif /* !__cplusplus */
 127
 128 #elif defined(__GNUC__)
 129
 130         /* GCC attributes */
 131         #define FORMAT(type,fmt,first)  __attribute__((__format__(type, fmt, first)))
 132         #define NORETURN                __attribute__((__noreturn__))
 133         #define UNUSED(type,arg)        __attribute__((__unused__)) type arg
 134         #define INLINE                  static inline __attribute__((__always_inline__))
 135         #define LIKELY(x)               __builtin_expect((x), 1)
 136         #define UNLIKELY(x)             __builtin_expect((x), 0)
 137         #if GNUC_PREREQ(3,1)
 138                 #define DEPRECATED      __attribute__((__deprecated__))
 139         #endif
 140
 141         #if CPU_X86
 142
 143                 /* hack to avoid conflicts with system type */
 144                 #define sigset_t system_sigset_t
 145                 #include <stddef.h>
 146                 #include <setjmp.h>
 147                 #include <stdbool.h>
 148                 #undef system_sigset_t
 149
 150         #elif CPU_AVR
 151
 152                 #include <stddef.h>
 153                 #include <stdbool.h>
 154
 155                 /* Missing printf-family functions in avr-libc/stdio.h */
 156                 #include <stdarg.h>
 157                 #include <avr/pgmspace.h>
 158                 int vsprintf_P(char *buf, const char * PROGMEM fmt, va_list ap);
 159
 160                 /* Support for harvard architectures */
 161                 #ifdef _PROGMEM
 162                         #define PGM_READ_CHAR(s) pgm_read_byte(s)
 163                         #define PGM_FUNC(x) x ## _P
 164                         #define PGM_ATTR        PROGMEM
 165                 #endif
 166
 167         #endif
 168
 169 #elif defined(__MWERKS__) && CPU_DSP56K
 170
 171         #include <stdint.h>
 172         #include <stddef.h>
 173         #include <stdbool.h>
 174         #include <setjmp.h>
 175
 176         // CodeWarrior has size_t as built-in type, but does not define this symbol.
 177         #define _SIZE_T_DEFINED
 178
 179 #else
 180         #error unknown compiler
 181 #endif
 182
 183
 184 /* A few defaults for missing compiler features. */
 185 #ifndef INLINE
 186 #define INLINE                 static inline
 187 #endif
 188 #ifndef NORETURN
 189 #define NORETURN               /* nothing */
 190 #endif
 191 #ifndef FORMAT
 192 #define FORMAT(type,fmt,first) /* nothing */
 193 #endif
 194 #ifndef DEPRECATED
 195 #define DEPRECATED             /* nothing */
 196 #endif
 197 #ifndef UNUSED
 198 #define UNUSED(type,arg)       type arg
 199 #endif
 200 #ifndef REGISTER
 201 #define REGISTER               /* nothing */
 202 #endif
 203 #ifndef INTERRUPT
 204 #define INTERRUPT(x)           ERROR_NOT_IMPLEMENTED
 205 #endif
 206 #ifndef LIKELY
 207 #define LIKELY(x)              x
 208 #endif
 209 #ifndef UNLIKELY
 210 #define UNLIKELY(x)            x
 211 #endif
 212
 213 /* Support for harvard architectures */
 214 #ifndef PSTR
 215 #define PSTR            /* nothing */
 216 #endif
 217 #ifndef PGM_READ_CHAR
 218 #define PGM_READ_CHAR(s) (*(s))
 219 #endif
 220 #ifndef PGM_FUNC
 221 #define PGM_FUNC(x) x
 222 #endif
 223 #ifndef PGM_ATTR
 224 #define PGM_ATTR        /* nothing */
 225 #endif
 226
 227
 228 /* Misc definitions */
 229 #ifndef NULL
 230 #define NULL  0
 231 #endif
 232 #ifndef EOF
 233 #define EOF   (-1)
 234 #endif
 235
 236
 237 /* Support for hybrid C/C++ applications. */
 238 #ifdef __cplusplus
 239         #define EXTERN_C_BEGIN  extern "C" {
 240         #define EXTERN_C_END    }
 241 #else
 242         #define EXTERN_C_BEGIN  /* nothing */
 243         #define EXTERN_C_END    /* nothing */
 244 #endif
 245
 246
 247 /* Quasi-ANSI macros */
 248 #ifndef offsetof
 249         /*! offsetof(s,m) - Return the byte offset of the member \a m in struct \a s */
 250         #define offsetof(s,m)   (size_t)&(((s *)0)->m)
 251 #endif
 252 #ifndef countof
 253         /*! Count the number of elements in the static array \a a */
 254         #define countof(a) (sizeof(a) / sizeof(*(a)))
 255 #endif
 256
 257
 258 /* Simple macros */
 259 #define ABS(a)      (((a) < 0) ? -(a) : (a))
 260 #define MIN(a,b)    (((a) < (b)) ? (a) : (b))
 261 #define MAX(a,b)    (((a) > (b)) ? (a) : (b))
 262
 263 #ifndef BV
 264 /*! Convert a bit value to a binary flag */
 265 #define BV(x)   (1<<(x))
 266 #endif
 267
 268 /*! Round up \a x to an even multiple of the 2's power \a pad */
 269 #define ROUND2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 270
 271 /*! Calculate a compile-time log2 for a uint8_t */
 272 #define UINT8_LOG2(x) \
 273         ((x) < 2 ? 0 : \
 274          ((x) < 4 ? 1 : \
 275           ((x) < 8 ? 2 : \
 276            ((x) < 16 ? 3 : \
 277             ((x) < 32 ? 4 : \
 278              ((x) < 64 ? 5 : \
 279               ((x) < 128 ? 6 : 7)))))))
 280
 281 /*! Calculate a compile-time log2 for a uint16_t */
 282 #define UINT16_LOG2(x) \
 283         ((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
 284
 285 /*! Calculate a compile-time log2 for a uint32_t */
 286 #define UINT32_LOG2(x) \
 287         ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 288
 289 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
 290 #define PP_CAT(x,y)         PP_CAT__(x,y)
 291 #define PP_CAT__(x,y)       x ## y
 292 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
 293 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
 294 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
 295
 296 /*! String-ize a token (allowing macros to expand) */
 297 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
 298 #define PP_STRINGIZE__(x)   #x
 299
 300 /*! Issue a compilation error if the \a condition is false */
 301 #define STATIC_ASSERT(condition)  \
 302         extern char CT_ASSERT___[(condition) ? 1 : -1]
 303
 304 /*
 305  * Standard type definitions
 306  * These should be in <sys/types.h>, but many compilers lack them.
 307  */
 308 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
 309         typedef unsigned int size_t;
 310         typedef int ssize_t;
 311 #endif
 312 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
 313         typedef long time_t;
 314 #endif /* _TIME_T_DEFINED || __time_t_defined */
 315
 316 /*! Storage for pointers and integers */
 317 #define IPTR void *
 318
 319 typedef long utime_t;
 320 typedef unsigned char sig_t;
 321 typedef unsigned char sigset_t;
 322 typedef unsigned char page_t;
 323
 324 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
 325         /*
 326          * ISO C99 fixed-size types
 327          * These should be in <stdint.h>, but many compilers lack them.
 328          */
 329         typedef signed char         int8_t;
 330         typedef short int           int16_t;
 331         typedef long int            int32_t;
 332         typedef unsigned char       uint8_t;
 333         typedef unsigned short int  uint16_t;
 334         typedef unsigned long int   uint32_t;
 335 #elif defined(__AVR__)
 336         /* TODO: should this detect GCC+AVR combo, or just CPU_AVR? */
 337         /* avr-libc is weird... */
 338         #include <inttypes.h>
 339 #else
 340         /* This is the correct location. */
 341         #include <stdint.h>
 342 #endif
 343
 344 /*!
 345  * \name Types for hardware registers.
 346  *
 347  * Only use these types for registers whose contents can
 348  * be changed asynchronously by external hardware.
 349  *
 350  * \{
 351  */
 352 #if CPU_DSP56K
 353         /* Registers can be accessed only through 16-bit pointers */
 354         typedef volatile uint16_t  reg16_t;
 355 #else
 356         typedef volatile uint8_t   reg8_t;
 357         typedef volatile uint16_t  reg16_t;
 358         typedef volatile uint32_t  reg32_t;
 359 #endif
 360 /*\}*/
 361
 362 #endif /* COMPILER_H */