Files
@ d0a14f973771
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public/vmkernel64/release/lib/vmkapi_compiler.h
d0a14f973771
7.7 KiB
text/x-chdr
ESXi-5.0-U1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | /* **********************************************************
* Copyright 2007 - 2009 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* Compiler Utilities */ /**
* \addtogroup Lib
* @{
* \defgroup Compiler Compiler Utilities
*
* These interfaces allow easy access to special compiler-specific
* information and tags.
*
* @{
***********************************************************************
*/
#ifndef _VMKAPI_COMPILER_H_
#define _VMKAPI_COMPILER_H_
/** \cond never */
#ifndef VMK_HEADER_INCLUDED_FROM_VMKAPI_H
#error This vmkapi file should never be included directly but only via vmkapi.h
#endif
/** \endcond never */
/*
***********************************************************************
* VMK_ATTRIBUTE_NORETURN -- */ /**
*
* \brief Indicate to the compiler that the function never returns
*
***********************************************************************
*/
#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 9)
#define VMK_ATTRIBUTE_NORETURN \
__attribute__((__noreturn__))
#else
#define VMK_ATTRIBUTE_NORETURN
#endif
/*
***********************************************************************
* VMK_ATTRIBUTE_ALWAYS_INLINE -- */ /**
*
* \brief Indicate to the compiler that an inlined function should
* always be inlined.
*
***********************************************************************
*/
#if (__GNUC__ >= 3)
#define VMK_ATTRIBUTE_ALWAYS_INLINE \
__attribute__((always_inline))
#else
#define VMK_ATTRIBUTE_ALWAYS_INLINE
#endif
/*
***********************************************************************
* VMK_ATTRIBUTE_PRINTF -- */ /**
*
* \brief Compiler format checking for printf-like functions
*
* \param[in] fmt Argument number of the format string
* \param[in] vararg Argument number of the first vararg
*
***********************************************************************
*/
#if (__GNUC__ >= 3)
#define VMK_ATTRIBUTE_PRINTF(fmt, vararg) \
__attribute__((format(__printf__, fmt, vararg)))
#else
#define VMK_ATTRIBUTE_PRINTF(fmt, vararg)
#endif
/*
***********************************************************************
* VMK_ATTRIBUTE_SCANF -- */ /**
*
* \brief Compiler format checking for scanf-like functions
*
* \param[in] fmt Argument number of the format string
* \param[in] vararg Argument number of the first vararg
*
***********************************************************************
*/
#if (__GNUC__ >= 3)
#define VMK_ATTRIBUTE_SCANF(fmt, vararg) \
__attribute__((format(__scanf__, fmt, vararg)))
#else
#define VMK_ATTRIBUTE_SCANF(fmt, vararg)
#endif
/*
***********************************************************************
* VMK_INLINE -- */ /**
*
* \brief Indicate to the compiler that a function should be inlined.
*
***********************************************************************
*/
#define VMK_INLINE inline
/*
***********************************************************************
* VMK_ALWAYS_INLINE -- */ /**
*
* \brief Indicate to the compiler that a function should be inlined
* and that it should always be inlined.
*
***********************************************************************
*/
#define VMK_ALWAYS_INLINE \
inline VMK_ATTRIBUTE_ALWAYS_INLINE
/*
***********************************************************************
* VMK_ATTRIBUTE_ALIGN -- */ /**
*
* \brief Align the data structure on "n" bytes.
*
* \param[in] n Number of bytes to align the data structure on.
*
***********************************************************************
*/
#if (__GNUC__ >= 3)
#define VMK_ATTRIBUTE_ALIGN(n) \
/** \cond never */ __attribute__((__aligned__(n))) /** \endcond */
#else
#define VMK_ATTRIBUTE_ALIGN(n)
#endif
/*
***********************************************************************
* VMK_ATTRIBUTE_PACKED -- */ /**
*
* \brief Pack a data structure into the minumum number of bytes.
*
***********************************************************************
*/
#if (__GNUC__ >= 3)
#define VMK_ATTRIBUTE_PACKED \
/** \cond never */ __attribute__((__packed__)) /** \endcond */
#else
#define VMK_ATTRIBUTE_PACKED
#endif
/*
***********************************************************************
* VMK_LIKELY -- */ /**
*
* \brief Branch prediction hint to the compiler that the supplied
* expression will likely evaluate to true.
*
* \note Be aware that using this in an if-statement may mean
* the compiler will fail to issue some warnings on the
* given expression.
*
* \param[in] _exp Expression that will likely evaluate to true.
*
***********************************************************************
*/
#if (__GNUC__ >= 3)
#define VMK_LIKELY(_exp) __builtin_expect(!!(_exp), 1)
#else
#define VMK_LIKELY(_exp) (_exp)
#endif
/*
***********************************************************************
* VMK_UNLIKELY -- */ /**
*
* \brief Branch prediction hint to the compiler that the supplied
* expression will likely evaluate to false.
*
* \note Be aware that using this in an if-statement may mean
* the compiler will fail to issue some warnings on the
* given expression.
*
* \param[in] _exp Expression that will likely evaluate to false.
*
***********************************************************************
*/
#if (__GNUC__ >= 3)
#define VMK_UNLIKELY(_exp) __builtin_expect((_exp), 0)
#else
#define VMK_UNLIKELY(_exp) (_exp)
#endif
/*
***********************************************************************
* VMK_PADDED_STRUCT -- */ /**
*
* \brief Macro used for padding a struct
*
* \param _align_sz_ Align the struct to this size
* \param _fields_ fields of the struct
*
***********************************************************************
*/
#define VMK_PADDED_STRUCT(_align_sz_, _fields_) \
union { \
struct _fields_; \
char pad[((((sizeof(struct _fields_)) + (_align_sz_) - 1) / \
(_align_sz_)) * (_align_sz_))]; \
};
/*
***********************************************************************
* vmk_offsetof -- */ /**
*
* \brief Get the offset of a member of in a type
*
* \param[in] TYPE Type the member is a part of.
* \param[in] MEMBER Member to get the offset of.
*
* \returns The offset in bytes of MEMBER in TYPE.
*
***********************************************************************
*/
#define vmk_offsetof(TYPE, MEMBER) ((vmk_ByteCount) &((TYPE *)0)->MEMBER)
/*
******************************************************************************
* VMK_DEBUG_ONLY -- */ /**
*
* \brief Compile code only for debug builds.
*
* \par Example usage:
*
* \code
* VMK_DEBUG_ONLY(
* myFunc();
* x = 1;
* y = 3;
* )
* \endcode
*
******************************************************************************
*/
#if defined(VMX86_DEBUG)
#define VMK_DEBUG_ONLY(x) x
#else
#define VMK_DEBUG_ONLY(x)
#endif
#endif /* _VMKAPI_COMPILER_H_ */
/** @} */
/** @} */
|