| 1 | /** @file
|
|---|
| 2 | * IPRT - Spinlocks.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 9 | * available from https://www.virtualbox.org.
|
|---|
| 10 | *
|
|---|
| 11 | * This program is free software; you can redistribute it and/or
|
|---|
| 12 | * modify it under the terms of the GNU General Public License
|
|---|
| 13 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 14 | * License.
|
|---|
| 15 | *
|
|---|
| 16 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 17 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 19 | * General Public License for more details.
|
|---|
| 20 | *
|
|---|
| 21 | * You should have received a copy of the GNU General Public License
|
|---|
| 22 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 23 | *
|
|---|
| 24 | * The contents of this file may alternatively be used under the terms
|
|---|
| 25 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 26 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 27 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 28 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 29 | *
|
|---|
| 30 | * You may elect to license modified versions of this file under the
|
|---|
| 31 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 32 | *
|
|---|
| 33 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef IPRT_INCLUDED_spinlock_h
|
|---|
| 37 | #define IPRT_INCLUDED_spinlock_h
|
|---|
| 38 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 39 | # pragma once
|
|---|
| 40 | #endif
|
|---|
| 41 |
|
|---|
| 42 | #include <iprt/cdefs.h>
|
|---|
| 43 | #include <iprt/types.h>
|
|---|
| 44 |
|
|---|
| 45 | RT_C_DECLS_BEGIN
|
|---|
| 46 |
|
|---|
| 47 |
|
|---|
| 48 | /** @defgroup grp_rt_spinlock RTSpinlock - Spinlocks
|
|---|
| 49 | * @ingroup grp_rt
|
|---|
| 50 | * @{
|
|---|
| 51 | */
|
|---|
| 52 |
|
|---|
| 53 | /**
|
|---|
| 54 | * Creates a spinlock.
|
|---|
| 55 | *
|
|---|
| 56 | * @returns iprt status code.
|
|---|
| 57 | * @param pSpinlock Where to store the spinlock handle.
|
|---|
| 58 | * @param fFlags Creation flags, see RTSPINLOCK_FLAGS_XXX.
|
|---|
| 59 | * @param pszName Spinlock name, for debugging purposes. String lifetime
|
|---|
| 60 | * must be the same as the lock as it won't be copied.
|
|---|
| 61 | */
|
|---|
| 62 | RTDECL(int) RTSpinlockCreate(PRTSPINLOCK pSpinlock, uint32_t fFlags, const char *pszName);
|
|---|
| 63 |
|
|---|
| 64 | /** @name RTSPINLOCK_FLAGS_XXX
|
|---|
| 65 | * @{ */
|
|---|
| 66 | /** Disable interrupts when taking the spinlock, making it interrupt safe
|
|---|
| 67 | * (sans NMI of course).
|
|---|
| 68 | *
|
|---|
| 69 | * This is generally the safest option, though it isn't really required unless
|
|---|
| 70 | * the data being protect is also accessed from interrupt handler context. */
|
|---|
| 71 | #define RTSPINLOCK_FLAGS_INTERRUPT_SAFE RT_BIT(1)
|
|---|
| 72 | /** No need to disable interrupts, the protect code/data is not used by
|
|---|
| 73 | * interrupt handlers. */
|
|---|
| 74 | #define RTSPINLOCK_FLAGS_INTERRUPT_UNSAFE RT_BIT(2)
|
|---|
| 75 | /** @} */
|
|---|
| 76 |
|
|---|
| 77 | /**
|
|---|
| 78 | * Destroys a spinlock created by RTSpinlockCreate().
|
|---|
| 79 | *
|
|---|
| 80 | * @returns iprt status code.
|
|---|
| 81 | * @param Spinlock Spinlock returned by RTSpinlockCreate().
|
|---|
| 82 | */
|
|---|
| 83 | RTDECL(int) RTSpinlockDestroy(RTSPINLOCK Spinlock);
|
|---|
| 84 |
|
|---|
| 85 | /**
|
|---|
| 86 | * Acquires the spinlock.
|
|---|
| 87 | *
|
|---|
| 88 | * @param Spinlock The spinlock to acquire.
|
|---|
| 89 | */
|
|---|
| 90 | RTDECL(void) RTSpinlockAcquire(RTSPINLOCK Spinlock);
|
|---|
| 91 |
|
|---|
| 92 | /**
|
|---|
| 93 | * Releases the spinlock.
|
|---|
| 94 | *
|
|---|
| 95 | * @param Spinlock The spinlock to acquire.
|
|---|
| 96 | */
|
|---|
| 97 | RTDECL(void) RTSpinlockRelease(RTSPINLOCK Spinlock);
|
|---|
| 98 |
|
|---|
| 99 |
|
|---|
| 100 | /** @} */
|
|---|
| 101 |
|
|---|
| 102 | RT_C_DECLS_END
|
|---|
| 103 |
|
|---|
| 104 | #endif /* !IPRT_INCLUDED_spinlock_h */
|
|---|
| 105 |
|
|---|
