clang  16.0.0git
RISCVToolchain.cpp
Go to the documentation of this file.
1 //===--- RISCVToolchain.cpp - RISCV 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"
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.
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 /// RISCV 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()) {
57  path_list &Paths = getFilePaths();
58  // Add toolchain/multilib specific file paths.
61  getFilePaths().push_back(GCCInstallation.getInstallPath().str());
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 
76  return new tools::RISCV::Linker(*this);
77 }
78 
80  return GCCInstallation.isValid() ?
82 }
83 
85 RISCVToolChain::GetUnwindLibType(const llvm::opt::ArgList &Args) const {
86  return ToolChain::UNW_None;
87 }
88 
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 
115  const llvm::opt::ArgList &DriverArgs,
116  llvm::opt::ArgStringList &CC1Args) const {
117  const GCCVersion &Version = GCCInstallation.getVersion();
118  StringRef TripleStr = GCCInstallation.getTriple().str();
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",
182  crtend = ToolChain.getCompilerRTArgString(Args, "crtend",
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);
194  Args.AddAllArgs(CmdArgs, options::OPT_u);
195  ToolChain.AddFilePathLibArgs(Args, CmdArgs);
196  Args.AddAllArgs(CmdArgs,
197  {options::OPT_T_Group, options::OPT_e, options::OPT_s,
198  options::OPT_t, options::OPT_Z_Flag, options::OPT_r});
199 
200  // TODO: add C++ includes and libs if compiling C++.
201 
202  if (!Args.hasArg(options::OPT_nostdlib) &&
203  !Args.hasArg(options::OPT_nodefaultlibs)) {
204  if (D.CCCIsCXX()) {
205  if (ToolChain.ShouldLinkCXXStdlib(Args))
206  ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
207  CmdArgs.push_back("-lm");
208  }
209  CmdArgs.push_back("--start-group");
210  CmdArgs.push_back("-lc");
211  CmdArgs.push_back("-lgloss");
212  CmdArgs.push_back("--end-group");
213  AddRunTimeLibs(ToolChain, ToolChain.getDriver(), CmdArgs, Args);
214  }
215 
216  if (WantCRTs)
217  CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtend)));
218 
219  CmdArgs.push_back("-o");
220  CmdArgs.push_back(Output.getFilename());
221  C.addCommand(std::make_unique<Command>(
222  JA, *this, ResponseFileSupport::AtFileCurCP(), Args.MakeArgString(Linker),
223  CmdArgs, Inputs, Output));
224 }
225 // RISCV tools end.
clang::driver::toolchains::RISCVToolChain::hasGCCToolchain
static bool hasGCCToolchain(const Driver &D, const llvm::opt::ArgList &Args)
Definition: RISCVToolchain.cpp:38
clang::driver::toolchains::RISCVToolChain::GetUnwindLibType
UnwindLibType GetUnwindLibType(const llvm::opt::ArgList &Args) const override
Definition: RISCVToolchain.cpp:85
clang::driver::toolchains
Definition: AIX.h:55
clang::driver::ToolChain::getProgramPaths
path_list & getProgramPaths()
Definition: ToolChain.h:277
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::driver::Driver::Dir
std::string Dir
The path the driver executable was in, as invoked from the command line.
Definition: Driver.h:153
clang::driver::MultilibSet
Definition: Multilib.h:114
llvm::SmallVector
Definition: LLVM.h:38
clang::driver::toolchains::Generic_GCC::GCCInstallation
GCCInstallationDetector GCCInstallation
Definition: Gnu.h:288
clang::driver::tools
Definition: AIX.h:17
clang::driver::ToolChain::getDriver
const Driver & getDriver() const
Definition: ToolChain.h:232
clang::driver::ToolChain::FT_Object
@ FT_Object
Definition: ToolChain.h:129
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::isValid
bool isValid() const
Check whether we detected a valid GCC install.
Definition: Gnu.h:224
clang::driver::toolchains::RISCVToolChain::addLibStdCxxIncludePaths
void addLibStdCxxIncludePaths(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Definition: RISCVToolchain.cpp:114
clang::driver::ToolChain::GetFilePath
std::string GetFilePath(const char *Name) const
Definition: ToolChain.cpp:610
clang::driver::InputInfo
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
clang::driver::ToolChain::RuntimeLibType
RuntimeLibType
Definition: ToolChain.h:100
InputInfo.h
clang::driver::tools::AddLinkerInputs
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
clang::driver::toolchains::Generic_GCC::GCCVersion
Struct to store and manipulate GCC versions.
Definition: Gnu.h:161
clang::driver::ToolChain::getFilePaths
path_list & getFilePaths()
Definition: ToolChain.h:274
RISCVToolchain.h
clang::driver::Tool
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
clang::driver::toolchains::Generic_ELF
Definition: Gnu.h:363
Options.h
clang::driver::toolchains::Generic_GCC::GCCVersion::Text
std::string Text
The unparsed text of the version.
Definition: Gnu.h:163
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::init
void init(const llvm::Triple &TargetTriple, const llvm::opt::ArgList &Args, ArrayRef< std::string > ExtraTripleAliases=std::nullopt)
Initialize a GCCInstallationDetector from the driver.
Definition: Gnu.cpp:1998
clang::driver::ToolChain::UNW_None
@ UNW_None
Definition: ToolChain.h:106
llvm::opt
Definition: DiagnosticOptions.h:19
clang::driver::ResponseFileSupport::AtFileCurCP
static constexpr ResponseFileSupport AtFileCurCP()
Definition: Job.h:92
clang::driver::toolchains::RISCVToolChain::AddClangSystemIncludeArgs
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition: RISCVToolchain.cpp:96
clang::driver::ToolChain::RLT_Libgcc
@ RLT_Libgcc
Definition: ToolChain.h:102
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::getTriple
const llvm::Triple & getTriple() const
Get the GCC triple for the detected install.
Definition: Gnu.h:227
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::getParentLibPath
StringRef getParentLibPath() const
Get the detected GCC parent lib path.
Definition: Gnu.h:233
clang::driver::tools::addPathIfExists
void addPathIfExists(const Driver &D, const Twine &Path, ToolChain::path_list &Paths)
Definition: CommonArgs.cpp:134
llvm::SmallString< 128 >
clang::driver::ToolChain::SelectedMultilib
Multilib SelectedMultilib
Definition: ToolChain.h:190
clang::driver::Driver::SysRoot
std::string SysRoot
sysroot, if present
Definition: Driver.h:181
clang::driver::Multilib
This corresponds to a single GCC Multilib, or a segment of one controlled by a command line flag.
Definition: Multilib.h:28
clang::driver::Driver::CCCIsCXX
bool CCCIsCXX() const
Whether the driver should follow g++ like behavior.
Definition: Driver.h:211
clang::driver::MultilibSet::filePathsCallback
const IncludeDirsFunc & filePathsCallback() const
Definition: Multilib.h:186
clang::driver::toolchains::RISCVToolChain::buildLinker
Tool * buildLinker() const override
Definition: RISCVToolchain.cpp:75
clang::driver::ToolChain::getArch
llvm::Triple::ArchType getArch() const
Definition: ToolChain.h:248
addMultilibsFilePaths
static void addMultilibsFilePaths(const Driver &D, const MultilibSet &Multilibs, const Multilib &Multilib, StringRef InstallPath, ToolChain::path_list &Paths)
Definition: RISCVToolchain.cpp:25
clang::driver::ToolChain::AddFilePathLibArgs
void AddFilePathLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
AddFilePathLibArgs - Add each thing in getFilePaths() as a "-L" option.
Definition: ToolChain.cpp:1046
clang::driver::ToolChain::ShouldLinkCXXStdlib
bool ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const
Returns if the C++ standard library should be linked in.
Definition: ToolChain.cpp:1021
clang::driver::ToolChain::AddCXXStdlibLibArgs
virtual void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
AddCXXStdlibLibArgs - Add the system specific linker arguments to use for the given C++ standard libr...
Definition: ToolChain.cpp:1027
clang::driver::ToolChain::GetRuntimeLibType
virtual RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const
Definition: ToolChain.cpp:831
Compilation.h
clang::driver::ToolChain::getCompilerRTArgString
const char * getCompilerRTArgString(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:537
clang::driver::ToolChain
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:91
clang::driver::ToolChain::RLT_CompilerRT
@ RLT_CompilerRT
Definition: ToolChain.h:101
clang::driver::tools::AddRunTimeLibs
void AddRunTimeLibs(const ToolChain &TC, const Driver &D, llvm::opt::ArgStringList &CmdArgs, const llvm::opt::ArgList &Args)
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::getInstallPath
StringRef getInstallPath() const
Get the detected GCC installation path.
Definition: Gnu.h:230
clang::driver::Compilation
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::getVersion
const GCCVersion & getVersion() const
Get the detected GCC version string.
Definition: Gnu.h:246
clang::driver::toolchains::RISCVToolChain::addClangTargetOptions
void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, Action::OffloadKind) const override
Add options that need to be passed to cc1 for this target.
Definition: RISCVToolchain.cpp:89
clang::driver::tools::RISCV::Linker
Definition: RISCVToolchain.h:49
clang::driver::toolchains::Generic_GCC::addLibStdCXXIncludePaths
bool addLibStdCXXIncludePaths(Twine IncludeDir, StringRef Triple, Twine IncludeSuffix, const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, bool DetectDebian=false) const
Definition: Gnu.cpp:3098
clang::driver::InputInfo::getFilename
const char * getFilename() const
Definition: InputInfo.h:83
CommonArgs.h
clang
Definition: CalledOnceCheck.h:17
clang::driver::Driver
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:75
clang::driver::Driver::getTargetTriple
std::string getTargetTriple() const
Definition: Driver.h:383
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::getMultilib
const Multilib & getMultilib() const
Get the detected Multilib.
Definition: Gnu.h:236
clang::driver::toolchains::RISCVToolChain::GetDefaultRuntimeLibType
RuntimeLibType GetDefaultRuntimeLibType() const override
GetDefaultRuntimeLibType - Get the default runtime library variant to use.
Definition: RISCVToolchain.cpp:79
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::getMultilibs
const MultilibSet & getMultilibs() const
Get the whole MultilibSet.
Definition: Gnu.h:239
clang::driver::ToolChain::Multilibs
MultilibSet Multilibs
Definition: ToolChain.h:189
clang::driver::ToolChain::UnwindLibType
UnwindLibType
Definition: ToolChain.h:105
clang::driver::Multilib::includeSuffix
const std::string & includeSuffix() const
Get the include directory suffix.
Definition: Multilib.h:67
clang::driver::Action::OffloadKind
OffloadKind
Definition: Action.h:86
clang::driver
Definition: Action.h:31
clang::driver::ToolChain::addSystemInclude
static void addSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory to CC1 arguments.
Definition: ToolChain.cpp:919
clang::driver::JobAction
Definition: Action.h:398
clang::driver::toolchains::RISCVToolChain::RISCVToolChain
RISCVToolChain(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
RISCV Toolchain.
Definition: RISCVToolchain.cpp:50