clang  15.0.0git
CSKYToolChain.cpp
Go to the documentation of this file.
1 //===--- CSKYToolchain.cpp - CSKY 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 "CSKYToolChain.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 /// CSKY Toolchain
35 CSKYToolChain::CSKYToolChain(const Driver &D, const llvm::Triple &Triple,
36  const ArgList &Args)
37  : Generic_ELF(D, Triple, Args) {
38  GCCInstallation.init(Triple, Args);
39  if (GCCInstallation.isValid()) {
42  path_list &Paths = getFilePaths();
43  // Add toolchain/multilib specific file paths.
46  getFilePaths().push_back(GCCInstallation.getInstallPath().str() +
49  // Multilib cross-compiler GCC installations put ld in a triple-prefixed
50  // directory off of the parent of the GCC installation.
51  PPaths.push_back(Twine(GCCInstallation.getParentLibPath() + "/../" +
52  GCCInstallation.getTriple().str() + "/bin")
53  .str());
54  PPaths.push_back((GCCInstallation.getParentLibPath() + "/../bin").str());
55  } else {
56  getProgramPaths().push_back(D.Dir);
57  }
58  getFilePaths().push_back(computeSysRoot() + "/lib" +
60 }
61 
63  return new tools::CSKY::Linker(*this);
64 }
65 
69 }
70 
72 CSKYToolChain::GetUnwindLibType(const llvm::opt::ArgList &Args) const {
73  return ToolChain::UNW_None;
74 }
75 
76 void CSKYToolChain::addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
77  llvm::opt::ArgStringList &CC1Args,
78  Action::OffloadKind) const {
79  CC1Args.push_back("-nostdsysteminc");
80 }
81 
82 void CSKYToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
83  ArgStringList &CC1Args) const {
84  if (DriverArgs.hasArg(options::OPT_nostdinc))
85  return;
86 
87  if (!DriverArgs.hasArg(options::OPT_nostdlibinc)) {
88  SmallString<128> Dir(computeSysRoot());
89  llvm::sys::path::append(Dir, "include");
90  addSystemInclude(DriverArgs, CC1Args, Dir.str());
91  SmallString<128> Dir2(computeSysRoot());
92  llvm::sys::path::append(Dir2, "sys-include");
93  addSystemInclude(DriverArgs, CC1Args, Dir2.str());
94  }
95 }
96 
98  const llvm::opt::ArgList &DriverArgs,
99  llvm::opt::ArgStringList &CC1Args) const {
100  const GCCVersion &Version = GCCInstallation.getVersion();
101  StringRef TripleStr = GCCInstallation.getTriple().str();
103  addLibStdCXXIncludePaths(computeSysRoot() + "/include/c++/" + Version.Text,
104  TripleStr, Multilib.includeSuffix(), DriverArgs,
105  CC1Args);
106 }
107 
108 std::string CSKYToolChain::computeSysRoot() const {
109  if (!getDriver().SysRoot.empty())
110  return getDriver().SysRoot;
111 
112  SmallString<128> SysRootDir;
113  if (GCCInstallation.isValid()) {
114  StringRef LibDir = GCCInstallation.getParentLibPath();
115  StringRef TripleStr = GCCInstallation.getTriple().str();
116  llvm::sys::path::append(SysRootDir, LibDir, "..", TripleStr);
117  } else {
118  // Use the triple as provided to the driver. Unlike the parsed triple
119  // this has not been normalized to always contain every field.
120  llvm::sys::path::append(SysRootDir, getDriver().Dir, "..",
121  getDriver().getTargetTriple());
122  }
123 
124  if (!llvm::sys::fs::exists(SysRootDir))
125  return std::string();
126 
127  return std::string(SysRootDir.str());
128 }
129 
130 void CSKY::Linker::ConstructJob(Compilation &C, const JobAction &JA,
131  const InputInfo &Output,
132  const InputInfoList &Inputs,
133  const ArgList &Args,
134  const char *LinkingOutput) const {
135  const ToolChain &ToolChain = getToolChain();
136  const Driver &D = ToolChain.getDriver();
137  ArgStringList CmdArgs;
138 
139  if (!D.SysRoot.empty())
140  CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
141 
142  CmdArgs.push_back("-m");
143  CmdArgs.push_back("cskyelf");
144 
145  std::string Linker = getToolChain().GetLinkerPath();
146 
147  bool WantCRTs =
148  !Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles);
149 
150  const char *crtbegin, *crtend;
151  auto RuntimeLib = ToolChain.GetRuntimeLibType(Args);
152  if (RuntimeLib == ToolChain::RLT_Libgcc) {
153  crtbegin = "crtbegin.o";
154  crtend = "crtend.o";
155  } else {
156  assert(RuntimeLib == ToolChain::RLT_CompilerRT);
157  crtbegin = ToolChain.getCompilerRTArgString(Args, "crtbegin",
159  crtend =
161  }
162 
163  if (WantCRTs) {
164  CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crt0.o")));
165  CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crti.o")));
166  CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));
167  }
168 
169  Args.AddAllArgs(CmdArgs, options::OPT_L);
170  ToolChain.AddFilePathLibArgs(Args, CmdArgs);
171  Args.AddAllArgs(CmdArgs,
172  {options::OPT_T_Group, options::OPT_e, options::OPT_s,
173  options::OPT_t, options::OPT_Z_Flag, options::OPT_r});
174 
175  AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
176 
177  // TODO: add C++ includes and libs if compiling C++.
178 
179  if (!Args.hasArg(options::OPT_nostdlib) &&
180  !Args.hasArg(options::OPT_nodefaultlibs)) {
181  if (ToolChain.ShouldLinkCXXStdlib(Args))
182  ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
183  CmdArgs.push_back("--start-group");
184  CmdArgs.push_back("-lc");
185  if (Args.hasArg(options::OPT_msim))
186  CmdArgs.push_back("-lsemi");
187  else
188  CmdArgs.push_back("-lnosys");
189  CmdArgs.push_back("--end-group");
190  AddRunTimeLibs(ToolChain, ToolChain.getDriver(), CmdArgs, Args);
191  }
192 
193  if (WantCRTs) {
194  CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtend)));
195  CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath("crtn.o")));
196  }
197 
198  CmdArgs.push_back("-o");
199  CmdArgs.push_back(Output.getFilename());
200  C.addCommand(std::make_unique<Command>(
201  JA, *this, ResponseFileSupport::AtFileCurCP(), Args.MakeArgString(Linker),
202  CmdArgs, Inputs, Output));
203 }
204 // CSKY tools end.
clang::driver::toolchains
Definition: AIX.h:55
clang::driver::toolchains::CSKYToolChain::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: CSKYToolChain.cpp:76
clang::driver::ToolChain::getProgramPaths
path_list & getProgramPaths()
Definition: ToolChain.h:269
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:150
clang::driver::MultilibSet
Definition: Multilib.h:114
llvm::SmallVector< std::string, 16 >
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:228
addMultilibsFilePaths
static void addMultilibsFilePaths(const Driver &D, const MultilibSet &Multilibs, const Multilib &Multilib, StringRef InstallPath, ToolChain::path_list &Paths)
Definition: CSKYToolChain.cpp:25
clang::driver::ToolChain::FT_Object
@ FT_Object
Definition: ToolChain.h:123
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::isValid
bool isValid() const
Check whether we detected a valid GCC install.
Definition: Gnu.h:224
CSKYToolChain.h
clang::driver::ToolChain::GetFilePath
std::string GetFilePath(const char *Name) const
Definition: ToolChain.cpp:605
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::init
void init(const llvm::Triple &TargetTriple, const llvm::opt::ArgList &Args, ArrayRef< std::string > ExtraTripleAliases=None)
Initialize a GCCInstallationDetector from the driver.
Definition: Gnu.cpp:1971
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:266
clang::driver::Tool
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
clang::driver::toolchains::Generic_ELF
Definition: Gnu.h:362
Options.h
clang::driver::toolchains::Generic_GCC::GCCVersion::Text
std::string Text
The unparsed text of the version.
Definition: Gnu.h:163
clang::driver::Multilib::osSuffix
const std::string & osSuffix() const
Get the detected os path suffix for the multi-arch target variant.
Definition: Multilib.h:56
clang::driver::ToolChain::UNW_None
@ UNW_None
Definition: ToolChain.h:106
clang::driver::tools::CSKY::Linker
Definition: CSKYToolChain.h:47
llvm::opt
Definition: DiagnosticOptions.h:19
clang::driver::ResponseFileSupport::AtFileCurCP
static constexpr ResponseFileSupport AtFileCurCP()
Definition: Job.h:92
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:122
llvm::SmallString< 128 >
clang::driver::ToolChain::SelectedMultilib
Multilib SelectedMultilib
Definition: ToolChain.h:186
clang::driver::Driver::SysRoot
std::string SysRoot
sysroot, if present
Definition: Driver.h:178
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::MultilibSet::filePathsCallback
const IncludeDirsFunc & filePathsCallback() const
Definition: Multilib.h:186
clang::driver::toolchains::CSKYToolChain::AddClangSystemIncludeArgs
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition: CSKYToolChain.cpp:82
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:1024
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:1001
clang::driver::toolchains::CSKYToolChain::GetDefaultRuntimeLibType
RuntimeLibType GetDefaultRuntimeLibType() const override
GetDefaultRuntimeLibType - Get the default runtime library variant to use.
Definition: CSKYToolChain.cpp:66
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:1007
clang::driver::ToolChain::GetRuntimeLibType
virtual RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const
Definition: ToolChain.cpp:818
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:532
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::toolchains::CSKYToolChain::CSKYToolChain
CSKYToolChain(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
CSKY Toolchain.
Definition: CSKYToolChain.cpp:35
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::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:3047
clang::driver::toolchains::CSKYToolChain::addLibStdCxxIncludePaths
void addLibStdCxxIncludePaths(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Definition: CSKYToolChain.cpp:97
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:72
clang::driver::toolchains::Generic_GCC::GCCInstallationDetector::getMultilib
const Multilib & getMultilib() const
Get the detected Multilib.
Definition: Gnu.h:236
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:185
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:88
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:906
clang::driver::JobAction
Definition: Action.h:395
clang::driver::toolchains::CSKYToolChain::buildLinker
Tool * buildLinker() const override
Definition: CSKYToolChain.cpp:62
clang::driver::toolchains::CSKYToolChain::GetUnwindLibType
UnwindLibType GetUnwindLibType(const llvm::opt::ArgList &Args) const override
Definition: CSKYToolChain.cpp:72