Create crypto binaries report

.azuredevops/CryptoTest.yml

@@ -90,6 +90,7 @@ stages:
           -a $(build_archs)
           -t $(build_targets)
           --stop-on-fail
+          --report
           TOOL_CHAIN_TAG=${{ parameters.toolchain }}
 
     - task: CopyFiles@2
@@ -158,6 +159,7 @@ stages:
           BUILDLOG_CryptoBin_*.txt
           SETUPLOG.txt
           UPDATE_LOG.txt
+          Report_STANDARD_DEBUG_VS2022.txt
         targetFolder: '$(Build.ArtifactStagingDirectory)/Logs'
         flattenFolders: true
 

CryptoBinPkg/Plugin/ReportCrypto/ReportCrypto.py

@@ -0,0 +1,169 @@
+## @file BundleCrypto.py
+# Plugin to Bundle the CryptoBin build output
+#
+##
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+from edk2toolext.environment.plugintypes.uefi_build_plugin import IUefiBuildPlugin
+from pathlib import Path
+from datetime import datetime
+from git import Repo
+import lzma
+
+binary_to_type = {}
+arch_and_type_to_lib = {}
+
+class ReportCrypto(IUefiBuildPlugin):
+
+    def do_post_build(self, thebuilder):
+
+        # Path to Build output
+        build_path = Path(thebuilder.env.GetValue("BUILD_OUTPUT_BASE"))
+        tool_chain = thebuilder.env.GetValue("TOOL_CHAIN_TAG")
+        target = thebuilder.env.GetValue("TARGET")
+        # Create report file in the build directory
+        report_file_name = f"Report_{thebuilder.flavor}_{target}_{tool_chain}.txt"
+        report_File = Path(thebuilder.ws) / "Build" / report_file_name
+        report_File.touch()
+        arch_list = thebuilder.env.GetValue("TARGET_ARCH")
+
+        # Time and Title
+        title = f"CRYPTO BINARIES REPORT - {thebuilder.flavor} FLAVOR - {target}\n\n"
+        time = datetime.now().strftime('%Y-%m-%d %H:%M:%S\n')
+        report = [title, "Build Time: " + time]
+
+        # get tool chain
+        report.append(f"Tool Chain: {tool_chain}\n")
+
+        # get each CryptoBin module type
+        self.get_module_type_for_crypto_bin(thebuilder)
+
+        report.append("=============================================\n")
+        # get submodules information
+        report.append("<------Submodules------>\n")
+        repo = Repo(thebuilder.ws)
+        for sub in repo.submodules:
+            report.append("--------\n")
+            report.append(f"Name: {sub.name}\n")
+            report.append(f"Branch: {sub.branch_name}\n")
+            report.append(f"Commit: {sub.hexsha}\n")
+
+        report.append("=============================================\n")
+        # For each architecture built
+        for arch in arch_list.split(" "):
+            arch_build_path = build_path / arch
+            # write flavor and architecture name to report file
+            report += ["--------------------------------\n", "ARCH: " + arch + "\n\n"]
+
+            # get built binaries
+            files = list(arch_build_path.glob("*.efi"))
+            files.sort()
+
+            # start binaries sizes report
+            report.append("<------Crypto binaries sizes report------>\n\n")
+            for file in files:
+                # get file size in k bytes
+                file_size = file.stat().st_size / 1024
+
+                # get compressed file size using LMZA
+                with open(file, 'rb') as input_file:
+                    # Read the content of the input files
+                    input_data = input_file.read()
+                    # Compress the data using LZMA
+                    compressed_data = lzma.compress(input_data)
+
+                    # Get the number of k bytes of the compressed data
+                    compressed_data_size = len(compressed_data) / 1024
+                    # log to file (assuming file name won't be longer than 40 characters to keep the report clean)
+                    report.append(f"{file.name} - " + (40-len(file.name))* " " + f"Uncompressed: {file_size:.2f} KB | LZMA Compressed: {compressed_data_size:.2f} KB\n")
+
+            # get linked openssl configuration
+            report.append("\n")   
+            report.append("<------Linked Openssl configuration------>\n\n")
+            for file in files:
+                # get module type for the binary
+                module_type = binary_to_type.get(file.name, "UEFI_APPLICATION") # Default to UEFI_APPLICATION if not found (e.g. test binary)
+                opensslib = self.get_linked_lib(thebuilder, arch, module_type, "OpensslLib")
+                report.append(f"{file.name} - " + (40-len(file.name))* " " + f"OpensslLib: {opensslib}\n")
+
+
+        # start openssl configuration report
+        report.append("=============================================\n")
+        report.append("<------Openssl configuration report------>\n")
+
+        # get openssl library files 
+        openssl_lib = Path(thebuilder.edk2path.GetAbsolutePathOnThisSystemFromEdk2RelativePath("OpensslPkg")) / "Library" / "OpensslLib"
+        openssl_inf_files = list(openssl_lib.glob("OpensslLib*.inf"))
+        openssl_inf_files.sort()
+        for file in openssl_inf_files:
+            # write openssl library files to report file
+            openssl_flags = self.get_openssl_flags(file)
+            report.append("--------\n")
+            report.append("File: " + file.name + "\n")
+            report.extend(openssl_flags)
+
+        report.append("=============================================\n")
+
+        # write report to the report file
+        report_File.write_text("".join(report))
+
+        return 0
+
+    def get_openssl_flags(self, file):
+
+        # get openssl library flags
+        flags = []
+        with file.open() as f:
+            for line in f:
+                if "DEFINE OPENSSL_FLAGS" in line:
+                    flags.append(line)
+        return flags
+
+    def get_module_type_for_crypto_bin(self, thebuilder):
+
+        CryptoBinPkg_Driver_path = Path(thebuilder.ws) / "CryptoBinPkg" / "Driver"
+        inf_files = list(CryptoBinPkg_Driver_path.glob("*.inf"))
+        for inf_file in inf_files:
+            base_name = ""
+            module_type = ""
+            with inf_file.open() as f:
+                for line in f:
+                    if "BASE_NAME" in line:
+                        base_name = line.split("=")[1].strip()
+                    if "MODULE_TYPE" in line:
+                        module_type = line.split("=")[1].strip()
+                    if base_name != "" and module_type != "":
+                        binary_to_type[f"{base_name}.efi"] = module_type # start binaries sizes report
+                        break
+
+    def get_linked_lib(self, thebuilder, arch, module_type, lib):
+
+        cryptoBinPkg_dsc_path = Path(thebuilder.ws) / "CryptoBinPkg" / "CryptoBinPkg.dsc"
+        with cryptoBinPkg_dsc_path.open() as f:
+            current_key = None
+            # there are 3 possible lib configuarions for the crypto binaries: "[LibraryClasses] (default)", "LibraryClasses.common.{module_type}" and "[LibraryClasses.arch.module_type] (most specific)"
+            default = ""
+            common_type = ""
+            arch_type = ""
+            for line in f:
+                if "[LibraryClasses]" in line:
+                    current_key = "Default"
+                elif "[LibraryClasses" in line:
+                    current_key = line
+                if f"{lib}|" in line:
+                    specific_lib = line.split("|")[1].strip()
+                    if current_key == "Default":
+                        default = specific_lib            
+                    else:
+                        if f"{arch}.{module_type}" in current_key:
+                            arch_type = specific_lib
+                        elif f"common.{module_type}" in current_key:
+                            common_type = specific_lib
+
+            if arch_type != "":
+                return arch_type
+            elif common_type != "":
+                return common_type
+            else:
+                return default

