clang/lib/Driver/ToolChains/RISCVToolchain.cpp

   1 //===--- RISCVToolchain.cpp - RISC-V ToolChain Implementations --*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "RISCVToolchain.h"
  10 #include "CommonArgs.h"
  11 #include "clang/Driver/Compilation.h"
  12 #include "clang/Driver/InputInfo.h"
  13 #include "clang/Driver/Options.h"
  14 #include "llvm/Option/ArgList.h"
  15 #include "llvm/Support/FileSystem.h"
  16 #include "llvm/Support/Path.h"
  17 #include "llvm/Support/raw_ostream.h"
  18
  19 using namespace clang::driver;
  20 using namespace clang::driver::toolchains;
  21 using namespace clang::driver::tools;
  22 using namespace clang;
  23 using namespace llvm::opt;
  24
  25 static void addMultilibsFilePaths(const Driver &D, const MultilibSet &Multilibs,
  26                                   const Multilib &Multilib,
  27                                   StringRef InstallPath,
  28                                   ToolChain::path_list &Paths) {
  29   if (const auto &PathsCallback = Multilibs.filePathsCallback())
  30     for (const auto &Path : PathsCallback(Multilib))
  31       addPathIfExists(D, InstallPath + Path, Paths);
  32 }
  33
  34 // This function tests whether a gcc installation is present either
  35 // through gcc-toolchain argument or in the same prefix where clang
  36 // is installed. This helps decide whether to instantiate this toolchain
  37 // or Baremetal toolchain.
  38 bool RISCVToolChain::hasGCCToolchain(const Driver &D,
  39                                      const llvm::opt::ArgList &Args) {
  40   if (Args.getLastArg(options::OPT_gcc_toolchain))
  41     return true;
  42
  43   SmallString<128> GCCDir;
  44   llvm::sys::path::append(GCCDir, D.Dir, "..", D.getTargetTriple(),
  45                           "lib/crt0.o");
  46   return llvm::sys::fs::exists(GCCDir);
  47 }
  48
  49 /// RISC-V Toolchain
  50 RISCVToolChain::RISCVToolChain(const Driver &D, const llvm::Triple &Triple,
  51                                const ArgList &Args)
  52     : Generic_ELF(D, Triple, Args) {
  53   GCCInstallation.init(Triple, Args);
  54   if (GCCInstallation.isValid()) {
  55     Multilibs = GCCInstallation.getMultilibs();
  56     SelectedMultilibs.assign({GCCInstallation.getMultilib()});
  57     path_list &Paths = getFilePaths();
  58     // Add toolchain/multilib specific file paths.
  59     addMultilibsFilePaths(D, Multilibs, SelectedMultilibs.back(),
  60                           GCCInstallation.getInstallPath(), Paths);
  61     getFilePaths().push_back(GCCInstallation.getInstallPath().str());
  62     ToolChain::path_list &PPaths = getProgramPaths();
  63     // Multilib cross-compiler GCC installations put ld in a triple-prefixed
  64     // directory off of the parent of the GCC installation.
  65     PPaths.push_back(Twine(GCCInstallation.getParentLibPath() + "/../" +
  66                            GCCInstallation.getTriple().str() + "/bin")
  67                          .str());
  68     PPaths.push_back((GCCInstallation.getParentLibPath() + "/../bin").str());
  69   } else {
  70     getProgramPaths().push_back(D.Dir);
  71   }
  72   getFilePaths().push_back(computeSysRoot() + "/lib");
  73 }
  74
  75 Tool *RISCVToolChain::buildLinker() const {
  76   return new tools::RISCV::Linker(*this);
  77 }
  78
  79 ToolChain::RuntimeLibType RISCVToolChain::GetDefaultRuntimeLibType() const {
  80   return GCCInstallation.isValid() ?
  81     ToolChain::RLT_Libgcc : ToolChain::RLT_CompilerRT;
  82 }
  83
  84 ToolChain::UnwindLibType
  85 RISCVToolChain::GetUnwindLibType(const llvm::opt::ArgList &Args) const {
  86   return ToolChain::UNW_None;
  87 }
  88
  89 void RISCVToolChain::addClangTargetOptions(
  90     const llvm::opt::ArgList &DriverArgs,
  91     llvm::opt::ArgStringList &CC1Args,
  92     Action::OffloadKind) const {
  93   CC1Args.push_back("-nostdsysteminc");
  94 }
  95
  96 void RISCVToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
  97                                                ArgStringList &CC1Args) const {
  98   if (DriverArgs.hasArg(options::OPT_nostdinc))
  99     return;
 100
 101   if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
 102     SmallString<128> Dir(getDriver().ResourceDir);
 103     llvm::sys::path::append(Dir, "include");
 104     addSystemInclude(DriverArgs, CC1Args, Dir.str());
 105   }
 106
 107   if (!DriverArgs.hasArg(options::OPT_nostdlibinc)) {
 108     SmallString<128> Dir(computeSysRoot());
 109     llvm::sys::path::append(Dir, "include");
 110     addSystemInclude(DriverArgs, CC1Args, Dir.str());
 111   }
 112 }
 113
 114 void RISCVToolChain::addLibStdCxxIncludePaths(
 115     const llvm::opt::ArgList &DriverArgs,
 116     llvm::opt::ArgStringList &CC1Args) const {
 117   const GCCVersion &Version = GCCInstallation.getVersion();
 118   StringRef TripleStr = GCCInstallation.getTriple().str();
 119   const Multilib &Multilib = GCCInstallation.getMultilib();
 120   addLibStdCXXIncludePaths(computeSysRoot() + "/include/c++/" + Version.Text,
 121                            TripleStr, Multilib.includeSuffix(), DriverArgs,
 122                            CC1Args);
 123 }
 124
 125 std::string RISCVToolChain::computeSysRoot() const {
 126   if (!getDriver().SysRoot.empty())
 127     return getDriver().SysRoot;
 128
 129   SmallString<128> SysRootDir;
 130   if (GCCInstallation.isValid()) {
 131     StringRef LibDir = GCCInstallation.getParentLibPath();
 132     StringRef TripleStr = GCCInstallation.getTriple().str();
 133     llvm::sys::path::append(SysRootDir, LibDir, "..", TripleStr);
 134   } else {
 135     // Use the triple as provided to the driver. Unlike the parsed triple
 136     // this has not been normalized to always contain every field.
 137     llvm::sys::path::append(SysRootDir, getDriver().Dir, "..",
 138                             getDriver().getTargetTriple());
 139   }
 140
 141   if (!llvm::sys::fs::exists(SysRootDir))
 142     return std::string();
 143
 144   return std::string(SysRootDir.str());
 145 }
 146
 147 void RISCV::Linker::ConstructJob(Compilation &C, const JobAction &JA,
 148                                  const InputInfo &Output,
 149                                  const InputInfoList &Inputs,
 150                                  const ArgList &Args,
 151                                  const char *LinkingOutput) const {
 152   const ToolChain &ToolChain = getToolChain();
 153   const Driver &D = ToolChain.getDriver();
 154   ArgStringList CmdArgs;
 155
 156   if (!D.SysRoot.empty())
 157     CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
 158
 159   bool IsRV64 = ToolChain.getArch() == llvm::Triple::riscv64;
 160   CmdArgs.push_back("-m");
 161   if (IsRV64) {
 162     CmdArgs.push_back("elf64lriscv");
 163   } else {
 164     CmdArgs.push_back("elf32lriscv");
 165   }
 166   CmdArgs.push_back("-X");
 167
 168   std::string Linker = getToolChain().GetLinkerPath();
 169
 170   bool WantCRTs =
 171       !Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles);
 172
 173   const char *crtbegin, *crtend;
 174   auto RuntimeLib = ToolChain.GetRuntimeLibType(Args);
 175   if (RuntimeLib == ToolChain::RLT_Libgcc) {
 176     crtbegin = "crtbegin.o";
 177     crtend = "crtend.o";
 178   } else {
 179     assert (RuntimeLib == ToolChain::RLT_CompilerRT);
 180     crtbegin = ToolChain.getCompilerRTArgString(Args, "crtbegin",
 181                                                 ToolChain::FT_Object);
 182     crtend = ToolChain.getCompilerRTArgString(Args, "crtend",
 183                                               ToolChain::FT_Object);
 184   }
 185
 186   if (WantCRTs) {
 187     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crt0.o")));
 188     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));
 189   }
 190
 191   AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
 192
 193   Args.addAllArgs(CmdArgs, {options::OPT_L, options::OPT_u});
 194
 195   ToolChain.AddFilePathLibArgs(Args, CmdArgs);
 196   Args.addAllArgs(CmdArgs, {options::OPT_T_Group, options::OPT_s,
 197                             options::OPT_t, options::OPT_r});
 198
 199   // TODO: add C++ includes and libs if compiling C++.
 200
 201   if (!Args.hasArg(options::OPT_nostdlib) &&
 202       !Args.hasArg(options::OPT_nodefaultlibs)) {
 203     if (D.CCCIsCXX()) {
 204       if (ToolChain.ShouldLinkCXXStdlib(Args))
 205         ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
 206       CmdArgs.push_back("-lm");
 207     }
 208     CmdArgs.push_back("--start-group");
 209     CmdArgs.push_back("-lc");
 210     CmdArgs.push_back("-lgloss");
 211     CmdArgs.push_back("--end-group");
 212     AddRunTimeLibs(ToolChain, ToolChain.getDriver(), CmdArgs, Args);
 213   }
 214
 215   if (WantCRTs)
 216     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtend)));
 217
 218   CmdArgs.push_back("-o");
 219   CmdArgs.push_back(Output.getFilename());
 220   C.addCommand(std::make_unique<Command>(
 221       JA, *this, ResponseFileSupport::AtFileCurCP(), Args.MakeArgString(Linker),
 222       CmdArgs, Inputs, Output));
 223 }
 224 // RISCV tools end.