2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
14 * b) Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the distribution.
18 * c) Neither the name of Cisco Systems, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #ifndef _NETINET_SCTP_LOCK_BSD_H_
39 #define _NETINET_SCTP_LOCK_BSD_H_
42 * General locking concepts: The goal of our locking is to of course provide
43 * consistency and yet minimize overhead. We will attempt to use
44 * non-recursive locks which are supposed to be quite inexpensive. Now in
45 * order to do this the goal is that most functions are not aware of locking.
46 * Once we have a TCB we lock it and unlock when we are through. This means
47 * that the TCB lock is kind-of a "global" lock when working on an
48 * association. Caution must be used when asserting a TCB_LOCK since if we
49 * recurse we deadlock.
51 * Most other locks (INP and INFO) attempt to localize the locking i.e. we try
52 * to contain the lock and unlock within the function that needs to lock it.
53 * This sometimes mean we do extra locks and unlocks and lose a bit of
54 * efficiency, but if the performance statements about non-recursive locks are
55 * true this should not be a problem. One issue that arises with this only
56 * lock when needed is that if an implicit association setup is done we have
57 * a problem. If at the time I lookup an association I have NULL in the tcb
58 * return, by the time I call to create the association some other processor
59 * could have created it. This is what the CREATE lock on the endpoint.
60 * Places where we will be implicitly creating the association OR just
61 * creating an association (the connect call) will assert the CREATE_INP
62 * lock. This will assure us that during all the lookup of INP and INFO if
63 * another creator is also locking/looking up we can gate the two to
64 * synchronize. So the CREATE_INP lock is also another one we must use
65 * extreme caution in locking to make sure we don't hit a re-entrancy issue.
70 * When working with the global SCTP lists we lock and unlock the INP_INFO
71 * lock. So when we go to lookup an association we will want to do a
72 * SCTP_INP_INFO_RLOCK() and then when we want to add a new association to
73 * the SCTP_BASE_INFO() list's we will do a SCTP_INP_INFO_WLOCK().
76 #define SCTP_IPI_COUNT_INIT()
78 #define SCTP_STATLOG_INIT_LOCK()
79 #define SCTP_STATLOG_DESTROY()
80 #define SCTP_STATLOG_LOCK()
81 #define SCTP_STATLOG_UNLOCK()
83 #define SCTP_INP_INFO_LOCK_INIT() do { \
84 rw_init(&SCTP_BASE_INFO(ipi_ep_mtx), "sctp-info"); \
87 #define SCTP_INP_INFO_LOCK_DESTROY() do { \
88 if (rw_wowned(&SCTP_BASE_INFO(ipi_ep_mtx))) { \
89 rw_wunlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
91 rw_destroy(&SCTP_BASE_INFO(ipi_ep_mtx)); \
94 #define SCTP_INP_INFO_RLOCK() do { \
95 rw_rlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
98 #define SCTP_INP_INFO_WLOCK() do { \
99 rw_wlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
102 #define SCTP_INP_INFO_RUNLOCK() do { \
103 rw_runlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
106 #define SCTP_INP_INFO_WUNLOCK() do { \
107 rw_wunlock(&SCTP_BASE_INFO(ipi_ep_mtx)); \
110 #define SCTP_INP_INFO_LOCK_ASSERT() do { \
111 rw_assert(&SCTP_BASE_INFO(ipi_ep_mtx), RA_LOCKED); \
114 #define SCTP_INP_INFO_RLOCK_ASSERT() do { \
115 rw_assert(&SCTP_BASE_INFO(ipi_ep_mtx), RA_RLOCKED); \
118 #define SCTP_INP_INFO_WLOCK_ASSERT() do { \
119 rw_assert(&SCTP_BASE_INFO(ipi_ep_mtx), RA_WLOCKED); \
122 #define SCTP_MCORE_QLOCK_INIT(cpstr) do { \
123 mtx_init(&(cpstr)->que_mtx, "sctp-mcore_queue","queue_lock", \
124 MTX_DEF | MTX_DUPOK); \
127 #define SCTP_MCORE_QDESTROY(cpstr) do { \
128 if (mtx_owned(&(cpstr)->core_mtx)) { \
129 mtx_unlock(&(cpstr)->que_mtx); \
131 mtx_destroy(&(cpstr)->que_mtx); \
134 #define SCTP_MCORE_QLOCK(cpstr) do { \
135 mtx_lock(&(cpstr)->que_mtx); \
138 #define SCTP_MCORE_QUNLOCK(cpstr) do { \
139 mtx_unlock(&(cpstr)->que_mtx); \
142 #define SCTP_MCORE_LOCK_INIT(cpstr) do { \
143 mtx_init(&(cpstr)->core_mtx, "sctp-cpulck","cpu_proc_lock", \
144 MTX_DEF | MTX_DUPOK); \
147 #define SCTP_MCORE_DESTROY(cpstr) do { \
148 if (mtx_owned(&(cpstr)->core_mtx)) { \
149 mtx_unlock(&(cpstr)->core_mtx); \
151 mtx_destroy(&(cpstr)->core_mtx); \
154 #define SCTP_MCORE_LOCK(cpstr) do { \
155 mtx_lock(&(cpstr)->core_mtx); \
158 #define SCTP_MCORE_UNLOCK(cpstr) do { \
159 mtx_unlock(&(cpstr)->core_mtx); \
162 #define SCTP_IPI_ADDR_INIT() do { \
163 rw_init(&SCTP_BASE_INFO(ipi_addr_mtx), "sctp-addr"); \
166 #define SCTP_IPI_ADDR_DESTROY() do { \
167 if (rw_wowned(&SCTP_BASE_INFO(ipi_addr_mtx))) { \
168 rw_wunlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
170 rw_destroy(&SCTP_BASE_INFO(ipi_addr_mtx)); \
173 #define SCTP_IPI_ADDR_RLOCK() do { \
174 rw_rlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
177 #define SCTP_IPI_ADDR_WLOCK() do { \
178 rw_wlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
181 #define SCTP_IPI_ADDR_RUNLOCK() do { \
182 rw_runlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
185 #define SCTP_IPI_ADDR_WUNLOCK() do { \
186 rw_wunlock(&SCTP_BASE_INFO(ipi_addr_mtx)); \
189 #define SCTP_IPI_ADDR_LOCK_ASSERT() do { \
190 rw_assert(&SCTP_BASE_INFO(ipi_addr_mtx), RA_LOCKED); \
193 #define SCTP_IPI_ADDR_WLOCK_ASSERT() do { \
194 rw_assert(&SCTP_BASE_INFO(ipi_addr_mtx), RA_WLOCKED); \
197 #define SCTP_IPI_ITERATOR_WQ_INIT() do { \
198 mtx_init(&sctp_it_ctl.ipi_iterator_wq_mtx, "sctp-it-wq", \
199 "sctp_it_wq", MTX_DEF); \
202 #define SCTP_IPI_ITERATOR_WQ_DESTROY() do { \
203 mtx_destroy(&sctp_it_ctl.ipi_iterator_wq_mtx); \
206 #define SCTP_IPI_ITERATOR_WQ_LOCK() do { \
207 mtx_lock(&sctp_it_ctl.ipi_iterator_wq_mtx); \
210 #define SCTP_IPI_ITERATOR_WQ_UNLOCK() do { \
211 mtx_unlock(&sctp_it_ctl.ipi_iterator_wq_mtx); \
214 #define SCTP_IP_PKTLOG_INIT() do { \
215 mtx_init(&SCTP_BASE_INFO(ipi_pktlog_mtx), "sctp-pktlog", \
216 "packetlog", MTX_DEF); \
219 #define SCTP_IP_PKTLOG_DESTROY() do { \
220 mtx_destroy(&SCTP_BASE_INFO(ipi_pktlog_mtx)); \
223 #define SCTP_IP_PKTLOG_LOCK() do { \
224 mtx_lock(&SCTP_BASE_INFO(ipi_pktlog_mtx)); \
227 #define SCTP_IP_PKTLOG_UNLOCK() do { \
228 mtx_unlock(&SCTP_BASE_INFO(ipi_pktlog_mtx)); \
232 * The INP locks we will use for locking an SCTP endpoint, so for example if
233 * we want to change something at the endpoint level for example random_store
234 * or cookie secrets we lock the INP level.
237 #define SCTP_INP_READ_INIT(_inp) do { \
238 mtx_init(&(_inp)->inp_rdata_mtx, "sctp-read", "inpr", \
239 MTX_DEF | MTX_DUPOK); \
242 #define SCTP_INP_READ_DESTROY(_inp) do { \
243 mtx_destroy(&(_inp)->inp_rdata_mtx); \
246 #define SCTP_INP_READ_LOCK(_inp) do { \
247 mtx_lock(&(_inp)->inp_rdata_mtx); \
250 #define SCTP_INP_READ_UNLOCK(_inp) do { \
251 mtx_unlock(&(_inp)->inp_rdata_mtx); \
254 #define SCTP_INP_LOCK_INIT(_inp) do { \
255 mtx_init(&(_inp)->inp_mtx, "sctp-inp", "inp", \
256 MTX_DEF | MTX_DUPOK); \
259 #define SCTP_INP_LOCK_DESTROY(_inp) do { \
260 mtx_destroy(&(_inp)->inp_mtx); \
263 #define SCTP_INP_LOCK_CONTENDED(_inp) \
264 ((_inp)->inp_mtx.mtx_lock & MTX_CONTESTED)
266 #define SCTP_INP_READ_CONTENDED(_inp) \
267 ((_inp)->inp_rdata_mtx.mtx_lock & MTX_CONTESTED)
269 #ifdef SCTP_LOCK_LOGGING
270 #define SCTP_INP_RLOCK(_inp) do { \
271 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) \
272 sctp_log_lock(_inp, NULL, SCTP_LOG_LOCK_INP); \
273 mtx_lock(&(_inp)->inp_mtx); \
276 #define SCTP_INP_WLOCK(_inp) do { \
277 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) \
278 sctp_log_lock(_inp, NULL, SCTP_LOG_LOCK_INP); \
279 mtx_lock(&(_inp)->inp_mtx); \
282 #define SCTP_INP_RLOCK(_inp) do { \
283 mtx_lock(&(_inp)->inp_mtx); \
286 #define SCTP_INP_WLOCK(_inp) do { \
287 mtx_lock(&(_inp)->inp_mtx); \
291 #define SCTP_INP_RUNLOCK(_inp) do { \
292 mtx_unlock(&(_inp)->inp_mtx); \
295 #define SCTP_INP_WUNLOCK(_inp) do { \
296 mtx_unlock(&(_inp)->inp_mtx); \
299 #define SCTP_INP_RLOCK_ASSERT(_inp) do { \
300 KASSERT(mtx_owned(&(_inp)->inp_mtx), \
301 ("Don't own INP read lock")); \
304 #define SCTP_INP_WLOCK_ASSERT(_inp) do { \
305 KASSERT(mtx_owned(&(_inp)->inp_mtx), \
306 ("Don't own INP write lock")); \
309 #define SCTP_INP_INCR_REF(_inp) atomic_add_int(&((_inp)->refcount), 1)
310 #define SCTP_INP_DECR_REF(_inp) atomic_add_int(&((_inp)->refcount), -1)
312 #define SCTP_ASOC_CREATE_LOCK_INIT(_inp) do { \
313 mtx_init(&(_inp)->inp_create_mtx, "sctp-create", "inp_create", \
314 MTX_DEF | MTX_DUPOK); \
317 #define SCTP_ASOC_CREATE_LOCK_DESTROY(_inp) do { \
318 mtx_destroy(&(_inp)->inp_create_mtx); \
321 #ifdef SCTP_LOCK_LOGGING
322 #define SCTP_ASOC_CREATE_LOCK(_inp) do { \
323 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) \
324 sctp_log_lock(_inp, NULL, SCTP_LOG_LOCK_CREATE); \
325 mtx_lock(&(_inp)->inp_create_mtx); \
328 #define SCTP_ASOC_CREATE_LOCK(_inp) do { \
329 mtx_lock(&(_inp)->inp_create_mtx); \
333 #define SCTP_ASOC_CREATE_UNLOCK(_inp) do { \
334 mtx_unlock(&(_inp)->inp_create_mtx); \
337 #define SCTP_ASOC_CREATE_LOCK_CONTENDED(_inp) \
338 ((_inp)->inp_create_mtx.mtx_lock & MTX_CONTESTED)
341 * For the majority of things (once we have found the association) we will
342 * lock the actual association mutex. This will protect all the assoiciation
343 * level queues and streams and such. We will need to lock the socket layer
344 * when we stuff data up into the receiving sb_mb. I.e. we will need to do an
345 * extra SOCKBUF_LOCK(&so->so_rcv) even though the association is locked.
348 #define SCTP_TCB_LOCK_INIT(_tcb) do { \
349 mtx_init(&(_tcb)->tcb_mtx, "sctp-tcb", "tcb", \
350 MTX_DEF | MTX_DUPOK); \
353 #define SCTP_TCB_LOCK_DESTROY(_tcb) do { \
354 mtx_destroy(&(_tcb)->tcb_mtx); \
357 #ifdef SCTP_LOCK_LOGGING
358 #define SCTP_TCB_LOCK(_tcb) do { \
359 if (SCTP_BASE_SYSCTL(sctp_logging_level) & SCTP_LOCK_LOGGING_ENABLE) \
360 sctp_log_lock(_tcb->sctp_ep, _tcb, SCTP_LOG_LOCK_TCB); \
361 mtx_lock(&(_tcb)->tcb_mtx); \
364 #define SCTP_TCB_LOCK(_tcb) do { \
365 mtx_lock(&(_tcb)->tcb_mtx); \
370 #define SCTP_TCB_TRYLOCK(_tcb) \
371 mtx_trylock(&(_tcb)->tcb_mtx)
373 #define SCTP_TCB_UNLOCK(_tcb) do { \
374 mtx_unlock(&(_tcb)->tcb_mtx); \
377 #define SCTP_TCB_UNLOCK_IFOWNED(_tcb) do { \
378 if (mtx_owned(&(_tcb)->tcb_mtx)) \
379 mtx_unlock(&(_tcb)->tcb_mtx); \
382 #define SCTP_TCB_LOCK_ASSERT(_tcb) do { \
383 KASSERT(mtx_owned(&(_tcb)->tcb_mtx), \
384 ("Don't own TCB lock")); \
387 #define SCTP_ITERATOR_LOCK_INIT() do { \
388 mtx_init(&sctp_it_ctl.it_mtx, "sctp-it", "iterator", MTX_DEF); \
391 #define SCTP_ITERATOR_LOCK_DESTROY() do { \
392 mtx_destroy(&sctp_it_ctl.it_mtx); \
395 #define SCTP_ITERATOR_LOCK() \
397 KASSERT(!mtx_owned(&sctp_it_ctl.it_mtx), \
398 ("Own the iterator lock")); \
399 mtx_lock(&sctp_it_ctl.it_mtx); \
402 #define SCTP_ITERATOR_UNLOCK() do { \
403 mtx_unlock(&sctp_it_ctl.it_mtx); \
406 #define SCTP_WQ_ADDR_INIT() do { \
407 mtx_init(&SCTP_BASE_INFO(wq_addr_mtx), \
408 "sctp-addr-wq","sctp_addr_wq", MTX_DEF); \
411 #define SCTP_WQ_ADDR_DESTROY() do { \
412 if (mtx_owned(&SCTP_BASE_INFO(wq_addr_mtx))) { \
413 mtx_unlock(&SCTP_BASE_INFO(wq_addr_mtx)); \
415 mtx_destroy(&SCTP_BASE_INFO(wq_addr_mtx)); \
418 #define SCTP_WQ_ADDR_LOCK() do { \
419 mtx_lock(&SCTP_BASE_INFO(wq_addr_mtx)); \
422 #define SCTP_WQ_ADDR_UNLOCK() do { \
423 mtx_unlock(&SCTP_BASE_INFO(wq_addr_mtx)); \
426 #define SCTP_WQ_ADDR_LOCK_ASSERT() do { \
427 KASSERT(mtx_owned(&SCTP_BASE_INFO(wq_addr_mtx)), \
428 ("Don't own the ADDR-WQ lock")); \
431 #define SCTP_INCR_EP_COUNT() do { \
432 atomic_add_int(&SCTP_BASE_INFO(ipi_count_ep), 1); \
435 #define SCTP_DECR_EP_COUNT() do { \
436 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_ep), 1); \
439 #define SCTP_INCR_ASOC_COUNT() do { \
440 atomic_add_int(&SCTP_BASE_INFO(ipi_count_asoc), 1); \
443 #define SCTP_DECR_ASOC_COUNT() do { \
444 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_asoc), 1); \
447 #define SCTP_INCR_LADDR_COUNT() do { \
448 atomic_add_int(&SCTP_BASE_INFO(ipi_count_laddr), 1); \
451 #define SCTP_DECR_LADDR_COUNT() do { \
452 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_laddr), 1); \
455 #define SCTP_INCR_RADDR_COUNT() do { \
456 atomic_add_int(&SCTP_BASE_INFO(ipi_count_raddr), 1); \
459 #define SCTP_DECR_RADDR_COUNT() do { \
460 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_raddr),1); \
463 #define SCTP_INCR_CHK_COUNT() do { \
464 atomic_add_int(&SCTP_BASE_INFO(ipi_count_chunk), 1); \
467 #define SCTP_DECR_CHK_COUNT() do { \
468 KASSERT(SCTP_BASE_INFO(ipi_count_chunk) > 0, \
469 ("ipi_count_chunk would become negative")); \
470 if (SCTP_BASE_INFO(ipi_count_chunk) != 0) \
471 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_chunk), \
475 #define SCTP_INCR_READQ_COUNT() do { \
476 atomic_add_int(&SCTP_BASE_INFO(ipi_count_readq), 1); \
479 #define SCTP_DECR_READQ_COUNT() do { \
480 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_readq), 1); \
483 #define SCTP_INCR_STRMOQ_COUNT() do { \
484 atomic_add_int(&SCTP_BASE_INFO(ipi_count_strmoq), 1); \
487 #define SCTP_DECR_STRMOQ_COUNT() do { \
488 atomic_subtract_int(&SCTP_BASE_INFO(ipi_count_strmoq), 1); \
491 #if defined(SCTP_SO_LOCK_TESTING)
492 #define SCTP_INP_SO(sctpinp) \
493 (sctpinp)->ip_inp.inp.inp_socket
494 #define SCTP_SOCKET_LOCK(so, refcnt)
495 #define SCTP_SOCKET_UNLOCK(so, refcnt)