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  * \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.38  2004/12/31 16:41:52  bernie
  18  *#* PROGMEM: Define to nothing for non-Harvard processors.
  19  *#*
  20  *#* Revision 1.37  2004/12/08 09:43:21  bernie
  21  *#* Metrowerks supports variadic macros.
  22  *#*
  23  *#* Revision 1.36  2004/12/08 08:55:54  bernie
  24  *#* Rename sigset_t to sigmask_t and time_t to mtime_t, to avoid conflicts with POSIX definitions.
  25  *#*
  26  *#* Revision 1.35  2004/12/08 07:35:51  bernie
  27  *#* Typo in macro name.
  28  *#*
  29  *#* Revision 1.34  2004/11/28 23:21:33  bernie
  30  *#* Use mtime_t instead of overloading ANSI time_t with new semantics.
  31  *#*
  32  *#* Revision 1.33  2004/11/16 23:09:40  bernie
  33  *#* size_t: Add 64bit definitions; time_t: Add 16bit hack for tiny CPUs.
  34  *#*
  35  *#* Revision 1.32  2004/11/16 22:42:44  bernie
  36  *#* Doxygen fixes.
  37  *#*
  38  *#* Revision 1.31  2004/11/16 22:37:28  bernie
  39  *#* IPTR: Remove obsolete definition.
  40  *#*
  41  *#* Revision 1.30  2004/11/16 22:30:19  bernie
  42  *#* Declare fixed-size types before other types.
  43  *#*
  44  *#* Revision 1.29  2004/11/16 20:34:40  bernie
  45  *#* UNUSED_VAR, USED_VAR, USED_FUNC: New macros; UNUSED_ARG: Rename from UNUSED.
  46  *#*
  47  *#* Revision 1.28  2004/10/21 11:03:52  bernie
  48  *#* Typo.
  49  *#*
  50  *#* Revision 1.27  2004/10/21 10:09:40  bernie
  51  *#* Remove spurious token in preprocessor directive.
  52  *#*
  53  *#* Revision 1.26  2004/10/19 08:55:14  bernie
  54  *#* UNUSED_FUNC: New function attribute.
  55  *#*
  56  *#* Revision 1.25  2004/10/19 07:14:20  bernie
  57  *#* Add macros to test for specific compiler features.
  58  *#*
  59  *#* Revision 1.24  2004/10/03 18:35:13  bernie
  60  *#* Poison C++ keywords in C programs for better portability.
  61  *#*
  62  *#* Revision 1.23  2004/09/20 03:30:27  bernie
  63  *#* Remove vsprintf_P() proto, no longer needed with avr-libc 1.0.4.
  64  *#*
  65  *#* Revision 1.22  2004/09/14 21:03:04  bernie
  66  *#* PURE_FUNC, CONST_FUNC, MUST_CHECK: New function attributes; LIKELY()/UNLIKELY(): Fix for non-integral expressions.
  67  *#*
  68  *#* Revision 1.21  2004/09/06 21:38:31  bernie
  69  *#* Misc documentation and style fixes.
  70  *#*
  71  *#* Revision 1.20  2004/08/29 21:57:58  bernie
  72  *#* Move back STATIC_ASSERT() to compiler.h as it's needed in cpu.h;
  73  *#* iptr_t, const_iptr_t: Replace IPTR macro with a real typedef.
  74  *#*
  75  *#* Revision 1.19  2004/08/25 14:12:08  rasky
  76  *#* Aggiornato il comment block dei log RCS
  77  *#*
  78  *#* Revision 1.18  2004/08/24 16:32:37  bernie
  79  *#* Document custom types.
  80  *#*
  81  *#* Revision 1.17  2004/08/24 13:32:14  bernie
  82  *#* PP_CAT(), PP_STRINGIZE(): Move back to compiler.h to break circular dependency between cpu.h/compiler.h/macros.h;
  83  *#* offsetof(), countof(): Move back to compiler.h to avoid including macros.h almost everywhere;
  84  *#* Trim CVS log;
  85  *#* Rename header guards;
  86  *#* Don't include arch_config.h in compiler.h as it's not needed there.
  87  *#*
  88  *#* Revision 1.16  2004/08/14 19:37:57  rasky
  89  *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
  90  *#*
  91  *#* Revision 1.15  2004/08/13 03:23:26  bernie
  92  *#* Adjust a few MSVC tweaks from older projects.
  93  *#*
  94  *#* Revision 1.14  2004/08/10 06:56:29  bernie
  95  *#* RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
  96  *#*
  97  *#* Revision 1.13  2004/08/02 20:20:29  aleph
  98  *#* Merge from project_ks
  99  *#*
 100  *#* Revision 1.12  2004/08/01 01:21:17  bernie
 101  *#* LIKELY(), UNLIKELY(): New compiler-specific macros.
 102  *#*
 103  *#* Revision 1.11  2004/07/30 14:34:10  rasky
 104  *#* Vari fix per documentazione e commenti
 105  *#* Aggiunte PP_CATn e STATIC_ASSERT
 106  *#*
 107  *#* Revision 1.10  2004/07/30 14:15:53  rasky
 108  *#* Nuovo supporto unificato per detect della CPU
 109  *#*
 110  *#* Revision 1.9  2004/07/29 22:57:09  bernie
 111  *#* vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
 112  *#*/
 113 #ifndef DEVLIB_COMPILER_H
 114 #define DEVLIB_COMPILER_H
 115
 116 #include "cpu_detect.h"
 117
 118
 119 #if defined __GNUC__ && defined __GNUC_MINOR__
 120         #define GNUC_PREREQ(maj, min) \
 121                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
 122 #else
 123         #define GNUC_PREREQ(maj, min) 0
 124 #endif
 125
 126 /* Some CW versions do not allow enabling C99 from the settings panel. */
 127 #if defined(__MWERKS__)
 128         #pragma c99 on
 129 #endif
 130
 131 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
 132         #define COMPILER_C99      1
 133 #else
 134         #define COMPILER_C99      0
 135 #endif
 136
 137
 138 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
 139 #define PP_CAT(x,y)         PP_CAT__(x,y)
 140 #define PP_CAT__(x,y)       x ## y
 141 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
 142 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
 143 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
 144
 145 /*! String-ize a token (allowing macros to expand) */
 146 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
 147 #define PP_STRINGIZE__(x)   #x
 148
 149
 150 #if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
 151         #pragma language=extended
 152         #define INTERRUPT(x)  interrupt [x]
 153         #define REGISTER      shortad
 154         #define INLINE        /* unsupported */
 155
 156         /*
 157          * Imported from <longjmp.h>. Unfortunately, we can't just include
 158          * this header because it typedefs jmp_buf to be an array of chars.
 159          * This would allow the compiler to place the buffer on an odd address.
 160          * The CPU _should_ be able to perform word accesses to
 161          * unaligned data, but there are *BUGS* in the 80196KC with
 162          * some combinations of opcodes and addressing modes. One of
 163          * these, "ST SP,[?GR]+" is used in the longjmp() implementation
 164          * provided by the IAR compiler ANSI C library. When ?GR contains
 165          * an odd address, surprisingly the CPU will copy the high order
 166          * byte of the source operand (SP) in the low order byte of the
 167          * destination operand (the memory location pointed to by ?GR).
 168          *
 169          * We also need to replace the library setjmp()/longjmp() with
 170          * our own versions because the IAR implementation "forgets" to
 171          * save the contents of local registers (?LR).
 172          */
 173         struct _JMP_BUF
 174         {
 175                 void *sp;           /* Stack pointer */
 176                 void *return_addr;  /* Return address */
 177                 int lr[6];          /* 6 local registers */
 178         };
 179
 180         typedef struct _JMP_BUF jmp_buf[1];
 181
 182         int setjmp(jmp_buf env);
 183         void longjmp(jmp_buf env, int val);
 184
 185         /* Fake bool support */
 186         #define true (1==1)
 187         #define false (1!=1)
 188         typedef unsigned char bool;
 189
 190 #elif defined(_MSC_VER) /* Win32 emulation support */
 191
 192         #include <setjmp.h>
 193
 194         /* FIXME: I can't remember why exactly this was needed (NdBernie) */
 195         #define float double
 196
 197         /* MSVC doesn't provide <stdbool.h>. */
 198         #ifndef __cplusplus
 199                 #define true (1==1)
 200                 #define false (1!=1)
 201                 typedef int bool;
 202         #endif /* !__cplusplus */
 203
 204         /* These C99 functions are oddly named in MSVCRT32.lib */
 205         #define snprintf _snprintf
 206         #define vsnprintf _vsnprintf
 207
 208 #elif defined(__GNUC__)
 209
 210         /* Compiler features */
 211         #define COMPILER_VARIADIC_MACROS 1 /* Even in C++ */
 212         #define COMPILER_TYPEOF 1
 213         #define COMPILER_STATEMENT_EXPRESSIONS 1
 214
 215         /* GCC attributes */
 216         #define FORMAT(type,fmt,first)  __attribute__((__format__(type, fmt, first)))
 217         #define NORETURN                __attribute__((__noreturn__))
 218         #define UNUSED_ARG(type,arg)    __attribute__((__unused__)) type arg
 219         #define UNUSED_VAR(type,name)   __attribute__((__unused__)) type name
 220         #define USED_VAR(type,name)     __attribute__((__used__)) type name
 221         #define INLINE                  static inline __attribute__((__always_inline__))
 222         #define LIKELY(x)               __builtin_expect(!!(x), 1)
 223         #define UNLIKELY(x)             __builtin_expect(!!(x), 0)
 224         #define PURE_FUNC               __attribute__((pure))
 225         #define CONST_FUNC              __attribute__((const))
 226         #define UNUSED_FUNC             __attribute__((unused))
 227         #define USED_FUNC               __attribute__((__used__))
 228         #define RESTRICT                __restrict__
 229         #define MUST_CHECK              __attribute__((warn_unused_result))
 230         #if GNUC_PREREQ(3,1)
 231                 #define DEPRECATED  __attribute__((__deprecated__))
 232         #endif
 233
 234         #if CPU_X86
 235
 236                 #include <stddef.h>
 237                 #include <setjmp.h>
 238                 #include <stdbool.h>
 239
 240         #elif CPU_AVR
 241
 242                 #include <stddef.h>
 243                 #include <stdbool.h>
 244
 245                 /* Support for harvard architectures */
 246                 #ifdef _PROGMEM
 247                         #include <avr/pgmspace.h>
 248                         #define PGM_READ_CHAR(s) pgm_read_byte(s)
 249                         #define PGM_FUNC(x) x ## _P
 250                         #define PGM_ATTR  PROGMEM
 251                 #endif
 252                 #define PROGMEM  __attribute__((__progmem__))
 253
 254         #endif
 255
 256         #ifndef __cplusplus
 257                 /*
 258                  * Disallow some C++ keywords as identifiers in C programs,
 259                  * for improved portability.
 260                  */
 261                 #pragma GCC poison new delete class template typename
 262                 #pragma GCC poison private protected public operator
 263                 #pragma GCC poison friend mutable using namespace
 264                 #pragma GCC poison cin cout cerr clog
 265         #endif
 266
 267 #elif defined(__MWERKS__) && CPU_DSP56K
 268
 269         /* Compiler features */
 270         #define COMPILER_VARIADIC_MACROS 1
 271         #define COMPILER_TYPEOF 1
 272         #define COMPILER_STATEMENT_EXPRESSIONS 1
 273
 274         #include <stdint.h>
 275         #include <stddef.h>
 276         #include <stdbool.h>
 277         #include <setjmp.h>
 278
 279         // CodeWarrior has size_t as built-in type, but does not define this symbol.
 280         #define _SIZE_T_DEFINED
 281
 282 #else
 283         #error unknown compiler
 284 #endif
 285
 286
 287 /* Defaults for compiler extensions. */
 288
 289 /*!
 290  * \def COMPILER_VARIADIC_MACROS
 291  * Support for macros with variable arguments.
 292  */
 293 #ifndef COMPILER_VARIADIC_MACROS
 294 #define COMPILER_VARIADIC_MACROS (COMPILER_C99 != 0)
 295 #endif
 296
 297 /*!
 298  * \def COMPILER_TYPEOF
 299  * Support for macros with variable arguments.
 300  */
 301 #ifndef COMPILER_TYPEOF
 302 #define COMPILER_TYPEOF 0
 303 #endif
 304
 305 /*!
 306  * \def COMPILER_STATEMENT_EXPRESSIONS
 307  * Support for macros with variable arguments.
 308  */
 309 #ifndef COMPILER_STATEMENT_EXPRESSIONS
 310 #define COMPILER_STATEMENT_EXPRESSIONS 0
 311 #endif
 312
 313 /* A few defaults for missing compiler features. */
 314 #ifndef INLINE
 315 #define INLINE                 static inline
 316 #endif
 317 #ifndef NORETURN
 318 #define NORETURN               /* nothing */
 319 #endif
 320 #ifndef FORMAT
 321 #define FORMAT(type,fmt,first) /* nothing */
 322 #endif
 323 #ifndef DEPRECATED
 324 #define DEPRECATED             /* nothing */
 325 #endif
 326 #ifndef UNUSED_ARG
 327 #define UNUSED_ARG(type,arg)   type arg
 328 #endif
 329 #define UNUSED                 UNUSED_ARG /* OBSOLETE */
 330 #ifndef UNUSED_VAR
 331 #define UNUSED_VAR(type,name)  type name
 332 #endif
 333 #ifndef USED_VAR
 334 #define USED_VAR(type,name)    type name
 335 #endif
 336 #ifndef REGISTER
 337 #define REGISTER               /* nothing */
 338 #endif
 339 #ifndef PROGMEM
 340 #define PROGMEM                /* nothing */
 341 #endif
 342 #ifndef INTERRUPT
 343 #define INTERRUPT(x)           ERROR_NOT_IMPLEMENTED
 344 #endif
 345 #ifndef LIKELY
 346 #define LIKELY(x)              x
 347 #endif
 348 #ifndef UNLIKELY
 349 #define UNLIKELY(x)            x
 350 #endif
 351 #ifndef PURE_FUNC
 352 #define PURE_FUNC              /* nothing */
 353 #endif
 354 #ifndef CONST_FUNC
 355 #define CONST_FUNC             /* nothing */
 356 #endif
 357 #ifndef UNUSED_FUNC
 358 #define UNUSED_FUNC            /* nothing */
 359 #endif
 360 #ifndef USED_FUNC
 361 #define USED_FUNC              /* nothing */
 362 #endif
 363 #ifndef RESTRICT
 364 #define RESTRICT               /* nothing */
 365 #endif
 366 #ifndef MUST_CHECK
 367 #define MUST_CHECK             /* nothing */
 368 #endif
 369
 370 /* Support for harvard architectures */
 371 #ifndef PSTR
 372 #define PSTR            /* nothing */
 373 #endif
 374 #ifndef PGM_READ_CHAR
 375 #define PGM_READ_CHAR(s) (*(s))
 376 #endif
 377 #ifndef PGM_FUNC
 378 #define PGM_FUNC(x) x
 379 #endif
 380 #ifndef PGM_ATTR
 381 #define PGM_ATTR        /* nothing */
 382 #endif
 383
 384 /* Misc definitions */
 385 #ifndef NULL
 386 #define NULL  (void *)0
 387 #endif
 388 #ifndef EOF
 389 #define EOF   (-1)
 390 #endif
 391
 392
 393 /* Support for hybrid C/C++ applications. */
 394 #ifdef __cplusplus
 395         #define EXTERN_C        extern "C"
 396         #define EXTERN_C_BEGIN  extern "C" {
 397         #define EXTERN_C_END    }
 398 #else
 399         #define EXTERN_C        extern
 400         #define EXTERN_C_BEGIN  /* nothing */
 401         #define EXTERN_C_END    /* nothing */
 402 #endif
 403
 404
 405 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
 406         /*!
 407          * \name ISO C99 fixed-size types
 408          *
 409          * These should be in <stdint.h>, but many compilers lack them.
 410          * \{
 411          */
 412         typedef signed char         int8_t;
 413         typedef short int           int16_t;
 414         typedef long int            int32_t;
 415         typedef unsigned char       uint8_t;
 416         typedef unsigned short int  uint16_t;
 417         typedef unsigned long int   uint32_t;
 418         /* \} */
 419 #elif defined(__GNUC__) && CPU_AVR
 420         /* avr-libc is weird... */
 421         #include <inttypes.h>
 422 #else
 423         /* This is the correct location. */
 424         #include <stdint.h>
 425 #endif
 426
 427
 428 #if CPU_AVR_ATMEGA8
 429         /*
 430          * The ATmega8 has a very small Flash, so we can't afford
 431          * to link in support routines for 32bit integer arithmetic.
 432          */
 433         typedef int16_t mtime_t;  /*!< Type for time expressed in milliseconds. */
 434         typedef int16_t utime_t;  /*!< Type for time expressed in microseconds. */
 435         #define SIZEOF_MTIME_T (16 / CPU_BITS_PER_CHAR)
 436         #define SIZEOF_UTIME_T (16 / CPU_BITS_PER_CHAR)
 437 #else
 438         typedef int32_t mtime_t;  /*!< Type for time expressed in milliseconds. */
 439         typedef int32_t utime_t;  /*!< Type for time expressed in microseconds. */
 440         #define SIZEOF_MTIME_T (32 / CPU_BITS_PER_CHAR)
 441         #define SIZEOF_UTIME_T (32 / CPU_BITS_PER_CHAR)
 442 #endif
 443
 444 /*! Bulk storage large enough for both pointers or integers. */
 445 typedef void * iptr_t;
 446 typedef const void * const_iptr_t;
 447
 448 typedef unsigned char sig_t;     /*!< Type for signal bits. */
 449 typedef unsigned char sigmask_t; /*!< Type for signal masks. */
 450 typedef unsigned char page_t;    /*!< Type for banked memory pages. */
 451
 452
 453 /*!
 454  * \name Standard type definitions.
 455  *
 456  * These should be in <sys/types.h>, but many compilers lack them.
 457  *
 458  * \{
 459  */
 460 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
 461         #if CPU_REG_BITS > 32
 462                 /* 64bit. */
 463                 typedef unsigned long size_t;
 464                 typedef long ssize_t;
 465         #else
 466                 /* 32bit or 16bit. */
 467                 typedef unsigned int size_t;
 468                 typedef int ssize_t;
 469         #endif
 470 #endif
 471
 472 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined) || defined(_EMUL))
 473         /*! For backwards compatibility.  Use mtime_t in new code. */
 474         #define time_t mtime_t
 475         #define SIZEOF_TIME_T SIZEOF_MTIME_T
 476 #else
 477         /* Just a guess, but quite safe. */
 478         #define SIZEOF_TIME_T SIZEOF_LONG
 479 #endif /* _TIME_T_DEFINED || __time_t_defined */
 480 /*\}*/
 481
 482
 483 /*!
 484  * \name Types for hardware registers.
 485  *
 486  * Only use these types for registers whose contents can
 487  * be changed asynchronously by external hardware.
 488  *
 489  * \{
 490  */
 491 #if CPU_DSP56K
 492         /* Registers can be accessed only through 16-bit pointers */
 493         typedef volatile uint16_t  reg16_t;
 494 #else
 495         typedef volatile uint8_t   reg8_t;
 496         typedef volatile uint16_t  reg16_t;
 497         typedef volatile uint32_t  reg32_t;
 498 #endif
 499 /*\}*/
 500
 501
 502 /* Quasi-ANSI macros */
 503 #ifndef offsetof
 504         /*!
 505          * Return the byte offset of the member \a m in struct \a s.
 506          *
 507          * \note This macro should be defined in "stddef.h" and is sometimes
 508          *       compiler-specific (g++ has a builtin for it).
 509          */
 510         #define offsetof(s,m)  (size_t)&(((s *)0)->m)
 511 #endif
 512 #ifndef countof
 513         /*!
 514          * Count the number of elements in the static array \a a.
 515          *
 516          * \note This macro is non-standard, but implements a very common idiom
 517          */
 518         #define countof(a)  (sizeof(a) / sizeof(*(a)))
 519 #endif
 520
 521 /*! Issue a compilation error if the \a condition is false */
 522 #define STATIC_ASSERT(condition)  \
 523         UNUSED_VAR(extern char,PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1])
 524
 525 #endif /* DEVLIB_COMPILER_H */