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