Files
@ d6b9b2ac5869
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public-bincomp/vmkernel64/release/base/vmkapi_platform.h
d6b9b2ac5869
7.7 KiB
text/x-chdr
ESXi-5.5-U2
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 256 257 258 259 260 | /* **********************************************************
* Copyright 2007 - 2009 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* Platform */ /**
* \defgroup Platform Platform
*
* Interfaces relating to the underlying platform.
*
* @{
***********************************************************************
*/
#ifndef _VMKAPI_PLATFORM_H_
#define _VMKAPI_PLATFORM_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 */
/** \brief Size of an L1 cacheline */
#define VMK_L1_CACHELINE_SIZE 64
/** \brief Type that is large enough to store CPU flags */
typedef vmk_uintptr_t vmk_CPUFlags;
/*
***********************************************************************
* VMK_ATTRIBUTE_L1_ALIGNED -- */ /**
* \ingroup Compiler
*
* \brief Indicate to the compiler that a data structure should be
* aligned on an L1 cacheline boundary.
*
***********************************************************************
*/
#define VMK_ATTRIBUTE_L1_ALIGNED VMK_ATTRIBUTE_ALIGN(VMK_L1_CACHELINE_SIZE)
/*
***********************************************************************
* vmk_CPUDisableInterrupts -- */ /**
*
* \ingroup Platform
* \brief Disable interrupts on the current CPU.
*
* \note This function will not block.
*
* \nativedriversdisallowed
*
***********************************************************************
*/
void vmk_CPUDisableInterrupts(void);
/*
***********************************************************************
* vmk_CPUEnableInterrupts -- */ /**
*
* \ingroup Platform
* \brief Enable interrupts on the current CPU.
*
* \note This function will not block.
*
* \nativedriversdisallowed
*
***********************************************************************
*/
void vmk_CPUEnableInterrupts(void);
/*
***********************************************************************
* vmk_CPUHasIntsEnabled -- */ /**
*
* \ingroup Platform
* \brief Check whether interrupts are enabled on the current CPU.
*
* \note This function will not block.
*
* \retval VMK_TRUE Interrupts are enabled on the current CPU.
* \retval VMK_FALSE Interrupts are disabled on the current CPU.
*
* \nativedriversdisallowed
*
***********************************************************************
*/
vmk_Bool vmk_CPUHasIntsEnabled(void);
/*
***********************************************************************
* VMK_ASSERT_CPU_HAS_INTS_ENABLED -- */ /**
*
* \ingroup Platform
* \brief Assert that interrupts are enabled on the current CPU.
*
* \nativedriversdisallowed
*
***********************************************************************
*/
#define VMK_ASSERT_CPU_HAS_INTS_ENABLED() \
VMK_ASSERT(vmk_CPUHasIntsEnabled())
/*
***********************************************************************
* VMK_ASSERT_CPU_HAS_INTS_DISABLED -- */ /**
*
* \ingroup Platform
* \brief Assert that interrupts are disabled on the current CPU.
*
***********************************************************************
*/
#define VMK_ASSERT_CPU_HAS_INTS_DISABLED() \
VMK_ASSERT(!vmk_CPUHasIntsEnabled())
/*
***********************************************************************
* vmk_CPUGetFlags -- */ /**
*
* \ingroup Platform
* \brief Get the current CPU's interrupt flags.
*
* \note This function will not block.
*
* \return The current CPU's interrupt flags.
*
* \nativedriversdisallowed
*
***********************************************************************
*/
vmk_CPUFlags vmk_CPUGetFlags(void);
/*
***********************************************************************
* vmk_CPUSetFlags -- */ /**
*
* \ingroup Platform
* \brief Restore the current CPU's interrupt flags
*
* \note This function will not block.
*
* \nativedriversdisallowed
*
***********************************************************************
*/
void vmk_CPUSetFlags(
vmk_CPUFlags flags);
/*
***********************************************************************
* vmk_CPUEnsureClearDF -- */ /**
*
* \ingroup Platform
* \brief Ensures that the DF bit is clear.
*
* This is useful for instructions like outs, ins, scas, movs, stos,
* cmps, lods which look at DF.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void vmk_CPUEnsureClearDF(void)
{
__asm__ __volatile__ ("cld\n\t");
}
/*
***********************************************************************
* vmk_CPUMemFenceRead -- */ /**
*
* \ingroup Platform
* \brief Ensure that all loads have completed.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void vmk_CPUMemFenceRead(void)
{
asm volatile ("lfence" ::: "memory");
}
/*
***********************************************************************
* vmk_CPUMemFenceWrite -- */ /**
*
* \ingroup Platform
* \brief Ensure that all stores are completed and globally visible.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void vmk_CPUMemFenceWrite(void)
{
asm volatile ("sfence" ::: "memory");
}
/*
***********************************************************************
* vmk_CPUMemFenceReadWrite -- */ /**
*
* \ingroup Platform
* \brief Ensure that all loads and stores are completed and globally
* visible.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void vmk_CPUMemFenceReadWrite(void)
{
asm volatile ("mfence" ::: "memory");
}
/*
***********************************************************************
* vmk_CPUCacheFlush -- */ /**
*
* \ingroup Platform
* \brief Flushes the cache lines on the local PCPU for the memory
* region specified.
*
* \note If a specific operation required flushing the cache line of
* the local PCPU, both that operation and this call should
* come within the same VMK_WITH_PCPU_DO region.
*
* \param[in] pcpu PCPU ID obtained from VMK_WITH_PCPU_DO.
* \param[in] va Starting virtual address of memory region.
* \param[in] size Size of memory region.
*
* \retval VMK_OK Cache lines successfully flushed.
* \retval VMK_BAD_PARAM An invalid parameter was specified.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_CPUCacheFlush(
vmk_PCPUID pcpu,
vmk_VA va,
vmk_ByteCount size);
/*
***********************************************************************
* vmk_CPUGlobalCacheFlush -- */ /**
*
* \ingroup Platform
* \brief Flushes all modified cache lines on all PCPUs.
*
* \note This function will block.
*
* \note This is an expensive operation that should be used rarely and
* not at all on fast paths.
*
* \retval VMK_OK Cachelines successfully flushed.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_CPUGlobalCacheFlush(void);
#endif /* _VMKAPI_PLATFORM_H_ */
/* @} */
|