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