Skip to content

Commit

Permalink
[DirectX][DXIL] Set DXIL Version in DXIL target triple based on shade…
Browse files Browse the repository at this point in the history
…r model version (llvm#90809)

An earlier commit provided a way to decouple DXIL version from Shader
Model version by representing the DXIL version as `SubArch` in the DXIL 
Target Triple and adding corresponding valid DXIL Arch types.

This change constructs DXIL target triple with DXIL version that is
deduced from Shader Model version specified in the following scenarios:

1. When compilation target profile is specified: 
For e.g., DXIL target triple `dxilv1.8-unknown-shader6.8-library` is
constructed when `-T lib_6_8` is specified. 
2. When DXIL target triple without DXIL version is specified:
For e.g., DXIL target triple `dxilv1.8-pc-shadermodel6.8-library` is
constructed when `-mtriple=dxil-pc-shadermodel6.8-library` is specified.

Updated relevant HLSL tests that check for target triple. 

Validated that Clang (`check-clang`) and LLVM (`check-llvm`) regression
tests pass.
  • Loading branch information
bharadwajy committed May 6, 2024
1 parent 89e0557 commit 080978d
Show file tree
Hide file tree
Showing 10 changed files with 148 additions and 21 deletions.
2 changes: 1 addition & 1 deletion clang/lib/Basic/Targets.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@ using namespace clang::targets;
TargetInfo *
TargetInfo::CreateTargetInfo(DiagnosticsEngine &Diags,
const std::shared_ptr<TargetOptions> &Opts) {
llvm::Triple Triple(Opts->Triple);
llvm::Triple Triple(llvm::Triple::normalize(Opts->Triple));

// Construct the target
std::unique_ptr<TargetInfo> Target = AllocateTarget(Triple, *Opts);
Expand Down
44 changes: 42 additions & 2 deletions clang/lib/Driver/ToolChains/HLSL.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,49 @@ std::optional<std::string> tryParseProfile(StringRef Profile) {
else if (llvm::getAsUnsignedInteger(Parts[2], 0, Minor))
return std::nullopt;

// dxil-unknown-shadermodel-hull
// Determine DXIL version using the minor version number of Shader
// Model version specified in target profile. Prior to decoupling DXIL version
// numbering from that of Shader Model DXIL version 1.Y corresponds to SM 6.Y.
// E.g., dxilv1.Y-unknown-shadermodelX.Y-hull
llvm::Triple T;
T.setArch(Triple::ArchType::dxil);
Triple::SubArchType SubArch = llvm::Triple::NoSubArch;
switch (Minor) {
case 0:
SubArch = llvm::Triple::DXILSubArch_v1_0;
break;
case 1:
SubArch = llvm::Triple::DXILSubArch_v1_1;
break;
case 2:
SubArch = llvm::Triple::DXILSubArch_v1_2;
break;
case 3:
SubArch = llvm::Triple::DXILSubArch_v1_3;
break;
case 4:
SubArch = llvm::Triple::DXILSubArch_v1_4;
break;
case 5:
SubArch = llvm::Triple::DXILSubArch_v1_5;
break;
case 6:
SubArch = llvm::Triple::DXILSubArch_v1_6;
break;
case 7:
SubArch = llvm::Triple::DXILSubArch_v1_7;
break;
case 8:
SubArch = llvm::Triple::DXILSubArch_v1_8;
break;
case OfflineLibMinor:
// Always consider minor version x as the latest supported DXIL version
SubArch = llvm::Triple::LatestDXILSubArch;
break;
default:
// No DXIL Version corresponding to specified Shader Model version found
return std::nullopt;
}
T.setArch(Triple::ArchType::dxil, SubArch);
T.setOSName(Triple::getOSTypeName(Triple::OSType::ShaderModel).str() +
VersionTuple(Major, Minor).getAsString());
T.setEnvironment(Kind);
Expand Down
2 changes: 1 addition & 1 deletion clang/test/CodeGenHLSL/basic-target.c
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
// RUN: %clang -target dxil-pc-shadermodel6.0-geometry -S -emit-llvm -o - %s | FileCheck %s

// CHECK: target datalayout = "e-m:e-p:32:32-i1:32-i8:8-i16:16-i32:32-i64:64-f16:16-f32:32-f64:64-n8:16:32:64"
// CHECK: target triple = "dxil-pc-shadermodel6.0-{{[a-z]+}}"
// CHECK: target triple = "dxilv1.0-pc-shadermodel6.0-{{[a-z]+}}"
6 changes: 3 additions & 3 deletions clang/test/Driver/dxc_dxv_path.hlsl
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
// DXV_PATH:dxv{{(.exe)?}}" "-" "-o" "-"

// RUN: %clang_dxc -I test -Vd -Tlib_6_3 -### %s 2>&1 | FileCheck %s --check-prefix=VD
// VD:"-cc1"{{.*}}"-triple" "dxil-unknown-shadermodel6.3-library"
// VD:"-cc1"{{.*}}"-triple" "dxilv1.3-unknown-shadermodel6.3-library"
// VD-NOT:dxv not found

// RUN: %clang_dxc -Tlib_6_3 -ccc-print-bindings --dxv-path=%T -Fo %t.dxo %s 2>&1 | FileCheck %s --check-prefix=BINDINGS
// BINDINGS: "dxil-unknown-shadermodel6.3-library" - "clang", inputs: ["[[INPUT:.+]]"], output: "[[DXC:.+]].dxo"
// BINDINGS-NEXT: "dxil-unknown-shadermodel6.3-library" - "hlsl::Validator", inputs: ["[[DXC]].dxo"]
// BINDINGS: "dxilv1.3-unknown-shadermodel6.3-library" - "clang", inputs: ["[[INPUT:.+]]"], output: "[[DXC:.+]].dxo"
// BINDINGS-NEXT: "dxilv1.3-unknown-shadermodel6.3-library" - "hlsl::Validator", inputs: ["[[DXC]].dxo"]

// RUN: %clang_dxc -Tlib_6_3 -ccc-print-phases --dxv-path=%T -Fo %t.dxc %s 2>&1 | FileCheck %s --check-prefix=PHASES

Expand Down
4 changes: 2 additions & 2 deletions clang/test/Options/enable_16bit_types_validation.hlsl
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
// HV_invalid_2017: error: '-enable-16bit-types' option requires target HLSL Version >= 2018 and shader model >= 6.2, but HLSL Version is 'hlsl2017' and shader model is '6.4'
// TP_invalid: error: '-enable-16bit-types' option requires target HLSL Version >= 2018 and shader model >= 6.2, but HLSL Version is 'hlsl2021' and shader model is '6.0'

// valid_2021: "dxil-unknown-shadermodel6.4-library"
// valid_2021: "dxilv1.4-unknown-shadermodel6.4-library"
// valid_2021-SAME: "-std=hlsl2021"
// valid_2021-SAME: "-fnative-half-type"

// valid_2018: "dxil-unknown-shadermodel6.4-library"
// valid_2018: "dxilv1.4-unknown-shadermodel6.4-library"
// valid_2018-SAME: "-std=hlsl2018"
// valid_2018-SAME: "-fnative-half-type"

Expand Down
22 changes: 12 additions & 10 deletions clang/unittests/Driver/DXCModeTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -68,25 +68,27 @@ TEST(DxcModeTest, TargetProfileValidation) {
IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
DiagnosticsEngine Diags(DiagID, &*DiagOpts, DiagConsumer);

validateTargetProfile("-Tvs_6_0", "dxil--shadermodel6.0-vertex",
validateTargetProfile("-Tvs_6_0", "dxilv1.0--shadermodel6.0-vertex",
InMemoryFileSystem, Diags);
validateTargetProfile("-Ths_6_1", "dxil--shadermodel6.1-hull",
validateTargetProfile("-Ths_6_1", "dxilv1.1--shadermodel6.1-hull",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tds_6_2", "dxil--shadermodel6.2-domain",
validateTargetProfile("-Tds_6_2", "dxilv1.2--shadermodel6.2-domain",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tds_6_2", "dxil--shadermodel6.2-domain",
validateTargetProfile("-Tds_6_2", "dxilv1.2--shadermodel6.2-domain",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tgs_6_3", "dxil--shadermodel6.3-geometry",
validateTargetProfile("-Tgs_6_3", "dxilv1.3--shadermodel6.3-geometry",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tps_6_4", "dxil--shadermodel6.4-pixel",
validateTargetProfile("-Tps_6_4", "dxilv1.4--shadermodel6.4-pixel",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tcs_6_5", "dxil--shadermodel6.5-compute",
validateTargetProfile("-Tcs_6_5", "dxilv1.5--shadermodel6.5-compute",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tms_6_6", "dxil--shadermodel6.6-mesh",
validateTargetProfile("-Tms_6_6", "dxilv1.6--shadermodel6.6-mesh",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tas_6_7", "dxil--shadermodel6.7-amplification",
validateTargetProfile("-Tas_6_7", "dxilv1.7--shadermodel6.7-amplification",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tlib_6_x", "dxil--shadermodel6.15-library",
validateTargetProfile("-Tcs_6_8", "dxilv1.8--shadermodel6.8-compute",
InMemoryFileSystem, Diags);
validateTargetProfile("-Tlib_6_x", "dxilv1.8--shadermodel6.15-library",
InMemoryFileSystem, Diags);

// Invalid tests.
Expand Down
1 change: 1 addition & 0 deletions llvm/include/llvm/TargetParser/Triple.h
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ class Triple {
DXILSubArch_v1_6,
DXILSubArch_v1_7,
DXILSubArch_v1_8,
LatestDXILSubArch = DXILSubArch_v1_8,
};
enum VendorType {
UnknownVendor,
Expand Down
4 changes: 2 additions & 2 deletions llvm/lib/IR/Verifier.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,8 @@ struct VerifierSupport {
bool TreatBrokenDebugInfoAsError = true;

explicit VerifierSupport(raw_ostream *OS, const Module &M)
: OS(OS), M(M), MST(&M), TT(M.getTargetTriple()), DL(M.getDataLayout()),
Context(M.getContext()) {}
: OS(OS), M(M), MST(&M), TT(Triple::normalize(M.getTargetTriple())),
DL(M.getDataLayout()), Context(M.getContext()) {}

private:
void Write(const Module *M) {
Expand Down
68 changes: 68 additions & 0 deletions llvm/lib/TargetParser/Triple.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,31 @@ StringRef Triple::getArchName(ArchType Kind, SubArchType SubArch) {
if (SubArch == AArch64SubArch_arm64e)
return "arm64e";
break;
case Triple::dxil:
switch (SubArch) {
case Triple::NoSubArch:
case Triple::DXILSubArch_v1_0:
return "dxilv1.0";
case Triple::DXILSubArch_v1_1:
return "dxilv1.1";
case Triple::DXILSubArch_v1_2:
return "dxilv1.2";
case Triple::DXILSubArch_v1_3:
return "dxilv1.3";
case Triple::DXILSubArch_v1_4:
return "dxilv1.4";
case Triple::DXILSubArch_v1_5:
return "dxilv1.5";
case Triple::DXILSubArch_v1_6:
return "dxilv1.6";
case Triple::DXILSubArch_v1_7:
return "dxilv1.7";
case Triple::DXILSubArch_v1_8:
return "dxilv1.8";
default:
break;
}
break;
default:
break;
}
Expand Down Expand Up @@ -1014,6 +1039,8 @@ Triple::Triple(const Twine &ArchStr, const Twine &VendorStr, const Twine &OSStr,
ObjectFormat = getDefaultFormat(*this);
}

static VersionTuple parseVersionFromName(StringRef Name);

std::string Triple::normalize(StringRef Str) {
bool IsMinGW32 = false;
bool IsCygwin = false;
Expand Down Expand Up @@ -1206,6 +1233,47 @@ std::string Triple::normalize(StringRef Str) {
}
}

// Normalize DXIL triple if it does not include DXIL version number.
// Determine DXIL version number using the minor version number of Shader
// Model version specified in target triple, if any. Prior to decoupling DXIL
// version numbering from that of Shader Model DXIL version 1.Y corresponds to
// SM 6.Y. E.g., dxilv1.Y-unknown-shadermodelX.Y-hull
if (Components[0] == "dxil") {
if (Components.size() > 4) {
Components.resize(4);
}
// Add DXIL version only if shadermodel is specified in the triple
if (OS == Triple::ShaderModel) {
VersionTuple Ver =
parseVersionFromName(Components[2].drop_front(strlen("shadermodel")));
// Default DXIL minor version when Shader Model version is anything other
// than 6.[0...8] or 6.x (which translates to latest current SM version)
// DXIL version corresponding to Shader Model version other than 6.x
// is 1.0
unsigned DXILMinor = 0;
const unsigned SMMajor = 6;
const unsigned LatestCurrentDXILMinor = 8;
if (!Ver.empty()) {
if (Ver.getMajor() == SMMajor) {
if (std::optional<unsigned> SMMinor = Ver.getMinor()) {
DXILMinor = *SMMinor;
// Ensure specified minor version is supported
if (DXILMinor > LatestCurrentDXILMinor) {
report_fatal_error("Unsupported Shader Model version", false);
}
}
}
} else {
// Special case: DXIL minor version is set to LatestCurrentDXILMinor for
// shadermodel6.x is
if (Components[2] == "shadermodel6.x") {
DXILMinor = LatestCurrentDXILMinor;
}
}
Components[0] =
Components[0].str().append("v1.").append(std::to_string(DXILMinor));
}
}
// Stick the corrected components back together to form the normalized string.
return join(Components, "-");
}
Expand Down
16 changes: 16 additions & 0 deletions llvm/unittests/TargetParser/TripleTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2454,4 +2454,20 @@ TEST(TripleTest, isArmMClass) {
EXPECT_TRUE(T.isArmMClass());
}
}

TEST(TripleTest, DXILNormaizeWithVersion) {
EXPECT_EQ("dxilv1.0-unknown-shadermodel6.0",
Triple::normalize("dxilv1.0--shadermodel6.0"));
EXPECT_EQ("dxilv1.0-unknown-shadermodel6.0",
Triple::normalize("dxil--shadermodel6.0"));
EXPECT_EQ("dxilv1.1-unknown-shadermodel6.1-library",
Triple::normalize("dxil-shadermodel6.1-unknown-library"));
EXPECT_EQ("dxilv1.8-unknown-shadermodel6.x-unknown",
Triple::normalize("dxil-unknown-shadermodel6.x-unknown"));
EXPECT_EQ("dxilv1.8-unknown-shadermodel6.x-unknown",
Triple::normalize("dxil-unknown-shadermodel6.x-unknown"));
EXPECT_EQ("dxil-unknown-unknown-unknown", Triple::normalize("dxil---"));
EXPECT_EQ("dxilv1.0-pc-shadermodel5.0-compute",
Triple::normalize("dxil-shadermodel5.0-pc-compute"));
}
} // end anonymous namespace

0 comments on commit 080978d

Please sign in to comment.