1 //===--- PS4CPU.cpp - PS4CPU 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 "PS4CPU.h"
10 #include "CommonArgs.h"
11 #include "clang/Driver/Compilation.h"
12 #include "clang/Driver/Driver.h"
13 #include "clang/Driver/DriverDiagnostic.h"
14 #include "clang/Driver/Options.h"
15 #include "clang/Driver/SanitizerArgs.h"
16 #include "llvm/Option/ArgList.h"
17 #include "llvm/Support/FileSystem.h"
18 #include "llvm/Support/Path.h"
19 #include <cstdlib> // ::getenv
20 
21 using namespace clang::driver;
22 using namespace clang;
23 using namespace llvm::opt;
24 
25 // Helper to paste bits of an option together and return a saved string.
makeArgString(const ArgList & Args,const char * Prefix,const char * Base,const char * Suffix)26 static const char *makeArgString(const ArgList &Args, const char *Prefix,
27                                  const char *Base, const char *Suffix) {
28   // Basically "Prefix + Base + Suffix" all converted to Twine then saved.
29   return Args.MakeArgString(Twine(StringRef(Prefix), Base) + Suffix);
30 }
31 
addProfileRTArgs(const ToolChain & TC,const ArgList & Args,ArgStringList & CmdArgs)32 void tools::PScpu::addProfileRTArgs(const ToolChain &TC, const ArgList &Args,
33                                     ArgStringList &CmdArgs) {
34   assert(TC.getTriple().isPS());
35   auto &PSTC = static_cast<const toolchains::PS4PS5Base &>(TC);
36 
37   if ((Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,
38                     false) ||
39        Args.hasFlag(options::OPT_fprofile_generate,
40                     options::OPT_fno_profile_generate, false) ||
41        Args.hasFlag(options::OPT_fprofile_generate_EQ,
42                     options::OPT_fno_profile_generate, false) ||
43        Args.hasFlag(options::OPT_fprofile_instr_generate,
44                     options::OPT_fno_profile_instr_generate, false) ||
45        Args.hasFlag(options::OPT_fprofile_instr_generate_EQ,
46                     options::OPT_fno_profile_instr_generate, false) ||
47        Args.hasFlag(options::OPT_fcs_profile_generate,
48                     options::OPT_fno_profile_generate, false) ||
49        Args.hasFlag(options::OPT_fcs_profile_generate_EQ,
50                     options::OPT_fno_profile_generate, false) ||
51        Args.hasArg(options::OPT_fcreate_profile) ||
52        Args.hasArg(options::OPT_coverage)))
53     CmdArgs.push_back(makeArgString(
54         Args, "--dependent-lib=", PSTC.getProfileRTLibName(), ""));
55 }
56 
ConstructJob(Compilation & C,const JobAction & JA,const InputInfo & Output,const InputInfoList & Inputs,const ArgList & Args,const char * LinkingOutput) const57 void tools::PScpu::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
58                                            const InputInfo &Output,
59                                            const InputInfoList &Inputs,
60                                            const ArgList &Args,
61                                            const char *LinkingOutput) const {
62   auto &TC = static_cast<const toolchains::PS4PS5Base &>(getToolChain());
63   claimNoWarnArgs(Args);
64   ArgStringList CmdArgs;
65 
66   Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
67 
68   CmdArgs.push_back("-o");
69   CmdArgs.push_back(Output.getFilename());
70 
71   assert(Inputs.size() == 1 && "Unexpected number of inputs.");
72   const InputInfo &Input = Inputs[0];
73   assert(Input.isFilename() && "Invalid input.");
74   CmdArgs.push_back(Input.getFilename());
75 
76   std::string AsName = TC.qualifyPSCmdName("as");
77   const char *Exec = Args.MakeArgString(TC.GetProgramPath(AsName.c_str()));
78   C.addCommand(std::make_unique<Command>(JA, *this,
79                                          ResponseFileSupport::AtFileUTF8(),
80                                          Exec, CmdArgs, Inputs, Output));
81 }
82 
addSanitizerArgs(const ToolChain & TC,const ArgList & Args,ArgStringList & CmdArgs)83 void tools::PScpu::addSanitizerArgs(const ToolChain &TC, const ArgList &Args,
84                                     ArgStringList &CmdArgs) {
85   assert(TC.getTriple().isPS());
86   auto &PSTC = static_cast<const toolchains::PS4PS5Base &>(TC);
87   PSTC.addSanitizerArgs(Args, CmdArgs, "--dependent-lib=lib", ".a");
88 }
89 
addSanitizerArgs(const ArgList & Args,ArgStringList & CmdArgs,const char * Prefix,const char * Suffix) const90 void toolchains::PS4CPU::addSanitizerArgs(const ArgList &Args,
91                                           ArgStringList &CmdArgs,
92                                           const char *Prefix,
93                                           const char *Suffix) const {
94   auto arg = [&](const char *Name) -> const char * {
95     return makeArgString(Args, Prefix, Name, Suffix);
96   };
97   const SanitizerArgs &SanArgs = getSanitizerArgs(Args);
98   if (SanArgs.needsUbsanRt())
99     CmdArgs.push_back(arg("SceDbgUBSanitizer_stub_weak"));
100   if (SanArgs.needsAsanRt())
101     CmdArgs.push_back(arg("SceDbgAddressSanitizer_stub_weak"));
102 }
103 
addSanitizerArgs(const ArgList & Args,ArgStringList & CmdArgs,const char * Prefix,const char * Suffix) const104 void toolchains::PS5CPU::addSanitizerArgs(const ArgList &Args,
105                                           ArgStringList &CmdArgs,
106                                           const char *Prefix,
107                                           const char *Suffix) const {
108   auto arg = [&](const char *Name) -> const char * {
109     return makeArgString(Args, Prefix, Name, Suffix);
110   };
111   const SanitizerArgs &SanArgs = getSanitizerArgs(Args);
112   if (SanArgs.needsUbsanRt())
113     CmdArgs.push_back(arg("SceUBSanitizer_nosubmission_stub_weak"));
114   if (SanArgs.needsAsanRt())
115     CmdArgs.push_back(arg("SceAddressSanitizer_nosubmission_stub_weak"));
116   if (SanArgs.needsTsanRt())
117     CmdArgs.push_back(arg("SceThreadSanitizer_nosubmission_stub_weak"));
118 }
119 
ConstructJob(Compilation & C,const JobAction & JA,const InputInfo & Output,const InputInfoList & Inputs,const ArgList & Args,const char * LinkingOutput) const120 void tools::PScpu::Linker::ConstructJob(Compilation &C, const JobAction &JA,
121                                         const InputInfo &Output,
122                                         const InputInfoList &Inputs,
123                                         const ArgList &Args,
124                                         const char *LinkingOutput) const {
125   auto &TC = static_cast<const toolchains::PS4PS5Base &>(getToolChain());
126   const Driver &D = TC.getDriver();
127   ArgStringList CmdArgs;
128 
129   // Silence warning for "clang -g foo.o -o foo"
130   Args.ClaimAllArgs(options::OPT_g_Group);
131   // and "clang -emit-llvm foo.o -o foo"
132   Args.ClaimAllArgs(options::OPT_emit_llvm);
133   // and for "clang -w foo.o -o foo". Other warning options are already
134   // handled somewhere else.
135   Args.ClaimAllArgs(options::OPT_w);
136 
137   if (!D.SysRoot.empty())
138     CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
139 
140   if (Args.hasArg(options::OPT_pie))
141     CmdArgs.push_back("-pie");
142 
143   if (Args.hasArg(options::OPT_rdynamic))
144     CmdArgs.push_back("-export-dynamic");
145   if (Args.hasArg(options::OPT_shared))
146     CmdArgs.push_back("--shared");
147 
148   if (Output.isFilename()) {
149     CmdArgs.push_back("-o");
150     CmdArgs.push_back(Output.getFilename());
151   } else {
152     assert(Output.isNothing() && "Invalid output.");
153   }
154 
155   if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs))
156     TC.addSanitizerArgs(Args, CmdArgs, "-l", "");
157 
158   Args.AddAllArgs(CmdArgs, options::OPT_L);
159   Args.AddAllArgs(CmdArgs, options::OPT_T_Group);
160   Args.AddAllArgs(CmdArgs, options::OPT_e);
161   Args.AddAllArgs(CmdArgs, options::OPT_s);
162   Args.AddAllArgs(CmdArgs, options::OPT_t);
163   Args.AddAllArgs(CmdArgs, options::OPT_r);
164 
165   if (Args.hasArg(options::OPT_Z_Xlinker__no_demangle))
166     CmdArgs.push_back("--no-demangle");
167 
168   AddLinkerInputs(TC, Inputs, Args, CmdArgs, JA);
169 
170   if (Args.hasArg(options::OPT_pthread)) {
171     CmdArgs.push_back("-lpthread");
172   }
173 
174   if (Args.hasArg(options::OPT_fuse_ld_EQ)) {
175     D.Diag(diag::err_drv_unsupported_opt_for_target)
176         << "-fuse-ld" << TC.getTriple().str();
177   }
178 
179   std::string LdName = TC.qualifyPSCmdName(TC.getLinkerBaseName());
180   const char *Exec = Args.MakeArgString(TC.GetProgramPath(LdName.c_str()));
181 
182   C.addCommand(std::make_unique<Command>(JA, *this,
183                                          ResponseFileSupport::AtFileUTF8(),
184                                          Exec, CmdArgs, Inputs, Output));
185 }
186 
PS4PS5Base(const Driver & D,const llvm::Triple & Triple,const ArgList & Args,StringRef Platform,const char * EnvVar)187 toolchains::PS4PS5Base::PS4PS5Base(const Driver &D, const llvm::Triple &Triple,
188                                    const ArgList &Args, StringRef Platform,
189                                    const char *EnvVar)
190     : Generic_ELF(D, Triple, Args) {
191   if (Args.hasArg(clang::driver::options::OPT_static))
192     D.Diag(clang::diag::err_drv_unsupported_opt_for_target)
193         << "-static" << Platform;
194 
195   // Determine where to find the PS4/PS5 libraries. We use the EnvVar
196   // if it exists; otherwise use the driver's installation path, which
197   // should be <SDK_DIR>/host_tools/bin.
198 
199   SmallString<512> SDKDir;
200   if (const char *EnvValue = getenv(EnvVar)) {
201     if (!llvm::sys::fs::exists(EnvValue))
202       D.Diag(clang::diag::warn_drv_ps_sdk_dir) << EnvVar << EnvValue;
203     SDKDir = EnvValue;
204   } else {
205     SDKDir = D.Dir;
206     llvm::sys::path::append(SDKDir, "/../../");
207   }
208 
209   // By default, the driver won't report a warning if it can't find the
210   // SDK include or lib directories. This behavior could be changed if
211   // -Weverything or -Winvalid-or-nonexistent-directory options are passed.
212   // If -isysroot was passed, use that as the SDK base path.
213   std::string PrefixDir;
214   if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
215     PrefixDir = A->getValue();
216     if (!llvm::sys::fs::exists(PrefixDir))
217       D.Diag(clang::diag::warn_missing_sysroot) << PrefixDir;
218   } else
219     PrefixDir = std::string(SDKDir.str());
220 
221   SmallString<512> SDKIncludeDir(PrefixDir);
222   llvm::sys::path::append(SDKIncludeDir, "target/include");
223   if (!Args.hasArg(options::OPT_nostdinc) &&
224       !Args.hasArg(options::OPT_nostdlibinc) &&
225       !Args.hasArg(options::OPT_isysroot) &&
226       !Args.hasArg(options::OPT__sysroot_EQ) &&
227       !llvm::sys::fs::exists(SDKIncludeDir)) {
228     D.Diag(clang::diag::warn_drv_unable_to_find_directory_expected)
229         << Twine(Platform, " system headers").str() << SDKIncludeDir;
230   }
231 
232   SmallString<512> SDKLibDir(SDKDir);
233   llvm::sys::path::append(SDKLibDir, "target/lib");
234   if (!Args.hasArg(options::OPT_nostdlib) &&
235       !Args.hasArg(options::OPT_nodefaultlibs) &&
236       !Args.hasArg(options::OPT__sysroot_EQ) && !Args.hasArg(options::OPT_E) &&
237       !Args.hasArg(options::OPT_c) && !Args.hasArg(options::OPT_S) &&
238       !Args.hasArg(options::OPT_emit_ast) &&
239       !llvm::sys::fs::exists(SDKLibDir)) {
240     D.Diag(clang::diag::warn_drv_unable_to_find_directory_expected)
241         << Twine(Platform, " system libraries").str() << SDKLibDir;
242     return;
243   }
244   getFilePaths().push_back(std::string(SDKLibDir.str()));
245 }
246 
buildAssembler() const247 Tool *toolchains::PS4CPU::buildAssembler() const {
248   return new tools::PScpu::Assembler(*this);
249 }
250 
buildAssembler() const251 Tool *toolchains::PS5CPU::buildAssembler() const {
252   // PS5 does not support an external assembler.
253   getDriver().Diag(clang::diag::err_no_external_assembler);
254   return nullptr;
255 }
256 
buildLinker() const257 Tool *toolchains::PS4PS5Base::buildLinker() const {
258   return new tools::PScpu::Linker(*this);
259 }
260 
getSupportedSanitizers() const261 SanitizerMask toolchains::PS4PS5Base::getSupportedSanitizers() const {
262   SanitizerMask Res = ToolChain::getSupportedSanitizers();
263   Res |= SanitizerKind::Address;
264   Res |= SanitizerKind::PointerCompare;
265   Res |= SanitizerKind::PointerSubtract;
266   Res |= SanitizerKind::Vptr;
267   return Res;
268 }
269 
getSupportedSanitizers() const270 SanitizerMask toolchains::PS5CPU::getSupportedSanitizers() const {
271   SanitizerMask Res = PS4PS5Base::getSupportedSanitizers();
272   Res |= SanitizerKind::Thread;
273   return Res;
274 }
275 
addClangTargetOptions(const ArgList & DriverArgs,ArgStringList & CC1Args,Action::OffloadKind DeviceOffloadingKind) const276 void toolchains::PS4PS5Base::addClangTargetOptions(
277     const ArgList &DriverArgs, ArgStringList &CC1Args,
278     Action::OffloadKind DeviceOffloadingKind) const {
279   // PS4/PS5 do not use init arrays.
280   if (DriverArgs.hasArg(options::OPT_fuse_init_array)) {
281     Arg *A = DriverArgs.getLastArg(options::OPT_fuse_init_array);
282     getDriver().Diag(clang::diag::err_drv_unsupported_opt_for_target)
283         << A->getAsString(DriverArgs) << getTriple().str();
284   }
285 
286   CC1Args.push_back("-fno-use-init-array");
287 
288   const Arg *A =
289       DriverArgs.getLastArg(options::OPT_fvisibility_from_dllstorageclass,
290                             options::OPT_fno_visibility_from_dllstorageclass);
291   if (!A ||
292       A->getOption().matches(options::OPT_fvisibility_from_dllstorageclass)) {
293     CC1Args.push_back("-fvisibility-from-dllstorageclass");
294 
295     if (DriverArgs.hasArg(options::OPT_fvisibility_dllexport_EQ))
296       DriverArgs.AddLastArg(CC1Args, options::OPT_fvisibility_dllexport_EQ);
297     else
298       CC1Args.push_back("-fvisibility-dllexport=protected");
299 
300     if (DriverArgs.hasArg(options::OPT_fvisibility_nodllstorageclass_EQ))
301       DriverArgs.AddLastArg(CC1Args,
302                             options::OPT_fvisibility_nodllstorageclass_EQ);
303     else
304       CC1Args.push_back("-fvisibility-nodllstorageclass=hidden");
305 
306     if (DriverArgs.hasArg(options::OPT_fvisibility_externs_dllimport_EQ))
307       DriverArgs.AddLastArg(CC1Args,
308                             options::OPT_fvisibility_externs_dllimport_EQ);
309     else
310       CC1Args.push_back("-fvisibility-externs-dllimport=default");
311 
312     if (DriverArgs.hasArg(
313             options::OPT_fvisibility_externs_nodllstorageclass_EQ))
314       DriverArgs.AddLastArg(
315           CC1Args, options::OPT_fvisibility_externs_nodllstorageclass_EQ);
316     else
317       CC1Args.push_back("-fvisibility-externs-nodllstorageclass=default");
318   }
319 }
320 
321 // PS4 toolchain.
PS4CPU(const Driver & D,const llvm::Triple & Triple,const llvm::opt::ArgList & Args)322 toolchains::PS4CPU::PS4CPU(const Driver &D, const llvm::Triple &Triple,
323                            const llvm::opt::ArgList &Args)
324     : PS4PS5Base(D, Triple, Args, "PS4", "SCE_ORBIS_SDK_DIR") {}
325 
326 // PS5 toolchain.
PS5CPU(const Driver & D,const llvm::Triple & Triple,const llvm::opt::ArgList & Args)327 toolchains::PS5CPU::PS5CPU(const Driver &D, const llvm::Triple &Triple,
328                            const llvm::opt::ArgList &Args)
329     : PS4PS5Base(D, Triple, Args, "PS5", "SCE_PROSPERO_SDK_DIR") {}
330