Skip to contentSkip to conversation

Makefile: rework u-boot-initial-env target

PATCH Superseded Max Krummenacher 4 participants 7 messages Nov 8, 2022 – Nov 23, 2022 Kbuild

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v4 cover Makefile: rework u-boot-initial-env target

From: Max Krummenacher <[email protected]>

With CONFIG_LTO enabled the current way of extracting the configured environment no longer works, i.e. the object file content changes due to LTO.

Build a host tool which prints the configured environment instead of using objcopy and friends to achive the same.

The code and Makefile changes were mostly stolen from tools/env/ i.e. the target userspace tools to access the environment.

Changes in v4:
- add '(objtree)/' when calling the tool. Suggested by Pali Rohár.
- renamed patch, as more than just the Makefile has changes

Changes in v3:
- moved the tool from scripts/ to tools/. Suggested by Tom Rini
- changed the dependencies to '$(env_h)' and 'tools'. Suggested by Tom Rini and Pali Rohár.
- removed the sed rule which replaces \x00 with \x0A as this is already done by the tool. Suggested by Pali Rohár.

Changes in v2:
- reworked to build a host tool which prints the configured environment as proposed by Pali Rohár
https://lore.kernel.org/u-boot/[email protected]/
- renamed patch, v1 used "Makefile: fix u-boot-initial-env target if lto is enabled"

Max Krummenacher (1):
u-boot-initial-env: rework make target

 Makefile                |  9 +++++----
 tools/.gitignore        |  1 +
 tools/Makefile          |  3 +++
 tools/printinitialenv.c | 44 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 53 insertions(+), 4 deletions(-)
 create mode 100644 tools/printinitialenv.c
Signature · 1 line
2.35.3
#1 lore raw

PATCH v4 1/1 u-boot-initial-env: rework make target

From: Max Krummenacher <[email protected]>

With LTO enabled the U-Boot initial environment is no longer stored in an easy accessible section in env/common.o. I.e. the section name changes from build to build, its content maybe compressed and it is annotated with additional data.

Drop trying to read the initial env with elf tools from the compiler specific object file in favour of adding and using a host tool with the only functionality of printing the initial env to stdout.

See also:
https://lore.kernel.org/all/[email protected]/

---

Changes in v4:
- add '(objtree)/' when calling the tool. Suggested by Pali Rohár.
- renamed patch, as more than just the Makefile has changes

Changes in v3:
- moved the tool from scripts/ to tools/. Suggested by Tom Rini
- changed the dependencies to '$(env_h)' and 'tools'. Suggested by Tom Rini and Pali Rohár.
- removed the sed rule which replaces \x00 with \x0A as this is already done by the tool. Suggested by Pali Rohár.

Changes in v2:
- reworked to build a host tool which prints the configured environment as proposed by Pali Rohár
https://lore.kernel.org/u-boot/[email protected]/
- renamed patch, v1 used "Makefile: fix u-boot-initial-env target if lto is enabled"

 Makefile                |  9 +++++----
 tools/.gitignore        |  1 +
 tools/Makefile          |  3 +++
 tools/printinitialenv.c | 44 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 53 insertions(+), 4 deletions(-)
 create mode 100644 tools/printinitialenv.c
Makefile +5 -4
index 0f1174718f7..c0669840dc7 100644
@@ -2442,11 +2442,12 @@ endif
 	$(Q)$(MAKE) -f $(srctree)/scripts/Makefile.modpost
 
 quiet_cmd_genenv = GENENV  $@
-cmd_genenv = $(OBJCOPY) --dump-section .rodata.default_environment=$@ env/common.o; \
-	sed --in-place -e 's/\x00/\x0A/g' $@; sed --in-place -e '/^\s*$$/d' $@; \
-	sort --field-separator== -k1,1 --stable $@ -o $@
+cmd_genenv = \
+	$(objtree)/tools/printinitialenv | \
+	sed -e '/^\s*$$/d' | \
+	sort --field-separator== -k1,1 --stable -o $@
 
-u-boot-initial-env: u-boot.bin
+u-boot-initial-env: $(env_h) tools FORCE
 	$(call if_changed,genenv)
 
 # Consistency checks
tools/.gitignore +1 -0
index d3a93ff294a..28e8ce2a07a 100644
@@ -28,6 +28,7 @@
 /mxsboot
 /ncb
 /prelink-riscv
+/printinitialenv
 /proftool
 /relocate-rela
 /spl_size_limit
tools/Makefile +3 -0
index 34a1aa7a8b7..a3afdee7813 100644
@@ -245,6 +245,9 @@ hostprogs-$(CONFIG_MIPS) += mips-relocs
 hostprogs-$(CONFIG_ASN1_COMPILER)	+= asn1_compiler
 HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include
 
