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
|
/** @file
* IPRT - Spinlocks.
*/
/*
* Copyright (C) 2006-2020 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef IPRT_INCLUDED_spinlock_h
#define IPRT_INCLUDED_spinlock_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/cdefs.h>
#include <iprt/types.h>
RT_C_DECLS_BEGIN
/** @defgroup grp_rt_spinlock RTSpinlock - Spinlocks
* @ingroup grp_rt
* @{
*/
/**
* Creates a spinlock.
*
* @returns iprt status code.
* @param pSpinlock Where to store the spinlock handle.
* @param fFlags Creation flags, see RTSPINLOCK_FLAGS_XXX.
* @param pszName Spinlock name, for debugging purposes. String lifetime
* must be the same as the lock as it won't be copied.
*/
RTDECL(int) RTSpinlockCreate(PRTSPINLOCK pSpinlock, uint32_t fFlags, const char *pszName);
/** @name RTSPINLOCK_FLAGS_XXX
* @{ */
/** Disable interrupts when taking the spinlock, making it interrupt safe
* (sans NMI of course).
*
* This is generally the safest option, though it isn't really required unless
* the data being protect is also accessed from interrupt handler context. */
#define RTSPINLOCK_FLAGS_INTERRUPT_SAFE RT_BIT(1)
/** No need to disable interrupts, the protect code/data is not used by
* interrupt handlers. */
#define RTSPINLOCK_FLAGS_INTERRUPT_UNSAFE RT_BIT(2)
/** @} */
/**
* Destroys a spinlock created by RTSpinlockCreate().
*
* @returns iprt status code.
* @param Spinlock Spinlock returned by RTSpinlockCreate().
*/
RTDECL(int) RTSpinlockDestroy(RTSPINLOCK Spinlock);
/**
* Acquires the spinlock.
*
* @param Spinlock The spinlock to acquire.
*/
RTDECL(void) RTSpinlockAcquire(RTSPINLOCK Spinlock);
/**
* Releases the spinlock.
*
* @param Spinlock The spinlock to acquire.
*/
RTDECL(void) RTSpinlockRelease(RTSPINLOCK Spinlock);
/** @} */
RT_C_DECLS_END
#endif /* !IPRT_INCLUDED_spinlock_h */
|
