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