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