xref: /freebsd/sys/powerpc/powerpc/elf64_machdep.c (revision 4bc52338)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright 1996-1998 John D. Polstra.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/systm.h>
33 #include <sys/exec.h>
34 #include <sys/imgact.h>
35 #include <sys/malloc.h>
36 #include <sys/proc.h>
37 #include <sys/namei.h>
38 #include <sys/fcntl.h>
39 #include <sys/sysent.h>
40 #include <sys/imgact_elf.h>
41 #include <sys/syscall.h>
42 #include <sys/signalvar.h>
43 #include <sys/vnode.h>
44 #include <sys/linker.h>
45 
46 #include <vm/vm.h>
47 #include <vm/vm_param.h>
48 
49 #include <machine/altivec.h>
50 #include <machine/cpu.h>
51 #include <machine/fpu.h>
52 #include <machine/elf.h>
53 #include <machine/md_var.h>
54 
55 static void exec_setregs_funcdesc(struct thread *td, struct image_params *imgp,
56     u_long stack);
57 
58 struct sysentvec elf64_freebsd_sysvec_v1 = {
59 	.sv_size	= SYS_MAXSYSCALL,
60 	.sv_table	= sysent,
61 	.sv_errsize	= 0,
62 	.sv_errtbl	= NULL,
63 	.sv_transtrap	= NULL,
64 	.sv_fixup	= __elfN(freebsd_fixup),
65 	.sv_sendsig	= sendsig,
66 	.sv_sigcode	= sigcode64,
67 	.sv_szsigcode	= &szsigcode64,
68 	.sv_name	= "FreeBSD ELF64",
69 	.sv_coredump	= __elfN(coredump),
70 	.sv_imgact_try	= NULL,
71 	.sv_minsigstksz	= MINSIGSTKSZ,
72 	.sv_minuser	= VM_MIN_ADDRESS,
73 	.sv_maxuser	= VM_MAXUSER_ADDRESS,
74 	.sv_usrstack	= USRSTACK,
75 	.sv_psstrings	= PS_STRINGS,
76 	.sv_stackprot	= VM_PROT_ALL,
77 	.sv_copyout_strings = exec_copyout_strings,
78 	.sv_setregs	= exec_setregs_funcdesc,
79 	.sv_fixlimit	= NULL,
80 	.sv_maxssiz	= NULL,
81 	.sv_flags	= SV_ABI_FREEBSD | SV_LP64 | SV_SHP | SV_ASLR,
82 	.sv_set_syscall_retval = cpu_set_syscall_retval,
83 	.sv_fetch_syscall_args = cpu_fetch_syscall_args,
84 	.sv_syscallnames = syscallnames,
85 	.sv_shared_page_base = SHAREDPAGE,
86 	.sv_shared_page_len = PAGE_SIZE,
87 	.sv_schedtail	= NULL,
88 	.sv_thread_detach = NULL,
89 	.sv_trap	= NULL,
90 	.sv_hwcap	= &cpu_features,
91 	.sv_hwcap2	= &cpu_features2,
92 };
93 INIT_SYSENTVEC(elf64_sysvec_v1, &elf64_freebsd_sysvec_v1);
94 
95 struct sysentvec elf64_freebsd_sysvec_v2 = {
96 	.sv_size	= SYS_MAXSYSCALL,
97 	.sv_table	= sysent,
98 	.sv_errsize	= 0,
99 	.sv_errtbl	= NULL,
100 	.sv_transtrap	= NULL,
101 	.sv_fixup	= __elfN(freebsd_fixup),
102 	.sv_sendsig	= sendsig,
103 	.sv_sigcode	= sigcode64_elfv2,
104 	.sv_szsigcode	= &szsigcode64_elfv2,
105 	.sv_name	= "FreeBSD ELF64 V2",
106 	.sv_coredump	= __elfN(coredump),
107 	.sv_imgact_try	= NULL,
108 	.sv_minsigstksz	= MINSIGSTKSZ,
109 	.sv_minuser	= VM_MIN_ADDRESS,
110 	.sv_maxuser	= VM_MAXUSER_ADDRESS,
111 	.sv_usrstack	= USRSTACK,
112 	.sv_psstrings	= PS_STRINGS,
113 	.sv_stackprot	= VM_PROT_ALL,
114 	.sv_copyout_strings = exec_copyout_strings,
115 	.sv_setregs	= exec_setregs,
116 	.sv_fixlimit	= NULL,
117 	.sv_maxssiz	= NULL,
118 	.sv_flags	= SV_ABI_FREEBSD | SV_LP64 | SV_SHP,
119 	.sv_set_syscall_retval = cpu_set_syscall_retval,
120 	.sv_fetch_syscall_args = cpu_fetch_syscall_args,
121 	.sv_syscallnames = syscallnames,
122 	.sv_shared_page_base = SHAREDPAGE,
123 	.sv_shared_page_len = PAGE_SIZE,
124 	.sv_schedtail	= NULL,
125 	.sv_thread_detach = NULL,
126 	.sv_trap	= NULL,
127 	.sv_hwcap	= &cpu_features,
128 	.sv_hwcap2	= &cpu_features2,
129 };
130 INIT_SYSENTVEC(elf64_sysvec_v2, &elf64_freebsd_sysvec_v2);
131 
132 static boolean_t ppc64_elfv1_header_match(struct image_params *params);
133 static boolean_t ppc64_elfv2_header_match(struct image_params *params);
134 
135 static Elf64_Brandinfo freebsd_brand_info_elfv1 = {
136 	.brand		= ELFOSABI_FREEBSD,
137 	.machine	= EM_PPC64,
138 	.compat_3_brand	= "FreeBSD",
139 	.emul_path	= NULL,
140 	.interp_path	= "/libexec/ld-elf.so.1",
141 	.sysvec		= &elf64_freebsd_sysvec_v1,
142 	.interp_newpath	= NULL,
143 	.brand_note	= &elf64_freebsd_brandnote,
144 	.flags		= BI_CAN_EXEC_DYN | BI_BRAND_NOTE,
145 	.header_supported = &ppc64_elfv1_header_match
146 };
147 
148 SYSINIT(elf64v1, SI_SUB_EXEC, SI_ORDER_ANY,
149     (sysinit_cfunc_t) elf64_insert_brand_entry,
150     &freebsd_brand_info_elfv1);
151 
152 static Elf64_Brandinfo freebsd_brand_info_elfv2 = {
153 	.brand		= ELFOSABI_FREEBSD,
154 	.machine	= EM_PPC64,
155 	.compat_3_brand	= "FreeBSD",
156 	.emul_path	= NULL,
157 	.interp_path	= "/libexec/ld-elf.so.1",
158 	.sysvec		= &elf64_freebsd_sysvec_v2,
159 	.interp_newpath	= NULL,
160 	.brand_note	= &elf64_freebsd_brandnote,
161 	.flags		= BI_CAN_EXEC_DYN | BI_BRAND_NOTE,
162 	.header_supported = &ppc64_elfv2_header_match
163 };
164 
165 SYSINIT(elf64v2, SI_SUB_EXEC, SI_ORDER_ANY,
166     (sysinit_cfunc_t) elf64_insert_brand_entry,
167     &freebsd_brand_info_elfv2);
168 
169 static Elf64_Brandinfo freebsd_brand_oinfo = {
170 	.brand		= ELFOSABI_FREEBSD,
171 	.machine	= EM_PPC64,
172 	.compat_3_brand	= "FreeBSD",
173 	.emul_path	= NULL,
174 	.interp_path	= "/usr/libexec/ld-elf.so.1",
175 	.sysvec		= &elf64_freebsd_sysvec_v1,
176 	.interp_newpath	= NULL,
177 	.brand_note	= &elf64_freebsd_brandnote,
178 	.flags		= BI_CAN_EXEC_DYN | BI_BRAND_NOTE,
179 	.header_supported = &ppc64_elfv1_header_match
180 };
181 
182 SYSINIT(oelf64, SI_SUB_EXEC, SI_ORDER_ANY,
183 	(sysinit_cfunc_t) elf64_insert_brand_entry,
184 	&freebsd_brand_oinfo);
185 
186 void elf_reloc_self(Elf_Dyn *dynp, Elf_Addr relocbase);
187 
188 static boolean_t
189 ppc64_elfv1_header_match(struct image_params *params)
190 {
191 	const Elf64_Ehdr *hdr = (const Elf64_Ehdr *)params->image_header;
192 	int abi = (hdr->e_flags & 3);
193 
194 	return (abi == 0 || abi == 1);
195 }
196 
197 static boolean_t
198 ppc64_elfv2_header_match(struct image_params *params)
199 {
200 	const Elf64_Ehdr *hdr = (const Elf64_Ehdr *)params->image_header;
201 	int abi = (hdr->e_flags & 3);
202 
203 	return (abi == 2);
204 }
205 
206 static void
207 exec_setregs_funcdesc(struct thread *td, struct image_params *imgp,
208     u_long stack)
209 {
210 	struct trapframe *tf;
211 	register_t entry_desc[3];
212 
213 	tf = trapframe(td);
214 	exec_setregs(td, imgp, stack);
215 
216 	/*
217 	 * For 64-bit ELFv1, we need to disentangle the function
218 	 * descriptor
219 	 *
220 	 * 0. entry point
221 	 * 1. TOC value (r2)
222 	 * 2. Environment pointer (r11)
223 	 */
224 
225 	(void)copyin((void *)imgp->entry_addr, entry_desc,
226 	    sizeof(entry_desc));
227 	tf->srr0 = entry_desc[0] + imgp->reloc_base;
228 	tf->fixreg[2] = entry_desc[1] + imgp->reloc_base;
229 	tf->fixreg[11] = entry_desc[2] + imgp->reloc_base;
230 }
231 
232 void
233 elf64_dump_thread(struct thread *td, void *dst, size_t *off)
234 {
235 	size_t len;
236 	struct pcb *pcb;
237 	uint64_t vshr[32];
238 	uint64_t *vsr_dw1;
239 	int vsr_idx;
240 
241 	len = 0;
242 	pcb = td->td_pcb;
243 
244 	if (pcb->pcb_flags & PCB_VEC) {
245 		save_vec_nodrop(td);
246 		if (dst != NULL) {
247 			len += elf64_populate_note(NT_PPC_VMX,
248 			    &pcb->pcb_vec, (char *)dst + len,
249 			    sizeof(pcb->pcb_vec), NULL);
250 		} else
251 			len += elf64_populate_note(NT_PPC_VMX, NULL, NULL,
252 			    sizeof(pcb->pcb_vec), NULL);
253 	}
254 
255 	if (pcb->pcb_flags & PCB_VSX) {
256 		save_fpu_nodrop(td);
257 		if (dst != NULL) {
258 			/*
259 			 * Doubleword 0 of VSR0-VSR31 overlap with FPR0-FPR31 and
260 			 * VSR32-VSR63 overlap with VR0-VR31, so we only copy
261 			 * the non-overlapping data, which is doubleword 1 of VSR0-VSR31.
262 			 */
263 			for (vsr_idx = 0; vsr_idx < nitems(vshr); vsr_idx++) {
264 				vsr_dw1 = (uint64_t *)&pcb->pcb_fpu.fpr[vsr_idx].vsr[2];
265 				vshr[vsr_idx] = *vsr_dw1;
266 			}
267 			len += elf64_populate_note(NT_PPC_VSX,
268 			    vshr, (char *)dst + len,
269 			    sizeof(vshr), NULL);
270 		} else
271 			len += elf64_populate_note(NT_PPC_VSX, NULL, NULL,
272 			    sizeof(vshr), NULL);
273 	}
274 
275 	*off = len;
276 }
277 
278 bool
279 elf_is_ifunc_reloc(Elf_Size r_info __unused)
280 {
281 
282 	return (false);
283 }
284 
285 /* Process one elf relocation with addend. */
286 static int
287 elf_reloc_internal(linker_file_t lf, Elf_Addr relocbase, const void *data,
288     int type, int local, elf_lookup_fn lookup)
289 {
290 	Elf_Addr *where;
291 	Elf_Addr addr;
292 	Elf_Addr addend;
293 	Elf_Word rtype, symidx;
294 	const Elf_Rela *rela;
295 	int error;
296 
297 	switch (type) {
298 	case ELF_RELOC_REL:
299 		panic("PPC only supports RELA relocations");
300 		break;
301 	case ELF_RELOC_RELA:
302 		rela = (const Elf_Rela *)data;
303 		where = (Elf_Addr *) (relocbase + rela->r_offset);
304 		addend = rela->r_addend;
305 		rtype = ELF_R_TYPE(rela->r_info);
306 		symidx = ELF_R_SYM(rela->r_info);
307 		break;
308 	default:
309 		panic("elf_reloc: unknown relocation mode %d\n", type);
310 	}
311 
312 	switch (rtype) {
313 
314 	case R_PPC_NONE:
315 		break;
316 
317 	case R_PPC64_ADDR64:	/* doubleword64 S + A */
318 		error = lookup(lf, symidx, 1, &addr);
319 		if (error != 0)
320 			return -1;
321 		addr += addend;
322 		*where = addr;
323 		break;
324 
325 	case R_PPC_RELATIVE:	/* doubleword64 B + A */
326 		*where = elf_relocaddr(lf, relocbase + addend);
327 		break;
328 
329 	case R_PPC_JMP_SLOT:	/* function descriptor copy */
330 		lookup(lf, symidx, 1, &addr);
331 #if !defined(_CALL_ELF) || _CALL_ELF == 1
332 		memcpy(where, (Elf_Addr *)addr, 3*sizeof(Elf_Addr));
333 #else
334 		*where = addr;
335 #endif
336 		__asm __volatile("dcbst 0,%0; sync" :: "r"(where) : "memory");
337 		break;
338 
339 	default:
340 		printf("kldload: unexpected relocation type %d\n",
341 		    (int) rtype);
342 		return -1;
343 	}
344 	return(0);
345 }
346 
347 void
348 elf_reloc_self(Elf_Dyn *dynp, Elf_Addr relocbase)
349 {
350 	Elf_Rela *rela = NULL, *relalim;
351 	Elf_Addr relasz = 0;
352 	Elf_Addr *where;
353 
354 	/*
355 	 * Extract the rela/relasz values from the dynamic section
356 	 */
357 	for (; dynp->d_tag != DT_NULL; dynp++) {
358 		switch (dynp->d_tag) {
359 		case DT_RELA:
360 			rela = (Elf_Rela *)(relocbase+dynp->d_un.d_ptr);
361 			break;
362 		case DT_RELASZ:
363 			relasz = dynp->d_un.d_val;
364 			break;
365 		}
366 	}
367 
368 	/*
369 	 * Relocate these values
370 	 */
371 	relalim = (Elf_Rela *)((caddr_t)rela + relasz);
372 	for (; rela < relalim; rela++) {
373 		if (ELF_R_TYPE(rela->r_info) != R_PPC_RELATIVE)
374 			continue;
375 		where = (Elf_Addr *)(relocbase + rela->r_offset);
376 		*where = (Elf_Addr)(relocbase + rela->r_addend);
377 	}
378 }
379 
380 int
381 elf_reloc(linker_file_t lf, Elf_Addr relocbase, const void *data, int type,
382     elf_lookup_fn lookup)
383 {
384 
385 	return (elf_reloc_internal(lf, relocbase, data, type, 0, lookup));
386 }
387 
388 int
389 elf_reloc_local(linker_file_t lf, Elf_Addr relocbase, const void *data,
390     int type, elf_lookup_fn lookup)
391 {
392 
393 	return (elf_reloc_internal(lf, relocbase, data, type, 1, lookup));
394 }
395 
396 int
397 elf_cpu_load_file(linker_file_t lf)
398 {
399 	/* Only sync the cache for non-kernel modules */
400 	if (lf->id != 1)
401 		__syncicache(lf->address, lf->size);
402 	return (0);
403 }
404 
405 int
406 elf_cpu_unload_file(linker_file_t lf __unused)
407 {
408 
409 	return (0);
410 }
411