treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / arch / mips / kernel / relocate.c
blob3d80a51256de6ad9d3915dad4d5c3cfbc79c5467
1 /*
2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
4 * for more details.
6 * Support for Kernel relocation at boot time
8 * Copyright (C) 2015, Imagination Technologies Ltd.
9 * Authors: Matt Redfearn (matt.redfearn@mips.com)
11 #include <asm/bootinfo.h>
12 #include <asm/cacheflush.h>
13 #include <asm/fw/fw.h>
14 #include <asm/sections.h>
15 #include <asm/setup.h>
16 #include <asm/timex.h>
17 #include <linux/elf.h>
18 #include <linux/kernel.h>
19 #include <linux/libfdt.h>
20 #include <linux/of_fdt.h>
21 #include <linux/sched/task.h>
22 #include <linux/start_kernel.h>
23 #include <linux/string.h>
24 #include <linux/printk.h>
26 #define RELOCATED(x) ((void *)((long)x + offset))
28 extern u32 _relocation_start[]; /* End kernel image / start relocation table */
29 extern u32 _relocation_end[]; /* End relocation table */
31 extern long __start___ex_table; /* Start exception table */
32 extern long __stop___ex_table; /* End exception table */
34 extern void __weak plat_fdt_relocated(void *new_location);
37 * This function may be defined for a platform to perform any post-relocation
38 * fixup necessary.
39 * Return non-zero to abort relocation
41 int __weak plat_post_relocation(long offset)
43 return 0;
46 static inline u32 __init get_synci_step(void)
48 u32 res;
50 __asm__("rdhwr %0, $1" : "=r" (res));
52 return res;
55 static void __init sync_icache(void *kbase, unsigned long kernel_length)
57 void *kend = kbase + kernel_length;
58 u32 step = get_synci_step();
60 do {
61 __asm__ __volatile__(
62 "synci 0(%0)"
63 : /* no output */
64 : "r" (kbase));
66 kbase += step;
67 } while (kbase < kend);
69 /* Completion barrier */
70 __sync();
73 static int __init apply_r_mips_64_rel(u32 *loc_orig, u32 *loc_new, long offset)
75 *(u64 *)loc_new += offset;
77 return 0;
80 static int __init apply_r_mips_32_rel(u32 *loc_orig, u32 *loc_new, long offset)
82 *loc_new += offset;
84 return 0;
87 static int __init apply_r_mips_26_rel(u32 *loc_orig, u32 *loc_new, long offset)
89 unsigned long target_addr = (*loc_orig) & 0x03ffffff;
91 if (offset % 4) {
92 pr_err("Dangerous R_MIPS_26 REL relocation\n");
93 return -ENOEXEC;
96 /* Original target address */
97 target_addr <<= 2;
98 target_addr += (unsigned long)loc_orig & ~0x03ffffff;
100 /* Get the new target address */
101 target_addr += offset;
103 if ((target_addr & 0xf0000000) != ((unsigned long)loc_new & 0xf0000000)) {
104 pr_err("R_MIPS_26 REL relocation overflow\n");
105 return -ENOEXEC;
108 target_addr -= (unsigned long)loc_new & ~0x03ffffff;
109 target_addr >>= 2;
111 *loc_new = (*loc_new & ~0x03ffffff) | (target_addr & 0x03ffffff);
113 return 0;
117 static int __init apply_r_mips_hi16_rel(u32 *loc_orig, u32 *loc_new, long offset)
119 unsigned long insn = *loc_orig;
120 unsigned long target = (insn & 0xffff) << 16; /* high 16bits of target */
122 target += offset;
124 *loc_new = (insn & ~0xffff) | ((target >> 16) & 0xffff);
125 return 0;
128 static int (*reloc_handlers_rel[]) (u32 *, u32 *, long) __initdata = {
129 [R_MIPS_64] = apply_r_mips_64_rel,
130 [R_MIPS_32] = apply_r_mips_32_rel,
131 [R_MIPS_26] = apply_r_mips_26_rel,
132 [R_MIPS_HI16] = apply_r_mips_hi16_rel,
135 int __init do_relocations(void *kbase_old, void *kbase_new, long offset)
137 u32 *r;
138 u32 *loc_orig;
139 u32 *loc_new;
140 int type;
141 int res;
143 for (r = _relocation_start; r < _relocation_end; r++) {
144 /* Sentinel for last relocation */
145 if (*r == 0)
146 break;
148 type = (*r >> 24) & 0xff;
149 loc_orig = kbase_old + ((*r & 0x00ffffff) << 2);
150 loc_new = RELOCATED(loc_orig);
152 if (reloc_handlers_rel[type] == NULL) {
153 /* Unsupported relocation */
154 pr_err("Unhandled relocation type %d at 0x%pK\n",
155 type, loc_orig);
156 return -ENOEXEC;
159 res = reloc_handlers_rel[type](loc_orig, loc_new, offset);
160 if (res)
161 return res;
164 return 0;
168 * The exception table is filled in by the relocs tool after vmlinux is linked.
169 * It must be relocated separately since there will not be any relocation
170 * information for it filled in by the linker.
172 static int __init relocate_exception_table(long offset)
174 unsigned long *etable_start, *etable_end, *e;
176 etable_start = RELOCATED(&__start___ex_table);
177 etable_end = RELOCATED(&__stop___ex_table);
179 for (e = etable_start; e < etable_end; e++)
180 *e += offset;
182 return 0;
185 #ifdef CONFIG_RANDOMIZE_BASE
187 static inline __init unsigned long rotate_xor(unsigned long hash,
188 const void *area, size_t size)
190 size_t i;
191 unsigned long *ptr = (unsigned long *)area;
193 for (i = 0; i < size / sizeof(hash); i++) {
194 /* Rotate by odd number of bits and XOR. */
195 hash = (hash << ((sizeof(hash) * 8) - 7)) | (hash >> 7);
196 hash ^= ptr[i];
199 return hash;
202 static inline __init unsigned long get_random_boot(void)
204 unsigned long entropy = random_get_entropy();
205 unsigned long hash = 0;
207 /* Attempt to create a simple but unpredictable starting entropy. */
208 hash = rotate_xor(hash, linux_banner, strlen(linux_banner));
210 /* Add in any runtime entropy we can get */
211 hash = rotate_xor(hash, &entropy, sizeof(entropy));
213 #if defined(CONFIG_USE_OF)
214 /* Get any additional entropy passed in device tree */
215 if (initial_boot_params) {
216 int node, len;
217 u64 *prop;
219 node = fdt_path_offset(initial_boot_params, "/chosen");
220 if (node >= 0) {
221 prop = fdt_getprop_w(initial_boot_params, node,
222 "kaslr-seed", &len);
223 if (prop && (len == sizeof(u64)))
224 hash = rotate_xor(hash, prop, sizeof(*prop));
227 #endif /* CONFIG_USE_OF */
229 return hash;
232 static inline __init bool kaslr_disabled(void)
234 char *str;
236 #if defined(CONFIG_CMDLINE_BOOL)
237 const char *builtin_cmdline = CONFIG_CMDLINE;
239 str = strstr(builtin_cmdline, "nokaslr");
240 if (str == builtin_cmdline ||
241 (str > builtin_cmdline && *(str - 1) == ' '))
242 return true;
243 #endif
244 str = strstr(arcs_cmdline, "nokaslr");
245 if (str == arcs_cmdline || (str > arcs_cmdline && *(str - 1) == ' '))
246 return true;
248 return false;
251 static inline void __init *determine_relocation_address(void)
253 /* Choose a new address for the kernel */
254 unsigned long kernel_length;
255 void *dest = &_text;
256 unsigned long offset;
258 if (kaslr_disabled())
259 return dest;
261 kernel_length = (long)_end - (long)(&_text);
263 offset = get_random_boot() << 16;
264 offset &= (CONFIG_RANDOMIZE_BASE_MAX_OFFSET - 1);
265 if (offset < kernel_length)
266 offset += ALIGN(kernel_length, 0xffff);
268 return RELOCATED(dest);
271 #else
273 static inline void __init *determine_relocation_address(void)
276 * Choose a new address for the kernel
277 * For now we'll hard code the destination
279 return (void *)0xffffffff81000000;
282 #endif
284 static inline int __init relocation_addr_valid(void *loc_new)
286 if ((unsigned long)loc_new & 0x0000ffff) {
287 /* Inappropriately aligned new location */
288 return 0;
290 if ((unsigned long)loc_new < (unsigned long)&_end) {
291 /* New location overlaps original kernel */
292 return 0;
294 return 1;
297 void *__init relocate_kernel(void)
299 void *loc_new;
300 unsigned long kernel_length;
301 unsigned long bss_length;
302 long offset = 0;
303 int res = 1;
304 /* Default to original kernel entry point */
305 void *kernel_entry = start_kernel;
306 void *fdt = NULL;
308 /* Get the command line */
309 fw_init_cmdline();
310 #if defined(CONFIG_USE_OF)
311 /* Deal with the device tree */
312 fdt = plat_get_fdt();
313 early_init_dt_scan(fdt);
314 if (boot_command_line[0]) {
315 /* Boot command line was passed in device tree */
316 strlcpy(arcs_cmdline, boot_command_line, COMMAND_LINE_SIZE);
318 #endif /* CONFIG_USE_OF */
320 kernel_length = (long)(&_relocation_start) - (long)(&_text);
321 bss_length = (long)&__bss_stop - (long)&__bss_start;
323 loc_new = determine_relocation_address();
325 /* Sanity check relocation address */
326 if (relocation_addr_valid(loc_new))
327 offset = (unsigned long)loc_new - (unsigned long)(&_text);
329 /* Reset the command line now so we don't end up with a duplicate */
330 arcs_cmdline[0] = '\0';
332 if (offset) {
333 void (*fdt_relocated_)(void *) = NULL;
334 #if defined(CONFIG_USE_OF)
335 unsigned long fdt_phys = virt_to_phys(fdt);
338 * If built-in dtb is used then it will have been relocated
339 * during kernel _text relocation. If appended DTB is used
340 * then it will not be relocated, but it should remain
341 * intact in the original location. If dtb is loaded by
342 * the bootloader then it may need to be moved if it crosses
343 * the target memory area
346 if (fdt_phys >= virt_to_phys(RELOCATED(&_text)) &&
347 fdt_phys <= virt_to_phys(RELOCATED(&_end))) {
348 void *fdt_relocated =
349 RELOCATED(ALIGN((long)&_end, PAGE_SIZE));
350 memcpy(fdt_relocated, fdt, fdt_totalsize(fdt));
351 fdt = fdt_relocated;
352 fdt_relocated_ = RELOCATED(&plat_fdt_relocated);
354 #endif /* CONFIG_USE_OF */
356 /* Copy the kernel to it's new location */
357 memcpy(loc_new, &_text, kernel_length);
359 /* Perform relocations on the new kernel */
360 res = do_relocations(&_text, loc_new, offset);
361 if (res < 0)
362 goto out;
364 /* Sync the caches ready for execution of new kernel */
365 sync_icache(loc_new, kernel_length);
367 res = relocate_exception_table(offset);
368 if (res < 0)
369 goto out;
372 * The original .bss has already been cleared, and
373 * some variables such as command line parameters
374 * stored to it so make a copy in the new location.
376 memcpy(RELOCATED(&__bss_start), &__bss_start, bss_length);
379 * If fdt was stored outside of the kernel image and
380 * had to be moved then update platform's state data
381 * with the new fdt location
383 if (fdt_relocated_)
384 fdt_relocated_(fdt);
387 * Last chance for the platform to abort relocation.
388 * This may also be used by the platform to perform any
389 * initialisation required now that the new kernel is
390 * resident in memory and ready to be executed.
392 if (plat_post_relocation(offset))
393 goto out;
395 /* The current thread is now within the relocated image */
396 __current_thread_info = RELOCATED(&init_thread_union);
398 /* Return the new kernel's entry point */
399 kernel_entry = RELOCATED(start_kernel);
401 out:
402 return kernel_entry;
406 * Show relocation information on panic.
408 void show_kernel_relocation(const char *level)
410 unsigned long offset;
412 offset = __pa_symbol(_text) - __pa_symbol(VMLINUX_LOAD_ADDRESS);
414 if (IS_ENABLED(CONFIG_RELOCATABLE) && offset > 0) {
415 printk(level);
416 pr_cont("Kernel relocated by 0x%pK\n", (void *)offset);
417 pr_cont(" .text @ 0x%pK\n", _text);
418 pr_cont(" .data @ 0x%pK\n", _sdata);
419 pr_cont(" .bss @ 0x%pK\n", __bss_start);
423 static int kernel_location_notifier_fn(struct notifier_block *self,
424 unsigned long v, void *p)
426 show_kernel_relocation(KERN_EMERG);
427 return NOTIFY_DONE;
430 static struct notifier_block kernel_location_notifier = {
431 .notifier_call = kernel_location_notifier_fn
434 static int __init register_kernel_offset_dumper(void)
436 atomic_notifier_chain_register(&panic_notifier_list,
437 &kernel_location_notifier);
438 return 0;
440 __initcall(register_kernel_offset_dumper);