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