blob: 5910396af91a4a9880c945ec1b9f4201fa75cfe8 [file] [log] [blame]
#!/usr/bin/env python3
import os
import shutil
from upstream_utils import (
get_repo_root,
clone_repo,
comment_out_invalid_includes,
walk_cwd_and_copy_if,
git_am,
)
def run_global_replacements(wpiutil_llvm_files):
for wpi_file in wpiutil_llvm_files:
with open(wpi_file) as f:
content = f.read()
# Rename namespace from llvm to wpi
content = content.replace("namespace llvm", "namespace wpi")
content = content.replace("llvm::", "wpi::")
# Fix #includes
content = content.replace('include "llvm/ADT', 'include "wpi')
content = content.replace('include "llvm/Config', 'include "wpi')
content = content.replace('include "llvm/Support', 'include "wpi')
# Fix uses of span
content = content.replace("span", "std::span")
content = content.replace("include <std::span>", "include <span>")
if wpi_file.endswith("ConvertUTFWrapper.cpp"):
content = content.replace(
"const UTF16 *Src = reinterpret_cast<const UTF16 *>(SrcBytes.begin());",
"const UTF16 *Src = reinterpret_cast<const UTF16 *>(&*SrcBytes.begin());",
)
content = content.replace(
"const UTF16 *SrcEnd = reinterpret_cast<const UTF16 *>(SrcBytes.end());",
"const UTF16 *SrcEnd = reinterpret_cast<const UTF16 *>(&*SrcBytes.begin() + SrcBytes.size());",
)
content = content.replace(
"const UTF32 *Src = reinterpret_cast<const UTF32 *>(SrcBytes.begin());",
"const UTF32 *Src = reinterpret_cast<const UTF32 *>(&*SrcBytes.begin());",
)
content = content.replace(
"const UTF32 *SrcEnd = reinterpret_cast<const UTF32 *>(SrcBytes.end());",
"const UTF32 *SrcEnd = reinterpret_cast<const UTF32 *>(&*SrcBytes.begin() + SrcBytes.size());",
)
# Remove unused headers
content = content.replace('#include "llvm-c/ErrorHandling.h"\n', "")
content = content.replace('#include "wpi/Debug.h"\n', "")
content = content.replace('#include "wpi/Error.h"\n', "")
content = content.replace('#include "wpi/Format.h"\n', "")
content = content.replace('#include "wpi/FormatVariadic.h"\n', "")
content = content.replace('#include "wpi/NativeFormatting.h"\n', "")
content = content.replace('#include "wpi/Threading.h"\n', "")
content = content.replace('#include "wpi/DataTypes.h"\n', "")
content = content.replace('#include "wpi/llvm-config.h"\n', "")
content = content.replace('#include "wpi/abi-breaking.h"\n', "")
content = content.replace('#include "wpi/config.h"\n', "")
content = content.replace('#include "wpi/Signals.h"\n', "")
content = content.replace('#include "wpi/Process.h"\n', "")
content = content.replace('#include "wpi/Path.h"\n', "")
content = content.replace('#include "wpi/Program.h"\n', "")
# Fix include guards
content = content.replace("LLVM_ADT_", "WPIUTIL_WPI_")
content = content.replace("LLVM_SUPPORT_", "WPIUTIL_WPI_")
content = content.replace("LLVM_DEFINED_HAS_FEATURE", "WPI_DEFINED_HAS_FEATURE")
content = content.replace("const std::string_view &", "std::string_view ")
content = content.replace("sys::fs::openFileForRead", "fs::OpenFileForRead")
content = content.replace("sys::fs::closeFile", "fs::CloseFile")
content = content.replace("sys::fs::", "fs::")
# Replace wpi/FileSystem.h with wpi/fs.h
content = content.replace('include "wpi/FileSystem.h"', 'include "wpi/fs.h"')
# Replace llvm_unreachable() with wpi_unreachable()
content = content.replace("llvm_unreachable", "wpi_unreachable")
content = content.replace("llvm_is_multithreaded()", "1")
# Revert message in copyright header
content = content.replace("/// Defines the wpi::", "/// Defines the llvm::")
content = content.replace("// end llvm namespace", "// end wpi namespace")
content = content.replace("// end namespace llvm", "// end namespace wpi")
content = content.replace("// End llvm namespace", "// End wpi namespace")
content = content.replace("fs::openFileForRead", "fs::OpenFileForRead")
with open(wpi_file, "w") as f:
f.write(content)
def flattened_llvm_files(llvm, dirs_to_keep):
file_lookup = {}
for dir_to_keep in dirs_to_keep:
dir_to_crawl = os.path.join(llvm, dir_to_keep)
for root, _, files in os.walk(dir_to_crawl):
for f in files:
file_lookup[f] = os.path.join(root, f)
return file_lookup
def find_wpiutil_llvm_files(wpiutil_root, subfolder):
# These files have substantial changes, not worth managing with the patching process
ignore_list = [
"StringExtras.h",
"StringExtras.cpp",
"MemoryBuffer.cpp",
"MemoryBuffer.h",
"SmallVectorMemoryBuffer.h",
]
wpiutil_files = []
for root, _, files in os.walk(os.path.join(wpiutil_root, subfolder)):
for f in files:
if f not in ignore_list:
full_file = os.path.join(root, f)
wpiutil_files.append(full_file)
return wpiutil_files
def overwrite_files(wpiutil_files, llvm_files):
# Very sparse rips from LLVM sources. Not worth tyring to make match upstream
unmatched_files_whitelist = ["fs.h", "fs.cpp", "function_ref.h"]
for wpi_file in wpiutil_files:
wpi_base_name = os.path.basename(wpi_file)
if wpi_base_name in llvm_files:
shutil.copyfile(llvm_files[wpi_base_name], wpi_file)
elif wpi_base_name not in unmatched_files_whitelist:
print(f"No file match for {wpi_file}, check if LLVM deleted it")
def overwrite_source(wpiutil_root, llvm_root):
llvm_files = flattened_llvm_files(
llvm_root,
[
"llvm/include/llvm/ADT/",
"llvm/include/llvm/Config",
"llvm/include/llvm/Support/",
"llvm/lib/Support/",
],
)
wpi_files = find_wpiutil_llvm_files(
wpiutil_root, "src/main/native/thirdparty/llvm/include/wpi"
) + find_wpiutil_llvm_files(
wpiutil_root, "src/main/native/thirdparty/llvm/cpp/llvm"
)
overwrite_files(wpi_files, llvm_files)
run_global_replacements(wpi_files)
def overwrite_tests(wpiutil_root, llvm_root):
llvm_files = flattened_llvm_files(
llvm_root,
["llvm/unittests/ADT/", "llvm/unittests/Config", "llvm/unittests/Support/"],
)
wpi_files = find_wpiutil_llvm_files(wpiutil_root, "src/test/native/cpp/llvm")
overwrite_files(wpi_files, llvm_files)
run_global_replacements(wpi_files)
def main():
upstream_root = clone_repo("https://github.com/llvm/llvm-project", "llvmorg-17.0.4")
wpilib_root = get_repo_root()
wpiutil = os.path.join(wpilib_root, "wpiutil")
# Apply patches to upstream Git repo
os.chdir(upstream_root)
for f in [
"0001-Remove-StringRef-ArrayRef-and-Optional.patch",
"0002-Wrap-std-min-max-calls-in-parens-for-Windows-warning.patch",
"0003-Change-unique_function-storage-size.patch",
"0004-Threading-updates.patch",
"0005-ifdef-guard-safety.patch",
"0006-Explicitly-use-std.patch",
"0007-Remove-format_provider.patch",
"0008-Add-compiler-warning-pragmas.patch",
"0009-Remove-unused-functions.patch",
"0010-Detemplatize-SmallVectorBase.patch",
"0011-Add-vectors-to-raw_ostream.patch",
"0012-Extra-collections-features.patch",
"0013-EpochTracker-ABI-macro.patch",
"0014-Delete-numbers-from-MathExtras.patch",
"0015-Add-lerp-and-sgn.patch",
"0016-Fixup-includes.patch",
"0017-Use-std-is_trivially_copy_constructible.patch",
"0018-Windows-support.patch",
"0019-Prefer-fmtlib.patch",
"0020-Prefer-wpi-s-fs.h.patch",
"0021-Remove-unused-functions.patch",
"0022-OS-specific-changes.patch",
"0023-Use-SmallVector-for-UTF-conversion.patch",
"0024-Prefer-to-use-static-pointers-in-raw_ostream.patch",
"0025-constexpr-endian-byte-swap.patch",
"0026-Copy-type-traits-from-STLExtras.h-into-PointerUnion..patch",
"0027-Remove-StringMap-test-for-llvm-sort.patch",
"0028-Unused-variable-in-release-mode.patch",
"0029-Use-C-20-bit-header.patch",
"0030-Remove-DenseMap-GTest-printer-test.patch",
"0031-Replace-deprecated-std-aligned_storage_t.patch",
"0032-Fix-compilation-of-MathExtras.h-on-Windows-with-sdl.patch",
"0033-raw_ostream-Add-SetNumBytesInBuffer.patch",
]:
git_am(
os.path.join(wpilib_root, "upstream_utils/llvm_patches", f),
use_threeway=True,
)
overwrite_source(wpiutil, upstream_root)
overwrite_tests(wpiutil, upstream_root)
if __name__ == "__main__":
main()