zmake: add support for static versions

Add a the option "--static" to zmake configure/build. This is passed
through to the generate_ec_version.py script to generate static version
information for reproducible builds.

Note that Zephyr builds require
zephyrproject-rtos/zephyr#48195 to compare
correctly.

BUG=none
BRANCH=none
TEST=zmake testall
TEST=zmake build herobrine -B /tmp/zephyr-rev1 --static
TEST=zmake build herobrine -B /tmp/zephyr-rev2 --static
TEST=cmp /tmp/zephyr-rev1/herobrine/output/zephyr.bin \
  /tmp/zephyr-rev2/herobrine/output/zephyr.bin

Signed-off-by: Keith Short <[email protected]>
Change-Id: I07361f21c865e2b233ebdb2dc730d25afe13a843
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3786857
Reviewed-by: Abe Levkoy <[email protected]>

Author: keith-zephyr

zephyr/CMakeLists.txt

@@ -565,6 +565,7 @@ add_custom_target(
   "--base" "${ZEPHYR_BASE}"
   "--name" "${CMAKE_PROJECT_NAME}"
   "--module" "${ZEPHYR_MODULES}"
+  ${EXTRA_EC_VERSION_FLAGS}
 )
 add_dependencies(app ec_version_header)
 

zephyr/zmake/README.md

@@ -35,7 +35,7 @@ Chromium OS's meta-build tool for Zephyr
 
 ### zmake configure
 
-**Usage:** `zmake configure [-h] [-t TOOLCHAIN] [--bringup] [--clobber] [--allow-warnings] [-B BUILD_DIR] [-c] [--extra-cflags EXTRA_CFLAGS] [--delete-intermediates] (-a | --host-tests-only | --boards-only | project_name [project_name ...])`
+**Usage:** `zmake configure [-h] [-t TOOLCHAIN] [--bringup] [--clobber] [--static] [--allow-warnings] [-B BUILD_DIR] [-c] [--extra-cflags EXTRA_CFLAGS] [--delete-intermediates] (-a | --host-tests-only | --boards-only | project_name [project_name ...])`
 
 #### Positional Arguments
 
@@ -51,6 +51,7 @@ Chromium OS's meta-build tool for Zephyr
 | `-t TOOLCHAIN`, `--toolchain TOOLCHAIN` | Name of toolchain to use |
 | `--bringup` | Enable bringup debugging features |
 | `--clobber` | Delete existing build directories, even if configuration is unchanged |
+| `--static` | Generate static version information for reproducible builds |
 | `--allow-warnings` | Do not treat warnings as errors |
 | `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Root build directory, project files will be in ${build_dir}/${project_name} |
 | `-c`, `--coverage` | Enable CONFIG_COVERAGE Kconfig. |
@@ -62,7 +63,7 @@ Chromium OS's meta-build tool for Zephyr
 
 ### zmake build
 
-**Usage:** `zmake build [-h] [-t TOOLCHAIN] [--bringup] [--clobber] [--allow-warnings] [-B BUILD_DIR] [-c] [--extra-cflags EXTRA_CFLAGS] [--delete-intermediates] (-a | --host-tests-only | --boards-only | project_name [project_name ...])`
+**Usage:** `zmake build [-h] [-t TOOLCHAIN] [--bringup] [--clobber] [--static] [--allow-warnings] [-B BUILD_DIR] [-c] [--extra-cflags EXTRA_CFLAGS] [--delete-intermediates] (-a | --host-tests-only | --boards-only | project_name [project_name ...])`
 
 #### Positional Arguments
 
@@ -78,6 +79,7 @@ Chromium OS's meta-build tool for Zephyr
 | `-t TOOLCHAIN`, `--toolchain TOOLCHAIN` | Name of toolchain to use |
 | `--bringup` | Enable bringup debugging features |
 | `--clobber` | Delete existing build directories, even if configuration is unchanged |
+| `--static` | Generate static version information for reproducible builds |
 | `--allow-warnings` | Do not treat warnings as errors |
 | `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Root build directory, project files will be in ${build_dir}/${project_name} |
 | `-c`, `--coverage` | Enable CONFIG_COVERAGE Kconfig. |
@@ -106,7 +108,7 @@ Chromium OS's meta-build tool for Zephyr
 
 ### zmake test
 
-**Usage:** `zmake test [-h] [--no-rebuild] [-t TOOLCHAIN] [--bringup] [--clobber] [--allow-warnings] [-B BUILD_DIR] [-c] [--extra-cflags EXTRA_CFLAGS] [--delete-intermediates] (-a | --host-tests-only | --boards-only | project_name [project_name ...])`
+**Usage:** `zmake test [-h] [--no-rebuild] [-t TOOLCHAIN] [--bringup] [--clobber] [--static] [--allow-warnings] [-B BUILD_DIR] [-c] [--extra-cflags EXTRA_CFLAGS] [--delete-intermediates] (-a | --host-tests-only | --boards-only | project_name [project_name ...])`
 
 #### Positional Arguments
 
@@ -123,6 +125,7 @@ Chromium OS's meta-build tool for Zephyr
 | `-t TOOLCHAIN`, `--toolchain TOOLCHAIN` | Name of toolchain to use |
 | `--bringup` | Enable bringup debugging features |
 | `--clobber` | Delete existing build directories, even if configuration is unchanged |
