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