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.15  2004/08/13 03:23:26  bernie
  19  * Adjust a few MSVC tweaks from older projects.
  20  *
  21  * Revision 1.14  2004/08/10 06:56:29  bernie
  22  * RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
  23  *
  24  * Revision 1.13  2004/08/02 20:20:29  aleph
  25  * Merge from project_ks
  26  *
  27  * Revision 1.12  2004/08/01 01:21:17  bernie
  28  * LIKELY(), UNLIKELY(): New compiler-specific macros.
  29  *
  30  * Revision 1.11  2004/07/30 14:34:10  rasky
  31  * Vari fix per documentazione e commenti
  32  * Aggiunte PP_CATn e STATIC_ASSERT
  33  *
  34  * Revision 1.10  2004/07/30 14:15:53  rasky
  35  * Nuovo supporto unificato per detect della CPU
  36  *
  37  * Revision 1.9  2004/07/29 22:57:09  bernie
  38  * vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
  39  *
  40  * Revision 1.8  2004/07/20 23:43:39  bernie
  41  * Use attribute((always_inline)) to force inlining.  This fixes the much
  42  * hated need of redundant prototypes for inline functions.
  43  *
  44  * Revision 1.7  2004/07/20 23:26:48  bernie
  45  * Fix two errors introduced by previous commit.
  46  *
  47  * Revision 1.6  2004/07/20 23:12:43  bernie
  48  * *** empty log message ***
  49  *
  50  * Revision 1.5  2004/07/20 17:08:03  bernie
  51  * Cleanup documentation
  52  *
  53  * Revision 1.4  2004/06/27 15:20:26  aleph
  54  * Change UNUSED() macro to accept two arguments: type and name;
  55  * Add macro GNUC_PREREQ to detect GCC version during build;
  56  * Some spacing cleanups and typo fix
  57  *
  58  * Revision 1.3  2004/06/06 18:00:39  bernie
  59  * PP_CAT(): New macro.
  60  *
  61  * Revision 1.2  2004/06/03 11:27:09  bernie
  62  * Add dual-license information.
  63  *
  64  * Revision 1.1  2004/05/23 17:48:35  bernie
  65  * Add top-level files.
  66  *
  67  */
  68 #ifndef COMPILER_H
  69 #define COMPILER_H
  70
  71 #include "arch_config.h"
  72 #include "cpu_detect.h"
  73
  74
  75 #if defined __GNUC__ && defined __GNUC_MINOR__
  76         #define GNUC_PREREQ(maj, min) \
  77                 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  78 #else
  79         #define GNUC_PREREQ(maj, min) 0
  80 #endif
  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  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 /* Quasi-ANSI macros */
 264 #ifndef offsetof
 265         /*! offsetof(s,m) - Return the byte offset of the member \a m in struct \a s */
 266         #define offsetof(s,m)   (size_t)&(((s *)0)->m)
 267 #endif
 268 #ifndef countof
 269         /*! Count the number of elements in the static array \a a */
 270         #define countof(a) (sizeof(a) / sizeof(*(a)))
 271 #endif
 272
 273
 274 /* Simple macros */
 275 #if GNUC_PREREQ(2,0)
 276         #define ABS(n) ({ \
 277                 __typeof__(n) _n = (n); \
 278                 (_n < 0) ? -_n : _n; \
 279         })
 280         #define MIN(a,b) ({ \
 281                 __typeof__(a) _a = (a); \
 282                 __typeof__(b) _b = (b); \
 283                 (void)(&_a == &_b); /* ensure same type */ \
 284                 (_a < _b) ? _a : _b; \
 285         })
 286         #define MAX(a,b) ({ \
 287                 __typeof__(a) _a = (a); \
 288                 __typeof__(b) _b = (b); \
 289                 (void)(&_a == &_b); /* ensure same type */ \
 290                 (_a > _b) ? _a : _b; \
 291         })
 292 #else /* !GNUC */
 293         /* Buggy macros for inferior compilers */
 294         #define ABS(a)          (((a) < 0) ? -(a) : (a))
 295         #define MIN(a,b)        (((a) < (b)) ? (a) : (b))
 296         #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
 297 #endif /* !GNUC */
 298
 299 #ifndef BV
 300 /*! Convert a bit value to a binary flag */
 301 #define BV(x)   (1<<(x))
 302 #endif
 303
 304 /*! Round up \a x to an even multiple of the 2's power \a pad */
 305 #define ROUND2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 306
 307 /*! Calculate a compile-time log2 for a uint8_t */
 308 #define UINT8_LOG2(x) \
 309         ((x) < 2 ? 0 : \
 310          ((x) < 4 ? 1 : \
 311           ((x) < 8 ? 2 : \
 312            ((x) < 16 ? 3 : \
 313             ((x) < 32 ? 4 : \
 314              ((x) < 64 ? 5 : \
 315               ((x) < 128 ? 6 : 7)))))))
 316
 317 /*! Calculate a compile-time log2 for a uint16_t */
 318 #define UINT16_LOG2(x) \
 319         ((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
 320
 321 /*! Calculate a compile-time log2 for a uint32_t */
 322 #define UINT32_LOG2(x) \
 323         ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 324
 325 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
 326 #define PP_CAT(x,y)         PP_CAT__(x,y)
 327 #define PP_CAT__(x,y)       x ## y
 328 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
 329 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
 330 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
 331
 332 /*! String-ize a token (allowing macros to expand) */
 333 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
 334 #define PP_STRINGIZE__(x)   #x
 335
 336 /*! Issue a compilation error if the \a condition is false */
 337 #define STATIC_ASSERT(condition)  \
 338         extern char PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]
 339
 340 /*
 341  * Standard type definitions
 342  * These should be in <sys/types.h>, but many compilers lack them.
 343  */
 344 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
 345         typedef unsigned int size_t;
 346         typedef int ssize_t;
 347 #endif
 348 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
 349         typedef long time_t;
 350 #endif /* _TIME_T_DEFINED || __time_t_defined */
 351
 352 /*! Storage for pointers and integers */
 353 #define IPTR void *
 354
 355 typedef long utime_t;
 356 typedef unsigned char sig_t;
 357 typedef unsigned char sigset_t;
 358 typedef unsigned char page_t;
 359
 360 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
 361         /*
 362          * ISO C99 fixed-size types
 363          * These should be in <stdint.h>, but many compilers lack them.
 364          */
 365         typedef signed char         int8_t;
 366         typedef short int           int16_t;
 367         typedef long int            int32_t;
 368         typedef unsigned char       uint8_t;
 369         typedef unsigned short int  uint16_t;
 370         typedef unsigned long int   uint32_t;
 371 #elif defined(__AVR__)
 372         /* TODO: should this detect GCC+AVR combo, or just CPU_AVR? */
 373         /* avr-libc is weird... */
 374         #include <inttypes.h>
 375 #else
 376         /* This is the correct location. */
 377         #include <stdint.h>
 378 #endif
 379
 380 /*!
 381  * \name Types for hardware registers.
 382  *
 383  * Only use these types for registers whose contents can
 384  * be changed asynchronously by external hardware.
 385  *
 386  * \{
 387  */
 388 #if CPU_DSP56K
 389         /* Registers can be accessed only through 16-bit pointers */
 390         typedef volatile uint16_t  reg16_t;
 391 #else
 392         typedef volatile uint8_t   reg8_t;
 393         typedef volatile uint16_t  reg16_t;
 394         typedef volatile uint32_t  reg32_t;
 395 #endif
 396 /*\}*/
 397
 398 #endif /* COMPILER_H */