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