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