bertos/cfg/compiler.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2001, 2002, 2003 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief Additional support macros for compiler independance
  35  *
  36  * \version $Id$
  37  * \author Bernie Innocenti <bernie@codewiz.org>
  38  */
  39
  40 #ifndef BERTOS_COMPILER_H
  41 #define BERTOS_COMPILER_H
  42
  43 #include <cpu/detect.h>
  44
  45
  46 #if defined __GNUC__ && defined __GNUC_MINOR__
  47         #define GNUC_PREREQ(maj, min) \
  48                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  49 #else
  50         #define GNUC_PREREQ(maj, min) 0
  51 #endif
  52
  53 /* Some CW versions do not allow enabling C99 from the settings panel. */
  54 #if defined(__MWERKS__)
  55         #pragma c99 on
  56 #endif
  57
  58 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
  59         #define COMPILER_C99      1
  60 #else
  61         #define COMPILER_C99      0
  62 #endif
  63
  64
  65 /** Concatenate two different preprocessor tokens (allowing macros to expand) */
  66 #define PP_CAT(x,y)         PP_CAT__(x,y)
  67 #define PP_CAT__(x,y)       x ## y
  68 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
  69 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
  70 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
  71
  72 /** String-ize a token (allowing macros to expand) */
  73 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
  74 #define PP_STRINGIZE__(x)   #x
  75
  76
  77 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
  78
  79         #pragma language=extended
  80
  81         #if CPU_ARM
  82
  83                 #define COMPILER_VARIADIC_MACROS 1
  84
  85                 #define INTERRUPT(x)  __irq __arm void x (void)
  86                 #define INLINE        static inline
  87
  88                 /* Include some standard C89/C99 stuff */
  89                 #include <stddef.h>
  90                 #include <stdint.h>
  91                 #include <stdbool.h>
  92
  93         #elif CPU_I196
  94
  95                 // IAR has size_t as built-in type, but does not define this symbol.
  96                 #define _SIZE_T_DEFINED
  97
  98                 #define INTERRUPT(x)  interrupt [x]
  99                 #define REGISTER      shortad
 100                 #define INLINE        /* unsupported */
 101
 102                 /*
 103                  * Imported from <longjmp.h>. Unfortunately, we can't just include
 104                  * this header because it typedefs jmp_buf to be an array of chars.
 105                  * This would allow the compiler to place the buffer on an odd address.
 106                  * The CPU _should_ be able to perform word accesses to
 107                  * unaligned data, but there are *BUGS* in the 80196KC with
 108                  * some combinations of opcodes and addressing modes. One of
 109                  * these, "ST SP,[?GR]+" is used in the longjmp() implementation
 110                  * provided by the IAR compiler ANSI C library. When ?GR contains
 111                  * an odd address, surprisingly the CPU will copy the high order
 112                  * byte of the source operand (SP) in the low order byte of the
 113                  * destination operand (the memory location pointed to by ?GR).
 114                  *
 115                  * We also need to replace the library setjmp()/longjmp() with
 116                  * our own versions because the IAR implementation "forgets" to
 117                  * save the contents of local registers (?LR).
 118                  */
 119                 struct _JMP_BUF
 120                 {
 121                         void *sp;           /* Stack pointer */
 122                         void *return_addr;  /* Return address */
 123                         int lr[6];          /* 6 local registers */
 124                 };
 125
 126                 typedef struct _JMP_BUF jmp_buf[1];
 127
 128                 int setjmp(jmp_buf env);
 129                 void longjmp(jmp_buf env, int val);
 130
 131                 /* Fake bool support */
 132                 #define true (1==1)
 133                 #define false (1!=1)
 134                 typedef unsigned char bool;
 135
 136         #else
 137                 #error Unsupported CPU
 138         #endif
 139
 140 #elif defined(_MSC_VER) /* Win32 emulation support */
 141
 142         /* MSVC doesn't provide <stdbool.h>. */
 143         #ifndef __cplusplus
 144                 #define true (1==1)
 145                 #define false (1!=1)
 146                 typedef int bool;
 147         #endif /* !__cplusplus */
 148
 149         /* These C99 functions are oddly named in MSVCRT32.lib */
 150         #define snprintf _snprintf
 151         #define vsnprintf _vsnprintf
 152
 153         /* MSVC doesn't support C99's __func__, but has a similar extension. */
 154         #define __func__ __FUNCTION__
 155
 156         /* MSVC doesn't support C99's inline keyword */
 157         #ifndef __cplusplus
 158                 #define INLINE __inline
 159         #endif
 160
 161 #elif defined(__GNUC__)
 162
 163         /* Compiler features */
 164         #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
 165         #define COMPILER_TYPEOF 1
 166         #define COMPILER_STATEMENT_EXPRESSIONS 1
 167
 168         /* GCC attributes */
 169         #define FORMAT(type,fmt,first)  __attribute__((__format__(type, fmt, first)))
 170         #define NORETURN                __attribute__((__noreturn__))
 171         #define UNUSED_ARG(type,arg)    __attribute__((__unused__)) type arg
 172         #define UNUSED_VAR(type,name)   __attribute__((__unused__)) type name
 173         #define USED_VAR(type,name)     __attribute__((__used__)) type name
 174         #define INLINE                  static inline __attribute__((__always_inline__))
 175         #define LIKELY(x)               __builtin_expect(!!(x), 1)
 176         #define UNLIKELY(x)             __builtin_expect(!!(x), 0)
 177         #define PURE_FUNC               __attribute__((pure))
 178         #define CONST_FUNC              __attribute__((const))
 179         #define UNUSED_FUNC             __attribute__((unused))
 180         #define USED_FUNC               __attribute__((__used__))
 181         #define RESTRICT                __restrict__
 182         #define MUST_CHECK              __attribute__((warn_unused_result))
 183         #define PACKED                  __attribute__((packed))
 184         /**
 185          * Force compiler to realod context variable.
 186          */
 187         #define MEMORY_BARRIER           asm volatile ("" : : : "memory")
 188
 189         #if GNUC_PREREQ(3,1)
 190                 #define DEPRECATED  __attribute__((__deprecated__))
 191         #endif
 192
 193         #if GNUC_PREREQ(4,5)
 194                 #define UNREACHABLE() __builtin_unreachable()
 195         #endif
 196
 197         #ifndef __cplusplus
 198                 #define ASSERT_TYPE_EQUAL(var1, var2) \
 199                         STATIC_ASSERT(__builtin_types_compatible_p(typeof(var1), typeof(var2)))
 200                 #define ASSERT_TYPE_IS(var, type) \
 201                         STATIC_ASSERT(__builtin_types_compatible_p(typeof(var), type))
 202         #endif
 203
 204         /* Include some standard C89/C99 stuff */
 205         #include <stddef.h>
 206         #include <stdint.h>
 207         #include <stdbool.h>
 208         #if !CPU_AVR
 209         #include <sys/types.h> /* for ssize_t */
 210         #endif
 211
 212         #ifndef __cplusplus
 213                 /*
 214                  * Disallow some C++ keywords as identifiers in C programs,
 215                  * for improved portability.
 216                  */
 217                 #pragma GCC poison new delete class template typename
 218                 #pragma GCC poison private protected public operator
 219                 #pragma GCC poison friend mutable using namespace
 220                 #pragma GCC poison cin cout cerr clog
 221         #endif
 222
 223
 224
 225 #elif defined(__MWERKS__)
 226
 227         /* Compiler features */
 228         #define COMPILER_VARIADIC_MACROS 1
 229         #define COMPILER_TYPEOF 1
 230         #define COMPILER_STATEMENT_EXPRESSIONS 1
 231
 232         #define typeof __typeof__
 233
 234         #define UNUSED_ARG(type,arg)    type
 235
 236         #include <stddef.h>
 237         #include <stdint.h>
 238         #include <stdbool.h>
 239
 240         // CodeWarrior has size_t as built-in type, but does not define this symbol.
 241         #define _SIZE_T_DEFINED
 242
 243 #else
 244         #error unknown compiler
 245 #endif
 246
 247
 248 /* Defaults for compiler extensions. */
 249
 250 /**
 251  * \def COMPILER_VARIADIC_MACROS
 252  * Support for macros with variable arguments.
 253  */
 254 #ifndef COMPILER_VARIADIC_MACROS
 255 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
 256 #endif
 257
 258 /**
 259  * \def COMPILER_TYPEOF
 260  * Support for dynamic type identification.
 261  */
 262 #ifndef COMPILER_TYPEOF
 263 #define COMPILER_TYPEOF 0
 264 #endif
 265
 266 /**
 267  * \def COMPILER_STATEMENT_EXPRESSIONS
 268  * Support for statement expressions.
 269  */
 270 #ifndef COMPILER_STATEMENT_EXPRESSIONS
 271 #define COMPILER_STATEMENT_EXPRESSIONS 0
 272 #endif
 273
 274 /* A few defaults for missing compiler features. */
 275 #ifndef INLINE
 276 #define INLINE                 static inline
 277 #endif
 278 #ifndef NORETURN
 279 #define NORETURN               /* nothing */
 280 #endif
 281 #ifndef FORMAT
 282 #define FORMAT(type,fmt,first) /* nothing */
 283 #endif
 284 #ifndef DEPRECATED
 285 #define DEPRECATED             /* nothing */
 286 #endif
 287 #ifndef UNUSED_ARG
 288 #define UNUSED_ARG(type,arg)   type arg
 289 #endif
 290 #ifndef UNUSED_VAR
 291 #define UNUSED_VAR(type,name)  type name
 292 #endif
 293 #ifndef USED_VAR
 294 #define USED_VAR(type,name)    type name
 295 #endif
 296 #ifndef REGISTER
 297 #define REGISTER               /* nothing */
 298 #endif
 299 #ifndef LIKELY
 300 #define LIKELY(x)              x
 301 #endif
 302 #ifndef UNLIKELY
 303 #define UNLIKELY(x)            x
 304 #endif
 305 #ifndef PURE_FUNC
 306 #define PURE_FUNC              /* nothing */
 307 #endif
 308 #ifndef CONST_FUNC
 309 #define CONST_FUNC             /* nothing */
 310 #endif
 311 #ifndef UNUSED_FUNC
 312 #define UNUSED_FUNC            /* nothing */
 313 #endif
 314 #ifndef USED_FUNC
 315 #define USED_FUNC              /* nothing */
 316 #endif
 317 #ifndef RESTRICT
 318 #define RESTRICT               /* nothing */
 319 #endif
 320 #ifndef MUST_CHECK
 321 #define MUST_CHECK             /* nothing */
 322 #endif
 323 #ifndef PACKED
 324 #define PACKED                 /* nothing */
 325 #endif
 326 #ifndef MEMORY_BARRIER
 327 #define MEMORY_BARRIER         /* nothing */
 328 #warning No memory barrier defined for select compiler. If you use the kernel check it.
 329 #endif
 330 #ifndef UNREACHABLE
 331 #define UNREACHABLE() for (;;)
 332 #endif
 333
 334
 335 /* Misc definitions */
 336 #ifndef NULL
 337 #define NULL  (void *)0
 338 #endif
 339 #ifndef EOF
 340 #define EOF   (-1)
 341 #endif
 342
 343 /* Support for hybrid C/C++ applications. */
 344 #ifdef __cplusplus
 345         #define EXTERN_C        extern "C"
 346         #define EXTERN_C_BEGIN  extern "C" {
 347         #define EXTERN_C_END    }
 348         #define EXTERN_CONST    extern const
 349         #define CONST_CAST(TYPE,EXPR)   (const_cast<TYPE>(EXPR))
 350 #else
 351         #define EXTERN_C        extern
 352         #define EXTERN_C_BEGIN  /* nothing */
 353         #define EXTERN_C_END    /* nothing */
 354         #define EXTERN_CONST    const
 355         #define CONST_CAST(TYPE,EXPR)   ((TYPE)(EXPR)) /* FIXME: How can we suppress the warning in C? */
 356 #endif
 357
 358
 359 #if defined(_MSC_VER) \
 360         || ((defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)) && CPU_I196)
 361         /**
 362          * \name ISO C99 fixed-size types
 363          *
 364          * These should be in <stdint.h>, but a few compilers lack them.
 365          * \{
 366          */
 367         typedef signed char         int8_t;
 368         typedef unsigned char       uint8_t;
 369         typedef short int           int16_t;
 370         typedef unsigned short int  uint16_t;
 371         typedef long int            int32_t; /* _WIN64 safe */
 372         typedef unsigned long int   uint32_t; /* _WIN64 safe */
 373
 374         #ifdef _MSC_VER
 375                 typedef __int64              int64_t;
 376                 typedef unsigned __int64     uint64_t;
 377         #else
 378                 typedef long long            int64_t;
 379                 typedef unsigned long long   uint64_t;
 380         #endif
 381         /* \} */
 382 #else
 383         /* This is the standard location. */
 384         #include <stdint.h>
 385 #endif
 386
 387 #if CPU_AVR_ATMEGA8
 388         /*
 389          * The ATmega8 has a very small Flash, so we can't afford
 390          * to link in support routines for 32bit integer arithmetic.
 391          */
 392         typedef int16_t ticks_t;  /**< Type for time expressed in ticks. */
 393         typedef int16_t mtime_t;  /**< Type for time expressed in milliseconds. */
 394         typedef int16_t utime_t;  /**< Type for time expressed in microseconds. */
 395         #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
 396         #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
 397         #define MTIME_INFINITE 0x7FFFL
 398 #else
 399         typedef int32_t ticks_t;  /**< Type for time expressed in ticks. */
 400
 401         typedef int32_t utime_t;  /**< Type for time expressed in microseconds. */
 402         #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
 403
 404         #ifndef DEVLIB_MTIME_DEFINED
 405                 #define DEVLIB_MTIME_DEFINED 1 /* Resolve conflict with <os/hptime.h> */
 406                 typedef int32_t mtime_t;  /**< Type for time expressed in milliseconds. */
 407                 #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
 408                 #define MTIME_INFINITE 0x7FFFFFFFL
 409         #endif
 410 #endif
 411
 412 /** Bulk storage large enough for both pointers or integers. */
 413 typedef void * iptr_t;
 414
 415 /** Bulk storage large enough for both pointers to constants or integers. */
 416 typedef const void * const_iptr_t;
 417
 418 typedef unsigned char sigbit_t;  /**< Type for signal bits. */
 419 typedef unsigned char sigmask_t; /**< Type for signal masks. */
 420 typedef unsigned char page_t;    /**< Type for banked memory pages. */
 421
 422
 423 /**
 424  * \name Standard type definitions.
 425  *
 426  * These should be in <sys/types.h> or <stddef.h>, but many compilers
 427  * and C libraries lack them.
 428  *
 429  * We check for some common definitions to avoid redefinitions:
 430  *
 431  *    glibc, avr-libc: _SIZE_T_DEFINED, __ssize_t_defined
 432  *    Darwin libc:     _BSD_SIZE_T_DEFINED_, _SIZE_T
 433  *    IAR ARM:         _SIZE_T
 434  *
 435  * \{
 436  */
 437 #if !(defined(size_t) || defined(_SIZE_T_DEFINED) || defined(_BSD_SIZE_T_DEFINED_) \
 438         || defined(_SIZE_T))
 439         #if CPU_X86
 440                 /* 32bit or 64bit (32bit for _WIN64). */
 441                 typedef unsigned long size_t;
 442         #else
 443                 #error Unknown CPU
 444         #endif
 445 #endif
 446
 447 #if !(defined(ssize_t) || defined(_SSIZE_T) || defined(__ssize_t_defined))
 448         #if CPU_X86
 449                 /* 32bit or 64bit (32bit for _WIN64). */
 450                 typedef long ssize_t;
 451         #elif CPU_ARM
 452                 typedef int ssize_t;
 453         #elif CPU_AVR
 454                 /* 16bit (missing in avr-libc's sys/types.h). */
 455                 typedef int ssize_t;
 456         #else
 457                 #error Unknown CPU
 458         #endif
 459 #endif
 460 /*\}*/
 461
 462
 463 /**
 464  * \name Types for hardware registers.
 465  *
 466  * Only use these types for registers whose contents can
 467  * be changed asynchronously by external hardware.
 468  *
 469  * \{
 470  */
 471 #if CPU_DSP56K
 472         /* Registers can be accessed only through 16-bit pointers */
 473         typedef volatile uint16_t  reg16_t;
 474 #else
 475         typedef volatile uint8_t   reg8_t;
 476         typedef volatile uint16_t  reg16_t;
 477         typedef volatile uint32_t  reg32_t;
 478 #endif
 479 /*\}*/
 480
 481
 482 /* Quasi-ANSI macros */
 483 #ifndef offsetof
 484         /**
 485          * Return the byte offset of the member \a m in struct \a s.
 486          *
 487          * \note This macro should be defined in "stddef.h" and is sometimes
 488          *       compiler-specific (g++ has a builtin for it).
 489          */
 490         #define offsetof(s,m)  (size_t)&(((s *)0)->m)
 491 #endif
 492 #ifndef countof
 493         /**
 494          * Count the number of elements in the static array \a a.
 495          *
 496          * \note This macro is non-standard, but implements a very common idiom
 497          */
 498         #define countof(a)  (sizeof(a) / sizeof(*(a)))
 499 #endif
 500 #ifndef alignof
 501         /**
 502          * Return the alignment in memory of a generic data type.
 503          *
 504          * \note We need to worry about alignment when allocating memory that
 505          * will be used later by unknown objects (e.g., malloc()) or, more
 506          * generally, whenever creating generic container types.
 507          */
 508         #define alignof(type) offsetof(struct { char c; type member; }, member)
 509 #endif
 510
 511 /**
 512  * Cast a member of a structure out to the containing structure.
 513  *
 514  * \param ptr     the pointer to the member.
 515  * \param type    the type of the container struct this is embedded in.
 516  * \param member  the name of the member within the struct.
 517  */
 518 #if COMPILER_TYPEOF && COMPILER_STATEMENT_EXPRESSIONS
 519         #define containerof(ptr, type, member) ({ \
 520                 typeof( ((type *)0)->member ) *_mptr = (ptr); /* type check */ \
 521                 (type *)(void *)((char *)_mptr - offsetof(type, member)); \
 522         })
 523 #else
 524         #define containerof(ptr, type, member) \
 525                 ( (type *)(void *)((char *)(ptr) - offsetof(type, member)) )
 526 #endif
 527
 528 /** Issue a compilation error if the \a condition is false */
 529 #define STATIC_ASSERT(condition)  \
 530         UNUSED_VAR(extern char, STATIC_ASSERTION_FAILED__[(condition) ? 1 : -1])
 531
 532 #ifndef ASSERT_TYPE_EQUAL
 533         /** Ensure two variables have the same type. */
 534         #define ASSERT_TYPE_EQUAL(var1, var2)  \
 535                         do { (void)(&(var1) == &(var2)); } while(0)
 536 #endif
 537
 538 #ifndef ASSERT_TYPE_IS
 539         /** Ensure variable is of specified type. */
 540         #define ASSERT_TYPE_IS(var, type)  \
 541                         do { (void)(&(var) == (type *)0); } while(0)
 542 #endif
 543
 544 #endif /* BERTOS_COMPILER_H */