HIPSPV.h

Go to the documentation of this file.

//===--- HIPSPV.h - HIP ToolChain 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
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_HIPSPV_H
#define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_HIPSPV_H
 
#include "SPIRV.h"
#include "clang/Driver/Driver.h"
#include "clang/Driver/Tool.h"
#include "clang/Driver/ToolChain.h"
 
namespace clang {
namespace driver {
namespace tools {
namespace HIPSPV {
 
// Runs llvm-link/opt/llc/lld, which links multiple LLVM bitcode, together with
// device library, then compiles it to SPIR-V in a shared object.
class LLVM_LIBRARY_VISIBILITY Linker final : public Tool {
public:
  Linker(const ToolChain &TC) : Tool("HIPSPV::Linker", "hipspv-link", TC) {}
 
  bool hasIntegratedCPP() const override { return false; }
 
  void ConstructJob(Compilation &C, const JobAction &JA,
                    const InputInfo &Output, const InputInfoList &Inputs,
                    const llvm::opt::ArgList &TCArgs,
                    const char *LinkingOutput) const override;
 
private:
  void constructLinkAndEmitSpirvCommand(Compilation &C, const JobAction &JA,
                                        const InputInfoList &Inputs,
                                        const InputInfo &Output,
                                        const llvm::opt::ArgList &Args) const;
};
 
} // namespace HIPSPV
} // namespace tools
 
namespace toolchains {
 
class LLVM_LIBRARY_VISIBILITY HIPSPVToolChain final : public ToolChain {
public:
  HIPSPVToolChain(const Driver &D, const llvm::Triple &Triple,
                  const ToolChain &HostTC, const llvm::opt::ArgList &Args);
  HIPSPVToolChain(const Driver &D, const llvm::Triple &Triple,
                  const llvm::opt::ArgList &Args);
 
  const llvm::Triple *getAuxTriple() const override {
    return HostTC ? &HostTC->getTriple() : nullptr;
  }
 
  // Keep IsIntegratedBackendDefault() at the base class' "true": it also
  // decides whether clang's compile and backend jobs are collapsed into a
  // single -cc1 invocation, so making it depend on whether the SPIR-V backend
  // was built would change the device compilation job layout of every HIPSPV
  // compile. The fallback to the external llvm-spirv translator is decided in
  // HIPSPV::Linker::constructLinkAndEmitSpirvCommand instead.
  bool IsIntegratedBackendSupported() const override;
  bool IsNonIntegratedBackendSupported() const override { return true; }
 
  void
  addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
                        llvm::opt::ArgStringList &CC1Args, BoundArch BA,
                        Action::OffloadKind DeviceOffloadKind) const override;
  void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override;
  CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const override;
  void
  AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs,
                            llvm::opt::ArgStringList &CC1Args) const override;
  void AddClangCXXStdlibIncludeArgs(
      const llvm::opt::ArgList &Args,
      llvm::opt::ArgStringList &CC1Args) const override;
  void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs,
                           llvm::opt::ArgStringList &CC1Args) const override;
  void AddHIPIncludeArgs(const llvm::opt::ArgList &DriverArgs,
                         llvm::opt::ArgStringList &CC1Args) const override;
  llvm::SmallVector<BitCodeLibraryInfo, 12>
  getDeviceLibs(const llvm::opt::ArgList &Args, BoundArch BA,
                const Action::OffloadKind DeviceOffloadKind) const override;
 
  SanitizerMask
  getSupportedSanitizers(BoundArch BA,
                         Action::OffloadKind DeviceOffloadKind) const override;
 
  VersionTuple
  computeMSVCVersion(const Driver *D,
                     const llvm::opt::ArgList &Args) const override;
 
  void adjustDebugInfoKind(llvm::codegenoptions::DebugInfoKind &DebugInfoKind,
                           const llvm::opt::ArgList &Args) const override;
  bool IsMathErrnoDefault() const override { return false; }
  bool useIntegratedAs() const override { return true; }
  bool isCrossCompiling() const override { return true; }
  bool isPICDefault() const override { return false; }
  bool isPIEDefault(const llvm::opt::ArgList &Args) const override {
    return false;
  }
  bool isPICDefaultForced() const override { return false; }
  bool SupportsProfiling() const override { return false; }
 
  LTOKind getDefaultLTOMode() const override { return LTOK_Full; }
  LTOKind
  getLTOMode(const llvm::opt::ArgList &Args,
             Action::OffloadKind Kind = Action::OFK_None) const override;
 
  const ToolChain *HostTC = nullptr;
 
protected:
  Tool *buildLinker() const override;
};
 
} // end namespace toolchains
} // end namespace driver
} // end namespace clang
 
#endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_HIPSPV_H