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