+| `--static` | Generate static version information for reproducible builds |
 | `--allow-warnings` | Do not treat warnings as errors |
 | `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Root build directory, project files will be in ${build_dir}/${project_name} |
 | `-c`, `--coverage` | Enable CONFIG_COVERAGE Kconfig. |
@@ -134,7 +137,7 @@ Chromium OS's meta-build tool for Zephyr
 
 ### zmake testall
 
-**Usage:** `zmake testall [-h] [--clobber] [-B BUILD_DIR]`
+**Usage:** `zmake testall [-h] [--clobber] [-B BUILD_DIR] [--static]`
 
 #### Optional Arguments
 
@@ -143,6 +146,7 @@ Chromium OS's meta-build tool for Zephyr
 | `-h`, `--help` | show this help message and exit |
 | `--clobber` | Delete existing build directories, even if configuration is unchanged |
 | `-B BUILD_DIR`, `--build-dir BUILD_DIR` | Build directory |
+| `--static` | Generate static version information for reproducible builds |
 
 ### zmake generate-readme
 

zephyr/zmake/zmake/__main__.py

@@ -228,6 +228,12 @@ def get_argparser():
     testall.add_argument(
         "-B", "--build-dir", type=pathlib.Path, help="Build directory"
     )
+    testall.add_argument(
+        "--static",
+        action="store_true",
+        dest="static_version",
+        help="Generate static version information for reproducible builds",
+    )
 
     generate_readme = sub.add_parser(
         "generate-readme",
@@ -268,6 +274,12 @@ def add_common_configure_args(sub_parser: argparse.ArgumentParser):
         dest="clobber",
         help="Delete existing build directories, even if configuration is unchanged",
     )
+    sub_parser.add_argument(
+        "--static",
+        action="store_true",
+        dest="static_version",
+        help="Generate static version information for reproducible builds",
+    )
     sub_parser.add_argument(
         "--allow-warnings",
         action="store_true",

zephyr/zmake/zmake/zmake.py

@@ -250,6 +250,7 @@ def configure(  # pylint: disable=too-many-arguments,too-many-locals
         extra_cflags=None,
         delete_intermediates=False,
         boards_only=False,
+        static_version=False,
     ):
         """Locate and configure the specified projects."""
         # Resolve build_dir if needed.
@@ -281,6 +282,7 @@ def configure(  # pylint: disable=too-many-arguments,too-many-locals
                     extra_cflags=extra_cflags,
                     multiproject=len(projects) > 1,
                     delete_intermediates=delete_intermediates,
+                    static_version=static_version,
                 )
             )
             if self._sequential:
@@ -326,6 +328,7 @@ def build(  # pylint: disable=too-many-arguments
         extra_cflags=None,
         delete_intermediates=False,
         boards_only=False,
+        static_version=False,
     ):
         """Locate and build the specified projects."""
         return self.configure(
@@ -342,6 +345,7 @@ def build(  # pylint: disable=too-many-arguments
             build_after_configure=True,
             delete_intermediates=delete_intermediates,
             boards_only=boards_only,
+            static_version=static_version,
         )
 
     def test(  # pylint: disable=too-many-arguments,too-many-locals
@@ -359,6 +363,7 @@ def test(  # pylint: disable=too-many-arguments,too-many-locals
         no_rebuild=False,
         delete_intermediates=False,
         boards_only=False,
+        static_version=False,
     ):
         """Locate and build the specified projects."""
         if not no_rebuild:
@@ -376,6 +381,7 @@ def test(  # pylint: disable=too-many-arguments,too-many-locals
                 test_after_configure=True,
                 delete_intermediates=delete_intermediates,
                 boards_only=boards_only,
+                static_version=static_version,
             )
         # Resolve build_dir if needed.
         if not build_dir:
@@ -435,6 +441,7 @@ def testall(  # pylint: disable=too-many-arguments
         bringup=False,
         coverage=False,
         allow_warnings=False,
+        static_version=False,
     ):
         """Locate and build all the projects."""
         return self.test(
@@ -446,6 +453,7 @@ def testall(  # pylint: disable=too-many-arguments
             coverage=coverage,
             allow_warnings=allow_warnings,
             all_projects=True,
+            static_version=static_version,
         )
 
     def _configure(
@@ -462,6 +470,7 @@ def _configure(
         extra_cflags=None,
         multiproject=False,
         delete_intermediates=False,
+        static_version=False,
     ):
         # pylint: disable=too-many-arguments,too-many-locals,too-many-branches
         # pylint: disable=too-many-statements
@@ -497,6 +506,11 @@ def _configure(
                     ),
                     "ZMAKE_INCLUDE_DIR": str(generated_include_dir),
                     "ZMAKE_PROJECT_NAME": project.config.project_name,
+                    **(
+                        {"EXTRA_EC_VERSION_FLAGS": "--static"}
+                        if static_version
+                        else {}
+                    ),
                 },
             )
 
@@ -645,6 +659,7 @@ def _configure(
                     coverage=coverage,
                     output_files_out=output_files,
                     multiproject=multiproject,
+                    static_version=static_version,
                 )
                 if result:
                     self.failed_projects.append(project.config.project_name)
@@ -687,6 +702,7 @@ def _build(  # pylint: disable=too-many-arguments
         output_files_out=None,
         coverage=False,
         multiproject=False,
+        static_version=False,
     ):
         # pylint: disable=too-many-locals,too-many-branches
         """Build a pre-configured build directory."""
@@ -730,13 +746,17 @@ def wait_and_check_success(procs, writers):
             project.config.project_name,
             build_dir / "zephyr_base",
             zmake.modules.locate_from_directory(build_dir / "modules"),
+            static=static_version,
         )
 
         # The version header needs to generated during the build phase
         # instead of configure, as the tree may have changed since
         # configure was run.
         zmake.version.write_version_header(
-            version_string, build_dir / "include" / "ec_version.h", "zmake"
+            version_string,
+            build_dir / "include" / "ec_version.h",
+            "zmake",
+            static=static_version,
         )
 
         gcov = "gcov.sh-not-found"