1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
|
#!/usr/bin/env python3
##===----------------------------------------------------------------------===##
##
## This source file is part of the SwiftCrypto open source project
##
## Copyright (c) 2019-2022 Apple Inc. and the SwiftCrypto project authors
## Licensed under Apache License v2.0
##
## See LICENSE.txt for license information
## See CONTRIBUTORS.md for the list of SwiftCrypto project authors
##
## SPDX-License-Identifier: Apache-2.0
##
##===----------------------------------------------------------------------===##
import contextlib
import subprocess
import os
# OS_ARCH_COMBOS maps from OS and platform to the OpenSSL assembly "style" for
# that platform and the extension used by asm files.
OS_ARCH_COMBOS = [
('ios', 'arm', 'ios32', [], 'S'),
('ios', 'aarch64', 'ios64', [], 'S'),
('linux', 'arm', 'linux32', [], 'S'),
('linux', 'aarch64', 'linux64', [], 'S'),
('linux', 'x86', 'elf', ['-fPIC', '-DOPENSSL_IA32_SSE2'], 'S'),
('linux', 'x86_64', 'elf', [], 'S'),
('mac', 'x86_64', 'macosx', [], 'S'),
# ('windows', 'aarch64', 'coff', [], 'S'),
# ('windows', 'arm', 'coff', [], 'S'),
('windows', 'x86', 'win32n', [], 'S'),
# ('windows', 'x86_64', 'coff', [], 'S'),
]
# NON_PERL_FILES enumerates assembly files that are not processed by the
# perlasm system.
NON_PERL_FILES = {
('linux', 'arm'): [
'boringssl/crypto/curve25519/asm/x25519-asm-arm.S',
'boringssl/crypto/poly1305/poly1305_arm_asm.S',
],
('linux', 'x86_64'): [
'boringssl/crypto/hrss/asm/poly_rq_mul.S',
],
}
def FindCMakeFiles(directory):
"""Returns list of all CMakeLists.txt files recursively in directory."""
cmakefiles = []
for (path, _, filenames) in os.walk(directory):
for filename in filenames:
if filename == 'CMakeLists.txt':
cmakefiles.append(os.path.join(path, filename))
return cmakefiles
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."""
perlasms = []
with open(cmakefile) as f:
for line in f:
line = line.strip()
if not line.startswith('perlasm('):
continue
if not line.endswith(')'):
raise ValueError('Bad perlasm line in %s' % cmakefile)
# Remove "perlasm(" from start and ")" from end
params = line[8:-1].split()
if len(params) != 4:
raise ValueError('Bad perlasm line in %s' % cmakefile)
perlasms.append({
'arch': params[1],
'output': os.path.join(os.path.dirname(cmakefile), params[2]),
'input': os.path.join(os.path.dirname(cmakefile), params[3]),
})
return perlasms
def ReadPerlAsmOperations():
"""Returns a list of all perlasm() directives found in CMake config files in
src/."""
perlasms = []
cmakefiles = FindCMakeFiles('boringssl')
for cmakefile in cmakefiles:
perlasms.extend(ExtractPerlAsmFromCMakeFile(cmakefile))
return perlasms
def PerlAsm(output_filename, input_filename, perlasm_style, extra_args):
"""Runs the a perlasm script and puts the output into output_filename."""
base_dir = os.path.dirname(output_filename)
if not os.path.isdir(base_dir):
os.makedirs(base_dir)
subprocess.check_call(
['perl', input_filename, perlasm_style] + extra_args + [output_filename])
def WriteAsmFiles(perlasms):
"""Generates asm files from perlasm directives for each supported OS x
platform combination."""
asmfiles = {}
for perlasm in perlasms:
for (osname, arch, perlasm_style, extra_args, asm_ext) in OS_ARCH_COMBOS:
if arch != perlasm['arch']:
continue
key = (osname, arch)
outDir = '%s-%s' % key
filename = os.path.basename(perlasm['input'])
output = perlasm['output']
if not output.startswith('boringssl/crypto'):
raise ValueError('output missing crypto: %s' % output)
output = os.path.join(outDir, output[17:])
output = '%s-%s.%s' % (output, osname, asm_ext)
PerlAsm(output, perlasm['input'], perlasm_style, extra_args)
asmfiles.setdefault(key, []).append(output)
return asmfiles
def preprocessor_arch_for_arch(arch):
if arch == "arm":
return "__arm__"
elif arch == "aarch64":
return "__aarch64__"
elif arch == "x86":
return "__i386__"
elif arch == "x86_64":
return "__x86_64__"
def preprocessor_platform_for_os(osname):
if osname == 'mac' or osname == 'ios':
return '__APPLE__'
elif osname == 'linux':
return '__linux__'
elif osname == 'windows':
return '_WIN32'
def asm_target(osname, arch, asm):
components = asm.split('/')
new_components = ["boringssl/crypto"] + components[1:-1] + [components[-1].replace('.S', '.' + osname + '.' + arch + '.S')]
return '/'.join(new_components)
def munge_file(pp_arch, pp_platform, source_lines, sink):
"""
Wraps a single assembly file in appropriate defines.
"""
sink.write(b"#if defined(%b) && defined(%b)\n" % (pp_arch.encode(), pp_platform.encode()))
for line in source_lines:
sink.write(line)
sink.write(b"#endif // defined(%b) && defined(%b)\n" % (pp_arch.encode(), pp_platform.encode()))
def munge_all_files(osname, arch, asms):
"""
Puts the appropriate architecture #ifdefs around the asm.
"""
for asm in asms:
pp_arch = preprocessor_arch_for_arch(arch)
pp_platform = preprocessor_platform_for_os(osname)
target = asm_target(osname, arch, asm)
with open(asm, 'rb') as source:
with open(target, 'wb') as sink:
munge_file(pp_arch, pp_platform, source, sink)
def main():
# First, we build all the .S files using the helper from boringssl.
asm_outputs = WriteAsmFiles(ReadPerlAsmOperations())
# Now we need to bring over all the .S files, inserting our preprocessor
# directives along the way. We do this to allow the C preprocessor to make
# unneeded assembly files vanish.
for ((osname, arch), asm_files) in asm_outputs.items():
munge_all_files(osname, arch, asm_files)
for ((osname, arch), asm_files) in NON_PERL_FILES.items():
for asm_file in asm_files:
with open(asm_file, 'rb') as f:
lines = f.readlines()
pp_arch = preprocessor_arch_for_arch(arch)
pp_platform = preprocessor_platform_for_os(osname)
with open(asm_file, 'wb') as sink:
munge_file(pp_arch, pp_platform, lines, sink)
if __name__ == '__main__':
main()
|