]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/boot/efi/boot.c
Merge pull request #7154 from keszybz/bootspec
[thirdparty/systemd.git] / src / boot / efi / boot.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2 /*
3 * This program is free software; you can redistribute it and/or modify it
4 * under the terms of the GNU Lesser General Public License as published by
5 * the Free Software Foundation; either version 2.1 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
12 *
13 * Copyright (C) 2012-2015 Kay Sievers <kay@vrfy.org>
14 * Copyright (C) 2012-2015 Harald Hoyer <harald@redhat.com>
15 */
16
17 #include <efi.h>
18 #include <efilib.h>
19
20 #include "console.h"
21 #include "disk.h"
22 #include "graphics.h"
23 #include "linux.h"
24 #include "measure.h"
25 #include "pe.h"
26 #include "shim.h"
27 #include "util.h"
28
29 #ifndef EFI_OS_INDICATIONS_BOOT_TO_FW_UI
30 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001ULL
31 #endif
32
33 /* magic string to find in the binary image */
34 static const char __attribute__((used)) magic[] = "#### LoaderInfo: systemd-boot " PACKAGE_VERSION " ####";
35
36 static const EFI_GUID global_guid = EFI_GLOBAL_VARIABLE;
37
38 enum loader_type {
39 LOADER_UNDEFINED,
40 LOADER_EFI,
41 LOADER_LINUX
42 };
43
44 typedef struct {
45 CHAR16 *file;
46 CHAR16 *title_show;
47 CHAR16 *title;
48 CHAR16 *version;
49 CHAR16 *machine_id;
50 EFI_HANDLE *device;
51 enum loader_type type;
52 CHAR16 *loader;
53 CHAR16 *options;
54 CHAR16 key;
55 EFI_STATUS (*call)(VOID);
56 BOOLEAN no_autoselect;
57 BOOLEAN non_unique;
58 } ConfigEntry;
59
60 typedef struct {
61 ConfigEntry **entries;
62 UINTN entry_count;
63 INTN idx_default;
64 INTN idx_default_efivar;
65 UINTN timeout_sec;
66 UINTN timeout_sec_config;
67 INTN timeout_sec_efivar;
68 CHAR16 *entry_default_pattern;
69 CHAR16 *entry_oneshot;
70 CHAR16 *options_edit;
71 BOOLEAN no_editor;
72 } Config;
73
74 static VOID cursor_left(UINTN *cursor, UINTN *first) {
75 if ((*cursor) > 0)
76 (*cursor)--;
77 else if ((*first) > 0)
78 (*first)--;
79 }
80
81 static VOID cursor_right(UINTN *cursor, UINTN *first, UINTN x_max, UINTN len) {
82 if ((*cursor)+1 < x_max)
83 (*cursor)++;
84 else if ((*first) + (*cursor) < len)
85 (*first)++;
86 }
87
88 static BOOLEAN line_edit(CHAR16 *line_in, CHAR16 **line_out, UINTN x_max, UINTN y_pos) {
89 CHAR16 *line;
90 UINTN size;
91 UINTN len;
92 UINTN first;
93 CHAR16 *print;
94 UINTN cursor;
95 UINTN clear;
96 BOOLEAN exit;
97 BOOLEAN enter;
98
99 if (!line_in)
100 line_in = L"";
101 size = StrLen(line_in) + 1024;
102 line = AllocatePool(size * sizeof(CHAR16));
103 StrCpy(line, line_in);
104 len = StrLen(line);
105 print = AllocatePool((x_max+1) * sizeof(CHAR16));
106
107 uefi_call_wrapper(ST->ConOut->EnableCursor, 2, ST->ConOut, TRUE);
108
109 first = 0;
110 cursor = 0;
111 clear = 0;
112 enter = FALSE;
113 exit = FALSE;
114 while (!exit) {
115 EFI_STATUS err;
116 UINT64 key;
117 UINTN i;
118
119 i = len - first;
120 if (i >= x_max-1)
121 i = x_max-1;
122 CopyMem(print, line + first, i * sizeof(CHAR16));
123 while (clear > 0 && i < x_max-1) {
124 clear--;
125 print[i++] = ' ';
126 }
127 print[i] = '\0';
128
129 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_pos);
130 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, print);
131 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, cursor, y_pos);
132
133 err = console_key_read(&key, TRUE);
134 if (EFI_ERROR(err))
135 continue;
136
137 switch (key) {
138 case KEYPRESS(0, SCAN_ESC, 0):
139 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'c'):
140 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'g'):
141 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('c')):
142 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('g')):
143 exit = TRUE;
144 break;
145
146 case KEYPRESS(0, SCAN_HOME, 0):
147 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'a'):
148 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('a')):
149 /* beginning-of-line */
150 cursor = 0;
151 first = 0;
152 continue;
153
154 case KEYPRESS(0, SCAN_END, 0):
155 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'e'):
156 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('e')):
157 /* end-of-line */
158 cursor = len - first;
159 if (cursor+1 >= x_max) {
160 cursor = x_max-1;
161 first = len - (x_max-1);
162 }
163 continue;
164
165 case KEYPRESS(0, SCAN_DOWN, 0):
166 case KEYPRESS(EFI_ALT_PRESSED, 0, 'f'):
167 case KEYPRESS(EFI_CONTROL_PRESSED, SCAN_RIGHT, 0):
168 /* forward-word */
169 while (line[first + cursor] && line[first + cursor] == ' ')
170 cursor_right(&cursor, &first, x_max, len);
171 while (line[first + cursor] && line[first + cursor] != ' ')
172 cursor_right(&cursor, &first, x_max, len);
173 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, cursor, y_pos);
174 continue;
175
176 case KEYPRESS(0, SCAN_UP, 0):
177 case KEYPRESS(EFI_ALT_PRESSED, 0, 'b'):
178 case KEYPRESS(EFI_CONTROL_PRESSED, SCAN_LEFT, 0):
179 /* backward-word */
180 if ((first + cursor) > 0 && line[first + cursor-1] == ' ') {
181 cursor_left(&cursor, &first);
182 while ((first + cursor) > 0 && line[first + cursor] == ' ')
183 cursor_left(&cursor, &first);
184 }
185 while ((first + cursor) > 0 && line[first + cursor-1] != ' ')
186 cursor_left(&cursor, &first);
187 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, cursor, y_pos);
188 continue;
189
190 case KEYPRESS(0, SCAN_RIGHT, 0):
191 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'f'):
192 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('f')):
193 /* forward-char */
194 if (first + cursor == len)
195 continue;
196 cursor_right(&cursor, &first, x_max, len);
197 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, cursor, y_pos);
198 continue;
199
200 case KEYPRESS(0, SCAN_LEFT, 0):
201 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'b'):
202 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('b')):
203 /* backward-char */
204 cursor_left(&cursor, &first);
205 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, cursor, y_pos);
206 continue;
207
208 case KEYPRESS(EFI_ALT_PRESSED, 0, 'd'):
209 /* kill-word */
210 clear = 0;
211 for (i = first + cursor; i < len && line[i] == ' '; i++)
212 clear++;
213 for (; i < len && line[i] != ' '; i++)
214 clear++;
215
216 for (i = first + cursor; i + clear < len; i++)
217 line[i] = line[i + clear];
218 len -= clear;
219 line[len] = '\0';
220 continue;
221
222 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'w'):
223 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('w')):
224 case KEYPRESS(EFI_ALT_PRESSED, 0, CHAR_BACKSPACE):
225 /* backward-kill-word */
226 clear = 0;
227 if ((first + cursor) > 0 && line[first + cursor-1] == ' ') {
228 cursor_left(&cursor, &first);
229 clear++;
230 while ((first + cursor) > 0 && line[first + cursor] == ' ') {
231 cursor_left(&cursor, &first);
232 clear++;
233 }
234 }
235 while ((first + cursor) > 0 && line[first + cursor-1] != ' ') {
236 cursor_left(&cursor, &first);
237 clear++;
238 }
239 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, cursor, y_pos);
240
241 for (i = first + cursor; i + clear < len; i++)
242 line[i] = line[i + clear];
243 len -= clear;
244 line[len] = '\0';
245 continue;
246
247 case KEYPRESS(0, SCAN_DELETE, 0):
248 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'd'):
249 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('d')):
250 if (len == 0)
251 continue;
252 if (first + cursor == len)
253 continue;
254 for (i = first + cursor; i < len; i++)
255 line[i] = line[i+1];
256 clear = 1;
257 len--;
258 continue;
259
260 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'k'):
261 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('k')):
262 /* kill-line */
263 line[first + cursor] = '\0';
264 clear = len - (first + cursor);
265 len = first + cursor;
266 continue;
267
268 case KEYPRESS(0, 0, CHAR_LINEFEED):
269 case KEYPRESS(0, 0, CHAR_CARRIAGE_RETURN):
270 if (StrCmp(line, line_in) != 0) {
271 *line_out = line;
272 line = NULL;
273 }
274 enter = TRUE;
275 exit = TRUE;
276 break;
277
278 case KEYPRESS(0, 0, CHAR_BACKSPACE):
279 if (len == 0)
280 continue;
281 if (first == 0 && cursor == 0)
282 continue;
283 for (i = first + cursor-1; i < len; i++)
284 line[i] = line[i+1];
285 clear = 1;
286 len--;
287 if (cursor > 0)
288 cursor--;
289 if (cursor > 0 || first == 0)
290 continue;
291 /* show full line if it fits */
292 if (len < x_max) {
293 cursor = first;
294 first = 0;
295 continue;
296 }
297 /* jump left to see what we delete */
298 if (first > 10) {
299 first -= 10;
300 cursor = 10;
301 } else {
302 cursor = first;
303 first = 0;
304 }
305 continue;
306
307 case KEYPRESS(0, 0, ' ') ... KEYPRESS(0, 0, '~'):
308 case KEYPRESS(0, 0, 0x80) ... KEYPRESS(0, 0, 0xffff):
309 if (len+1 == size)
310 continue;
311 for (i = len; i > first + cursor; i--)
312 line[i] = line[i-1];
313 line[first + cursor] = KEYCHAR(key);
314 len++;
315 line[len] = '\0';
316 if (cursor+1 < x_max)
317 cursor++;
318 else if (first + cursor < len)
319 first++;
320 continue;
321 }
322 }
323
324 uefi_call_wrapper(ST->ConOut->EnableCursor, 2, ST->ConOut, FALSE);
325 FreePool(print);
326 FreePool(line);
327 return enter;
328 }
329
330 static UINTN entry_lookup_key(Config *config, UINTN start, CHAR16 key) {
331 UINTN i;
332
333 if (key == 0)
334 return -1;
335
336 /* select entry by number key */
337 if (key >= '1' && key <= '9') {
338 i = key - '0';
339 if (i > config->entry_count)
340 i = config->entry_count;
341 return i-1;
342 }
343
344 /* find matching key in config entries */
345 for (i = start; i < config->entry_count; i++)
346 if (config->entries[i]->key == key)
347 return i;
348
349 for (i = 0; i < start; i++)
350 if (config->entries[i]->key == key)
351 return i;
352
353 return -1;
354 }
355
356 static VOID print_status(Config *config, CHAR16 *loaded_image_path) {
357 UINT64 key;
358 UINTN i;
359 CHAR16 *s;
360 CHAR8 *b;
361 UINTN x;
362 UINTN y;
363 UINTN size;
364
365 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_LIGHTGRAY|EFI_BACKGROUND_BLACK);
366 uefi_call_wrapper(ST->ConOut->ClearScreen, 1, ST->ConOut);
367
368 Print(L"systemd-boot version: " PACKAGE_VERSION "\n");
369 Print(L"architecture: " EFI_MACHINE_TYPE_NAME "\n");
370 Print(L"loaded image: %s\n", loaded_image_path);
371 Print(L"UEFI specification: %d.%02d\n", ST->Hdr.Revision >> 16, ST->Hdr.Revision & 0xffff);
372 Print(L"firmware vendor: %s\n", ST->FirmwareVendor);
373 Print(L"firmware version: %d.%02d\n", ST->FirmwareRevision >> 16, ST->FirmwareRevision & 0xffff);
374
375 if (uefi_call_wrapper(ST->ConOut->QueryMode, 4, ST->ConOut, ST->ConOut->Mode->Mode, &x, &y) == EFI_SUCCESS)
376 Print(L"console size: %d x %d\n", x, y);
377
378 if (efivar_get_raw(&global_guid, L"SecureBoot", &b, &size) == EFI_SUCCESS) {
379 Print(L"SecureBoot: %s\n", yes_no(*b > 0));
380 FreePool(b);
381 }
382
383 if (efivar_get_raw(&global_guid, L"SetupMode", &b, &size) == EFI_SUCCESS) {
384 Print(L"SetupMode: %s\n", *b > 0 ? L"setup" : L"user");
385 FreePool(b);
386 }
387
388 if (shim_loaded())
389 Print(L"Shim: present\n");
390
391 if (efivar_get_raw(&global_guid, L"OsIndicationsSupported", &b, &size) == EFI_SUCCESS) {
392 Print(L"OsIndicationsSupported: %d\n", (UINT64)*b);
393 FreePool(b);
394 }
395 Print(L"\n");
396
397 Print(L"timeout: %d\n", config->timeout_sec);
398 if (config->timeout_sec_efivar >= 0)
399 Print(L"timeout (EFI var): %d\n", config->timeout_sec_efivar);
400 Print(L"timeout (config): %d\n", config->timeout_sec_config);
401 if (config->entry_default_pattern)
402 Print(L"default pattern: '%s'\n", config->entry_default_pattern);
403 Print(L"editor: %s\n", yes_no(!config->no_editor));
404 Print(L"\n");
405
406 Print(L"config entry count: %d\n", config->entry_count);
407 Print(L"entry selected idx: %d\n", config->idx_default);
408 if (config->idx_default_efivar >= 0)
409 Print(L"entry EFI var idx: %d\n", config->idx_default_efivar);
410 Print(L"\n");
411
412 if (efivar_get_int(L"LoaderConfigTimeout", &i) == EFI_SUCCESS)
413 Print(L"LoaderConfigTimeout: %d\n", i);
414 if (config->entry_oneshot)
415 Print(L"LoaderEntryOneShot: %s\n", config->entry_oneshot);
416 if (efivar_get(L"LoaderDevicePartUUID", &s) == EFI_SUCCESS) {
417 Print(L"LoaderDevicePartUUID: %s\n", s);
418 FreePool(s);
419 }
420 if (efivar_get(L"LoaderEntryDefault", &s) == EFI_SUCCESS) {
421 Print(L"LoaderEntryDefault: %s\n", s);
422 FreePool(s);
423 }
424
425 Print(L"\n--- press key ---\n\n");
426 console_key_read(&key, TRUE);
427
428 for (i = 0; i < config->entry_count; i++) {
429 ConfigEntry *entry;
430
431 if (key == KEYPRESS(0, SCAN_ESC, 0) || key == KEYPRESS(0, 0, 'q'))
432 break;
433
434 entry = config->entries[i];
435 Print(L"config entry: %d/%d\n", i+1, config->entry_count);
436 if (entry->file)
437 Print(L"file '%s'\n", entry->file);
438 Print(L"title show '%s'\n", entry->title_show);
439 if (entry->title)
440 Print(L"title '%s'\n", entry->title);
441 if (entry->version)
442 Print(L"version '%s'\n", entry->version);
443 if (entry->machine_id)
444 Print(L"machine-id '%s'\n", entry->machine_id);
445 if (entry->device) {
446 EFI_DEVICE_PATH *device_path;
447 CHAR16 *str;
448
449 device_path = DevicePathFromHandle(entry->device);
450 if (device_path) {
451 str = DevicePathToStr(device_path);
452 Print(L"device handle '%s'\n", str);
453 FreePool(str);
454 }
455 }
456 if (entry->loader)
457 Print(L"loader '%s'\n", entry->loader);
458 if (entry->options)
459 Print(L"options '%s'\n", entry->options);
460 Print(L"auto-select %s\n", yes_no(!entry->no_autoselect));
461 if (entry->call)
462 Print(L"internal call yes\n");
463
464 Print(L"\n--- press key ---\n\n");
465 console_key_read(&key, TRUE);
466 }
467
468 uefi_call_wrapper(ST->ConOut->ClearScreen, 1, ST->ConOut);
469 }
470
471 static BOOLEAN menu_run(Config *config, ConfigEntry **chosen_entry, CHAR16 *loaded_image_path) {
472 EFI_STATUS err;
473 UINTN visible_max;
474 UINTN idx_highlight;
475 UINTN idx_highlight_prev;
476 UINTN idx_first;
477 UINTN idx_last;
478 BOOLEAN refresh;
479 BOOLEAN highlight;
480 UINTN i;
481 UINTN line_width;
482 CHAR16 **lines;
483 UINTN x_start;
484 UINTN y_start;
485 UINTN x_max;
486 UINTN y_max;
487 CHAR16 *status;
488 CHAR16 *clearline;
489 INTN timeout_remain;
490 INT16 idx;
491 BOOLEAN exit = FALSE;
492 BOOLEAN run = TRUE;
493 BOOLEAN wait = FALSE;
494
495 graphics_mode(FALSE);
496 uefi_call_wrapper(ST->ConIn->Reset, 2, ST->ConIn, FALSE);
497 uefi_call_wrapper(ST->ConOut->EnableCursor, 2, ST->ConOut, FALSE);
498 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_LIGHTGRAY|EFI_BACKGROUND_BLACK);
499
500 /* draw a single character to make ClearScreen work on some firmware */
501 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, L" ");
502 uefi_call_wrapper(ST->ConOut->ClearScreen, 1, ST->ConOut);
503
504 err = uefi_call_wrapper(ST->ConOut->QueryMode, 4, ST->ConOut, ST->ConOut->Mode->Mode, &x_max, &y_max);
505 if (EFI_ERROR(err)) {
506 x_max = 80;
507 y_max = 25;
508 }
509
510 /* we check 10 times per second for a keystroke */
511 if (config->timeout_sec > 0)
512 timeout_remain = config->timeout_sec * 10;
513 else
514 timeout_remain = -1;
515
516 idx_highlight = config->idx_default;
517 idx_highlight_prev = 0;
518
519 visible_max = y_max - 2;
520
521 if ((UINTN)config->idx_default >= visible_max)
522 idx_first = config->idx_default-1;
523 else
524 idx_first = 0;
525
526 idx_last = idx_first + visible_max-1;
527
528 refresh = TRUE;
529 highlight = FALSE;
530
531 /* length of the longest entry */
532 line_width = 5;
533 for (i = 0; i < config->entry_count; i++) {
534 UINTN entry_len;
535
536 entry_len = StrLen(config->entries[i]->title_show);
537 if (line_width < entry_len)
538 line_width = entry_len;
539 }
540 if (line_width > x_max-6)
541 line_width = x_max-6;
542
543 /* offsets to center the entries on the screen */
544 x_start = (x_max - (line_width)) / 2;
545 if (config->entry_count < visible_max)
546 y_start = ((visible_max - config->entry_count) / 2) + 1;
547 else
548 y_start = 0;
549
550 /* menu entries title lines */
551 lines = AllocatePool(sizeof(CHAR16 *) * config->entry_count);
552 for (i = 0; i < config->entry_count; i++) {
553 UINTN j, k;
554
555 lines[i] = AllocatePool(((x_max+1) * sizeof(CHAR16)));
556 for (j = 0; j < x_start; j++)
557 lines[i][j] = ' ';
558
559 for (k = 0; config->entries[i]->title_show[k] != '\0' && j < x_max; j++, k++)
560 lines[i][j] = config->entries[i]->title_show[k];
561
562 for (; j < x_max; j++)
563 lines[i][j] = ' ';
564 lines[i][x_max] = '\0';
565 }
566
567 status = NULL;
568 clearline = AllocatePool((x_max+1) * sizeof(CHAR16));
569 for (i = 0; i < x_max; i++)
570 clearline[i] = ' ';
571 clearline[i] = 0;
572
573 while (!exit) {
574 UINT64 key;
575
576 if (refresh) {
577 for (i = 0; i < config->entry_count; i++) {
578 if (i < idx_first || i > idx_last)
579 continue;
580 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_start + i - idx_first);
581 if (i == idx_highlight)
582 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut,
583 EFI_BLACK|EFI_BACKGROUND_LIGHTGRAY);
584 else
585 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut,
586 EFI_LIGHTGRAY|EFI_BACKGROUND_BLACK);
587 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, lines[i]);
588 if ((INTN)i == config->idx_default_efivar) {
589 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, x_start-3, y_start + i - idx_first);
590 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, L"=>");
591 }
592 }
593 refresh = FALSE;
594 } else if (highlight) {
595 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_start + idx_highlight_prev - idx_first);
596 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_LIGHTGRAY|EFI_BACKGROUND_BLACK);
597 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, lines[idx_highlight_prev]);
598 if ((INTN)idx_highlight_prev == config->idx_default_efivar) {
599 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, x_start-3, y_start + idx_highlight_prev - idx_first);
600 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, L"=>");
601 }
602
603 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_start + idx_highlight - idx_first);
604 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_BLACK|EFI_BACKGROUND_LIGHTGRAY);
605 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, lines[idx_highlight]);
606 if ((INTN)idx_highlight == config->idx_default_efivar) {
607 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, x_start-3, y_start + idx_highlight - idx_first);
608 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, L"=>");
609 }
610 highlight = FALSE;
611 }
612
613 if (timeout_remain > 0) {
614 FreePool(status);
615 status = PoolPrint(L"Boot in %d sec.", (timeout_remain + 5) / 10);
616 }
617
618 /* print status at last line of screen */
619 if (status) {
620 UINTN len;
621 UINTN x;
622
623 /* center line */
624 len = StrLen(status);
625 if (len < x_max)
626 x = (x_max - len) / 2;
627 else
628 x = 0;
629 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_LIGHTGRAY|EFI_BACKGROUND_BLACK);
630 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_max-1);
631 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, clearline + (x_max - x));
632 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, status);
633 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, clearline+1 + x + len);
634 }
635
636 err = console_key_read(&key, wait);
637 if (EFI_ERROR(err)) {
638 /* timeout reached */
639 if (timeout_remain == 0) {
640 exit = TRUE;
641 break;
642 }
643
644 /* sleep and update status */
645 if (timeout_remain > 0) {
646 uefi_call_wrapper(BS->Stall, 1, 100 * 1000);
647 timeout_remain--;
648 continue;
649 }
650
651 /* timeout disabled, wait for next key */
652 wait = TRUE;
653 continue;
654 }
655
656 timeout_remain = -1;
657
658 /* clear status after keystroke */
659 if (status) {
660 FreePool(status);
661 status = NULL;
662 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_LIGHTGRAY|EFI_BACKGROUND_BLACK);
663 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_max-1);
664 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, clearline+1);
665 }
666
667 idx_highlight_prev = idx_highlight;
668
669 switch (key) {
670 case KEYPRESS(0, SCAN_UP, 0):
671 case KEYPRESS(0, 0, 'k'):
672 if (idx_highlight > 0)
673 idx_highlight--;
674 break;
675
676 case KEYPRESS(0, SCAN_DOWN, 0):
677 case KEYPRESS(0, 0, 'j'):
678 if (idx_highlight < config->entry_count-1)
679 idx_highlight++;
680 break;
681
682 case KEYPRESS(0, SCAN_HOME, 0):
683 case KEYPRESS(EFI_ALT_PRESSED, 0, '<'):
684 if (idx_highlight > 0) {
685 refresh = TRUE;
686 idx_highlight = 0;
687 }
688 break;
689
690 case KEYPRESS(0, SCAN_END, 0):
691 case KEYPRESS(EFI_ALT_PRESSED, 0, '>'):
692 if (idx_highlight < config->entry_count-1) {
693 refresh = TRUE;
694 idx_highlight = config->entry_count-1;
695 }
696 break;
697
698 case KEYPRESS(0, SCAN_PAGE_UP, 0):
699 if (idx_highlight > visible_max)
700 idx_highlight -= visible_max;
701 else
702 idx_highlight = 0;
703 break;
704
705 case KEYPRESS(0, SCAN_PAGE_DOWN, 0):
706 idx_highlight += visible_max;
707 if (idx_highlight > config->entry_count-1)
708 idx_highlight = config->entry_count-1;
709 break;
710
711 case KEYPRESS(0, 0, CHAR_LINEFEED):
712 case KEYPRESS(0, 0, CHAR_CARRIAGE_RETURN):
713 exit = TRUE;
714 break;
715
716 case KEYPRESS(0, SCAN_F1, 0):
717 case KEYPRESS(0, 0, 'h'):
718 case KEYPRESS(0, 0, '?'):
719 status = StrDuplicate(L"(d)efault, (t/T)timeout, (e)dit, (v)ersion (Q)uit (P)rint (h)elp");
720 break;
721
722 case KEYPRESS(0, 0, 'Q'):
723 exit = TRUE;
724 run = FALSE;
725 break;
726
727 case KEYPRESS(0, 0, 'd'):
728 if (config->idx_default_efivar != (INTN)idx_highlight) {
729 /* store the selected entry in a persistent EFI variable */
730 efivar_set(L"LoaderEntryDefault", config->entries[idx_highlight]->file, TRUE);
731 config->idx_default_efivar = idx_highlight;
732 status = StrDuplicate(L"Default boot entry selected.");
733 } else {
734 /* clear the default entry EFI variable */
735 efivar_set(L"LoaderEntryDefault", NULL, TRUE);
736 config->idx_default_efivar = -1;
737 status = StrDuplicate(L"Default boot entry cleared.");
738 }
739 refresh = TRUE;
740 break;
741
742 case KEYPRESS(0, 0, '-'):
743 case KEYPRESS(0, 0, 'T'):
744 if (config->timeout_sec_efivar > 0) {
745 config->timeout_sec_efivar--;
746 efivar_set_int(L"LoaderConfigTimeout", config->timeout_sec_efivar, TRUE);
747 if (config->timeout_sec_efivar > 0)
748 status = PoolPrint(L"Menu timeout set to %d sec.", config->timeout_sec_efivar);
749 else
750 status = StrDuplicate(L"Menu disabled. Hold down key at bootup to show menu.");
751 } else if (config->timeout_sec_efivar <= 0){
752 config->timeout_sec_efivar = -1;
753 efivar_set(L"LoaderConfigTimeout", NULL, TRUE);
754 if (config->timeout_sec_config > 0)
755 status = PoolPrint(L"Menu timeout of %d sec is defined by configuration file.",
756 config->timeout_sec_config);
757 else
758 status = StrDuplicate(L"Menu disabled. Hold down key at bootup to show menu.");
759 }
760 break;
761
762 case KEYPRESS(0, 0, '+'):
763 case KEYPRESS(0, 0, 't'):
764 if (config->timeout_sec_efivar == -1 && config->timeout_sec_config == 0)
765 config->timeout_sec_efivar++;
766 config->timeout_sec_efivar++;
767 efivar_set_int(L"LoaderConfigTimeout", config->timeout_sec_efivar, TRUE);
768 if (config->timeout_sec_efivar > 0)
769 status = PoolPrint(L"Menu timeout set to %d sec.",
770 config->timeout_sec_efivar);
771 else
772 status = StrDuplicate(L"Menu disabled. Hold down key at bootup to show menu.");
773 break;
774
775 case KEYPRESS(0, 0, 'e'):
776 /* only the options of configured entries can be edited */
777 if (config->no_editor || config->entries[idx_highlight]->type == LOADER_UNDEFINED)
778 break;
779 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_LIGHTGRAY|EFI_BACKGROUND_BLACK);
780 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_max-1);
781 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, clearline+1);
782 if (line_edit(config->entries[idx_highlight]->options, &config->options_edit, x_max-1, y_max-1))
783 exit = TRUE;
784 uefi_call_wrapper(ST->ConOut->SetCursorPosition, 3, ST->ConOut, 0, y_max-1);
785 uefi_call_wrapper(ST->ConOut->OutputString, 2, ST->ConOut, clearline+1);
786 break;
787
788 case KEYPRESS(0, 0, 'v'):
789 status = PoolPrint(L"systemd-boot " PACKAGE_VERSION " (" EFI_MACHINE_TYPE_NAME "), UEFI Specification %d.%02d, Vendor %s %d.%02d",
790 ST->Hdr.Revision >> 16, ST->Hdr.Revision & 0xffff,
791 ST->FirmwareVendor, ST->FirmwareRevision >> 16, ST->FirmwareRevision & 0xffff);
792 break;
793
794 case KEYPRESS(0, 0, 'P'):
795 print_status(config, loaded_image_path);
796 refresh = TRUE;
797 break;
798
799 case KEYPRESS(EFI_CONTROL_PRESSED, 0, 'l'):
800 case KEYPRESS(EFI_CONTROL_PRESSED, 0, CHAR_CTRL('l')):
801 refresh = TRUE;
802 break;
803
804 default:
805 /* jump with a hotkey directly to a matching entry */
806 idx = entry_lookup_key(config, idx_highlight+1, KEYCHAR(key));
807 if (idx < 0)
808 break;
809 idx_highlight = idx;
810 refresh = TRUE;
811 }
812
813 if (idx_highlight > idx_last) {
814 idx_last = idx_highlight;
815 idx_first = 1 + idx_highlight - visible_max;
816 refresh = TRUE;
817 } else if (idx_highlight < idx_first) {
818 idx_first = idx_highlight;
819 idx_last = idx_highlight + visible_max-1;
820 refresh = TRUE;
821 }
822
823 if (!refresh && idx_highlight != idx_highlight_prev)
824 highlight = TRUE;
825 }
826
827 *chosen_entry = config->entries[idx_highlight];
828
829 for (i = 0; i < config->entry_count; i++)
830 FreePool(lines[i]);
831 FreePool(lines);
832 FreePool(clearline);
833
834 uefi_call_wrapper(ST->ConOut->SetAttribute, 2, ST->ConOut, EFI_WHITE|EFI_BACKGROUND_BLACK);
835 uefi_call_wrapper(ST->ConOut->ClearScreen, 1, ST->ConOut);
836 return run;
837 }
838
839 static VOID config_add_entry(Config *config, ConfigEntry *entry) {
840 if ((config->entry_count & 15) == 0) {
841 UINTN i;
842
843 i = config->entry_count + 16;
844 if (config->entry_count == 0)
845 config->entries = AllocatePool(sizeof(VOID *) * i);
846 else
847 config->entries = ReallocatePool(config->entries,
848 sizeof(VOID *) * config->entry_count, sizeof(VOID *) * i);
849 }
850 config->entries[config->entry_count++] = entry;
851 }
852
853 static VOID config_entry_free(ConfigEntry *entry) {
854 FreePool(entry->title_show);
855 FreePool(entry->title);
856 FreePool(entry->machine_id);
857 FreePool(entry->loader);
858 FreePool(entry->options);
859 }
860
861 static BOOLEAN is_digit(CHAR16 c) {
862 return (c >= '0') && (c <= '9');
863 }
864
865 static UINTN c_order(CHAR16 c) {
866 if (c == '\0')
867 return 0;
868 if (is_digit(c))
869 return 0;
870 else if ((c >= 'a') && (c <= 'z'))
871 return c;
872 else
873 return c + 0x10000;
874 }
875
876 static INTN str_verscmp(CHAR16 *s1, CHAR16 *s2) {
877 CHAR16 *os1 = s1;
878 CHAR16 *os2 = s2;
879
880 while (*s1 || *s2) {
881 INTN first;
882
883 while ((*s1 && !is_digit(*s1)) || (*s2 && !is_digit(*s2))) {
884 INTN order;
885
886 order = c_order(*s1) - c_order(*s2);
887 if (order)
888 return order;
889 s1++;
890 s2++;
891 }
892
893 while (*s1 == '0')
894 s1++;
895 while (*s2 == '0')
896 s2++;
897
898 first = 0;
899 while (is_digit(*s1) && is_digit(*s2)) {
900 if (first == 0)
901 first = *s1 - *s2;
902 s1++;
903 s2++;
904 }
905
906 if (is_digit(*s1))
907 return 1;
908 if (is_digit(*s2))
909 return -1;
910
911 if (first)
912 return first;
913 }
914
915 return StrCmp(os1, os2);
916 }
917
918 static CHAR8 *line_get_key_value(CHAR8 *content, CHAR8 *sep, UINTN *pos, CHAR8 **key_ret, CHAR8 **value_ret) {
919 CHAR8 *line;
920 UINTN linelen;
921 CHAR8 *value;
922
923 skip:
924 line = content + *pos;
925 if (*line == '\0')
926 return NULL;
927
928 linelen = 0;
929 while (line[linelen] && !strchra((CHAR8 *)"\n\r", line[linelen]))
930 linelen++;
931
932 /* move pos to next line */
933 *pos += linelen;
934 if (content[*pos])
935 (*pos)++;
936
937 /* empty line */
938 if (linelen == 0)
939 goto skip;
940
941 /* terminate line */
942 line[linelen] = '\0';
943
944 /* remove leading whitespace */
945 while (strchra((CHAR8 *)" \t", *line)) {
946 line++;
947 linelen--;
948 }
949
950 /* remove trailing whitespace */
951 while (linelen > 0 && strchra(sep, line[linelen-1]))
952 linelen--;
953 line[linelen] = '\0';
954
955 if (*line == '#')
956 goto skip;
957
958 /* split key/value */
959 value = line;
960 while (*value && !strchra(sep, *value))
961 value++;
962 if (*value == '\0')
963 goto skip;
964 *value = '\0';
965 value++;
966 while (*value && strchra(sep, *value))
967 value++;
968
969 /* unquote */
970 if (value[0] == '\"' && line[linelen-1] == '\"') {
971 value++;
972 line[linelen-1] = '\0';
973 }
974
975 *key_ret = line;
976 *value_ret = value;
977 return line;
978 }
979
980 static VOID config_defaults_load_from_file(Config *config, CHAR8 *content) {
981 CHAR8 *line;
982 UINTN pos = 0;
983 CHAR8 *key, *value;
984
985 line = content;
986 while ((line = line_get_key_value(content, (CHAR8 *)" \t", &pos, &key, &value))) {
987 if (strcmpa((CHAR8 *)"timeout", key) == 0) {
988 CHAR16 *s;
989
990 s = stra_to_str(value);
991 config->timeout_sec_config = Atoi(s);
992 config->timeout_sec = config->timeout_sec_config;
993 FreePool(s);
994 continue;
995 }
996
997 if (strcmpa((CHAR8 *)"default", key) == 0) {
998 FreePool(config->entry_default_pattern);
999 config->entry_default_pattern = stra_to_str(value);
1000 StrLwr(config->entry_default_pattern);
1001 continue;
1002 }
1003
1004 if (strcmpa((CHAR8 *)"editor", key) == 0) {
1005 BOOLEAN on;
1006
1007 if (EFI_ERROR(parse_boolean(value, &on)))
1008 continue;
1009 config->no_editor = !on;
1010 }
1011 }
1012 }
1013
1014 static VOID config_entry_add_from_file(Config *config, EFI_HANDLE *device, CHAR16 *file, CHAR8 *content, CHAR16 *loaded_image_path) {
1015 ConfigEntry *entry;
1016 CHAR8 *line;
1017 UINTN pos = 0;
1018 CHAR8 *key, *value;
1019 UINTN len;
1020 CHAR16 *initrd = NULL;
1021
1022 entry = AllocateZeroPool(sizeof(ConfigEntry));
1023
1024 line = content;
1025 while ((line = line_get_key_value(content, (CHAR8 *)" \t", &pos, &key, &value))) {
1026 if (strcmpa((CHAR8 *)"title", key) == 0) {
1027 FreePool(entry->title);
1028 entry->title = stra_to_str(value);
1029 continue;
1030 }
1031
1032 if (strcmpa((CHAR8 *)"version", key) == 0) {
1033 FreePool(entry->version);
1034 entry->version = stra_to_str(value);
1035 continue;
1036 }
1037
1038 if (strcmpa((CHAR8 *)"machine-id", key) == 0) {
1039 FreePool(entry->machine_id);
1040 entry->machine_id = stra_to_str(value);
1041 continue;
1042 }
1043
1044 if (strcmpa((CHAR8 *)"linux", key) == 0) {
1045 FreePool(entry->loader);
1046 entry->type = LOADER_LINUX;
1047 entry->loader = stra_to_path(value);
1048 entry->key = 'l';
1049 continue;
1050 }
1051
1052 if (strcmpa((CHAR8 *)"efi", key) == 0) {
1053 entry->type = LOADER_EFI;
1054 FreePool(entry->loader);
1055 entry->loader = stra_to_path(value);
1056
1057 /* do not add an entry for ourselves */
1058 if (StriCmp(entry->loader, loaded_image_path) == 0) {
1059 entry->type = LOADER_UNDEFINED;
1060 break;
1061 }
1062 continue;
1063 }
1064
1065 if (strcmpa((CHAR8 *)"architecture", key) == 0) {
1066 /* do not add an entry for an EFI image of architecture not matching with that of the image */
1067 if (strcmpa((CHAR8 *)EFI_MACHINE_TYPE_NAME, value) != 0) {
1068 entry->type = LOADER_UNDEFINED;
1069 break;
1070 }
1071 continue;
1072 }
1073
1074 if (strcmpa((CHAR8 *)"initrd", key) == 0) {
1075 CHAR16 *new;
1076
1077 new = stra_to_path(value);
1078 if (initrd) {
1079 CHAR16 *s;
1080
1081 s = PoolPrint(L"%s initrd=%s", initrd, new);
1082 FreePool(initrd);
1083 initrd = s;
1084 } else
1085 initrd = PoolPrint(L"initrd=%s", new);
1086 FreePool(new);
1087 continue;
1088 }
1089
1090 if (strcmpa((CHAR8 *)"options", key) == 0) {
1091 CHAR16 *new;
1092
1093 new = stra_to_str(value);
1094 if (entry->options) {
1095 CHAR16 *s;
1096
1097 s = PoolPrint(L"%s %s", entry->options, new);
1098 FreePool(entry->options);
1099 entry->options = s;
1100 } else {
1101 entry->options = new;
1102 new = NULL;
1103 }
1104 FreePool(new);
1105 continue;
1106 }
1107 }
1108
1109 if (entry->type == LOADER_UNDEFINED) {
1110 config_entry_free(entry);
1111 FreePool(initrd);
1112 FreePool(entry);
1113 return;
1114 }
1115
1116 /* add initrd= to options */
1117 if (entry->type == LOADER_LINUX && initrd) {
1118 if (entry->options) {
1119 CHAR16 *s;
1120
1121 s = PoolPrint(L"%s %s", initrd, entry->options);
1122 FreePool(entry->options);
1123 entry->options = s;
1124 } else {
1125 entry->options = initrd;
1126 initrd = NULL;
1127 }
1128 }
1129 FreePool(initrd);
1130
1131 entry->device = device;
1132 entry->file = StrDuplicate(file);
1133 len = StrLen(entry->file);
1134 /* remove ".conf" */
1135 if (len > 5)
1136 entry->file[len - 5] = '\0';
1137 StrLwr(entry->file);
1138
1139 config_add_entry(config, entry);
1140 }
1141
1142 static VOID config_load_defaults(Config *config, EFI_FILE *root_dir) {
1143 CHAR8 *content = NULL;
1144 UINTN sec;
1145 UINTN len;
1146 EFI_STATUS err;
1147
1148 len = file_read(root_dir, L"\\loader\\loader.conf", 0, 0, &content);
1149 if (len > 0)
1150 config_defaults_load_from_file(config, content);
1151 FreePool(content);
1152
1153 err = efivar_get_int(L"LoaderConfigTimeout", &sec);
1154 if (!EFI_ERROR(err)) {
1155 config->timeout_sec_efivar = sec;
1156 config->timeout_sec = sec;
1157 } else
1158 config->timeout_sec_efivar = -1;
1159 }
1160
1161 static VOID config_load_entries(Config *config, EFI_HANDLE *device, EFI_FILE *root_dir, CHAR16 *loaded_image_path) {
1162 EFI_FILE_HANDLE entries_dir;
1163 EFI_STATUS err;
1164
1165 err = uefi_call_wrapper(root_dir->Open, 5, root_dir, &entries_dir, L"\\loader\\entries", EFI_FILE_MODE_READ, 0ULL);
1166 if (!EFI_ERROR(err)) {
1167 for (;;) {
1168 CHAR16 buf[256];
1169 UINTN bufsize;
1170 EFI_FILE_INFO *f;
1171 CHAR8 *content = NULL;
1172 UINTN len;
1173
1174 bufsize = sizeof(buf);
1175 err = uefi_call_wrapper(entries_dir->Read, 3, entries_dir, &bufsize, buf);
1176 if (bufsize == 0 || EFI_ERROR(err))
1177 break;
1178
1179 f = (EFI_FILE_INFO *) buf;
1180 if (f->FileName[0] == '.')
1181 continue;
1182 if (f->Attribute & EFI_FILE_DIRECTORY)
1183 continue;
1184
1185 len = StrLen(f->FileName);
1186 if (len < 6)
1187 continue;
1188 if (StriCmp(f->FileName + len - 5, L".conf") != 0)
1189 continue;
1190 if (StrnCmp(f->FileName, L"auto-", 5) == 0)
1191 continue;
1192
1193 len = file_read(entries_dir, f->FileName, 0, 0, &content);
1194 if (len > 0)
1195 config_entry_add_from_file(config, device, f->FileName, content, loaded_image_path);
1196 FreePool(content);
1197 }
1198 uefi_call_wrapper(entries_dir->Close, 1, entries_dir);
1199 }
1200 }
1201
1202 static VOID config_sort_entries(Config *config) {
1203 UINTN i;
1204
1205 for (i = 1; i < config->entry_count; i++) {
1206 BOOLEAN more;
1207 UINTN k;
1208
1209 more = FALSE;
1210 for (k = 0; k < config->entry_count - i; k++) {
1211 ConfigEntry *entry;
1212
1213 if (str_verscmp(config->entries[k]->file, config->entries[k+1]->file) <= 0)
1214 continue;
1215 entry = config->entries[k];
1216 config->entries[k] = config->entries[k+1];
1217 config->entries[k+1] = entry;
1218 more = TRUE;
1219 }
1220 if (!more)
1221 break;
1222 }
1223 }
1224
1225 static VOID config_default_entry_select(Config *config) {
1226 CHAR16 *var;
1227 EFI_STATUS err;
1228 UINTN i;
1229
1230 /*
1231 * The EFI variable to specify a boot entry for the next, and only the
1232 * next reboot. The variable is always cleared directly after it is read.
1233 */
1234 err = efivar_get(L"LoaderEntryOneShot", &var);
1235 if (!EFI_ERROR(err)) {
1236 BOOLEAN found = FALSE;
1237
1238 for (i = 0; i < config->entry_count; i++) {
1239 if (StrCmp(config->entries[i]->file, var) == 0) {
1240 config->idx_default = i;
1241 found = TRUE;
1242 break;
1243 }
1244 }
1245
1246 config->entry_oneshot = StrDuplicate(var);
1247 efivar_set(L"LoaderEntryOneShot", NULL, TRUE);
1248 FreePool(var);
1249 if (found)
1250 return;
1251 }
1252
1253 /*
1254 * The EFI variable to select the default boot entry overrides the
1255 * configured pattern. The variable can be set and cleared by pressing
1256 * the 'd' key in the loader selection menu, the entry is marked with
1257 * an '*'.
1258 */
1259 err = efivar_get(L"LoaderEntryDefault", &var);
1260 if (!EFI_ERROR(err)) {
1261 BOOLEAN found = FALSE;
1262
1263 for (i = 0; i < config->entry_count; i++) {
1264 if (StrCmp(config->entries[i]->file, var) == 0) {
1265 config->idx_default = i;
1266 config->idx_default_efivar = i;
1267 found = TRUE;
1268 break;
1269 }
1270 }
1271 FreePool(var);
1272 if (found)
1273 return;
1274 }
1275 config->idx_default_efivar = -1;
1276
1277 if (config->entry_count == 0)
1278 return;
1279
1280 /*
1281 * Match the pattern from the end of the list to the start, find last
1282 * entry (largest number) matching the given pattern.
1283 */
1284 if (config->entry_default_pattern) {
1285 i = config->entry_count;
1286 while (i--) {
1287 if (config->entries[i]->no_autoselect)
1288 continue;
1289 if (MetaiMatch(config->entries[i]->file, config->entry_default_pattern)) {
1290 config->idx_default = i;
1291 return;
1292 }
1293 }
1294 }
1295
1296 /* select the last suitable entry */
1297 i = config->entry_count;
1298 while (i--) {
1299 if (config->entries[i]->no_autoselect)
1300 continue;
1301 config->idx_default = i;
1302 return;
1303 }
1304
1305 /* no entry found */
1306 config->idx_default = -1;
1307 }
1308
1309 static BOOLEAN find_nonunique(ConfigEntry **entries, UINTN entry_count) {
1310 BOOLEAN non_unique = FALSE;
1311 UINTN i, k;
1312
1313 for (i = 0; i < entry_count; i++)
1314 entries[i]->non_unique = FALSE;
1315
1316 for (i = 0; i < entry_count; i++)
1317 for (k = 0; k < entry_count; k++) {
1318 if (i == k)
1319 continue;
1320 if (StrCmp(entries[i]->title_show, entries[k]->title_show) != 0)
1321 continue;
1322
1323 non_unique = entries[i]->non_unique = entries[k]->non_unique = TRUE;
1324 }
1325
1326 return non_unique;
1327 }
1328
1329 /* generate a unique title, avoiding non-distinguishable menu entries */
1330 static VOID config_title_generate(Config *config) {
1331 UINTN i;
1332
1333 /* set title */
1334 for (i = 0; i < config->entry_count; i++) {
1335 CHAR16 *title;
1336
1337 FreePool(config->entries[i]->title_show);
1338 title = config->entries[i]->title;
1339 if (!title)
1340 title = config->entries[i]->file;
1341 config->entries[i]->title_show = StrDuplicate(title);
1342 }
1343
1344 if (!find_nonunique(config->entries, config->entry_count))
1345 return;
1346
1347 /* add version to non-unique titles */
1348 for (i = 0; i < config->entry_count; i++) {
1349 CHAR16 *s;
1350
1351 if (!config->entries[i]->non_unique)
1352 continue;
1353 if (!config->entries[i]->version)
1354 continue;
1355
1356 s = PoolPrint(L"%s (%s)", config->entries[i]->title_show, config->entries[i]->version);
1357 FreePool(config->entries[i]->title_show);
1358 config->entries[i]->title_show = s;
1359 }
1360
1361 if (!find_nonunique(config->entries, config->entry_count))
1362 return;
1363
1364 /* add machine-id to non-unique titles */
1365 for (i = 0; i < config->entry_count; i++) {
1366 CHAR16 *s;
1367 CHAR16 *m;
1368
1369 if (!config->entries[i]->non_unique)
1370 continue;
1371 if (!config->entries[i]->machine_id)
1372 continue;
1373
1374 m = StrDuplicate(config->entries[i]->machine_id);
1375 m[8] = '\0';
1376 s = PoolPrint(L"%s (%s)", config->entries[i]->title_show, m);
1377 FreePool(config->entries[i]->title_show);
1378 config->entries[i]->title_show = s;
1379 FreePool(m);
1380 }
1381
1382 if (!find_nonunique(config->entries, config->entry_count))
1383 return;
1384
1385 /* add file name to non-unique titles */
1386 for (i = 0; i < config->entry_count; i++) {
1387 CHAR16 *s;
1388
1389 if (!config->entries[i]->non_unique)
1390 continue;
1391 s = PoolPrint(L"%s (%s)", config->entries[i]->title_show, config->entries[i]->file);
1392 FreePool(config->entries[i]->title_show);
1393 config->entries[i]->title_show = s;
1394 config->entries[i]->non_unique = FALSE;
1395 }
1396 }
1397
1398 static BOOLEAN config_entry_add_call(Config *config, CHAR16 *title, EFI_STATUS (*call)(VOID)) {
1399 ConfigEntry *entry;
1400
1401 entry = AllocateZeroPool(sizeof(ConfigEntry));
1402 entry->title = StrDuplicate(title);
1403 entry->call = call;
1404 entry->no_autoselect = TRUE;
1405 config_add_entry(config, entry);
1406 return TRUE;
1407 }
1408
1409 static ConfigEntry *config_entry_add_loader(Config *config, EFI_HANDLE *device,
1410 enum loader_type type,CHAR16 *file, CHAR16 key, CHAR16 *title, CHAR16 *loader) {
1411 ConfigEntry *entry;
1412
1413 entry = AllocateZeroPool(sizeof(ConfigEntry));
1414 entry->type = type;
1415 entry->title = StrDuplicate(title);
1416 entry->device = device;
1417 entry->loader = StrDuplicate(loader);
1418 entry->file = StrDuplicate(file);
1419 StrLwr(entry->file);
1420 entry->key = key;
1421 config_add_entry(config, entry);
1422
1423 return entry;
1424 }
1425
1426 static BOOLEAN config_entry_add_loader_auto(Config *config, EFI_HANDLE *device, EFI_FILE *root_dir, CHAR16 *loaded_image_path,
1427 CHAR16 *file, CHAR16 key, CHAR16 *title, CHAR16 *loader) {
1428 EFI_FILE_HANDLE handle;
1429 ConfigEntry *entry;
1430 EFI_STATUS err;
1431
1432 /* do not add an entry for ourselves */
1433 if (loaded_image_path && StriCmp(loader, loaded_image_path) == 0)
1434 return FALSE;
1435
1436 /* check existence */
1437 err = uefi_call_wrapper(root_dir->Open, 5, root_dir, &handle, loader, EFI_FILE_MODE_READ, 0ULL);
1438 if (EFI_ERROR(err))
1439 return FALSE;
1440 uefi_call_wrapper(handle->Close, 1, handle);
1441
1442 entry = config_entry_add_loader(config, device, LOADER_UNDEFINED, file, key, title, loader);
1443 if (!entry)
1444 return FALSE;
1445
1446 /* do not boot right away into auto-detected entries */
1447 entry->no_autoselect = TRUE;
1448
1449 return TRUE;
1450 }
1451
1452 static VOID config_entry_add_osx(Config *config) {
1453 EFI_STATUS err;
1454 UINTN handle_count = 0;
1455 EFI_HANDLE *handles = NULL;
1456
1457 err = LibLocateHandle(ByProtocol, &FileSystemProtocol, NULL, &handle_count, &handles);
1458 if (!EFI_ERROR(err)) {
1459 UINTN i;
1460
1461 for (i = 0; i < handle_count; i++) {
1462 EFI_FILE *root;
1463 BOOLEAN found;
1464
1465 root = LibOpenRoot(handles[i]);
1466 if (!root)
1467 continue;
1468 found = config_entry_add_loader_auto(config, handles[i], root, NULL, L"auto-osx", 'a', L"macOS",
1469 L"\\System\\Library\\CoreServices\\boot.efi");
1470 uefi_call_wrapper(root->Close, 1, root);
1471 if (found)
1472 break;
1473 }
1474
1475 FreePool(handles);
1476 }
1477 }
1478
1479 static VOID config_entry_add_linux( Config *config, EFI_LOADED_IMAGE *loaded_image, EFI_FILE *root_dir) {
1480 EFI_FILE_HANDLE linux_dir;
1481 EFI_STATUS err;
1482 ConfigEntry *entry;
1483
1484 err = uefi_call_wrapper(root_dir->Open, 5, root_dir, &linux_dir, L"\\EFI\\Linux", EFI_FILE_MODE_READ, 0ULL);
1485 if (!EFI_ERROR(err)) {
1486 for (;;) {
1487 CHAR16 buf[256];
1488 UINTN bufsize;
1489 EFI_FILE_INFO *f;
1490 CHAR8 *sections[] = {
1491 (UINT8 *)".osrel",
1492 (UINT8 *)".cmdline",
1493 NULL
1494 };
1495 UINTN offs[ELEMENTSOF(sections)-1] = {};
1496 UINTN szs[ELEMENTSOF(sections)-1] = {};
1497 UINTN addrs[ELEMENTSOF(sections)-1] = {};
1498 CHAR8 *content = NULL;
1499 UINTN len;
1500 CHAR8 *line;
1501 UINTN pos = 0;
1502 CHAR8 *key, *value;
1503 CHAR16 *os_name = NULL;
1504 CHAR16 *os_id = NULL;
1505 CHAR16 *os_version = NULL;
1506 CHAR16 *os_build = NULL;
1507
1508 bufsize = sizeof(buf);
1509 err = uefi_call_wrapper(linux_dir->Read, 3, linux_dir, &bufsize, buf);
1510 if (bufsize == 0 || EFI_ERROR(err))
1511 break;
1512
1513 f = (EFI_FILE_INFO *) buf;
1514 if (f->FileName[0] == '.')
1515 continue;
1516 if (f->Attribute & EFI_FILE_DIRECTORY)
1517 continue;
1518 len = StrLen(f->FileName);
1519 if (len < 5)
1520 continue;
1521 if (StriCmp(f->FileName + len - 4, L".efi") != 0)
1522 continue;
1523
1524 /* look for .osrel and .cmdline sections in the .efi binary */
1525 err = pe_file_locate_sections(linux_dir, f->FileName, sections, addrs, offs, szs);
1526 if (EFI_ERROR(err))
1527 continue;
1528
1529 len = file_read(linux_dir, f->FileName, offs[0], szs[0], &content);
1530 if (len <= 0)
1531 continue;
1532
1533 /* read properties from the embedded os-release file */
1534 line = content;
1535 while ((line = line_get_key_value(content, (CHAR8 *)"=", &pos, &key, &value))) {
1536 if (strcmpa((CHAR8 *)"PRETTY_NAME", key) == 0) {
1537 FreePool(os_name);
1538 os_name = stra_to_str(value);
1539 continue;
1540 }
1541
1542 if (strcmpa((CHAR8 *)"ID", key) == 0) {
1543 FreePool(os_id);
1544 os_id = stra_to_str(value);
1545 continue;
1546 }
1547
1548 if (strcmpa((CHAR8 *)"VERSION_ID", key) == 0) {
1549 FreePool(os_version);
1550 os_version = stra_to_str(value);
1551 continue;
1552 }
1553
1554 if (strcmpa((CHAR8 *)"BUILD_ID", key) == 0) {
1555 FreePool(os_build);
1556 os_build = stra_to_str(value);
1557 continue;
1558 }
1559 }
1560
1561 if (os_name && os_id && (os_version || os_build)) {
1562 CHAR16 *conf;
1563 CHAR16 *path;
1564 CHAR16 *cmdline;
1565
1566 conf = PoolPrint(L"%s-%s", os_id, os_version ? : os_build);
1567 path = PoolPrint(L"\\EFI\\Linux\\%s", f->FileName);
1568 entry = config_entry_add_loader(config, loaded_image->DeviceHandle, LOADER_LINUX, conf, 'l', os_name, path);
1569
1570 FreePool(content);
1571 /* read the embedded cmdline file */
1572 len = file_read(linux_dir, f->FileName, offs[1], szs[1] - 1 , &content);
1573 if (len > 0) {
1574 cmdline = stra_to_str(content);
1575 entry->options = cmdline;
1576 cmdline = NULL;
1577 }
1578 FreePool(cmdline);
1579 FreePool(conf);
1580 FreePool(path);
1581 }
1582
1583 FreePool(os_name);
1584 FreePool(os_id);
1585 FreePool(os_version);
1586 FreePool(os_build);
1587 FreePool(content);
1588 }
1589 uefi_call_wrapper(linux_dir->Close, 1, linux_dir);
1590 }
1591 }
1592
1593 static EFI_STATUS image_start(EFI_HANDLE parent_image, const Config *config, const ConfigEntry *entry) {
1594 EFI_HANDLE image;
1595 EFI_DEVICE_PATH *path;
1596 CHAR16 *options;
1597 EFI_STATUS err;
1598
1599 path = FileDevicePath(entry->device, entry->loader);
1600 if (!path) {
1601 Print(L"Error getting device path.");
1602 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1603 return EFI_INVALID_PARAMETER;
1604 }
1605
1606 err = uefi_call_wrapper(BS->LoadImage, 6, FALSE, parent_image, path, NULL, 0, &image);
1607 if (EFI_ERROR(err)) {
1608 Print(L"Error loading %s: %r", entry->loader, err);
1609 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1610 goto out;
1611 }
1612
1613 if (config->options_edit)
1614 options = config->options_edit;
1615 else if (entry->options)
1616 options = entry->options;
1617 else
1618 options = NULL;
1619 if (options) {
1620 EFI_LOADED_IMAGE *loaded_image;
1621
1622 err = uefi_call_wrapper(BS->OpenProtocol, 6, image, &LoadedImageProtocol, (VOID **)&loaded_image,
1623 parent_image, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
1624 if (EFI_ERROR(err)) {
1625 Print(L"Error getting LoadedImageProtocol handle: %r", err);
1626 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1627 goto out_unload;
1628 }
1629 loaded_image->LoadOptions = options;
1630 loaded_image->LoadOptionsSize = (StrLen(loaded_image->LoadOptions)+1) * sizeof(CHAR16);
1631
1632 #if ENABLE_TPM
1633 /* Try to log any options to the TPM, especially to catch manually edited options */
1634 err = tpm_log_event(SD_TPM_PCR,
1635 (EFI_PHYSICAL_ADDRESS) loaded_image->LoadOptions,
1636 loaded_image->LoadOptionsSize, loaded_image->LoadOptions);
1637 if (EFI_ERROR(err)) {
1638 Print(L"Unable to add image options measurement: %r", err);
1639 uefi_call_wrapper(BS->Stall, 1, 200 * 1000);
1640 }
1641 #endif
1642 }
1643
1644 efivar_set_time_usec(L"LoaderTimeExecUSec", 0);
1645 err = uefi_call_wrapper(BS->StartImage, 3, image, NULL, NULL);
1646 out_unload:
1647 uefi_call_wrapper(BS->UnloadImage, 1, image);
1648 out:
1649 FreePool(path);
1650 return err;
1651 }
1652
1653 static EFI_STATUS reboot_into_firmware(VOID) {
1654 CHAR8 *b;
1655 UINTN size;
1656 UINT64 osind;
1657 EFI_STATUS err;
1658
1659 osind = EFI_OS_INDICATIONS_BOOT_TO_FW_UI;
1660
1661 err = efivar_get_raw(&global_guid, L"OsIndications", &b, &size);
1662 if (!EFI_ERROR(err))
1663 osind |= (UINT64)*b;
1664 FreePool(b);
1665
1666 err = efivar_set_raw(&global_guid, L"OsIndications", (CHAR8 *)&osind, sizeof(UINT64), TRUE);
1667 if (EFI_ERROR(err))
1668 return err;
1669
1670 err = uefi_call_wrapper(RT->ResetSystem, 4, EfiResetCold, EFI_SUCCESS, 0, NULL);
1671 Print(L"Error calling ResetSystem: %r", err);
1672 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1673 return err;
1674 }
1675
1676 static VOID config_free(Config *config) {
1677 UINTN i;
1678
1679 for (i = 0; i < config->entry_count; i++)
1680 config_entry_free(config->entries[i]);
1681 FreePool(config->entries);
1682 FreePool(config->entry_default_pattern);
1683 FreePool(config->options_edit);
1684 FreePool(config->entry_oneshot);
1685 }
1686
1687 EFI_STATUS efi_main(EFI_HANDLE image, EFI_SYSTEM_TABLE *sys_table) {
1688 CHAR16 *s;
1689 CHAR8 *b;
1690 UINTN size;
1691 EFI_LOADED_IMAGE *loaded_image;
1692 EFI_FILE *root_dir;
1693 CHAR16 *loaded_image_path;
1694 EFI_STATUS err;
1695 Config config;
1696 UINT64 init_usec;
1697 BOOLEAN menu = FALSE;
1698 CHAR16 uuid[37];
1699
1700 InitializeLib(image, sys_table);
1701 init_usec = time_usec();
1702 efivar_set_time_usec(L"LoaderTimeInitUSec", init_usec);
1703 efivar_set(L"LoaderInfo", L"systemd-boot " PACKAGE_VERSION, FALSE);
1704 s = PoolPrint(L"%s %d.%02d", ST->FirmwareVendor, ST->FirmwareRevision >> 16, ST->FirmwareRevision & 0xffff);
1705 efivar_set(L"LoaderFirmwareInfo", s, FALSE);
1706 FreePool(s);
1707 s = PoolPrint(L"UEFI %d.%02d", ST->Hdr.Revision >> 16, ST->Hdr.Revision & 0xffff);
1708 efivar_set(L"LoaderFirmwareType", s, FALSE);
1709 FreePool(s);
1710
1711 err = uefi_call_wrapper(BS->OpenProtocol, 6, image, &LoadedImageProtocol, (VOID **)&loaded_image,
1712 image, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
1713 if (EFI_ERROR(err)) {
1714 Print(L"Error getting a LoadedImageProtocol handle: %r ", err);
1715 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1716 return err;
1717 }
1718
1719 /* export the device path this image is started from */
1720 if (disk_get_part_uuid(loaded_image->DeviceHandle, uuid) == EFI_SUCCESS)
1721 efivar_set(L"LoaderDevicePartUUID", uuid, FALSE);
1722
1723 root_dir = LibOpenRoot(loaded_image->DeviceHandle);
1724 if (!root_dir) {
1725 Print(L"Unable to open root directory: %r ", err);
1726 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1727 return EFI_LOAD_ERROR;
1728 }
1729
1730 if (secure_boot_enabled() && shim_loaded()) {
1731 err = security_policy_install();
1732 if (EFI_ERROR(err)) {
1733 Print(L"Error installing security policy: %r ", err);
1734 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1735 return err;
1736 }
1737 }
1738
1739 /* the filesystem path to this image, to prevent adding ourselves to the menu */
1740 loaded_image_path = DevicePathToStr(loaded_image->FilePath);
1741 efivar_set(L"LoaderImageIdentifier", loaded_image_path, FALSE);
1742
1743 ZeroMem(&config, sizeof(Config));
1744 config_load_defaults(&config, root_dir);
1745
1746 /* scan /EFI/Linux/ directory */
1747 config_entry_add_linux(&config, loaded_image, root_dir);
1748
1749 /* scan /loader/entries/\*.conf files */
1750 config_load_entries(&config, loaded_image->DeviceHandle, root_dir, loaded_image_path);
1751
1752 /* sort entries after version number */
1753 config_sort_entries(&config);
1754
1755 /* if we find some well-known loaders, add them to the end of the list */
1756 config_entry_add_loader_auto(&config, loaded_image->DeviceHandle, root_dir, loaded_image_path,
1757 L"auto-windows", 'w', L"Windows Boot Manager", L"\\EFI\\Microsoft\\Boot\\bootmgfw.efi");
1758 config_entry_add_loader_auto(&config, loaded_image->DeviceHandle, root_dir, loaded_image_path,
1759 L"auto-efi-shell", 's', L"EFI Shell", L"\\shell" EFI_MACHINE_TYPE_NAME ".efi");
1760 config_entry_add_loader_auto(&config, loaded_image->DeviceHandle, root_dir, loaded_image_path,
1761 L"auto-efi-default", '\0', L"EFI Default Loader", L"\\EFI\\Boot\\boot" EFI_MACHINE_TYPE_NAME ".efi");
1762 config_entry_add_osx(&config);
1763
1764 if (efivar_get_raw(&global_guid, L"OsIndicationsSupported", &b, &size) == EFI_SUCCESS) {
1765 UINT64 osind = (UINT64)*b;
1766
1767 if (osind & EFI_OS_INDICATIONS_BOOT_TO_FW_UI)
1768 config_entry_add_call(&config, L"Reboot Into Firmware Interface", reboot_into_firmware);
1769 FreePool(b);
1770 }
1771
1772 if (config.entry_count == 0) {
1773 Print(L"No loader found. Configuration files in \\loader\\entries\\*.conf are needed.");
1774 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1775 goto out;
1776 }
1777
1778 config_title_generate(&config);
1779
1780 /* select entry by configured pattern or EFI LoaderDefaultEntry= variable */
1781 config_default_entry_select(&config);
1782
1783 /* if no configured entry to select from was found, enable the menu */
1784 if (config.idx_default == -1) {
1785 config.idx_default = 0;
1786 if (config.timeout_sec == 0)
1787 config.timeout_sec = 10;
1788 }
1789
1790 /* select entry or show menu when key is pressed or timeout is set */
1791 if (config.timeout_sec == 0) {
1792 UINT64 key;
1793
1794 err = console_key_read(&key, FALSE);
1795 if (!EFI_ERROR(err)) {
1796 INT16 idx;
1797
1798 /* find matching key in config entries */
1799 idx = entry_lookup_key(&config, config.idx_default, KEYCHAR(key));
1800 if (idx >= 0)
1801 config.idx_default = idx;
1802 else
1803 menu = TRUE;
1804 }
1805 } else
1806 menu = TRUE;
1807
1808 for (;;) {
1809 ConfigEntry *entry;
1810
1811 entry = config.entries[config.idx_default];
1812 if (menu) {
1813 efivar_set_time_usec(L"LoaderTimeMenuUSec", 0);
1814 uefi_call_wrapper(BS->SetWatchdogTimer, 4, 0, 0x10000, 0, NULL);
1815 if (!menu_run(&config, &entry, loaded_image_path))
1816 break;
1817
1818 /* run special entry like "reboot" */
1819 if (entry->call) {
1820 entry->call();
1821 continue;
1822 }
1823 }
1824
1825 /* export the selected boot entry to the system */
1826 efivar_set(L"LoaderEntrySelected", entry->file, FALSE);
1827
1828 uefi_call_wrapper(BS->SetWatchdogTimer, 4, 5 * 60, 0x10000, 0, NULL);
1829 err = image_start(image, &config, entry);
1830 if (EFI_ERROR(err)) {
1831 graphics_mode(FALSE);
1832 Print(L"\nFailed to execute %s (%s): %r\n", entry->title, entry->loader, err);
1833 uefi_call_wrapper(BS->Stall, 1, 3 * 1000 * 1000);
1834 goto out;
1835 }
1836
1837 menu = TRUE;
1838 config.timeout_sec = 0;
1839 }
1840 err = EFI_SUCCESS;
1841 out:
1842 FreePool(loaded_image_path);
1843 config_free(&config);
1844 uefi_call_wrapper(root_dir->Close, 1, root_dir);
1845 uefi_call_wrapper(BS->CloseProtocol, 4, image, &LoadedImageProtocol, image, NULL);
1846 return err;
1847 }