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
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 #include <linux/module.h>
22 #include <linux/elf.h>
23 #include <linux/moduleloader.h>
24 #include <linux/err.h>
25 #include <linux/vmalloc.h>
26 #include <linux/ftrace.h>
27 #include <linux/bug.h>
28 #include <linux/uaccess.h>
29 #include <asm/module.h>
30 #include <asm/firmware.h>
31 #include <asm/code-patching.h>
32 #include <linux/sort.h>
33 #include <asm/setup.h>
34 #include <asm/sections.h>
36 /* FIXME: We don't do .init separately. To do this, we'd need to have
37 a separate r2 value in the init and core section, and stub between
40 Using a magic allocator which places modules within 32MB solves
41 this, and makes other things simpler. Anton?
44 #ifdef PPC64_ELF_ABI_v2
46 /* An address is simply the address of the function. */
47 typedef unsigned long func_desc_t;
49 static func_desc_t func_desc(unsigned long addr)
53 static unsigned long func_addr(unsigned long addr)
57 static unsigned long stub_func_addr(func_desc_t func)
62 /* PowerPC64 specific values for the Elf64_Sym st_other field. */
63 #define STO_PPC64_LOCAL_BIT 5
64 #define STO_PPC64_LOCAL_MASK (7 << STO_PPC64_LOCAL_BIT)
65 #define PPC64_LOCAL_ENTRY_OFFSET(other) \
66 (((1 << (((other) & STO_PPC64_LOCAL_MASK) >> STO_PPC64_LOCAL_BIT)) >> 2) << 2)
68 static unsigned int local_entry_offset(const Elf64_Sym *sym)
70 /* sym->st_other indicates offset to local entry point
71 * (otherwise it will assume r12 is the address of the start
72 * of function and try to derive r2 from it). */
73 return PPC64_LOCAL_ENTRY_OFFSET(sym->st_other);
77 /* An address is address of the OPD entry, which contains address of fn. */
78 typedef struct ppc64_opd_entry func_desc_t;
80 static func_desc_t func_desc(unsigned long addr)
82 return *(struct ppc64_opd_entry *)addr;
84 static unsigned long func_addr(unsigned long addr)
86 return func_desc(addr).funcaddr;
88 static unsigned long stub_func_addr(func_desc_t func)
92 static unsigned int local_entry_offset(const Elf64_Sym *sym)
98 #define STUB_MAGIC 0x73747562 /* stub */
100 /* Like PPC32, we need little trampolines to do > 24-bit jumps (into
101 the kernel itself). But on PPC64, these need to be used for every
102 jump, actually, to reset r2 (TOC+0x8000). */
103 struct ppc64_stub_entry
105 /* 28 byte jump instruction sequence (7 instructions). We only
106 * need 6 instructions on ABIv2 but we always allocate 7 so
107 * so we don't have to modify the trampoline load instruction. */
109 /* Used by ftrace to identify stubs */
111 /* Data for the above code */
112 func_desc_t funcdata;
116 * PPC64 uses 24 bit jumps, but we need to jump into other modules or
117 * the kernel which may be further. So we jump to a stub.
119 * For ELFv1 we need to use this to set up the new r2 value (aka TOC
120 * pointer). For ELFv2 it's the callee's responsibility to set up the
121 * new r2, but for both we need to save the old r2.
123 * We could simply patch the new r2 value and function pointer into
124 * the stub, but it's significantly shorter to put these values at the
125 * end of the stub code, and patch the stub address (32-bits relative
126 * to the TOC ptr, r2) into the stub.
129 static u32 ppc64_stub_insns[] = {
130 0x3d620000, /* addis r11,r2, <high> */
131 0x396b0000, /* addi r11,r11, <low> */
132 /* Save current r2 value in magic place on the stack. */
133 0xf8410000|R2_STACK_OFFSET, /* std r2,R2_STACK_OFFSET(r1) */
134 0xe98b0020, /* ld r12,32(r11) */
135 #ifdef PPC64_ELF_ABI_v1
136 /* Set up new r2 from function descriptor */
137 0xe84b0028, /* ld r2,40(r11) */
139 0x7d8903a6, /* mtctr r12 */
140 0x4e800420 /* bctr */
143 #ifdef CONFIG_DYNAMIC_FTRACE
144 int module_trampoline_target(struct module *mod, unsigned long addr,
145 unsigned long *target)
147 struct ppc64_stub_entry *stub;
148 func_desc_t funcdata;
151 if (!within_module_core(addr, mod)) {
152 pr_err("%s: stub %lx not in module %s\n", __func__, addr, mod->name);
156 stub = (struct ppc64_stub_entry *)addr;
158 if (probe_kernel_read(&magic, &stub->magic, sizeof(magic))) {
159 pr_err("%s: fault reading magic for stub %lx for %s\n", __func__, addr, mod->name);
163 if (magic != STUB_MAGIC) {
164 pr_err("%s: bad magic for stub %lx for %s\n", __func__, addr, mod->name);
168 if (probe_kernel_read(&funcdata, &stub->funcdata, sizeof(funcdata))) {
169 pr_err("%s: fault reading funcdata for stub %lx for %s\n", __func__, addr, mod->name);
173 *target = stub_func_addr(funcdata);
179 /* Count how many different 24-bit relocations (different symbol,
181 static unsigned int count_relocs(const Elf64_Rela *rela, unsigned int num)
183 unsigned int i, r_info, r_addend, _count_relocs;
185 /* FIXME: Only count external ones --RR */
189 for (i = 0; i < num; i++)
190 /* Only count 24-bit relocs, others don't need stubs */
191 if (ELF64_R_TYPE(rela[i].r_info) == R_PPC_REL24 &&
192 (r_info != ELF64_R_SYM(rela[i].r_info) ||
193 r_addend != rela[i].r_addend)) {
195 r_info = ELF64_R_SYM(rela[i].r_info);
196 r_addend = rela[i].r_addend;
199 return _count_relocs;
202 static int relacmp(const void *_x, const void *_y)
204 const Elf64_Rela *x, *y;
206 y = (Elf64_Rela *)_x;
207 x = (Elf64_Rela *)_y;
209 /* Compare the entire r_info (as opposed to ELF64_R_SYM(r_info) only) to
210 * make the comparison cheaper/faster. It won't affect the sorting or
211 * the counting algorithms' performance
213 if (x->r_info < y->r_info)
215 else if (x->r_info > y->r_info)
217 else if (x->r_addend < y->r_addend)
219 else if (x->r_addend > y->r_addend)
225 static void relaswap(void *_x, void *_y, int size)
227 uint64_t *x, *y, tmp;
233 for (i = 0; i < sizeof(Elf64_Rela) / sizeof(uint64_t); i++) {
240 /* Get size of potential trampolines required. */
241 static unsigned long get_stubs_size(const Elf64_Ehdr *hdr,
242 const Elf64_Shdr *sechdrs)
244 /* One extra reloc so it's always 0-funcaddr terminated */
245 unsigned long relocs = 1;
248 /* Every relocated section... */
249 for (i = 1; i < hdr->e_shnum; i++) {
250 if (sechdrs[i].sh_type == SHT_RELA) {
251 pr_debug("Found relocations in section %u\n", i);
252 pr_debug("Ptr: %p. Number: %Lu\n",
253 (void *)sechdrs[i].sh_addr,
254 sechdrs[i].sh_size / sizeof(Elf64_Rela));
256 /* Sort the relocation information based on a symbol and
257 * addend key. This is a stable O(n*log n) complexity
258 * alogrithm but it will reduce the complexity of
259 * count_relocs() to linear complexity O(n)
261 sort((void *)sechdrs[i].sh_addr,
262 sechdrs[i].sh_size / sizeof(Elf64_Rela),
263 sizeof(Elf64_Rela), relacmp, relaswap);
265 relocs += count_relocs((void *)sechdrs[i].sh_addr,
267 / sizeof(Elf64_Rela));
271 #ifdef CONFIG_DYNAMIC_FTRACE
272 /* make the trampoline to the ftrace_caller */
276 pr_debug("Looks like a total of %lu stubs, max\n", relocs);
277 return relocs * sizeof(struct ppc64_stub_entry);
280 /* Still needed for ELFv2, for .TOC. */
281 static void dedotify_versions(struct modversion_info *vers,
284 struct modversion_info *end;
286 for (end = (void *)vers + size; vers < end; vers++)
287 if (vers->name[0] == '.') {
288 memmove(vers->name, vers->name+1, strlen(vers->name));
289 #ifdef ARCH_RELOCATES_KCRCTAB
290 /* The TOC symbol has no CRC computed. To avoid CRC
291 * check failing, we must force it to the expected
292 * value (see CRC check in module.c).
294 if (!strcmp(vers->name, "TOC."))
295 vers->crc = -(unsigned long)reloc_start;
301 * Undefined symbols which refer to .funcname, hack to funcname. Make .TOC.
302 * seem to be defined (value set later).
304 static void dedotify(Elf64_Sym *syms, unsigned int numsyms, char *strtab)
308 for (i = 1; i < numsyms; i++) {
309 if (syms[i].st_shndx == SHN_UNDEF) {
310 char *name = strtab + syms[i].st_name;
311 if (name[0] == '.') {
312 if (strcmp(name+1, "TOC.") == 0)
313 syms[i].st_shndx = SHN_ABS;
320 static Elf64_Sym *find_dot_toc(Elf64_Shdr *sechdrs,
322 unsigned int symindex)
324 unsigned int i, numsyms;
327 syms = (Elf64_Sym *)sechdrs[symindex].sh_addr;
328 numsyms = sechdrs[symindex].sh_size / sizeof(Elf64_Sym);
330 for (i = 1; i < numsyms; i++) {
331 if (syms[i].st_shndx == SHN_ABS
332 && strcmp(strtab + syms[i].st_name, "TOC.") == 0)
338 int module_frob_arch_sections(Elf64_Ehdr *hdr,
345 /* Find .toc and .stubs sections, symtab and strtab */
346 for (i = 1; i < hdr->e_shnum; i++) {
348 if (strcmp(secstrings + sechdrs[i].sh_name, ".stubs") == 0)
349 me->arch.stubs_section = i;
350 else if (strcmp(secstrings + sechdrs[i].sh_name, ".toc") == 0)
351 me->arch.toc_section = i;
352 else if (strcmp(secstrings+sechdrs[i].sh_name,"__versions")==0)
353 dedotify_versions((void *)hdr + sechdrs[i].sh_offset,
356 /* We don't handle .init for the moment: rename to _init */
357 while ((p = strstr(secstrings + sechdrs[i].sh_name, ".init")))
360 if (sechdrs[i].sh_type == SHT_SYMTAB)
361 dedotify((void *)hdr + sechdrs[i].sh_offset,
362 sechdrs[i].sh_size / sizeof(Elf64_Sym),
364 + sechdrs[sechdrs[i].sh_link].sh_offset);
367 if (!me->arch.stubs_section) {
368 pr_err("%s: doesn't contain .stubs.\n", me->name);
372 /* If we don't have a .toc, just use .stubs. We need to set r2
373 to some reasonable value in case the module calls out to
374 other functions via a stub, or if a function pointer escapes
375 the module by some means. */
376 if (!me->arch.toc_section)
377 me->arch.toc_section = me->arch.stubs_section;
379 /* Override the stubs size */
380 sechdrs[me->arch.stubs_section].sh_size = get_stubs_size(hdr, sechdrs);
384 /* r2 is the TOC pointer: it actually points 0x8000 into the TOC (this
385 gives the value maximum span in an instruction which uses a signed
387 static inline unsigned long my_r2(const Elf64_Shdr *sechdrs, struct module *me)
389 return sechdrs[me->arch.toc_section].sh_addr + 0x8000;
392 /* Both low and high 16 bits are added as SIGNED additions, so if low
393 16 bits has high bit set, high 16 bits must be adjusted. These
394 macros do that (stolen from binutils). */
395 #define PPC_LO(v) ((v) & 0xffff)
396 #define PPC_HI(v) (((v) >> 16) & 0xffff)
397 #define PPC_HA(v) PPC_HI ((v) + 0x8000)
399 /* Patch stub to reference function and correct r2 value. */
400 static inline int create_stub(const Elf64_Shdr *sechdrs,
401 struct ppc64_stub_entry *entry,
407 memcpy(entry->jump, ppc64_stub_insns, sizeof(ppc64_stub_insns));
409 /* Stub uses address relative to r2. */
410 reladdr = (unsigned long)entry - my_r2(sechdrs, me);
411 if (reladdr > 0x7FFFFFFF || reladdr < -(0x80000000L)) {
412 pr_err("%s: Address %p of stub out of range of %p.\n",
413 me->name, (void *)reladdr, (void *)my_r2);
416 pr_debug("Stub %p get data from reladdr %li\n", entry, reladdr);
418 entry->jump[0] |= PPC_HA(reladdr);
419 entry->jump[1] |= PPC_LO(reladdr);
420 entry->funcdata = func_desc(addr);
421 entry->magic = STUB_MAGIC;
426 /* Create stub to jump to function described in this OPD/ptr: we need the
427 stub to set up the TOC ptr (r2) for the function. */
428 static unsigned long stub_for_addr(const Elf64_Shdr *sechdrs,
432 struct ppc64_stub_entry *stubs;
433 unsigned int i, num_stubs;
435 num_stubs = sechdrs[me->arch.stubs_section].sh_size / sizeof(*stubs);
437 /* Find this stub, or if that fails, the next avail. entry */
438 stubs = (void *)sechdrs[me->arch.stubs_section].sh_addr;
439 for (i = 0; stub_func_addr(stubs[i].funcdata); i++) {
440 BUG_ON(i >= num_stubs);
442 if (stub_func_addr(stubs[i].funcdata) == func_addr(addr))
443 return (unsigned long)&stubs[i];
446 if (!create_stub(sechdrs, &stubs[i], addr, me))
449 return (unsigned long)&stubs[i];
452 #ifdef CC_USING_MPROFILE_KERNEL
453 static bool is_early_mcount_callsite(u32 *instruction)
456 * Check if this is one of the -mprofile-kernel sequences.
458 if (instruction[-1] == PPC_INST_STD_LR &&
459 instruction[-2] == PPC_INST_MFLR)
462 if (instruction[-1] == PPC_INST_MFLR)
469 * In case of _mcount calls, do not save the current callee's TOC (in r2) into
470 * the original caller's stack frame. If we did we would clobber the saved TOC
471 * value of the original caller.
473 static void squash_toc_save_inst(const char *name, unsigned long addr)
475 struct ppc64_stub_entry *stub = (struct ppc64_stub_entry *)addr;
477 /* Only for calls to _mcount */
478 if (strcmp("_mcount", name) != 0)
481 stub->jump[2] = PPC_INST_NOP;
484 static void squash_toc_save_inst(const char *name, unsigned long addr) { }
486 /* without -mprofile-kernel, mcount calls are never early */
487 static bool is_early_mcount_callsite(u32 *instruction)
493 /* We expect a noop next: if it is, replace it with instruction to
495 static int restore_r2(u32 *instruction, struct module *me)
497 if (is_early_mcount_callsite(instruction - 1))
500 if (*instruction != PPC_INST_NOP) {
501 pr_err("%s: Expect noop after relocate, got %08x\n",
502 me->name, *instruction);
505 /* ld r2,R2_STACK_OFFSET(r1) */
506 *instruction = PPC_INST_LD_TOC;
510 int apply_relocate_add(Elf64_Shdr *sechdrs,
512 unsigned int symindex,
517 Elf64_Rela *rela = (void *)sechdrs[relsec].sh_addr;
519 unsigned long *location;
522 pr_debug("Applying ADD relocate section %u to %u\n", relsec,
523 sechdrs[relsec].sh_info);
525 /* First time we're called, we can fix up .TOC. */
526 if (!me->arch.toc_fixed) {
527 sym = find_dot_toc(sechdrs, strtab, symindex);
528 /* It's theoretically possible that a module doesn't want a
529 * .TOC. so don't fail it just for that. */
531 sym->st_value = my_r2(sechdrs, me);
532 me->arch.toc_fixed = true;
535 for (i = 0; i < sechdrs[relsec].sh_size / sizeof(*rela); i++) {
536 /* This is where to make the change */
537 location = (void *)sechdrs[sechdrs[relsec].sh_info].sh_addr
539 /* This is the symbol it is referring to */
540 sym = (Elf64_Sym *)sechdrs[symindex].sh_addr
541 + ELF64_R_SYM(rela[i].r_info);
543 pr_debug("RELOC at %p: %li-type as %s (0x%lx) + %li\n",
544 location, (long)ELF64_R_TYPE(rela[i].r_info),
545 strtab + sym->st_name, (unsigned long)sym->st_value,
546 (long)rela[i].r_addend);
548 /* `Everything is relative'. */
549 value = sym->st_value + rela[i].r_addend;
551 switch (ELF64_R_TYPE(rela[i].r_info)) {
554 *(u32 *)location = value;
559 *(unsigned long *)location = value;
563 *(unsigned long *)location = my_r2(sechdrs, me);
567 /* Subtract TOC pointer */
568 value -= my_r2(sechdrs, me);
569 if (value + 0x8000 > 0xffff) {
570 pr_err("%s: bad TOC16 relocation (0x%lx)\n",
574 *((uint16_t *) location)
575 = (*((uint16_t *) location) & ~0xffff)
579 case R_PPC64_TOC16_LO:
580 /* Subtract TOC pointer */
581 value -= my_r2(sechdrs, me);
582 *((uint16_t *) location)
583 = (*((uint16_t *) location) & ~0xffff)
587 case R_PPC64_TOC16_DS:
588 /* Subtract TOC pointer */
589 value -= my_r2(sechdrs, me);
590 if ((value & 3) != 0 || value + 0x8000 > 0xffff) {
591 pr_err("%s: bad TOC16_DS relocation (0x%lx)\n",
595 *((uint16_t *) location)
596 = (*((uint16_t *) location) & ~0xfffc)
600 case R_PPC64_TOC16_LO_DS:
601 /* Subtract TOC pointer */
602 value -= my_r2(sechdrs, me);
603 if ((value & 3) != 0) {
604 pr_err("%s: bad TOC16_LO_DS relocation (0x%lx)\n",
608 *((uint16_t *) location)
609 = (*((uint16_t *) location) & ~0xfffc)
613 case R_PPC64_TOC16_HA:
614 /* Subtract TOC pointer */
615 value -= my_r2(sechdrs, me);
616 value = ((value + 0x8000) >> 16);
617 *((uint16_t *) location)
618 = (*((uint16_t *) location) & ~0xffff)
623 /* FIXME: Handle weak symbols here --RR */
624 if (sym->st_shndx == SHN_UNDEF) {
625 /* External: go via stub */
626 value = stub_for_addr(sechdrs, value, me);
629 if (!restore_r2((u32 *)location + 1, me))
632 squash_toc_save_inst(strtab + sym->st_name, value);
634 value += local_entry_offset(sym);
636 /* Convert value to relative */
637 value -= (unsigned long)location;
638 if (value + 0x2000000 > 0x3ffffff || (value & 3) != 0){
639 pr_err("%s: REL24 %li out of range!\n",
640 me->name, (long int)value);
644 /* Only replace bits 2 through 26 */
645 *(uint32_t *)location
646 = (*(uint32_t *)location & ~0x03fffffc)
647 | (value & 0x03fffffc);
651 /* 64 bits relative (used by features fixups) */
652 *location = value - (unsigned long)location;
656 /* 32 bits relative (used by relative exception tables) */
657 *(u32 *)location = value - (unsigned long)location;
660 case R_PPC64_TOCSAVE:
662 * Marker reloc indicates we don't have to save r2.
663 * That would only save us one instruction, so ignore
670 * Optimize ELFv2 large code model entry point if
671 * the TOC is within 2GB range of current location.
673 value = my_r2(sechdrs, me) - (unsigned long)location;
674 if (value + 0x80008000 > 0xffffffff)
677 * Check for the large code model prolog sequence:
681 if ((((uint32_t *)location)[0] & ~0xfffc)
684 if (((uint32_t *)location)[1] != 0x7c426214)
687 * If found, replace it with:
688 * addis r2, r12, (.TOC.-func)@ha
689 * addi r2, r12, (.TOC.-func)@l
691 ((uint32_t *)location)[0] = 0x3c4c0000 + PPC_HA(value);
692 ((uint32_t *)location)[1] = 0x38420000 + PPC_LO(value);
695 case R_PPC64_REL16_HA:
696 /* Subtract location pointer */
697 value -= (unsigned long)location;
698 value = ((value + 0x8000) >> 16);
699 *((uint16_t *) location)
700 = (*((uint16_t *) location) & ~0xffff)
704 case R_PPC64_REL16_LO:
705 /* Subtract location pointer */
706 value -= (unsigned long)location;
707 *((uint16_t *) location)
708 = (*((uint16_t *) location) & ~0xffff)
713 pr_err("%s: Unknown ADD relocation: %lu\n",
715 (unsigned long)ELF64_R_TYPE(rela[i].r_info));
723 #ifdef CONFIG_DYNAMIC_FTRACE
725 #ifdef CC_USING_MPROFILE_KERNEL
727 #define PACATOC offsetof(struct paca_struct, kernel_toc)
730 * For mprofile-kernel we use a special stub for ftrace_caller() because we
731 * can't rely on r2 containing this module's TOC when we enter the stub.
733 * That can happen if the function calling us didn't need to use the toc. In
734 * that case it won't have setup r2, and the r2 value will be either the
735 * kernel's toc, or possibly another modules toc.
737 * To deal with that this stub uses the kernel toc, which is always accessible
738 * via the paca (in r13). The target (ftrace_caller()) is responsible for
739 * saving and restoring the toc before returning.
741 static unsigned long create_ftrace_stub(const Elf64_Shdr *sechdrs, struct module *me)
743 struct ppc64_stub_entry *entry;
744 unsigned int i, num_stubs;
745 static u32 stub_insns[] = {
746 0xe98d0000 | PACATOC, /* ld r12,PACATOC(r13) */
747 0x3d8c0000, /* addis r12,r12,<high> */
748 0x398c0000, /* addi r12,r12,<low> */
749 0x7d8903a6, /* mtctr r12 */
750 0x4e800420, /* bctr */
754 num_stubs = sechdrs[me->arch.stubs_section].sh_size / sizeof(*entry);
756 /* Find the next available stub entry */
757 entry = (void *)sechdrs[me->arch.stubs_section].sh_addr;
758 for (i = 0; i < num_stubs && stub_func_addr(entry->funcdata); i++, entry++);
760 if (i >= num_stubs) {
761 pr_err("%s: Unable to find a free slot for ftrace stub.\n", me->name);
765 memcpy(entry->jump, stub_insns, sizeof(stub_insns));
767 /* Stub uses address relative to kernel toc (from the paca) */
768 reladdr = (unsigned long)ftrace_caller - kernel_toc_addr();
769 if (reladdr > 0x7FFFFFFF || reladdr < -(0x80000000L)) {
770 pr_err("%s: Address of ftrace_caller out of range of kernel_toc.\n", me->name);
774 entry->jump[1] |= PPC_HA(reladdr);
775 entry->jump[2] |= PPC_LO(reladdr);
777 /* Eventhough we don't use funcdata in the stub, it's needed elsewhere. */
778 entry->funcdata = func_desc((unsigned long)ftrace_caller);
779 entry->magic = STUB_MAGIC;
781 return (unsigned long)entry;
784 static unsigned long create_ftrace_stub(const Elf64_Shdr *sechdrs, struct module *me)
786 return stub_for_addr(sechdrs, (unsigned long)ftrace_caller, me);
790 int module_finalize_ftrace(struct module *mod, const Elf_Shdr *sechdrs)
792 mod->arch.toc = my_r2(sechdrs, mod);
793 mod->arch.tramp = create_ftrace_stub(sechdrs, mod);
795 if (!mod->arch.tramp)