Skip to contentSkip to conversation

initramfs: Parse KBUILD_BUILD_TIMESTAMP as UTC date

PATCH Superseded Paulo Miguel Almeida 3 participants 4 messages Jul 29, 2023 – Aug 21, 2023 Kbuild

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 initramfs: Parse KBUILD_BUILD_TIMESTAMP as UTC date

When KBUILD_BUILD_TIMESTAMP is specified, the date command will parse it to Unix Epoch time in UTC. However, the date command is timezone-aware so it will convert from the local timezone to UTC first which hits some of the sanity checks added on commit 5efb685bb3af1 ("initramfs: Check negative timestamp to prevent broken cpio archive")

This creates an edge case for the UTC+<N> part of the world. For instance

- In New Zealand (UTC+12:00):

	$ date -d"1970-01-01" +%s
	-43200
	$ make KBUILD_BUILD_TIMESTAMP=1970-01-01
	make[1]: Entering directory '<snip>/linux/'
	  GEN     Makefile
	  DESCEND objtool
	  INSTALL libsubcmd_headers
	  CALL    ../scripts/checksyscalls.sh
	  GEN     usr/initramfs_data.cpio
	ERROR: Timestamp out of range for cpio format
	make[4]: *** [../usr/Makefile:76: usr/initramfs_data.cpio] Error 1

- In Seattle, WA (UTC-07:00):

	$ date -d"1970-01-01" +%s
	32400
	$ make KBUILD_BUILD_TIMESTAMP=1970-01-01
	<builds fine>

Parse KBUILD_BUILD_TIMESTAMP date string as UTC so no localtime conversion is done which fixes the edge case aforementioned.

---
 usr/gen_initramfs.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
usr/gen_initramfs.sh +1 -1
index 14b5782f961a..a90316d9a080 100755
@@ -221,7 +221,7 @@ while [ $# -gt 0 ]; do
 			shift
 			;;
 		"-d")	# date for file mtimes
-			timestamp="$(date -d"$1" +%s || :)"
+			timestamp="$(date -d"$1" -u +%s || :)"
 			if test -n "$timestamp"; then
 				timestamp="-t $timestamp"
 			fi
Signature · 1 line
2.40.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 26 lines · Paulo Miguel Almeida

When KBUILD_BUILD_TIMESTAMP is specified, the date command will parse it to Unix Epoch time in UTC. However, the date command is timezone-aware so it will convert from the local timezone to UTC first which hits some of the sanity checks added on commit 5efb685bb3af1 ("initramfs: Check negative timestamp to prevent broken cpio archive")

This creates an edge case for the UTC+<N> part of the world. For instance

- In New Zealand (UTC+12:00):

	$ date -d"1970-01-01" +%s
	-43200
	$ make KBUILD_BUILD_TIMESTAMP=1970-01-01
	make[1]: Entering directory '<snip>/linux/'
	  GEN     Makefile
	  DESCEND objtool
	  INSTALL libsubcmd_headers
	  CALL    ../scripts/checksyscalls.sh
	  GEN     usr/initramfs_data.cpio
	ERROR: Timestamp out of range for cpio format
	make[4]: *** [../usr/Makefile:76: usr/initramfs_data.cpio] Error 1

- In Seattle, WA (UTC-07:00):

	$ date -d"1970-01-01" +%s
	32400
Quoted 8 lines
	$ make KBUILD_BUILD_TIMESTAMP=1970-01-01
	<builds fine>

Parse KBUILD_BUILD_TIMESTAMP date string as UTC so no localtime conversion is done which fixes the edge case aforementioned.

---

Thanks for the patch!

Looking at 1970-01-01 concretely, you could circumvent your reported issue by using KBUILD_BUILD_TIMESTAMP="1970-01-01 UTC". But I think you found an interesting point w/ regard to reproducibility, as time zone is neither mentioned in Documentation/kbuild/reproducibility.rst nor in Documentation/kbuild/kbuild.rst but influences the output of 'date -d' (w/o '-u') (or comparable) calls in usr/gen_initramfs.sh as well as in kernel/gen_kheaders.sh ('TZ=UTC tar'?) and possibly in scripts/kernel-doc.

I think some might be suprised that giving a YYYY-MM-DD date to KBUILD_BUILD_TIMESTAMP leads to an effectively different timestamp in initramfs_data.cpio, but I think your change is still reasonable.

Quoted 19 lines
 usr/gen_initramfs.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
usr/gen_initramfs.sh +1 -1
index 14b5782f961a..a90316d9a080 100755
@@ -221,7 +221,7 @@ while [ $# -gt 0 ]; do
 			shift
 			;;
 		"-d")	# date for file mtimes
-			timestamp="$(date -d"$1" +%s || :)"
+			timestamp="$(date -d"$1" -u +%s || :)"
 			if test -n "$timestamp"; then
 				timestamp="-t $timestamp"
 			fi
Signature · 1 line
2.40.1
Signature · 1 line
Nicolas Schier
#2 lore raw
In reply to Paulo Miguel Almeida
Quoted 30 lines · Paulo Miguel Almeida

When KBUILD_BUILD_TIMESTAMP is specified, the date command will parse it to Unix Epoch time in UTC. However, the date command is timezone-aware so it will convert from the local timezone to UTC first
which hits some of the sanity checks added on commit 5efb685bb3af1 ("initramfs: Check negative timestamp to prevent broken cpio archive")

This creates an edge case for the UTC+<N> part of the world. For instance

 - In New Zealand (UTC+12:00):

        $ date -d"1970-01-01" +%s
        -43200
        $ make KBUILD_BUILD_TIMESTAMP=1970-01-01
        make[1]: Entering directory '<snip>/linux/'
          GEN     Makefile
          DESCEND objtool
          INSTALL libsubcmd_headers
          CALL    ../scripts/checksyscalls.sh
          GEN     usr/initramfs_data.cpio
        ERROR: Timestamp out of range for cpio format
        make[4]: *** [../usr/Makefile:76: usr/initramfs_data.cpio]
Error 1

 - In Seattle, WA (UTC-07:00):

        $ date -d"1970-01-01" +%s
        32400
Quoted 8 lines
        $ make KBUILD_BUILD_TIMESTAMP=1970-01-01
        <builds fine>

Parse KBUILD_BUILD_TIMESTAMP date string as UTC so no localtime conversion is done which fixes the edge case aforementioned.

Signed-off-by: Paulo Miguel Almeida
<[email protected]>

This should also be documented in Documentation/kbuild/kbuild.rst, including a note that you can still use local time if you include the timezone specifier.

Thanks,

Signature · 2 lines
Andrew Donnellan    OzLabs, ADL Canberra
[email protected]   IBM Australia Limited
#3 lore raw
Quoted 4 lines · Andrew Donnellan
Quoted 4 lines

Parse KBUILD_BUILD_TIMESTAMP date string as UTC so no localtime conversion is done which fixes the edge case aforementioned.

Quoted 8 lines
Quoted 2 lines

Signed-off-by: Paulo Miguel Almeida
<[email protected]>

This should also be documented in Documentation/kbuild/kbuild.rst, including a note that you can still use local time if you include the timezone specifier.

Thanks,

Thanks for the review Andrew and Nicolas.

Will send a new patch shortly with the changes requested.

thanks,

- Paulo A.