Skip to contentSkip to conversation

EFI: strip xen.efi when putting it on the EFI partition

PATCH Superseded Jan Beulich 5 participants 8 messages Jun 9, 2022 – Jul 7, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 EFI: strip xen.efi when putting it on the EFI partition

With debug info retained, xen.efi can be quite large. Unlike for xen.gz there's no intermediate step (mkelf32 there) involved which would strip debug info kind of as a side effect. While the installing of xen.efi on the EFI partition is an optional step (intended to be a courtesy to the developer), adjust it also for the purpose of documenting what distros would be expected to do during boot loader configuration (which is what would normally put xen.efi into the EFI partition).

Model the control over stripping after Linux'es module installation, except that the stripped executable is constructed in the build area instead of in the destination location. This is to conserve on space used there - EFI partitions tend to be only a few hundred Mb in size.

---
GNU strip 2.38 appears to have issues when acting on a PE binary:
- file name symbols are also stripped; while there is a separate --keep-file-symbols option (which I would have thought to be on by default anyway), its use so far makes no difference,
- the string table grows in size, when one would expect it to retain its size (or shrink),
- linker version is changed in and timestamp zapped from the header. Older GNU strip (observed with 2.35.1) doesn't work at all ("Data Directory size (1c) exceeds space left in section (8)").

Future GNU strip is going to honor --keep-file-symbols (and will also have the other issues fixed). Question is whether we should use that option (for the symbol table as a whole to make sense), or whether instead we should (by default) strip the symbol table as well.

xen/Makefile +19 -0
@@ -465,6 +465,22 @@ endif
 .PHONY: _build
 _build: $(TARGET)$(CONFIG_XEN_INSTALL_SUFFIX)
 
+# Strip
+#
+# INSTALL_EFI_STRIP, if defined, will cause xen.efi to be stripped before it
+# is installed. If INSTALL_EFI_STRIP is '1', then the default option
+# --strip-debug will be used. Otherwise, INSTALL_EFI_STRIP value will be used
+# as the option(s) to the strip command.
+ifdef INSTALL_EFI_STRIP
+
+ifeq ($(INSTALL_EFI_STRIP),1)
+efi-strip-opt := --strip-debug
+else
+efi-strip-opt := $(INSTALL_EFI_STRIP)
+endif
+
+endif
+
 .PHONY: _install
 _install: D=$(DESTDIR)
 _install: T=$(notdir $(TARGET))
