xref: /freebsd/usr.sbin/efitable/efitable.c (revision 2cb0fce24d64039090dc9243cdf0715ee80c91b1)
1 /*-
2  * Copyright (c) 2021 3mdeb Embedded Systems Consulting <contact@3mdeb.com>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 #include <sys/types.h>
27 #include <sys/efi.h>
28 #include <sys/efiio.h>
29 #include <sys/param.h>
30 #include <sys/stat.h>
31 #include <fcntl.h>
32 #include <getopt.h>
33 #include <stdbool.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <sysexits.h>
38 #include <unistd.h>
39 #include <uuid.h>
40 #include <libxo/xo.h>
41 
42 #define TABLE_MAX_LEN 30
43 #define EFITABLE_XO_VERSION "1"
44 
45 static void efi_table_print_esrt(const void *data);
46 static void efi_table_print_prop(const void *data);
47 static void usage(void) __dead2;
48 
49 struct efi_table_op {
50 	char name[TABLE_MAX_LEN];
51 	void (*parse) (const void *);
52 	struct uuid uuid;
53 };
54 
55 static const struct efi_table_op efi_table_ops[] = {
56 	{ .name = "esrt", .parse = efi_table_print_esrt,
57 	    .uuid = EFI_TABLE_ESRT },
58 	{ .name = "prop", .parse = efi_table_print_prop,
59 	    .uuid = EFI_PROPERTIES_TABLE }
60 };
61 
62 int
63 main(int argc, char **argv)
64 {
65 	struct efi_get_table_ioc table = {
66 		.buf = NULL,
67 		.buf_len = 0,
68 		.table_len = 0
69 	};
70 	int efi_fd, ch, rc = 1, efi_idx = -1;
71 	bool got_table = false;
72 	bool table_set = false;
73 	bool uuid_set = false;
74 	struct option longopts[] = {
75 		{ "uuid",  required_argument, NULL, 'u' },
76 		{ "table", required_argument, NULL, 't' },
77 		{ NULL,    0,                 NULL,  0  }
78 	};
79 
80 	argc = xo_parse_args(argc, argv);
81 	if (argc < 0)
82 		exit(EXIT_FAILURE);
83 
84 	while ((ch = getopt_long(argc, argv, "u:t:", longopts, NULL)) != -1) {
85 		switch (ch) {
86 		case 'u':
87 		{
88 			char *uuid_str = optarg;
89 			struct uuid uuid;
90 			uint32_t status;
91 
92 			uuid_set = 1;
93 
94 			uuid_from_string(uuid_str, &uuid, &status);
95 			if (status != uuid_s_ok)
96 				xo_errx(EX_DATAERR, "invalid UUID");
97 
98 			for (size_t n = 0; n < nitems(efi_table_ops); n++) {
99 				if (!memcmp(&uuid, &efi_table_ops[n].uuid,
100 				    sizeof(uuid))) {
101 					efi_idx = n;
102 					got_table = true;
103 					break;
104 				}
105 			}
106 			break;
107 		}
108 		case 't':
109 		{
110 			char *table_name = optarg;
111 
112 			table_set = true;
113 
114 			for (size_t n = 0; n < nitems(efi_table_ops); n++) {
115 				if (!strcmp(table_name,
116 				    efi_table_ops[n].name)) {
117 					efi_idx = n;
118 					got_table = true;
119 					break;
120 				}
121 			}
122 
123 			if (!got_table)
124 				xo_errx(EX_DATAERR, "unsupported efi table");
125 
126 			break;
127 		}
128 		default:
129 			usage();
130 		}
131 	}
132 
133 	if (!table_set && !uuid_set)
134 		xo_errx(EX_USAGE, "table is not set");
135 
136 	if (!got_table)
137 		xo_errx(EX_DATAERR, "unsupported table");
138 
139 	efi_fd = open("/dev/efi", O_RDWR);
140 	if (efi_fd < 0)
141 		xo_err(EX_OSFILE, "/dev/efi");
142 
143 	table.uuid = efi_table_ops[efi_idx].uuid;
144 	if (ioctl(efi_fd, EFIIOC_GET_TABLE, &table) == -1)
145 		xo_err(EX_OSERR, "EFIIOC_GET_TABLE (len == 0)");
146 
147 	table.buf = malloc(table.table_len);
148 	table.buf_len = table.table_len;
149 
150 	if (ioctl(efi_fd, EFIIOC_GET_TABLE, &table) == -1)
151 		xo_err(EX_OSERR, "EFIIOC_GET_TABLE");
152 
153 	efi_table_ops[efi_idx].parse(table.buf);
154 	close(efi_fd);
155 
156 	return (rc);
157 }
158 
159 static void
160 efi_table_print_esrt(const void *data)
161 {
162 	const struct efi_esrt_entry_v1 *entries_v1;
163 	const struct efi_esrt_table *esrt;
164 
165 	esrt = (const struct efi_esrt_table *)data;
166 
167 	xo_set_version(EFITABLE_XO_VERSION);
168 	xo_open_container("esrt");
169 	xo_emit("{Lwc:FwResourceCount}{:fw_resource_count/%u}\n",
170 	    esrt->fw_resource_count);
171 	xo_emit("{Lwc:FwResourceCountMax}{:fw_resource_count_max/%u}\n",
172 	    esrt->fw_resource_count_max);
173 	xo_emit("{Lwc:FwResourceVersion}{:fw_resource_version/%u}\n",
174 	    esrt->fw_resource_version);
175 	xo_open_list("entries");
176 	xo_emit("\nEntries:\n");
177 
178 	entries_v1 = (const void *) esrt->entries;
179 	for (uint32_t i = 0; i < esrt->fw_resource_count; i++) {
180 		const struct efi_esrt_entry_v1 *e = &entries_v1[i];
181 		uint32_t status;
182 		char *uuid;
183 
184 		uuid_to_string(&e->fw_class, &uuid, &status);
185 		if (status != uuid_s_ok) {
186 			xo_errx(EX_DATAERR, "uuid_to_string error");
187 		}
188 
189 		xo_open_instance("entries");
190 		xo_emit("\n");
191 		xo_emit("{P:  }{Lwc:FwClass}{:fw_class/%s}\n", uuid);
192 		xo_emit("{P:  }{Lwc:FwType}{:fw_type/%u}\n", e->fw_type);
193 		xo_emit("{P:  }{Lwc:FwVersion}{:fw_version/%u}\n",
194 		    e->fw_version);
195 		xo_emit("{P:  }{Lwc:LowestSupportedFwVersion}"
196 		    "{:lowest_supported_fw_version/%u}\n",
197 		    e->lowest_supported_fw_version);
198 		xo_emit("{P:  }{Lwc:CapsuleFlags}{:capsule_flags/%#x}\n",
199 		    e->capsule_flags);
200 		xo_emit("{P:  }{Lwc:LastAttemptVersion"
201 		    "}{:last_attempt_version/%u}\n", e->last_attempt_version);
202 		xo_emit("{P:  }{Lwc:LastAttemptStatus"
203 		    "}{:last_attempt_status/%u}\n", e->last_attempt_status);
204 
205 		xo_close_instance("entries");
206 	}
207 
208 	xo_close_list("entries");
209 	xo_close_container("esrt");
210 	if (xo_finish() < 0)
211 		xo_err(EX_IOERR, "stdout");
212 }
213 
214 static void
215 efi_table_print_prop(const void *data)
216 {
217 	const struct efi_prop_table *prop;
218 
219 	prop = (const struct efi_prop_table *)data;
220 
221 	xo_set_version(EFITABLE_XO_VERSION);
222 	xo_open_container("prop");
223 	xo_emit("{Lwc:Version}{:version/%#x}\n", prop->version);
224 	xo_emit("{Lwc:Length}{:length/%u}\n", prop->length);
225 	xo_emit("{Lwc:MemoryProtectionAttribute}"
226 	    "{:memory_protection_attribute/%#lx}\n",
227 	    prop->memory_protection_attribute);
228 	xo_close_container("prop");
229 	if (xo_finish() < 0)
230 		xo_err(EX_IOERR, "stdout");
231 }
232 
233 static void usage(void)
234 {
235 	xo_error("usage: efitable [-d uuid | -t name] [--libxo]\n");
236 	exit(EX_USAGE);
237 }
238