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