@@ -489,6 +505,9 @@ _install: $(TARGET)$(CONFIG_XEN_INSTALL_
 		ln -sf $(T)-$(XEN_FULLVERSION).efi $(D)$(EFI_DIR)/$(T)-$(XEN_VERSION).efi; \
 		ln -sf $(T)-$(XEN_FULLVERSION).efi $(D)$(EFI_DIR)/$(T).efi; \
 		if [ -n '$(EFI_MOUNTPOINT)' -a -n '$(EFI_VENDOR)' ]; then \
+			$(if $(efi-strip-opt), \
+			     $(STRIP) $(efi-strip-opt) -p -o $(TARGET).efi.stripped $(TARGET).efi && \
+			     $(INSTALL_DATA) $(TARGET).efi.stripped $(D)$(EFI_MOUNTPOINT)/efi/$(EFI_VENDOR)/$(T)-$(XEN_FULLVERSION).efi ||) \
 			$(INSTALL_DATA) $(TARGET).efi $(D)$(EFI_MOUNTPOINT)/efi/$(EFI_VENDOR)/$(T)-$(XEN_FULLVERSION).efi; \
 		elif [ "$(D)" = "$(patsubst $(shell cd $(XEN_ROOT) && pwd)/%,%,$(D))" ]; then \
 			echo 'EFI installation only partially done (EFI_VENDOR not set)' >&2; \
#1 lore raw
Quoted 25 lines · Jan Beulich

With debug info retained, xen.efi can be quite large. Unlike for xen.gz there's no intermediate step (mkelf32 there) involved which would strip debug info kind of as a side effect. While the installing of xen.efi on the EFI partition is an optional step (intended to be a courtesy to the developer), adjust it also for the purpose of documenting what distros would be expected to do during boot loader configuration (which is what would normally put xen.efi into the EFI partition).

Model the control over stripping after Linux'es module installation, except that the stripped executable is constructed in the build area instead of in the destination location. This is to conserve on space used there - EFI partitions tend to be only a few hundred Mb in size.

---
GNU strip 2.38 appears to have issues when acting on a PE binary:
- file name symbols are also stripped; while there is a separate --keep-file-symbols option (which I would have thought to be on by default anyway), its use so far makes no difference,
- the string table grows in size, when one would expect it to retain its size (or shrink),
- linker version is changed in and timestamp zapped from the header. Older GNU strip (observed with 2.35.1) doesn't work at all ("Data Directory size (1c) exceeds space left in section (8)").

Quoted 4 lines

Future GNU strip is going to honor --keep-file-symbols (and will also have the other issues fixed). Question is whether we should use that option (for the symbol table as a whole to make sense), or whether instead we should (by default) strip the symbol table as well.

Without any feedback / ack I guess I'll consider this of no interest (despite having heard otherwise, triggering me to put together the patch in the first place), and put on the pile of effectively rejected patches.

Jan

#2 lore raw

Hi Jan,

Quoted 31 lines · Jan Beulich
Quoted 25 lines · Jan Beulich

With debug info retained, xen.efi can be quite large. Unlike for xen.gz there's no intermediate step (mkelf32 there) involved which would strip debug info kind of as a side effect. While the installing of xen.efi on the EFI partition is an optional step (intended to be a courtesy to the developer), adjust it also for the purpose of documenting what distros would be expected to do during boot loader configuration (which is what would normally put xen.efi into the EFI partition).

Model the control over stripping after Linux'es module installation, except that the stripped executable is constructed in the build area instead of in the destination location. This is to conserve on space used there - EFI partitions tend to be only a few hundred Mb in size.

---
GNU strip 2.38 appears to have issues when acting on a PE binary:
- file name symbols are also stripped; while there is a separate --keep-file-symbols option (which I would have thought to be on by default anyway), its use so far makes no difference,
- the string table grows in size, when one would expect it to retain its size (or shrink),
- linker version is changed in and timestamp zapped from the header. Older GNU strip (observed with 2.35.1) doesn't work at all ("Data Directory size (1c) exceeds space left in section (8)").

Quoted 4 lines

Future GNU strip is going to honor --keep-file-symbols (and will also have the other issues fixed). Question is whether we should use that option (for the symbol table as a whole to make sense), or whether instead we should (by default) strip the symbol table as well.

Quoted 4 lines

Without any feedback / ack I guess I'll consider this of no interest (despite having heard otherwise, triggering me to put together the patch in the first place), and put on the pile of effectively rejected patches.

Sorry, I haven't looked at this patch because I am not very familiar with the Makefile code. Reading through the commit message, I think having this patch would be quite beneficial.

Regarding the review, Anthony has been working on the build system recently. So maybe he could give a review? (I have CCed him).

Cheers,

Signature · 1 line
Julien Grall
Tested-by
#3 lore raw
In reply to Jan Beulich

Hi Jan,

Quoted 34 lines

-----Original Message-----
Subject: Re: [PATCH] EFI: strip xen.efi when putting it on the EFI partition

Quoted 25 lines · Jan Beulich

With debug info retained, xen.efi can be quite large. Unlike for xen.gz there's no intermediate step (mkelf32 there) involved which would strip debug info kind of as a side effect. While the installing of xen.efi on the EFI partition is an optional step (intended to be a courtesy to the developer), adjust it also for the purpose of documenting what distros would be expected to do during boot loader configuration (which is what would normally put xen.efi into the EFI partition).

Model the control over stripping after Linux'es module installation, except that the stripped executable is constructed in the build area instead of in the destination location. This is to conserve on space used there - EFI partitions tend to be only a few hundred Mb in size.

---
GNU strip 2.38 appears to have issues when acting on a PE binary:
- file name symbols are also stripped; while there is a separate --keep-file-symbols option (which I would have thought to be on by default anyway), its use so far makes no difference,
- the string table grows in size, when one would expect it to retain its size (or shrink),
- linker version is changed in and timestamp zapped from the header. Older GNU strip (observed with 2.35.1) doesn't work at all ("Data Directory size (1c) exceeds space left in section (8)").

Quoted 4 lines

Future GNU strip is going to honor --keep-file-symbols (and will also have the other issues fixed). Question is whether we should use that option (for the symbol table as a whole to make sense), or whether instead we should (by default) strip the symbol table as well.

Quoted 4 lines

Without any feedback / ack I guess I'll consider this of no interest (despite having heard otherwise, triggering me to put together the patch in the first place), and put on the pile of effectively rejected patches.

I did a test for this patch on my x86 machine and I think this patch is doing the correct thing, so:

I also noticed that Julien is suggesting maybe we can have Anthony as the reviewer for this patch, so I also add him in the CC of this email.

Kind regards,
Henry

Quoted 2 lines

Jan

#4 lore raw

Hi Jan,

Quoted 41 lines · Henry Wang

Hi Jan,

Quoted 34 lines

-----Original Message-----
Subject: Re: [PATCH] EFI: strip xen.efi when putting it on the EFI partition

Quoted 25 lines · Jan Beulich

With debug info retained, xen.efi can be quite large. Unlike for xen.gz there's no intermediate step (mkelf32 there) involved which would strip debug info kind of as a side effect. While the installing of xen.efi on the EFI partition is an optional step (intended to be a courtesy to the developer), adjust it also for the purpose of documenting what distros would be expected to do during boot loader configuration (which is what would normally put xen.efi into the EFI partition).

Model the control over stripping after Linux'es module installation, except that the stripped executable is constructed in the build area instead of in the destination location. This is to conserve on space used there - EFI partitions tend to be only a few hundred Mb in size.

---
GNU strip 2.38 appears to have issues when acting on a PE binary:
- file name symbols are also stripped; while there is a separate --keep-file-symbols option (which I would have thought to be on by default anyway), its use so far makes no difference,
- the string table grows in size, when one would expect it to retain its size (or shrink),
- linker version is changed in and timestamp zapped from the header. Older GNU strip (observed with 2.35.1) doesn't work at all ("Data Directory size (1c) exceeds space left in section (8)").

Quoted 4 lines

Future GNU strip is going to honor --keep-file-symbols (and will also have the other issues fixed). Question is whether we should use that option (for the symbol table as a whole to make sense), or whether instead we should (by default) strip the symbol table as well.

Quoted 4 lines

Without any feedback / ack I guess I'll consider this of no interest (despite having heard otherwise, triggering me to put together the patch in the first place), and put on the pile of effectively rejected patches.

Quoted 5 lines

I did a test for this patch on my x86 machine and I think this patch is doing the correct thing, so:

Because there was no Arm EFI environment in hand at the time, Henry only tested the x86 part.I have setup an Arm platform with UEFI v2.70 (EDK II, 0x00010000) today, and this patch works well when boot Xen as an EFI application from UEFI shell.

But the binaries sizes are the same with/without this patch. Is it expected? I have enabled:
CONFIG_DEBUG=y
CONFIG_DEBUG_INFO=y
Is there anything I should be aware to test this patch?

-rwxrwxr-x 1 weic weic 1081504 Jul 7 18:43 xen
-rwxrwxr-x 1 weic weic 1081504 Jul 7 19:43 xen

Tested-by (Arm only): Wei Chen <[email protected]>

Thanks,
Wei Chen

Quoted 9 lines

I also noticed that Julien is suggesting maybe we can have Anthony as the reviewer for this patch, so I also add him in the CC of this email.

Kind regards,
Henry

Quoted 2 lines

Jan

author Tested-by Wei Chen
#5 lore raw
Quoted 55 lines · Wei Chen

Hi Jan,

Quoted 41 lines · Henry Wang

Hi Jan,

Quoted 34 lines

-----Original Message-----
Subject: Re: [PATCH] EFI: strip xen.efi when putting it on the EFI partition

Quoted 25 lines · Jan Beulich

With debug info retained, xen.efi can be quite large. Unlike for xen.gz there's no intermediate step (mkelf32 there) involved which would strip debug info kind of as a side effect. While the installing of xen.efi on the EFI partition is an optional step (intended to be a courtesy to the developer), adjust it also for the purpose of documenting what distros would be expected to do during boot loader configuration (which is what would normally put xen.efi into the EFI partition).

Model the control over stripping after Linux'es module installation, except that the stripped executable is constructed in the build area instead of in the destination location. This is to conserve on space used there - EFI partitions tend to be only a few hundred Mb in size.

---
GNU strip 2.38 appears to have issues when acting on a PE binary:
- file name symbols are also stripped; while there is a separate --keep-file-symbols option (which I would have thought to be on by default anyway), its use so far makes no difference,
- the string table grows in size, when one would expect it to retain its size (or shrink),
- linker version is changed in and timestamp zapped from the header. Older GNU strip (observed with 2.35.1) doesn't work at all ("Data Directory size (1c) exceeds space left in section (8)").

Quoted 4 lines

Future GNU strip is going to honor --keep-file-symbols (and will also have the other issues fixed). Question is whether we should use that option (for the symbol table as a whole to make sense), or whether instead we should (by default) strip the symbol table as well.

Quoted 4 lines

Without any feedback / ack I guess I'll consider this of no interest (despite having heard otherwise, triggering me to put together the patch in the first place), and put on the pile of effectively rejected patches.

Quoted 5 lines

I did a test for this patch on my x86 machine and I think this patch is doing the correct thing, so:

Because there was no Arm EFI environment in hand at the time, Henry only tested the x86 part.I have setup an Arm platform with UEFI v2.70 (EDK II, 0x00010000) today, and this patch works well when boot Xen as an EFI application from UEFI shell.

Quoted 4 lines

But the binaries sizes are the same with/without this patch. Is it expected? I have enabled:
CONFIG_DEBUG=y
CONFIG_DEBUG_INFO=y

Well, the way "xen" is built (and "xen.efi" only being an alias thereof), debug info is stripped in the course. That's quite different from x86, where - with a new enough linker - debug info is retained while linking (and it is truly linking by which xen.efi is built), and hence can make sense to strip while installing.

Quoted 6 lines

Is there anything I should be aware to test this patch?

(quoted diff) +0 -2
-rwxrwxr-x 1 weic weic 1081504 Jul  7 18:43 xen
-rwxrwxr-x 1 weic weic 1081504 Jul  7 19:43 xen

Tested-by (Arm only): Wei Chen <[email protected]>

Thanks. Btw the proper form of the tag, as of a couple of months ago, is

Jan

#6 lore raw
In reply to Jan Beulich
Quoted 25 lines · Jan Beulich

With debug info retained, xen.efi can be quite large. Unlike for xen.gz there's no intermediate step (mkelf32 there) involved which would strip debug info kind of as a side effect. While the installing of xen.efi on the EFI partition is an optional step (intended to be a courtesy to the developer), adjust it also for the purpose of documenting what distros would be expected to do during boot loader configuration (which is what would normally put xen.efi into the EFI partition).

Model the control over stripping after Linux'es module installation, except that the stripped executable is constructed in the build area instead of in the destination location. This is to conserve on space used there - EFI partitions tend to be only a few hundred Mb in size.

---
GNU strip 2.38 appears to have issues when acting on a PE binary:
- file name symbols are also stripped; while there is a separate --keep-file-symbols option (which I would have thought to be on by default anyway), its use so far makes no difference,
- the string table grows in size, when one would expect it to retain its size (or shrink),
- linker version is changed in and timestamp zapped from the header. Older GNU strip (observed with 2.35.1) doesn't work at all ("Data Directory size (1c) exceeds space left in section (8)").

Quoted 4 lines

Future GNU strip is going to honor --keep-file-symbols (and will also have the other issues fixed). Question is whether we should use that option (for the symbol table as a whole to make sense), or whether instead we should (by default) strip the symbol table as well.

I guess trying to keep those symbol might be useful, if it's not too big, to help debugging system in production.

xen/Makefile endif · line 473

Quoted 12 lines
xen/Makefile +6 -0
@@ -465,6 +465,22 @@ endif
 .PHONY: _build
 _build: $(TARGET)$(CONFIG_XEN_INSTALL_SUFFIX)
 
+# Strip
+#
+# INSTALL_EFI_STRIP, if defined, will cause xen.efi to be stripped before it
+# is installed. If INSTALL_EFI_STRIP is '1', then the default option
+# --strip-debug will be used. Otherwise, INSTALL_EFI_STRIP value will be used
+# as the option(s) to the strip command.

It would be useful to also document INSTALL_EFI_STRIP in ./INSTALL or in ./docs/misc/efi.pandoc (efi.pandoc is where EFI_VENDOR is documented for example, so probably a better place for the doc of the new option).

Quoted 14 lines
xen/Makefile +10 -0
+ifdef INSTALL_EFI_STRIP
+
+ifeq ($(INSTALL_EFI_STRIP),1)
+efi-strip-opt := --strip-debug
+else
+efi-strip-opt := $(INSTALL_EFI_STRIP)
+endif
+
+endif
+
 .PHONY: _install
 _install: D=$(DESTDIR)
 _install: T=$(notdir $(TARGET))

xen/Makefile _install: $(TARGET)$(CONFIG_XEN_INSTALL_ · line 510

Quoted 6 lines
xen/Makefile +3 -0
@@ -489,6 +505,9 @@ _install: $(TARGET)$(CONFIG_XEN_INSTALL_
 		ln -sf $(T)-$(XEN_FULLVERSION).efi $(D)$(EFI_DIR)/$(T)-$(XEN_VERSION).efi; \
 		ln -sf $(T)-$(XEN_FULLVERSION).efi $(D)$(EFI_DIR)/$(T).efi; \
 		if [ -n '$(EFI_MOUNTPOINT)' -a -n '$(EFI_VENDOR)' ]; then \
+			$(if $(efi-strip-opt), \
+			     $(STRIP) $(efi-strip-opt) -p -o $(TARGET).efi.stripped $(TARGET).efi && \
+			     $(INSTALL_DATA) $(TARGET).efi.stripped $(D)$(EFI_MOUNTPOINT)/efi/$(EFI_VENDOR)/$(T)-$(XEN_FULLVERSION).efi ||) \

This optional part of the script that ends with "||" means that if strip or install fails, we would install the non stripped binary. Is this something that's acceptable? (Plus of doing that is avoiding changing the next line, and avoiding a longer $(if ,).

xen/Makefile _install: $(TARGET)$(CONFIG_XEN_INSTALL_ · line 513

Quoted 3 lines
xen/Makefile +0 -0
 			$(INSTALL_DATA) $(TARGET).efi $(D)$(EFI_MOUNTPOINT)/efi/$(EFI_VENDOR)/$(T)-$(XEN_FULLVERSION).efi; \
 		elif [ "$(D)" = "$(patsubst $(shell cd $(XEN_ROOT) && pwd)/%,%,$(D))" ]; then \
 			echo 'EFI installation only partially done (EFI_VENDOR not set)' >&2; \

An other thing, the "*.efi.stripped" file is I think going to be left over and not removed during make clean.

Cheers,

Signature · 1 line
Anthony PERARD
#7 lore raw
Quoted 7 lines · Anthony PERARD
Quoted 6 lines · Jan Beulich
xen/Makefile +0 -0
@@ -465,6 +465,22 @@ endif
 .PHONY: _build
 _build: $(TARGET)$(CONFIG_XEN_INSTALL_SUFFIX)
 
Quoted 10 lines

xen/Makefile endif · line 473

Quoted 6 lines
xen/Makefile +6 -0
+# Strip
+#
+# INSTALL_EFI_STRIP, if defined, will cause xen.efi to be stripped before it
+# is installed. If INSTALL_EFI_STRIP is '1', then the default option
+# --strip-debug will be used. Otherwise, INSTALL_EFI_STRIP value will be used
+# as the option(s) to the strip command.

It would be useful to also document INSTALL_EFI_STRIP in ./INSTALL or in ./docs/misc/efi.pandoc (efi.pandoc is where EFI_VENDOR is documented for example, so probably a better place for the doc of the new option).

Well, imo it's far preferable to install _something_ that works (even if it consumes more space) than not installing anything.

I'll look into addressing the other two comments you gave.

Jan