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