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