1 /*-
2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3 * Copyright (c) 2004, 2006 Marcel Moolenaar
4 * Copyright (c) 2014 The FreeBSD Foundation
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 AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD: head/sys/boot/efi/loader/bootinfo.c 293724 2016-01-12 02:17:39Z smh $");
31
32 #include <stand.h>
33 #include <string.h>
34 #include <sys/param.h>
35 #include <sys/reboot.h>
36 #include <sys/linker.h>
37 #include <sys/boot.h>
38 #include <machine/cpufunc.h>
39 #include <machine/elf.h>
40 #include <machine/metadata.h>
41 #include <machine/psl.h>
42
43 #include <efi.h>
44 #include <efilib.h>
45
46 #include "bootstrap.h"
47 #include "loader_efi.h"
48
49 #if defined(__x86_64__)
50 #include <machine/specialreg.h>
51 #include "framebuffer.h"
52 #endif
53
54 int bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp);
55
56 extern EFI_SYSTEM_TABLE *ST;
57
58 static const char howto_switches[] = "aCdrgmphsv";
59 static int howto_masks[] = {
60 RB_ASKNAME, RB_CDROM, RB_KDB, RB_DFLTROOT, RB_GDB,
61 RB_MUTE, RB_PAUSE, RB_SERIAL, RB_SINGLE, RB_VERBOSE
62 };
63
64 static int
bi_getboothowto(char * kargs)65 bi_getboothowto(char *kargs)
66 {
67 const char *sw;
68 char *opts;
69 char *console;
70 int howto, i;
71
72 howto = 0;
73
74 /* Get the boot options from the environment first. */
75 for (i = 0; howto_names[i].ev != NULL; i++) {
76 if (getenv(howto_names[i].ev) != NULL)
77 howto |= howto_names[i].mask;
78 }
79
80 console = getenv("console");
81 if (console != NULL) {
82 if (strcmp(console, "comconsole") == 0)
83 howto |= RB_SERIAL;
84 if (strcmp(console, "vidconsole") == 0)
85 howto |= RB_VIDEO;
86 if (strcmp(console, "nullconsole") == 0)
87 howto |= RB_MUTE;
88 }
89
90 /* Parse kargs */
91 if (kargs == NULL)
92 return (howto);
93
94 opts = strchr(kargs, '-');
95 while (opts != NULL) {
96 while (*(++opts) != '\0') {
97 sw = strchr(howto_switches, *opts);
98 if (sw == NULL)
99 break;
100 howto |= howto_masks[sw - howto_switches];
101 }
102 opts = strchr(opts, '-');
103 }
104
105 return (howto);
106 }
107
108 /*
109 * Copy the environment into the load area starting at (addr).
110 * Each variable is formatted as <name>=<value>, with a single nul
111 * separating each variable, and a double nul terminating the environment.
112 */
113 static vm_offset_t
bi_copyenv(vm_offset_t start)114 bi_copyenv(vm_offset_t start)
115 {
116 struct env_var *ep;
117 vm_offset_t addr, last;
118 size_t len;
119
120 addr = last = start;
121
122 /* Traverse the environment. */
123 for (ep = environ; ep != NULL; ep = ep->ev_next) {
124 len = strlen(ep->ev_name);
125 if ((size_t)archsw.arch_copyin(ep->ev_name, addr, len) != len)
126 break;
127 addr += len;
128 if (archsw.arch_copyin("=", addr, 1) != 1)
129 break;
130 addr++;
131 if (ep->ev_value != NULL) {
132 len = strlen(ep->ev_value);
133 if ((size_t)archsw.arch_copyin(ep->ev_value, addr, len) != len)
134 break;
135 addr += len;
136 }
137 if (archsw.arch_copyin("", addr, 1) != 1)
138 break;
139 last = ++addr;
140 }
141
142 if (archsw.arch_copyin("", last++, 1) != 1)
143 last = start;
144 return(last);
145 }
146
147 /*
148 * Copy module-related data into the load area, where it can be
149 * used as a directory for loaded modules.
150 *
151 * Module data is presented in a self-describing format. Each datum
152 * is preceded by a 32-bit identifier and a 32-bit size field.
153 *
154 * Currently, the following data are saved:
155 *
156 * MOD_NAME (variable) module name (string)
157 * MOD_TYPE (variable) module type (string)
158 * MOD_ARGS (variable) module parameters (string)
159 * MOD_ADDR sizeof(vm_offset_t) module load address
160 * MOD_SIZE sizeof(size_t) module size
161 * MOD_METADATA (variable) type-specific metadata
162 */
163 #define COPY32(v, a, c) { \
164 uint32_t x = (v); \
165 if (c) \
166 archsw.arch_copyin(&x, a, sizeof(x)); \
167 a += sizeof(x); \
168 }
169
170 #define MOD_STR(t, a, s, c) { \
171 COPY32(t, a, c); \
172 COPY32(strlen(s) + 1, a, c); \
173 if (c) \
174 archsw.arch_copyin(s, a, strlen(s) + 1); \
175 a += roundup(strlen(s) + 1, sizeof(u_long)); \
176 }
177
178 #define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c)
179 #define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c)
180 #define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c)
181
182 #define MOD_VAR(t, a, s, c) { \
183 COPY32(t, a, c); \
184 COPY32(sizeof(s), a, c); \
185 if (c) \
186 archsw.arch_copyin(&s, a, sizeof(s)); \
187 a += roundup(sizeof(s), sizeof(u_long)); \
188 }
189
190 #define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c)
191 #define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c)
192
193 #define MOD_METADATA(a, mm, c) { \
194 COPY32(MODINFO_METADATA | mm->md_type, a, c); \
195 COPY32(mm->md_size, a, c); \
196 if (c) \
197 archsw.arch_copyin(mm->md_data, a, mm->md_size); \
198 a += roundup(mm->md_size, sizeof(u_long)); \
199 }
200
201 #define MOD_END(a, c) { \
202 COPY32(MODINFO_END, a, c); \
203 COPY32(0, a, c); \
204 }
205
206 static vm_offset_t
bi_copymodules(vm_offset_t addr)207 bi_copymodules(vm_offset_t addr)
208 {
209 struct preloaded_file *fp;
210 struct file_metadata *md;
211 int c;
212 uint64_t v;
213
214 c = addr != 0;
215 /* Start with the first module on the list, should be the kernel. */
216 for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) {
217 MOD_NAME(addr, fp->f_name, c); /* This must come first. */
218 MOD_TYPE(addr, fp->f_type, c);
219 if (fp->f_args)
220 MOD_ARGS(addr, fp->f_args, c);
221 v = fp->f_addr;
222 MOD_ADDR(addr, v, c);
223 v = fp->f_size;
224 MOD_SIZE(addr, v, c);
225 for (md = fp->f_metadata; md != NULL; md = md->md_next)
226 if (!(md->md_type & MODINFOMD_NOCOPY))
227 MOD_METADATA(addr, md, c);
228 }
229 MOD_END(addr, c);
230 return(addr);
231 }
232
233 static int
bi_load_efi_data(struct preloaded_file * kfp)234 bi_load_efi_data(struct preloaded_file *kfp)
235 {
236 EFI_MEMORY_DESCRIPTOR *mm;
237 EFI_PHYSICAL_ADDRESS addr;
238 EFI_STATUS status;
239 size_t efisz;
240 UINTN efi_mapkey;
241 UINTN mmsz, pages, retry, sz;
242 UINT32 mmver;
243 struct efi_map_header *efihdr;
244
245 #if defined(__x86_64__)
246 struct efi_fb efifb;
247 int colordepth;
248
249 if (efi_find_framebuffer(&efifb) == 0) {
250 printf("EFI framebuffer information:\n");
251 printf("addr, size 0x%lx, 0x%lx\n", efifb.fb_addr,
252 efifb.fb_size);
253 printf("dimensions %d x %d\n", efifb.fb_width,
254 efifb.fb_height);
255 printf("stride %d\n", efifb.fb_stride);
256 printf("masks 0x%08x, 0x%08x, 0x%08x, 0x%08x\n",
257 efifb.fb_mask_red, efifb.fb_mask_green, efifb.fb_mask_blue,
258 efifb.fb_mask_reserved);
259
260 colordepth = efi_framebuffer_bpp(&efifb);
261 if (colordepth != 24 && colordepth != 32) {
262 printf("Unsupported framebuffer format: depth=%d\n",
263 colordepth);
264 return (EINVAL);
265 } else {
266 file_addmetadata(kfp, MODINFOMD_EFI_FB, sizeof(efifb),
267 &efifb);
268 }
269 }
270 #endif
271
272 efisz = (sizeof(struct efi_map_header) + 0xf) & ~0xf;
273
274 /*
275 * It is possible that the first call to ExitBootServices may change
276 * the map key. Fetch a new map key and retry ExitBootServices in that
277 * case.
278 */
279 for (retry = 2; retry > 0; retry--) {
280 /*
281 * Allocate enough pages to hold the bootinfo block and the
282 * memory map EFI will return to us. The memory map has an
283 * unknown size, so we have to determine that first. Note that
284 * the AllocatePages call can itself modify the memory map, so
285 * we have to take that into account as well. The changes to
286 * the memory map are caused by splitting a range of free
287 * memory into two (AFAICT), so that one is marked as being
288 * loader data.
289 */
290 sz = 0;
291 BS->GetMemoryMap(&sz, NULL, &efi_mapkey, &mmsz, &mmver);
292 sz += mmsz;
293 sz = (sz + 0xf) & ~0xf;
294 pages = EFI_SIZE_TO_PAGES(sz + efisz);
295 status = BS->AllocatePages(AllocateAnyPages, EfiLoaderData,
296 pages, &addr);
297 if (EFI_ERROR(status)) {
298 printf("%s: AllocatePages error %llu\n", __func__,
299 status);
300 return (ENOMEM);
301 }
302
303 /*
304 * Read the memory map and stash it after bootinfo. Align the
305 * memory map on a 16-byte boundary (the bootinfo block is page
306 * aligned).
307 */
308 efihdr = (struct efi_map_header *)addr;
309 mm = (void *)((uint8_t *)efihdr + efisz);
310 sz = (EFI_PAGE_SIZE * pages) - efisz;
311
312 status = BS->GetMemoryMap(&sz, mm, &efi_mapkey, &mmsz, &mmver);
313 if (EFI_ERROR(status)) {
314 printf("%s: GetMemoryMap error %llu\n", __func__,
315 status);
316 return (EINVAL);
317 }
318 status = BS->ExitBootServices(IH, efi_mapkey);
319 if (EFI_ERROR(status) == 0) {
320 efihdr->memory_size = sz;
321 efihdr->descriptor_size = mmsz;
322 efihdr->descriptor_version = mmver;
323 file_addmetadata(kfp, MODINFOMD_EFI_MAP, efisz + sz,
324 efihdr);
325 return (0);
326 }
327 BS->FreePages(addr, pages);
328 }
329 printf("ExitBootServices error %llu\n", status);
330 return (EINVAL);
331 }
332
333 /*
334 * Load the information expected by an amd64 kernel.
335 *
336 * - The 'boothowto' argument is constructed.
337 * - The 'bootdev' argument is constructed.
338 * - The 'bootinfo' struct is constructed, and copied into the kernel space.
339 * - The kernel environment is copied into kernel space.
340 * - Module metadata are formatted and placed in kernel space.
341 */
342 int
bi_load(char * args,vm_offset_t * modulep,vm_offset_t * kernendp)343 bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp)
344 {
345 struct preloaded_file *xp, *kfp;
346 struct devdesc *rootdev;
347 struct file_metadata *md;
348 vm_offset_t addr;
349 uint64_t kernend;
350 uint64_t envp;
351 vm_offset_t size;
352 char *rootdevname;
353 int howto;
354
355 howto = bi_getboothowto(args);
356
357 /*
358 * Allow the environment variable 'rootdev' to override the supplied
359 * device. This should perhaps go to MI code and/or have $rootdev
360 * tested/set by MI code before launching the kernel.
361 */
362 rootdevname = getenv("rootdev");
363 archsw.arch_getdev((void**)(&rootdev), rootdevname, NULL);
364 if (rootdev == NULL) {
365 printf("Can't determine root device.\n");
366 return(EINVAL);
367 }
368
369 /* Try reading the /etc/fstab file to select the root device */
370 getrootmount(efi_fmtdev((void *)rootdev));
371
372 addr = 0;
373 for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
374 if (addr < (xp->f_addr + xp->f_size))
375 addr = xp->f_addr + xp->f_size;
376 }
377
378 /* Pad to a page boundary. */
379 addr = roundup(addr, PAGE_SIZE);
380
381 /* Copy our environment. */
382 envp = addr;
383 addr = bi_copyenv(addr);
384
385 /* Pad to a page boundary. */
386 addr = roundup(addr, PAGE_SIZE);
387
388 kfp = file_findfile(NULL, "elf kernel");
389 if (kfp == NULL)
390 kfp = file_findfile(NULL, "elf64 kernel");
391 if (kfp == NULL)
392 panic("can't find kernel file");
393 kernend = 0; /* fill it in later */
394 file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto);
395 file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp);
396 file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend);
397 file_addmetadata(kfp, MODINFOMD_FW_HANDLE, sizeof ST, &ST);
398
399 bi_load_efi_data(kfp);
400
401 /* Figure out the size and location of the metadata. */
402 *modulep = addr;
403 size = bi_copymodules(0);
404 kernend = roundup(addr + size, PAGE_SIZE);
405 *kernendp = kernend;
406
407 /* patch MODINFOMD_KERNEND */
408 md = file_findmetadata(kfp, MODINFOMD_KERNEND);
409 bcopy(&kernend, md->md_data, sizeof kernend);
410
411 /* Copy module list and metadata. */
412 (void)bi_copymodules(addr);
413
414 return (0);
415 }
416