1*f6217f89SApple OSS Distributions /*
2*f6217f89SApple OSS Distributions * Copyright (c) 2022 Apple Inc. All rights reserved.
3*f6217f89SApple OSS Distributions */
4*f6217f89SApple OSS Distributions
5*f6217f89SApple OSS Distributions #define PRIVATE 1 /* Needed for some F_OFD_* definitions */
6*f6217f89SApple OSS Distributions #include <fcntl.h>
7*f6217f89SApple OSS Distributions #include <sys/fcntl.h>
8*f6217f89SApple OSS Distributions #include <errno.h>
9*f6217f89SApple OSS Distributions #include <darwintest.h>
10*f6217f89SApple OSS Distributions #include <darwintest_utils.h>
11*f6217f89SApple OSS Distributions #include <stdatomic.h>
12*f6217f89SApple OSS Distributions
13*f6217f89SApple OSS Distributions #ifndef O_CLOFORK
14*f6217f89SApple OSS Distributions #define O_CLOFORK 0x08000000
15*f6217f89SApple OSS Distributions #endif
16*f6217f89SApple OSS Distributions
17*f6217f89SApple OSS Distributions T_GLOBAL_META(
18*f6217f89SApple OSS Distributions T_META_NAMESPACE("xnu.locks"),
19*f6217f89SApple OSS Distributions T_META_RADAR_COMPONENT_NAME("xnu"),
20*f6217f89SApple OSS Distributions T_META_RADAR_COMPONENT_VERSION("locks"),
21*f6217f89SApple OSS Distributions T_META_OWNER("tim_marsland"), // with thanks to Peter Rutenbar
22*f6217f89SApple OSS Distributions T_META_RUN_CONCURRENTLY(TRUE));
23*f6217f89SApple OSS Distributions
24*f6217f89SApple OSS Distributions enum lock_flags {
25*f6217f89SApple OSS Distributions EXCL = 1,
26*f6217f89SApple OSS Distributions WAIT = 2,
27*f6217f89SApple OSS Distributions UNLOCK = 4,
28*f6217f89SApple OSS Distributions };
29*f6217f89SApple OSS Distributions
30*f6217f89SApple OSS Distributions enum lock_type {
31*f6217f89SApple OSS Distributions TYPE_FLOCK = 0,
32*f6217f89SApple OSS Distributions TYPE_POSIX = 1,
33*f6217f89SApple OSS Distributions TYPE_OFD = 2,
34*f6217f89SApple OSS Distributions };
35*f6217f89SApple OSS Distributions
36*f6217f89SApple OSS Distributions static int
ofd_get(struct flock * fl,int fd,off_t start,off_t len,pid_t pid,uint32_t flags)37*f6217f89SApple OSS Distributions ofd_get(struct flock *fl,
38*f6217f89SApple OSS Distributions int fd, off_t start, off_t len, pid_t pid, uint32_t flags)
39*f6217f89SApple OSS Distributions {
40*f6217f89SApple OSS Distributions fl->l_start = start;
41*f6217f89SApple OSS Distributions fl->l_len = len;
42*f6217f89SApple OSS Distributions fl->l_pid = pid;
43*f6217f89SApple OSS Distributions fl->l_type = (flags & EXCL) ? F_WRLCK : F_RDLCK;
44*f6217f89SApple OSS Distributions fl->l_whence = SEEK_SET;
45*f6217f89SApple OSS Distributions return fcntl(fd, (pid == -1) ? F_OFD_GETLK : F_OFD_GETLKPID, fl);
46*f6217f89SApple OSS Distributions }
47*f6217f89SApple OSS Distributions
48*f6217f89SApple OSS Distributions static int
posix_get(struct flock * fl,int fd,off_t start,off_t len,pid_t pid,uint32_t flags)49*f6217f89SApple OSS Distributions posix_get(struct flock *fl,
50*f6217f89SApple OSS Distributions int fd, off_t start, off_t len, pid_t pid, uint32_t flags)
51*f6217f89SApple OSS Distributions {
52*f6217f89SApple OSS Distributions fl->l_start = start;
53*f6217f89SApple OSS Distributions fl->l_len = len;
54*f6217f89SApple OSS Distributions fl->l_pid = pid;
55*f6217f89SApple OSS Distributions fl->l_type = (flags & EXCL) ? F_WRLCK : F_RDLCK;
56*f6217f89SApple OSS Distributions fl->l_whence = SEEK_SET;
57*f6217f89SApple OSS Distributions return fcntl(fd, (pid == -1) ? F_GETLK : F_GETLKPID, fl);
58*f6217f89SApple OSS Distributions }
59*f6217f89SApple OSS Distributions
60*f6217f89SApple OSS Distributions static int
posix_lock(int fd,off_t start,off_t len,uint32_t flags)61*f6217f89SApple OSS Distributions posix_lock(int fd, off_t start, off_t len, uint32_t flags)
62*f6217f89SApple OSS Distributions {
63*f6217f89SApple OSS Distributions struct flock fl = {
64*f6217f89SApple OSS Distributions .l_start = start,
65*f6217f89SApple OSS Distributions .l_len = len,
66*f6217f89SApple OSS Distributions .l_pid = -1,
67*f6217f89SApple OSS Distributions .l_type = (flags & EXCL) ? F_WRLCK : F_RDLCK,
68*f6217f89SApple OSS Distributions .l_whence = SEEK_SET,
69*f6217f89SApple OSS Distributions };
70*f6217f89SApple OSS Distributions return fcntl(fd, (flags & WAIT) ? F_SETLKW : F_SETLK, &fl);
71*f6217f89SApple OSS Distributions }
72*f6217f89SApple OSS Distributions
73*f6217f89SApple OSS Distributions static int
ofd_lock(int fd,off_t start,off_t len,uint32_t flags)74*f6217f89SApple OSS Distributions ofd_lock(int fd, off_t start, off_t len, uint32_t flags)
75*f6217f89SApple OSS Distributions {
76*f6217f89SApple OSS Distributions struct flock fl = {
77*f6217f89SApple OSS Distributions .l_start = start,
78*f6217f89SApple OSS Distributions .l_len = len,
79*f6217f89SApple OSS Distributions .l_pid = -1,
80*f6217f89SApple OSS Distributions .l_type = (flags & EXCL) ? F_WRLCK : F_RDLCK,
81*f6217f89SApple OSS Distributions .l_whence = SEEK_SET,
82*f6217f89SApple OSS Distributions };
83*f6217f89SApple OSS Distributions return fcntl(fd, (flags & WAIT) ? F_OFD_SETLKW : F_OFD_SETLK, &fl);
84*f6217f89SApple OSS Distributions }
85*f6217f89SApple OSS Distributions
86*f6217f89SApple OSS Distributions static int
posix_unlock(int fd,off_t start,off_t len)87*f6217f89SApple OSS Distributions posix_unlock(int fd, off_t start, off_t len)
88*f6217f89SApple OSS Distributions {
89*f6217f89SApple OSS Distributions struct flock fl = {
90*f6217f89SApple OSS Distributions .l_start = start,
91*f6217f89SApple OSS Distributions .l_len = len,
92*f6217f89SApple OSS Distributions .l_pid = -1,
93*f6217f89SApple OSS Distributions .l_type = F_UNLCK,
94*f6217f89SApple OSS Distributions .l_whence = SEEK_SET,
95*f6217f89SApple OSS Distributions };
96*f6217f89SApple OSS Distributions return fcntl(fd, F_SETLK, &fl);
97*f6217f89SApple OSS Distributions }
98*f6217f89SApple OSS Distributions
99*f6217f89SApple OSS Distributions static int
ofd_unlock(int fd,off_t start,off_t len)100*f6217f89SApple OSS Distributions ofd_unlock(int fd, off_t start, off_t len)
101*f6217f89SApple OSS Distributions {
102*f6217f89SApple OSS Distributions struct flock fl = {
103*f6217f89SApple OSS Distributions .l_start = start,
104*f6217f89SApple OSS Distributions .l_len = len,
105*f6217f89SApple OSS Distributions .l_pid = -1,
106*f6217f89SApple OSS Distributions .l_type = F_UNLCK,
107*f6217f89SApple OSS Distributions .l_whence = SEEK_SET,
108*f6217f89SApple OSS Distributions };
109*f6217f89SApple OSS Distributions return fcntl(fd, F_OFD_SETLK, &fl);
110*f6217f89SApple OSS Distributions }
111*f6217f89SApple OSS Distributions
112*f6217f89SApple OSS Distributions /* Is the given flock equal to the given arguments */
113*f6217f89SApple OSS Distributions static bool
flequal(struct flock * fl,off_t start,off_t len,pid_t pid,int flags)114*f6217f89SApple OSS Distributions flequal(struct flock *fl, off_t start, off_t len, pid_t pid, int flags)
115*f6217f89SApple OSS Distributions {
116*f6217f89SApple OSS Distributions if (start == fl->l_start && len == fl->l_len && pid == fl->l_pid) {
117*f6217f89SApple OSS Distributions if (flags == EXCL && fl->l_type == F_WRLCK) {
118*f6217f89SApple OSS Distributions return true;
119*f6217f89SApple OSS Distributions } else if (flags == UNLOCK && fl->l_type == F_UNLCK) {
120*f6217f89SApple OSS Distributions return true;
121*f6217f89SApple OSS Distributions } else if (flags == 0 && fl->l_type == F_RDLCK) {
122*f6217f89SApple OSS Distributions return true;
123*f6217f89SApple OSS Distributions }
124*f6217f89SApple OSS Distributions }
125*f6217f89SApple OSS Distributions T_LOG("flequal: %lld %lld %d %x %x\n",
126*f6217f89SApple OSS Distributions fl->l_start, fl->l_len, fl->l_pid, fl->l_type, fl->l_whence);
127*f6217f89SApple OSS Distributions return false;
128*f6217f89SApple OSS Distributions }
129*f6217f89SApple OSS Distributions
130*f6217f89SApple OSS Distributions typedef struct {
131*f6217f89SApple OSS Distributions pthread_t thread;
132*f6217f89SApple OSS Distributions int fd, err;
133*f6217f89SApple OSS Distributions bool complete;
134*f6217f89SApple OSS Distributions enum lock_type lock_type;
135*f6217f89SApple OSS Distributions uint32_t flags;
136*f6217f89SApple OSS Distributions off_t start, end;
137*f6217f89SApple OSS Distributions } lock_thread_state_t;
138*f6217f89SApple OSS Distributions
139*f6217f89SApple OSS Distributions static void *
lock_thread(void * arg)140*f6217f89SApple OSS Distributions lock_thread(
141*f6217f89SApple OSS Distributions void *arg)
142*f6217f89SApple OSS Distributions {
143*f6217f89SApple OSS Distributions lock_thread_state_t *lts = (lock_thread_state_t *)arg;
144*f6217f89SApple OSS Distributions
145*f6217f89SApple OSS Distributions switch (lts->lock_type) {
146*f6217f89SApple OSS Distributions case TYPE_FLOCK: {
147*f6217f89SApple OSS Distributions int op = (lts->flags & EXCL) ? LOCK_EX : LOCK_SH;
148*f6217f89SApple OSS Distributions op |= (lts->flags & WAIT) ? 0 : LOCK_NB;
149*f6217f89SApple OSS Distributions lts->err = flock(lts->fd, op) ? errno : 0;
150*f6217f89SApple OSS Distributions break;
151*f6217f89SApple OSS Distributions }
152*f6217f89SApple OSS Distributions case TYPE_POSIX:
153*f6217f89SApple OSS Distributions lts->err = posix_lock(lts->fd,
154*f6217f89SApple OSS Distributions lts->start, lts->end, lts->flags) ? errno : 0;
155*f6217f89SApple OSS Distributions break;
156*f6217f89SApple OSS Distributions case TYPE_OFD:
157*f6217f89SApple OSS Distributions lts->err = ofd_lock(lts->fd,
158*f6217f89SApple OSS Distributions lts->start, lts->end, lts->flags) ? errno : 0;
159*f6217f89SApple OSS Distributions break;
160*f6217f89SApple OSS Distributions }
161*f6217f89SApple OSS Distributions
162*f6217f89SApple OSS Distributions atomic_thread_fence(memory_order_acquire);
163*f6217f89SApple OSS Distributions lts->complete = true;
164*f6217f89SApple OSS Distributions atomic_thread_fence(memory_order_release);
165*f6217f89SApple OSS Distributions
166*f6217f89SApple OSS Distributions return NULL;
167*f6217f89SApple OSS Distributions }
168*f6217f89SApple OSS Distributions
169*f6217f89SApple OSS Distributions static bool
has_completed(lock_thread_state_t * lts)170*f6217f89SApple OSS Distributions has_completed(lock_thread_state_t *lts)
171*f6217f89SApple OSS Distributions {
172*f6217f89SApple OSS Distributions atomic_thread_fence(memory_order_acquire);
173*f6217f89SApple OSS Distributions const bool r = lts->complete;
174*f6217f89SApple OSS Distributions atomic_thread_fence(memory_order_release);
175*f6217f89SApple OSS Distributions return r;
176*f6217f89SApple OSS Distributions }
177*f6217f89SApple OSS Distributions
178*f6217f89SApple OSS Distributions static void
start_lock_thread(enum lock_type type,lock_thread_state_t * lts,int fd,off_t start,off_t end,uint32_t flags)179*f6217f89SApple OSS Distributions start_lock_thread(enum lock_type type, lock_thread_state_t *lts,
180*f6217f89SApple OSS Distributions int fd, off_t start, off_t end, uint32_t flags)
181*f6217f89SApple OSS Distributions {
182*f6217f89SApple OSS Distributions lts->fd = fd;
183*f6217f89SApple OSS Distributions lts->err = 0;
184*f6217f89SApple OSS Distributions lts->complete = false;
185*f6217f89SApple OSS Distributions lts->lock_type = type;
186*f6217f89SApple OSS Distributions lts->flags = flags;
187*f6217f89SApple OSS Distributions lts->start = start;
188*f6217f89SApple OSS Distributions lts->end = end;
189*f6217f89SApple OSS Distributions
190*f6217f89SApple OSS Distributions pthread_create(<s->thread, NULL, lock_thread, lts);
191*f6217f89SApple OSS Distributions }
192*f6217f89SApple OSS Distributions
193*f6217f89SApple OSS Distributions static void
random_pause(void)194*f6217f89SApple OSS Distributions random_pause(void)
195*f6217f89SApple OSS Distributions {
196*f6217f89SApple OSS Distributions const useconds_t usec = rand() & (16384 - 1);
197*f6217f89SApple OSS Distributions usleep(usec + 1);
198*f6217f89SApple OSS Distributions }
199*f6217f89SApple OSS Distributions
200*f6217f89SApple OSS Distributions #define GET_CHECK( \
201*f6217f89SApple OSS Distributions str, fd, \
202*f6217f89SApple OSS Distributions get_start, get_len, get_flags, get_type, \
203*f6217f89SApple OSS Distributions chk_start, chk_len, chk_flags, chk_pid) \
204*f6217f89SApple OSS Distributions do { \
205*f6217f89SApple OSS Distributions struct flock _fl; \
206*f6217f89SApple OSS Distributions if (get_type == TYPE_OFD) { \
207*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ofd_get(&_fl, fd, get_start, get_len, -1, get_flags), str " (ofd_get)"); \
208*f6217f89SApple OSS Distributions } else { \
209*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_get(&_fl, fd, get_start, get_len, -1, get_flags), str " (posix_get)"); \
210*f6217f89SApple OSS Distributions } \
211*f6217f89SApple OSS Distributions T_ASSERT_TRUE(flequal(&_fl, chk_start, chk_len, chk_pid, chk_flags), str " (flequal)"); \
212*f6217f89SApple OSS Distributions } while (0)
213*f6217f89SApple OSS Distributions
214*f6217f89SApple OSS Distributions #define LOCK_AND_CHECK( \
215*f6217f89SApple OSS Distributions str, fd, \
216*f6217f89SApple OSS Distributions lck_start, lck_len, lck_flags, lock_type, \
217*f6217f89SApple OSS Distributions get_start, get_len, get_flags, get_type, \
218*f6217f89SApple OSS Distributions chk_start, chk_len, chk_flags, chk_pid) \
219*f6217f89SApple OSS Distributions do { \
220*f6217f89SApple OSS Distributions if (lock_type == TYPE_OFD) { \
221*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ofd_lock(fd, lck_start, lck_len, lck_flags), str " (ofd_lock)"); \
222*f6217f89SApple OSS Distributions } else { \
223*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_lock(fd, lck_start, lck_len, lck_flags), str " (posix_lock)"); \
224*f6217f89SApple OSS Distributions } \
225*f6217f89SApple OSS Distributions GET_CHECK(str, fd, get_start, get_len, get_flags, get_type, chk_start, chk_len, chk_flags, chk_pid); \
226*f6217f89SApple OSS Distributions } while (0)
227*f6217f89SApple OSS Distributions
228*f6217f89SApple OSS Distributions #define UNLOCK_AND_CHECK( \
229*f6217f89SApple OSS Distributions str, fd, \
230*f6217f89SApple OSS Distributions lck_start, lck_len, unlock_type, \
231*f6217f89SApple OSS Distributions get_start, get_len, get_flags, get_type, \
232*f6217f89SApple OSS Distributions chk_start, chk_len, chk_flags, chk_pid) \
233*f6217f89SApple OSS Distributions do { \
234*f6217f89SApple OSS Distributions if (unlock_type == TYPE_OFD) { \
235*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ofd_unlock(fd, lck_start, lck_len), str " (ofd_unlock)"); \
236*f6217f89SApple OSS Distributions } else { \
237*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_unlock(fd, lck_start, lck_len), str " (posix_unlock)"); \
238*f6217f89SApple OSS Distributions } \
239*f6217f89SApple OSS Distributions GET_CHECK(str, fd, get_start, get_len, get_flags, get_type, chk_start, chk_len, chk_flags, chk_pid); \
240*f6217f89SApple OSS Distributions } while (0)
241*f6217f89SApple OSS Distributions
242*f6217f89SApple OSS Distributions #define A_PATH "basic_lockf_a"
243*f6217f89SApple OSS Distributions #define B_PATH "basic_lockf_b"
244*f6217f89SApple OSS Distributions
245*f6217f89SApple OSS Distributions T_DECL(lockf_basic,
246*f6217f89SApple OSS Distributions "Basic test of flock/POSIX/OFD advisory file locks",
247*f6217f89SApple OSS Distributions T_META_CHECK_LEAKS(false), T_META_TAG_VM_PREFERRED)
248*f6217f89SApple OSS Distributions {
249*f6217f89SApple OSS Distributions const char *tmpdir = dt_tmpdir();
250*f6217f89SApple OSS Distributions lock_thread_state_t lts[4];
251*f6217f89SApple OSS Distributions pid_t pid = getpid();
252*f6217f89SApple OSS Distributions int a, a_confined, b, b_confined;
253*f6217f89SApple OSS Distributions const off_t file_len = 0x10000;
254*f6217f89SApple OSS Distributions T_SETUPBEGIN;
255*f6217f89SApple OSS Distributions
256*f6217f89SApple OSS Distributions /* random sleeping to hunt for races */
257*f6217f89SApple OSS Distributions
258*f6217f89SApple OSS Distributions unsigned seed = (unsigned)pid;
259*f6217f89SApple OSS Distributions const char *p = getenv("LOCKF_BASIC_SRAND_SEED");
260*f6217f89SApple OSS Distributions if (p) {
261*f6217f89SApple OSS Distributions seed = (unsigned)atol(p);
262*f6217f89SApple OSS Distributions }
263*f6217f89SApple OSS Distributions srand(seed);
264*f6217f89SApple OSS Distributions
265*f6217f89SApple OSS Distributions /* Create two test files, a and b */
266*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(chdir(tmpdir), "chdir(%s)", tmpdir);
267*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS((a = open(A_PATH, O_CREAT | O_RDWR, 0666)), "open(a)");
268*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS((b = open(B_PATH, O_CREAT | O_RDWR, 0666)), "open(b)");
269*f6217f89SApple OSS Distributions
270*f6217f89SApple OSS Distributions /* Give both files 64KiB */
271*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ftruncate(a, file_len), "truncate a");
272*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ftruncate(b, 0x10000), "truncate b");
273*f6217f89SApple OSS Distributions
274*f6217f89SApple OSS Distributions /* Open a/b again, but CONFINED this time */
275*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS((a_confined = open(A_PATH, O_CLOFORK | O_RDWR)), "open(a, O_CLOFORK)");
276*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(fcntl(a_confined, F_SETCONFINED, 1), "F_SETCONFINED");
277*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS((b_confined = open(B_PATH, O_CLOFORK | O_RDWR)), "open(b, O_CLOFORK)");
278*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(fcntl(b_confined, F_SETCONFINED, 1), "F_SETCONFINED");
279*f6217f89SApple OSS Distributions
280*f6217f89SApple OSS Distributions T_SETUPEND;
281*f6217f89SApple OSS Distributions
282*f6217f89SApple OSS Distributions /* Test all coalescence cases (non-upgrade/downgrade) */
283*f6217f89SApple OSS Distributions
284*f6217f89SApple OSS Distributions /*
285*f6217f89SApple OSS Distributions * [ ]
286*f6217f89SApple OSS Distributions * + [ ]
287*f6217f89SApple OSS Distributions * = [ ]
288*f6217f89SApple OSS Distributions */
289*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_lock(a, 130, 20, 0), "Coalesce: initial posix lock");
290*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: equal", a,
291*f6217f89SApple OSS Distributions 130, 20, 0, TYPE_POSIX, /* POSIX-lock a, shared, from [100..199] */
292*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD, /* OFD-get the entire file, exclusively */
293*f6217f89SApple OSS Distributions 130, 20, 0, pid); /* The result should be: [100..199] is locked shared by our PID */
294*f6217f89SApple OSS Distributions
295*f6217f89SApple OSS Distributions /*
296*f6217f89SApple OSS Distributions * [ ]
297*f6217f89SApple OSS Distributions * + [ ]
298*f6217f89SApple OSS Distributions * = [ ]
299*f6217f89SApple OSS Distributions */
300*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: adjacent high", a,
301*f6217f89SApple OSS Distributions 150, 25, 0, TYPE_POSIX,
302*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
303*f6217f89SApple OSS Distributions 130, 45, 0, pid);
304*f6217f89SApple OSS Distributions
305*f6217f89SApple OSS Distributions /*
306*f6217f89SApple OSS Distributions * [ ]
307*f6217f89SApple OSS Distributions * + [ ]
308*f6217f89SApple OSS Distributions * = [ ]
309*f6217f89SApple OSS Distributions */
310*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: adjacent low", a,
311*f6217f89SApple OSS Distributions 125, 5, 0, TYPE_POSIX,
312*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
313*f6217f89SApple OSS Distributions 125, 50, 0, pid);
314*f6217f89SApple OSS Distributions
315*f6217f89SApple OSS Distributions /*
316*f6217f89SApple OSS Distributions * [ ]
317*f6217f89SApple OSS Distributions * + [ ]
318*f6217f89SApple OSS Distributions * = [ ]
319*f6217f89SApple OSS Distributions */
320*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: subsume smaller", a,
321*f6217f89SApple OSS Distributions 150, 10, 0, TYPE_POSIX,
322*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
323*f6217f89SApple OSS Distributions 125, 50, 0, pid);
324*f6217f89SApple OSS Distributions
325*f6217f89SApple OSS Distributions /*
326*f6217f89SApple OSS Distributions * [ ]
327*f6217f89SApple OSS Distributions * + [ ]
328*f6217f89SApple OSS Distributions * = [ ]
329*f6217f89SApple OSS Distributions */
330*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: subsume larger", a,
331*f6217f89SApple OSS Distributions 100, 100, 0, TYPE_POSIX,
332*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
333*f6217f89SApple OSS Distributions 100, 100, 0, pid);
334*f6217f89SApple OSS Distributions
335*f6217f89SApple OSS Distributions /*
336*f6217f89SApple OSS Distributions * [ ]
337*f6217f89SApple OSS Distributions * + [ ]
338*f6217f89SApple OSS Distributions * = [ ]
339*f6217f89SApple OSS Distributions */
340*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: extend high", a,
341*f6217f89SApple OSS Distributions 100, 125, 0, TYPE_POSIX,
342*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
343*f6217f89SApple OSS Distributions 100, 125, 0, pid);
344*f6217f89SApple OSS Distributions
345*f6217f89SApple OSS Distributions /*
346*f6217f89SApple OSS Distributions * [ ]
347*f6217f89SApple OSS Distributions * + [ ]
348*f6217f89SApple OSS Distributions * = [ ]
349*f6217f89SApple OSS Distributions */
350*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: extend low", a,
351*f6217f89SApple OSS Distributions 75, 150, 0, TYPE_POSIX,
352*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
353*f6217f89SApple OSS Distributions 75, 150, 0, pid);
354*f6217f89SApple OSS Distributions
355*f6217f89SApple OSS Distributions /*
356*f6217f89SApple OSS Distributions * [ ]
357*f6217f89SApple OSS Distributions * + [ ]
358*f6217f89SApple OSS Distributions * = [ ]
359*f6217f89SApple OSS Distributions */
360*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: overlap start", a,
361*f6217f89SApple OSS Distributions 50, 100, 0, TYPE_POSIX,
362*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
363*f6217f89SApple OSS Distributions 50, 175, 0, pid);
364*f6217f89SApple OSS Distributions
365*f6217f89SApple OSS Distributions /*
366*f6217f89SApple OSS Distributions * [ ]
367*f6217f89SApple OSS Distributions * + [ ]
368*f6217f89SApple OSS Distributions * = [ ]
369*f6217f89SApple OSS Distributions */
370*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Coalesce: overlap end", a,
371*f6217f89SApple OSS Distributions 150, 100, 0, TYPE_POSIX,
372*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
373*f6217f89SApple OSS Distributions 50, 200, 0, pid);
374*f6217f89SApple OSS Distributions
375*f6217f89SApple OSS Distributions /* Test all upgrade cases */
376*f6217f89SApple OSS Distributions
377*f6217f89SApple OSS Distributions /*
378*f6217f89SApple OSS Distributions * [ R ]
379*f6217f89SApple OSS Distributions * + [ W ]
380*f6217f89SApple OSS Distributions * = [ R | W ]
381*f6217f89SApple OSS Distributions */
382*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Upgrade: adjacent high not-coalesced", a,
383*f6217f89SApple OSS Distributions 250, 50, EXCL, TYPE_POSIX, /* Take the posix lock exclusively */
384*f6217f89SApple OSS Distributions 50, 250, 0, TYPE_OFD, /* and OFD-get shared */
385*f6217f89SApple OSS Distributions 250, 50, EXCL, pid);
386*f6217f89SApple OSS Distributions
387*f6217f89SApple OSS Distributions /*
388*f6217f89SApple OSS Distributions * [ R | W ]
389*f6217f89SApple OSS Distributions * + [ W ]
390*f6217f89SApple OSS Distributions * = [ W | R | W ]
391*f6217f89SApple OSS Distributions */
392*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Upgrade: adjacent low not-coalesced", a,
393*f6217f89SApple OSS Distributions 25, 25, EXCL, TYPE_POSIX,
394*f6217f89SApple OSS Distributions 25, 225, 0, TYPE_OFD,
395*f6217f89SApple OSS Distributions 25, 25, EXCL, pid);
396*f6217f89SApple OSS Distributions
397*f6217f89SApple OSS Distributions /*
398*f6217f89SApple OSS Distributions * 25 50 250 300
399*f6217f89SApple OSS Distributions * [ W | R | W ]
400*f6217f89SApple OSS Distributions * + [ W ]
401*f6217f89SApple OSS Distributions * [ W | R | W ]
402*f6217f89SApple OSS Distributions * 25 50 225 300
403*f6217f89SApple OSS Distributions */
404*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Upgrade: truncate shared-end, grow excl-start", a,
405*f6217f89SApple OSS Distributions 225, 50, EXCL, TYPE_POSIX,
406*f6217f89SApple OSS Distributions 50, 250, 0, TYPE_OFD,
407*f6217f89SApple OSS Distributions 225, 75, EXCL, pid);
408*f6217f89SApple OSS Distributions
409*f6217f89SApple OSS Distributions /*
410*f6217f89SApple OSS Distributions * 25 50 225 300
411*f6217f89SApple OSS Distributions * [ W | R | W ]
412*f6217f89SApple OSS Distributions * + [ W ]
413*f6217f89SApple OSS Distributions * = [ W | R | W ]
414*f6217f89SApple OSS Distributions * 25 60 225 300
415*f6217f89SApple OSS Distributions */
416*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Upgrade: truncate shared-start, grow excl-end", a,
417*f6217f89SApple OSS Distributions 40, 20, EXCL, TYPE_POSIX,
418*f6217f89SApple OSS Distributions 0, 225, 0, TYPE_OFD,
419*f6217f89SApple OSS Distributions 25, 35, EXCL, pid);
420*f6217f89SApple OSS Distributions
421*f6217f89SApple OSS Distributions /*
422*f6217f89SApple OSS Distributions * 25 60 225 300
423*f6217f89SApple OSS Distributions * [ W | R | W ]
424*f6217f89SApple OSS Distributions * + [ W ]
425*f6217f89SApple OSS Distributions * = [ W | | W | | W ]
426*f6217f89SApple OSS Distributions * 25 60 100 150 225 300
427*f6217f89SApple OSS Distributions */
428*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Upgrade: 3-way split", a,
429*f6217f89SApple OSS Distributions 100, 50, EXCL, TYPE_POSIX,
430*f6217f89SApple OSS Distributions 60, 165, 0, TYPE_OFD,
431*f6217f89SApple OSS Distributions 100, 50, EXCL, pid);
432*f6217f89SApple OSS Distributions
433*f6217f89SApple OSS Distributions /*
434*f6217f89SApple OSS Distributions * 25 60 100 150 225 300
435*f6217f89SApple OSS Distributions * [ W | | W | | W ]
436*f6217f89SApple OSS Distributions * + [ W ]
437*f6217f89SApple OSS Distributions * = [ W ]
438*f6217f89SApple OSS Distributions * 25 300
439*f6217f89SApple OSS Distributions */
440*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Upgrade: subsume multiple locks", a,
441*f6217f89SApple OSS Distributions 25, 275, EXCL, TYPE_POSIX,
442*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
443*f6217f89SApple OSS Distributions 25, 275, EXCL, pid);
444*f6217f89SApple OSS Distributions
445*f6217f89SApple OSS Distributions /* Unlock / waiter-wakeup cases */
446*f6217f89SApple OSS Distributions
447*f6217f89SApple OSS Distributions /*
448*f6217f89SApple OSS Distributions * 25 300
449*f6217f89SApple OSS Distributions * [ W ]
450*f6217f89SApple OSS Distributions * + [W (wait)]
451*f6217f89SApple OSS Distributions * 290 310
452*f6217f89SApple OSS Distributions */
453*f6217f89SApple OSS Distributions start_lock_thread(TYPE_OFD, <s[0], a, 290, 20, EXCL | WAIT); /* Wait on this lock in another thread */
454*f6217f89SApple OSS Distributions random_pause();
455*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Unlock: created waiting lock");
456*f6217f89SApple OSS Distributions
457*f6217f89SApple OSS Distributions /*
458*f6217f89SApple OSS Distributions * 25 300
459*f6217f89SApple OSS Distributions * [ W ]
460*f6217f89SApple OSS Distributions * - [ - ]
461*f6217f89SApple OSS Distributions * = [ W ]
462*f6217f89SApple OSS Distributions * 25 300
463*f6217f89SApple OSS Distributions */
464*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: region with no locks", a,
465*f6217f89SApple OSS Distributions 300, 100, TYPE_POSIX,
466*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
467*f6217f89SApple OSS Distributions 25, 275, EXCL, pid);
468*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Unlock: waiter still waiting");
469*f6217f89SApple OSS Distributions
470*f6217f89SApple OSS Distributions /*
471*f6217f89SApple OSS Distributions * 25 300
472*f6217f89SApple OSS Distributions * [ W ]
473*f6217f89SApple OSS Distributions * - [ - ]
474*f6217f89SApple OSS Distributions * = [ W ]
475*f6217f89SApple OSS Distributions * 25 250
476*f6217f89SApple OSS Distributions */
477*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: overlap end", a,
478*f6217f89SApple OSS Distributions 250, 100, TYPE_POSIX,
479*f6217f89SApple OSS Distributions 25, 1, 0, TYPE_OFD,
480*f6217f89SApple OSS Distributions 25, 225, EXCL, pid);
481*f6217f89SApple OSS Distributions
482*f6217f89SApple OSS Distributions /*
483*f6217f89SApple OSS Distributions * 25 250
484*f6217f89SApple OSS Distributions * [ W ]
485*f6217f89SApple OSS Distributions * [ W ]
486*f6217f89SApple OSS Distributions * 290 310
487*f6217f89SApple OSS Distributions */
488*f6217f89SApple OSS Distributions
489*f6217f89SApple OSS Distributions while (!has_completed(<s[0])) {
490*f6217f89SApple OSS Distributions random_pause();
491*f6217f89SApple OSS Distributions }
492*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[0]), "Unlock: waiter woke up");
493*f6217f89SApple OSS Distributions T_ASSERT_POSIX_ZERO(lts[0].err, "Unlock: no err granting waiter");
494*f6217f89SApple OSS Distributions GET_CHECK("Unlock: waiter granted confirmation", a,
495*f6217f89SApple OSS Distributions 250, 100, 0, TYPE_POSIX,
496*f6217f89SApple OSS Distributions 290, 20, EXCL, -1); /* -1 because it's a non-CONFINED OFD lock (with no PID) */
497*f6217f89SApple OSS Distributions
498*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ofd_unlock(a, 290, 20), "Unlock: unlock that now-granted waiter");
499*f6217f89SApple OSS Distributions
500*f6217f89SApple OSS Distributions /*
501*f6217f89SApple OSS Distributions * 25 250
502*f6217f89SApple OSS Distributions * [ W ] 290 310
503*f6217f89SApple OSS Distributions * [ W ]
504*f6217f89SApple OSS Distributions * - [ - ]
505*f6217f89SApple OSS Distributions * = [ W ]
506*f6217f89SApple OSS Distributions * 25 250
507*f6217f89SApple OSS Distributions */
508*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: equal range", a,
509*f6217f89SApple OSS Distributions 290, 20, TYPE_POSIX,
510*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
511*f6217f89SApple OSS Distributions 25, 225, EXCL, pid);
512*f6217f89SApple OSS Distributions
513*f6217f89SApple OSS Distributions /*
514*f6217f89SApple OSS Distributions * 25 250
515*f6217f89SApple OSS Distributions * [ W ]
516*f6217f89SApple OSS Distributions * - [ - ]
517*f6217f89SApple OSS Distributions * = [ W ]
518*f6217f89SApple OSS Distributions * 50 250
519*f6217f89SApple OSS Distributions */
520*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: overlap start", a,
521*f6217f89SApple OSS Distributions 0, 50, TYPE_POSIX,
522*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
523*f6217f89SApple OSS Distributions 50, 200, EXCL, pid);
524*f6217f89SApple OSS Distributions
525*f6217f89SApple OSS Distributions /*
526*f6217f89SApple OSS Distributions * 50 250
527*f6217f89SApple OSS Distributions * [ W ]
528*f6217f89SApple OSS Distributions * - [ ]
529*f6217f89SApple OSS Distributions * = [ W ]
530*f6217f89SApple OSS Distributions * 100 250
531*f6217f89SApple OSS Distributions */
532*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: start-aligned", a,
533*f6217f89SApple OSS Distributions 50, 50, TYPE_POSIX,
534*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
535*f6217f89SApple OSS Distributions 100, 150, EXCL, pid);
536*f6217f89SApple OSS Distributions
537*f6217f89SApple OSS Distributions /*
538*f6217f89SApple OSS Distributions * 100 250
539*f6217f89SApple OSS Distributions * [ W ]
540*f6217f89SApple OSS Distributions * - [ ]
541*f6217f89SApple OSS Distributions * = [ W ]
542*f6217f89SApple OSS Distributions * 100 200
543*f6217f89SApple OSS Distributions */
544*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: end-aligned", a,
545*f6217f89SApple OSS Distributions 200, 50, TYPE_POSIX,
546*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
547*f6217f89SApple OSS Distributions 100, 100, EXCL, pid);
548*f6217f89SApple OSS Distributions
549*f6217f89SApple OSS Distributions /*
550*f6217f89SApple OSS Distributions * 100 200
551*f6217f89SApple OSS Distributions * [ W ]
552*f6217f89SApple OSS Distributions * - [ ]
553*f6217f89SApple OSS Distributions * = [ W ] [ W ]
554*f6217f89SApple OSS Distributions * 100 125 175 200
555*f6217f89SApple OSS Distributions */
556*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: split", a,
557*f6217f89SApple OSS Distributions 125, 50, TYPE_POSIX,
558*f6217f89SApple OSS Distributions 0, 150, 0, TYPE_OFD,
559*f6217f89SApple OSS Distributions 100, 25, EXCL, pid);
560*f6217f89SApple OSS Distributions
561*f6217f89SApple OSS Distributions /* Check the tail-fragment too */
562*f6217f89SApple OSS Distributions GET_CHECK("Unlock: split (tail-check)", a,
563*f6217f89SApple OSS Distributions 125, 200, 0, TYPE_OFD,
564*f6217f89SApple OSS Distributions 175, 25, EXCL, pid);
565*f6217f89SApple OSS Distributions
566*f6217f89SApple OSS Distributions /*
567*f6217f89SApple OSS Distributions * 100 125 175 200
568*f6217f89SApple OSS Distributions * [ W ] [ W ]
569*f6217f89SApple OSS Distributions * - [ ]
570*f6217f89SApple OSS Distributions * = (no locks)
571*f6217f89SApple OSS Distributions */
572*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Unlock: multiple locks", a,
573*f6217f89SApple OSS Distributions 0, 0, TYPE_POSIX,
574*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
575*f6217f89SApple OSS Distributions 0, 0, UNLOCK, -1);
576*f6217f89SApple OSS Distributions
577*f6217f89SApple OSS Distributions
578*f6217f89SApple OSS Distributions /*
579*f6217f89SApple OSS Distributions * Downgrade / waiter-wakeup test:
580*f6217f89SApple OSS Distributions * The only interesting different between this and upgrade is that waiting locks
581*f6217f89SApple OSS Distributions * may now be granted. So let's test that...
582*f6217f89SApple OSS Distributions */
583*f6217f89SApple OSS Distributions
584*f6217f89SApple OSS Distributions /*
585*f6217f89SApple OSS Distributions * Create this lock layout
586*f6217f89SApple OSS Distributions * 0 500
587*f6217f89SApple OSS Distributions * [ W ]
588*f6217f89SApple OSS Distributions *
589*f6217f89SApple OSS Distributions * 0 100 200 300 400 600
590*f6217f89SApple OSS Distributions * [R(wait)] [R(wait)] [ R(wait) ]
591*f6217f89SApple OSS Distributions *
592*f6217f89SApple OSS Distributions * 50 450
593*f6217f89SApple OSS Distributions * [ R(wait) ]
594*f6217f89SApple OSS Distributions */
595*f6217f89SApple OSS Distributions
596*f6217f89SApple OSS Distributions LOCK_AND_CHECK("Downgrade: first lock", a,
597*f6217f89SApple OSS Distributions 0, 500, EXCL, TYPE_POSIX,
598*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
599*f6217f89SApple OSS Distributions 0, 500, EXCL, pid);
600*f6217f89SApple OSS Distributions
601*f6217f89SApple OSS Distributions start_lock_thread(TYPE_OFD, <s[0], a, 0, 100, WAIT);
602*f6217f89SApple OSS Distributions start_lock_thread(TYPE_OFD, <s[1], a, 200, 100, WAIT);
603*f6217f89SApple OSS Distributions start_lock_thread(TYPE_OFD, <s[2], a, 400, 200, WAIT);
604*f6217f89SApple OSS Distributions start_lock_thread(TYPE_OFD, <s[3], a, 50, 400, WAIT);
605*f6217f89SApple OSS Distributions
606*f6217f89SApple OSS Distributions random_pause(); /* wait a bit to allow the lock threads to run */
607*f6217f89SApple OSS Distributions
608*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Downgrade: waiter 0 waiting");;
609*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[1]), "Downgrade: waiter 1 waiting");
610*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[2]), "Downgrade: waiter 2 waiting");
611*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[3]), "Downgrade: waiter 3 waiting");
612*f6217f89SApple OSS Distributions
613*f6217f89SApple OSS Distributions /* Open a gap just wide enough for the [200..300] lock to be granted */
614*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_lock(a, 200, 100, 0), "Downgrade [200..300]");
615*f6217f89SApple OSS Distributions
616*f6217f89SApple OSS Distributions /*
617*f6217f89SApple OSS Distributions * (We can't use LOCK_AND_CHECK here, because there may be two shared locks
618*f6217f89SApple OSS Distributions * with that range (our downgrade, plus waiter #1) - so ofd_get() could return
619*f6217f89SApple OSS Distributions * either one non-deterministically.)
620*f6217f89SApple OSS Distributions */
621*f6217f89SApple OSS Distributions
622*f6217f89SApple OSS Distributions while (!has_completed(<s[1])) {
623*f6217f89SApple OSS Distributions random_pause(); /* wait for waiter #1 to complete */
624*f6217f89SApple OSS Distributions }
625*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Downgrade: waiter 0 waiting");
626*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[1]), "Downgrade: waiter 1 awoken");
627*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[2]), "Downgrade: waiter 2 waiting");
628*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[3]), "Downgrade: waiter 3 waiting");
629*f6217f89SApple OSS Distributions
630*f6217f89SApple OSS Distributions /* Open a gap just wide enough for the [400..600] lock to be granted */
631*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_lock(a, 400, 100, 0), "Downgrade [400..500]");
632*f6217f89SApple OSS Distributions
633*f6217f89SApple OSS Distributions while (!has_completed(<s[2])) {
634*f6217f89SApple OSS Distributions random_pause(); /* wait for waiter #2 to complete */
635*f6217f89SApple OSS Distributions }
636*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Downgrade: waiter 0 waiting");
637*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[2]), "Downgrade: waiter 2 awoken");
638*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[3]), "Downgrade: waiter 3 waiting");
639*f6217f89SApple OSS Distributions
640*f6217f89SApple OSS Distributions /* Downgrade the remaining chunks */
641*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_lock(a, 0, 500, 0), "Downgrade [0..500]");
642*f6217f89SApple OSS Distributions
643*f6217f89SApple OSS Distributions while (!has_completed(<s[0]) || !has_completed(<s[3])) {
644*f6217f89SApple OSS Distributions random_pause(); /* wait for waiters #0 and #3 to complete */
645*f6217f89SApple OSS Distributions }
646*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[0]), "Downgrade: waiter 0 awoken");
647*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[3]), "Downgrade: waiter 3 awoken");
648*f6217f89SApple OSS Distributions
649*f6217f89SApple OSS Distributions /* Unlock the remaining OFD shared locks */
650*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Downgrade: cleanup (unlock all shared OFD locks)", a,
651*f6217f89SApple OSS Distributions 0, 0, TYPE_OFD,
652*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_POSIX,
653*f6217f89SApple OSS Distributions 0, 0, UNLOCK, -1);
654*f6217f89SApple OSS Distributions
655*f6217f89SApple OSS Distributions /* Unlock the remaining POSIX lock [0..500] */
656*f6217f89SApple OSS Distributions UNLOCK_AND_CHECK("Downgrade: cleanup (unlock all shared posix locks)", a,
657*f6217f89SApple OSS Distributions 0, 500, TYPE_POSIX,
658*f6217f89SApple OSS Distributions 0, 0, 0, TYPE_OFD,
659*f6217f89SApple OSS Distributions 0, 0, UNLOCK, -1);
660*f6217f89SApple OSS Distributions
661*f6217f89SApple OSS Distributions
662*f6217f89SApple OSS Distributions /* Test SEEK_END flock range decoding */
663*f6217f89SApple OSS Distributions
664*f6217f89SApple OSS Distributions {
665*f6217f89SApple OSS Distributions /* SEEK_END start=-10 len=10 */
666*f6217f89SApple OSS Distributions struct flock fl = {.l_start = -10, .l_len = 10, .l_type = F_WRLCK, .l_whence = SEEK_END};
667*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(fcntl(a, F_SETLK, &fl), "SEEK_END: -10, 10");
668*f6217f89SApple OSS Distributions GET_CHECK("SEEK_END: -10, 10 ", a,
669*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
670*f6217f89SApple OSS Distributions file_len - 10, 10, EXCL, pid);
671*f6217f89SApple OSS Distributions }
672*f6217f89SApple OSS Distributions
673*f6217f89SApple OSS Distributions {
674*f6217f89SApple OSS Distributions /* SEEK_END start=-10 len=10 */
675*f6217f89SApple OSS Distributions struct flock fl = {.l_start = -file_len, .l_len = file_len, .l_type = F_WRLCK, .l_whence = SEEK_END};
676*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(fcntl(a, F_SETLK, &fl), "SEEK_END: -file_len, file_len");
677*f6217f89SApple OSS Distributions GET_CHECK("SEEK_END: -file_len, file_len", a,
678*f6217f89SApple OSS Distributions 0, 0, EXCL, TYPE_OFD,
679*f6217f89SApple OSS Distributions 0, file_len, EXCL, pid);
680*f6217f89SApple OSS Distributions }
681*f6217f89SApple OSS Distributions
682*f6217f89SApple OSS Distributions {
683*f6217f89SApple OSS Distributions /* Negative case: SEEK_END start=-(file_len + 10) len=20 */
684*f6217f89SApple OSS Distributions struct flock fl = {.l_start = -(file_len + 10), .l_len = 20, .l_type = F_WRLCK, .l_whence = SEEK_END};
685*f6217f89SApple OSS Distributions T_EXPECT_TRUE(fcntl(a, F_SETLK, &fl) && errno == EINVAL, "SEEK_END: -(file_len + 10), 20 => EINVAL");
686*f6217f89SApple OSS Distributions }
687*f6217f89SApple OSS Distributions
688*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_unlock(a, 0, 0), "SEEK_END: cleanup (release locks)");
689*f6217f89SApple OSS Distributions
690*f6217f89SApple OSS Distributions /* Test interactions between all 3 lock types */
691*f6217f89SApple OSS Distributions
692*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(flock(a, LOCK_SH | LOCK_NB), "Interaction: flock(a, shared)");
693*f6217f89SApple OSS Distributions
694*f6217f89SApple OSS Distributions /* Take (waiting) exclusive locks in all 3 types on a_confined */
695*f6217f89SApple OSS Distributions start_lock_thread(TYPE_FLOCK, <s[0], a_confined, 0, 0, EXCL | WAIT);
696*f6217f89SApple OSS Distributions start_lock_thread(TYPE_POSIX, <s[1], a_confined, 0, 0, EXCL | WAIT);
697*f6217f89SApple OSS Distributions start_lock_thread(TYPE_OFD, <s[2], a_confined, 0, 0, EXCL | WAIT);
698*f6217f89SApple OSS Distributions
699*f6217f89SApple OSS Distributions /* Yuck. Allow time for these threads to run -and- block on the flock lock */
700*f6217f89SApple OSS Distributions sleep(1);
701*f6217f89SApple OSS Distributions
702*f6217f89SApple OSS Distributions /* Take shared locks in the remaining 2 types (posix/ofd) on a */
703*f6217f89SApple OSS Distributions
704*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_lock(a, 0, 0, 0), "Interaction: posix_lock(a, 0, 0, 0)");
705*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ofd_lock(a, 0, 0, 0), "Interaction: ofd_lock(a, 0, 0, 0)");
706*f6217f89SApple OSS Distributions
707*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Interaction: flock-waiter is starting or waiting");
708*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[1]), "Interaction: posix-waiter is starting or waiting");
709*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[2]), "Interaction: ofd-waiter is starting or waiting");
710*f6217f89SApple OSS Distributions
711*f6217f89SApple OSS Distributions T_EXPECT_POSIX_FAILURE(flock(a, LOCK_EX | LOCK_NB), EAGAIN, "Interaction: can't flock-upgrade");
712*f6217f89SApple OSS Distributions T_EXPECT_POSIX_FAILURE(posix_lock(a, 0, 0, EXCL), EAGAIN, "Interaction: can't posix-upgrade");
713*f6217f89SApple OSS Distributions T_EXPECT_POSIX_FAILURE(ofd_lock(a, 0, 0, EXCL), EAGAIN, "Interaction: can't ofd-upgrade");
714*f6217f89SApple OSS Distributions
715*f6217f89SApple OSS Distributions /*
716*f6217f89SApple OSS Distributions * At this point:
717*f6217f89SApple OSS Distributions * - 'a' owns a shared flock && a shared OFD lock
718*f6217f89SApple OSS Distributions * - this process owns a shared POSIX lock
719*f6217f89SApple OSS Distributions * - three threads are (hopefully) blocked waiting to take exclusive locks
720*f6217f89SApple OSS Distributions * on 'a_confined.'
721*f6217f89SApple OSS Distributions *
722*f6217f89SApple OSS Distributions * Drop the POSIX lock ...
723*f6217f89SApple OSS Distributions */
724*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_unlock(a, 0, 0), "Interaction: Unlock posix");
725*f6217f89SApple OSS Distributions
726*f6217f89SApple OSS Distributions random_pause(); /* wait a bit to see if there are consequences for the waiting locks */
727*f6217f89SApple OSS Distributions
728*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Interaction: flock-waiter is still starting or waiting");
729*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[1]), "Interaction: posix-waiter is still starting or waiting");
730*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[2]), "Interaction: ofd-waiter is still starting or waiting");
731*f6217f89SApple OSS Distributions
732*f6217f89SApple OSS Distributions /*
733*f6217f89SApple OSS Distributions * and drop the flock lock ...
734*f6217f89SApple OSS Distributions */
735*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(flock(a, LOCK_UN), "Interaction: Unlock flock");
736*f6217f89SApple OSS Distributions
737*f6217f89SApple OSS Distributions random_pause(); /* wait a bit to see if there are consequences for the waiting locks */
738*f6217f89SApple OSS Distributions
739*f6217f89SApple OSS Distributions // Check that rdar://102160410 remains fixed.
740*f6217f89SApple OSS Distributions // Before that, the LOCK_UN above would release the OFD lock too
741*f6217f89SApple OSS Distributions
742*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[0]), "Interaction: flock-waiter is still starting or waiting");
743*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[1]), "Interaction: posix-waiter is still starting or waiting");
744*f6217f89SApple OSS Distributions T_ASSERT_FALSE(has_completed(<s[2]), "Interaction: ofd-waiter is still starting or waiting");
745*f6217f89SApple OSS Distributions
746*f6217f89SApple OSS Distributions /*
747*f6217f89SApple OSS Distributions * and finally drop the OFD lock, which should let one of the blocked threads
748*f6217f89SApple OSS Distributions * acquire an exclusive lock. Work through them turn by turn.
749*f6217f89SApple OSS Distributions */
750*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ofd_unlock(a, 0, 0), "Interaction: Unlock ofd");
751*f6217f89SApple OSS Distributions
752*f6217f89SApple OSS Distributions bool unlocked[3] = {
753*f6217f89SApple OSS Distributions false, false, false
754*f6217f89SApple OSS Distributions };
755*f6217f89SApple OSS Distributions
756*f6217f89SApple OSS Distributions for (uint32_t waiters = 3; waiters > 0; waiters--) {
757*f6217f89SApple OSS Distributions uint32_t num_waiting = 0;
758*f6217f89SApple OSS Distributions do {
759*f6217f89SApple OSS Distributions random_pause(); /* wait for consequences for the waiting locks */
760*f6217f89SApple OSS Distributions num_waiting = !has_completed(<s[0]) + !has_completed(<s[1]) + !has_completed(<s[2]);
761*f6217f89SApple OSS Distributions } while (num_waiting == waiters);
762*f6217f89SApple OSS Distributions
763*f6217f89SApple OSS Distributions T_ASSERT_EQ(num_waiting, waiters - 1, "Interaction: 1 waiter awoke");
764*f6217f89SApple OSS Distributions
765*f6217f89SApple OSS Distributions if (has_completed(<s[0]) && !unlocked[0]) {
766*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(flock(a_confined, LOCK_UN), "Interaction: Flock awoke, unlocking");
767*f6217f89SApple OSS Distributions unlocked[0] = true;
768*f6217f89SApple OSS Distributions } else if (has_completed(<s[1]) && !unlocked[1]) {
769*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(posix_unlock(a_confined, 0, 0), "Interaction: posix awoke, unlocking");
770*f6217f89SApple OSS Distributions unlocked[1] = true;
771*f6217f89SApple OSS Distributions } else if (has_completed(<s[2]) && !unlocked[2]) {
772*f6217f89SApple OSS Distributions T_ASSERT_POSIX_SUCCESS(ofd_unlock(a_confined, 0, 0), "Interaction: ofd awoke, unlocking");
773*f6217f89SApple OSS Distributions unlocked[2] = true;
774*f6217f89SApple OSS Distributions }
775*f6217f89SApple OSS Distributions }
776*f6217f89SApple OSS Distributions
777*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[0]), "Interaction: flock-waiter has completed");
778*f6217f89SApple OSS Distributions T_ASSERT_TRUE(unlocked[0], "Interaction: flock-waiter was unlocked");
779*f6217f89SApple OSS Distributions
780*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[1]), "Interaction: posix-waiter has completed");
781*f6217f89SApple OSS Distributions T_ASSERT_TRUE(unlocked[1], "Interaction: posix-waiter was unlocked");
782*f6217f89SApple OSS Distributions
783*f6217f89SApple OSS Distributions T_ASSERT_TRUE(has_completed(<s[2]), "Interaction: ofd-waiter has completed");
784*f6217f89SApple OSS Distributions T_ASSERT_TRUE(unlocked[2], "Interaction: ofd-waiter was unlocked");
785*f6217f89SApple OSS Distributions }
786