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