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