+# host tool to dump the currently configured default environment
+hostprogs-y				+= printinitialenv
+
 HOSTCFLAGS_mkeficapsule.o += \
 	$(shell pkg-config --cflags gnutls 2> /dev/null || echo "")
 HOSTCFLAGS_mkeficapsule.o += \
tools/printinitialenv.c new file +44 -0

44 lines not on this page · raw message

Signature · 1 line
2.35.3
Acked-by on v4 1/1
#2 lore raw

Re: [PATCH v4 1/1] u-boot-initial-env: rework make target

Quoted 7 lines · On Tuesday 08 November 2022 09:52:22 Max Krummenacher wrote:

From: Max Krummenacher <[email protected]>

With LTO enabled the U-Boot initial environment is no longer stored in an easy accessible section in env/common.o. I.e. the section name changes from build to build, its content maybe compressed and it is annotated with additional data.

Quoted 8 lines

Drop trying to read the initial env with elf tools from the compiler specific object file in favour of adding and using a host tool with the only functionality of printing the initial env to stdout.

See also:
https://lore.kernel.org/all/[email protected]/

Looks good,

Quoted 126 lines

---

Changes in v4:
- add '(objtree)/' when calling the tool. Suggested by Pali Rohár.
- renamed patch, as more than just the Makefile has changes

Changes in v3:
- moved the tool from scripts/ to tools/. Suggested by Tom Rini
- changed the dependencies to '$(env_h)' and 'tools'. Suggested by Tom Rini and Pali Rohár.
- removed the sed rule which replaces \x00 with \x0A as this is already done by the tool. Suggested by Pali Rohár.

Changes in v2:
- reworked to build a host tool which prints the configured environment as proposed by Pali Rohár
https://lore.kernel.org/u-boot/[email protected]/
- renamed patch, v1 used "Makefile: fix u-boot-initial-env target if lto is enabled"

 Makefile                |  9 +++++----
 tools/.gitignore        |  1 +
 tools/Makefile          |  3 +++
 tools/printinitialenv.c | 44 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 53 insertions(+), 4 deletions(-)
 create mode 100644 tools/printinitialenv.c
Makefile +5 -4
index 0f1174718f7..c0669840dc7 100644
@@ -2442,11 +2442,12 @@ endif
 	$(Q)$(MAKE) -f $(srctree)/scripts/Makefile.modpost
 
 quiet_cmd_genenv = GENENV  $@
-cmd_genenv = $(OBJCOPY) --dump-section .rodata.default_environment=$@ env/common.o; \
-	sed --in-place -e 's/\x00/\x0A/g' $@; sed --in-place -e '/^\s*$$/d' $@; \
-	sort --field-separator== -k1,1 --stable $@ -o $@
+cmd_genenv = \
+	$(objtree)/tools/printinitialenv | \
+	sed -e '/^\s*$$/d' | \
+	sort --field-separator== -k1,1 --stable -o $@
 
-u-boot-initial-env: u-boot.bin
+u-boot-initial-env: $(env_h) tools FORCE
 	$(call if_changed,genenv)
 
 # Consistency checks
tools/.gitignore +1 -0
index d3a93ff294a..28e8ce2a07a 100644
@@ -28,6 +28,7 @@
 /mxsboot
 /ncb
 /prelink-riscv
+/printinitialenv
 /proftool
 /relocate-rela
 /spl_size_limit
tools/Makefile +3 -0
index 34a1aa7a8b7..a3afdee7813 100644
@@ -245,6 +245,9 @@ hostprogs-$(CONFIG_MIPS) += mips-relocs
 hostprogs-$(CONFIG_ASN1_COMPILER)	+= asn1_compiler
 HOSTCFLAGS_asn1_compiler.o = -idirafter $(srctree)/include
 
+# host tool to dump the currently configured default environment
+hostprogs-y				+= printinitialenv
+
 HOSTCFLAGS_mkeficapsule.o += \
 	$(shell pkg-config --cflags gnutls 2> /dev/null || echo "")
 HOSTCFLAGS_mkeficapsule.o += \
tools/printinitialenv.c new file +44 -0
new file mode 100644
index 00000000000..c58b234d679
@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * (C) Copyright 2022
+ * Max Krummenacher, Toradex
+ *
+ * Snippets taken from tools/env/fw_env.c
+ *
+ * This prints the list of default environment variables as currently
+ * configured.
+ *
+ */
+
+#include <stdio.h>
+
+/* Pull in the current config to define the default environment */
+#include <linux/kconfig.h>
+
+#ifndef __ASSEMBLY__
+#define __ASSEMBLY__ /* get only #defines from config.h */
+#include <config.h>
+#undef	__ASSEMBLY__
+#else
+#include <config.h>
+#endif
+
+#define DEFAULT_ENV_INSTANCE_STATIC
+#include <generated/environment.h>
+#include <env_default.h>
+
+int main(void)
+{
+	char *env, *nxt;
+
+	for (env = default_environment; *env; env = nxt + 1) {
+		for (nxt = env; *nxt; ++nxt) {
+			if (nxt >= &default_environment[sizeof(default_environment)]) {
+				fprintf(stderr, "## Error: environment not terminated\n");
+				return -1;
+			}
+		}
+		printf("%s\n", env);
+	}
+	return 0;
+}
Signature · 1 line
2.35.3
#3 lore raw

