From 32e1f960f0b90f4ce2bdd9b1352248056b446248 Mon Sep 17 00:00:00 2001
From: torben-hansen <50673096+torben-hansen@users.noreply.github.com>
Date: Tue, 25 Apr 2023 10:38:46 -0700
Subject: [PATCH] Remove cruft from generate build script (#976)
Removes 50% of the code from generate_build_files.py which are never used. Probably a remnant from years ago when first changing this script to feed AWS-LC needs.
Consuming Perl-generated machine implementations and Go generated files are done by cmake scripts.
---
util/generate_build_files.py | 191 ++---------------------------------
1 file changed, 6 insertions(+), 185 deletions(-)
mode change 100644 => 100755 util/generate_build_files.py
diff --git a/util/generate_build_files.py b/util/generate_build_files.py
old mode 100644
new mode 100755
index 26ba324bb5..5ac62106aa
--- a/util/generate_build_files.py
+++ b/util/generate_build_files.py
@@ -14,8 +14,6 @@
# OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-"""Enumerates source files for consumption by various build systems."""
-
import io
import optparse
import os
@@ -52,53 +50,6 @@ def FindCMakeFiles(directory):
return cmakefiles
-def OnlyFIPSFragments(path, dent, is_dir):
- return is_dir or (path.startswith(
- os.path.join(SRC_DIR, 'crypto', 'fipsmodule', '')) and
- NoTests(path, dent, is_dir))
-
-def NoTestsNorFIPSFragments(path, dent, is_dir):
- return (NoTests(path, dent, is_dir) and
- (is_dir or not OnlyFIPSFragments(path, dent, is_dir)))
-
-def NoTests(path, dent, is_dir):
- """Filter function that can be passed to FindCFiles in order to remove test
- sources."""
- if is_dir:
- return dent != 'test'
- return 'test.' not in dent
-
-
-def OnlyTests(path, dent, is_dir):
- """Filter function that can be passed to FindCFiles in order to remove
- non-test sources."""
- if is_dir:
- return dent != 'test'
- return '_test.' in dent
-
-
-def AllFiles(path, dent, is_dir):
- """Filter function that can be passed to FindCFiles in order to include all
- sources."""
- return True
-
-
-def NoTestRunnerFiles(path, dent, is_dir):
- """Filter function that can be passed to FindCFiles or FindHeaderFiles in
- order to exclude test runner files."""
- # NOTE(martinkr): This prevents .h/.cc files in src/ssl/test/runner, which
- # are in their own subpackage, from being included in boringssl/BUILD files.
- return not is_dir or dent != 'runner'
-
-
-def NotGTestSupport(path, dent, is_dir):
- return 'gtest' not in dent and 'abi_test' not in dent
-
-
-def SSLHeaderFiles(path, dent, is_dir):
- return dent in ['ssl.h', 'tls1.h', 'ssl23.h', 'ssl3.h', 'dtls1.h', 'srtp.h']
-
-
def FindCFiles(directory, filter_func):
"""Recurses through directory and returns a list of paths to all the C source
files that pass filter_func."""
@@ -119,27 +70,6 @@ def FindCFiles(directory, filter_func):
cfiles.sort()
return cfiles
-
-def FindHeaderFiles(directory, filter_func):
- """Recurses through directory and returns a list of paths to all the header files that pass filter_func."""
- hfiles = []
-
- for (path, dirnames, filenames) in os.walk(directory):
- for filename in filenames:
- if not filename.endswith('.h'):
- continue
- if not filter_func(path, filename, False):
- continue
- hfiles.append(os.path.join(path, filename))
-
- for (i, dirname) in enumerate(dirnames):
- if not filter_func(path, dirname, True):
- del dirnames[i]
-
- hfiles.sort()
- return hfiles
-
-
def ExtractPerlAsmFromCMakeFile(cmakefile):
"""Parses the contents of the CMakeLists.txt file passed as an argument and
returns a list of all the perlasm() directives found in the file."""
@@ -163,7 +93,6 @@ def ExtractPerlAsmFromCMakeFile(cmakefile):
return perlasms
-
def ReadPerlAsmOperations():
"""Returns a list of all perlasm() directives found in CMake config files in
src_dir"""
@@ -208,7 +137,6 @@ def ArchForAsmFilename(filename):
def WriteAsmFiles(perlasms):
"""Generates asm files from perlasm directives for each supported OS x
platform combination."""
- asmfiles = {}
for osarch in OS_ARCH_COMBOS:
(osname, arch, perlasm_style, extra_args, asm_ext) = osarch
@@ -224,16 +152,6 @@ def WriteAsmFiles(perlasms):
if arch in ArchForAsmFilename(filename):
PerlAsm(os.path.join(DEST_DIR, output), perlasm['input'], perlasm_style,
perlasm['extra_args'] + extra_args)
- asmfiles.setdefault(key, []).append(output)
-
- for (key, non_perl_asm_files) in NON_PERL_FILES.items():
- asmfiles.setdefault(key, []).extend(non_perl_asm_files)
-
- for files in asmfiles.values():
- files.sort()
-
- return asmfiles
-
def ExtractVariablesFromCMakeFile(cmakefile):
"""Parses the contents of the CMakeLists.txt file passed as an argument and
@@ -263,20 +181,8 @@ def ExtractVariablesFromCMakeFile(cmakefile):
raise ValueError('Unfinished set command')
return variables
-
def main():
cmake = ExtractVariablesFromCMakeFile(os.path.join(SRC_DIR, 'sources.cmake'))
- crypto_c_files = (FindCFiles(os.path.join(SRC_DIR, 'crypto'), NoTestsNorFIPSFragments) +
- FindCFiles(os.path.join(SRC_DIR, 'third_party', 'fiat'), NoTestsNorFIPSFragments))
- fips_fragments = FindCFiles(os.path.join(SRC_DIR, 'crypto', 'fipsmodule'), OnlyFIPSFragments)
- ssl_source_files = FindCFiles(os.path.join(SRC_DIR, 'ssl'), NoTests)
- tool_c_files = FindCFiles(os.path.join(SRC_DIR, 'tool'), NoTests)
- tool_h_files = FindHeaderFiles(os.path.join(SRC_DIR, 'tool'), AllFiles)
-
- # BCM shared library C files
- bcm_crypto_c_files = [
- os.path.join(SRC_DIR, 'crypto', 'fipsmodule', 'bcm.c')
- ]
# Generate err_data.c
if not os.path.isdir(DEST_DIR):
@@ -287,97 +193,24 @@ def main():
cwd=os.path.join(SRC_DIR, 'crypto', 'err'),
stdout=err_data)
- crypto_c_files.append('err_data.c')
- crypto_c_files.sort()
-
- test_support_c_files = FindCFiles(os.path.join(SRC_DIR, 'crypto', 'test'),
- NotGTestSupport)
- test_support_h_files = (
- FindHeaderFiles(os.path.join(SRC_DIR, 'crypto', 'test'), AllFiles) +
- FindHeaderFiles(os.path.join(SRC_DIR, 'ssl', 'test'), NoTestRunnerFiles))
-
- crypto_test_files = []
-
# Generate crypto_test_data.cc
with open(os.path.join(DEST_DIR, 'crypto_test_data.cc'), 'w+') as out:
subprocess.check_call(
['go', 'run', 'util/embed_test_data.go'] + cmake['CRYPTO_TEST_DATA'],
cwd=SRC_DIR,
stdout=out)
- crypto_test_files += ['crypto_test_data.cc']
-
- crypto_test_files += FindCFiles(os.path.join(SRC_DIR, 'crypto'), OnlyTests)
- crypto_test_files += [
- os.path.join(SRC_DIR, 'crypto/test/abi_test.cc'),
- os.path.join(SRC_DIR, 'crypto/test/file_test_gtest.cc'),
- os.path.join(SRC_DIR, 'crypto/test/gtest_main.cc'),
- ]
- # urandom_test.cc is in a separate binary so that it can be test PRNG
- # initialisation.
- crypto_test_files = [
- file for file in crypto_test_files
- if not file.endswith('/urandom_test.cc')
- ]
- crypto_test_files.sort()
-
- ssl_test_files = FindCFiles(os.path.join(SRC_DIR, 'ssl'), OnlyTests)
- ssl_test_files += [
- os.path.join(SRC_DIR, 'crypto/test/abi_test.cc'),
- os.path.join(SRC_DIR, 'crypto/test/gtest_main.cc'),
- ]
- ssl_test_files.sort()
-
- urandom_test_files = [
- os.path.join(SRC_DIR, "crypto/fipsmodule/rand/urandom_test.cc"),
- ]
-
- fuzz_c_files = FindCFiles(os.path.join(SRC_DIR, 'fuzz'), NoTests)
-
- ssl_h_files = FindHeaderFiles(os.path.join(SRC_DIR, 'include', 'openssl'),
- SSLHeaderFiles)
-
- def NotSSLHeaderFiles(path, filename, is_dir):
- return not SSLHeaderFiles(path, filename, is_dir)
- crypto_h_files = FindHeaderFiles(os.path.join(SRC_DIR, 'include', 'openssl'),
- NotSSLHeaderFiles)
-
- ssl_internal_h_files = FindHeaderFiles(os.path.join(SRC_DIR, 'ssl'), NoTests)
- crypto_internal_h_files = (
- FindHeaderFiles(os.path.join(SRC_DIR, 'crypto'), NoTests) +
- FindHeaderFiles(os.path.join(SRC_DIR, 'third_party', 'fiat'), NoTests))
-
- files = {
- 'bcm_crypto': bcm_crypto_c_files,
- 'crypto': crypto_c_files,
- 'crypto_headers': crypto_h_files,
- 'crypto_internal_headers': crypto_internal_h_files,
- 'crypto_test': crypto_test_files,
- 'crypto_test_data': sorted(os.path.join(SRC_DIR, x) for x in cmake['CRYPTO_TEST_DATA']),
- 'fips_fragments': fips_fragments,
- 'fuzz': fuzz_c_files,
- 'ssl': ssl_source_files,
- 'ssl_headers': ssl_h_files,
- 'ssl_internal_headers': ssl_internal_h_files,
- 'ssl_test': ssl_test_files,
- 'tool': tool_c_files,
- 'tool_headers': tool_h_files,
- 'test_support': test_support_c_files,
- 'test_support_headers': test_support_h_files,
- 'urandom_test': urandom_test_files,
- }
-
- asm_outputs = sorted(WriteAsmFiles(ReadPerlAsmOperations()).items())
- return 0
+ WriteAsmFiles(ReadPerlAsmOperations())
+ return 0
if __name__ == '__main__':
usage = '''%prog
- This script generates intermediate build files for CMake builds without the need
- to install Go or Perl as a dependency. These files are output to the |generated-src|
- directory and are used by the top-level CMakeLists.txt for AWS-LC if these depedencies
- are not found.
+ This script generates intermediate build files for CMake builds without the
+ need to install Go or Perl as a dependency. These files are output to the
+ |generated-src| directory and are used by the top-level CMakeLists.txt if
+ either Go or Perl are not found.
'''
parser = optparse.OptionParser(usage=usage)
@@ -386,16 +219,4 @@ def NotSSLHeaderFiles(path, filename, is_dir):
SRC_DIR = os.getcwd()
DEST_DIR = os.path.relpath('generated-src', os.getcwd())
- # NON_PERL_FILES enumerates assembly files that are not processed by the
- # perlasm system.
- NON_PERL_FILES = {
- ('linux', 'arm'): [
- os.path.relpath(os.path.join(SRC_DIR, "crypto/curve25519/asm/x25519-asm-arm.S"), DEST_DIR),
- os.path.relpath(os.path.join(SRC_DIR, "crypto/poly1305/asm/poly1305_asm_arm.S"), DEST_DIR),
- ],
- ('linux', 'x86_64'): [
- os.path.relpath(os.path.join(SRC_DIR, "crypto/hrss/asm/poly_rq_mul.S"), DEST_DIR),
- ],
- }
-
sys.exit(main())