mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
286 lines
16 KiB
Python
Executable File
286 lines
16 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
import argparse
|
|
import itertools
|
|
import json
|
|
from pathlib import Path
|
|
from dataclasses import dataclass
|
|
|
|
THIS_DIR = Path(__file__).parent.resolve()
|
|
|
|
@dataclass
|
|
class Config:
|
|
architecture: list[dict]
|
|
os: list[dict]
|
|
build_type: list[str]
|
|
cmake_args: list[str]
|
|
|
|
'''
|
|
Generate a strategy matrix for GitHub Actions CI.
|
|
|
|
On each PR commit we will build a selection of Debian, RHEL, Ubuntu, MacOS, and
|
|
Windows configurations, while upon merge into the develop, release, or master
|
|
branches, we will build all configurations, and test most of them.
|
|
|
|
We will further set additional CMake arguments as follows:
|
|
- All builds will have the `tests`, `werr`, and `xrpld` options.
|
|
- All builds will have the `wextra` option except for GCC 12 and Clang 16.
|
|
- All release builds will have the `assert` option.
|
|
- Certain Debian Bookworm configurations will change the reference fee, enable
|
|
codecov, and enable voidstar in PRs.
|
|
'''
|
|
def generate_strategy_matrix(all: bool, config: Config) -> list:
|
|
configurations = []
|
|
for architecture, os, build_type, cmake_args in itertools.product(config.architecture, config.os, config.build_type, config.cmake_args):
|
|
# The default CMake target is 'all' for Linux and MacOS and 'install'
|
|
# for Windows, but it can get overridden for certain configurations.
|
|
cmake_target = 'install' if os["distro_name"] == 'windows' else 'all'
|
|
|
|
# We build and test all configurations by default, except for Windows in
|
|
# Debug, because it is too slow, as well as when code coverage is
|
|
# enabled as that mode already runs the tests.
|
|
build_only = False
|
|
if os['distro_name'] == 'windows' and build_type == 'Debug':
|
|
build_only = True
|
|
|
|
# Only generate a subset of configurations in PRs.
|
|
if not all:
|
|
# Debian:
|
|
# - Bookworm using GCC 13: Release and Unity on linux/amd64, set
|
|
# the reference fee to 500.
|
|
# - Bookworm using GCC 15: Debug and no Unity on linux/amd64, enable
|
|
# code coverage (which will be done below).
|
|
# - Bookworm using Clang 16: Debug and no Unity on linux/arm64,
|
|
# enable voidstar.
|
|
# - Bookworm using Clang 17: Release and no Unity on linux/amd64,
|
|
# set the reference fee to 1000.
|
|
# - Bookworm using Clang 20: Debug and Unity on linux/amd64.
|
|
if os['distro_name'] == 'debian':
|
|
skip = True
|
|
if os['distro_version'] == 'bookworm':
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'gcc-13' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
cmake_args = f'-DUNIT_TEST_REFERENCE_FEE=500 {cmake_args}'
|
|
skip = False
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'gcc-15' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
skip = False
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'clang-16' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/arm64':
|
|
cmake_args = f'-Dvoidstar=ON {cmake_args}'
|
|
skip = False
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'clang-17' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
cmake_args = f'-DUNIT_TEST_REFERENCE_FEE=1000 {cmake_args}'
|
|
skip = False
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'clang-20' and build_type == 'Debug' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
skip = False
|
|
if skip:
|
|
continue
|
|
|
|
# RHEL:
|
|
# - 9 using GCC 12: Debug and Unity on linux/amd64.
|
|
# - 10 using Clang: Release and no Unity on linux/amd64.
|
|
if os['distro_name'] == 'rhel':
|
|
skip = True
|
|
if os['distro_version'] == '9':
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'gcc-12' and build_type == 'Debug' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
skip = False
|
|
elif os['distro_version'] == '10':
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'clang-any' and build_type == 'Release' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
skip = False
|
|
if skip:
|
|
continue
|
|
|
|
# Ubuntu:
|
|
# - Jammy using GCC 12: Debug and no Unity on linux/arm64.
|
|
# - Noble using GCC 14: Release and Unity on linux/amd64.
|
|
# - Noble using Clang 18: Debug and no Unity on linux/amd64.
|
|
# - Noble using Clang 19: Release and Unity on linux/arm64.
|
|
if os['distro_name'] == 'ubuntu':
|
|
skip = True
|
|
if os['distro_version'] == 'jammy':
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'gcc-12' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/arm64':
|
|
skip = False
|
|
elif os['distro_version'] == 'noble':
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'gcc-14' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
skip = False
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'clang-18' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
skip = False
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'clang-19' and build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'linux/arm64':
|
|
skip = False
|
|
if skip:
|
|
continue
|
|
|
|
# MacOS:
|
|
# - Debug and no Unity on macos/arm64.
|
|
if os['distro_name'] == 'macos' and not (build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'macos/arm64'):
|
|
continue
|
|
|
|
# Windows:
|
|
# - Release and Unity on windows/amd64.
|
|
if os['distro_name'] == 'windows' and not (build_type == 'Release' and '-Dunity=ON' in cmake_args and architecture['platform'] == 'windows/amd64'):
|
|
continue
|
|
|
|
# Additional CMake arguments.
|
|
cmake_args = f'{cmake_args} -Dtests=ON -Dwerr=ON -Dxrpld=ON'
|
|
if not f'{os["compiler_name"]}-{os["compiler_version"]}' in ['gcc-12', 'clang-16']:
|
|
cmake_args = f'{cmake_args} -Dwextra=ON'
|
|
if build_type == 'Release':
|
|
cmake_args = f'{cmake_args} -Dassert=ON'
|
|
|
|
# We skip all RHEL on arm64 due to a build failure that needs further
|
|
# investigation.
|
|
if os['distro_name'] == 'rhel' and architecture['platform'] == 'linux/arm64':
|
|
continue
|
|
|
|
# We skip all clang 20+ on arm64 due to Boost build error.
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' in ['clang-20', 'clang-21'] and architecture['platform'] == 'linux/arm64':
|
|
continue
|
|
|
|
cxx_flags = '-g'
|
|
# Enable code coverage for Debian Bookworm using GCC 14 in Debug and no
|
|
# Unity on linux/amd64
|
|
if f'{os["compiler_name"]}-{os["compiler_version"]}' == 'gcc-14' and build_type == 'Debug' and '-Dunity=OFF' in cmake_args and architecture['platform'] == 'linux/amd64':
|
|
cmake_args = f'-Dcoverage=ON -Dcoverage_format=xml -DCODE_COVERAGE_VERBOSE=ON -DCMAKE_C_FLAGS=-O0 {cmake_args}'
|
|
cxx_flags = f'-O0 {cxx_flags}'
|
|
|
|
# Generate a unique name for the configuration, e.g. macos-arm64-debug
|
|
# or debian-bookworm-gcc-12-amd64-release-unity.
|
|
config_name = os['distro_name']
|
|
if (n := os['distro_version']) != '':
|
|
config_name += f'-{n}'
|
|
if (n := os['compiler_name']) != '':
|
|
config_name += f'-{n}'
|
|
if (n := os['compiler_version']) != '':
|
|
config_name += f'-{n}'
|
|
config_name += f'-{architecture["platform"][architecture["platform"].find("/")+1:]}'
|
|
config_name += f'-{build_type.lower()}'
|
|
if '-Dunity=ON' in cmake_args:
|
|
config_name += '-unity'
|
|
|
|
# Add the configuration to the list, with the most unique fields first,
|
|
# so that they are easier to identify in the GitHub Actions UI, as long
|
|
# names get truncated.
|
|
# Add Address and Thread (both coupled with UB) sanitizers when the distro is bookworm.
|
|
if os['distro_version'] == 'bookworm' and f'{os["compiler_name"]}-{os["compiler_version"]}' in {'gcc-15', 'clang-20'}:
|
|
extra_warning_flags = ''
|
|
linker_relocation_flags = ''
|
|
linker_flags = ''
|
|
|
|
# Use large code model to avoid relocation errors with large binaries
|
|
# Only for x86-64 (amd64) - ARM64 doesn't support -mcmodel=large
|
|
if architecture['platform'] == 'linux/amd64' and os['compiler_name'] == 'gcc':
|
|
# Add -mcmodel=large and -fPIC to both compiler AND linker flags
|
|
# This is needed because sanitizers create very large binaries
|
|
# -fPIC enables position independent code to avoid relocation range issues
|
|
# large model removes the 2GB limitation that medium model has
|
|
cxx_flags += ' -mcmodel=large -fPIC -pie'
|
|
linker_relocation_flags+=' -mcmodel=large -fPIC -pie'
|
|
|
|
# Create default sanitizer flags
|
|
sanitizers_flags = 'undefined,float-divide-by-zero'
|
|
|
|
if os['compiler_name'] == 'gcc':
|
|
sanitizers_flags = f'{sanitizers_flags},signed-integer-overflow'
|
|
# Suppress false positive warnings in GCC with stringop-overflow
|
|
extra_warning_flags += ' -Wno-stringop-overflow'
|
|
# Disable mold, gold and lld linkers.
|
|
# Use default linker (bfd/ld) which is more lenient with mixed code models
|
|
cmake_args += ' -Duse_mold=OFF -Duse_gold=OFF -Duse_lld=OFF'
|
|
# Add linker flags for Sanitizers
|
|
linker_flags += f' -DCMAKE_EXE_LINKER_FLAGS="{linker_relocation_flags} -fsanitize=address,{sanitizers_flags}"'
|
|
linker_flags += f' -DCMAKE_SHARED_LINKER_FLAGS="{linker_relocation_flags} -fsanitize=address,{sanitizers_flags}"'
|
|
elif os['compiler_name'] == 'clang':
|
|
sanitizers_flags = f'{sanitizers_flags},signed-integer-overflow,unsigned-integer-overflow'
|
|
linker_flags += f' -DCMAKE_EXE_LINKER_FLAGS="-fsanitize=address,{sanitizers_flags}"'
|
|
linker_flags += f' -DCMAKE_SHARED_LINKER_FLAGS="-fsanitize=address,{sanitizers_flags}"'
|
|
|
|
# Sanitizers recommend minimum of -O1 for reasonable performance
|
|
if "-O0" in cxx_flags:
|
|
cxx_flags = cxx_flags.replace("-O0", "-O1")
|
|
else:
|
|
cxx_flags += " -O1"
|
|
|
|
# First create config for asan
|
|
cmake_args_flags = f'{cmake_args} -DCMAKE_CXX_FLAGS="-fsanitize=address,{sanitizers_flags} -fno-omit-frame-pointer {cxx_flags} {extra_warning_flags}" {linker_flags}'
|
|
|
|
# Add config with asan
|
|
configurations.append({
|
|
'config_name': config_name + "_asan",
|
|
'cmake_args': cmake_args_flags,
|
|
'cmake_target': cmake_target,
|
|
'build_only': build_only,
|
|
'build_type': build_type,
|
|
'os': os,
|
|
'architecture': architecture
|
|
})
|
|
|
|
linker_flags = ''
|
|
# Update configs for tsan
|
|
# gcc doesn't supports atomic_thread_fence with tsan. Suppress warnings.
|
|
# Also tsan doesn't work well with mcmode=large and bfd linker
|
|
if os['compiler_name'] == 'gcc':
|
|
extra_warning_flags += ' -Wno-tsan'
|
|
cxx_flags = cxx_flags.replace('-mcmodel=large', '-mcmodel=medium')
|
|
linker_relocation_flags = linker_relocation_flags.replace('-mcmodel=large', '-mcmodel=medium')
|
|
# Add linker flags for Sanitizers
|
|
linker_flags += f' -DCMAKE_EXE_LINKER_FLAGS="{linker_relocation_flags} -fsanitize=thread,{sanitizers_flags}"'
|
|
linker_flags += f' -DCMAKE_SHARED_LINKER_FLAGS="{linker_relocation_flags} -fsanitize=thread,{sanitizers_flags}"'
|
|
elif os['compiler_name'] == 'clang':
|
|
cxx_flags += ' -fsanitize-blacklist=$GITHUB_WORKSPACE/external/sanitizer-blacklist.txt'
|
|
linker_flags += f' -DCMAKE_EXE_LINKER_FLAGS="-fsanitize=thread,{sanitizers_flags}"'
|
|
linker_flags += f' -DCMAKE_SHARED_LINKER_FLAGS="-fsanitize=thread,{sanitizers_flags}"'
|
|
|
|
# Note: We use $GITHUB_WORKSPACE environment variable which will be expanded by the shell
|
|
# before CMake processes it. This ensures the compiler receives an absolute path.
|
|
# CMAKE_SOURCE_DIR won't work here because it's inside CMAKE_CXX_FLAGS string.
|
|
cmake_args_flags = f'{cmake_args} -DCMAKE_CXX_FLAGS="-fsanitize=thread,{sanitizers_flags} -fno-omit-frame-pointer {cxx_flags} {extra_warning_flags}" {linker_flags}'
|
|
|
|
configurations.append({
|
|
'config_name': config_name+ "_tsan",
|
|
'cmake_args': cmake_args_flags,
|
|
'cmake_target': cmake_target,
|
|
'build_only': build_only,
|
|
'build_type': build_type,
|
|
'os': os,
|
|
'architecture': architecture
|
|
})
|
|
else:
|
|
if cxx_flags:
|
|
cmake_args_flags = f'{cmake_args} -DCMAKE_CXX_FLAGS={cxx_flags}'
|
|
else:
|
|
cmake_args_flags = f'{cmake_args}'
|
|
configurations.append({
|
|
'config_name': config_name,
|
|
'cmake_args': cmake_args_flags,
|
|
'cmake_target': cmake_target,
|
|
'build_only': build_only,
|
|
'build_type': build_type,
|
|
'os': os,
|
|
'architecture': architecture
|
|
})
|
|
|
|
return configurations
|
|
|
|
|
|
def read_config(file: Path) -> Config:
|
|
config = json.loads(file.read_text())
|
|
if config['architecture'] is None or config['os'] is None or config['build_type'] is None or config['cmake_args'] is None:
|
|
raise Exception('Invalid configuration file.')
|
|
|
|
return Config(**config)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('-a', '--all', help='Set to generate all configurations (generally used when merging a PR) or leave unset to generate a subset of configurations (generally used when committing to a PR).', action="store_true")
|
|
parser.add_argument('-c', '--config', help='Path to the JSON file containing the strategy matrix configurations.', required=False, type=Path)
|
|
args = parser.parse_args()
|
|
|
|
matrix = []
|
|
if args.config is None or args.config == '':
|
|
matrix += generate_strategy_matrix(args.all, read_config(THIS_DIR / "linux.json"))
|
|
matrix += generate_strategy_matrix(args.all, read_config(THIS_DIR / "macos.json"))
|
|
matrix += generate_strategy_matrix(args.all, read_config(THIS_DIR / "windows.json"))
|
|
else:
|
|
matrix += generate_strategy_matrix(args.all, read_config(args.config))
|
|
|
|
# Generate the strategy matrix.
|
|
print(f'matrix={json.dumps({"include": matrix})}')
|