Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright 2011 Red Hat, Inc.
4 * All rights reserved.
5 *
6 * Author(s): Peter Jones <pjones@redhat.com>
7 */
8#ifndef __LINUX_PE_H
9#define __LINUX_PE_H
10
11#include <linux/types.h>
12
13/*
14 * Linux EFI stub v1.0 adds the following functionality:
15 * - Loading initrd from the LINUX_EFI_INITRD_MEDIA_GUID device path,
16 * - Loading/starting the kernel from firmware that targets a different
17 * machine type, via the entrypoint exposed in the .compat PE/COFF section.
18 *
19 * The recommended way of loading and starting v1.0 or later kernels is to use
20 * the LoadImage() and StartImage() EFI boot services, and expose the initrd
21 * via the LINUX_EFI_INITRD_MEDIA_GUID device path.
22 *
23 * Versions older than v1.0 support initrd loading via the image load options
24 * (using initrd=, limited to the volume from which the kernel itself was
25 * loaded), or via arch specific means (bootparams, DT, etc).
26 *
27 * On x86, LoadImage() and StartImage() can be omitted if the EFI handover
28 * protocol is implemented, which can be inferred from the version,
29 * handover_offset and xloadflags fields in the bootparams structure.
30 */
31#define LINUX_EFISTUB_MAJOR_VERSION 0x1
32#define LINUX_EFISTUB_MINOR_VERSION 0x0
33
34#define MZ_MAGIC 0x5a4d /* "MZ" */
35
36#define PE_MAGIC 0x00004550 /* "PE\0\0" */
37#define PE_OPT_MAGIC_PE32 0x010b
38#define PE_OPT_MAGIC_PE32_ROM 0x0107
39#define PE_OPT_MAGIC_PE32PLUS 0x020b
40
41/* machine type */
42#define IMAGE_FILE_MACHINE_UNKNOWN 0x0000
43#define IMAGE_FILE_MACHINE_AM33 0x01d3
44#define IMAGE_FILE_MACHINE_AMD64 0x8664
45#define IMAGE_FILE_MACHINE_ARM 0x01c0
46#define IMAGE_FILE_MACHINE_ARMV7 0x01c4
47#define IMAGE_FILE_MACHINE_ARM64 0xaa64
48#define IMAGE_FILE_MACHINE_EBC 0x0ebc
49#define IMAGE_FILE_MACHINE_I386 0x014c
50#define IMAGE_FILE_MACHINE_IA64 0x0200
51#define IMAGE_FILE_MACHINE_M32R 0x9041
52#define IMAGE_FILE_MACHINE_MIPS16 0x0266
53#define IMAGE_FILE_MACHINE_MIPSFPU 0x0366
54#define IMAGE_FILE_MACHINE_MIPSFPU16 0x0466
55#define IMAGE_FILE_MACHINE_POWERPC 0x01f0
56#define IMAGE_FILE_MACHINE_POWERPCFP 0x01f1
57#define IMAGE_FILE_MACHINE_R4000 0x0166
58#define IMAGE_FILE_MACHINE_SH3 0x01a2
59#define IMAGE_FILE_MACHINE_SH3DSP 0x01a3
60#define IMAGE_FILE_MACHINE_SH3E 0x01a4
61#define IMAGE_FILE_MACHINE_SH4 0x01a6
62#define IMAGE_FILE_MACHINE_SH5 0x01a8
63#define IMAGE_FILE_MACHINE_THUMB 0x01c2
64#define IMAGE_FILE_MACHINE_WCEMIPSV2 0x0169
65
66/* flags */
67#define IMAGE_FILE_RELOCS_STRIPPED 0x0001
68#define IMAGE_FILE_EXECUTABLE_IMAGE 0x0002
69#define IMAGE_FILE_LINE_NUMS_STRIPPED 0x0004
70#define IMAGE_FILE_LOCAL_SYMS_STRIPPED 0x0008
71#define IMAGE_FILE_AGGRESSIVE_WS_TRIM 0x0010
72#define IMAGE_FILE_LARGE_ADDRESS_AWARE 0x0020
73#define IMAGE_FILE_16BIT_MACHINE 0x0040
74#define IMAGE_FILE_BYTES_REVERSED_LO 0x0080
75#define IMAGE_FILE_32BIT_MACHINE 0x0100
76#define IMAGE_FILE_DEBUG_STRIPPED 0x0200
77#define IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP 0x0400
78#define IMAGE_FILE_NET_RUN_FROM_SWAP 0x0800
79#define IMAGE_FILE_SYSTEM 0x1000
80#define IMAGE_FILE_DLL 0x2000
81#define IMAGE_FILE_UP_SYSTEM_ONLY 0x4000
82#define IMAGE_FILE_BYTES_REVERSED_HI 0x8000
83
84#define IMAGE_FILE_OPT_ROM_MAGIC 0x107
85#define IMAGE_FILE_OPT_PE32_MAGIC 0x10b
86#define IMAGE_FILE_OPT_PE32_PLUS_MAGIC 0x20b
87
88#define IMAGE_SUBSYSTEM_UNKNOWN 0
89#define IMAGE_SUBSYSTEM_NATIVE 1
90#define IMAGE_SUBSYSTEM_WINDOWS_GUI 2
91#define IMAGE_SUBSYSTEM_WINDOWS_CUI 3
92#define IMAGE_SUBSYSTEM_POSIX_CUI 7
93#define IMAGE_SUBSYSTEM_WINDOWS_CE_GUI 9
94#define IMAGE_SUBSYSTEM_EFI_APPLICATION 10
95#define IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
96#define IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12
97#define IMAGE_SUBSYSTEM_EFI_ROM_IMAGE 13
98#define IMAGE_SUBSYSTEM_XBOX 14
99
100#define IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE 0x0040
101#define IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY 0x0080
102#define IMAGE_DLL_CHARACTERISTICS_NX_COMPAT 0x0100
103#define IMAGE_DLLCHARACTERISTICS_NO_ISOLATION 0x0200
104#define IMAGE_DLLCHARACTERISTICS_NO_SEH 0x0400
105#define IMAGE_DLLCHARACTERISTICS_NO_BIND 0x0800
106#define IMAGE_DLLCHARACTERISTICS_WDM_DRIVER 0x2000
107#define IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE 0x8000
108
109/* they actually defined 0x00000000 as well, but I think we'll skip that one. */
110#define IMAGE_SCN_RESERVED_0 0x00000001
111#define IMAGE_SCN_RESERVED_1 0x00000002
112#define IMAGE_SCN_RESERVED_2 0x00000004
113#define IMAGE_SCN_TYPE_NO_PAD 0x00000008 /* don't pad - obsolete */
114#define IMAGE_SCN_RESERVED_3 0x00000010
115#define IMAGE_SCN_CNT_CODE 0x00000020 /* .text */
116#define IMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040 /* .data */
117#define IMAGE_SCN_CNT_UNINITIALIZED_DATA 0x00000080 /* .bss */
118#define IMAGE_SCN_LNK_OTHER 0x00000100 /* reserved */
119#define IMAGE_SCN_LNK_INFO 0x00000200 /* .drectve comments */
120#define IMAGE_SCN_RESERVED_4 0x00000400
121#define IMAGE_SCN_LNK_REMOVE 0x00000800 /* .o only - scn to be rm'd*/
122#define IMAGE_SCN_LNK_COMDAT 0x00001000 /* .o only - COMDAT data */
123#define IMAGE_SCN_RESERVED_5 0x00002000 /* spec omits this */
124#define IMAGE_SCN_RESERVED_6 0x00004000 /* spec omits this */
125#define IMAGE_SCN_GPREL 0x00008000 /* global pointer referenced data */
126/* spec lists 0x20000 twice, I suspect they meant 0x10000 for one of them */
127#define IMAGE_SCN_MEM_PURGEABLE 0x00010000 /* reserved for "future" use */
128#define IMAGE_SCN_16BIT 0x00020000 /* reserved for "future" use */
129#define IMAGE_SCN_LOCKED 0x00040000 /* reserved for "future" use */
130#define IMAGE_SCN_PRELOAD 0x00080000 /* reserved for "future" use */
131/* and here they just stuck a 1-byte integer in the middle of a bitfield */
132#define IMAGE_SCN_ALIGN_1BYTES 0x00100000 /* it does what it says on the box */
133#define IMAGE_SCN_ALIGN_2BYTES 0x00200000
134#define IMAGE_SCN_ALIGN_4BYTES 0x00300000
135#define IMAGE_SCN_ALIGN_8BYTES 0x00400000
136#define IMAGE_SCN_ALIGN_16BYTES 0x00500000
137#define IMAGE_SCN_ALIGN_32BYTES 0x00600000
138#define IMAGE_SCN_ALIGN_64BYTES 0x00700000
139#define IMAGE_SCN_ALIGN_128BYTES 0x00800000
140#define IMAGE_SCN_ALIGN_256BYTES 0x00900000
141#define IMAGE_SCN_ALIGN_512BYTES 0x00a00000
142#define IMAGE_SCN_ALIGN_1024BYTES 0x00b00000
143#define IMAGE_SCN_ALIGN_2048BYTES 0x00c00000
144#define IMAGE_SCN_ALIGN_4096BYTES 0x00d00000
145#define IMAGE_SCN_ALIGN_8192BYTES 0x00e00000
146#define IMAGE_SCN_LNK_NRELOC_OVFL 0x01000000 /* extended relocations */
147#define IMAGE_SCN_MEM_DISCARDABLE 0x02000000 /* scn can be discarded */
148#define IMAGE_SCN_MEM_NOT_CACHED 0x04000000 /* cannot be cached */
149#define IMAGE_SCN_MEM_NOT_PAGED 0x08000000 /* not pageable */
150#define IMAGE_SCN_MEM_SHARED 0x10000000 /* can be shared */
151#define IMAGE_SCN_MEM_EXECUTE 0x20000000 /* can be executed as code */
152#define IMAGE_SCN_MEM_READ 0x40000000 /* readable */
153#define IMAGE_SCN_MEM_WRITE 0x80000000 /* writeable */
154
155#define IMAGE_DEBUG_TYPE_CODEVIEW 2
156
157#ifndef __ASSEMBLY__
158
159struct mz_hdr {
160 uint16_t magic; /* MZ_MAGIC */
161 uint16_t lbsize; /* size of last used block */
162 uint16_t blocks; /* pages in file, 0x3 */
163 uint16_t relocs; /* relocations */
164 uint16_t hdrsize; /* header size in "paragraphs" */
165 uint16_t min_extra_pps; /* .bss */
166 uint16_t max_extra_pps; /* runtime limit for the arena size */
167 uint16_t ss; /* relative stack segment */
168 uint16_t sp; /* initial %sp register */
169 uint16_t checksum; /* word checksum */
170 uint16_t ip; /* initial %ip register */
171 uint16_t cs; /* initial %cs relative to load segment */
172 uint16_t reloc_table_offset; /* offset of the first relocation */
173 uint16_t overlay_num; /* overlay number. set to 0. */
174 uint16_t reserved0[4]; /* reserved */
175 uint16_t oem_id; /* oem identifier */
176 uint16_t oem_info; /* oem specific */
177 uint16_t reserved1[10]; /* reserved */
178 uint32_t peaddr; /* address of pe header */
179 char message[]; /* message to print */
180};
181
182struct mz_reloc {
183 uint16_t offset;
184 uint16_t segment;
185};
186
187struct pe_hdr {
188 uint32_t magic; /* PE magic */
189 uint16_t machine; /* machine type */
190 uint16_t sections; /* number of sections */
191 uint32_t timestamp; /* time_t */
192 uint32_t symbol_table; /* symbol table offset */
193 uint32_t symbols; /* number of symbols */
194 uint16_t opt_hdr_size; /* size of optional header */
195 uint16_t flags; /* flags */
196};
197
198/* the fact that pe32 isn't padded where pe32+ is 64-bit means union won't
199 * work right. vomit. */
200struct pe32_opt_hdr {
201 /* "standard" header */
202 uint16_t magic; /* file type */
203 uint8_t ld_major; /* linker major version */
204 uint8_t ld_minor; /* linker minor version */
205 uint32_t text_size; /* size of text section(s) */
206 uint32_t data_size; /* size of data section(s) */
207 uint32_t bss_size; /* size of bss section(s) */
208 uint32_t entry_point; /* file offset of entry point */
209 uint32_t code_base; /* relative code addr in ram */
210 uint32_t data_base; /* relative data addr in ram */
211 /* "windows" header */
212 uint32_t image_base; /* preferred load address */
213 uint32_t section_align; /* alignment in bytes */
214 uint32_t file_align; /* file alignment in bytes */
215 uint16_t os_major; /* major OS version */
216 uint16_t os_minor; /* minor OS version */
217 uint16_t image_major; /* major image version */
218 uint16_t image_minor; /* minor image version */
219 uint16_t subsys_major; /* major subsystem version */
220 uint16_t subsys_minor; /* minor subsystem version */
221 uint32_t win32_version; /* reserved, must be 0 */
222 uint32_t image_size; /* image size */
223 uint32_t header_size; /* header size rounded up to
224 file_align */
225 uint32_t csum; /* checksum */
226 uint16_t subsys; /* subsystem */
227 uint16_t dll_flags; /* more flags! */
228 uint32_t stack_size_req;/* amt of stack requested */
229 uint32_t stack_size; /* amt of stack required */
230 uint32_t heap_size_req; /* amt of heap requested */
231 uint32_t heap_size; /* amt of heap required */
232 uint32_t loader_flags; /* reserved, must be 0 */
233 uint32_t data_dirs; /* number of data dir entries */
234};
235
236struct pe32plus_opt_hdr {
237 uint16_t magic; /* file type */
238 uint8_t ld_major; /* linker major version */
239 uint8_t ld_minor; /* linker minor version */
240 uint32_t text_size; /* size of text section(s) */
241 uint32_t data_size; /* size of data section(s) */
242 uint32_t bss_size; /* size of bss section(s) */
243 uint32_t entry_point; /* file offset of entry point */
244 uint32_t code_base; /* relative code addr in ram */
245 /* "windows" header */
246 uint64_t image_base; /* preferred load address */
247 uint32_t section_align; /* alignment in bytes */
248 uint32_t file_align; /* file alignment in bytes */
249 uint16_t os_major; /* major OS version */
250 uint16_t os_minor; /* minor OS version */
251 uint16_t image_major; /* major image version */
252 uint16_t image_minor; /* minor image version */
253 uint16_t subsys_major; /* major subsystem version */
254 uint16_t subsys_minor; /* minor subsystem version */
255 uint32_t win32_version; /* reserved, must be 0 */
256 uint32_t image_size; /* image size */
257 uint32_t header_size; /* header size rounded up to
258 file_align */
259 uint32_t csum; /* checksum */
260 uint16_t subsys; /* subsystem */
261 uint16_t dll_flags; /* more flags! */
262 uint64_t stack_size_req;/* amt of stack requested */
263 uint64_t stack_size; /* amt of stack required */
264 uint64_t heap_size_req; /* amt of heap requested */
265 uint64_t heap_size; /* amt of heap required */
266 uint32_t loader_flags; /* reserved, must be 0 */
267 uint32_t data_dirs; /* number of data dir entries */
268};
269
270struct data_dirent {
271 uint32_t virtual_address; /* relative to load address */
272 uint32_t size;
273};
274
275struct data_directory {
276 struct data_dirent exports; /* .edata */
277 struct data_dirent imports; /* .idata */
278 struct data_dirent resources; /* .rsrc */
279 struct data_dirent exceptions; /* .pdata */
280 struct data_dirent certs; /* certs */
281 struct data_dirent base_relocations; /* .reloc */
282 struct data_dirent debug; /* .debug */
283 struct data_dirent arch; /* reservered */
284 struct data_dirent global_ptr; /* global pointer reg. Size=0 */
285 struct data_dirent tls; /* .tls */
286 struct data_dirent load_config; /* load configuration structure */
287 struct data_dirent bound_imports; /* no idea */
288 struct data_dirent import_addrs; /* import address table */
289 struct data_dirent delay_imports; /* delay-load import table */
290 struct data_dirent clr_runtime_hdr; /* .cor (object only) */
291 struct data_dirent reserved;
292};
293
294struct section_header {
295 char name[8]; /* name or "/12\0" string tbl offset */
296 uint32_t virtual_size; /* size of loaded section in ram */
297 uint32_t virtual_address; /* relative virtual address */
298 uint32_t raw_data_size; /* size of the section */
299 uint32_t data_addr; /* file pointer to first page of sec */
300 uint32_t relocs; /* file pointer to relocation entries */
301 uint32_t line_numbers; /* line numbers! */
302 uint16_t num_relocs; /* number of relocations */
303 uint16_t num_lin_numbers; /* srsly. */
304 uint32_t flags;
305};
306
307enum x64_coff_reloc_type {
308 IMAGE_REL_AMD64_ABSOLUTE = 0,
309 IMAGE_REL_AMD64_ADDR64,
310 IMAGE_REL_AMD64_ADDR32,
311 IMAGE_REL_AMD64_ADDR32N,
312 IMAGE_REL_AMD64_REL32,
313 IMAGE_REL_AMD64_REL32_1,
314 IMAGE_REL_AMD64_REL32_2,
315 IMAGE_REL_AMD64_REL32_3,
316 IMAGE_REL_AMD64_REL32_4,
317 IMAGE_REL_AMD64_REL32_5,
318 IMAGE_REL_AMD64_SECTION,
319 IMAGE_REL_AMD64_SECREL,
320 IMAGE_REL_AMD64_SECREL7,
321 IMAGE_REL_AMD64_TOKEN,
322 IMAGE_REL_AMD64_SREL32,
323 IMAGE_REL_AMD64_PAIR,
324 IMAGE_REL_AMD64_SSPAN32,
325};
326
327enum arm_coff_reloc_type {
328 IMAGE_REL_ARM_ABSOLUTE,
329 IMAGE_REL_ARM_ADDR32,
330 IMAGE_REL_ARM_ADDR32N,
331 IMAGE_REL_ARM_BRANCH2,
332 IMAGE_REL_ARM_BRANCH1,
333 IMAGE_REL_ARM_SECTION,
334 IMAGE_REL_ARM_SECREL,
335};
336
337enum sh_coff_reloc_type {
338 IMAGE_REL_SH3_ABSOLUTE,
339 IMAGE_REL_SH3_DIRECT16,
340 IMAGE_REL_SH3_DIRECT32,
341 IMAGE_REL_SH3_DIRECT8,
342 IMAGE_REL_SH3_DIRECT8_WORD,
343 IMAGE_REL_SH3_DIRECT8_LONG,
344 IMAGE_REL_SH3_DIRECT4,
345 IMAGE_REL_SH3_DIRECT4_WORD,
346 IMAGE_REL_SH3_DIRECT4_LONG,
347 IMAGE_REL_SH3_PCREL8_WORD,
348 IMAGE_REL_SH3_PCREL8_LONG,
349 IMAGE_REL_SH3_PCREL12_WORD,
350 IMAGE_REL_SH3_STARTOF_SECTION,
351 IMAGE_REL_SH3_SIZEOF_SECTION,
352 IMAGE_REL_SH3_SECTION,
353 IMAGE_REL_SH3_SECREL,
354 IMAGE_REL_SH3_DIRECT32_NB,
355 IMAGE_REL_SH3_GPREL4_LONG,
356 IMAGE_REL_SH3_TOKEN,
357 IMAGE_REL_SHM_PCRELPT,
358 IMAGE_REL_SHM_REFLO,
359 IMAGE_REL_SHM_REFHALF,
360 IMAGE_REL_SHM_RELLO,
361 IMAGE_REL_SHM_RELHALF,
362 IMAGE_REL_SHM_PAIR,
363 IMAGE_REL_SHM_NOMODE,
364};
365
366enum ppc_coff_reloc_type {
367 IMAGE_REL_PPC_ABSOLUTE,
368 IMAGE_REL_PPC_ADDR64,
369 IMAGE_REL_PPC_ADDR32,
370 IMAGE_REL_PPC_ADDR24,
371 IMAGE_REL_PPC_ADDR16,
372 IMAGE_REL_PPC_ADDR14,
373 IMAGE_REL_PPC_REL24,
374 IMAGE_REL_PPC_REL14,
375 IMAGE_REL_PPC_ADDR32N,
376 IMAGE_REL_PPC_SECREL,
377 IMAGE_REL_PPC_SECTION,
378 IMAGE_REL_PPC_SECREL16,
379 IMAGE_REL_PPC_REFHI,
380 IMAGE_REL_PPC_REFLO,
381 IMAGE_REL_PPC_PAIR,
382 IMAGE_REL_PPC_SECRELLO,
383 IMAGE_REL_PPC_GPREL,
384 IMAGE_REL_PPC_TOKEN,
385};
386
387enum x86_coff_reloc_type {
388 IMAGE_REL_I386_ABSOLUTE,
389 IMAGE_REL_I386_DIR16,
390 IMAGE_REL_I386_REL16,
391 IMAGE_REL_I386_DIR32,
392 IMAGE_REL_I386_DIR32NB,
393 IMAGE_REL_I386_SEG12,
394 IMAGE_REL_I386_SECTION,
395 IMAGE_REL_I386_SECREL,
396 IMAGE_REL_I386_TOKEN,
397 IMAGE_REL_I386_SECREL7,
398 IMAGE_REL_I386_REL32,
399};
400
401enum ia64_coff_reloc_type {
402 IMAGE_REL_IA64_ABSOLUTE,
403 IMAGE_REL_IA64_IMM14,
404 IMAGE_REL_IA64_IMM22,
405 IMAGE_REL_IA64_IMM64,
406 IMAGE_REL_IA64_DIR32,
407 IMAGE_REL_IA64_DIR64,
408 IMAGE_REL_IA64_PCREL21B,
409 IMAGE_REL_IA64_PCREL21M,
410 IMAGE_REL_IA64_PCREL21F,
411 IMAGE_REL_IA64_GPREL22,
412 IMAGE_REL_IA64_LTOFF22,
413 IMAGE_REL_IA64_SECTION,
414 IMAGE_REL_IA64_SECREL22,
415 IMAGE_REL_IA64_SECREL64I,
416 IMAGE_REL_IA64_SECREL32,
417 IMAGE_REL_IA64_DIR32NB,
418 IMAGE_REL_IA64_SREL14,
419 IMAGE_REL_IA64_SREL22,
420 IMAGE_REL_IA64_SREL32,
421 IMAGE_REL_IA64_UREL32,
422 IMAGE_REL_IA64_PCREL60X,
423 IMAGE_REL_IA64_PCREL60B,
424 IMAGE_REL_IA64_PCREL60F,
425 IMAGE_REL_IA64_PCREL60I,
426 IMAGE_REL_IA64_PCREL60M,
427 IMAGE_REL_IA64_IMMGPREL6,
428 IMAGE_REL_IA64_TOKEN,
429 IMAGE_REL_IA64_GPREL32,
430 IMAGE_REL_IA64_ADDEND,
431};
432
433struct coff_reloc {
434 uint32_t virtual_address;
435 uint32_t symbol_table_index;
436 union {
437 enum x64_coff_reloc_type x64_type;
438 enum arm_coff_reloc_type arm_type;
439 enum sh_coff_reloc_type sh_type;
440 enum ppc_coff_reloc_type ppc_type;
441 enum x86_coff_reloc_type x86_type;
442 enum ia64_coff_reloc_type ia64_type;
443 uint16_t data;
444 };
445};
446
447/*
448 * Definitions for the contents of the certs data block
449 */
450#define WIN_CERT_TYPE_PKCS_SIGNED_DATA 0x0002
451#define WIN_CERT_TYPE_EFI_OKCS115 0x0EF0
452#define WIN_CERT_TYPE_EFI_GUID 0x0EF1
453
454#define WIN_CERT_REVISION_1_0 0x0100
455#define WIN_CERT_REVISION_2_0 0x0200
456
457struct win_certificate {
458 uint32_t length;
459 uint16_t revision;
460 uint16_t cert_type;
461};
462
463#endif /* !__ASSEMBLY__ */
464
465#endif /* __LINUX_PE_H */