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