1 #ifndef __sctp_lock_bsd_h__
2 #define __sctp_lock_bsd_h__
4 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * b) Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the distribution.
16 * c) Neither the name of Cisco Systems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
34 * General locking concepts: The goal of our locking is to of course provide
35 * consistency and yet minimize overhead. We will attempt to use
36 * non-recursive locks which are supposed to be quite inexpensive. Now in
37 * order to do this the goal is that most functions are not aware of locking.
38 * Once we have a TCB we lock it and unlock when we are through. This means
39 * that the TCB lock is kind-of a "global" lock when working on an
40 * association. Caution must be used when asserting a TCB_LOCK since if we
41 * recurse we deadlock.
43 * Most other locks (INP and INFO) attempt to localize the locking i.e. we try
44 * to contain the lock and unlock within the function that needs to lock it.
45 * This sometimes mean we do extra locks and unlocks and lose a bit of
46 * efficency, but if the performance statements about non-recursive locks are
47 * true this should not be a problem. One issue that arises with this only
48 * lock when needed is that if an implicit association setup is done we have
49 * a problem. If at the time I lookup an association I have NULL in the tcb
50 * return, by the time I call to create the association some other processor
51 * could have created it. This is what the CREATE lock on the endpoint.
52 * Places where we will be implicitly creating the association OR just
53 * creating an association (the connect call) will assert the CREATE_INP
54 * lock. This will assure us that during all the lookup of INP and INFO if
55 * another creator is also locking/looking up we can gate the two to
56 * synchronize. So the CREATE_INP lock is also another one we must use
57 * extreme caution in locking to make sure we don't hit a re-entrancy issue.
59 * For non FreeBSD 5.x we provide a bunch of EMPTY lock macros so we can
60 * blatantly put locks everywhere and they reduce to nothing on
61 * NetBSD/OpenBSD and FreeBSD 4.x
66 * When working with the global SCTP lists we lock and unlock the INP_INFO
67 * lock. So when we go to lookup an association we will want to do a
68 * SCTP_INP_INFO_RLOCK() and then when we want to add a new association to
69 * the SCTP_BASE_INFO() list's we will do a SCTP_INP_INFO_WLOCK().
71 #include <sys/cdefs.h>
72 __FBSDID("$FreeBSD$");
75 extern struct sctp_foo_stuff sctp_logoff[];
76 extern int sctp_logoff_stuff;
78 #define SCTP_IPI_COUNT_INIT()
80 #define SCTP_STATLOG_INIT_LOCK()
81 #define SCTP_STATLOG_LOCK()
82 #define SCTP_STATLOG_UNLOCK()
83 #define SCTP_STATLOG_DESTROY()
85 #define SCTP_INP_INFO_LOCK_DESTROY() do { \
86 if(rw_wowned(&SCTP_BASE_INFO(ipi_ep_mtx))) { \
87 rw_wunlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
89 rw_destroy(&SCTP_BASE_INFO(ipi_ep_mtx)); \
92 #define SCTP_INP_INFO_LOCK_INIT() \
93 rw_init(&SCTP_BASE_INFO(ipi_ep_mtx), "sctp-info");
96 #define SCTP_INP_INFO_RLOCK() do { \
97 rw_rlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
101 #define SCTP_INP_INFO_WLOCK() do { \
102 rw_wlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
106 #define SCTP_INP_INFO_RUNLOCK() rw_runlock(&SCTP_BASE_INFO(ipi_ep_mtx))
107 #define SCTP_INP_INFO_WUNLOCK() rw_wunlock(&SCTP_BASE_INFO(ipi_ep_mtx))
110 #define SCTP_IPI_ADDR_INIT() \
111 rw_init(&SCTP_BASE_INFO(ipi_addr_mtx), "sctp-addr")
112 #define SCTP_IPI_ADDR_DESTROY() do { \
113 if(rw_wowned(&SCTP_BASE_INFO(ipi_addr_mtx))) { \
114 rw_wunlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
116 rw_destroy(&SCTP_BASE_INFO(ipi_addr_mtx)); \
118 #define SCTP_IPI_ADDR_RLOCK() do { \
119 rw_rlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
121 #define SCTP_IPI_ADDR_WLOCK() do { \
122 rw_wlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
125 #define SCTP_IPI_ADDR_RUNLOCK() rw_runlock(&SCTP_BASE_INFO(ipi_addr_mtx))
126 #define SCTP_IPI_ADDR_WUNLOCK() rw_wunlock(&SCTP_BASE_INFO(ipi_addr_mtx))
129 #define SCTP_IPI_ITERATOR_WQ_INIT() \
130 mtx_init(&sctp_it_ctl.ipi_iterator_wq_mtx, "sctp-it-wq", "sctp_it_wq", MTX_DEF)
132 #define SCTP_IPI_ITERATOR_WQ_DESTROY() \
133 mtx_destroy(&sctp_it_ctl.ipi_iterator_wq_mtx)
135 #define SCTP_IPI_ITERATOR_WQ_LOCK() do { \
136 mtx_lock(&sctp_it_ctl.ipi_iterator_wq_mtx); \
139 #define SCTP_IPI_ITERATOR_WQ_UNLOCK() mtx_unlock(&sctp_it_ctl.ipi_iterator_wq_mtx)
142 #define SCTP_IP_PKTLOG_INIT() \
143 mtx_init(&SCTP_BASE_INFO(ipi_pktlog_mtx), "sctp-pktlog", "packetlog", MTX_DEF)
146 #define SCTP_IP_PKTLOG_LOCK() do { \
147 mtx_lock(&SCTP_BASE_INFO(ipi_pktlog_mtx)); \
150 #define SCTP_IP_PKTLOG_UNLOCK() mtx_unlock(&SCTP_BASE_INFO(ipi_pktlog_mtx))
152 #define SCTP_IP_PKTLOG_DESTROY() \
153 mtx_destroy(&SCTP_BASE_INFO(ipi_pktlog_mtx))
160 * The INP locks we will use for locking an SCTP endpoint, so for example if
161 * we want to change something at the endpoint level for example random_store
162 * or cookie secrets we lock the INP level.
165 #define SCTP_INP_READ_INIT(_inp) \
166 mtx_init(&(_inp)->inp_rdata_mtx, "sctp-read", "inpr", MTX_DEF | MTX_DUPOK)
168 #define SCTP_INP_READ_DESTROY(_inp) \
169 mtx_destroy(&(_inp)->inp_rdata_mtx)
171 #define SCTP_INP_READ_LOCK(_inp) do { \
172 mtx_lock(&(_inp)->inp_rdata_mtx); \
176 #define SCTP_INP_READ_UNLOCK(_inp) mtx_unlock(&(_inp)->inp_rdata_mtx)
179 #define SCTP_INP_LOCK_INIT(_inp) \
180 mtx_init(&(_inp)->inp_mtx, "sctp-inp", "inp", MTX_DEF | MTX_DUPOK)
181 #define SCTP_ASOC_CREATE_LOCK_INIT(_inp) \
182 mtx_init(&(_inp)->inp_create_mtx, "sctp-create", "inp_create", \
185 #define SCTP_INP_LOCK_DESTROY(_inp) \
186 mtx_destroy(&(_inp)->inp_mtx)
188 #define SCTP_INP_LOCK_CONTENDED(_inp) ((_inp)->inp_mtx.mtx_lock & MTX_CONTESTED)
190 #define SCTP_INP_READ_CONTENDED(_inp) ((_inp)->inp_rdata_mtx.mtx_lock & MTX_CONTESTED)
192 #define SCTP_ASOC_CREATE_LOCK_CONTENDED(_inp) ((_inp)->inp_create_mtx.mtx_lock & MTX_CONTESTED)
195 #define SCTP_ASOC_CREATE_LOCK_DESTROY(_inp) \
196 mtx_destroy(&(_inp)->inp_create_mtx)
199 #ifdef SCTP_LOCK_LOGGING
200 #define SCTP_INP_RLOCK(_inp) do { \
201 if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) sctp_log_lock(_inp, (struct sctp_tcb *)NULL, SCTP_LOG_LOCK_INP);\
202 mtx_lock(&(_inp)->inp_mtx); \
205 #define SCTP_INP_WLOCK(_inp) do { \
206 if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) sctp_log_lock(_inp, (struct sctp_tcb *)NULL, SCTP_LOG_LOCK_INP);\
207 mtx_lock(&(_inp)->inp_mtx); \
212 #define SCTP_INP_RLOCK(_inp) do { \
213 mtx_lock(&(_inp)->inp_mtx); \
216 #define SCTP_INP_WLOCK(_inp) do { \
217 mtx_lock(&(_inp)->inp_mtx); \
223 #define SCTP_TCB_SEND_LOCK_INIT(_tcb) \
224 mtx_init(&(_tcb)->tcb_send_mtx, "sctp-send-tcb", "tcbs", MTX_DEF | MTX_DUPOK)
226 #define SCTP_TCB_SEND_LOCK_DESTROY(_tcb) mtx_destroy(&(_tcb)->tcb_send_mtx)
228 #define SCTP_TCB_SEND_LOCK(_tcb) do { \
229 mtx_lock(&(_tcb)->tcb_send_mtx); \
232 #define SCTP_TCB_SEND_UNLOCK(_tcb) mtx_unlock(&(_tcb)->tcb_send_mtx)
234 #define SCTP_INP_INCR_REF(_inp) atomic_add_int(&((_inp)->refcount), 1)
235 #define SCTP_INP_DECR_REF(_inp) atomic_add_int(&((_inp)->refcount), -1)
238 #ifdef SCTP_LOCK_LOGGING
239 #define SCTP_ASOC_CREATE_LOCK(_inp) \
241 if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) sctp_log_lock(_inp, (struct sctp_tcb *)NULL, SCTP_LOG_LOCK_CREATE); \
242 mtx_lock(&(_inp)->inp_create_mtx); \
246 #define SCTP_ASOC_CREATE_LOCK(_inp) \
248 mtx_lock(&(_inp)->inp_create_mtx); \
252 #define SCTP_INP_RUNLOCK(_inp) mtx_unlock(&(_inp)->inp_mtx)
253 #define SCTP_INP_WUNLOCK(_inp) mtx_unlock(&(_inp)->inp_mtx)
254 #define SCTP_ASOC_CREATE_UNLOCK(_inp) mtx_unlock(&(_inp)->inp_create_mtx)
257 * For the majority of things (once we have found the association) we will
258 * lock the actual association mutex. This will protect all the assoiciation
259 * level queues and streams and such. We will need to lock the socket layer
260 * when we stuff data up into the receiving sb_mb. I.e. we will need to do an
261 * extra SOCKBUF_LOCK(&so->so_rcv) even though the association is locked.
264 #define SCTP_TCB_LOCK_INIT(_tcb) \
265 mtx_init(&(_tcb)->tcb_mtx, "sctp-tcb", "tcb", MTX_DEF | MTX_DUPOK)
267 #define SCTP_TCB_LOCK_DESTROY(_tcb) mtx_destroy(&(_tcb)->tcb_mtx)
269 #ifdef SCTP_LOCK_LOGGING
270 #define SCTP_TCB_LOCK(_tcb) do { \
271 if(SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) sctp_log_lock(_tcb->sctp_ep, _tcb, SCTP_LOG_LOCK_TCB); \
272 mtx_lock(&(_tcb)->tcb_mtx); \
276 #define SCTP_TCB_LOCK(_tcb) do { \
277 mtx_lock(&(_tcb)->tcb_mtx); \
283 #define SCTP_TCB_TRYLOCK(_tcb) mtx_trylock(&(_tcb)->tcb_mtx)
285 #define SCTP_TCB_UNLOCK(_tcb) mtx_unlock(&(_tcb)->tcb_mtx)
287 #define SCTP_TCB_UNLOCK_IFOWNED(_tcb) do { \
288 if (mtx_owned(&(_tcb)->tcb_mtx)) \
289 mtx_unlock(&(_tcb)->tcb_mtx); \
295 #define SCTP_TCB_LOCK_ASSERT(_tcb) do { \
296 if (mtx_owned(&(_tcb)->tcb_mtx) == 0) \
297 panic("Don't own TCB lock"); \
300 #define SCTP_TCB_LOCK_ASSERT(_tcb)
303 #define SCTP_ITERATOR_LOCK_INIT() \
304 mtx_init(&sctp_it_ctl.it_mtx, "sctp-it", "iterator", MTX_DEF)
307 #define SCTP_ITERATOR_LOCK() \
309 if (mtx_owned(&sctp_it_ctl.it_mtx)) \
310 panic("Iterator Lock"); \
311 mtx_lock(&sctp_it_ctl.it_mtx); \
314 #define SCTP_ITERATOR_LOCK() \
316 mtx_lock(&sctp_it_ctl.it_mtx); \
321 #define SCTP_ITERATOR_UNLOCK() mtx_unlock(&sctp_it_ctl.it_mtx)
322 #define SCTP_ITERATOR_LOCK_DESTROY() mtx_destroy(&sctp_it_ctl.it_mtx)
325 #define SCTP_WQ_ADDR_INIT() do { \
326 mtx_init(&SCTP_BASE_INFO(wq_addr_mtx), "sctp-addr-wq","sctp_addr_wq",MTX_DEF); \
329 #define SCTP_WQ_ADDR_DESTROY() do { \
330 if(mtx_owned(&SCTP_BASE_INFO(wq_addr_mtx))) { \
331 mtx_unlock(&SCTP_BASE_INFO(wq_addr_mtx)); \
333 mtx_destroy(&SCTP_BASE_INFO(wq_addr_mtx)); \
336 #define SCTP_WQ_ADDR_LOCK() do { \
337 mtx_lock(&SCTP_BASE_INFO(wq_addr_mtx)); \
339 #define SCTP_WQ_ADDR_UNLOCK() do { \
340 mtx_unlock(&SCTP_BASE_INFO(wq_addr_mtx)); \
345 #define SCTP_INCR_EP_COUNT() \
347 atomic_add_int(&SCTP_BASE_INFO(ipi_count_ep), 1); \
350 #define SCTP_DECR_EP_COUNT() \
352 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_ep), 1); \
355 #define SCTP_INCR_ASOC_COUNT() \
357 atomic_add_int(&SCTP_BASE_INFO(ipi_count_asoc), 1); \
360 #define SCTP_DECR_ASOC_COUNT() \
362 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_asoc), 1); \
365 #define SCTP_INCR_LADDR_COUNT() \
367 atomic_add_int(&SCTP_BASE_INFO(ipi_count_laddr), 1); \
370 #define SCTP_DECR_LADDR_COUNT() \
372 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_laddr), 1); \
375 #define SCTP_INCR_RADDR_COUNT() \
377 atomic_add_int(&SCTP_BASE_INFO(ipi_count_raddr), 1); \
380 #define SCTP_DECR_RADDR_COUNT() \
382 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_raddr),1); \
385 #define SCTP_INCR_CHK_COUNT() \
387 atomic_add_int(&SCTP_BASE_INFO(ipi_count_chunk), 1); \
390 #define SCTP_DECR_CHK_COUNT() \
392 if(SCTP_BASE_INFO(ipi_count_chunk) == 0) \
393 panic("chunk count to 0?"); \
394 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_chunk), 1); \
397 #define SCTP_DECR_CHK_COUNT() \
399 if(SCTP_BASE_INFO(ipi_count_chunk) != 0) \
400 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_chunk), 1); \
403 #define SCTP_INCR_READQ_COUNT() \
405 atomic_add_int(&SCTP_BASE_INFO(ipi_count_readq),1); \
408 #define SCTP_DECR_READQ_COUNT() \
410 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_readq), 1); \
413 #define SCTP_INCR_STRMOQ_COUNT() \
415 atomic_add_int(&SCTP_BASE_INFO(ipi_count_strmoq), 1); \
418 #define SCTP_DECR_STRMOQ_COUNT() \
420 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_strmoq), 1); \
424 #if defined(SCTP_SO_LOCK_TESTING)
425 #define SCTP_INP_SO(sctpinp) (sctpinp)->ip_inp.inp.inp_socket
426 #define SCTP_SOCKET_LOCK(so, refcnt)
427 #define SCTP_SOCKET_UNLOCK(so, refcnt)