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.14  2004/08/10 06:56:29  bernie
  19  * RESTRICT: New C99-like macro; STATIC_ASSERT: Fix warning for multiple invocation in one file.
  20  *
  21  * Revision 1.13  2004/08/02 20:20:29  aleph
  22  * Merge from project_ks
  23  *
  24  * Revision 1.12  2004/08/01 01:21:17  bernie
  25  * LIKELY(), UNLIKELY(): New compiler-specific macros.
  26  *
  27  * Revision 1.11  2004/07/30 14:34:10  rasky
  28  * Vari fix per documentazione e commenti
  29  * Aggiunte PP_CATn e STATIC_ASSERT
  30  *
  31  * Revision 1.10  2004/07/30 14:15:53  rasky
  32  * Nuovo supporto unificato per detect della CPU
  33  *
  34  * Revision 1.9  2004/07/29 22:57:09  bernie
  35  * vsprintf(): Remove prototype for backwards compatibility with GCC 3.4; ssize_t: Add definition for inferior compilers.
  36  *
  37  * Revision 1.8  2004/07/20 23:43:39  bernie
  38  * Use attribute((always_inline)) to force inlining.  This fixes the much
  39  * hated need of redundant prototypes for inline functions.
  40  *
  41  * Revision 1.7  2004/07/20 23:26:48  bernie
  42  * Fix two errors introduced by previous commit.
  43  *
  44  * Revision 1.6  2004/07/20 23:12:43  bernie
  45  * *** empty log message ***
  46  *
  47  * Revision 1.5  2004/07/20 17:08:03  bernie
  48  * Cleanup documentation
  49  *
  50  * Revision 1.4  2004/06/27 15:20:26  aleph
  51  * Change UNUSED() macro to accept two arguments: type and name;
  52  * Add macro GNUC_PREREQ to detect GCC version during build;
  53  * Some spacing cleanups and typo fix
  54  *
  55  * Revision 1.3  2004/06/06 18:00:39  bernie
  56  * PP_CAT(): New macro.
  57  *
  58  * Revision 1.2  2004/06/03 11:27:09  bernie
  59  * Add dual-license information.
  60  *
  61  * Revision 1.1  2004/05/23 17:48:35  bernie
  62  * Add top-level files.
  63  *
  64  */
  65 #ifndef COMPILER_H
  66 #define COMPILER_H
  67
  68 #include "arch_config.h"
  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(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)
  80         #pragma language=extended
  81         #define INTERRUPT(x)  interrupt [x]
  82         #define REGISTER      shortad
  83         #define INLINE        /* unsupported */
  84
  85         /* Imported from <longjmp.h>. Unfortunately, we can't just include
  86          * this header because it typedefs jmp_buf to be an array of chars.
  87          * This would allow the compiler to place the buffer on an odd address.
  88          * The CPU _should_ be able to perform word accesses to
  89          * unaligned data, but there are *BUGS* in the 80196KC with
  90          * some combinations of opcodes and addressing modes. One of
  91          * these, "ST SP,[?GR]+" is used in the longjmp() implementation
  92          * provided by the IAR compiler ANSI C library. When ?GR contains
  93          * an odd address, surprisingly the CPU will copy the high order
  94          * byte of the source operand (SP) in the low order byte of the
  95          * destination operand (the memory location pointed to by ?GR).
  96          *
  97          * We also need to replace the library setjmp()/longjmp() with
  98          * our own versions because the IAR implementation "forgets" to
  99          * save the contents of local registers (?LR).
 100          */
 101         struct _JMP_BUF
 102         {
 103                 void *  sp;                             /* Stack pointer */
 104                 void *  return_addr;    /* Return address */
 105                 int             lr[6];                  /* 6 local registers */
 106         };
 107
 108         typedef struct _JMP_BUF jmp_buf[1];
 109
 110         int setjmp(jmp_buf env);
 111         void longjmp(jmp_buf env, int val);
 112
 113         /* Fake bool support */
 114         #define true (1==1)
 115         #define false (1!=1)
 116         typedef unsigned char bool;
 117
 118 #elif defined(_MSC_VER) /* Win32 emulation support */
 119
 120         #include <setjmp.h>
 121         #include <time.h> /* for time_t */
 122         #define float double
 123
 124         /* Ouch, ReleaseSemaphore() conflicts with a WIN32 call ;-( */
 125         #define ReleaseSemaphore KReleaseSemaphore
 126
 127         /* Fake bool support */
 128         #ifndef __cplusplus
 129                 #define true 1
 130                 #define false 0
 131                 typedef int bool;
 132         #endif /* !__cplusplus */
 133
 134 #elif defined(__GNUC__)
 135
 136         /* GCC attributes */
 137         #define FORMAT(type,fmt,first)  __attribute__((__format__(type, fmt, first)))
 138         #define NORETURN                __attribute__((__noreturn__))
 139         #define UNUSED(type,arg)        __attribute__((__unused__)) type arg
 140         #define INLINE                  static inline __attribute__((__always_inline__))
 141         #define LIKELY(x)               __builtin_expect((x), 1)
 142         #define UNLIKELY(x)             __builtin_expect((x), 0)
 143         #define RESTRICT                __restrict__
 144         #if GNUC_PREREQ(3,1)
 145                 #define DEPRECATED      __attribute__((__deprecated__))
 146         #endif
 147
 148         #if CPU_X86
 149
 150                 /* hack to avoid conflicts with system type */
 151                 #define sigset_t system_sigset_t
 152                 #include <stddef.h>
 153                 #include <setjmp.h>
 154                 #include <stdbool.h>
 155                 #undef system_sigset_t
 156
 157         #elif CPU_AVR
 158
 159                 #include <stddef.h>
 160                 #include <stdbool.h>
 161
 162                 /* Missing printf-family functions in avr-libc/stdio.h */
 163                 #include <stdarg.h>
 164                 #include <avr/pgmspace.h>
 165                 int vsprintf_P(char *buf, const char * PROGMEM fmt, va_list ap);
 166
 167                 /* Support for harvard architectures */
 168                 #ifdef _PROGMEM
 169                         #define PGM_READ_CHAR(s) pgm_read_byte(s)
 170                         #define PGM_FUNC(x) x ## _P
 171                         #define PGM_ATTR        PROGMEM
 172                 #endif
 173
 174         #endif
 175
 176 #elif defined(__MWERKS__) && CPU_DSP56K
 177
 178         #include <stdint.h>
 179         #include <stddef.h>
 180         #include <stdbool.h>
 181         #include <setjmp.h>
 182
 183         // CodeWarrior has size_t as built-in type, but does not define this symbol.
 184         #define _SIZE_T_DEFINED
 185
 186 #else
 187         #error unknown compiler
 188 #endif
 189
 190
 191 /* A few defaults for missing compiler features. */
 192 #ifndef INLINE
 193 #define INLINE                 static inline
 194 #endif
 195 #ifndef NORETURN
 196 #define NORETURN               /* nothing */
 197 #endif
 198 #ifndef FORMAT
 199 #define FORMAT(type,fmt,first) /* nothing */
 200 #endif
 201 #ifndef DEPRECATED
 202 #define DEPRECATED             /* nothing */
 203 #endif
 204 #ifndef UNUSED
 205 #define UNUSED(type,arg)       type arg
 206 #endif
 207 #ifndef REGISTER
 208 #define REGISTER               /* nothing */
 209 #endif
 210 #ifndef INTERRUPT
 211 #define INTERRUPT(x)           ERROR_NOT_IMPLEMENTED
 212 #endif
 213 #ifndef LIKELY
 214 #define LIKELY(x)              x
 215 #endif
 216 #ifndef UNLIKELY
 217 #define UNLIKELY(x)            x
 218 #endif
 219 #ifndef RESTRICT
 220 #define RESTRICT
 221 #endif
 222
 223 /* Support for harvard architectures */
 224 #ifndef PSTR
 225 #define PSTR            /* nothing */
 226 #endif
 227 #ifndef PGM_READ_CHAR
 228 #define PGM_READ_CHAR(s) (*(s))
 229 #endif
 230 #ifndef PGM_FUNC
 231 #define PGM_FUNC(x) x
 232 #endif
 233 #ifndef PGM_ATTR
 234 #define PGM_ATTR        /* nothing */
 235 #endif
 236
 237
 238 /* Misc definitions */
 239 #ifndef NULL
 240 #define NULL  0
 241 #endif
 242 #ifndef EOF
 243 #define EOF   (-1)
 244 #endif
 245
 246
 247 /* Support for hybrid C/C++ applications. */
 248 #ifdef __cplusplus
 249         #define EXTERN_C_BEGIN  extern "C" {
 250         #define EXTERN_C_END    }
 251 #else
 252         #define EXTERN_C_BEGIN  /* nothing */
 253         #define EXTERN_C_END    /* nothing */
 254 #endif
 255
 256
 257 /* Quasi-ANSI macros */
 258 #ifndef offsetof
 259         /*! offsetof(s,m) - Return the byte offset of the member \a m in struct \a s */
 260         #define offsetof(s,m)   (size_t)&(((s *)0)->m)
 261 #endif
 262 #ifndef countof
 263         /*! Count the number of elements in the static array \a a */
 264         #define countof(a) (sizeof(a) / sizeof(*(a)))
 265 #endif
 266
 267
 268 /* Simple macros */
 269 #if GNUC_PREREQ(2,0)
 270         #define ABS(n) ({ \
 271                 __typeof__(n) _n = (n); \
 272                 (_n < 0) ? -_n : _n; \
 273         })
 274         #define MIN(a,b) ({ \
 275                 __typeof__(a) _a = (a); \
 276                 __typeof__(b) _b = (b); \
 277                 (void)(&_a == &_b); /* ensure same type */ \
 278                 (_a < _b) ? _a : _b; \
 279         })
 280         #define MAX(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 #else /* !GNUC */
 287         /* Buggy macros for inferior compilers */
 288         #define ABS(a)          (((a) < 0) ? -(a) : (a))
 289         #define MIN(a,b)        (((a) < (b)) ? (a) : (b))
 290         #define MAX(a,b)        (((a) > (b)) ? (a) : (b))
 291 #endif /* !GNUC */
 292
 293 #ifndef BV
 294 /*! Convert a bit value to a binary flag */
 295 #define BV(x)   (1<<(x))
 296 #endif
 297
 298 /*! Round up \a x to an even multiple of the 2's power \a pad */
 299 #define ROUND2(x, pad) (((x) + ((pad) - 1)) & ~((pad) - 1))
 300
 301 /*! Calculate a compile-time log2 for a uint8_t */
 302 #define UINT8_LOG2(x) \
 303         ((x) < 2 ? 0 : \
 304          ((x) < 4 ? 1 : \
 305           ((x) < 8 ? 2 : \
 306            ((x) < 16 ? 3 : \
 307             ((x) < 32 ? 4 : \
 308              ((x) < 64 ? 5 : \
 309               ((x) < 128 ? 6 : 7)))))))
 310
 311 /*! Calculate a compile-time log2 for a uint16_t */
 312 #define UINT16_LOG2(x) \
 313         ((x < 256) ? UINT8_LOG2(x) : UINT8_LOG2((x) >> 8) + 8)
 314
 315 /*! Calculate a compile-time log2 for a uint32_t */
 316 #define UINT32_LOG2(x) \
 317         ((x < 65536UL) ? UINT16_LOG2(x) : UINT16_LOG2((x) >> 16) + 16)
 318
 319 /*! Concatenate two different preprocessor tokens (allowing macros to expand) */
 320 #define PP_CAT(x,y)         PP_CAT__(x,y)
 321 #define PP_CAT__(x,y)       x ## y
 322 #define PP_CAT3(x,y,z)      PP_CAT(PP_CAT(x,y),z)
 323 #define PP_CAT4(x,y,z,w)    PP_CAT(PP_CAT3(x,y,z),w)
 324 #define PP_CAT5(x,y,z,w,j)  PP_CAT(PP_CAT4(x,y,z,w),j)
 325
 326 /*! String-ize a token (allowing macros to expand) */
 327 #define PP_STRINGIZE(x)     PP_STRINGIZE__(x)
 328 #define PP_STRINGIZE__(x)   #x
 329
 330 /*! Issue a compilation error if the \a condition is false */
 331 #define STATIC_ASSERT(condition)  \
 332         extern char PP_CAT(CT_ASSERT___, __LINE__)[(condition) ? 1 : -1]
 333
 334 /*
 335  * Standard type definitions
 336  * These should be in <sys/types.h>, but many compilers lack them.
 337  */
 338 #if !(defined(size_t) || defined(_SIZE_T_DEFINED))
 339         typedef unsigned int size_t;
 340         typedef int ssize_t;
 341 #endif
 342 #if !(defined(_TIME_T_DEFINED) || defined(__time_t_defined))
 343         typedef long time_t;
 344 #endif /* _TIME_T_DEFINED || __time_t_defined */
 345
 346 /*! Storage for pointers and integers */
 347 #define IPTR void *
 348
 349 typedef long utime_t;
 350 typedef unsigned char sig_t;
 351 typedef unsigned char sigset_t;
 352 typedef unsigned char page_t;
 353
 354 #if (defined(_MSC_VER) || defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__))
 355         /*
 356          * ISO C99 fixed-size types
 357          * These should be in <stdint.h>, but many compilers lack them.
 358          */
 359         typedef signed char         int8_t;
 360         typedef short int           int16_t;
 361         typedef long int            int32_t;
 362         typedef unsigned char       uint8_t;
 363         typedef unsigned short int  uint16_t;
 364         typedef unsigned long int   uint32_t;
 365 #elif defined(__AVR__)
 366         /* TODO: should this detect GCC+AVR combo, or just CPU_AVR? */
 367         /* avr-libc is weird... */
 368         #include <inttypes.h>
 369 #else
 370         /* This is the correct location. */
 371         #include <stdint.h>
 372 #endif
 373
 374 /*!
 375  * \name Types for hardware registers.
 376  *
 377  * Only use these types for registers whose contents can
 378  * be changed asynchronously by external hardware.
 379  *
 380  * \{
 381  */
 382 #if CPU_DSP56K
 383         /* Registers can be accessed only through 16-bit pointers */
 384         typedef volatile uint16_t  reg16_t;
 385 #else
 386         typedef volatile uint8_t   reg8_t;
 387         typedef volatile uint16_t  reg16_t;
 388         typedef volatile uint32_t  reg32_t;
 389 #endif
 390 /*\}*/
 391
 392 #endif /* COMPILER_H */