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
|
/*-
* BSD LICENSE
*
* Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTE_RWLOCK_H_
#define _RTE_RWLOCK_H_
/**
* @file
*
* RTE Read-Write Locks
*
* This file defines an API for read-write locks. The lock is used to
* protect data that allows multiple readers in parallel, but only
* one writer. All readers are blocked until the writer is finished
* writing.
*
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <rte_common.h>
#include <rte_atomic.h>
#include <rte_pause.h>
/**
* The rte_rwlock_t type.
*
* cnt is -1 when write lock is held, and > 0 when read locks are held.
*/
typedef struct {
volatile int32_t cnt; /**< -1 when W lock held, > 0 when R locks held. */
} rte_rwlock_t;
/**
* A static rwlock initializer.
*/
#define RTE_RWLOCK_INITIALIZER { 0 }
/**
* Initialize the rwlock to an unlocked state.
*
* @param rwl
* A pointer to the rwlock structure.
*/
static inline void
rte_rwlock_init(rte_rwlock_t *rwl)
{
rwl->cnt = 0;
}
/**
* Take a read lock. Loop until the lock is held.
*
* @param rwl
* A pointer to a rwlock structure.
*/
static inline void
rte_rwlock_read_lock(rte_rwlock_t *rwl)
{
int32_t x;
int success = 0;
while (success == 0) {
x = rwl->cnt;
/* write lock is held */
if (x < 0) {
rte_pause();
continue;
}
success = rte_atomic32_cmpset((volatile uint32_t *)&rwl->cnt,
x, x + 1);
}
}
/**
* Release a read lock.
*
* @param rwl
* A pointer to the rwlock structure.
*/
static inline void
rte_rwlock_read_unlock(rte_rwlock_t *rwl)
{
rte_atomic32_dec((rte_atomic32_t *)(intptr_t)&rwl->cnt);
}
/**
* Take a write lock. Loop until the lock is held.
*
* @param rwl
* A pointer to a rwlock structure.
*/
static inline void
rte_rwlock_write_lock(rte_rwlock_t *rwl)
{
int32_t x;
int success = 0;
while (success == 0) {
x = rwl->cnt;
/* a lock is held */
if (x != 0) {
rte_pause();
continue;
}
success = rte_atomic32_cmpset((volatile uint32_t *)&rwl->cnt,
0, -1);
}
}
/**
* Release a write lock.
*
* @param rwl
* A pointer to a rwlock structure.
*/
static inline void
rte_rwlock_write_unlock(rte_rwlock_t *rwl)
{
rte_atomic32_inc((rte_atomic32_t *)(intptr_t)&rwl->cnt);
}
/**
* Try to execute critical section in a hardware memory transaction, if it
* fails or not available take a read lock
*
* NOTE: An attempt to perform a HW I/O operation inside a hardware memory
* transaction always aborts the transaction since the CPU is not able to
* roll-back should the transaction fail. Therefore, hardware transactional
* locks are not advised to be used around rte_eth_rx_burst() and
* rte_eth_tx_burst() calls.
*
* @param rwl
* A pointer to a rwlock structure.
*/
static inline void
rte_rwlock_read_lock_tm(rte_rwlock_t *rwl);
/**
* Commit hardware memory transaction or release the read lock if the lock is used as a fall-back
*
* @param rwl
* A pointer to the rwlock structure.
*/
static inline void
rte_rwlock_read_unlock_tm(rte_rwlock_t *rwl);
/**
* Try to execute critical section in a hardware memory transaction, if it
* fails or not available take a write lock
*
* NOTE: An attempt to perform a HW I/O operation inside a hardware memory
* transaction always aborts the transaction since the CPU is not able to
* roll-back should the transaction fail. Therefore, hardware transactional
* locks are not advised to be used around rte_eth_rx_burst() and
* rte_eth_tx_burst() calls.
*
* @param rwl
* A pointer to a rwlock structure.
*/
static inline void
rte_rwlock_write_lock_tm(rte_rwlock_t *rwl);
/**
* Commit hardware memory transaction or release the write lock if the lock is used as a fall-back
*
* @param rwl
* A pointer to a rwlock structure.
*/
static inline void
rte_rwlock_write_unlock_tm(rte_rwlock_t *rwl);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_RWLOCK_H_ */
|
