xref: /freebsd/lib/libthr/thread/thr_rtld.c (revision 6b932eca796b2b80b5295abc853f56cb3f8a15f9)
1b6b894f6SDavid Xu /*
2b6b894f6SDavid Xu  * Copyright (c) 2006, David Xu <davidxu@freebsd.org>
3b6b894f6SDavid Xu  * All rights reserved.
4b6b894f6SDavid Xu  *
5b6b894f6SDavid Xu  * Redistribution and use in source and binary forms, with or without
6b6b894f6SDavid Xu  * modification, are permitted provided that the following conditions
7b6b894f6SDavid Xu  * are met:
8b6b894f6SDavid Xu  * 1. Redistributions of source code must retain the above copyright
9b6b894f6SDavid Xu  *    notice unmodified, this list of conditions, and the following
10b6b894f6SDavid Xu  *    disclaimer.
11b6b894f6SDavid Xu  * 2. Redistributions in binary form must reproduce the above copyright
12b6b894f6SDavid Xu  *    notice, this list of conditions and the following disclaimer in the
13b6b894f6SDavid Xu  *    documentation and/or other materials provided with the distribution.
14b6b894f6SDavid Xu  *
15b6b894f6SDavid Xu  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16b6b894f6SDavid Xu  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17b6b894f6SDavid Xu  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18b6b894f6SDavid Xu  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19b6b894f6SDavid Xu  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20b6b894f6SDavid Xu  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21b6b894f6SDavid Xu  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22b6b894f6SDavid Xu  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23b6b894f6SDavid Xu  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24b6b894f6SDavid Xu  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25b6b894f6SDavid Xu  *
26b6b894f6SDavid Xu  * $FreeBSD$
27b6b894f6SDavid Xu  *
28b6b894f6SDavid Xu  */
29b6b894f6SDavid Xu 
30b6b894f6SDavid Xu  /*
31b6b894f6SDavid Xu   * A lockless rwlock for rtld.
32b6b894f6SDavid Xu   */
33b6b894f6SDavid Xu #include <sys/cdefs.h>
34b6b894f6SDavid Xu #include <stdlib.h>
35b6b894f6SDavid Xu 
36b6b894f6SDavid Xu #include "rtld_lock.h"
37b6b894f6SDavid Xu #include "thr_private.h"
38b6b894f6SDavid Xu 
398c38215fSDavid Xu #undef errno
408c38215fSDavid Xu extern int errno;
418c38215fSDavid Xu 
42b6b894f6SDavid Xu static int	_thr_rtld_clr_flag(int);
43b6b894f6SDavid Xu static void	*_thr_rtld_lock_create(void);
44b6b894f6SDavid Xu static void	_thr_rtld_lock_destroy(void *);
45b6b894f6SDavid Xu static void	_thr_rtld_lock_release(void *);
46b6b894f6SDavid Xu static void	_thr_rtld_rlock_acquire(void *);
47b6b894f6SDavid Xu static int	_thr_rtld_set_flag(int);
48b6b894f6SDavid Xu static void	_thr_rtld_wlock_acquire(void *);
49b6b894f6SDavid Xu 
50b6b894f6SDavid Xu struct rtld_lock {
51fb2641d9SDavid Xu 	struct	urwlock	lock;
5210b40346SKonstantin Belousov 	char		_pad[CACHE_LINE_SIZE - sizeof(struct urwlock)];
53b6b894f6SDavid Xu };
54b6b894f6SDavid Xu 
5510b40346SKonstantin Belousov static struct rtld_lock lock_place[MAX_RTLD_LOCKS] __aligned(CACHE_LINE_SIZE);
5610b40346SKonstantin Belousov static int busy_places;
5710b40346SKonstantin Belousov 
58b6b894f6SDavid Xu static void *
59b6b894f6SDavid Xu _thr_rtld_lock_create(void)
60b6b894f6SDavid Xu {
6110b40346SKonstantin Belousov 	int locki;
62b6b894f6SDavid Xu 	struct rtld_lock *l;
6310b40346SKonstantin Belousov 	static const char fail[] = "_thr_rtld_lock_create failed\n";
64b6b894f6SDavid Xu 
6510b40346SKonstantin Belousov 	for (locki = 0; locki < MAX_RTLD_LOCKS; locki++) {
6610b40346SKonstantin Belousov 		if ((busy_places & (1 << locki)) == 0)
6710b40346SKonstantin Belousov 			break;
68b6b894f6SDavid Xu 	}
6910b40346SKonstantin Belousov 	if (locki == MAX_RTLD_LOCKS) {
7010b40346SKonstantin Belousov 		write(2, fail, sizeof(fail) - 1);
7110b40346SKonstantin Belousov 		return (NULL);
7210b40346SKonstantin Belousov 	}
7310b40346SKonstantin Belousov 	busy_places |= (1 << locki);
7410b40346SKonstantin Belousov 
7510b40346SKonstantin Belousov 	l = &lock_place[locki];
76fb2641d9SDavid Xu 	l->lock.rw_flags = URWLOCK_PREFER_READER;
77b6b894f6SDavid Xu 	return (l);
78b6b894f6SDavid Xu }
79b6b894f6SDavid Xu 
80b6b894f6SDavid Xu static void
81b6b894f6SDavid Xu _thr_rtld_lock_destroy(void *lock)
82b6b894f6SDavid Xu {
8310b40346SKonstantin Belousov 	int locki;
8410b40346SKonstantin Belousov 
8510b40346SKonstantin Belousov 	locki = (struct rtld_lock *)lock - &lock_place[0];
8610b40346SKonstantin Belousov 	busy_places &= ~(1 << locki);
87b6b894f6SDavid Xu }
88b6b894f6SDavid Xu 
898c38215fSDavid Xu #define SAVE_ERRNO()	{			\
908c38215fSDavid Xu 	if (curthread != _thr_initial)		\
918c38215fSDavid Xu 		errsave = curthread->error;	\
928c38215fSDavid Xu 	else					\
938c38215fSDavid Xu 		errsave = errno;		\
948c38215fSDavid Xu }
958c38215fSDavid Xu 
968c38215fSDavid Xu #define RESTORE_ERRNO()	{ 			\
978c38215fSDavid Xu 	if (curthread != _thr_initial)  	\
988c38215fSDavid Xu 		curthread->error = errsave;	\
998c38215fSDavid Xu 	else					\
1008c38215fSDavid Xu 		errno = errsave;		\
1018c38215fSDavid Xu }
1028c38215fSDavid Xu 
103b6b894f6SDavid Xu static void
104b6b894f6SDavid Xu _thr_rtld_rlock_acquire(void *lock)
105b6b894f6SDavid Xu {
106b6b894f6SDavid Xu 	struct pthread		*curthread;
107b6b894f6SDavid Xu 	struct rtld_lock	*l;
1088c38215fSDavid Xu 	int			errsave;
109b6b894f6SDavid Xu 
110b6b894f6SDavid Xu 	curthread = _get_curthread();
1118c38215fSDavid Xu 	SAVE_ERRNO();
112b6b894f6SDavid Xu 	l = (struct rtld_lock *)lock;
113b6b894f6SDavid Xu 
114b6b894f6SDavid Xu 	THR_CRITICAL_ENTER(curthread);
115fb2641d9SDavid Xu 	while (_thr_rwlock_rdlock(&l->lock, 0, NULL) != 0)
116fb2641d9SDavid Xu 		;
117137ae5d2SAttilio Rao 	curthread->rdlock_count++;
1188c38215fSDavid Xu 	RESTORE_ERRNO();
119b6b894f6SDavid Xu }
120b6b894f6SDavid Xu 
121b6b894f6SDavid Xu static void
122b6b894f6SDavid Xu _thr_rtld_wlock_acquire(void *lock)
123b6b894f6SDavid Xu {
124b6b894f6SDavid Xu 	struct pthread		*curthread;
125b6b894f6SDavid Xu 	struct rtld_lock	*l;
1268c38215fSDavid Xu 	int			errsave;
127b6b894f6SDavid Xu 
128b6b894f6SDavid Xu 	curthread = _get_curthread();
1298c38215fSDavid Xu 	SAVE_ERRNO();
130b6b894f6SDavid Xu 	l = (struct rtld_lock *)lock;
131b6b894f6SDavid Xu 
132b6b894f6SDavid Xu 	_thr_signal_block(curthread);
133fb2641d9SDavid Xu 	while (_thr_rwlock_wrlock(&l->lock, NULL) != 0)
134fb2641d9SDavid Xu 		;
1358c38215fSDavid Xu 	RESTORE_ERRNO();
136b6b894f6SDavid Xu }
137b6b894f6SDavid Xu 
138b6b894f6SDavid Xu static void
139b6b894f6SDavid Xu _thr_rtld_lock_release(void *lock)
140b6b894f6SDavid Xu {
141b6b894f6SDavid Xu 	struct pthread		*curthread;
142b6b894f6SDavid Xu 	struct rtld_lock	*l;
143fb2641d9SDavid Xu 	int32_t			state;
1448c38215fSDavid Xu 	int			errsave;
145b6b894f6SDavid Xu 
146b6b894f6SDavid Xu 	curthread = _get_curthread();
1478c38215fSDavid Xu 	SAVE_ERRNO();
148b6b894f6SDavid Xu 	l = (struct rtld_lock *)lock;
149b6b894f6SDavid Xu 
150fb2641d9SDavid Xu 	state = l->lock.rw_state;
151fb2641d9SDavid Xu 	if (_thr_rwlock_unlock(&l->lock) == 0) {
152fb2641d9SDavid Xu 		if ((state & URWLOCK_WRITE_OWNER) == 0) {
153*6b932ecaSDavid Xu 			curthread->rdlock_count--;
154b6b894f6SDavid Xu 			THR_CRITICAL_LEAVE(curthread);
155b6b894f6SDavid Xu 		} else {
156b6b894f6SDavid Xu 			_thr_signal_unblock(curthread);
157b6b894f6SDavid Xu 		}
158fb2641d9SDavid Xu 	}
1598c38215fSDavid Xu 	RESTORE_ERRNO();
160b6b894f6SDavid Xu }
161b6b894f6SDavid Xu 
162b6b894f6SDavid Xu static int
16337a6356bSDavid Xu _thr_rtld_set_flag(int mask __unused)
164b6b894f6SDavid Xu {
165b6b894f6SDavid Xu 	/*
166b6b894f6SDavid Xu 	 * The caller's code in rtld-elf is broken, it is not signal safe,
167b6b894f6SDavid Xu 	 * just return zero to fool it.
168b6b894f6SDavid Xu 	 */
169b6b894f6SDavid Xu 	return (0);
170b6b894f6SDavid Xu }
171b6b894f6SDavid Xu 
172b6b894f6SDavid Xu static int
17337a6356bSDavid Xu _thr_rtld_clr_flag(int mask __unused)
174b6b894f6SDavid Xu {
175b6b894f6SDavid Xu 	return (0);
176b6b894f6SDavid Xu }
177b6b894f6SDavid Xu 
178b6b894f6SDavid Xu void
179b6b894f6SDavid Xu _thr_rtld_init(void)
180b6b894f6SDavid Xu {
181b6b894f6SDavid Xu 	struct RtldLockInfo	li;
182b6b894f6SDavid Xu 	struct pthread		*curthread;
18370ba1e8fSPeter Wemm 	long dummy = -1;
184b6b894f6SDavid Xu 
185b6b894f6SDavid Xu 	curthread = _get_curthread();
186b6b894f6SDavid Xu 
187b6b894f6SDavid Xu 	/* force to resolve _umtx_op PLT */
188d6e0eb0aSDavid Xu 	_umtx_op_err((struct umtx *)&dummy, UMTX_OP_WAKE, 1, 0, 0);
18904a57d2cSDavid Xu 
19004a57d2cSDavid Xu 	/* force to resolve errno() PLT */
19104a57d2cSDavid Xu 	__error();
192b6b894f6SDavid Xu 
193b6b894f6SDavid Xu 	li.lock_create  = _thr_rtld_lock_create;
194b6b894f6SDavid Xu 	li.lock_destroy = _thr_rtld_lock_destroy;
195b6b894f6SDavid Xu 	li.rlock_acquire = _thr_rtld_rlock_acquire;
196b6b894f6SDavid Xu 	li.wlock_acquire = _thr_rtld_wlock_acquire;
197b6b894f6SDavid Xu 	li.lock_release  = _thr_rtld_lock_release;
198b6b894f6SDavid Xu 	li.thread_set_flag = _thr_rtld_set_flag;
199b6b894f6SDavid Xu 	li.thread_clr_flag = _thr_rtld_clr_flag;
200b6b894f6SDavid Xu 	li.at_fork = NULL;
201b6b894f6SDavid Xu 
202b6b894f6SDavid Xu 	/* mask signals, also force to resolve __sys_sigprocmask PLT */
203b6b894f6SDavid Xu 	_thr_signal_block(curthread);
204b6b894f6SDavid Xu 	_rtld_thread_init(&li);
205b6b894f6SDavid Xu 	_thr_signal_unblock(curthread);
206b6b894f6SDavid Xu }
207b6b894f6SDavid Xu 
208b6b894f6SDavid Xu void
209b6b894f6SDavid Xu _thr_rtld_fini(void)
210b6b894f6SDavid Xu {
211b6b894f6SDavid Xu 	struct pthread	*curthread;
212b6b894f6SDavid Xu 
213b6b894f6SDavid Xu 	curthread = _get_curthread();
214b6b894f6SDavid Xu 	_thr_signal_block(curthread);
215b6b894f6SDavid Xu 	_rtld_thread_init(NULL);
216b6b894f6SDavid Xu 	_thr_signal_unblock(curthread);
217b6b894f6SDavid Xu }
218