1*4882a593SmuzhiyunFrom a4e8936f010a8e928e973b80390c8f83ad6b8000 Mon Sep 17 00:00:00 2001
2*4882a593SmuzhiyunFrom: Peter Jones <pjones@redhat.com>
3*4882a593SmuzhiyunDate: Mon, 15 Feb 2021 14:19:31 +0100
4*4882a593SmuzhiyunSubject: [PATCH] util/mkimage: Unify more of the PE32 and PE32+ header set-up
5*4882a593Smuzhiyun
6*4882a593SmuzhiyunThere's quite a bit of code duplication in the code that sets the optional
7*4882a593Smuzhiyunheader for PE32 and PE32+. The two are very similar with the exception of
8*4882a593Smuzhiyuna few fields that have type grub_uint64_t instead of grub_uint32_t.
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunFactor out the common code and add a PE_OHDR() macro that simplifies the
11*4882a593Smuzhiyunset-up and make the code more readable.
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunSigned-off-by: Peter Jones <pjones@redhat.com>
14*4882a593SmuzhiyunSigned-off-by: Javier Martinez Canillas <javierm@redhat.com>
15*4882a593SmuzhiyunReviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
16*4882a593SmuzhiyunSigned-off-by: Stefan Sørensen <stefan.sorensen@spectralink.com>
17*4882a593Smuzhiyun---
18*4882a593Smuzhiyun util/mkimage.c | 111 ++++++++++++++++++++++++++-------------------------------
19*4882a593Smuzhiyun 1 file changed, 51 insertions(+), 60 deletions(-)
20*4882a593Smuzhiyun
21*4882a593Smuzhiyundiff --git a/util/mkimage.c b/util/mkimage.c
22*4882a593Smuzhiyunindex b94bfb7..a039039 100644
23*4882a593Smuzhiyun--- a/util/mkimage.c
24*4882a593Smuzhiyun+++ b/util/mkimage.c
25*4882a593Smuzhiyun@@ -816,6 +816,21 @@ grub_install_get_image_targets_string (void)
26*4882a593Smuzhiyun   return formats;
27*4882a593Smuzhiyun }
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun+/*
30*4882a593Smuzhiyun+ * tmp_ is just here so the compiler knows we'll never derefernce a NULL.
31*4882a593Smuzhiyun+ * It should get fully optimized away.
32*4882a593Smuzhiyun+ */
33*4882a593Smuzhiyun+#define PE_OHDR(o32, o64, field) (*(		\
34*4882a593Smuzhiyun+{						\
35*4882a593Smuzhiyun+  __typeof__((o64)->field) tmp_;		\
36*4882a593Smuzhiyun+  __typeof__((o64)->field) *ret_ = &tmp_;	\
37*4882a593Smuzhiyun+  if (o32)					\
38*4882a593Smuzhiyun+    ret_ = (void *)(&((o32)->field));		\
39*4882a593Smuzhiyun+  else if (o64)				\
40*4882a593Smuzhiyun+    ret_ = (void *)(&((o64)->field));		\
41*4882a593Smuzhiyun+  ret_;					\
42*4882a593Smuzhiyun+}))
43*4882a593Smuzhiyun+
44*4882a593Smuzhiyun void
45*4882a593Smuzhiyun grub_install_generate_image (const char *dir, const char *prefix,
46*4882a593Smuzhiyun 			     FILE *out, const char *outname, char *mods[],
47*4882a593Smuzhiyun@@ -1252,6 +1267,8 @@ grub_install_generate_image (const char *dir, const char *prefix,
48*4882a593Smuzhiyun 	static const grub_uint8_t stub[] = GRUB_PE32_MSDOS_STUB;
49*4882a593Smuzhiyun 	int header_size;
50*4882a593Smuzhiyun 	int reloc_addr;
51*4882a593Smuzhiyun+	struct grub_pe32_optional_header *o32 = NULL;
52*4882a593Smuzhiyun+	struct grub_pe64_optional_header *o64 = NULL;
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun 	if (image_target->voidp_sizeof == 4)
55*4882a593Smuzhiyun 	  header_size = EFI32_HEADER_SIZE;
56*4882a593Smuzhiyun@@ -1293,76 +1310,50 @@ grub_install_generate_image (const char *dir, const char *prefix,
57*4882a593Smuzhiyun 	/* The PE Optional header.  */
58*4882a593Smuzhiyun 	if (image_target->voidp_sizeof == 4)
59*4882a593Smuzhiyun 	  {
60*4882a593Smuzhiyun-	    struct grub_pe32_optional_header *o;
61*4882a593Smuzhiyun-
62*4882a593Smuzhiyun 	    c->optional_header_size = grub_host_to_target16 (sizeof (struct grub_pe32_optional_header));
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun-	    o = (struct grub_pe32_optional_header *)
65*4882a593Smuzhiyun-	      (header + GRUB_PE32_MSDOS_STUB_SIZE + GRUB_PE32_SIGNATURE_SIZE
66*4882a593Smuzhiyun-	       + sizeof (struct grub_pe32_coff_header));
67*4882a593Smuzhiyun-	    o->magic = grub_host_to_target16 (GRUB_PE32_PE32_MAGIC);
68*4882a593Smuzhiyun-	    o->code_size = grub_host_to_target32 (layout.exec_size);
69*4882a593Smuzhiyun-	    o->data_size = grub_host_to_target32 (reloc_addr - layout.exec_size
70*4882a593Smuzhiyun-					     - header_size);
71*4882a593Smuzhiyun-	    o->entry_addr = grub_host_to_target32 (layout.start_address);
72*4882a593Smuzhiyun-	    o->code_base = grub_host_to_target32 (header_size);
73*4882a593Smuzhiyun-
74*4882a593Smuzhiyun-	    o->data_base = grub_host_to_target32 (header_size + layout.exec_size);
75*4882a593Smuzhiyun-
76*4882a593Smuzhiyun-	    o->image_base = 0;
77*4882a593Smuzhiyun-	    o->section_alignment = grub_host_to_target32 (image_target->section_align);
78*4882a593Smuzhiyun-	    o->file_alignment = grub_host_to_target32 (GRUB_PE32_FILE_ALIGNMENT);
79*4882a593Smuzhiyun-	    o->image_size = grub_host_to_target32 (pe_size);
80*4882a593Smuzhiyun-	    o->header_size = grub_host_to_target32 (header_size);
81*4882a593Smuzhiyun-	    o->subsystem = grub_host_to_target16 (GRUB_PE32_SUBSYSTEM_EFI_APPLICATION);
82*4882a593Smuzhiyun-
83*4882a593Smuzhiyun-	    /* Do these really matter? */
84*4882a593Smuzhiyun-	    o->stack_reserve_size = grub_host_to_target32 (0x10000);
85*4882a593Smuzhiyun-	    o->stack_commit_size = grub_host_to_target32 (0x10000);
86*4882a593Smuzhiyun-	    o->heap_reserve_size = grub_host_to_target32 (0x10000);
87*4882a593Smuzhiyun-	    o->heap_commit_size = grub_host_to_target32 (0x10000);
88*4882a593Smuzhiyun-
89*4882a593Smuzhiyun-	    o->num_data_directories = grub_host_to_target32 (GRUB_PE32_NUM_DATA_DIRECTORIES);
90*4882a593Smuzhiyun+	    o32 = (struct grub_pe32_optional_header *)
91*4882a593Smuzhiyun+              (header + GRUB_PE32_MSDOS_STUB_SIZE + GRUB_PE32_SIGNATURE_SIZE +
92*4882a593Smuzhiyun+               sizeof (struct grub_pe32_coff_header));
93*4882a593Smuzhiyun+	    o32->magic = grub_host_to_target16 (GRUB_PE32_PE32_MAGIC);
94*4882a593Smuzhiyun+	    o32->data_base = grub_host_to_target32 (header_size + layout.exec_size);
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun-	    o->base_relocation_table.rva = grub_host_to_target32 (reloc_addr);
97*4882a593Smuzhiyun-	    o->base_relocation_table.size = grub_host_to_target32 (layout.reloc_size);
98*4882a593Smuzhiyun-	    sections = o + 1;
99*4882a593Smuzhiyun+	    sections = o32 + 1;
100*4882a593Smuzhiyun 	  }
101*4882a593Smuzhiyun 	else
102*4882a593Smuzhiyun 	  {
103*4882a593Smuzhiyun-	    struct grub_pe64_optional_header *o;
104*4882a593Smuzhiyun-
105*4882a593Smuzhiyun 	    c->optional_header_size = grub_host_to_target16 (sizeof (struct grub_pe64_optional_header));
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun-	    o = (struct grub_pe64_optional_header *)
108*4882a593Smuzhiyun-	      (header + GRUB_PE32_MSDOS_STUB_SIZE + GRUB_PE32_SIGNATURE_SIZE
109*4882a593Smuzhiyun-	       + sizeof (struct grub_pe32_coff_header));
110*4882a593Smuzhiyun-	    o->magic = grub_host_to_target16 (GRUB_PE32_PE64_MAGIC);
111*4882a593Smuzhiyun-	    o->code_size = grub_host_to_target32 (layout.exec_size);
112*4882a593Smuzhiyun-	    o->data_size = grub_host_to_target32 (reloc_addr - layout.exec_size
113*4882a593Smuzhiyun-					     - header_size);
114*4882a593Smuzhiyun-	    o->entry_addr = grub_host_to_target32 (layout.start_address);
115*4882a593Smuzhiyun-	    o->code_base = grub_host_to_target32 (header_size);
116*4882a593Smuzhiyun-	    o->image_base = 0;
117*4882a593Smuzhiyun-	    o->section_alignment = grub_host_to_target32 (image_target->section_align);
118*4882a593Smuzhiyun-	    o->file_alignment = grub_host_to_target32 (GRUB_PE32_FILE_ALIGNMENT);
119*4882a593Smuzhiyun-	    o->image_size = grub_host_to_target32 (pe_size);
120*4882a593Smuzhiyun-	    o->header_size = grub_host_to_target32 (header_size);
121*4882a593Smuzhiyun-	    o->subsystem = grub_host_to_target16 (GRUB_PE32_SUBSYSTEM_EFI_APPLICATION);
122*4882a593Smuzhiyun-
123*4882a593Smuzhiyun-	    /* Do these really matter? */
124*4882a593Smuzhiyun-	    o->stack_reserve_size = grub_host_to_target32 (0x10000);
125*4882a593Smuzhiyun-	    o->stack_commit_size = grub_host_to_target32 (0x10000);
126*4882a593Smuzhiyun-	    o->heap_reserve_size = grub_host_to_target32 (0x10000);
127*4882a593Smuzhiyun-	    o->heap_commit_size = grub_host_to_target32 (0x10000);
128*4882a593Smuzhiyun-
129*4882a593Smuzhiyun-	    o->num_data_directories
130*4882a593Smuzhiyun-	      = grub_host_to_target32 (GRUB_PE32_NUM_DATA_DIRECTORIES);
131*4882a593Smuzhiyun+	    o64 = (struct grub_pe64_optional_header *)
132*4882a593Smuzhiyun+		  (header + GRUB_PE32_MSDOS_STUB_SIZE + GRUB_PE32_SIGNATURE_SIZE +
133*4882a593Smuzhiyun+                   sizeof (struct grub_pe32_coff_header));
134*4882a593Smuzhiyun+	    o64->magic = grub_host_to_target16 (GRUB_PE32_PE64_MAGIC);
135*4882a593Smuzhiyun
136*4882a593Smuzhiyun-	    o->base_relocation_table.rva = grub_host_to_target32 (reloc_addr);
137*4882a593Smuzhiyun-	    o->base_relocation_table.size = grub_host_to_target32 (layout.reloc_size);
138*4882a593Smuzhiyun-	    sections = o + 1;
139*4882a593Smuzhiyun+	    sections = o64 + 1;
140*4882a593Smuzhiyun 	  }
141*4882a593Smuzhiyun+
142*4882a593Smuzhiyun+	PE_OHDR (o32, o64, code_size) = grub_host_to_target32 (layout.exec_size);
143*4882a593Smuzhiyun+	PE_OHDR (o32, o64, data_size) = grub_host_to_target32 (reloc_addr - layout.exec_size - header_size);
144*4882a593Smuzhiyun+	PE_OHDR (o32, o64, entry_addr) = grub_host_to_target32 (layout.start_address);
145*4882a593Smuzhiyun+	PE_OHDR (o32, o64, code_base) = grub_host_to_target32 (header_size);
146*4882a593Smuzhiyun+
147*4882a593Smuzhiyun+	PE_OHDR (o32, o64, image_base) = 0;
148*4882a593Smuzhiyun+	PE_OHDR (o32, o64, section_alignment) = grub_host_to_target32 (image_target->section_align);
149*4882a593Smuzhiyun+	PE_OHDR (o32, o64, file_alignment) = grub_host_to_target32 (GRUB_PE32_FILE_ALIGNMENT);
150*4882a593Smuzhiyun+	PE_OHDR (o32, o64, image_size) = grub_host_to_target32 (pe_size);
151*4882a593Smuzhiyun+	PE_OHDR (o32, o64, header_size) = grub_host_to_target32 (header_size);
152*4882a593Smuzhiyun+	PE_OHDR (o32, o64, subsystem) = grub_host_to_target16 (GRUB_PE32_SUBSYSTEM_EFI_APPLICATION);
153*4882a593Smuzhiyun+
154*4882a593Smuzhiyun+	/* Do these really matter? */
155*4882a593Smuzhiyun+	PE_OHDR (o32, o64, stack_reserve_size) = grub_host_to_target32 (0x10000);
156*4882a593Smuzhiyun+	PE_OHDR (o32, o64, stack_commit_size) = grub_host_to_target32 (0x10000);
157*4882a593Smuzhiyun+	PE_OHDR (o32, o64, heap_reserve_size) = grub_host_to_target32 (0x10000);
158*4882a593Smuzhiyun+	PE_OHDR (o32, o64, heap_commit_size) = grub_host_to_target32 (0x10000);
159*4882a593Smuzhiyun+
160*4882a593Smuzhiyun+	PE_OHDR (o32, o64, num_data_directories) = grub_host_to_target32 (GRUB_PE32_NUM_DATA_DIRECTORIES);
161*4882a593Smuzhiyun+	PE_OHDR (o32, o64, base_relocation_table.rva) = grub_host_to_target32 (reloc_addr);
162*4882a593Smuzhiyun+	PE_OHDR (o32, o64, base_relocation_table.size) = grub_host_to_target32 (layout.reloc_size);
163*4882a593Smuzhiyun+
164*4882a593Smuzhiyun 	/* The sections.  */
165*4882a593Smuzhiyun 	text_section = sections;
166*4882a593Smuzhiyun 	strcpy (text_section->name, ".text");
167*4882a593Smuzhiyun--
168*4882a593Smuzhiyun2.14.2
169*4882a593Smuzhiyun
170