xref: /freebsd/libexec/rtld-elf/aarch64/reloc.c (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
1 /*-
2  * Copyright (c) 2014-2015 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * Portions of this software were developed by Andrew Turner
6  * under sponsorship from the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include <sys/types.h>
34 
35 #include <stdlib.h>
36 
37 #include "debug.h"
38 #include "rtld.h"
39 #include "rtld_printf.h"
40 
41 /*
42  * It is possible for the compiler to emit relocations for unaligned data.
43  * We handle this situation with these inlines.
44  */
45 #define	RELOC_ALIGNED_P(x) \
46 	(((uintptr_t)(x) & (sizeof(void *) - 1)) == 0)
47 
48 /*
49  * This is not the correct prototype, but we only need it for
50  * a function pointer to a simple asm function.
51  */
52 void *_rtld_tlsdesc(void *);
53 void *_rtld_tlsdesc_dynamic(void *);
54 
55 void _exit(int);
56 
57 void
58 init_pltgot(Obj_Entry *obj)
59 {
60 
61 	if (obj->pltgot != NULL) {
62 		obj->pltgot[1] = (Elf_Addr) obj;
63 		obj->pltgot[2] = (Elf_Addr) &_rtld_bind_start;
64 	}
65 }
66 
67 int
68 do_copy_relocations(Obj_Entry *dstobj)
69 {
70 	const Obj_Entry *srcobj, *defobj;
71 	const Elf_Rela *relalim;
72 	const Elf_Rela *rela;
73 	const Elf_Sym *srcsym;
74 	const Elf_Sym *dstsym;
75 	const void *srcaddr;
76 	const char *name;
77 	void *dstaddr;
78 	SymLook req;
79 	size_t size;
80 	int res;
81 
82 	/*
83 	 * COPY relocs are invalid outside of the main program
84 	 */
85 	assert(dstobj->mainprog);
86 
87 	relalim = (const Elf_Rela *)((char *)dstobj->rela +
88 	    dstobj->relasize);
89 	for (rela = dstobj->rela; rela < relalim; rela++) {
90 		if (ELF_R_TYPE(rela->r_info) != R_AARCH64_COPY)
91 			continue;
92 
93 		dstaddr = (void *)(dstobj->relocbase + rela->r_offset);
94 		dstsym = dstobj->symtab + ELF_R_SYM(rela->r_info);
95 		name = dstobj->strtab + dstsym->st_name;
96 		size = dstsym->st_size;
97 
98 		symlook_init(&req, name);
99 		req.ventry = fetch_ventry(dstobj, ELF_R_SYM(rela->r_info));
100 		req.flags = SYMLOOK_EARLY;
101 
102 		for (srcobj = globallist_next(dstobj); srcobj != NULL;
103 		     srcobj = globallist_next(srcobj)) {
104 			res = symlook_obj(&req, srcobj);
105 			if (res == 0) {
106 				srcsym = req.sym_out;
107 				defobj = req.defobj_out;
108 				break;
109 			}
110 		}
111 		if (srcobj == NULL) {
112 			_rtld_error(
113 "Undefined symbol \"%s\" referenced from COPY relocation in %s",
114 			    name, dstobj->path);
115 			return (-1);
116 		}
117 
118 		srcaddr = (const void *)(defobj->relocbase + srcsym->st_value);
119 		memcpy(dstaddr, srcaddr, size);
120 	}
121 
122 	return (0);
123 }
124 
125 struct tls_data {
126 	int64_t index;
127 	Obj_Entry *obj;
128 	const Elf_Rela *rela;
129 };
130 
131 static struct tls_data *
132 reloc_tlsdesc_alloc(Obj_Entry *obj, const Elf_Rela *rela)
133 {
134 	struct tls_data *tlsdesc;
135 
136 	tlsdesc = xmalloc(sizeof(struct tls_data));
137 	tlsdesc->index = -1;
138 	tlsdesc->obj = obj;
139 	tlsdesc->rela = rela;
140 
141 	return (tlsdesc);
142 }
143 
144 /*
145  * Look up the symbol to find its tls index
146  */
147 static int64_t
148 rtld_tlsdesc_handle_locked(struct tls_data *tlsdesc, int flags,
149     RtldLockState *lockstate)
150 {
151 	const Elf_Rela *rela;
152 	const Elf_Sym *def;
153 	const Obj_Entry *defobj;
154 	Obj_Entry *obj;
155 
156 	rela = tlsdesc->rela;
157 	obj = tlsdesc->obj;
158 
159 	def = find_symdef(ELF_R_SYM(rela->r_info), obj, &defobj, flags, NULL,
160 	    lockstate);
161 	if (def == NULL)
162 		rtld_die();
163 
164 	tlsdesc->index = defobj->tlsoffset + def->st_value + rela->r_addend;
165 
166 	return (tlsdesc->index);
167 }
168 
169 int64_t
170 rtld_tlsdesc_handle(struct tls_data *tlsdesc, int flags)
171 {
172 	RtldLockState lockstate;
173 
174 	/* We have already found the index, return it */
175 	if (tlsdesc->index >= 0)
176 		return (tlsdesc->index);
177 
178 	wlock_acquire(rtld_bind_lock, &lockstate);
179 	/* tlsdesc->index may have been set by another thread */
180 	if (tlsdesc->index == -1)
181 		rtld_tlsdesc_handle_locked(tlsdesc, flags, &lockstate);
182 	lock_release(rtld_bind_lock, &lockstate);
183 
184 	return (tlsdesc->index);
185 }
186 
187 static void
188 reloc_tlsdesc(Obj_Entry *obj, const Elf_Rela *rela, Elf_Addr *where)
189 {
190 	if (ELF_R_SYM(rela->r_info) == 0) {
191 		where[0] = (Elf_Addr)_rtld_tlsdesc;
192 		where[1] = obj->tlsoffset + rela->r_addend;
193 	} else {
194 		where[0] = (Elf_Addr)_rtld_tlsdesc_dynamic;
195 		where[1] = (Elf_Addr)reloc_tlsdesc_alloc(obj, rela);
196 	}
197 }
198 
199 /*
200  * Process the PLT relocations.
201  */
202 int
203 reloc_plt(Obj_Entry *obj)
204 {
205 	const Elf_Rela *relalim;
206 	const Elf_Rela *rela;
207 
208 	relalim = (const Elf_Rela *)((char *)obj->pltrela + obj->pltrelasize);
209 	for (rela = obj->pltrela; rela < relalim; rela++) {
210 		Elf_Addr *where;
211 
212 		where = (Elf_Addr *)(obj->relocbase + rela->r_offset);
213 
214 		switch(ELF_R_TYPE(rela->r_info)) {
215 		case R_AARCH64_JUMP_SLOT:
216 			*where += (Elf_Addr)obj->relocbase;
217 			break;
218 		case R_AARCH64_TLSDESC:
219 			reloc_tlsdesc(obj, rela, where);
220 			break;
221 		default:
222 			_rtld_error("Unknown relocation type %u in PLT",
223 			    (unsigned int)ELF_R_TYPE(rela->r_info));
224 			return (-1);
225 		}
226 	}
227 
228 	return (0);
229 }
230 
231 /*
232  * LD_BIND_NOW was set - force relocation for all jump slots
233  */
234 int
235 reloc_jmpslots(Obj_Entry *obj, int flags, RtldLockState *lockstate)
236 {
237 	const Obj_Entry *defobj;
238 	const Elf_Rela *relalim;
239 	const Elf_Rela *rela;
240 	const Elf_Sym *def;
241 	struct tls_data *tlsdesc;
242 
243 	relalim = (const Elf_Rela *)((char *)obj->pltrela + obj->pltrelasize);
244 	for (rela = obj->pltrela; rela < relalim; rela++) {
245 		Elf_Addr *where;
246 
247 		where = (Elf_Addr *)(obj->relocbase + rela->r_offset);
248 		switch(ELF_R_TYPE(rela->r_info)) {
249 		case R_AARCH64_JUMP_SLOT:
250 			def = find_symdef(ELF_R_SYM(rela->r_info), obj,
251 			    &defobj, SYMLOOK_IN_PLT | flags, NULL, lockstate);
252 			if (def == NULL) {
253 				dbg("reloc_jmpslots: sym not found");
254 				return (-1);
255 			}
256 
257 			*where = (Elf_Addr)(defobj->relocbase + def->st_value);
258 			break;
259 		case R_AARCH64_TLSDESC:
260 			if (ELF_R_SYM(rela->r_info) != 0) {
261 				tlsdesc = (struct tls_data *)where[1];
262 				if (tlsdesc->index == -1)
263 					rtld_tlsdesc_handle_locked(tlsdesc,
264 					    SYMLOOK_IN_PLT | flags, lockstate);
265 			}
266 			break;
267 		default:
268 			_rtld_error("Unknown relocation type %x in jmpslot",
269 			    (unsigned int)ELF_R_TYPE(rela->r_info));
270 			return (-1);
271 		}
272 	}
273 
274 	return (0);
275 }
276 
277 int
278 reloc_iresolve(Obj_Entry *obj, struct Struct_RtldLockState *lockstate)
279 {
280 
281 	/* XXX not implemented */
282 	return (0);
283 }
284 
285 int
286 reloc_gnu_ifunc(Obj_Entry *obj, int flags,
287    struct Struct_RtldLockState *lockstate)
288 {
289 
290 	/* XXX not implemented */
291 	return (0);
292 }
293 
294 Elf_Addr
295 reloc_jmpslot(Elf_Addr *where, Elf_Addr target, const Obj_Entry *defobj,
296     const Obj_Entry *obj, const Elf_Rel *rel)
297 {
298 
299 	assert(ELF_R_TYPE(rel->r_info) == R_AARCH64_JUMP_SLOT);
300 
301 	if (*where != target && !ld_bind_not)
302 		*where = target;
303 	return (target);
304 }
305 
306 void
307 ifunc_init(Elf_Auxinfo aux_info[__min_size(AT_COUNT)] __unused)
308 {
309 }
310 
311 /*
312  * Process non-PLT relocations
313  */
314 int
315 reloc_non_plt(Obj_Entry *obj, Obj_Entry *obj_rtld, int flags,
316     RtldLockState *lockstate)
317 {
318 	const Obj_Entry *defobj;
319 	const Elf_Rela *relalim;
320 	const Elf_Rela *rela;
321 	const Elf_Sym *def;
322 	SymCache *cache;
323 	Elf_Addr *where;
324 	unsigned long symnum;
325 
326 	if ((flags & SYMLOOK_IFUNC) != 0)
327 		/* XXX not implemented */
328 		return (0);
329 
330 	/*
331 	 * The dynamic loader may be called from a thread, we have
332 	 * limited amounts of stack available so we cannot use alloca().
333 	 */
334 	if (obj == obj_rtld)
335 		cache = NULL;
336 	else
337 		cache = calloc(obj->dynsymcount, sizeof(SymCache));
338 		/* No need to check for NULL here */
339 
340 	relalim = (const Elf_Rela *)((caddr_t)obj->rela + obj->relasize);
341 	for (rela = obj->rela; rela < relalim; rela++) {
342 		where = (Elf_Addr *)(obj->relocbase + rela->r_offset);
343 		symnum = ELF_R_SYM(rela->r_info);
344 
345 		switch (ELF_R_TYPE(rela->r_info)) {
346 		case R_AARCH64_ABS64:
347 		case R_AARCH64_GLOB_DAT:
348 			def = find_symdef(symnum, obj, &defobj, flags, cache,
349 			    lockstate);
350 			if (def == NULL)
351 				return (-1);
352 
353 			*where = (Elf_Addr)defobj->relocbase + def->st_value +
354 			    rela->r_addend;
355 			break;
356 		case R_AARCH64_COPY:
357 			/*
358 			 * These are deferred until all other relocations have
359 			 * been done. All we do here is make sure that the
360 			 * COPY relocation is not in a shared library. They
361 			 * are allowed only in executable files.
362 			 */
363 			if (!obj->mainprog) {
364 				_rtld_error("%s: Unexpected R_AARCH64_COPY "
365 				    "relocation in shared library", obj->path);
366 				return (-1);
367 			}
368 			break;
369 		case R_AARCH64_TLSDESC:
370 			reloc_tlsdesc(obj, rela, where);
371 			break;
372 		case R_AARCH64_TLS_TPREL64:
373 			def = find_symdef(symnum, obj, &defobj, flags, cache,
374 			    lockstate);
375 			if (def == NULL)
376 				return (-1);
377 
378 			/*
379 			 * We lazily allocate offsets for static TLS as we
380 			 * see the first relocation that references the
381 			 * TLS block. This allows us to support (small
382 			 * amounts of) static TLS in dynamically loaded
383 			 * modules. If we run out of space, we generate an
384 			 * error.
385 			 */
386 			if (!defobj->tls_done) {
387 				if (!allocate_tls_offset((Obj_Entry*) defobj)) {
388 					_rtld_error(
389 					    "%s: No space available for static "
390 					    "Thread Local Storage", obj->path);
391 					return (-1);
392 				}
393 			}
394 
395 			*where = def->st_value + rela->r_addend +
396 			    defobj->tlsoffset;
397 			break;
398 		case R_AARCH64_RELATIVE:
399 			*where = (Elf_Addr)(obj->relocbase + rela->r_addend);
400 			break;
401 		default:
402 			rtld_printf("%s: Unhandled relocation %lu\n",
403 			    obj->path, ELF_R_TYPE(rela->r_info));
404 			return (-1);
405 		}
406 	}
407 
408 	return (0);
409 }
410 
411 void
412 allocate_initial_tls(Obj_Entry *objs)
413 {
414 	Elf_Addr **tp;
415 
416 	/*
417 	* Fix the size of the static TLS block by using the maximum
418 	* offset allocated so far and adding a bit for dynamic modules to
419 	* use.
420 	*/
421 	tls_static_space = tls_last_offset + tls_last_size +
422 	    RTLD_STATIC_TLS_EXTRA;
423 
424 	tp = (Elf_Addr **) allocate_tls(objs, NULL, TLS_TCB_SIZE, 16);
425 
426 	asm volatile("msr	tpidr_el0, %0" : : "r"(tp));
427 }
428