Files

555 lines
21 KiB
Nix

{
lib,
stdenv,
# LLVM version closest to ROCm fork to override
llvmPackages_22,
overrideCC,
lndir,
rocm-device-libs,
fetchFromGitHub,
runCommand,
symlinkJoin,
rdfind,
zstd,
gcc-unwrapped,
glibc,
libffi,
libxml2,
removeReferencesTo,
fetchpatch,
# Build compilers and stdenv suitable for profiling
# leaving compressed line tables (-g1 -gz) unstripped
# TODO: Should also apply to downstream packages which use rocmClangStdenv?
profilableStdenv ? false,
# FIXME: proper two-stage bootstrap & PGO/BOLT/LTO
# LTO currently disabled due to llvm 22 vs 22.1 bitcode mismatch between
# llvmPackages_22 (22.1) and ROCm LLVM (22.0). Uses new bitcode attr
# 105 nocreateundeforpoison fails to link hipify.
# Whether to use LTO when building the ROCm toolchain
# Slows down this toolchain's build, for typical ROCm usecase
# time saved building composable_kernel and other heavy packages
# will outweight that. ~3-4% speedup multiplied by thousands
# of corehours.
withLto ? false,
# whether rocm stdenv uses libcxx (clang c++ stdlib) instead of gcc stdlibc++
withLibcxx ? false,
}:
let
version = "7.2.3";
# major version of this should be the clang version ROCm forked from
rocmLlvmVersion = "22.0.0-rocm";
# llvmPackages_base version should match rocmLlvmVersion
# so libllvm's bitcode is compatible with the built toolchain
llvmPackages_base = llvmPackages_22;
llvmPackagesNoBintools = llvmPackages_base.override {
bootBintools = null;
bootBintoolsNoLibc = null;
};
stdenvToBuildRocmLlvm =
if withLibcxx then
overrideCC llvmPackagesNoBintools.libcxxStdenv llvmPackagesNoBintools.clangUseLLVM
else
# oddly fuse-ld=lld fails without this override
overrideCC llvmPackagesNoBintools.stdenv (
llvmPackagesNoBintools.libstdcxxClang.override {
inherit (llvmPackages_base) bintools;
}
);
gcc-include = runCommand "gcc-include" { } ''
mkdir -p $out
ln -s ${gcc-unwrapped}/include/ $out/
ln -s ${gcc-unwrapped}/lib/ $out/
'';
disallowedRefsForToolchain = [
stdenv.cc
stdenv.cc.cc
stdenv.cc.bintools
gcc-unwrapped
stdenvToBuildRocmLlvm
stdenvToBuildRocmLlvm.cc
stdenvToBuildRocmLlvm.cc.cc
];
# A prefix for use as the GCC prefix when building rocm-toolchain
gcc-prefix-headers = symlinkJoin {
name = "gcc-prefix-headers";
paths = [
glibc.dev
gcc-unwrapped.out
];
disallowedRequisites = [
glibc.dev
gcc-unwrapped.out
];
postBuild = ''
rm -rf $out/{bin,libexec,nix-support,lib64,share,etc}
rm $out/lib/gcc/x86_64-unknown-linux-gnu/*/plugin/include/auto-host.h
mkdir /build/tmpout
mv $out/* /build/tmpout
cp -Lr --no-preserve=mode /build/tmpout/* $out/
set -x
versionedIncludePath="$(echo $out/include/c++/*/)"
mv $versionedIncludePath/* $out/include/c++/
rm -rf $versionedIncludePath/
'';
};
gcc-prefix = symlinkJoin {
name = "gcc-prefix";
paths = [
gcc-prefix-headers
glibc
gcc-unwrapped.lib
];
disallowedRequisites = [
glibc.dev
gcc-unwrapped.out
];
postBuild = ''
rm -rf $out/{bin,libexec,nix-support,lib64,share,etc}
rm $out/lib/ld-linux-x86-64.so.2
ln -s $out $out/x86_64-unknown-linux-gnu
'';
};
llvmSrc = fetchFromGitHub {
owner = "ROCm";
repo = "llvm-project";
rev = "rocm-${version}";
hash = "sha256-TwFvQimbax2E37ZC/52lNkHXCgyBNfSGDBaqmas2x/s=";
};
llvmMajorVersion = lib.versions.major rocmLlvmVersion;
# An llvmPackages (pkgs/development/compilers/llvm/) built from ROCm LLVM's source tree
llvmPackagesRocm = llvmPackages_base.override (_old: {
stdenv = stdenvToBuildRocmLlvm;
# not setting gitRelease = because that causes patch selection logic to use git patches
# ROCm LLVM is closer to 20 official
# gitRelease = {}; officialRelease = null;
officialRelease = { }; # Set but empty because we're overriding everything from it.
# this version determines which patches are applied
version = rocmLlvmVersion;
src = llvmSrc;
monorepoSrc = llvmSrc;
doCheck = false;
});
refsToRemove = builtins.concatStringsSep " -t " [
stdenvToBuildRocmLlvm
stdenvToBuildRocmLlvm.cc
stdenvToBuildRocmLlvm.cc.cc
stdenv.cc
stdenv.cc.cc
stdenv.cc.bintools
];
# Hacky way to avoid nixfmt indenting the entire scope body suggested by @emilazy
overrideLlvmPackagesRocm =
f:
let
overridenScope = llvmPackagesRocm.overrideScope (final: prev: f { inherit final prev; });
in
{
inherit (overridenScope)
# Expose only a limited set of packages that we care about for ROCm
bintools
compiler-rt
compiler-rt-libc
clang
clang-unwrapped
libcxx
lld
llvm
rocm-toolchain
rocmClangStdenv
openmp
;
};
sysrootCompiler =
{
cc,
name,
paths,
linkPaths,
}:
let
linked = symlinkJoin { inherit name paths; };
in
runCommand name
{
pname = name;
# If this is erroring, try why-depends --precise on the symlinkJoin of inputs to look for the problem
# nix why-depends --precise .#rocmPackages.llvm.rocm-toolchain.linked /store/path/its/not/allowed
disallowedRequisites = disallowedRefsForToolchain;
passthru.linked = linked;
linkPaths = linkPaths;
passAsFile = [ "linkPaths" ];
# TODO(@LunNova): Try to use --sysroot with clang in its original location instead of
# relying on copying the binary?
# $clang/bin/clang++ --sysroot=$rocm-toolchain is not equivalent
# to a clang copied to $rocm-toolchain/bin here, have not yet figured out why
}
''
mkdir -p $out/
cp --reflink=auto -rL ${linked}/* $out/
chmod -R +rw $out
mkdir -p $out/usr
ln -s $out/ $out/usr/local
# we don't need mixed 32 bit, the presence of lib64 is used by LLVM to decide it's a multilib sysroot
rm -rf $out/lib64
rm -rf $out/lib/cmake $out/lib/lib*.a
mkdir -p $out/lib/clang/${llvmMajorVersion}/lib/linux/
ln -s $out/lib/linux/libclang_rt.* $out/lib/clang/${llvmMajorVersion}/lib/linux/
mkdir -p $out/lib/clang/${llvmMajorVersion}/lib/${stdenv.hostPlatform.config}/
for f in $out/lib/linux/*-${stdenv.hostPlatform.parsed.cpu.name}.*; do
[ -e "$f" ] || continue
base="$(basename "$f" | sed 's/-${stdenv.hostPlatform.parsed.cpu.name}\././')"
ln -sf "$f" "$out/lib/clang/${llvmMajorVersion}/lib/${stdenv.hostPlatform.config}/$base"
done
find $out -type f -exec sed -i "s|${cc.out}|$out|g" {} +
find $out -type f -exec sed -i "s|${cc.dev}|$out|g" {} +
# Clang config file: redirect resource dir to the sysroot (where compiler-rt
# lives) and set GCC install prefix for header/library search
cat > $out/bin/${stdenv.hostPlatform.config}.cfg <<CFG
-resource-dir=$out/lib/clang/${llvmMajorVersion}
${lib.optionalString (!withLibcxx) "--gcc-toolchain=${gcc-prefix}"}
CFG
${lib.getExe rdfind} -makesymlinks true ${
builtins.concatStringsSep " " (map (x: "${x}/lib") paths)
} $out/ # create links *within* the sysroot to save space
for i in $(cat $linkPathsPath); do
${lib.getExe lndir} -silent $i $out
done
echo 'export CC=clang' >> $out/nix-support/setup-hook
echo 'export CXX=clang++' >> $out/nix-support/setup-hook
'';
tablegenUsage = x: !(lib.strings.hasInfix "llvm-tblgen" x);
llvmTargetsFlag = "-DLLVM_TARGETS_TO_BUILD=AMDGPU;${
{
"x86_64" = "X86";
"aarch64" = "AArch64";
}
.${stdenv.targetPlatform.parsed.cpu.name}
or (throw "Unsupported CPU architecture: ${stdenv.targetPlatform.parsed.cpu.name}")
}";
llvmMeta = {
# TODO(@LunNova): it would be nice to support aarch64 for rocmPackages
platforms = [ "x86_64-linux" ];
};
# TODO(@LunNova): Some of this might be worth supporting in llvmPackages, dropping from here
commonCmakeFlags = [
llvmTargetsFlag
# Compression support is required for compressed offload kernels
# Set FORCE_ON so that failure to find the compression lib will be a build error
(lib.cmakeFeature "LLVM_ENABLE_ZSTD" "FORCE_ON")
# required for threaded ThinLTO to work
(lib.cmakeBool "LLVM_ENABLE_THREADS" true)
# third-party/benchmark is broken in rocm-7.2.0
# error: '__COUNTER__' is a C2y extension [-Werror,-Wc2y-extensions]
(lib.cmakeBool "LLVM_INCLUDE_BENCHMARKS" false)
# LLVM tries to call git to embed VCS info if FORCE_VC_ aren't set
(lib.cmakeFeature "LLVM_FORCE_VC_REVISION" "rocm-${version}")
(lib.cmakeFeature "LLVM_FORCE_VC_REPOSITORY" "https://github.com/ROCm/llvm-project")
(lib.cmakeFeature "LLVM_VERSION_SUFFIX" "")
(lib.cmakeBool "LLVM_ENABLE_LIBCXX" withLibcxx)
(lib.cmakeFeature "CLANG_DEFAULT_CXX_STDLIB" (if withLibcxx then "libc++" else "libstdc++"))
(lib.cmakeFeature "CLANG_VENDOR" "nixpkgs-AMD")
(lib.cmakeFeature "CLANG_REPOSITORY_STRING" "https://github.com/ROCm/llvm-project/tree/rocm-${version}")
]
++ lib.optionals withLibcxx [
(lib.cmakeFeature "CLANG_DEFAULT_RTLIB" "compiler-rt")
]
++ lib.optionals withLto [
(lib.cmakeBool "CMAKE_INTERPROCEDURAL_OPTIMIZATION" true)
(lib.cmakeBool "LLVM_ENABLE_FATLTO" false)
]
++ lib.optionals (withLto && stdenvToBuildRocmLlvm.cc.isClang) [
(lib.cmakeFeature "LLVM_ENABLE_LTO" "FULL")
(lib.cmakeFeature "LLVM_USE_LINKER" "lld")
];
llvmExtraCflags = lib.concatStringsSep " " (
lib.optionals (stdenv.hostPlatform.system == "x86_64-linux") [
# Unprincipled decision to build x86_64 ROCm clang for at least skylake and tune for zen3+
# In practice building the ROCm package set with anything earlier than zen3 is annoying
# and earlier than skylake is implausible due to too few cores and too little RAM
# Speeds up composable_kernel builds by ~4%
# If this causes trouble in practice we can drop this. Set since 2025-03-24.
"-march=skylake"
"-mtune=znver3"
]
++ lib.optionals profilableStdenv [
# compressed line only debug info for profiling
"-gz"
"-g1"
]
);
inherit (llvmPackagesRocm) libcxx;
in
overrideLlvmPackagesRocm (s: {
libllvm = (s.prev.libllvm.override { }).overrideAttrs (old: {
patches = [
# Backport select ptr combine fixes so our LLVM 22 sdag fix backport can apply
(fetchpatch {
name = "amdgpu-add-baseline-load-select-ptr-combine-test.patch";
url = "https://github.com/llvm/llvm-project/commit/ac27b2455ad7c89cc1f928de7beb05933a035031.patch";
relative = "llvm";
hash = "sha256-1mine1h/oqnn2tKDYW4FntyZXu/foyifrKGkqKOHrPg=";
})
(fetchpatch {
name = "amdgpu-fix-treating-divergent-loads-as-uniform.patch";
url = "https://github.com/llvm/llvm-project/commit/d3c3c6bab5df051d9db12ea96add2211df9d81be.patch";
relative = "llvm";
hash = "sha256-9VB77d4d+nwX8s+JBq1PXmbmqT7oD6lRC0uDIrTgjjo=";
})
(fetchpatch {
name = "dag-allow-select-ptr-combine-for-non-0-address-spaces.patch";
url = "https://github.com/llvm/llvm-project/commit/0e1cb2de90aafa1d5dbd46fc9e6c4e743700fa8b.patch";
relative = "llvm";
hash = "sha256-6Pj3pRESaho60YhXWwaQxEKteSuziZseeT4FbZqZANk=";
})
]
++ old.patches
++ [
./perf-increase-namestring-size.patch
# v64i8 shuffle lowering inf loop on VBMI targets, hangs whisper-cpp etc
# https://github.com/NixOS/nixpkgs/issues/497745
(fetchpatch {
# https://github.com/llvm/llvm-project/pull/182832
name = "llvm-x86-v64i8-add-test-coverage.patch";
url = "https://github.com/llvm/llvm-project/commit/0e3a96d0ec01e3575674d72c4e23bf98affdca28.patch";
relative = "llvm";
hash = "sha256-qhRkB8Fjz/fNacuGv1OFkiTNOQ0/QQ9p4pLFudwrTzM=";
})
(fetchpatch {
# https://github.com/llvm/llvm-project/pull/182852
name = "llvm-x86-v64i8-prefer-vpermv3-on-vbmi.patch";
url = "https://github.com/llvm/llvm-project/commit/8f5880d3ae4e5dfc748985d90e5413671028aa3e.patch";
relative = "llvm";
hash = "sha256-4DU6gu/1+iQpzvVYBlTTUKtw77QSRyTja4hdel4D5Cw=";
})
(fetchpatch {
# https://github.com/llvm/llvm-project/pull/183109
name = "llvm-x86-v64i8-skip-repeated-mask-lane-permute-on-vbmi.patch";
url = "https://github.com/llvm/llvm-project/commit/1b9fea021840f17c41ea980300d0fc45e7285909.patch";
relative = "llvm";
hash = "sha256-9Akm78QQr8BIMrVWwDG3poWS1HuQ0hpIQWfke3oADgg=";
})
# TODO: consider reapplying "Don't include aliases in RegisterClassInfo::IgnoreCSRForAllocOrder"
# it was reverted as it's a pessimization for non-GPU archs, but this compiler
# is used mostly for amdgpu
];
dontStrip = profilableStdenv;
hardeningDisable = [ "all" ];
nativeBuildInputs = old.nativeBuildInputs ++ [ removeReferencesTo ];
buildInputs = old.buildInputs ++ [
zstd
];
preFixup = ''
moveToOutput "lib/lib*.a" "$dev"
moveToOutput "lib/cmake" "$dev"
sed -Ei "s|$lib/lib/(lib[^/]*)\.a|$dev/lib/\1.a|g" $dev/lib/cmake/llvm/*.cmake
'';
env = (old.env or { }) // {
NIX_CFLAGS_COMPILE = "${(old.env or { }).NIX_CFLAGS_COMPILE or ""} ${llvmExtraCflags}";
};
cmakeFlags = (builtins.filter tablegenUsage old.cmakeFlags) ++ commonCmakeFlags;
# Ensure we don't leak refs to compiler that was used to bootstrap this LLVM
disallowedReferences = (old.disallowedReferences or [ ]) ++ disallowedRefsForToolchain;
postFixup = ''
${old.postFixup or ""}
find $lib -type f -exec remove-references-to -t ${refsToRemove} {} +
'';
meta = old.meta // llvmMeta;
});
lld =
(s.prev.lld.override {
}).overrideAttrs
(old: {
dontStrip = profilableStdenv;
hardeningDisable = [ "all" ];
nativeBuildInputs = old.nativeBuildInputs ++ [
removeReferencesTo
];
buildInputs = old.buildInputs ++ [
zstd
];
env = (old.env or { }) // {
NIX_CFLAGS_COMPILE = "${(old.env or { }).NIX_CFLAGS_COMPILE or ""} ${llvmExtraCflags}";
};
cmakeFlags = (builtins.filter tablegenUsage old.cmakeFlags) ++ commonCmakeFlags;
# Ensure we don't leak refs to compiler that was used to bootstrap this LLVM
disallowedReferences = (old.disallowedReferences or [ ]) ++ disallowedRefsForToolchain;
postFixup = ''
${old.postFixup or ""}
find $lib -type f -exec remove-references-to -t ${refsToRemove} {} +
'';
meta = old.meta // llvmMeta;
});
clang-unwrapped = (
(s.prev.clang-unwrapped.override {
enableClangToolsExtra = false;
}).overrideAttrs
(old: {
passthru = old.passthru // {
inherit gcc-prefix;
};
patches = [
(fetchpatch {
# [clang][cmake] Add option to control scan-build-py installation (#172727)
name = "clang-scan-build-py-configurable.patch";
url = "https://github.com/llvm/llvm-project/commit/f5759eeb63a3a5ce7d555c13c3126cea84e0c7b1.patch";
relative = "clang";
hash = "sha256-73IDPGZWKX4vny3x5FJ3/NQw8XRad9UNwfYkvQdMB4s=";
})
]
++ old.patches
++ [
# Never add FHS include paths
./clang-bodge-ignore-systemwide-incls.diff
# Prevents builds timing out if a single compiler invocation is very slow but
# per-arch jobs are completing by ensuring there's terminal output
./clang-log-jobs.diff
./opt-offload-compress-on-by-default.patch
./perf-shorten-gcclib-include-paths.patch
(fetchpatch {
# [ClangOffloadBundler]: Add GetBundleIDsInFile to OffloadBundler
hash = "sha256-OsarDZXuJ5vAXTP4i0NBUeK/r6tQPumaqmMWkf29UtM=";
url = "https://github.com/GZGavinZhao/rocm-llvm-project/commit/c7de294b0d1d25f277f9d1cbb2c9e09c7600e210.patch";
relative = "clang";
})
];
# ROCm 7.2 commits 4dda51261a6 "Replace hostexec with upstream rpc"
# and 2ca1509d6d2 "Put the RTL, Back!", added CGEmitEmissaryExec.cpp which
# includes ../../openmp/device/include/EmissaryIds.h, breaking
# standalone clang builds. The upstream PR llvm/llvm-project#175265
# ("[OpenMP] support for Emissary APIs") moves EmissaryIds.h into
# clang/lib/Headers/ so this should not be needed once that lands
# and ROCm rebases onto it.
postUnpack = ''
${old.postUnpack or ""}
mkdir -p "''${sourceRoot}/openmp/device/include"
ln -s "${llvmSrc}/openmp/device/include/EmissaryIds.h" "''${sourceRoot}/openmp/device/include/"
'';
hardeningDisable = [ "all" ];
nativeBuildInputs = old.nativeBuildInputs ++ [
removeReferencesTo
];
buildInputs = old.buildInputs ++ [
zstd
];
env = (old.env or { }) // {
NIX_CFLAGS_COMPILE = "${(old.env or { }).NIX_CFLAGS_COMPILE or ""} ${llvmExtraCflags}";
};
dontStrip = profilableStdenv;
# Ensure we don't leak refs to compiler that was used to bootstrap this LLVM
disallowedReferences = (old.disallowedReferences or [ ]) ++ disallowedRefsForToolchain;
# Enable structured attrs for separateDebugInfo, because it is required with disallowedReferences set
__structuredAttrs = true;
# https://github.com/llvm/llvm-project/blob/6976deebafa8e7de993ce159aa6b82c0e7089313/clang/cmake/caches/DistributionExample-stage2.cmake#L9-L11
cmakeFlags =
# TODO: Remove in followup, tblgen now works correctly but would rebuild
(builtins.filter tablegenUsage old.cmakeFlags) ++ commonCmakeFlags;
preFixup = ''
${toString old.preFixup or ""}
moveToOutput "lib/lib*.a" "$dev"
moveToOutput "lib/cmake" "$dev"
mkdir -p $dev/lib/clang/
ln -s $lib/lib/clang/${llvmMajorVersion} $dev/lib/clang/
sed -Ei "s|$lib/lib/(lib[^/]*)\.a|$dev/lib/\1.a|g" $dev/lib/cmake/clang/*.cmake
'';
postFixup = ''
${toString old.postFixup or ""}
find $lib -type f -exec remove-references-to -t ${refsToRemove} {} +
find $dev -type f -exec remove-references-to -t ${refsToRemove} {} +
'';
meta = old.meta // llvmMeta;
})
);
# A clang that understands standard include searching in a GNU sysroot and will put GPU libs in include path
# in the right order
# and expects its libc to be in the sysroot
rocm-toolchain =
with s.final;
(sysrootCompiler {
cc = clang-unwrapped;
name = "rocm-toolchain";
paths = [
clang-unwrapped.out
clang-unwrapped.lib
bintools.out
compiler-rt.out
openmp.out
openmp.dev
]
++ lib.optionals withLibcxx [
libcxx
]
++ lib.optionals (!withLibcxx) [
glibc
glibc.dev
];
linkPaths = [
bintools.bintools.out
]
++ lib.optionals (!withLibcxx) [
gcc-include.out
];
})
// {
version = llvmMajorVersion;
cc = rocm-toolchain;
libllvm = llvm;
isClang = true;
isGNU = false;
};
compiler-rt-libc = s.prev.compiler-rt-libc.overrideAttrs (old: {
meta = old.meta // llvmMeta;
});
compiler-rt = s.final.compiler-rt-libc;
clang = s.final.rocm-toolchain;
rocmClangStdenv = with s.final; overrideCC (if withLibcxx then libcxxStdenv else stdenv) clang;
# Projects
openmp =
with s.final;
(llvmPackagesRocm.openmp.override {
llvm = llvm;
clang-unwrapped = clang-unwrapped;
}).overrideAttrs
(old: {
disallowedReferences = (old.disallowedReferences or [ ]) ++ disallowedRefsForToolchain;
nativeBuildInputs = (old.nativeBuildInputs or [ ]) ++ [
removeReferencesTo
];
cmakeFlags =
old.cmakeFlags
++ commonCmakeFlags
++ [
"-DDEVICELIBS_ROOT=${rocm-device-libs.src}"
# OMPD support is broken in ROCm 6.3+ Haven't investigated why.
"-DLIBOMP_OMPD_SUPPORT:BOOL=FALSE"
"-DLIBOMP_OMPD_GDB_SUPPORT:BOOL=FALSE"
];
buildInputs = old.buildInputs ++ [
clang-unwrapped
zstd
libxml2
libffi
];
postFixup = ''
${old.postFixup or ""}
ln -s $out/lib/libomp.so $dev/lib/libomp.so
'';
});
# AMD has a separate MLIR impl which we package under rocmPackages.rocmlir
# It would be an error to rely on the original mlir package from this scope
mlir = null;
})