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