compiler.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004, 2005 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 README.devlib for information.
   7  * -->
   8  *
   9  * \brief Additional support macros for compiler independance
  10  *
  11  * \version $Id$
  12  * \author Bernardo Innocenti <bernie@develer.com>
  13  */
  14
  15 /*#*
  16  *#* $Log$
  17  *#* Revision 1.43  2005/03/01 23:15:12  bernie
  18  *#* Remove compatibility hack.
  19  *#*
  20  *#* Revision 1.42  2005/02/16 20:28:46  bernie
  21  *#* Move PGM macros to mware/pgm.h
  22  *#*
  23  *#* Revision 1.41  2005/01/22 04:19:22  bernie
  24  *#* MTIME_INFINITE: New constant.
  25  *#*
  26  *#* Revision 1.40  2005/01/20 18:46:04  aleph
  27  *#* Add progmem datatypes; PSTR() definition.
  28  *#*/
  29 #ifndef DEVLIB_COMPILER_H
  30 #define DEVLIB_COMPILER_H
  31
  32 #include "cpu_detect.h"
  33
  34
  35 #if defined __GNUC__ && defined __GNUC_MINOR__
  36         #define GNUC_PREREQ(maj, min) \
  37                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  38 #else
  39         #define GNUC_PREREQ(maj, min) 0
  40 #endif
  41
  42 /* Some CW versions do not allow enabling C99 from the settings panel. */
  43 #if defined(__MWERKS__)
  44         #pragma c99 on
  45 #endif
  46
  47 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
  48         #define COMPILER_C99      1
  49 #else
  50         #define COMPILER_C99      0
  51 #endif
  52
  53
  54 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
  55 #define PP_CAT(x,y)         PP_CAT__(x,y)
  56 #define PP_CAT__(x,y)       x ## y
  57 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
  58 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
  59 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
  60
  61 /*! String-ize a token (allowing macros to expand) */
  62 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
  63 #define PP_STRINGIZE__(x)   #x
  64
  65
  66 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
  67         #pragma language=extended
  68         #define INTERRUPT(x)  interrupt [x]
  69         #define REGISTER      shortad
  70         #define INLINE        /* unsupported */
  71
  72         /*
  73          * Imported from <longjmp.h>. Unfortunately, we can't just include
  74          * this header because it typedefs jmp_buf to be an array of chars.
  75          * This would allow the compiler to place the buffer on an odd address.
  76          * The CPU _should_ be able to perform word accesses to
  77          * unaligned data, but there are *BUGS* in the 80196KC with
  78          * some combinations of opcodes and addressing modes. One of
  79          * these, "ST SP,[?GR]+" is used in the longjmp() implementation
  80          * provided by the IAR compiler ANSI C library. When ?GR contains
  81          * an odd address, surprisingly the CPU will copy the high order
  82          * byte of the source operand (SP) in the low order byte of the
  83          * destination operand (the memory location pointed to by ?GR).
  84          *
  85          * We also need to replace the library setjmp()/longjmp() with
  86          * our own versions because the IAR implementation "forgets" to
  87          * save the contents of local registers (?LR).
  88          */
  89         struct _JMP_BUF
  90         {
  91                 void *sp;           /* Stack pointer */
  92                 void *return_addr;  /* Return address */
  93                 int lr[6];          /* 6 local registers */
  94         };
  95
  96         typedef struct _JMP_BUF jmp_buf[1];
  97
  98         int setjmp(jmp_buf env);
  99         void longjmp(jmp_buf env, int val);
 100
 101         /* Fake bool support */
 102         #define true (1==1)
 103         #define false (1!=1)
 104         typedef unsigned char bool;
 105
 106 #elif defined(_MSC_VER) /* Win32 emulation support */
 107
 108         #include <setjmp.h>
 109
 110         /* FIXME: I can't remember why exactly this was needed (NdBernie) */
 111         #define float double
 112
 113         /* MSVC doesn't provide <stdbool.h>. */
 114         #ifndef __cplusplus
 115                 #define true (1==1)
 116                 #define false (1!=1)
 117                 typedef int bool;
 118         #endif /* !__cplusplus */
 119
 120         /* These C99 functions are oddly named in MSVCRT32.lib */
 121         #define snprintf _snprintf
 122         #define vsnprintf _vsnprintf
 123
 124 #elif defined(__GNUC__)
 125
 126         /* Compiler features */
 127         #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
 128         #define COMPILER_TYPEOF 1
 129         #define COMPILER_STATEMENT_EXPRESSIONS 1
 130
 131         /* GCC attributes */
 132         #define FORMAT(type,fmt,first)  __attribute__((__format__(type, fmt, first)))
 133         #define NORETURN                __attribute__((__noreturn__))
 134         #define UNUSED_ARG(type,arg)    __attribute__((__unused__)) type arg
 135         #define UNUSED_VAR(type,name)   __attribute__((__unused__)) type name
 136         #define USED_VAR(type,name)     __attribute__((__used__)) type name
 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         #define PURE_FUNC               __attribute__((pure))
 141         #define CONST_FUNC              __attribute__((const))
 142         #define UNUSED_FUNC             __attribute__((unused))
 143         #define USED_FUNC               __attribute__((__used__))
 144         #define RESTRICT                __restrict__
 145         #define MUST_CHECK              __attribute__((warn_unused_result))
 146         #if GNUC_PREREQ(3,1)
 147                 #define DEPRECATED  __attribute__((__deprecated__))
 148         #endif
 149
 150         #if CPU_AVR
 151                 #include <stddef.h>
 152                 #include <stdbool.h>
 153         #else
 154                 /* Include some standard C89/C99 stuff */
 155                 #include <stddef.h>
 156                 #include <setjmp.h>
 157                 #include <stdbool.h>
 158         #endif
 159
 160         #ifndef __cplusplus
 161                 /*
 162                  * Disallow some C++ keywords as identifiers in C programs,
 163                  * for improved portability.
 164                  */
 165                 #pragma GCC poison new delete class template typename
 166                 #pragma GCC poison private protected public operator
 167                 #pragma GCC poison friend mutable using namespace
 168                 #pragma GCC poison cin cout cerr clog
 169         #endif
 170
 171 #elif defined(__MWERKS__) && CPU_DSP56K
 172
 173         /* Compiler features */
 174         #define COMPILER_VARIADIC_MACROS 1
 175         #define COMPILER_TYPEOF 1
 176         #define COMPILER_STATEMENT_EXPRESSIONS 1
 177
 178         #define typeof __typeof__
 179
 180         #include <stdint.h>
 181         #include <stddef.h>
 182         #include <stdbool.h>
 183         #include <setjmp.h>
 184
 185         // CodeWarrior has size_t as built-in type, but does not define this symbol.
 186         #define _SIZE_T_DEFINED
 187
 188 #else
 189         #error unknown compiler
 190 #endif
 191
 192
 193 /* Defaults for compiler extensions. */
 194
 195 /*!
 196  * \def COMPILER_VARIADIC_MACROS
 197  * Support for macros with variable arguments.
 198  */
 199 #ifndef COMPILER_VARIADIC_MACROS
 200 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
 201 #endif
 202
 203 /*!
 204  * \def COMPILER_TYPEOF
 205  * Support for macros with variable arguments.
 206  */
 207 #ifndef COMPILER_TYPEOF
 208 #define COMPILER_TYPEOF 0
 209 #endif
 210
 211 /*!
 212  * \def COMPILER_STATEMENT_EXPRESSIONS
 213  * Support for macros with variable arguments.
 214  */
 215 #ifndef COMPILER_STATEMENT_EXPRESSIONS
 216 #define COMPILER_STATEMENT_EXPRESSIONS 0
 217 #endif
 218
 219 /* A few defaults for missing compiler features. */
 220 #ifndef INLINE
 221 #define INLINE                 static inline
 222 #endif
 223 #ifndef NORETURN
 224 #define NORETURN               /* nothing */
 225 #endif
 226 #ifndef FORMAT
 227 #define FORMAT(type,fmt,first) /* nothing */
 228 #endif
 229 #ifndef DEPRECATED
 230 #define DEPRECATED             /* nothing */
 231 #endif
 232 #ifndef UNUSED_ARG
 233 #define UNUSED_ARG(type,arg)   type arg
 234 #endif
 235 #define UNUSED                 UNUSED_ARG /* OBSOLETE */
 236 #ifndef UNUSED_VAR
 237 #define UNUSED_VAR(type,name)  type name
 238 #endif
 239 #ifndef USED_VAR
 240 #define USED_VAR(type,name)    type name
 241 #endif
 242 #ifndef REGISTER
 243 #define REGISTER               /* nothing */
 244 #endif
 245 #ifndef INTERRUPT
 246 #define INTERRUPT(x)           ERROR_NOT_IMPLEMENTED
 247 #endif
 248 #ifndef LIKELY
 249 #define LIKELY(x)              x
 250 #endif
 251 #ifndef UNLIKELY
 252 #define UNLIKELY(x)            x
 253 #endif
 254 #ifndef PURE_FUNC
 255 #define PURE_FUNC              /* nothing */
 256 #endif
 257 #ifndef CONST_FUNC
 258 #define CONST_FUNC             /* nothing */
 259 #endif
 260 #ifndef UNUSED_FUNC
 261 #define UNUSED_FUNC            /* nothing */
 262 #endif
 263 #ifndef USED_FUNC
 264 #define USED_FUNC              /* nothing */
 265 #endif
 266 #ifndef RESTRICT
 267 #define RESTRICT               /* nothing */
 268 #endif
 269 #ifndef MUST_CHECK
 270 #define MUST_CHECK             /* nothing */
 271 #endif
 272
 273 /* Misc definitions */
 274 #ifndef NULL
 275 #define NULL  (void *)0
 276 #endif
 277 #ifndef EOF
 278 #define EOF   (-1)
 279 #endif
 280
 281
 282 /* Support for hybrid C/C++ applications. */
 283 #ifdef __cplusplus
 284         #define EXTERN_C        extern "C"
 285         #define EXTERN_C_BEGIN  extern "C" {
 286         #define EXTERN_C_END    }
 287 #else
 288         #define EXTERN_C        extern
 289         #define EXTERN_C_BEGIN  /* nothing */
 290         #define EXTERN_C_END    /* nothing */
 291 #endif
 292
 293
 294 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
 295         /*!
 296          * \name ISO C99 fixed-size types
 297          *
 298          * These should be in <stdint.h>, but many compilers lack them.
 299          * \{
 300          */
 301         typedef signed char         int8_t;
 302         typedef short int           int16_t;
 303         typedef long int            int32_t;
 304         typedef unsigned char       uint8_t;
 305         typedef unsigned short int  uint16_t;
 306         typedef unsigned long int   uint32_t;
 307         /* \} */
 308 #elif defined(__GNUC__) && CPU_AVR
 309         /* avr-libc is weird... */
 310         #include <inttypes.h>
 311 #else
 312         /* This is the correct location. */
 313         #include <stdint.h>
 314 #endif
 315
 316 #if CPU_AVR_ATMEGA8
 317         /*
 318          * The ATmega8 has a very small Flash, so we can't afford
 319          * to link in support routines for 32bit integer arithmetic.
 320          */
 321         typedef int16_t mtime_t;  /*!< Type for time expressed in milliseconds. */
 322         typedef int16_t utime_t;  /*!< Type for time expressed in microseconds. */
 323         #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
 324         #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
 325         #define MTIME_INFINITE 0x7FFFL
 326 #else
 327         typedef int32_t mtime_t;  /*!< Type for time expressed in milliseconds. */
 328         typedef int32_t utime_t;  /*!< Type for time expressed in microseconds. */
 329         #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
 330         #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
 331         #define MTIME_INFINITE 0x7FFFFFFFL
 332 #endif
 333
 334 /*! Bulk storage large enough for both pointers or integers. */
 335 typedef void * iptr_t;
 336 typedef const void * const_iptr_t;
 337
 338 typedef unsigned char sig_t;     /*!< Type for signal bits. */
 339 typedef unsigned char sigmask_t; /*!< Type for signal masks. */
 340 typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 341
 342
 343 /*!
 344  * \name Standard type definitions.
 345  *
 346  * These should be in <sys/types.h> or <stddef.h>, but many compilers
 347  * and C libraries lack them.
 348  *
 349  * We check for some common definitions to avoid redefinitions:
 350  *
 351  *    glibc, avr-libc: _SIZE_T_DEFINED
 352  *    Darwin libc:     _BSD_SIZE_T_DEFINED_
 353  *
 354  * \{
 355  */
 356 #if !(defined(size_t) || defined(_SIZE_T_DEFINED) || defined(_BSD_SIZE_T_DEFINED_))
 357         #if CPU_REG_BITS > 32
 358                 /* 64bit. */
 359                 typedef unsigned long size_t;
 360                 typedef long ssize_t;
 361         #else
 362                 /* 32bit or 16bit. */
 363                 typedef unsigned int size_t;
 364                 typedef int ssize_t;
 365         #endif
 366 #endif
 367
 368 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined) || defined(_EMUL))
 369         /*! For backwards compatibility.  Use mtime_t in new code. */
 370         #define time_t mtime_t
 371         #define SIZEOF_TIME_T SIZEOF_MTIME_T
 372 #else
 373         /* Just a guess, but quite safe. */
 374         #define SIZEOF_TIME_T SIZEOF_LONG
 375 #endif /* _TIME_T_DEFINED || __time_t_defined */
 376 /*\}*/
 377
 378
 379 /*!
 380  * \name Types for hardware registers.
 381  *
 382  * Only use these types for registers whose contents can
 383  * be changed asynchronously by external hardware.
 384  *
 385  * \{
 386  */
 387 #if CPU_DSP56K
 388         /* Registers can be accessed only through 16-bit pointers */
 389         typedef volatile uint16_t  reg16_t;
 390 #else
 391         typedef volatile uint8_t   reg8_t;
 392         typedef volatile uint16_t  reg16_t;
 393         typedef volatile uint32_t  reg32_t;
 394 #endif
 395 /*\}*/
 396
 397
 398 /* Quasi-ANSI macros */
 399 #ifndef offsetof
 400         /*!
 401          * Return the byte offset of the member \a m in struct \a s.
 402          *
 403          * \note This macro should be defined in "stddef.h" and is sometimes
 404          *       compiler-specific (g++ has a builtin for it).
 405          */
 406         #define offsetof(s,m)  (size_t)&(((s *)0)->m)
 407 #endif
 408 #ifndef countof
 409         /*!
 410          * Count the number of elements in the static array \a a.
 411          *
 412          * \note This macro is non-standard, but implements a very common idiom
 413          */
 414         #define countof(a)  (sizeof(a) / sizeof(*(a)))
 415 #endif
 416
 417 /*! Issue a compilation error if the \a condition is false */
 418 #define STATIC_ASSERT(condition)  \
 419         UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
 420
 421 #endif /* DEVLIB_COMPILER_H */