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