clang 19.0.0git
PS4CPU.cpp
Go to the documentation of this file.
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/Config/config.h"
13#include "clang/Driver/Driver.h"
17#include "llvm/Option/ArgList.h"
18#include "llvm/Support/FileSystem.h"
19#include "llvm/Support/Path.h"
20#include <cstdlib> // ::getenv
21
22using namespace clang::driver;
23using namespace clang;
24using namespace llvm::opt;
25
26// Helper to paste bits of an option together and return a saved string.
27static const char *makeArgString(const ArgList &Args, const char *Prefix,
28 const char *Base, const char *Suffix) {
29 // Basically "Prefix + Base + Suffix" all converted to Twine then saved.
30 return Args.MakeArgString(Twine(StringRef(Prefix), Base) + Suffix);
31}
32
33void tools::PScpu::addProfileRTArgs(const ToolChain &TC, const ArgList &Args,
34 ArgStringList &CmdArgs) {
35 assert(TC.getTriple().isPS());
36 auto &PSTC = static_cast<const toolchains::PS4PS5Base &>(TC);
37
38 if ((Args.hasFlag(options::OPT_fprofile_arcs, options::OPT_fno_profile_arcs,
39 false) ||
40 Args.hasFlag(options::OPT_fprofile_generate,
41 options::OPT_fno_profile_generate, false) ||
42 Args.hasFlag(options::OPT_fprofile_generate_EQ,
43 options::OPT_fno_profile_generate, false) ||
44 Args.hasFlag(options::OPT_fprofile_instr_generate,
45 options::OPT_fno_profile_instr_generate, false) ||
46 Args.hasFlag(options::OPT_fprofile_instr_generate_EQ,
47 options::OPT_fno_profile_instr_generate, false) ||
48 Args.hasFlag(options::OPT_fcs_profile_generate,
49 options::OPT_fno_profile_generate, false) ||
50 Args.hasFlag(options::OPT_fcs_profile_generate_EQ,
51 options::OPT_fno_profile_generate, false) ||
52 Args.hasArg(options::OPT_fcreate_profile) ||
53 Args.hasArg(options::OPT_coverage)))
54 CmdArgs.push_back(makeArgString(
55 Args, "--dependent-lib=", PSTC.getProfileRTLibName(), ""));
56}
57
59 const InputInfo &Output,
60 const InputInfoList &Inputs,
61 const ArgList &Args,
62 const char *LinkingOutput) const {
63 auto &TC = static_cast<const toolchains::PS4PS5Base &>(getToolChain());
64 claimNoWarnArgs(Args);
65 ArgStringList CmdArgs;
66
67 Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
68
69 CmdArgs.push_back("-o");
70 CmdArgs.push_back(Output.getFilename());
71
72 assert(Inputs.size() == 1 && "Unexpected number of inputs.");
73 const InputInfo &Input = Inputs[0];
74 assert(Input.isFilename() && "Invalid input.");
75 CmdArgs.push_back(Input.getFilename());
76
77 std::string AsName = TC.qualifyPSCmdName("as");
78 const char *Exec = Args.MakeArgString(TC.GetProgramPath(AsName.c_str()));
79 C.addCommand(std::make_unique<Command>(JA, *this,
81 Exec, CmdArgs, Inputs, Output));
82}
83
84void tools::PScpu::addSanitizerArgs(const ToolChain &TC, const ArgList &Args,
85 ArgStringList &CmdArgs) {
86 assert(TC.getTriple().isPS());
87 auto &PSTC = static_cast<const toolchains::PS4PS5Base &>(TC);
88 PSTC.addSanitizerArgs(Args, CmdArgs, "--dependent-lib=lib", ".a");
89}
90
91void toolchains::PS4CPU::addSanitizerArgs(const ArgList &Args,
92 ArgStringList &CmdArgs,
93 const char *Prefix,
94 const char *Suffix) const {
95 auto arg = [&](const char *Name) -> const char * {
96 return makeArgString(Args, Prefix, Name, Suffix);
97 };
98 const SanitizerArgs &SanArgs = getSanitizerArgs(Args);
99 if (SanArgs.needsUbsanRt())
100 CmdArgs.push_back(arg("SceDbgUBSanitizer_stub_weak"));
101 if (SanArgs.needsAsanRt())
102 CmdArgs.push_back(arg("SceDbgAddressSanitizer_stub_weak"));
103}
104
106 ArgStringList &CmdArgs,
107 const char *Prefix,
108 const char *Suffix) const {
109 auto arg = [&](const char *Name) -> const char * {
110 return makeArgString(Args, Prefix, Name, Suffix);
111 };
112 const SanitizerArgs &SanArgs = getSanitizerArgs(Args);
113 if (SanArgs.needsUbsanRt())
114 CmdArgs.push_back(arg("SceUBSanitizer_nosubmission_stub_weak"));
115 if (SanArgs.needsAsanRt())
116 CmdArgs.push_back(arg("SceAddressSanitizer_nosubmission_stub_weak"));
117 if (SanArgs.needsTsanRt())
118 CmdArgs.push_back(arg("SceThreadSanitizer_nosubmission_stub_weak"));
119}
120
122 const InputInfo &Output,
123 const InputInfoList &Inputs,
124 const ArgList &Args,
125 const char *LinkingOutput) const {
126 auto &TC = static_cast<const toolchains::PS4PS5Base &>(getToolChain());
127 const Driver &D = TC.getDriver();
128 ArgStringList CmdArgs;
129
130 // Silence warning for "clang -g foo.o -o foo"
131 Args.ClaimAllArgs(options::OPT_g_Group);
132 // and "clang -emit-llvm foo.o -o foo"
133 Args.ClaimAllArgs(options::OPT_emit_llvm);
134 // and for "clang -w foo.o -o foo". Other warning options are already
135 // handled somewhere else.
136 Args.ClaimAllArgs(options::OPT_w);
137
138 if (!D.SysRoot.empty())
139 CmdArgs.push_back(Args.MakeArgString("--sysroot=" + D.SysRoot));
140
141 if (Args.hasArg(options::OPT_pie))
142 CmdArgs.push_back("-pie");
143
144 if (Args.hasArg(options::OPT_rdynamic))
145 CmdArgs.push_back("-export-dynamic");
146 if (Args.hasArg(options::OPT_shared))
147 CmdArgs.push_back("--shared");
148
149 assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");
150 if (Output.isFilename()) {
151 CmdArgs.push_back("-o");
152 CmdArgs.push_back(Output.getFilename());
153 }
154
155 const bool UseLTO = D.isUsingLTO();
156 const bool UseJMC =
157 Args.hasFlag(options::OPT_fjmc, options::OPT_fno_jmc, false);
158 const bool IsPS4 = TC.getTriple().isPS4();
159
160 const char *PS4LTOArgs = "";
161 auto AddCodeGenFlag = [&](Twine Flag) {
162 if (IsPS4)
163 PS4LTOArgs = Args.MakeArgString(Twine(PS4LTOArgs) + " " + Flag);
164 else
165 CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=") + Flag));
166 };
167
168 if (UseLTO) {
169 // We default to creating the arange section, but LTO does not. Enable it
170 // here.
171 AddCodeGenFlag("-generate-arange-section");
172
173 // This tells LTO to perform JustMyCode instrumentation.
174 if (UseJMC)
175 AddCodeGenFlag("-enable-jmc-instrument");
176
177 if (Arg *A = Args.getLastArg(options::OPT_fcrash_diagnostics_dir))
178 AddCodeGenFlag(Twine("-crash-diagnostics-dir=") + A->getValue());
179
180 StringRef Parallelism = getLTOParallelism(Args, D);
181 if (!Parallelism.empty()) {
182 if (IsPS4)
183 AddCodeGenFlag(Twine("-threads=") + Parallelism);
184 else
185 CmdArgs.push_back(Args.MakeArgString(Twine("-plugin-opt=jobs=") + Parallelism));
186 }
187
188 if (IsPS4) {
189 const char *Prefix = nullptr;
190 if (D.getLTOMode() == LTOK_Thin)
191 Prefix = "-lto-thin-debug-options=";
192 else if (D.getLTOMode() == LTOK_Full)
193 Prefix = "-lto-debug-options=";
194 else
195 llvm_unreachable("new LTO mode?");
196
197 CmdArgs.push_back(Args.MakeArgString(Twine(Prefix) + PS4LTOArgs));
198 }
199 }
200
201 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs))
202 TC.addSanitizerArgs(Args, CmdArgs, "-l", "");
203
204 if (D.isUsingLTO() && Args.hasArg(options::OPT_funified_lto)) {
205 if (D.getLTOMode() == LTOK_Thin)
206 CmdArgs.push_back("--lto=thin");
207 else if (D.getLTOMode() == LTOK_Full)
208 CmdArgs.push_back("--lto=full");
209 }
210
211 Args.addAllArgs(CmdArgs, {options::OPT_L, options::OPT_T_Group,
212 options::OPT_s, options::OPT_t});
213
214 if (Args.hasArg(options::OPT_Z_Xlinker__no_demangle))
215 CmdArgs.push_back("--no-demangle");
216
217 AddLinkerInputs(TC, Inputs, Args, CmdArgs, JA);
218
219 if (Args.hasArg(options::OPT_pthread)) {
220 CmdArgs.push_back("-lpthread");
221 }
222
223 if (UseJMC) {
224 CmdArgs.push_back("--whole-archive");
225 if (IsPS4)
226 CmdArgs.push_back("-lSceDbgJmc");
227 else
228 CmdArgs.push_back("-lSceJmc_nosubmission");
229 CmdArgs.push_back("--no-whole-archive");
230 }
231
232 if (Args.hasArg(options::OPT_fuse_ld_EQ)) {
233 D.Diag(diag::err_drv_unsupported_opt_for_target)
234 << "-fuse-ld" << TC.getTriple().str();
235 }
236
237 std::string LdName = TC.qualifyPSCmdName(TC.getLinkerBaseName());
238 const char *Exec = Args.MakeArgString(TC.GetProgramPath(LdName.c_str()));
239
240 C.addCommand(std::make_unique<Command>(JA, *this,
242 Exec, CmdArgs, Inputs, Output));
243}
244
245toolchains::PS4PS5Base::PS4PS5Base(const Driver &D, const llvm::Triple &Triple,
246 const ArgList &Args, StringRef Platform,
247 const char *EnvVar)
248 : Generic_ELF(D, Triple, Args) {
249 if (Args.hasArg(clang::driver::options::OPT_static))
250 D.Diag(clang::diag::err_drv_unsupported_opt_for_target)
251 << "-static" << Platform;
252
253 // Determine where to find the PS4/PS5 libraries.
254 // If -isysroot was passed, use that as the SDK base path.
255 // If not, we use the EnvVar if it exists; otherwise use the driver's
256 // installation path, which should be <SDK_DIR>/host_tools/bin.
257 SmallString<80> Whence;
258 if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
259 SDKRootDir = A->getValue();
260 if (!llvm::sys::fs::exists(SDKRootDir))
261 D.Diag(clang::diag::warn_missing_sysroot) << SDKRootDir;
262 Whence = A->getSpelling();
263 } else if (const char *EnvValue = getenv(EnvVar)) {
264 SDKRootDir = EnvValue;
265 Whence = { "environment variable '", EnvVar, "'" };
266 } else {
267 SDKRootDir = D.Dir + "/../../";
268 Whence = "compiler's location";
269 }
270
271 SmallString<512> SDKIncludeDir(SDKRootDir);
272 llvm::sys::path::append(SDKIncludeDir, "target/include");
273 if (!Args.hasArg(options::OPT_nostdinc) &&
274 !Args.hasArg(options::OPT_nostdlibinc) &&
275 !Args.hasArg(options::OPT_isysroot) &&
276 !Args.hasArg(options::OPT__sysroot_EQ) &&
277 !llvm::sys::fs::exists(SDKIncludeDir)) {
278 D.Diag(clang::diag::warn_drv_unable_to_find_directory_expected)
279 << Twine(Platform, " system headers").str() << SDKIncludeDir << Whence;
280 }
281
282 SmallString<512> SDKLibDir(SDKRootDir);
283 llvm::sys::path::append(SDKLibDir, "target/lib");
284 if (!Args.hasArg(options::OPT_nostdlib) &&
285 !Args.hasArg(options::OPT_nodefaultlibs) &&
286 !Args.hasArg(options::OPT__sysroot_EQ) && !Args.hasArg(options::OPT_E) &&
287 !Args.hasArg(options::OPT_c) && !Args.hasArg(options::OPT_S) &&
288 !Args.hasArg(options::OPT_emit_ast) &&
289 !llvm::sys::fs::exists(SDKLibDir)) {
290 D.Diag(clang::diag::warn_drv_unable_to_find_directory_expected)
291 << Twine(Platform, " system libraries").str() << SDKLibDir << Whence;
292 return;
293 }
294 getFilePaths().push_back(std::string(SDKLibDir));
295}
296
298 const ArgList &DriverArgs,
299 ArgStringList &CC1Args) const {
300 const Driver &D = getDriver();
301
302 if (DriverArgs.hasArg(options::OPT_nostdinc))
303 return;
304
305 if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
307 llvm::sys::path::append(Dir, "include");
308 addSystemInclude(DriverArgs, CC1Args, Dir.str());
309 }
310
311 if (DriverArgs.hasArg(options::OPT_nostdlibinc))
312 return;
313
314 addExternCSystemInclude(DriverArgs, CC1Args,
315 SDKRootDir + "/target/include");
316 addExternCSystemInclude(DriverArgs, CC1Args,
317 SDKRootDir + "/target/include_common");
318}
319
321 return new tools::PScpu::Assembler(*this);
322}
323
325 // PS5 does not support an external assembler.
326 getDriver().Diag(clang::diag::err_no_external_assembler);
327 return nullptr;
328}
329
331 return new tools::PScpu::Linker(*this);
332}
333
336 Res |= SanitizerKind::Address;
337 Res |= SanitizerKind::PointerCompare;
338 Res |= SanitizerKind::PointerSubtract;
339 Res |= SanitizerKind::Vptr;
340 return Res;
341}
342
345 Res |= SanitizerKind::Thread;
346 return Res;
347}
348
350 const ArgList &DriverArgs, ArgStringList &CC1Args,
351 Action::OffloadKind DeviceOffloadingKind) const {
352 // PS4/PS5 do not use init arrays.
353 if (DriverArgs.hasArg(options::OPT_fuse_init_array)) {
354 Arg *A = DriverArgs.getLastArg(options::OPT_fuse_init_array);
355 getDriver().Diag(clang::diag::err_drv_unsupported_opt_for_target)
356 << A->getAsString(DriverArgs) << getTriple().str();
357 }
358
359 CC1Args.push_back("-fno-use-init-array");
360
361 // Default to `hidden` visibility for PS5.
362 if (getTriple().isPS5() &&
363 !DriverArgs.hasArg(options::OPT_fvisibility_EQ,
364 options::OPT_fvisibility_ms_compat))
365 CC1Args.push_back("-fvisibility=hidden");
366
367 // Default to -fvisibility-global-new-delete=source for PS5.
368 if (getTriple().isPS5() &&
369 !DriverArgs.hasArg(options::OPT_fvisibility_global_new_delete_EQ,
370 options::OPT_fvisibility_global_new_delete_hidden))
371 CC1Args.push_back("-fvisibility-global-new-delete=source");
372
373 const Arg *A =
374 DriverArgs.getLastArg(options::OPT_fvisibility_from_dllstorageclass,
375 options::OPT_fno_visibility_from_dllstorageclass);
376 if (!A ||
377 A->getOption().matches(options::OPT_fvisibility_from_dllstorageclass)) {
378 CC1Args.push_back("-fvisibility-from-dllstorageclass");
379
380 if (DriverArgs.hasArg(options::OPT_fvisibility_dllexport_EQ))
381 DriverArgs.AddLastArg(CC1Args, options::OPT_fvisibility_dllexport_EQ);
382 else
383 CC1Args.push_back("-fvisibility-dllexport=protected");
384
385 // For PS4 we override the visibilty of globals definitions without
386 // dllimport or dllexport annotations.
387 if (DriverArgs.hasArg(options::OPT_fvisibility_nodllstorageclass_EQ))
388 DriverArgs.AddLastArg(CC1Args,
389 options::OPT_fvisibility_nodllstorageclass_EQ);
390 else if (getTriple().isPS4())
391 CC1Args.push_back("-fvisibility-nodllstorageclass=hidden");
392 else
393 CC1Args.push_back("-fvisibility-nodllstorageclass=keep");
394
395 if (DriverArgs.hasArg(options::OPT_fvisibility_externs_dllimport_EQ))
396 DriverArgs.AddLastArg(CC1Args,
397 options::OPT_fvisibility_externs_dllimport_EQ);
398 else
399 CC1Args.push_back("-fvisibility-externs-dllimport=default");
400
401 // For PS4 we override the visibilty of external globals without
402 // dllimport or dllexport annotations.
403 if (DriverArgs.hasArg(
404 options::OPT_fvisibility_externs_nodllstorageclass_EQ))
405 DriverArgs.AddLastArg(
406 CC1Args, options::OPT_fvisibility_externs_nodllstorageclass_EQ);
407 else if (getTriple().isPS4())
408 CC1Args.push_back("-fvisibility-externs-nodllstorageclass=default");
409 else
410 CC1Args.push_back("-fvisibility-externs-nodllstorageclass=keep");
411 }
412}
413
414// PS4 toolchain.
415toolchains::PS4CPU::PS4CPU(const Driver &D, const llvm::Triple &Triple,
416 const llvm::opt::ArgList &Args)
417 : PS4PS5Base(D, Triple, Args, "PS4", "SCE_ORBIS_SDK_DIR") {}
418
419// PS5 toolchain.
420toolchains::PS5CPU::PS5CPU(const Driver &D, const llvm::Triple &Triple,
421 const llvm::opt::ArgList &Args)
422 : PS4PS5Base(D, Triple, Args, "PS5", "SCE_PROSPERO_SDK_DIR") {}
static const char * makeArgString(const ArgList &Args, const char *Prefix, const char *Base, const char *Suffix)
Definition: PS4CPU.cpp:27
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:77
std::string SysRoot
sysroot, if present
Definition: Driver.h:180
DiagnosticBuilder Diag(unsigned DiagID) const
Definition: Driver.h:144
LTOKind getLTOMode(bool IsOffload=false) const
Get the specific kind of LTO being performed.
Definition: Driver.h:722
std::string ResourceDir
The path to the compiler resource directory.
Definition: Driver.h:164
bool isUsingLTO(bool IsOffload=false) const
Returns true if we are performing any kind of LTO.
Definition: Driver.h:717
std::string Dir
The path the driver executable was in, as invoked from the command line.
Definition: Driver.h:155
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
const char * getFilename() const
Definition: InputInfo.h:83
bool isNothing() const
Definition: InputInfo.h:74
bool isFilename() const
Definition: InputInfo.h:75
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:92
path_list & getFilePaths()
Definition: ToolChain.h:295
const Driver & getDriver() const
Definition: ToolChain.h:253
const llvm::Triple & getTriple() const
Definition: ToolChain.h:255
std::string GetProgramPath(const char *Name) const
Definition: ToolChain.cpp:864
virtual SanitizerMask getSupportedSanitizers() const
Return sanitizers which are available in this toolchain.
Definition: ToolChain.cpp:1360
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
const ToolChain & getToolChain() const
Definition: Tool.h:52
void addSanitizerArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const char *Prefix, const char *Suffix) const override
Definition: PS4CPU.cpp:91
Tool * buildAssembler() const override
Definition: PS4CPU.cpp:320
PS4CPU(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Definition: PS4CPU.cpp:415
Tool * buildLinker() const override
Definition: PS4CPU.cpp:330
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition: PS4CPU.cpp:297
virtual void addSanitizerArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const char *Prefix, const char *Suffix) const =0
void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, Action::OffloadKind DeviceOffloadingKind) const override
Add options that need to be passed to cc1 for this target.
Definition: PS4CPU.cpp:349
PS4PS5Base(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, StringRef Platform, const char *EnvVar)
Definition: PS4CPU.cpp:245
SanitizerMask getSupportedSanitizers() const override
Return sanitizers which are available in this toolchain.
Definition: PS4CPU.cpp:334
Tool * buildAssembler() const override
Definition: PS4CPU.cpp:324
void addSanitizerArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const char *Prefix, const char *Suffix) const override
Definition: PS4CPU.cpp:105
SanitizerMask getSupportedSanitizers() const override
Return sanitizers which are available in this toolchain.
Definition: PS4CPU.cpp:343
PS5CPU(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Definition: PS4CPU.cpp:420
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: PS4CPU.cpp:58
void ConstructJob(Compilation &C, const JobAction &JA, const InputInfo &Output, const InputInfoList &Inputs, const llvm::opt::ArgList &TCArgs, const char *LinkingOutput) const override
ConstructJob - Construct jobs to perform the action JA, writing to Output and with Inputs,...
Definition: PS4CPU.cpp:121
void addSanitizerArgs(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void addProfileRTArgs(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args, const Driver &D)
void claimNoWarnArgs(const llvm::opt::ArgList &Args)
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
The JSON file list parser is used to communicate input to InstallAPI.
static constexpr ResponseFileSupport AtFileUTF8()
Definition: Job.h:85