src/Compiler.h

   1 /*
   2  * Copyright (C) 2003-2013 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef COMPILER_H
  21 #define COMPILER_H
  22
  23 #define GCC_CHECK_VERSION(major, minor) \
  24   (defined(__GNUC__) &&                                                 \
  25    (__GNUC__ > (major) || (__GNUC__ == (major) && __GNUC_MINOR__ >= (minor))))
  26
  27 #define GCC_MAKE_VERSION(major, minor, patchlevel) ((major) * 10000 + (minor) * 100 + patchlevel)
  28
  29 #ifdef __GNUC__
  30 #  define GCC_VERSION GCC_MAKE_VERSION(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__)
  31 #else
  32 #  define GCC_VERSION 0
  33 #endif
  34
  35 #ifdef __clang__
  36 #  define CLANG_VERSION GCC_MAKE_VERSION(__clang_major__, __clang_minor__, __clang_patchlevel__)
  37 #else
  38 #  define CLANG_VERSION 0
  39 #endif
  40
  41 /**
  42  * Are we building with gcc (not clang or any other compiler) and a
  43  * version older than the specified one?
  44  */
  45 #define GCC_OLDER_THAN(major, minor) \
  46   (GCC_VERSION && !CLANG_VERSION && \
  47    GCC_VERSION < GCC_MAKE_VERSION(major, minor, 0))
  48
  49 #if GCC_CHECK_VERSION(4,0)
  50
  51 /* GCC 4.x */
  52
  53 #define gcc_const __attribute__((const))
  54 #define gcc_deprecated __attribute__((deprecated))
  55 #define gcc_may_alias __attribute__((may_alias))
  56 #define gcc_malloc __attribute__((malloc))
  57 #define gcc_noreturn __attribute__((noreturn))
  58 #define gcc_packed __attribute__((packed))
  59 #define gcc_printf(a,b) __attribute__((format(printf, a, b)))
  60 #define gcc_pure __attribute__((pure))
  61 #define gcc_sentinel __attribute__((sentinel))
  62 #define gcc_unused __attribute__((unused))
  63 #define gcc_warn_unused_result __attribute__((warn_unused_result))
  64
  65 #define gcc_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))
  66 #define gcc_nonnull_all __attribute__((nonnull))
  67
  68 #define gcc_likely(x) __builtin_expect (!!(x), 1)
  69 #define gcc_unlikely(x) __builtin_expect (!!(x), 0)
  70
  71 #define gcc_aligned(n) __attribute__((aligned(n)))
  72
  73 #define gcc_visibility_hidden __attribute__((visibility("hidden")))
  74 #define gcc_visibility_default __attribute__((visibility("default")))
  75
  76 #define gcc_always_inline __attribute__((always_inline))
  77
  78 #else
  79
  80 /* generic C compiler */
  81
  82 #define gcc_const
  83 #define gcc_deprecated
  84 #define gcc_may_alias
  85 #define gcc_malloc
  86 #define gcc_noreturn
  87 #define gcc_packed
  88 #define gcc_printf(a,b)
  89 #define gcc_pure
  90 #define gcc_sentinel
  91 #define gcc_unused
  92 #define gcc_warn_unused_result
  93
  94 #define gcc_nonnull(...)
  95 #define gcc_nonnull_all
  96
  97 #define gcc_likely(x) (x)
  98 #define gcc_unlikely(x) (x)
  99
 100 #define gcc_aligned(n)
 101
 102 #define gcc_visibility_hidden
 103 #define gcc_visibility_default
 104
 105 #define gcc_always_inline inline
 106
 107 #endif
 108
 109 #if GCC_CHECK_VERSION(4,3)
 110
 111 #define gcc_hot __attribute__((hot))
 112 #define gcc_cold __attribute__((cold))
 113
 114 #else /* ! GCC_UNUSED >= 40300 */
 115
 116 #define gcc_hot
 117 #define gcc_cold
 118
 119 #endif /* ! GCC_UNUSED >= 40300 */
 120
 121 #if GCC_CHECK_VERSION(4,6) && !defined(__clang__)
 122 #define gcc_flatten __attribute__((flatten))
 123 #else
 124 #define gcc_flatten
 125 #endif
 126
 127 #ifndef __cplusplus
 128 /* plain C99 has "restrict" */
 129 #define gcc_restrict restrict
 130 #elif GCC_CHECK_VERSION(4,0)
 131 /* "__restrict__" is a GCC extension for C++ */
 132 #define gcc_restrict __restrict__
 133 #else
 134 /* disable it on other compilers */
 135 #define gcc_restrict
 136 #endif
 137
 138 /* C++11 features */
 139
 140 #if defined(__cplusplus)
 141
 142 /* support for C++11 "override" was added in gcc 4.7 */
 143 #if GCC_OLDER_THAN(4,7)
 144 #define override
 145 #define final
 146 #endif
 147
 148 #if defined(__clang__) || GCC_CHECK_VERSION(4,8)
 149 #define gcc_alignas(T, fallback) alignas(T)
 150 #else
 151 #define gcc_alignas(T, fallback) gcc_aligned(fallback)
 152 #endif
 153
 154 #endif
 155
 156 #ifndef __has_feature
 157   // define dummy macro for non-clang compilers
 158   #define __has_feature(x) 0
 159 #endif
 160
 161 #if __has_feature(attribute_unused_on_fields)
 162 #define gcc_unused_field gcc_unused
 163 #else
 164 #define gcc_unused_field
 165 #endif
 166
 167 #if defined(__GNUC__) || defined(__clang__)
 168 #define gcc_unreachable() __builtin_unreachable()
 169 #else
 170 #define gcc_unreachable()
 171 #endif
 172
 173 #endif