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