1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * efi_selftest_start_image
4 *
5 * Copyright (c) 2018 Heinrich Schuchardt <xypron.glpk@gmx.de>
6 *
7 * This test checks the StartImage boot service.
8 * The efi_selftest_miniapp_exit.efi application is loaded into memory
9 * and started.
10 */
11
12 #include <efi_selftest.h>
13 /* Include containing the miniapp.efi application */
14 #include "efi_miniapp_file_image_exit.h"
15
16 /* Block size of compressed disk image */
17 #define COMPRESSED_DISK_IMAGE_BLOCK_SIZE 8
18
19 /* Binary logarithm of the block size */
20 #define LB_BLOCK_SIZE 9
21
22 static efi_handle_t image_handle;
23 static struct efi_boot_services *boottime;
24
25 /* One 8 byte block of the compressed disk image */
26 struct line {
27 size_t addr;
28 char *line;
29 };
30
31 /* Compressed file image */
32 struct compressed_file_image {
33 size_t length;
34 struct line lines[];
35 };
36
37 static struct compressed_file_image img = EFI_ST_DISK_IMG;
38
39 /* Decompressed file image */
40 static u8 *image;
41
42 /*
43 * Decompress the disk image.
44 *
45 * @image decompressed disk image
46 * Return: status code
47 */
decompress(u8 ** image)48 static efi_status_t decompress(u8 **image)
49 {
50 u8 *buf;
51 size_t i;
52 size_t addr;
53 size_t len;
54 efi_status_t ret;
55
56 ret = boottime->allocate_pool(EFI_LOADER_DATA, img.length,
57 (void **)&buf);
58 if (ret != EFI_SUCCESS) {
59 efi_st_error("Out of memory\n");
60 return ret;
61 }
62 boottime->set_mem(buf, img.length, 0);
63
64 for (i = 0; ; ++i) {
65 if (!img.lines[i].line)
66 break;
67 addr = img.lines[i].addr;
68 len = COMPRESSED_DISK_IMAGE_BLOCK_SIZE;
69 if (addr + len > img.length)
70 len = img.length - addr;
71 boottime->copy_mem(buf + addr, img.lines[i].line, len);
72 }
73 *image = buf;
74 return ret;
75 }
76
77 /*
78 * Setup unit test.
79 *
80 * @handle: handle of the loaded image
81 * @systable: system table
82 * Return: EFI_ST_SUCCESS for success
83 */
setup(const efi_handle_t handle,const struct efi_system_table * systable)84 static int setup(const efi_handle_t handle,
85 const struct efi_system_table *systable)
86 {
87 efi_status_t ret;
88
89 image_handle = handle;
90 boottime = systable->boottime;
91
92 /* Load the application image into memory */
93 ret = decompress(&image);
94
95 return ret;
96 }
97
98 /*
99 * Tear down unit test.
100 *
101 * Return: EFI_ST_SUCCESS for success
102 */
teardown(void)103 static int teardown(void)
104 {
105 efi_status_t r = EFI_ST_SUCCESS;
106
107 if (image) {
108 r = boottime->free_pool(image);
109 if (r != EFI_SUCCESS) {
110 efi_st_error("Failed to free image\n");
111 return EFI_ST_FAILURE;
112 }
113 }
114 return r;
115 }
116
117 /*
118 * Execute unit test.
119 *
120 * Load and start the application image.
121 *
122 * Return: EFI_ST_SUCCESS for success
123 */
execute(void)124 static int execute(void)
125 {
126 efi_status_t ret;
127 efi_handle_t handle;
128 efi_uintn_t exit_data_size = 0;
129 u16 *exit_data = NULL;
130 u16 expected_text[] = EFI_ST_SUCCESS_STR;
131
132 ret = boottime->load_image(false, image_handle, NULL, image,
133 img.length, &handle);
134 if (ret != EFI_SUCCESS) {
135 efi_st_error("Failed to load image\n");
136 return EFI_ST_FAILURE;
137 }
138 ret = boottime->start_image(handle, &exit_data_size, &exit_data);
139 if (ret != EFI_UNSUPPORTED) {
140 efi_st_error("Wrong return value from application\n");
141 return EFI_ST_FAILURE;
142 }
143 if (!exit_data || exit_data_size != sizeof(expected_text) ||
144 memcmp(exit_data, expected_text, sizeof(expected_text))) {
145 efi_st_error("Incorrect exit data\n");
146 return EFI_ST_FAILURE;
147 }
148 ret = boottime->free_pool(exit_data);
149 if (ret != EFI_SUCCESS) {
150 efi_st_error("Failed to free exit data\n");
151 return EFI_ST_FAILURE;
152 }
153
154 return EFI_ST_SUCCESS;
155 }
156
157 EFI_UNIT_TEST(startimage_exit) = {
158 .name = "start image exit",
159 .phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
160 .setup = setup,
161 .execute = execute,
162 .teardown = teardown,
163 };
164