xref: /xnu-12377.1.9/tests/unit/mocks/fibers/rwlock.h (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)
1 /*
2  * Copyright (c) 2025 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #pragma once
30 
31 #include "fibers.h"
32 
33 #define FIBERS_RWLOCK_ASSERT_SHARED    0x01
34 #define FIBERS_RWLOCK_ASSERT_EXCLUSIVE 0x02
35 #define FIBERS_RWLOCK_ASSERT_HELD      0x03
36 #define FIBERS_RWLOCK_ASSERT_NOTHELD   0x04
37 #define FIBERS_RWLOCK_ASSERT_NOT_OWNED 0x05
38 
39 #define FIBERS_RWLOCK_WANT_UPGRADE     0x1
40 
41 typedef struct fibers_rwlock fibers_rwlock_t;
42 
43 struct fibers_rwlock {
44 	fiber_t writer_active;
45 	unsigned int reader_count;
46 	unsigned int flags;
47 
48 	struct fibers_queue reader_wait_queue;
49 	struct fibers_queue writer_wait_queue;
50 };
51 
52 extern void fibers_rwlock_init(fibers_rwlock_t *rwlock);
53 extern void fibers_rwlock_rdlock(fibers_rwlock_t *rwlock, bool check_may_yield);
54 extern void fibers_rwlock_wrlock(fibers_rwlock_t *rwlock, bool check_may_yield);
55 extern int fibers_rwlock_try_rdlock(fibers_rwlock_t *rwlock);
56 extern int fibers_rwlock_try_wrlock(fibers_rwlock_t *rwlock);
57 extern void fibers_rwlock_rdunlock(fibers_rwlock_t *rwlock);
58 extern void fibers_rwlock_wrunlock(fibers_rwlock_t *rwlock);
59 extern void fibers_rwlock_unlock(fibers_rwlock_t *rwlock);
60 extern void fibers_rwlock_destroy(fibers_rwlock_t *rwlock);
61 extern bool fibers_rwlock_upgrade(fibers_rwlock_t *rwlock);
62 extern void fibers_rwlock_downgrade(fibers_rwlock_t *rwlock);
63 extern void fibers_rwlock_assert(fibers_rwlock_t *rwlock, unsigned int type);
64