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