Re: [PATCH v4 1/1] u-boot-initial-env: rework make target

Quoted 12 lines · Pali Rohár
Quoted 11 lines · On Tuesday 08 November 2022 09:52:22 Max Krummenacher wrote:

From: Max Krummenacher <[email protected]>

With LTO enabled the U-Boot initial environment is no longer stored in an easy accessible section in env/common.o. I.e. the section name changes from build to build, its content maybe compressed and it is annotated with additional data.

Drop trying to read the initial env with elf tools from the compiler specific object file in favour of adding and using a host tool with the only functionality of printing the initial env to stdout.

Quoted 8 lines
Quoted 4 lines

See also:
https://lore.kernel.org/all/[email protected]/

Looks good,

Hello Tom,
what's your plan for this patch? Any concern?

Francesco

#4 lore raw

Re: [PATCH v4 1/1] u-boot-initial-env: rework make target

In reply to Max Krummenacher
Quoted 11 lines · Max Krummenacher

From: Max Krummenacher <[email protected]>

With LTO enabled the U-Boot initial environment is no longer stored in an easy accessible section in env/common.o. I.e. the section name changes from build to build, its content maybe compressed and it is annotated with additional data.

Drop trying to read the initial env with elf tools from the compiler specific object file in favour of adding and using a host tool with the only functionality of printing the initial env to stdout.

Quoted 5 lines

See also:
https://lore.kernel.org/all/[email protected]/

Alright, so 'make tools-only_defconfig tools-only' now fails to build because we're missing the dependencies to make sure that we have generated/environment.h available.
https://source.denx.de/u-boot/u-boot/-/jobs/532186

Signature · 1 line
Tom
#5 lore raw

Re: [PATCH v4 1/1] u-boot-initial-env: rework make target

Quoted 16 lines · On Wednesday 23 November 2022 13:18:40 Tom Rini wrote:
Quoted 14 lines · Max Krummenacher

From: Max Krummenacher <[email protected]>

With LTO enabled the U-Boot initial environment is no longer stored in an easy accessible section in env/common.o. I.e. the section name changes from build to build, its content maybe compressed and it is annotated with additional data.

Drop trying to read the initial env with elf tools from the compiler specific object file in favour of adding and using a host tool with the only functionality of printing the initial env to stdout.

See also:
https://lore.kernel.org/all/[email protected]/

Quoted 7 lines
Quoted 2 lines

Alright, so 'make tools-only_defconfig tools-only' now fails to build because we're missing the dependencies to make sure that we have generated/environment.h available.
https://source.denx.de/u-boot/u-boot/-/jobs/532186

We cannot generate generated/environment.h in tools-only mode without real board because environment is always board dependent.

Therefore that new env tool has to be compiled only when doing full real board build, not just tools-only build.

So I would suggest to extend Makefile put that new tool under some "if" to exclude compilation in tools-only mode.

#6 lore raw

Re: [PATCH v4 1/1] u-boot-initial-env: rework make target

Quoted 25 lines · Pali Rohár
Quoted 16 lines · On Wednesday 23 November 2022 13:18:40 Tom Rini wrote:
Quoted 14 lines · Max Krummenacher

From: Max Krummenacher <[email protected]>

With LTO enabled the U-Boot initial environment is no longer stored in an easy accessible section in env/common.o. I.e. the section name changes from build to build, its content maybe compressed and it is annotated with additional data.

Drop trying to read the initial env with elf tools from the compiler specific object file in favour of adding and using a host tool with the only functionality of printing the initial env to stdout.

See also:
https://lore.kernel.org/all/[email protected]/

Quoted 7 lines
Quoted 2 lines

Alright, so 'make tools-only_defconfig tools-only' now fails to build because we're missing the dependencies to make sure that we have generated/environment.h available.
https://source.denx.de/u-boot/u-boot/-/jobs/532186

Quoted 8 lines

We cannot generate generated/environment.h in tools-only mode without real board because environment is always board dependent.

Therefore that new env tool has to be compiled only when doing full real board build, not just tools-only build.

So I would suggest to extend Makefile put that new tool under some "if" to exclude compilation in tools-only mode.

Note that "tools-only_defconfig" builds a functional sandbox U-Boot, so it's probably easier to get the dependencies right in the Makefile logic, rather than special case them. Especially since we're now building this for everyone it's now a race to make sure we did generate that file? I don't have a strong preference on how this is solved, however.

Signature · 1 line
Tom