CryptoBinPkg/Plugin/ReportCrypto/ReportCrypto_plug_in.json

@@ -0,0 +1,5 @@
+{
+    "scope": "crypto-report",
+    "name": "Report Crypto Contents",
+    "module": "ReportCrypto"
+}

MultiFlavorBuild.py

@@ -61,13 +61,17 @@ def validate_flavors(flavor_arg: str):
         parserObj.add_argument("-b", "--bundle", dest="bundle", action="store_true",
                                default=False,
                                help="Bundles the build output into the directory structure for the Crypto binary distribution.")
+        parserObj.add_argument("-r", "--report", dest="report", action="store_true",
+                                default=False,
+                                help="produces a report regarding the built crpyto binaries.")
 
     def RetrieveCommandLineOptions(self, args):
         self.arch = args.arch
         self.target = args.target
         self.flavor = args.flavor
         self.stop = args.stop
         self.bundle = args.bundle
+        self.report = args.report
 
     def GetWorkspaceRoot(self):
         ''' get WorkspacePath '''
@@ -116,6 +120,8 @@ def Go(self, WorkSpace, PackagesPath, PInHelper, PInManager):
                     params += ["-a", ",".join(arches)]
                     if self.bundle:
                         params += ["-b"]
+                    if self.report:
+                        params += ["-r"]
 
                     current_build = f"{flavor} {target}"
                     logging.log(edk2_logging.SECTION, f"Building {current_build}")
@@ -136,6 +142,8 @@ def Go(self, WorkSpace, PackagesPath, PInHelper, PInManager):
                     params += ["-a", "AARCH64"]
                     if self.bundle:
                         params += ["-b"]
+                    if self.report:
+                        params += ["-r"]
 
                     current_build = f"{flavor} {target}"
                     logging.log(edk2_logging.SECTION, f"Building {current_build}")

SingleFlavorBuild.py

@@ -42,13 +42,17 @@ def AddCommandLineOptions(self, parserObj):
         parserObj.add_argument("-b", "--bundle", dest="bundle", action="store_true",
                                default=False,
                                help="Bundles the build output into the directory structure for the Crypto binary distribution.")
+        parserObj.add_argument("-r", "--report", dest="report", action="store_true",
+                               default=False,
+                               help="produces a report regarding the built crpyto binaries.")
 
 
     def RetrieveCommandLineOptions(self, args):
         self.flavor = args.flavor
         self.target = args.target
         self.arch = args.arch
         self.bundle = args.bundle
+        self.report = args.report
 
     def GetWorkspaceRoot(self):
         ''' get WorkspacePath '''
@@ -61,7 +65,9 @@ def GetPackagesPath(self):
     def GetActiveScopes(self):
         ''' return tuple containing scopes that should be active for this process '''
         if self.bundle:
-            return CommonPlatform.Scopes + ("crypto-bundle",)
+            CommonPlatform.Scopes = CommonPlatform.Scopes + ("crypto-bundle",)
+        if self.report:
+            CommonPlatform.Scopes = CommonPlatform.Scopes + ("crypto-report",)
         return CommonPlatform.Scopes
 
     def GetBaseName(self):