Files
@ d6b9b2ac5869
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public-bincomp/vmkernel64/release/base/vmkapi_sem.h - annotation
d6b9b2ac5869
15.1 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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 763922b5834e 0d186246d211 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 0d186246d211 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 763922b5834e 763922b5834e 0d186246d211 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 763922b5834e 763922b5834e 0d186246d211 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 763922b5834e 0d186246d211 763922b5834e 763922b5834e 0d186246d211 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 763922b5834e 0d186246d211 0d186246d211 0d186246d211 0d186246d211 763922b5834e | /* **********************************************************
* Copyright 2004 - 2009 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* Semaphores */ /**
* \addtogroup Core
* @{
* \defgroup Semaphores Semaphores
* @{
***********************************************************************
*/
#ifndef _VMKAPI_SEM_H_
#define _VMKAPI_SEM_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 Opaque handle for semaphores
*/
typedef struct vmk_SemaphoreInt *vmk_Semaphore;
/**
* \brief Opaque handle for readers-writers semaphores
*/
typedef struct vmk_SemaphoreRWInt *vmk_SemaphoreRW;
/*
***********************************************************************
* vmk_SemaCreate -- */ /**
*
* \brief Allocate and initialize a counting semaphore
*
* \note This function will not block.
*
* \note Requires that the module heap be initialized.
*
* \param[out] sema New counting semaphore.
* \param[in] moduleID Module on whose behalf the semaphore
* is created.
* \param[in] name Human-readable name of the semaphore.
* \param[in] value Initial count.
*
* \retval VMK_OK The semaphore was successfully created
* \retval VMK_NO_MEMORY The semaphore could not be allocated
* \retval VMK_NO_MODULE_HEAP The module has no heap to allocate from
*
***********************************************************************
*/
VMK_ReturnStatus vmk_SemaCreate(
vmk_Semaphore *sema,
vmk_ModuleID moduleID,
const char *name,
vmk_int32 value);
/*
***********************************************************************
* vmk_BinarySemaCreate -- */ /**
*
* \brief Allocate and initialize a binary semaphore
*
* \note This function will not block.
*
* \note Requires that the module heap be initialized.
*
* \param[out] sema New counting semaphore.
* \param[in] moduleID Module on whose behalf the semaphore
* is created.
* \param[in] name Human-readable name of the semaphore.
*
* \retval VMK_OK The semaphore was successfully created
* \retval VMK_NO_MEMORY The semaphore could not be allocated
* \retval VMK_NO_MODULE_HEAP The module has no heap to allocate from
*
***********************************************************************
*/
VMK_ReturnStatus vmk_BinarySemaCreate(
vmk_Semaphore *sema,
vmk_ModuleID moduleID,
const char *name);
/*
***********************************************************************
* vmk_SemaAssertHasState --
*
* This is used by vmk_SemaAssertLocked() and vmk_SemaAssertUnlocked().
* VMKAPI clients should not call this function directly.
*
* \note This function will not block.
*
***********************************************************************
*/
/** \cond nodoc */
void vmk_SemaAssertHasState(
vmk_Semaphore *sema,
vmk_Bool locked);
/** \endcond */
/*
***********************************************************************
* vmk_SemaAssertIsLocked -- */ /**
*
* \brief Assert that a semaphore is currently locked.
*
* \note This function will not block.
* \note This call only performs the check on a debug build.
*
* \param[in] sema Semaphore to check.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void
vmk_SemaAssertIsLocked(
vmk_Semaphore *sema)
{
#ifdef VMX86_DEBUG
vmk_SemaAssertHasState(sema, VMK_TRUE);
#endif
}
/*
***********************************************************************
* vmk_SemaAssertIsUnlocked -- */ /**
*
* \brief Assert that a semaphore is currently unlocked.
*
* \note This function will not block.
* \note This call only performs the check on a debug build.
*
* \param[in] sema Semaphore to check.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void
vmk_SemaAssertIsUnlocked(
vmk_Semaphore *sema)
{
#ifdef VMX86_DEBUG
vmk_SemaAssertHasState(sema, VMK_FALSE);
#endif
}
/*
***********************************************************************
* vmk_SemaLock -- */ /**
*
* \brief Acquire a semaphore
*
* \note This function may block.
*
* \pre Shall be called from a blockable context.
* \pre The caller shall not already hold a semaphore of lower or equal
* rank if the semaphore is a binary semaphore.
*
* \param[in] sema The semaphore to acquire.
*
***********************************************************************
*/
void vmk_SemaLock(
vmk_Semaphore *sema);
/*
***********************************************************************
* vmk_SemaTryLock -- */ /**
*
* \brief Try to acquire a semaphore.
*
* \note This function will not block.
*
* This tries to acquire the given semaphore once.
* If the semaphore is already locked, it returns immediately.
*
* \pre Shall be called from a blockable context.
*
* \param[in] sema Semaphore to attempt to acquire.
*
* \retval VMK_OK The semaphore was successfully acquired.
* \retval VMK_BUSY The semaphore is currently locked.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_SemaTryLock(
vmk_Semaphore *sema);
/*
***********************************************************************
* vmk_SemaUnlock -- */ /**
*
* \brief Release a semaphore
*
* \note This function will not block.
*
* \param[in] sema Semaphore to unlock.
*
***********************************************************************
*/
void vmk_SemaUnlock(
vmk_Semaphore *sema);
/*
***********************************************************************
* vmk_SemaDestroy -- */ /**
*
* \brief Destroy a semaphore
*
* \note This function will not block.
*
* Revert all side effects of vmk_SemaCreate or
* vmk_BinarySemaCreate.
*
* \param[in] sema Semaphore to destroy.
*
***********************************************************************
*/
void vmk_SemaDestroy(vmk_Semaphore *sema);
/*
***********************************************************************
* vmk_RWSemaCreate -- */ /**
*
* \brief Allocate and initialize a readers-writers semaphore
*
* \note This function will not block.
*
* \param[out] sema New readers-writers semaphore.
* \param[in] moduleID Module on whose behalf the semaphore
* is created.
* \param[in] name Human-readable name of the semaphore.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_RWSemaCreate(
vmk_SemaphoreRW *sema,
vmk_ModuleID moduleID,
const char *name);
/*
***********************************************************************
* vmk_RWSemaDestroy -- */ /**
*
* \brief Destroy a readers-writers semaphore
*
* \note This function will not block.
*
* Revert all side effects of vmk_RWSemaCreate.
*
* \param[in] sema Readers-writers semaphore to destroy.
*
***********************************************************************
*/
void vmk_RWSemaDestroy(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaReadLock -- */ /**
*
* \brief Acquire a readers-writers semaphore for shared read access.
*
* \note This function may block.
*
* \pre Shall be called from a blockable context.
*
* \param[in] sema Readers-writers semaphore to acquire.
*
***********************************************************************
*/
void vmk_RWSemaReadLock(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaWriteLock -- */ /**
*
* \brief Acquire a readers-writers semaphore for exclusive write
* access.
*
* \note This function may block.
*
* \pre Shall be called from a blockable context.
*
* \param[in] sema Readers-writers semaphore to acquire.
*
***********************************************************************
*/
void vmk_RWSemaWriteLock(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaReadUnlock -- */ /**
*
* \brief Release a readers-writers semaphore from shared read access.
*
* \note This function will not block.
*
* \param[in] sema Readers-writers semaphore to release.
*
***********************************************************************
*/
void vmk_RWSemaReadUnlock(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaWriteUnlock -- */ /**
*
* \brief Release a readers-writers semaphore from exclusive write
* access.
*
* \note This function will not block.
*
* \param[in] sema Readers-writers semaphore to release.
*
***********************************************************************
*/
void vmk_RWSemaWriteUnlock(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaUpgradeFromRead -- */ /**
*
* \brief Upgrade a readers-writers semaphore to exclusive write access.
*
* This requests an upgrade to exclusive writers access for the
* readers-writers semaphore while already holding shared reader access.
* If the upgrade is not immediately available, only the first caller
* can block waiting for the upgrade. Others fail, but they retain
* shared reader access.
*
* \note This function may block.
*
* \pre Shall already have read access to the semaphore.
*
* \param[in] sema Readers-writers semaphore to upgrade.
*
* \retval VMK_OK The semaphore was upgraded.
* \retval VMK_BUSY The semaphore could not be upgraded.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_RWSemaUpgradeFromRead(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaTryUpgradeFromRead -- */ /**
*
* \brief Attempt to upgrade a readers-writers semaphore to
* exclusive write access.
*
* \note This function will not block.
*
* This attempts to obtain exclusive writers access to the
* readers-writers semaphore while already holding shared reader access.
* If the upgrade is not immediately available, shared reader access
* is retained.
*
* \pre Shall already have read access to the semaphore.
*
* \param[in] sema Readers-writers semaphore to upgrade.
*
* \retval VMK_OK The semaphore was upgraded.
* \retval VMK_BUSY The semaphore could not be upgraded.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_RWSemaTryUpgradeFromRead(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaDowngradeToRead -- */ /**
*
* \brief Downgrade a readers-writers semaphore from exclusive
* write access to shared read access.
*
* \note This function will not block.
*
* \pre Shall already have write access to the semaphore.
*
* \param[in] sema Readers-writers semaphore to downgrade.
*
***********************************************************************
*/
void vmk_RWSemaDowngradeToRead(vmk_SemaphoreRW *sema);
/*
***********************************************************************
* vmk_RWSemaAssertHasReadersInt --
*
* This is used internally by vmk_RWSemaAssertHasReaders. VMKAPI
* clients should not call this function directly.
*
* \note This function will not block.
*
***********************************************************************
*/
/** \cond nodoc */
void vmk_RWSemaAssertHasReadersInt(vmk_SemaphoreRW *sema);
/** \endcond */
/*
***********************************************************************
* vmk_RWSemaAssertHasReaders -- */ /**
*
* \brief Assert that a readers-writers semaphore has at least one
* shared reader. The check is only performed in debug builds.
*
* \note This function will not block.
*
* \param[in] sema Semaphore to check.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void
vmk_RWSemaAssertHasReaders(vmk_SemaphoreRW *sema)
{
#ifdef VMX86_DEBUG
vmk_RWSemaAssertHasReadersInt(sema);
#endif
}
/*
***********************************************************************
* vmk_SemaAssertHasWriterInt --
*
* This is used internally by vmk_RWSemaAssertHasWriter. VMKAPI
* clients should not call this function directly.
*
* \note This function will not block.
*
***********************************************************************
*/
/** \cond nodoc */
void vmk_RWSemaAssertHasWriterInt(vmk_SemaphoreRW *sema);
/** \endcond */
/*
***********************************************************************
* vmk_RWSemaAssertHasWriter -- */ /**
*
* \brief Assert that a readers-writers semaphore has a writer.
* The check is only performed in debug builds.
*
* \note This call will not block.
*
* \param[in] sema Semaphore to check.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void
vmk_RWSemaAssertHasWriter(vmk_SemaphoreRW *sema)
{
#ifdef VMX86_DEBUG
vmk_RWSemaAssertHasWriterInt(sema);
#endif
}
/*
***********************************************************************
* vmk_SemaAssertHasReadersWriterInt --
*
* This is used internally by vmk_RWSemaAssertHasReadersWriter.
* VMKAPI clients should not call this function directly.
*
* \note This function will not block.
*
***********************************************************************
*/
/** \cond nodoc */
void vmk_RWSemaAssertHasReadersWriterInt(vmk_SemaphoreRW *sema);
/** \endcond */
/*
***********************************************************************
* vmk_RWSemaAssertHasReadersWriter -- */ /**
*
* \brief Assert that a readers-writers semaphore has either readers
* or a writer. The check is only performed on debug builds.
*
* \note This call will not block.
*
* \param[in] sema Semaphore to check.
*
***********************************************************************
*/
static VMK_ALWAYS_INLINE void
vmk_RWSemaAssertHasReadersWriter(vmk_SemaphoreRW *sema)
{
#ifdef VMX86_DEBUG
vmk_RWSemaAssertHasReadersWriterInt(sema);
#endif
}
#endif /* _VMKAPI_SEM_H_ */
/** @} */
/** @} */
|