Merge tag 'spi-v5.20' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi
[linux-2.6-microblaze.git] / arch / x86 / kernel / kexec-bzimage64.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Kexec bzImage loader
4  *
5  * Copyright (C) 2014 Red Hat Inc.
6  * Authors:
7  *      Vivek Goyal <vgoyal@redhat.com>
8  */
9
10 #define pr_fmt(fmt)     "kexec-bzImage64: " fmt
11
12 #include <linux/string.h>
13 #include <linux/printk.h>
14 #include <linux/errno.h>
15 #include <linux/slab.h>
16 #include <linux/kexec.h>
17 #include <linux/kernel.h>
18 #include <linux/mm.h>
19 #include <linux/efi.h>
20 #include <linux/verification.h>
21 #include <linux/random.h>
22
23 #include <asm/bootparam.h>
24 #include <asm/setup.h>
25 #include <asm/crash.h>
26 #include <asm/efi.h>
27 #include <asm/e820/api.h>
28 #include <asm/kexec-bzimage64.h>
29
30 #define MAX_ELFCOREHDR_STR_LEN  30      /* elfcorehdr=0x<64bit-value> */
31
32 /*
33  * Defines lowest physical address for various segments. Not sure where
34  * exactly these limits came from. Current bzimage64 loader in kexec-tools
35  * uses these so I am retaining it. It can be changed over time as we gain
36  * more insight.
37  */
38 #define MIN_PURGATORY_ADDR      0x3000
39 #define MIN_BOOTPARAM_ADDR      0x3000
40 #define MIN_KERNEL_LOAD_ADDR    0x100000
41 #define MIN_INITRD_LOAD_ADDR    0x1000000
42
43 /*
44  * This is a place holder for all boot loader specific data structure which
45  * gets allocated in one call but gets freed much later during cleanup
46  * time. Right now there is only one field but it can grow as need be.
47  */
48 struct bzimage64_data {
49         /*
50          * Temporary buffer to hold bootparams buffer. This should be
51          * freed once the bootparam segment has been loaded.
52          */
53         void *bootparams_buf;
54 };
55
56 static int setup_initrd(struct boot_params *params,
57                 unsigned long initrd_load_addr, unsigned long initrd_len)
58 {
59         params->hdr.ramdisk_image = initrd_load_addr & 0xffffffffUL;
60         params->hdr.ramdisk_size = initrd_len & 0xffffffffUL;
61
62         params->ext_ramdisk_image = initrd_load_addr >> 32;
63         params->ext_ramdisk_size = initrd_len >> 32;
64
65         return 0;
66 }
67
68 static int setup_cmdline(struct kimage *image, struct boot_params *params,
69                          unsigned long bootparams_load_addr,
70                          unsigned long cmdline_offset, char *cmdline,
71                          unsigned long cmdline_len)
72 {
73         char *cmdline_ptr = ((char *)params) + cmdline_offset;
74         unsigned long cmdline_ptr_phys, len = 0;
75         uint32_t cmdline_low_32, cmdline_ext_32;
76
77         if (image->type == KEXEC_TYPE_CRASH) {
78                 len = sprintf(cmdline_ptr,
79                         "elfcorehdr=0x%lx ", image->elf_load_addr);
80         }
81         memcpy(cmdline_ptr + len, cmdline, cmdline_len);
82         cmdline_len += len;
83
84         cmdline_ptr[cmdline_len - 1] = '\0';
85
86         pr_debug("Final command line is: %s\n", cmdline_ptr);
87         cmdline_ptr_phys = bootparams_load_addr + cmdline_offset;
88         cmdline_low_32 = cmdline_ptr_phys & 0xffffffffUL;
89         cmdline_ext_32 = cmdline_ptr_phys >> 32;
90
91         params->hdr.cmd_line_ptr = cmdline_low_32;
92         if (cmdline_ext_32)
93                 params->ext_cmd_line_ptr = cmdline_ext_32;
94
95         return 0;
96 }
97
98 static int setup_e820_entries(struct boot_params *params)
99 {
100         unsigned int nr_e820_entries;
101
102         nr_e820_entries = e820_table_kexec->nr_entries;
103
104         /* TODO: Pass entries more than E820_MAX_ENTRIES_ZEROPAGE in bootparams setup data */
105         if (nr_e820_entries > E820_MAX_ENTRIES_ZEROPAGE)
106                 nr_e820_entries = E820_MAX_ENTRIES_ZEROPAGE;
107
108         params->e820_entries = nr_e820_entries;
109         memcpy(&params->e820_table, &e820_table_kexec->entries, nr_e820_entries*sizeof(struct e820_entry));
110
111         return 0;
112 }
113
114 enum { RNG_SEED_LENGTH = 32 };
115
116 static void
117 setup_rng_seed(struct boot_params *params, unsigned long params_load_addr,
118                unsigned int rng_seed_setup_data_offset)
119 {
120         struct setup_data *sd = (void *)params + rng_seed_setup_data_offset;
121         unsigned long setup_data_phys;
122
123         if (!rng_is_initialized())
124                 return;
125
126         sd->type = SETUP_RNG_SEED;
127         sd->len = RNG_SEED_LENGTH;
128         get_random_bytes(sd->data, RNG_SEED_LENGTH);
129         setup_data_phys = params_load_addr + rng_seed_setup_data_offset;
130         sd->next = params->hdr.setup_data;
131         params->hdr.setup_data = setup_data_phys;
132 }
133
134 #ifdef CONFIG_EFI
135 static int setup_efi_info_memmap(struct boot_params *params,
136                                   unsigned long params_load_addr,
137                                   unsigned int efi_map_offset,
138                                   unsigned int efi_map_sz)
139 {
140         void *efi_map = (void *)params + efi_map_offset;
141         unsigned long efi_map_phys_addr = params_load_addr + efi_map_offset;
142         struct efi_info *ei = &params->efi_info;
143
144         if (!efi_map_sz)
145                 return 0;
146
147         efi_runtime_map_copy(efi_map, efi_map_sz);
148
149         ei->efi_memmap = efi_map_phys_addr & 0xffffffff;
150         ei->efi_memmap_hi = efi_map_phys_addr >> 32;
151         ei->efi_memmap_size = efi_map_sz;
152
153         return 0;
154 }
155
156 static int
157 prepare_add_efi_setup_data(struct boot_params *params,
158                        unsigned long params_load_addr,
159                        unsigned int efi_setup_data_offset)
160 {
161         unsigned long setup_data_phys;
162         struct setup_data *sd = (void *)params + efi_setup_data_offset;
163         struct efi_setup_data *esd = (void *)sd + sizeof(struct setup_data);
164
165         esd->fw_vendor = efi_fw_vendor;
166         esd->tables = efi_config_table;
167         esd->smbios = efi.smbios;
168
169         sd->type = SETUP_EFI;
170         sd->len = sizeof(struct efi_setup_data);
171
172         /* Add setup data */
173         setup_data_phys = params_load_addr + efi_setup_data_offset;
174         sd->next = params->hdr.setup_data;
175         params->hdr.setup_data = setup_data_phys;
176
177         return 0;
178 }
179
180 static int
181 setup_efi_state(struct boot_params *params, unsigned long params_load_addr,
182                 unsigned int efi_map_offset, unsigned int efi_map_sz,
183                 unsigned int efi_setup_data_offset)
184 {
185         struct efi_info *current_ei = &boot_params.efi_info;
186         struct efi_info *ei = &params->efi_info;
187
188         if (!efi_enabled(EFI_RUNTIME_SERVICES))
189                 return 0;
190
191         if (!current_ei->efi_memmap_size)
192                 return 0;
193
194         params->secure_boot = boot_params.secure_boot;
195         ei->efi_loader_signature = current_ei->efi_loader_signature;
196         ei->efi_systab = current_ei->efi_systab;
197         ei->efi_systab_hi = current_ei->efi_systab_hi;
198
199         ei->efi_memdesc_version = current_ei->efi_memdesc_version;
200         ei->efi_memdesc_size = efi_get_runtime_map_desc_size();
201
202         setup_efi_info_memmap(params, params_load_addr, efi_map_offset,
203                               efi_map_sz);
204         prepare_add_efi_setup_data(params, params_load_addr,
205                                    efi_setup_data_offset);
206         return 0;
207 }
208 #endif /* CONFIG_EFI */
209
210 static void
211 setup_ima_state(const struct kimage *image, struct boot_params *params,
212                 unsigned long params_load_addr,
213                 unsigned int ima_setup_data_offset)
214 {
215 #ifdef CONFIG_IMA_KEXEC
216         struct setup_data *sd = (void *)params + ima_setup_data_offset;
217         unsigned long setup_data_phys;
218         struct ima_setup_data *ima;
219
220         if (!image->ima_buffer_size)
221                 return;
222
223         sd->type = SETUP_IMA;
224         sd->len = sizeof(*ima);
225
226         ima = (void *)sd + sizeof(struct setup_data);
227         ima->addr = image->ima_buffer_addr;
228         ima->size = image->ima_buffer_size;
229
230         /* Add setup data */
231         setup_data_phys = params_load_addr + ima_setup_data_offset;
232         sd->next = params->hdr.setup_data;
233         params->hdr.setup_data = setup_data_phys;
234 #endif /* CONFIG_IMA_KEXEC */
235 }
236
237 static int
238 setup_boot_parameters(struct kimage *image, struct boot_params *params,
239                       unsigned long params_load_addr,
240                       unsigned int efi_map_offset, unsigned int efi_map_sz,
241                       unsigned int setup_data_offset)
242 {
243         unsigned int nr_e820_entries;
244         unsigned long long mem_k, start, end;
245         int i, ret = 0;
246
247         /* Get subarch from existing bootparams */
248         params->hdr.hardware_subarch = boot_params.hdr.hardware_subarch;
249
250         /* Copying screen_info will do? */
251         memcpy(&params->screen_info, &screen_info, sizeof(struct screen_info));
252
253         /* Fill in memsize later */
254         params->screen_info.ext_mem_k = 0;
255         params->alt_mem_k = 0;
256
257         /* Always fill in RSDP: it is either 0 or a valid value */
258         params->acpi_rsdp_addr = boot_params.acpi_rsdp_addr;
259
260         /* Default APM info */
261         memset(&params->apm_bios_info, 0, sizeof(params->apm_bios_info));
262
263         /* Default drive info */
264         memset(&params->hd0_info, 0, sizeof(params->hd0_info));
265         memset(&params->hd1_info, 0, sizeof(params->hd1_info));
266
267         if (image->type == KEXEC_TYPE_CRASH) {
268                 ret = crash_setup_memmap_entries(image, params);
269                 if (ret)
270                         return ret;
271         } else
272                 setup_e820_entries(params);
273
274         nr_e820_entries = params->e820_entries;
275
276         for (i = 0; i < nr_e820_entries; i++) {
277                 if (params->e820_table[i].type != E820_TYPE_RAM)
278                         continue;
279                 start = params->e820_table[i].addr;
280                 end = params->e820_table[i].addr + params->e820_table[i].size - 1;
281
282                 if ((start <= 0x100000) && end > 0x100000) {
283                         mem_k = (end >> 10) - (0x100000 >> 10);
284                         params->screen_info.ext_mem_k = mem_k;
285                         params->alt_mem_k = mem_k;
286                         if (mem_k > 0xfc00)
287                                 params->screen_info.ext_mem_k = 0xfc00; /* 64M*/
288                         if (mem_k > 0xffffffff)
289                                 params->alt_mem_k = 0xffffffff;
290                 }
291         }
292
293 #ifdef CONFIG_EFI
294         /* Setup EFI state */
295         setup_efi_state(params, params_load_addr, efi_map_offset, efi_map_sz,
296                         setup_data_offset);
297         setup_data_offset += sizeof(struct setup_data) +
298                         sizeof(struct efi_setup_data);
299 #endif
300
301         if (IS_ENABLED(CONFIG_IMA_KEXEC)) {
302                 /* Setup IMA log buffer state */
303                 setup_ima_state(image, params, params_load_addr,
304                                 setup_data_offset);
305                 setup_data_offset += sizeof(struct setup_data) +
306                                      sizeof(struct ima_setup_data);
307         }
308
309         /* Setup RNG seed */
310         setup_rng_seed(params, params_load_addr, setup_data_offset);
311
312         /* Setup EDD info */
313         memcpy(params->eddbuf, boot_params.eddbuf,
314                                 EDDMAXNR * sizeof(struct edd_info));
315         params->eddbuf_entries = boot_params.eddbuf_entries;
316
317         memcpy(params->edd_mbr_sig_buffer, boot_params.edd_mbr_sig_buffer,
318                EDD_MBR_SIG_MAX * sizeof(unsigned int));
319
320         return ret;
321 }
322
323 static int bzImage64_probe(const char *buf, unsigned long len)
324 {
325         int ret = -ENOEXEC;
326         struct setup_header *header;
327
328         /* kernel should be at least two sectors long */
329         if (len < 2 * 512) {
330                 pr_err("File is too short to be a bzImage\n");
331                 return ret;
332         }
333
334         header = (struct setup_header *)(buf + offsetof(struct boot_params, hdr));
335         if (memcmp((char *)&header->header, "HdrS", 4) != 0) {
336                 pr_err("Not a bzImage\n");
337                 return ret;
338         }
339
340         if (header->boot_flag != 0xAA55) {
341                 pr_err("No x86 boot sector present\n");
342                 return ret;
343         }
344
345         if (header->version < 0x020C) {
346                 pr_err("Must be at least protocol version 2.12\n");
347                 return ret;
348         }
349
350         if (!(header->loadflags & LOADED_HIGH)) {
351                 pr_err("zImage not a bzImage\n");
352                 return ret;
353         }
354
355         if (!(header->xloadflags & XLF_KERNEL_64)) {
356                 pr_err("Not a bzImage64. XLF_KERNEL_64 is not set.\n");
357                 return ret;
358         }
359
360         if (!(header->xloadflags & XLF_CAN_BE_LOADED_ABOVE_4G)) {
361                 pr_err("XLF_CAN_BE_LOADED_ABOVE_4G is not set.\n");
362                 return ret;
363         }
364
365         /*
366          * Can't handle 32bit EFI as it does not allow loading kernel
367          * above 4G. This should be handled by 32bit bzImage loader
368          */
369         if (efi_enabled(EFI_RUNTIME_SERVICES) && !efi_enabled(EFI_64BIT)) {
370                 pr_debug("EFI is 32 bit. Can't load kernel above 4G.\n");
371                 return ret;
372         }
373
374         if (!(header->xloadflags & XLF_5LEVEL) && pgtable_l5_enabled()) {
375                 pr_err("bzImage cannot handle 5-level paging mode.\n");
376                 return ret;
377         }
378
379         /* I've got a bzImage */
380         pr_debug("It's a relocatable bzImage64\n");
381         ret = 0;
382
383         return ret;
384 }
385
386 static void *bzImage64_load(struct kimage *image, char *kernel,
387                             unsigned long kernel_len, char *initrd,
388                             unsigned long initrd_len, char *cmdline,
389                             unsigned long cmdline_len)
390 {
391
392         struct setup_header *header;
393         int setup_sects, kern16_size, ret = 0;
394         unsigned long setup_header_size, params_cmdline_sz;
395         struct boot_params *params;
396         unsigned long bootparam_load_addr, kernel_load_addr, initrd_load_addr;
397         struct bzimage64_data *ldata;
398         struct kexec_entry64_regs regs64;
399         void *stack;
400         unsigned int setup_hdr_offset = offsetof(struct boot_params, hdr);
401         unsigned int efi_map_offset, efi_map_sz, efi_setup_data_offset;
402         struct kexec_buf kbuf = { .image = image, .buf_max = ULONG_MAX,
403                                   .top_down = true };
404         struct kexec_buf pbuf = { .image = image, .buf_min = MIN_PURGATORY_ADDR,
405                                   .buf_max = ULONG_MAX, .top_down = true };
406
407         header = (struct setup_header *)(kernel + setup_hdr_offset);
408         setup_sects = header->setup_sects;
409         if (setup_sects == 0)
410                 setup_sects = 4;
411
412         kern16_size = (setup_sects + 1) * 512;
413         if (kernel_len < kern16_size) {
414                 pr_err("bzImage truncated\n");
415                 return ERR_PTR(-ENOEXEC);
416         }
417
418         if (cmdline_len > header->cmdline_size) {
419                 pr_err("Kernel command line too long\n");
420                 return ERR_PTR(-EINVAL);
421         }
422
423         /*
424          * In case of crash dump, we will append elfcorehdr=<addr> to
425          * command line. Make sure it does not overflow
426          */
427         if (cmdline_len + MAX_ELFCOREHDR_STR_LEN > header->cmdline_size) {
428                 pr_debug("Appending elfcorehdr=<addr> to command line exceeds maximum allowed length\n");
429                 return ERR_PTR(-EINVAL);
430         }
431
432         /* Allocate and load backup region */
433         if (image->type == KEXEC_TYPE_CRASH) {
434                 ret = crash_load_segments(image);
435                 if (ret)
436                         return ERR_PTR(ret);
437         }
438
439         /*
440          * Load purgatory. For 64bit entry point, purgatory  code can be
441          * anywhere.
442          */
443         ret = kexec_load_purgatory(image, &pbuf);
444         if (ret) {
445                 pr_err("Loading purgatory failed\n");
446                 return ERR_PTR(ret);
447         }
448
449         pr_debug("Loaded purgatory at 0x%lx\n", pbuf.mem);
450
451
452         /*
453          * Load Bootparams and cmdline and space for efi stuff.
454          *
455          * Allocate memory together for multiple data structures so
456          * that they all can go in single area/segment and we don't
457          * have to create separate segment for each. Keeps things
458          * little bit simple
459          */
460         efi_map_sz = efi_get_runtime_map_size();
461         params_cmdline_sz = sizeof(struct boot_params) + cmdline_len +
462                                 MAX_ELFCOREHDR_STR_LEN;
463         params_cmdline_sz = ALIGN(params_cmdline_sz, 16);
464         kbuf.bufsz = params_cmdline_sz + ALIGN(efi_map_sz, 16) +
465                                 sizeof(struct setup_data) +
466                                 sizeof(struct efi_setup_data) +
467                                 sizeof(struct setup_data) +
468                                 RNG_SEED_LENGTH;
469
470         if (IS_ENABLED(CONFIG_IMA_KEXEC))
471                 kbuf.bufsz += sizeof(struct setup_data) +
472                               sizeof(struct ima_setup_data);
473
474         params = kzalloc(kbuf.bufsz, GFP_KERNEL);
475         if (!params)
476                 return ERR_PTR(-ENOMEM);
477         efi_map_offset = params_cmdline_sz;
478         efi_setup_data_offset = efi_map_offset + ALIGN(efi_map_sz, 16);
479
480         /* Copy setup header onto bootparams. Documentation/x86/boot.rst */
481         setup_header_size = 0x0202 + kernel[0x0201] - setup_hdr_offset;
482
483         /* Is there a limit on setup header size? */
484         memcpy(&params->hdr, (kernel + setup_hdr_offset), setup_header_size);
485
486         kbuf.buffer = params;
487         kbuf.memsz = kbuf.bufsz;
488         kbuf.buf_align = 16;
489         kbuf.buf_min = MIN_BOOTPARAM_ADDR;
490         ret = kexec_add_buffer(&kbuf);
491         if (ret)
492                 goto out_free_params;
493         bootparam_load_addr = kbuf.mem;
494         pr_debug("Loaded boot_param, command line and misc at 0x%lx bufsz=0x%lx memsz=0x%lx\n",
495                  bootparam_load_addr, kbuf.bufsz, kbuf.bufsz);
496
497         /* Load kernel */
498         kbuf.buffer = kernel + kern16_size;
499         kbuf.bufsz =  kernel_len - kern16_size;
500         kbuf.memsz = PAGE_ALIGN(header->init_size);
501         kbuf.buf_align = header->kernel_alignment;
502         kbuf.buf_min = MIN_KERNEL_LOAD_ADDR;
503         kbuf.mem = KEXEC_BUF_MEM_UNKNOWN;
504         ret = kexec_add_buffer(&kbuf);
505         if (ret)
506                 goto out_free_params;
507         kernel_load_addr = kbuf.mem;
508
509         pr_debug("Loaded 64bit kernel at 0x%lx bufsz=0x%lx memsz=0x%lx\n",
510                  kernel_load_addr, kbuf.bufsz, kbuf.memsz);
511
512         /* Load initrd high */
513         if (initrd) {
514                 kbuf.buffer = initrd;
515                 kbuf.bufsz = kbuf.memsz = initrd_len;
516                 kbuf.buf_align = PAGE_SIZE;
517                 kbuf.buf_min = MIN_INITRD_LOAD_ADDR;
518                 kbuf.mem = KEXEC_BUF_MEM_UNKNOWN;
519                 ret = kexec_add_buffer(&kbuf);
520                 if (ret)
521                         goto out_free_params;
522                 initrd_load_addr = kbuf.mem;
523
524                 pr_debug("Loaded initrd at 0x%lx bufsz=0x%lx memsz=0x%lx\n",
525                                 initrd_load_addr, initrd_len, initrd_len);
526
527                 setup_initrd(params, initrd_load_addr, initrd_len);
528         }
529
530         setup_cmdline(image, params, bootparam_load_addr,
531                       sizeof(struct boot_params), cmdline, cmdline_len);
532
533         /* bootloader info. Do we need a separate ID for kexec kernel loader? */
534         params->hdr.type_of_loader = 0x0D << 4;
535         params->hdr.loadflags = 0;
536
537         /* Setup purgatory regs for entry */
538         ret = kexec_purgatory_get_set_symbol(image, "entry64_regs", &regs64,
539                                              sizeof(regs64), 1);
540         if (ret)
541                 goto out_free_params;
542
543         regs64.rbx = 0; /* Bootstrap Processor */
544         regs64.rsi = bootparam_load_addr;
545         regs64.rip = kernel_load_addr + 0x200;
546         stack = kexec_purgatory_get_symbol_addr(image, "stack_end");
547         if (IS_ERR(stack)) {
548                 pr_err("Could not find address of symbol stack_end\n");
549                 ret = -EINVAL;
550                 goto out_free_params;
551         }
552
553         regs64.rsp = (unsigned long)stack;
554         ret = kexec_purgatory_get_set_symbol(image, "entry64_regs", &regs64,
555                                              sizeof(regs64), 0);
556         if (ret)
557                 goto out_free_params;
558
559         ret = setup_boot_parameters(image, params, bootparam_load_addr,
560                                     efi_map_offset, efi_map_sz,
561                                     efi_setup_data_offset);
562         if (ret)
563                 goto out_free_params;
564
565         /* Allocate loader specific data */
566         ldata = kzalloc(sizeof(struct bzimage64_data), GFP_KERNEL);
567         if (!ldata) {
568                 ret = -ENOMEM;
569                 goto out_free_params;
570         }
571
572         /*
573          * Store pointer to params so that it could be freed after loading
574          * params segment has been loaded and contents have been copied
575          * somewhere else.
576          */
577         ldata->bootparams_buf = params;
578         return ldata;
579
580 out_free_params:
581         kfree(params);
582         return ERR_PTR(ret);
583 }
584
585 /* This cleanup function is called after various segments have been loaded */
586 static int bzImage64_cleanup(void *loader_data)
587 {
588         struct bzimage64_data *ldata = loader_data;
589
590         if (!ldata)
591                 return 0;
592
593         kfree(ldata->bootparams_buf);
594         ldata->bootparams_buf = NULL;
595
596         return 0;
597 }
598
599 #ifdef CONFIG_KEXEC_BZIMAGE_VERIFY_SIG
600 static int bzImage64_verify_sig(const char *kernel, unsigned long kernel_len)
601 {
602         int ret;
603
604         ret = verify_pefile_signature(kernel, kernel_len,
605                                       VERIFY_USE_SECONDARY_KEYRING,
606                                       VERIFYING_KEXEC_PE_SIGNATURE);
607         if (ret == -ENOKEY && IS_ENABLED(CONFIG_INTEGRITY_PLATFORM_KEYRING)) {
608                 ret = verify_pefile_signature(kernel, kernel_len,
609                                               VERIFY_USE_PLATFORM_KEYRING,
610                                               VERIFYING_KEXEC_PE_SIGNATURE);
611         }
612         return ret;
613 }
614 #endif
615
616 const struct kexec_file_ops kexec_bzImage64_ops = {
617         .probe = bzImage64_probe,
618         .load = bzImage64_load,
619         .cleanup = bzImage64_cleanup,
620 #ifdef CONFIG_KEXEC_BZIMAGE_VERIFY_SIG
621         .verify_sig = bzImage64_verify_sig,
622 #endif
623 };