eeee5a44bb
This PR is one of the many PRs in the SYCL upstreaming effort focusing on device code linking during the SYCL offload compilation process. RFC: https://discourse.llvm.org/t/rfc-offloading-design-for-sycl-offload-kind-and-spir-targets/74088 In this PR, we introduce a new tool that will be used to perform device code linking for SYCL offload kind. It accepts SYCL device objects in LLVM IR bitcode format and will generate a fully linked device object that can then be wrapped and linked into the host object. A primary use case for this tool is to perform device code linking for objects with SYCL offload kind inside the clang-linker-wrapper. It can also be invoked via clang driver as follows: `clang --target=spirv64 --sycl-link input.bc` Device code linking for SYCL offloading kind has a number of known quirks that makes it difficult to use in a unified offloading setting. Two of the primary issues are: 1. Several finalization steps are required to be run on the fully-linked LLVM IR bitcode to gaurantee conformance to SYCL standards. This step is unique to SYCL offloading compilation flow. 2. SPIR-V LLVM Translator tool is an extenal tool and hence SPIR-V IR code generation cannot be done as part of LTO. This limitation will be lifted once SPIR-V backend is available as a viable LLVM backend. Hence, we introduce this new tool to provide a clean wrapper to perform SYCL device linking. Co-Author: Michael Toguchi Thanks --------- Signed-off-by: Arvind Sudarsanam <arvind.sudarsanam@intel.com>
116 lines
4.5 KiB
C++
116 lines
4.5 KiB
C++
//===--- SPIRV.cpp - SPIR-V Tool Implementations ----------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#include "SPIRV.h"
|
|
#include "CommonArgs.h"
|
|
#include "clang/Basic/Version.h"
|
|
#include "clang/Driver/Compilation.h"
|
|
#include "clang/Driver/Driver.h"
|
|
#include "clang/Driver/InputInfo.h"
|
|
#include "clang/Driver/Options.h"
|
|
|
|
using namespace clang::driver;
|
|
using namespace clang::driver::toolchains;
|
|
using namespace clang::driver::tools;
|
|
using namespace llvm::opt;
|
|
|
|
void SPIRV::constructTranslateCommand(Compilation &C, const Tool &T,
|
|
const JobAction &JA,
|
|
const InputInfo &Output,
|
|
const InputInfo &Input,
|
|
const llvm::opt::ArgStringList &Args) {
|
|
llvm::opt::ArgStringList CmdArgs(Args);
|
|
CmdArgs.push_back(Input.getFilename());
|
|
|
|
if (Input.getType() == types::TY_PP_Asm)
|
|
CmdArgs.push_back("-to-binary");
|
|
if (Output.getType() == types::TY_PP_Asm)
|
|
CmdArgs.push_back("--spirv-tools-dis");
|
|
|
|
CmdArgs.append({"-o", Output.getFilename()});
|
|
|
|
// Try to find "llvm-spirv-<LLVM_VERSION_MAJOR>". Otherwise, fall back to
|
|
// plain "llvm-spirv".
|
|
using namespace std::string_literals;
|
|
auto VersionedTool = "llvm-spirv-"s + std::to_string(LLVM_VERSION_MAJOR);
|
|
std::string ExeCand = T.getToolChain().GetProgramPath(VersionedTool.c_str());
|
|
if (!llvm::sys::fs::can_execute(ExeCand))
|
|
ExeCand = T.getToolChain().GetProgramPath("llvm-spirv");
|
|
|
|
const char *Exec = C.getArgs().MakeArgString(ExeCand);
|
|
C.addCommand(std::make_unique<Command>(JA, T, ResponseFileSupport::None(),
|
|
Exec, CmdArgs, Input, Output));
|
|
}
|
|
|
|
void SPIRV::Translator::ConstructJob(Compilation &C, const JobAction &JA,
|
|
const InputInfo &Output,
|
|
const InputInfoList &Inputs,
|
|
const ArgList &Args,
|
|
const char *LinkingOutput) const {
|
|
claimNoWarnArgs(Args);
|
|
if (Inputs.size() != 1)
|
|
llvm_unreachable("Invalid number of input files.");
|
|
constructTranslateCommand(C, *this, JA, Output, Inputs[0], {});
|
|
}
|
|
|
|
clang::driver::Tool *SPIRVToolChain::getTranslator() const {
|
|
if (!Translator)
|
|
Translator = std::make_unique<SPIRV::Translator>(*this);
|
|
return Translator.get();
|
|
}
|
|
|
|
clang::driver::Tool *SPIRVToolChain::SelectTool(const JobAction &JA) const {
|
|
Action::ActionClass AC = JA.getKind();
|
|
return SPIRVToolChain::getTool(AC);
|
|
}
|
|
|
|
clang::driver::Tool *SPIRVToolChain::getTool(Action::ActionClass AC) const {
|
|
switch (AC) {
|
|
default:
|
|
break;
|
|
case Action::BackendJobClass:
|
|
case Action::AssembleJobClass:
|
|
return SPIRVToolChain::getTranslator();
|
|
}
|
|
return ToolChain::getTool(AC);
|
|
}
|
|
clang::driver::Tool *SPIRVToolChain::buildLinker() const {
|
|
return new tools::SPIRV::Linker(*this);
|
|
}
|
|
|
|
void SPIRV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
|
|
const InputInfo &Output,
|
|
const InputInfoList &Inputs,
|
|
const ArgList &Args,
|
|
const char *LinkingOutput) const {
|
|
const ToolChain &ToolChain = getToolChain();
|
|
std::string Linker = ToolChain.GetProgramPath(getShortName());
|
|
ArgStringList CmdArgs;
|
|
AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
|
|
|
|
CmdArgs.push_back("-o");
|
|
CmdArgs.push_back(Output.getFilename());
|
|
|
|
// Use of --sycl-link will call the clang-sycl-linker instead of
|
|
// the default linker (spirv-link).
|
|
if (Args.hasArg(options::OPT_sycl_link))
|
|
Linker = ToolChain.GetProgramPath("clang-sycl-linker");
|
|
C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
|
|
Args.MakeArgString(Linker), CmdArgs,
|
|
Inputs, Output));
|
|
}
|
|
|
|
SPIRVToolChain::SPIRVToolChain(const Driver &D, const llvm::Triple &Triple,
|
|
const ArgList &Args)
|
|
: ToolChain(D, Triple, Args) {
|
|
// TODO: Revisit need/use of --sycl-link option once SYCL toolchain is
|
|
// available and SYCL linking support is moved there.
|
|
NativeLLVMSupport = Args.hasArg(options::OPT_sycl_link);
|
|
}
|
|
|
|
bool SPIRVToolChain::HasNativeLLVMSupport() const { return NativeLLVMSupport; }
|