1 /* Kernel module help for PPC64.
2 Copyright (C) 2001, 2003 Rusty Russell IBM Corporation.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 #include <linux/module.h>
19 #include <linux/elf.h>
20 #include <linux/moduleloader.h>
21 #include <linux/err.h>
22 #include <linux/vmalloc.h>
23 #include <linux/bug.h>
24 #include <linux/uaccess.h>
25 #include <asm/module.h>
26 #include <asm/sections.h>
27 #include <asm/firmware.h>
28 #include <asm/code-patching.h>
29 #include <linux/sort.h>
33 /* FIXME: We don't do .init separately. To do this, we'd need to have
34 a separate r2 value in the init and core section, and stub between
37 Using a magic allocator which places modules within 32MB solves
38 this, and makes other things simpler. Anton?
43 #define DEBUGP(fmt , ...)
46 /* There's actually a third entry here, but it's unused */
47 struct ppc64_opd_entry
49 unsigned long funcaddr;
53 /* Like PPC32, we need little trampolines to do > 24-bit jumps (into
54 the kernel itself). But on PPC64, these need to be used for every
55 jump, actually, to reset r2 (TOC+0x8000). */
56 struct ppc64_stub_entry
58 /* 28 byte jump instruction sequence (7 instructions) */
59 unsigned char jump[28];
60 unsigned char unused[4];
61 /* Data for the above code */
62 struct ppc64_opd_entry opd;
65 /* We use a stub to fix up r2 (TOC ptr) and to jump to the (external)
66 function which may be more than 24-bits away. We could simply
67 patch the new r2 value and function pointer into the stub, but it's
68 significantly shorter to put these values at the end of the stub
69 code, and patch the stub address (32-bits relative to the TOC ptr,
71 static struct ppc64_stub_entry ppc64_stub =
73 0x3d, 0x82, 0x00, 0x00, /* addis r12,r2, <high> */
74 0x39, 0x8c, 0x00, 0x00, /* addi r12,r12, <low> */
75 /* Save current r2 value in magic place on the stack. */
76 0xf8, 0x41, 0x00, 0x28, /* std r2,40(r1) */
77 0xe9, 0x6c, 0x00, 0x20, /* ld r11,32(r12) */
78 0xe8, 0x4c, 0x00, 0x28, /* ld r2,40(r12) */
79 0x7d, 0x69, 0x03, 0xa6, /* mtctr r11 */
80 0x4e, 0x80, 0x04, 0x20 /* bctr */
83 /* Count how many different 24-bit relocations (different symbol,
85 static unsigned int count_relocs(const Elf64_Rela *rela, unsigned int num)
87 unsigned int i, r_info, r_addend, _count_relocs;
89 /* FIXME: Only count external ones --RR */
93 for (i = 0; i < num; i++)
94 /* Only count 24-bit relocs, others don't need stubs */
95 if (ELF64_R_TYPE(rela[i].r_info) == R_PPC_REL24 &&
96 (r_info != ELF64_R_SYM(rela[i].r_info) ||
97 r_addend != rela[i].r_addend)) {
99 r_info = ELF64_R_SYM(rela[i].r_info);
100 r_addend = rela[i].r_addend;
103 return _count_relocs;
106 static int relacmp(const void *_x, const void *_y)
108 const Elf64_Rela *x, *y;
110 y = (Elf64_Rela *)_x;
111 x = (Elf64_Rela *)_y;
113 /* Compare the entire r_info (as opposed to ELF64_R_SYM(r_info) only) to
114 * make the comparison cheaper/faster. It won't affect the sorting or
115 * the counting algorithms' performance
117 if (x->r_info < y->r_info)
119 else if (x->r_info > y->r_info)
121 else if (x->r_addend < y->r_addend)
123 else if (x->r_addend > y->r_addend)
129 static void relaswap(void *_x, void *_y, int size)
131 uint64_t *x, *y, tmp;
137 for (i = 0; i < sizeof(Elf64_Rela) / sizeof(uint64_t); i++) {
144 /* Get size of potential trampolines required. */
145 static unsigned long get_stubs_size(const Elf64_Ehdr *hdr,
146 const Elf64_Shdr *sechdrs)
148 /* One extra reloc so it's always 0-funcaddr terminated */
149 unsigned long relocs = 1;
152 /* Every relocated section... */
153 for (i = 1; i < hdr->e_shnum; i++) {
154 if (sechdrs[i].sh_type == SHT_RELA) {
155 DEBUGP("Found relocations in section %u\n", i);
156 DEBUGP("Ptr: %p. Number: %lu\n",
157 (void *)sechdrs[i].sh_addr,
158 sechdrs[i].sh_size / sizeof(Elf64_Rela));
160 /* Sort the relocation information based on a symbol and
161 * addend key. This is a stable O(n*log n) complexity
162 * alogrithm but it will reduce the complexity of
163 * count_relocs() to linear complexity O(n)
165 sort((void *)sechdrs[i].sh_addr,
166 sechdrs[i].sh_size / sizeof(Elf64_Rela),
167 sizeof(Elf64_Rela), relacmp, relaswap);
169 relocs += count_relocs((void *)sechdrs[i].sh_addr,
171 / sizeof(Elf64_Rela));
175 DEBUGP("Looks like a total of %lu stubs, max\n", relocs);
176 return relocs * sizeof(struct ppc64_stub_entry);
179 static void dedotify_versions(struct modversion_info *vers,
182 struct modversion_info *end;
184 for (end = (void *)vers + size; vers < end; vers++)
185 if (vers->name[0] == '.')
186 memmove(vers->name, vers->name+1, strlen(vers->name));
189 /* Undefined symbols which refer to .funcname, hack to funcname */
190 static void dedotify(Elf64_Sym *syms, unsigned int numsyms, char *strtab)
194 for (i = 1; i < numsyms; i++) {
195 if (syms[i].st_shndx == SHN_UNDEF) {
196 char *name = strtab + syms[i].st_name;
198 memmove(name, name+1, strlen(name));
203 int module_frob_arch_sections(Elf64_Ehdr *hdr,
210 /* Find .toc and .stubs sections, symtab and strtab */
211 for (i = 1; i < hdr->e_shnum; i++) {
213 if (strcmp(secstrings + sechdrs[i].sh_name, ".stubs") == 0)
214 me->arch.stubs_section = i;
215 else if (strcmp(secstrings + sechdrs[i].sh_name, ".toc") == 0)
216 me->arch.toc_section = i;
217 else if (strcmp(secstrings+sechdrs[i].sh_name,"__versions")==0)
218 dedotify_versions((void *)hdr + sechdrs[i].sh_offset,
221 /* We don't handle .init for the moment: rename to _init */
222 while ((p = strstr(secstrings + sechdrs[i].sh_name, ".init")))
225 if (sechdrs[i].sh_type == SHT_SYMTAB)
226 dedotify((void *)hdr + sechdrs[i].sh_offset,
227 sechdrs[i].sh_size / sizeof(Elf64_Sym),
229 + sechdrs[sechdrs[i].sh_link].sh_offset);
232 if (!me->arch.stubs_section) {
233 printk("%s: doesn't contain .stubs.\n", me->name);
237 /* If we don't have a .toc, just use .stubs. We need to set r2
238 to some reasonable value in case the module calls out to
239 other functions via a stub, or if a function pointer escapes
240 the module by some means. */
241 if (!me->arch.toc_section)
242 me->arch.toc_section = me->arch.stubs_section;
244 /* Override the stubs size */
245 sechdrs[me->arch.stubs_section].sh_size = get_stubs_size(hdr, sechdrs);
249 int apply_relocate(Elf64_Shdr *sechdrs,
251 unsigned int symindex,
255 printk(KERN_ERR "%s: Non-ADD RELOCATION unsupported\n", me->name);
259 /* r2 is the TOC pointer: it actually points 0x8000 into the TOC (this
260 gives the value maximum span in an instruction which uses a signed
262 static inline unsigned long my_r2(Elf64_Shdr *sechdrs, struct module *me)
264 return sechdrs[me->arch.toc_section].sh_addr + 0x8000;
267 /* Both low and high 16 bits are added as SIGNED additions, so if low
268 16 bits has high bit set, high 16 bits must be adjusted. These
269 macros do that (stolen from binutils). */
270 #define PPC_LO(v) ((v) & 0xffff)
271 #define PPC_HI(v) (((v) >> 16) & 0xffff)
272 #define PPC_HA(v) PPC_HI ((v) + 0x8000)
274 /* Patch stub to reference function and correct r2 value. */
275 static inline int create_stub(Elf64_Shdr *sechdrs,
276 struct ppc64_stub_entry *entry,
277 struct ppc64_opd_entry *opd,
280 Elf64_Half *loc1, *loc2;
285 loc1 = (Elf64_Half *)&entry->jump[2];
286 loc2 = (Elf64_Half *)&entry->jump[6];
288 /* Stub uses address relative to r2. */
289 reladdr = (unsigned long)entry - my_r2(sechdrs, me);
290 if (reladdr > 0x7FFFFFFF || reladdr < -(0x80000000L)) {
291 printk("%s: Address %p of stub out of range of %p.\n",
292 me->name, (void *)reladdr, (void *)my_r2);
295 DEBUGP("Stub %p get data from reladdr %li\n", entry, reladdr);
297 *loc1 = PPC_HA(reladdr);
298 *loc2 = PPC_LO(reladdr);
299 entry->opd.funcaddr = opd->funcaddr;
300 entry->opd.r2 = opd->r2;
304 /* Create stub to jump to function described in this OPD: we need the
305 stub to set up the TOC ptr (r2) for the function. */
306 static unsigned long stub_for_addr(Elf64_Shdr *sechdrs,
307 unsigned long opdaddr,
310 struct ppc64_stub_entry *stubs;
311 struct ppc64_opd_entry *opd = (void *)opdaddr;
312 unsigned int i, num_stubs;
314 num_stubs = sechdrs[me->arch.stubs_section].sh_size / sizeof(*stubs);
316 /* Find this stub, or if that fails, the next avail. entry */
317 stubs = (void *)sechdrs[me->arch.stubs_section].sh_addr;
318 for (i = 0; stubs[i].opd.funcaddr; i++) {
319 BUG_ON(i >= num_stubs);
321 if (stubs[i].opd.funcaddr == opd->funcaddr)
322 return (unsigned long)&stubs[i];
325 if (!create_stub(sechdrs, &stubs[i], opd, me))
328 return (unsigned long)&stubs[i];
331 /* We expect a noop next: if it is, replace it with instruction to
333 static int restore_r2(u32 *instruction, struct module *me)
335 if (*instruction != PPC_NOP_INSTR) {
336 printk("%s: Expect noop after relocate, got %08x\n",
337 me->name, *instruction);
340 *instruction = 0xe8410028; /* ld r2,40(r1) */
344 int apply_relocate_add(Elf64_Shdr *sechdrs,
346 unsigned int symindex,
351 Elf64_Rela *rela = (void *)sechdrs[relsec].sh_addr;
353 unsigned long *location;
356 DEBUGP("Applying ADD relocate section %u to %u\n", relsec,
357 sechdrs[relsec].sh_info);
358 for (i = 0; i < sechdrs[relsec].sh_size / sizeof(*rela); i++) {
359 /* This is where to make the change */
360 location = (void *)sechdrs[sechdrs[relsec].sh_info].sh_addr
362 /* This is the symbol it is referring to */
363 sym = (Elf64_Sym *)sechdrs[symindex].sh_addr
364 + ELF64_R_SYM(rela[i].r_info);
366 DEBUGP("RELOC at %p: %li-type as %s (%lu) + %li\n",
367 location, (long)ELF64_R_TYPE(rela[i].r_info),
368 strtab + sym->st_name, (unsigned long)sym->st_value,
369 (long)rela[i].r_addend);
371 /* `Everything is relative'. */
372 value = sym->st_value + rela[i].r_addend;
374 switch (ELF64_R_TYPE(rela[i].r_info)) {
377 *(u32 *)location = value;
382 *(unsigned long *)location = value;
386 *(unsigned long *)location = my_r2(sechdrs, me);
390 /* Subtract TOC pointer */
391 value -= my_r2(sechdrs, me);
392 if (value + 0x8000 > 0xffff) {
393 printk("%s: bad TOC16 relocation (%lu)\n",
397 *((uint16_t *) location)
398 = (*((uint16_t *) location) & ~0xffff)
402 case R_PPC64_TOC16_DS:
403 /* Subtract TOC pointer */
404 value -= my_r2(sechdrs, me);
405 if ((value & 3) != 0 || value + 0x8000 > 0xffff) {
406 printk("%s: bad TOC16_DS relocation (%lu)\n",
410 *((uint16_t *) location)
411 = (*((uint16_t *) location) & ~0xfffc)
416 /* FIXME: Handle weak symbols here --RR */
417 if (sym->st_shndx == SHN_UNDEF) {
418 /* External: go via stub */
419 value = stub_for_addr(sechdrs, value, me);
422 if (!restore_r2((u32 *)location + 1, me))
426 /* Convert value to relative */
427 value -= (unsigned long)location;
428 if (value + 0x2000000 > 0x3ffffff || (value & 3) != 0){
429 printk("%s: REL24 %li out of range!\n",
430 me->name, (long int)value);
434 /* Only replace bits 2 through 26 */
435 *(uint32_t *)location
436 = (*(uint32_t *)location & ~0x03fffffc)
437 | (value & 0x03fffffc);
441 /* 64 bits relative (used by features fixups) */
442 *location = value - (unsigned long)location;
446 printk("%s: Unknown ADD relocation: %lu\n",
448 (unsigned long)ELF64_R_TYPE(rela[i].r_info));
456 void *dereference_function_descriptor(void *ptr)
458 struct ppc64_opd_entry *desc = ptr;
461 if (!probe_kernel_address(&desc->funcaddr, p))