1 //===--- OpenBSD.cpp - OpenBSD 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 "OpenBSD.h"
10 #include "Arch/Mips.h"
11 #include "Arch/Sparc.h"
12 #include "CommonArgs.h"
13 #include "clang/Config/config.h"
14 #include "clang/Driver/Compilation.h"
15 #include "clang/Driver/Options.h"
16 #include "clang/Driver/SanitizerArgs.h"
17 #include "llvm/Option/ArgList.h"
18 #include "llvm/Support/Path.h"
19 
20 using namespace clang::driver;
21 using namespace clang::driver::tools;
22 using namespace clang::driver::toolchains;
23 using namespace clang;
24 using namespace llvm::opt;
25 
26 void openbsd::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
27                                       const InputInfo &Output,
28                                       const InputInfoList &Inputs,
29                                       const ArgList &Args,
30                                       const char *LinkingOutput) const {
31   claimNoWarnArgs(Args);
32   ArgStringList CmdArgs;
33 
34   switch (getToolChain().getArch()) {
35   case llvm::Triple::x86:
36     // When building 32-bit code on OpenBSD/amd64, we have to explicitly
37     // instruct as in the base system to assemble 32-bit code.
38     CmdArgs.push_back("--32");
39     break;
40 
41   case llvm::Triple::ppc:
42     CmdArgs.push_back("-mppc");
43     CmdArgs.push_back("-many");
44     break;
45 
46   case llvm::Triple::sparcv9: {
47     CmdArgs.push_back("-64");
48     std::string CPU = getCPUName(getToolChain().getDriver(), Args,
49                                  getToolChain().getTriple());
50     CmdArgs.push_back(
51         sparc::getSparcAsmModeForCPU(CPU, getToolChain().getTriple()));
52     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
53     break;
54   }
55 
56   case llvm::Triple::mips64:
57   case llvm::Triple::mips64el: {
58     StringRef CPUName;
59     StringRef ABIName;
60     mips::getMipsCPUAndABI(Args, getToolChain().getTriple(), CPUName, ABIName);
61 
62     CmdArgs.push_back("-mabi");
63     CmdArgs.push_back(mips::getGnuCompatibleMipsABIName(ABIName).data());
64 
65     if (getToolChain().getTriple().isLittleEndian())
66       CmdArgs.push_back("-EL");
67     else
68       CmdArgs.push_back("-EB");
69 
70     AddAssemblerKPIC(getToolChain(), Args, CmdArgs);
71     break;
72   }
73 
74   default:
75     break;
76   }
77 
78   Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
79 
80   CmdArgs.push_back("-o");
81   CmdArgs.push_back(Output.getFilename());
82 
83   for (const auto &II : Inputs)
84     CmdArgs.push_back(II.getFilename());
85 
86   const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("as"));
87   C.addCommand(std::make_unique<Command>(JA, *this,
88                                          ResponseFileSupport::AtFileCurCP(),
89                                          Exec, CmdArgs, Inputs, Output));
90 }
91 
92 void openbsd::Linker::ConstructJob(Compilation &C, const JobAction &JA,
93                                    const InputInfo &Output,
94                                    const InputInfoList &Inputs,
95                                    const ArgList &Args,
96                                    const char *LinkingOutput) const {
97   const toolchains::OpenBSD &ToolChain =
98       static_cast<const toolchains::OpenBSD &>(getToolChain());
99   const Driver &D = getToolChain().getDriver();
100   ArgStringList CmdArgs;
101 
102   // Silence warning for "clang -g foo.o -o foo"
103   Args.ClaimAllArgs(options::OPT_g_Group);
104   // and "clang -emit-llvm foo.o -o foo"
105   Args.ClaimAllArgs(options::OPT_emit_llvm);
106   // and for "clang -w foo.o -o foo". Other warning options are already
107   // handled somewhere else.
108   Args.ClaimAllArgs(options::OPT_w);
109 
110   if (ToolChain.getArch() == llvm::Triple::mips64)
111     CmdArgs.push_back("-EB");
112   else if (ToolChain.getArch() == llvm::Triple::mips64el)
113     CmdArgs.push_back("-EL");
114 
115   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_shared)) {
116     CmdArgs.push_back("-e");
117     CmdArgs.push_back("__start");
118   }
119 
120   CmdArgs.push_back("--eh-frame-hdr");
121   if (Args.hasArg(options::OPT_static)) {
122     CmdArgs.push_back("-Bstatic");
123   } else {
124     if (Args.hasArg(options::OPT_rdynamic))
125       CmdArgs.push_back("-export-dynamic");
126     CmdArgs.push_back("-Bdynamic");
127     if (Args.hasArg(options::OPT_shared)) {
128       CmdArgs.push_back("-shared");
129     } else {
130       CmdArgs.push_back("-dynamic-linker");
131       CmdArgs.push_back("/usr/libexec/ld.so");
132     }
133   }
134 
135   if (Args.hasArg(options::OPT_pie))
136     CmdArgs.push_back("-pie");
137   if (Args.hasArg(options::OPT_nopie) || Args.hasArg(options::OPT_pg))
138     CmdArgs.push_back("-nopie");
139 
140   if (Output.isFilename()) {
141     CmdArgs.push_back("-o");
142     CmdArgs.push_back(Output.getFilename());
143   } else {
144     assert(Output.isNothing() && "Invalid output.");
145   }
146 
147   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
148     const char *crt0 = nullptr;
149     const char *crtbegin = nullptr;
150     if (!Args.hasArg(options::OPT_shared)) {
151       if (Args.hasArg(options::OPT_pg))
152         crt0 = "gcrt0.o";
153       else if (Args.hasArg(options::OPT_static) &&
154                !Args.hasArg(options::OPT_nopie))
155         crt0 = "rcrt0.o";
156       else
157         crt0 = "crt0.o";
158       crtbegin = "crtbegin.o";
159     } else {
160       crtbegin = "crtbeginS.o";
161     }
162 
163     if (crt0)
164       CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crt0)));
165     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtbegin)));
166   }
167 
168   Args.AddAllArgs(CmdArgs, options::OPT_L);
169   ToolChain.AddFilePathLibArgs(Args, CmdArgs);
170   Args.AddAllArgs(CmdArgs, {options::OPT_T_Group, options::OPT_e,
171                             options::OPT_s, options::OPT_t,
172                             options::OPT_Z_Flag, options::OPT_r});
173 
174   bool NeedsSanitizerDeps = addSanitizerRuntimes(ToolChain, Args, CmdArgs);
175   bool NeedsXRayDeps = addXRayRuntime(ToolChain, Args, CmdArgs);
176   AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
177 
178   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
179     if (D.CCCIsCXX()) {
180       if (ToolChain.ShouldLinkCXXStdlib(Args))
181         ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
182       if (Args.hasArg(options::OPT_pg))
183         CmdArgs.push_back("-lm_p");
184       else
185         CmdArgs.push_back("-lm");
186     }
187     if (NeedsSanitizerDeps) {
188       CmdArgs.push_back(ToolChain.getCompilerRTArgString(Args, "builtins"));
189       linkSanitizerRuntimeDeps(ToolChain, CmdArgs);
190     }
191     if (NeedsXRayDeps) {
192       CmdArgs.push_back(ToolChain.getCompilerRTArgString(Args, "builtins"));
193       linkXRayRuntimeDeps(ToolChain, CmdArgs);
194     }
195     // FIXME: For some reason GCC passes -lgcc before adding
196     // the default system libraries. Just mimic this for now.
197     CmdArgs.push_back("-lcompiler_rt");
198 
199     if (Args.hasArg(options::OPT_pthread)) {
200       if (!Args.hasArg(options::OPT_shared) && Args.hasArg(options::OPT_pg))
201         CmdArgs.push_back("-lpthread_p");
202       else
203         CmdArgs.push_back("-lpthread");
204     }
205 
206     if (!Args.hasArg(options::OPT_shared)) {
207       if (Args.hasArg(options::OPT_pg))
208         CmdArgs.push_back("-lc_p");
209       else
210         CmdArgs.push_back("-lc");
211     }
212 
213     CmdArgs.push_back("-lcompiler_rt");
214   }
215 
216   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
217     const char *crtend = nullptr;
218     if (!Args.hasArg(options::OPT_shared))
219       crtend = "crtend.o";
220     else
221       crtend = "crtendS.o";
222 
223     CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(crtend)));
224   }
225 
226   const char *Exec = Args.MakeArgString(ToolChain.GetLinkerPath());
227   C.addCommand(std::make_unique<Command>(JA, *this,
228                                          ResponseFileSupport::AtFileCurCP(),
229                                          Exec, CmdArgs, Inputs, Output));
230 }
231 
232 SanitizerMask OpenBSD::getSupportedSanitizers() const {
233   const bool IsX86 = getTriple().getArch() == llvm::Triple::x86;
234   const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
235 
236   // For future use, only UBsan at the moment
237   SanitizerMask Res = ToolChain::getSupportedSanitizers();
238 
239   if (IsX86 || IsX86_64) {
240     Res |= SanitizerKind::Vptr;
241     Res |= SanitizerKind::Fuzzer;
242     Res |= SanitizerKind::FuzzerNoLink;
243   }
244 
245   return Res;
246 }
247 
248 /// OpenBSD - OpenBSD tool chain which can call as(1) and ld(1) directly.
249 
250 OpenBSD::OpenBSD(const Driver &D, const llvm::Triple &Triple,
251                  const ArgList &Args)
252     : Generic_ELF(D, Triple, Args) {
253   getFilePaths().push_back(getDriver().SysRoot + "/usr/lib");
254 }
255 
256 void OpenBSD::AddClangSystemIncludeArgs(
257     const llvm::opt::ArgList &DriverArgs,
258     llvm::opt::ArgStringList &CC1Args) const {
259   const Driver &D = getDriver();
260 
261   if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))
262     return;
263 
264   if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
265     SmallString<128> Dir(D.ResourceDir);
266     llvm::sys::path::append(Dir, "include");
267     addSystemInclude(DriverArgs, CC1Args, Dir.str());
268   }
269 
270   if (DriverArgs.hasArg(options::OPT_nostdlibinc))
271     return;
272 
273   // Check for configure-time C include directories.
274   StringRef CIncludeDirs(C_INCLUDE_DIRS);
275   if (CIncludeDirs != "") {
276     SmallVector<StringRef, 5> dirs;
277     CIncludeDirs.split(dirs, ":");
278     for (StringRef dir : dirs) {
279       StringRef Prefix =
280           llvm::sys::path::is_absolute(dir) ? StringRef(D.SysRoot) : "";
281       addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
282     }
283     return;
284   }
285 
286   addExternCSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/usr/include");
287 }
288 
289 void OpenBSD::addLibCxxIncludePaths(const llvm::opt::ArgList &DriverArgs,
290                                     llvm::opt::ArgStringList &CC1Args) const {
291   addSystemInclude(DriverArgs, CC1Args,
292                    getDriver().SysRoot + "/usr/include/c++/v1");
293 }
294 
295 void OpenBSD::AddCXXStdlibLibArgs(const ArgList &Args,
296                                   ArgStringList &CmdArgs) const {
297   bool Profiling = Args.hasArg(options::OPT_pg);
298 
299   CmdArgs.push_back(Profiling ? "-lc++_p" : "-lc++");
300   CmdArgs.push_back(Profiling ? "-lc++abi_p" : "-lc++abi");
301   CmdArgs.push_back(Profiling ? "-lpthread_p" : "-lpthread");
302 }
303 
304 std::string OpenBSD::getCompilerRT(const ArgList &Args,
305                                    StringRef Component,
306                                    FileType Type) const {
307   SmallString<128> Path(getDriver().SysRoot);
308   llvm::sys::path::append(Path, "/usr/lib/libcompiler_rt.a");
309   return std::string(Path.str());
310 }
311 
312 Tool *OpenBSD::buildAssembler() const {
313   return new tools::openbsd::Assembler(*this);
314 }
315 
316 Tool *OpenBSD::buildLinker() const { return new tools::openbsd::Linker(*this); }
317 
318 bool OpenBSD::HasNativeLLVMSupport() const { return true; }
319