clang 24.0.0git
Darwin.cpp
Go to the documentation of this file.
1//===--- Darwin.cpp - Darwin Tool and 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 "Darwin.h"
10#include "Arch/ARM.h"
13#include "clang/Config/config.h"
16#include "clang/Driver/Driver.h"
19#include "llvm/ADT/StringSwitch.h"
20#include "llvm/Option/ArgList.h"
21#include "llvm/ProfileData/InstrProf.h"
22#include "llvm/ProfileData/MemProf.h"
23#include "llvm/Support/Path.h"
24#include "llvm/Support/Threading.h"
25#include "llvm/Support/VirtualFileSystem.h"
26#include "llvm/TargetParser/TargetParser.h"
27#include "llvm/TargetParser/Triple.h"
28#include <cstdlib> // ::getenv
29
30#ifdef CLANG_USE_XCSELECT
31#include <xcselect.h> // ::xcselect_host_sdk_path
32#endif
33
34using namespace clang::driver;
35using namespace clang::driver::tools;
36using namespace clang::driver::toolchains;
37using namespace clang;
38using namespace llvm::opt;
39
41 return VersionTuple(13, 1);
42}
43
44llvm::Triple::ArchType darwin::getArchTypeForMachOArchName(StringRef Str) {
45 // See arch(3) and llvm-gcc's driver-driver.c. We don't implement support for
46 // archs which Darwin doesn't use.
47
48 // The matching this routine does is fairly pointless, since it is neither the
49 // complete architecture list, nor a reasonable subset. The problem is that
50 // historically the driver accepts this and also ties its -march=
51 // handling to the architecture name, so we need to be careful before removing
52 // support for it.
53
54 // This code must be kept in sync with Clang's Darwin specific argument
55 // translation.
56
57 return llvm::StringSwitch<llvm::Triple::ArchType>(Str)
58 .Cases({"i386", "i486", "i486SX", "i586", "i686"}, llvm::Triple::x86)
59 .Cases({"pentium", "pentpro", "pentIIm3", "pentIIm5", "pentium4"},
60 llvm::Triple::x86)
61 .Cases({"x86_64", "x86_64h"}, llvm::Triple::x86_64)
62 // This is derived from the driver.
63 .Cases({"arm", "armv4t", "armv5", "armv6", "armv6m"}, llvm::Triple::arm)
64 .Cases({"armv7", "armv7em", "armv7k", "armv7m"}, llvm::Triple::arm)
65 .Cases({"armv7s", "xscale"}, llvm::Triple::arm)
66 .Cases({"armv8m.base", "armv8m.main", "armv8.1m.main"}, llvm::Triple::arm)
67 .Cases({"arm64", "arm64e"}, llvm::Triple::aarch64)
68 .Case("arm64_32", llvm::Triple::aarch64_32)
69 .Cases({"amdgpu", "amdgcn"}, llvm::Triple::amdgpu)
70 .Case("r600", llvm::Triple::r600)
71 .Case("nvptx", llvm::Triple::nvptx)
72 .Case("nvptx64", llvm::Triple::nvptx64)
73 .Case("amdil", llvm::Triple::amdil)
74 .Case("spir", llvm::Triple::spir)
75 .Default(llvm::Triple::UnknownArch);
76}
77
78void darwin::setTripleTypeForMachOArchName(llvm::Triple &T, StringRef Str,
79 const ArgList &Args) {
80 const llvm::Triple::ArchType Arch = getArchTypeForMachOArchName(Str);
81 llvm::ARM::ArchKind ArchKind = llvm::ARM::parseArch(Str);
82 T.setArch(Arch);
83 if (Arch != llvm::Triple::UnknownArch)
84 T.setArchName(Str);
85
86 // Standalone/bare metal compiles often unintentionally come out as
87 // armv6m-apple-ios (-target not specified, or set from Xcode). Change these
88 // cases to armv6m-apple-unknown-macho to better reflect intent.
89 if ((T.getOS() != llvm::Triple::Firmware) &&
90 (ArchKind == llvm::ARM::ArchKind::ARMV6M ||
91 ArchKind == llvm::ARM::ArchKind::ARMV7M ||
92 ArchKind == llvm::ARM::ArchKind::ARMV7EM ||
93 ArchKind == llvm::ARM::ArchKind::ARMV8MBaseline ||
94 ArchKind == llvm::ARM::ArchKind::ARMV8MMainline ||
95 ArchKind == llvm::ARM::ArchKind::ARMV8_1MMainline)) {
96 // Don't reject these -version-min= if we have the appropriate triple.
97 if (T.getOS() == llvm::Triple::IOS)
98 for (Arg *A : Args.filtered(options::OPT_mios_version_min_EQ))
99 A->ignoreTargetSpecific();
100 if (T.getOS() == llvm::Triple::WatchOS)
101 for (Arg *A : Args.filtered(options::OPT_mwatchos_version_min_EQ))
102 A->ignoreTargetSpecific();
103 if (T.getOS() == llvm::Triple::TvOS)
104 for (Arg *A : Args.filtered(options::OPT_mtvos_version_min_EQ))
105 A->ignoreTargetSpecific();
106
107 T.setOS(llvm::Triple::UnknownOS);
108 T.setObjectFormat(llvm::Triple::MachO);
109 }
110}
111
113 const InputInfo &Output,
114 const InputInfoList &Inputs,
115 const ArgList &Args,
116 const char *LinkingOutput) const {
117 const llvm::Triple &T(getToolChain().getTriple());
118
119 ArgStringList CmdArgs;
120
121 assert(Inputs.size() == 1 && "Unexpected number of inputs.");
122 const InputInfo &Input = Inputs[0];
123
124 // Determine the original source input.
125 const Action *SourceAction = &JA;
126 while (SourceAction->getKind() != Action::InputClass) {
127 assert(!SourceAction->getInputs().empty() && "unexpected root action!");
128 SourceAction = SourceAction->getInputs()[0];
129 }
130
131 // If -fno-integrated-as is used add -Q to the darwin assembler driver to make
132 // sure it runs its system assembler not clang's integrated assembler.
133 // Applicable to darwin11+ and Xcode 4+. darwin<10 lacked integrated-as.
134 // FIXME: at run-time detect assembler capabilities or rely on version
135 // information forwarded by -target-assembler-version.
136 if (Args.hasArg(options::OPT_fno_integrated_as)) {
137 if (!(T.isMacOSX() && T.isMacOSXVersionLT(10, 7)))
138 CmdArgs.push_back("-Q");
139 }
140
141 // Forward -g, assuming we are dealing with an actual assembly file.
142 if (SourceAction->getType() == types::TY_Asm ||
143 SourceAction->getType() == types::TY_PP_Asm) {
144 if (Args.hasArg(options::OPT_gstabs))
145 CmdArgs.push_back("--gstabs");
146 else if (Args.hasArg(options::OPT_g_Group))
147 CmdArgs.push_back("-g");
148 }
149
150 // Derived from asm spec.
151 AddMachOArch(Args, CmdArgs);
152
153 // Use -force_cpusubtype_ALL on x86 by default.
154 if (T.isX86() || Args.hasArg(options::OPT_force__cpusubtype__ALL))
155 CmdArgs.push_back("-force_cpusubtype_ALL");
156
157 if (getToolChain().getArch() != llvm::Triple::x86_64 &&
158 (((Args.hasArg(options::OPT_mkernel) ||
159 Args.hasArg(options::OPT_fapple_kext)) &&
160 getMachOToolChain().isKernelStatic()) ||
161 Args.hasArg(options::OPT_static)))
162 CmdArgs.push_back("-static");
163
164 Args.AddAllArgValues(CmdArgs, options::OPT_Wa_COMMA, options::OPT_Xassembler);
165
166 assert(Output.isFilename() && "Unexpected lipo output.");
167 CmdArgs.push_back("-o");
168 CmdArgs.push_back(Output.getFilename());
169
170 assert(Input.isFilename() && "Invalid input.");
171 CmdArgs.push_back(Input.getFilename());
172
173 // asm_final spec is empty.
174
175 const char *Exec = Args.MakeArgString(getToolChain().GetProgramPath("as"));
176 C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
177 Exec, CmdArgs, Inputs, Output));
178}
179
180void darwin::MachOTool::anchor() {}
181
182void darwin::MachOTool::AddMachOArch(const ArgList &Args,
183 ArgStringList &CmdArgs) const {
184 StringRef ArchName = getMachOToolChain().getMachOArchName(Args);
185
186 // Derived from darwin_arch spec.
187 CmdArgs.push_back("-arch");
188 CmdArgs.push_back(Args.MakeArgString(ArchName));
189
190 // FIXME: Is this needed anymore?
191 if (ArchName == "arm")
192 CmdArgs.push_back("-force_cpusubtype_ALL");
193}
194
195void darwin::MachOTool::AddMachOArchOnly(const ArgList &Args,
196 ArgStringList &CmdArgs) const {
197 const toolchains::MachO &MachOTC = getMachOToolChain();
198
199 StringRef ArchName;
200 if (MachOTC.getTriple().isOSFirmware())
201 // Firmware uses the full triple as the arch name.
202 ArchName = MachOTC.getEffectiveTriple().getTriple();
203 else
204 ArchName = MachOTC.getMachOArchName(Args);
205
206 CmdArgs.push_back("-arch_only");
207 CmdArgs.push_back(Args.MakeArgString(ArchName));
208}
209
210static void AddMachOSysLibRoot(Compilation &C, const ArgList &Args,
211 ArgStringList &CmdArgs) {
212 // Give --sysroot= preference, over the Apple specific behavior to also use
213 // --isysroot as the syslibroot.
214 // We check `OPT__sysroot_EQ` directly instead of `getSysRoot` to make sure we
215 // prioritise command line arguments over configuration of `DEFAULT_SYSROOT`.
216 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ);
217 A && !StringRef(A->getValue()).empty()) {
218 CmdArgs.push_back("-syslibroot");
219 CmdArgs.push_back(A->getValue());
220 } else if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
221 CmdArgs.push_back("-syslibroot");
222 CmdArgs.push_back(A->getValue());
223 } else if (StringRef sysroot = C.getSysRoot(); sysroot != "") {
224 CmdArgs.push_back("-syslibroot");
225 CmdArgs.push_back(C.getArgs().MakeArgString(sysroot));
226 }
227}
228
229bool darwin::Linker::NeedsTempPath(const InputInfoList &Inputs) const {
230 // We only need to generate a temp path for LTO if we aren't compiling object
231 // files. When compiling source files, we run 'dsymutil' after linking. We
232 // don't run 'dsymutil' when compiling object files.
233 for (const auto &Input : Inputs)
234 if (Input.getType() != types::TY_Object)
235 return true;
236
237 return false;
238}
239
240/// Pass -no_deduplicate to ld64 under certain conditions:
241///
242/// - Either -O0 or -O1 is explicitly specified
243/// - No -O option is specified *and* this is a compile+link (implicit -O0)
244///
245/// Also do *not* add -no_deduplicate when no -O option is specified and this
246/// is just a link (we can't imply -O0)
247static bool shouldLinkerNotDedup(bool IsLinkerOnlyAction, const ArgList &Args) {
248 if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
249 if (A->getOption().matches(options::OPT_O0))
250 return true;
251 if (A->getOption().matches(options::OPT_O))
252 return llvm::StringSwitch<bool>(A->getValue())
253 .Case("1", true)
254 .Default(false);
255 return false; // OPT_Ofast & OPT_O4
256 }
257
258 if (!IsLinkerOnlyAction) // Implicit -O0 for compile+linker only.
259 return true;
260 return false;
261}
262
263void darwin::Linker::AddLinkArgs(Compilation &C, const ArgList &Args,
264 ArgStringList &CmdArgs,
265 const InputInfoList &Inputs,
266 VersionTuple Version, bool LinkerIsLLD,
267 bool UsePlatformVersion) const {
268 const Driver &D = getToolChain().getDriver();
269 const toolchains::MachO &MachOTC = getMachOToolChain();
270
271 // Newer linkers support -demangle. Pass it if supported and not disabled by
272 // the user.
273 if ((Version >= VersionTuple(100) || LinkerIsLLD) &&
274 !Args.hasArg(options::OPT_Z_Xlinker__no_demangle))
275 CmdArgs.push_back("-demangle");
276
277 if (Args.hasArg(options::OPT_rdynamic) &&
278 (Version >= VersionTuple(137) || LinkerIsLLD))
279 CmdArgs.push_back("-export_dynamic");
280
281 // If we are using App Extension restrictions, pass a flag to the linker
282 // telling it that the compiled code has been audited.
283 if (Args.hasFlag(options::OPT_fapplication_extension,
284 options::OPT_fno_application_extension, false))
285 CmdArgs.push_back("-application_extension");
286
287 if (auto LTO = getToolChain().getLTOMode(Args);
288 LTO != LTOK_None && (Version >= VersionTuple(116) || LinkerIsLLD) &&
289 NeedsTempPath(Inputs)) {
290 std::string TmpPathName;
291 if (LTO == LTOK_Full) {
292 // If we are using full LTO, then automatically create a temporary file
293 // path for the linker to use, so that it's lifetime will extend past a
294 // possible dsymutil step.
295 TmpPathName =
296 D.GetTemporaryPath("cc", types::getTypeTempSuffix(types::TY_Object));
297 } else if (LTO == LTOK_Thin)
298 // If we are using thin LTO, then create a directory instead.
299 TmpPathName = D.GetTemporaryDirectory("thinlto");
300
301 if (!TmpPathName.empty()) {
302 auto *TmpPath = C.getArgs().MakeArgString(TmpPathName);
303 C.addTempFile(TmpPath);
304 CmdArgs.push_back("-object_path_lto");
305 CmdArgs.push_back(TmpPath);
306 }
307 }
308
309 // Use -lto_library option to specify the libLTO.dylib path. Try to find
310 // it in clang installed libraries. ld64 will only look at this argument
311 // when it actually uses LTO, so libLTO.dylib only needs to exist at link
312 // time if ld64 decides that it needs to use LTO.
313 // Since this is passed unconditionally, ld64 will never look for libLTO.dylib
314 // next to it. That's ok since ld64 using a libLTO.dylib not matching the
315 // clang version won't work anyways.
316 // lld is built at the same revision as clang and statically links in
317 // LLVM libraries, so it doesn't need libLTO.dylib.
318 if (Version >= VersionTuple(133) && !LinkerIsLLD) {
319 // Search for libLTO in <InstalledDir>/../lib/libLTO.dylib
320 StringRef P = llvm::sys::path::parent_path(D.Dir);
321 SmallString<128> LibLTOPath(P);
322 llvm::sys::path::append(LibLTOPath, "lib");
323 llvm::sys::path::append(LibLTOPath, "libLTO.dylib");
324 CmdArgs.push_back("-lto_library");
325 CmdArgs.push_back(C.getArgs().MakeArgString(LibLTOPath));
326 }
327
328 // ld64 version 262 and above runs the deduplicate pass by default.
329 // FIXME: lld doesn't dedup by default. Should we pass `--icf=safe`
330 // if `!shouldLinkerNotDedup()` if LinkerIsLLD here?
331 if (Version >= VersionTuple(262) &&
332 shouldLinkerNotDedup(C.getJobs().empty(), Args))
333 CmdArgs.push_back("-no_deduplicate");
334
335 // Derived from the "link" spec.
336 Args.AddAllArgs(CmdArgs, options::OPT_static);
337 if (!Args.hasArg(options::OPT_static))
338 CmdArgs.push_back("-dynamic");
339 if (Args.hasArg(options::OPT_fgnu_runtime)) {
340 // FIXME: gcc replaces -lobjc in forward args with -lobjc-gnu
341 // here. How do we wish to handle such things?
342 }
343
344 if (!Args.hasArg(options::OPT_dynamiclib)) {
345 AddMachOArch(Args, CmdArgs);
346 // FIXME: Why do this only on this path?
347 Args.AddLastArg(CmdArgs, options::OPT_force__cpusubtype__ALL);
348
349 Args.AddLastArg(CmdArgs, options::OPT_bundle);
350 Args.AddAllArgs(CmdArgs, options::OPT_bundle__loader);
351 Args.AddAllArgs(CmdArgs, options::OPT_client__name);
352
353 Arg *A;
354 if ((A = Args.getLastArg(options::OPT_compatibility__version)) ||
355 (A = Args.getLastArg(options::OPT_current__version)) ||
356 (A = Args.getLastArg(options::OPT_install__name)))
357 D.Diag(diag::err_drv_argument_only_allowed_with) << A->getAsString(Args)
358 << "-dynamiclib";
359
360 Args.AddLastArg(CmdArgs, options::OPT_force__flat__namespace);
361 Args.AddLastArg(CmdArgs, options::OPT_keep__private__externs);
362 Args.AddLastArg(CmdArgs, options::OPT_private__bundle);
363 } else {
364 CmdArgs.push_back("-dylib");
365
366 Arg *A;
367 if ((A = Args.getLastArg(options::OPT_bundle)) ||
368 (A = Args.getLastArg(options::OPT_bundle__loader)) ||
369 (A = Args.getLastArg(options::OPT_client__name)) ||
370 (A = Args.getLastArg(options::OPT_force__flat__namespace)) ||
371 (A = Args.getLastArg(options::OPT_keep__private__externs)) ||
372 (A = Args.getLastArg(options::OPT_private__bundle)))
373 D.Diag(diag::err_drv_argument_not_allowed_with) << A->getAsString(Args)
374 << "-dynamiclib";
375
376 Args.AddAllArgsTranslated(CmdArgs, options::OPT_compatibility__version,
377 "-dylib_compatibility_version");
378 Args.AddAllArgsTranslated(CmdArgs, options::OPT_current__version,
379 "-dylib_current_version");
380
381 AddMachOArch(Args, CmdArgs);
382
383 Args.AddAllArgsTranslated(CmdArgs, options::OPT_install__name,
384 "-dylib_install_name");
385 }
386
387 Args.AddLastArg(CmdArgs, options::OPT_all__load);
388 Args.AddAllArgs(CmdArgs, options::OPT_allowable__client);
389 Args.AddLastArg(CmdArgs, options::OPT_bind__at__load);
390 if (MachOTC.isTargetIOSBased())
391 Args.AddLastArg(CmdArgs, options::OPT_arch__errors__fatal);
392 Args.AddLastArg(CmdArgs, options::OPT_dead__strip);
393 Args.AddLastArg(CmdArgs, options::OPT_no__dead__strip__inits__and__terms);
394 Args.AddAllArgs(CmdArgs, options::OPT_dylib__file);
395 Args.AddLastArg(CmdArgs, options::OPT_dynamic);
396 Args.AddAllArgs(CmdArgs, options::OPT_exported__symbols__list);
397 Args.AddLastArg(CmdArgs, options::OPT_flat__namespace);
398 Args.AddAllArgs(CmdArgs, options::OPT_force__load);
399 Args.AddAllArgs(CmdArgs, options::OPT_headerpad__max__install__names);
400 Args.AddAllArgs(CmdArgs, options::OPT_image__base);
401 Args.AddAllArgs(CmdArgs, options::OPT_init);
402
403 // Add the deployment target.
404 if (Version >= VersionTuple(520) || LinkerIsLLD || UsePlatformVersion)
405 MachOTC.addPlatformVersionArgs(Args, CmdArgs);
406 else
407 MachOTC.addMinVersionArgs(Args, CmdArgs);
408
409 Args.AddLastArg(CmdArgs, options::OPT_nomultidefs);
410 Args.AddLastArg(CmdArgs, options::OPT_multi__module);
411 Args.AddLastArg(CmdArgs, options::OPT_single__module);
412 Args.AddAllArgs(CmdArgs, options::OPT_multiply__defined);
413 Args.AddAllArgs(CmdArgs, options::OPT_multiply__defined__unused);
414
415 if (const Arg *A =
416 Args.getLastArg(options::OPT_fpie, options::OPT_fPIE,
417 options::OPT_fno_pie, options::OPT_fno_PIE)) {
418 if (A->getOption().matches(options::OPT_fpie) ||
419 A->getOption().matches(options::OPT_fPIE))
420 CmdArgs.push_back("-pie");
421 else
422 CmdArgs.push_back("-no_pie");
423 }
424
425 // for embed-bitcode, use -bitcode_bundle in linker command
426 if (C.getDriver().embedBitcodeEnabled()) {
427 // Check if the toolchain supports bitcode build flow.
428 if (MachOTC.SupportsEmbeddedBitcode()) {
429 CmdArgs.push_back("-bitcode_bundle");
430 // FIXME: Pass this if LinkerIsLLD too, once it implements this flag.
431 if (C.getDriver().embedBitcodeMarkerOnly() &&
432 Version >= VersionTuple(278)) {
433 CmdArgs.push_back("-bitcode_process_mode");
434 CmdArgs.push_back("marker");
435 }
436 } else
437 D.Diag(diag::err_drv_bitcode_unsupported_on_toolchain);
438 }
439
440 // If GlobalISel is enabled, pass it through to LLVM.
441 if (Arg *A = Args.getLastArg(options::OPT_fglobal_isel,
442 options::OPT_fno_global_isel)) {
443 if (A->getOption().matches(options::OPT_fglobal_isel)) {
444 CmdArgs.push_back("-mllvm");
445 CmdArgs.push_back("-global-isel");
446 // Disable abort and fall back to SDAG silently.
447 CmdArgs.push_back("-mllvm");
448 CmdArgs.push_back("-global-isel-abort=0");
449 }
450 }
451
452 if (Args.hasArg(options::OPT_mkernel) ||
453 Args.hasArg(options::OPT_fapple_kext) ||
454 Args.hasArg(options::OPT_ffreestanding)) {
455 CmdArgs.push_back("-mllvm");
456 CmdArgs.push_back("-disable-atexit-based-global-dtor-lowering");
457 }
458
459 Args.AddLastArg(CmdArgs, options::OPT_prebind);
460 Args.AddLastArg(CmdArgs, options::OPT_noprebind);
461 Args.AddLastArg(CmdArgs, options::OPT_nofixprebinding);
462 Args.AddLastArg(CmdArgs, options::OPT_prebind__all__twolevel__modules);
463 Args.AddLastArg(CmdArgs, options::OPT_read__only__relocs);
464 Args.AddAllArgs(CmdArgs, options::OPT_sectcreate);
465 Args.AddAllArgs(CmdArgs, options::OPT_sectorder);
466 Args.AddAllArgs(CmdArgs, options::OPT_seg1addr);
467 Args.AddAllArgs(CmdArgs, options::OPT_segprot);
468 Args.AddAllArgs(CmdArgs, options::OPT_segaddr);
469 Args.AddAllArgs(CmdArgs, options::OPT_segs__read__only__addr);
470 Args.AddAllArgs(CmdArgs, options::OPT_segs__read__write__addr);
471 Args.AddAllArgs(CmdArgs, options::OPT_seg__addr__table);
472 Args.AddAllArgs(CmdArgs, options::OPT_seg__addr__table__filename);
473 Args.AddAllArgs(CmdArgs, options::OPT_sub__library);
474 Args.AddAllArgs(CmdArgs, options::OPT_sub__umbrella);
475
476 AddMachOSysLibRoot(C, Args, CmdArgs);
477
478 Args.AddLastArg(CmdArgs, options::OPT_twolevel__namespace);
479 Args.AddLastArg(CmdArgs, options::OPT_twolevel__namespace__hints);
480 Args.AddAllArgs(CmdArgs, options::OPT_umbrella);
481 Args.AddAllArgs(CmdArgs, options::OPT_undefined);
482 Args.AddAllArgs(CmdArgs, options::OPT_unexported__symbols__list);
483 Args.AddAllArgs(CmdArgs, options::OPT_weak__reference__mismatches);
484 Args.AddLastArg(CmdArgs, options::OPT_X_Flag);
485 Args.AddAllArgs(CmdArgs, options::OPT_y);
486 Args.AddLastArg(CmdArgs, options::OPT_w);
487 Args.AddAllArgs(CmdArgs, options::OPT_pagezero__size);
488 Args.AddAllArgs(CmdArgs, options::OPT_segs__read__);
489 Args.AddLastArg(CmdArgs, options::OPT_seglinkedit);
490 Args.AddLastArg(CmdArgs, options::OPT_noseglinkedit);
491 Args.AddAllArgs(CmdArgs, options::OPT_sectalign);
492 Args.AddAllArgs(CmdArgs, options::OPT_sectobjectsymbols);
493 Args.AddAllArgs(CmdArgs, options::OPT_segcreate);
494 Args.AddLastArg(CmdArgs, options::OPT_why_load);
495 Args.AddLastArg(CmdArgs, options::OPT_whatsloaded);
496 Args.AddAllArgs(CmdArgs, options::OPT_dylinker__install__name);
497 Args.AddLastArg(CmdArgs, options::OPT_dylinker);
498 Args.AddLastArg(CmdArgs, options::OPT_Mach);
499
500 if (Version >= VersionTuple(900))
501 Args.AddLastArg(CmdArgs, options::OPT_O_Group);
502
503 if (LinkerIsLLD) {
504 if (auto *CSPGOGenerateArg = getLastCSProfileGenerateArg(Args)) {
505 SmallString<128> Path(CSPGOGenerateArg->getNumValues() == 0
506 ? ""
507 : CSPGOGenerateArg->getValue());
508 llvm::sys::path::append(Path, "default_%m.profraw");
509 CmdArgs.push_back("--cs-profile-generate");
510 CmdArgs.push_back(Args.MakeArgString(Twine("--cs-profile-path=") + Path));
511 } else if (auto *ProfileUseArg = getLastProfileUseArg(Args)) {
512 SmallString<128> Path(
513 ProfileUseArg->getNumValues() == 0 ? "" : ProfileUseArg->getValue());
514 if (Path.empty() || llvm::sys::fs::is_directory(Path))
515 llvm::sys::path::append(Path, "default.profdata");
516 CmdArgs.push_back(Args.MakeArgString(Twine("--cs-profile-path=") + Path));
517 }
518
519 auto *CodeGenDataGenArg =
520 Args.getLastArg(options::OPT_fcodegen_data_generate_EQ);
521 if (CodeGenDataGenArg)
522 CmdArgs.push_back(
523 Args.MakeArgString(Twine("--codegen-data-generate-path=") +
524 CodeGenDataGenArg->getValue()));
525 } else {
526 if (auto *CSPGOGenerateArg = getLastCSProfileGenerateArg(Args)) {
527 SmallString<128> Path(CSPGOGenerateArg->getNumValues() == 0
528 ? ""
529 : CSPGOGenerateArg->getValue());
530 llvm::sys::path::append(Path, "default_%m.profraw");
531 CmdArgs.push_back("-mllvm");
532 CmdArgs.push_back("-cs-profile-generate");
533 CmdArgs.push_back("-mllvm");
534 CmdArgs.push_back(Args.MakeArgString(Twine("-cs-profile-path=") + Path));
535 } else if (auto *ProfileUseArg = getLastProfileUseArg(Args)) {
536 SmallString<128> Path(
537 ProfileUseArg->getNumValues() == 0 ? "" : ProfileUseArg->getValue());
538 if (Path.empty() || llvm::sys::fs::is_directory(Path))
539 llvm::sys::path::append(Path, "default.profdata");
540 CmdArgs.push_back("-mllvm");
541 CmdArgs.push_back(Args.MakeArgString(Twine("-cs-profile-path=") + Path));
542 }
543 }
544
545 if (Arg *A = getLastProfileSampleUseArg(Args)) {
546 CmdArgs.push_back("-mllvm");
547 CmdArgs.push_back(
548 Args.MakeArgString(Twine("-sample-profile-file=") + A->getValue()));
549 }
550}
551
552/// Determine whether we are linking the ObjC runtime.
553static bool isObjCRuntimeLinked(const ArgList &Args) {
554 if (isObjCAutoRefCount(Args)) {
555 Args.ClaimAllArgs(options::OPT_fobjc_link_runtime);
556 return true;
557 }
558 return Args.hasArg(options::OPT_fobjc_link_runtime);
559}
560
561static bool checkRemarksOptions(const Driver &D, const ArgList &Args,
562 const llvm::Triple &Triple) {
563 // When enabling remarks, we need to error if:
564 // * The remark file is specified but we're targeting multiple architectures,
565 // which means more than one remark file is being generated.
567 Args.getAllArgValues(options::OPT_arch).size() > 1;
568 bool hasExplicitOutputFile =
569 Args.getLastArg(options::OPT_foptimization_record_file_EQ);
570 if (hasMultipleInvocations && hasExplicitOutputFile) {
571 D.Diag(diag::err_drv_invalid_output_with_multiple_archs)
572 << "-foptimization-record-file";
573 return false;
574 }
575 return true;
576}
577
578static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
579 const llvm::Triple &Triple,
580 const InputInfo &Output, const JobAction &JA) {
581 StringRef Format = "yaml";
582 if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
583 Format = A->getValue();
584
585 CmdArgs.push_back("-mllvm");
586 CmdArgs.push_back("-lto-pass-remarks-output");
587 CmdArgs.push_back("-mllvm");
588
589 const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
590 if (A) {
591 CmdArgs.push_back(A->getValue());
592 } else {
593 assert(Output.isFilename() && "Unexpected ld output.");
595 F = Output.getFilename();
596 F += ".opt.";
597 F += Format;
598
599 CmdArgs.push_back(Args.MakeArgString(F));
600 }
601
602 if (const Arg *A =
603 Args.getLastArg(options::OPT_foptimization_record_passes_EQ)) {
604 CmdArgs.push_back("-mllvm");
605 std::string Passes =
606 std::string("-lto-pass-remarks-filter=") + A->getValue();
607 CmdArgs.push_back(Args.MakeArgString(Passes));
608 }
609
610 if (!Format.empty()) {
611 CmdArgs.push_back("-mllvm");
612 Twine FormatArg = Twine("-lto-pass-remarks-format=") + Format;
613 CmdArgs.push_back(Args.MakeArgString(FormatArg));
614 }
615
616 if (getLastProfileUseArg(Args)) {
617 CmdArgs.push_back("-mllvm");
618 CmdArgs.push_back("-lto-pass-remarks-with-hotness");
619
620 if (const Arg *A =
621 Args.getLastArg(options::OPT_fdiagnostics_hotness_threshold_EQ)) {
622 CmdArgs.push_back("-mllvm");
623 std::string Opt =
624 std::string("-lto-pass-remarks-hotness-threshold=") + A->getValue();
625 CmdArgs.push_back(Args.MakeArgString(Opt));
626 }
627 }
628}
629
631 const InputInfo &Output,
632 const InputInfoList &Inputs,
633 const ArgList &Args,
634 const char *LinkingOutput) const {
635 assert((Output.getType() == types::TY_Image ||
636 Output.getType() == types::TY_Object) &&
637 "Invalid linker output type.");
638
639 // If the number of arguments surpasses the system limits, we will encode the
640 // input files in a separate file, shortening the command line. To this end,
641 // build a list of input file names that can be passed via a file with the
642 // -filelist linker option.
643 llvm::opt::ArgStringList InputFileList;
644
645 // The logic here is derived from gcc's behavior; most of which
646 // comes from specs (starting with link_command). Consult gcc for
647 // more information.
648 ArgStringList CmdArgs;
649
650 VersionTuple Version = getMachOToolChain().getLinkerVersion(Args);
651
652 bool LinkerIsLLD;
653 const char *Exec =
654 Args.MakeArgString(getToolChain().GetLinkerPath(&LinkerIsLLD));
655
656 // Newer triples always use -platform-version.
657 llvm::Triple Triple = getToolChain().getTriple();
658 bool UsePlatformVersion = Triple.isXROS() || Triple.isOSFirmware();
659
660 // I'm not sure why this particular decomposition exists in gcc, but
661 // we follow suite for ease of comparison.
662 AddLinkArgs(C, Args, CmdArgs, Inputs, Version, LinkerIsLLD,
663 UsePlatformVersion);
664
665 if (willEmitRemarks(Args) &&
666 checkRemarksOptions(getToolChain().getDriver(), Args,
668 renderRemarksOptions(Args, CmdArgs, getToolChain().getTriple(), Output, JA);
669
670 // Propagate the -moutline flag to the linker in LTO.
671 if (Arg *A =
672 Args.getLastArg(options::OPT_moutline, options::OPT_mno_outline)) {
673 if (A->getOption().matches(options::OPT_moutline)) {
674 if (getMachOToolChain().getMachOArchName(Args) == "arm64") {
675 CmdArgs.push_back("-mllvm");
676 CmdArgs.push_back("-enable-machine-outliner");
677 }
678 } else {
679 // Disable all outlining behaviour if we have mno-outline. We need to do
680 // this explicitly, because targets which support default outlining will
681 // try to do work if we don't.
682 CmdArgs.push_back("-mllvm");
683 CmdArgs.push_back("-enable-machine-outliner=never");
684 }
685 }
686
687 // Outline from linkonceodr functions by default in LTO, whenever the outliner
688 // is enabled. Note that the target may enable the machine outliner
689 // independently of -moutline.
690 CmdArgs.push_back("-mllvm");
691 CmdArgs.push_back("-enable-linkonceodr-outlining");
692
693 // Propagate codegen data flags to the linker for the LLVM backend.
694 auto *CodeGenDataGenArg =
695 Args.getLastArg(options::OPT_fcodegen_data_generate_EQ);
696 auto *CodeGenDataUseArg = Args.getLastArg(options::OPT_fcodegen_data_use_EQ);
697
698 // We only allow one of them to be specified.
699 const Driver &D = getToolChain().getDriver();
700 if (CodeGenDataGenArg && CodeGenDataUseArg)
701 D.Diag(diag::err_drv_argument_not_allowed_with)
702 << CodeGenDataGenArg->getAsString(Args)
703 << CodeGenDataUseArg->getAsString(Args);
704
705 // For codegen data gen, the output file is passed to the linker
706 // while a boolean flag is passed to the LLVM backend.
707 if (CodeGenDataGenArg) {
708 CmdArgs.push_back("-mllvm");
709 CmdArgs.push_back("-codegen-data-generate");
710 }
711
712 // For codegen data use, the input file is passed to the LLVM backend.
713 if (CodeGenDataUseArg) {
714 CmdArgs.push_back("-mllvm");
715 CmdArgs.push_back(Args.MakeArgString(Twine("-codegen-data-use-path=") +
716 CodeGenDataUseArg->getValue()));
717 }
718
719 // Setup statistics file output.
720 SmallString<128> StatsFile =
721 getStatsFileName(Args, Output, Inputs[0], getToolChain().getDriver());
722 if (!StatsFile.empty()) {
723 CmdArgs.push_back("-mllvm");
724 CmdArgs.push_back(Args.MakeArgString("-lto-stats-file=" + StatsFile.str()));
725 }
726
727 // Set up stack usage file path.
728 if (Args.hasArg(options::OPT_fstack_usage)) {
729 SmallString<128> StackUsageFile(Output.getFilename());
730 llvm::sys::path::replace_extension(StackUsageFile, "su");
731 CmdArgs.push_back("-mllvm");
732 CmdArgs.push_back(
733 Args.MakeArgString("-stack-usage-file=" + StackUsageFile));
734 }
735
736 // It seems that the 'e' option is completely ignored for dynamic executables
737 // (the default), and with static executables, the last one wins, as expected.
738 Args.addAllArgs(CmdArgs, {options::OPT_d_Flag, options::OPT_s, options::OPT_t,
739 options::OPT_Z_Flag, options::OPT_u_Group});
740
741 // Forward -ObjC when either -ObjC or -ObjC++ is used, to force loading
742 // members of static archive libraries which implement Objective-C classes or
743 // categories.
744 if (Args.hasArg(options::OPT_ObjC) || Args.hasArg(options::OPT_ObjCXX))
745 CmdArgs.push_back("-ObjC");
746
747 CmdArgs.push_back("-o");
748 CmdArgs.push_back(Output.getFilename());
749
750 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles))
751 getMachOToolChain().addStartObjectFileArgs(Args, CmdArgs);
752
753 Args.AddAllArgs(CmdArgs, options::OPT_L);
754
755 AddLinkerInputs(getToolChain(), Inputs, Args, CmdArgs, JA);
756 // Build the input file for -filelist (list of linker input files) in case we
757 // need it later
758 for (const auto &II : Inputs) {
759 if (!II.isFilename()) {
760 // This is a linker input argument.
761 // We cannot mix input arguments and file names in a -filelist input, thus
762 // we prematurely stop our list (remaining files shall be passed as
763 // arguments).
764 if (InputFileList.size() > 0)
765 break;
766
767 continue;
768 }
769
770 InputFileList.push_back(II.getFilename());
771 }
772
773 // Additional linker set-up and flags for Fortran. This is required in order
774 // to generate executables.
775 if (getToolChain().getDriver().IsFlangMode() &&
776 !Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
777 getToolChain().addFortranRuntimeLibraryPath(Args, CmdArgs);
778 getToolChain().addFortranRuntimeLibs(Args, CmdArgs);
779 }
780
781 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs))
782 addOpenMPRuntime(C, CmdArgs, getToolChain(), Args);
783
784 if (isObjCRuntimeLinked(Args) &&
785 !Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
786 // We use arclite library for both ARC and subscripting support.
787 getMachOToolChain().AddLinkARCArgs(Args, CmdArgs);
788
789 CmdArgs.push_back("-framework");
790 CmdArgs.push_back("Foundation");
791 // Link libobj.
792 CmdArgs.push_back("-lobjc");
793 }
794
795 if (LinkingOutput) {
796 CmdArgs.push_back("-arch_multiple");
797 CmdArgs.push_back("-final_output");
798 CmdArgs.push_back(LinkingOutput);
799 }
800
801 if (Args.hasArg(options::OPT_fnested_functions))
802 CmdArgs.push_back("-allow_stack_execute");
803
804 getMachOToolChain().addProfileRTLibs(Args, CmdArgs);
805
806 StringRef Parallelism = getLTOParallelism(Args, getToolChain().getDriver());
807 if (!Parallelism.empty()) {
808 CmdArgs.push_back("-mllvm");
809 unsigned NumThreads =
810 llvm::get_threadpool_strategy(Parallelism)->compute_thread_count();
811 CmdArgs.push_back(Args.MakeArgString("-threads=" + Twine(NumThreads)));
812 }
813
814 if (getToolChain().ShouldLinkCXXStdlib(Args))
815 getToolChain().AddCXXStdlibLibArgs(Args, CmdArgs);
816
817 bool NoStdOrDefaultLibs =
818 Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs);
819 bool ForceLinkBuiltins = Args.hasArg(options::OPT_fapple_link_rtlib);
820 if (!NoStdOrDefaultLibs || ForceLinkBuiltins) {
821 // link_ssp spec is empty.
822
823 // If we have both -nostdlib/nodefaultlibs and -fapple-link-rtlib then
824 // we just want to link the builtins, not the other libs like libSystem.
825 if (NoStdOrDefaultLibs && ForceLinkBuiltins) {
826 getMachOToolChain().AddLinkRuntimeLib(Args, CmdArgs, "builtins");
827 } else {
828 // Let the tool chain choose which runtime library to link.
829 getMachOToolChain().AddLinkRuntimeLibArgs(Args, CmdArgs,
830 ForceLinkBuiltins);
831
832 // No need to do anything for pthreads. Claim argument to avoid warning.
833 Args.ClaimAllArgs(options::OPT_pthread);
834 Args.ClaimAllArgs(options::OPT_pthreads);
835 }
836 }
837
838 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles)) {
839 // endfile_spec is empty.
840 }
841
842 Args.AddAllArgs(CmdArgs, options::OPT_T_Group);
843 Args.AddAllArgs(CmdArgs, options::OPT_F);
844
845 // -iframework should be forwarded as -F.
846 for (const Arg *A : Args.filtered(options::OPT_iframework))
847 CmdArgs.push_back(Args.MakeArgString(std::string("-F") + A->getValue()));
848
849 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
850 if (Arg *A = Args.getLastArg(options::OPT_fveclib)) {
851 if (A->getValue() == StringRef("Accelerate")) {
852 CmdArgs.push_back("-framework");
853 CmdArgs.push_back("Accelerate");
854 }
855 }
856 }
857
858 // Add non-standard, platform-specific search paths, e.g., for DriverKit:
859 // -L<sysroot>/System/DriverKit/usr/lib
860 // -F<sysroot>/System/DriverKit/System/Library/Framework
861 {
862 bool NonStandardSearchPath = false;
863 const auto &Triple = getToolChain().getTriple();
864 if (Triple.isDriverKit()) {
865 // ld64 fixed the implicit -F and -L paths in ld64-605.1+.
866 NonStandardSearchPath =
867 Version.getMajor() < 605 ||
868 (Version.getMajor() == 605 && Version.getMinor().value_or(0) < 1);
869 } else {
870 NonStandardSearchPath = getMachOToolChain().HasPlatformPrefix(Triple);
871 }
872
873 if (NonStandardSearchPath) {
874 if (auto *Sysroot = Args.getLastArg(options::OPT_isysroot)) {
875 auto AddSearchPath = [&](StringRef Flag, StringRef SearchPath) {
876 SmallString<128> P(Sysroot->getValue());
877 getMachOToolChain().AppendPlatformPrefix(P, Triple);
878 llvm::sys::path::append(P, SearchPath);
879 if (getToolChain().getVFS().exists(P)) {
880 CmdArgs.push_back(Args.MakeArgString(Flag + P));
881 }
882 };
883 AddSearchPath("-L", "/usr/lib");
884 AddSearchPath("-F", "/System/Library/Frameworks");
885 }
886 }
887 }
888
889 ResponseFileSupport ResponseSupport;
890 if (Version >= VersionTuple(705) || LinkerIsLLD) {
891 ResponseSupport = ResponseFileSupport::AtFileUTF8();
892 } else {
893 // For older versions of the linker, use the legacy filelist method instead.
894 ResponseSupport = {ResponseFileSupport::RF_FileList, llvm::sys::WEM_UTF8,
895 "-filelist"};
896 }
897
898 std::unique_ptr<Command> Cmd = std::make_unique<Command>(
899 JA, *this, ResponseSupport, Exec, CmdArgs, Inputs, Output);
900 Cmd->setInputFileList(std::move(InputFileList));
901 C.addCommand(std::move(Cmd));
902}
903
905 const InputInfo &Output,
906 const InputInfoList &Inputs,
907 const ArgList &Args,
908 const char *LinkingOutput) const {
909 const Driver &D = getToolChain().getDriver();
910
911 // Silence warning for "clang -g foo.o -o foo"
912 Args.ClaimAllArgs(options::OPT_g_Group);
913 // and "clang -emit-llvm foo.o -o foo"
914 Args.ClaimAllArgs(options::OPT_emit_llvm);
915 // and for "clang -w foo.o -o foo". Other warning options are already
916 // handled somewhere else.
917 Args.ClaimAllArgs(options::OPT_w);
918 // Silence warnings when linking C code with a C++ '-stdlib' argument.
919 Args.ClaimAllArgs(options::OPT_stdlib_EQ);
920
921 ArgStringList CmdArgs;
922 CmdArgs.push_back("-static");
923
924 if (Args.hasArg(options::OPT_static_lib_target_arch_only))
925 AddMachOArchOnly(Args, CmdArgs);
926
927 if (Args.hasFlag(options::OPT_static_lib_deterministic,
928 options::OPT_no_static_lib_deterministic,
929 /*Default=*/true))
930 CmdArgs.push_back("-D");
931
932 AddMachOSysLibRoot(C, Args, CmdArgs);
933 Args.AddAllArgs(CmdArgs, options::OPT_L);
934 Args.AddAllArgs(CmdArgs, options::OPT_F);
935
936 // -iframework should be forwarded as -F.
937 for (const Arg *A : Args.filtered(options::OPT_iframework))
938 CmdArgs.push_back(Args.MakeArgString(std::string("-F") + A->getValue()));
939
940 if (!Args.hasFlag(options::OPT_static_lib_warn_no_symbols,
941 options::OPT_no_static_lib_warn_no_symbols,
942 /*Default=*/false))
943 CmdArgs.push_back("-no_warning_for_no_symbols");
944
945 Args.AddAllArgValues(CmdArgs, options::OPT_Xstatic_lib_tool);
946
947 CmdArgs.push_back("-o");
948 CmdArgs.push_back(Output.getFilename());
949
950 // Add extra linker input arguments which are not treated as inputs
951 // (constructed via -Xarch_).
952 Args.AddAllArgValues(CmdArgs, options::OPT_Zlinker_input);
953
954 for (const auto &II : Inputs) {
955 // Add filenames immediately.
956 if (II.isFilename()) {
957 CmdArgs.push_back(II.getFilename());
958 continue;
959 }
960
961 // In some error cases, the input could be Nothing; skip those.
962 if (II.isNothing())
963 continue;
964
965 // Otherwise, this is a linker input argument.
966 const Arg &A = II.getInputArg();
967
968 // libtool only supports a few of the linker input arguments, warn for the
969 // rest.
970 if (A.getOption().matches(options::OPT_filelist) ||
971 A.getOption().matches(options::OPT_l) ||
972 A.getOption().matches(options::OPT_framework))
973 A.renderAsInput(Args, CmdArgs);
974 else
975 D.Diag(diag::warn_drv_unused_argument) << A.getAsString(Args);
976 }
977
978 // Delete old output archive file if it already exists before generating a new
979 // archive file.
980 const auto *OutputFileName = Output.getFilename();
981 if (Output.isFilename() && llvm::sys::fs::exists(OutputFileName)) {
982 if (std::error_code EC = llvm::sys::fs::remove(OutputFileName)) {
983 D.Diag(diag::err_drv_unable_to_remove_file) << EC.message();
984 return;
985 }
986 }
987
988 const char *Exec = Args.MakeArgString(getToolChain().GetStaticLibToolPath());
989 C.addCommand(std::make_unique<Command>(JA, *this,
991 Exec, CmdArgs, Inputs, Output));
992}
993
995 const InputInfo &Output,
996 const InputInfoList &Inputs,
997 const ArgList &Args,
998 const char *LinkingOutput) const {
999 ArgStringList CmdArgs;
1000
1001 CmdArgs.push_back("-create");
1002 assert(Output.isFilename() && "Unexpected lipo output.");
1003
1004 CmdArgs.push_back("-output");
1005 CmdArgs.push_back(Output.getFilename());
1006
1007 for (const auto &II : Inputs) {
1008 assert(II.isFilename() && "Unexpected lipo input.");
1009 CmdArgs.push_back(II.getFilename());
1010 }
1011
1012 StringRef LipoName = Args.getLastArgValue(options::OPT_fuse_lipo_EQ, "lipo");
1013 const char *Exec =
1014 Args.MakeArgString(getToolChain().GetProgramPath(LipoName.data()));
1015 C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
1016 Exec, CmdArgs, Inputs, Output));
1017}
1018
1020 const InputInfo &Output,
1021 const InputInfoList &Inputs,
1022 const ArgList &Args,
1023 const char *LinkingOutput) const {
1024 ArgStringList CmdArgs;
1025
1026 CmdArgs.push_back("-o");
1027 CmdArgs.push_back(Output.getFilename());
1028
1029 assert(Inputs.size() == 1 && "Unable to handle multiple inputs.");
1030 const InputInfo &Input = Inputs[0];
1031 assert(Input.isFilename() && "Unexpected dsymutil input.");
1032 CmdArgs.push_back(Input.getFilename());
1033
1034 const char *Exec =
1035 Args.MakeArgString(getToolChain().GetProgramPath("dsymutil"));
1036 C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
1037 Exec, CmdArgs, Inputs, Output));
1038}
1039
1041 const InputInfo &Output,
1042 const InputInfoList &Inputs,
1043 const ArgList &Args,
1044 const char *LinkingOutput) const {
1045 ArgStringList CmdArgs;
1046 CmdArgs.push_back("--verify");
1047 CmdArgs.push_back("--debug-info");
1048 CmdArgs.push_back("--eh-frame");
1049 CmdArgs.push_back("--quiet");
1050
1051 assert(Inputs.size() == 1 && "Unable to handle multiple inputs.");
1052 const InputInfo &Input = Inputs[0];
1053 assert(Input.isFilename() && "Unexpected verify input");
1054
1055 // Grabbing the output of the earlier dsymutil run.
1056 CmdArgs.push_back(Input.getFilename());
1057
1058 const char *Exec =
1059 Args.MakeArgString(getToolChain().GetProgramPath("dwarfdump"));
1060 C.addCommand(std::make_unique<Command>(JA, *this, ResponseFileSupport::None(),
1061 Exec, CmdArgs, Inputs, Output));
1062}
1063
1064MachO::MachO(const Driver &D, const llvm::Triple &Triple, const ArgList &Args)
1065 : ToolChain(D, Triple, Args) {
1066 // We expect 'as', 'ld', etc. to be adjacent to our install dir.
1067 getProgramPaths().push_back(getDriver().Dir);
1068}
1069
1070AppleMachO::AppleMachO(const Driver &D, const llvm::Triple &Triple,
1071 const ArgList &Args)
1072 : MachO(D, Triple, Args), CudaInstallation(D, Triple, Args),
1073 RocmInstallation(D, Triple, Args), SYCLInstallation(D, Triple, Args) {}
1074
1075/// Darwin - Darwin tool chain for i386 and x86_64.
1076Darwin::Darwin(const Driver &D, const llvm::Triple &Triple, const ArgList &Args)
1077 : AppleMachO(D, Triple, Args), TargetInitialized(false) {}
1078
1081
1082 // Darwin always preprocesses assembly files (unless -x is used explicitly).
1083 if (Ty == types::TY_PP_Asm)
1084 return types::TY_Asm;
1085
1086 return Ty;
1087}
1088
1089bool MachO::HasNativeLLVMSupport() const { return true; }
1090
1092 // Always use libc++ by default
1093 return ToolChain::CST_Libcxx;
1094}
1095
1096/// Darwin provides an ARC runtime starting in MacOS X 10.7 and iOS 5.0.
1100 if (isTargetIOSBased())
1102 if (isTargetXROS()) {
1103 // XROS uses the iOS runtime.
1104 auto T = llvm::Triple(Twine("arm64-apple-") +
1105 llvm::Triple::getOSTypeName(llvm::Triple::XROS) +
1106 TargetVersion.getAsString());
1107 return ObjCRuntime(ObjCRuntime::iOS, T.getiOSVersion());
1108 }
1109 if (isNonFragile)
1112}
1113
1114/// Darwin provides a blocks runtime starting in MacOS X 10.6 and iOS 3.2.
1117 return true;
1118 else if (isTargetFirmware())
1119 return false;
1120 else if (isTargetIOSBased())
1121 return !isIPhoneOSVersionLT(3, 2);
1122 else {
1123 assert(isTargetMacOSBased() && "unexpected darwin target");
1124 return !isMacosxVersionLT(10, 6);
1125 }
1126}
1127
1128void AppleMachO::AddCudaIncludeArgs(const ArgList &DriverArgs,
1129 ArgStringList &CC1Args) const {
1130 CudaInstallation->AddCudaIncludeArgs(DriverArgs, CC1Args);
1131}
1132
1133void AppleMachO::AddHIPIncludeArgs(const ArgList &DriverArgs,
1134 ArgStringList &CC1Args) const {
1135 RocmInstallation->AddHIPIncludeArgs(DriverArgs, CC1Args);
1136}
1137
1138void AppleMachO::addSYCLIncludeArgs(const ArgList &DriverArgs,
1139 ArgStringList &CC1Args) const {
1140 SYCLInstallation->addSYCLIncludeArgs(DriverArgs, CC1Args);
1141}
1142
1143// This is just a MachO name translation routine and there's no
1144// way to join this into ARMTargetParser without breaking all
1145// other assumptions. Maybe MachO should consider standardising
1146// their nomenclature.
1147static const char *ArmMachOArchName(StringRef Arch) {
1148 return llvm::StringSwitch<const char *>(Arch)
1149 .Case("armv6k", "armv6")
1150 .Case("armv6m", "armv6m")
1151 .Case("armv5tej", "armv5")
1152 .Case("xscale", "xscale")
1153 .Case("armv4t", "armv4t")
1154 .Case("armv7", "armv7")
1155 .Cases({"armv7a", "armv7-a"}, "armv7")
1156 .Cases({"armv7r", "armv7-r"}, "armv7")
1157 .Cases({"armv7em", "armv7e-m"}, "armv7em")
1158 .Cases({"armv7k", "armv7-k"}, "armv7k")
1159 .Cases({"armv7m", "armv7-m"}, "armv7m")
1160 .Cases({"armv7s", "armv7-s"}, "armv7s")
1161 .Cases({"armv8-m.base", "armv8m.base"}, "armv8m.base")
1162 .Cases({"armv8-m.main", "armv8m.main"}, "armv8m.main")
1163 .Cases({"armv8.1-m.main", "armv8m.main"}, "armv8.1m.main")
1164 .Default(nullptr);
1165}
1166
1167static const char *ArmMachOArchNameCPU(StringRef CPU) {
1168 llvm::ARM::ArchKind ArchKind = llvm::ARM::parseCPUArch(CPU);
1169 if (ArchKind == llvm::ARM::ArchKind::INVALID)
1170 return nullptr;
1171 StringRef Arch = llvm::ARM::getArchName(ArchKind);
1172
1173 // FIXME: Make sure this MachO triple mangling is really necessary.
1174 // ARMv5* normalises to ARMv5.
1175 if (Arch.starts_with("armv5"))
1176 Arch = Arch.substr(0, 5);
1177 // ARMv6*, except ARMv6M, normalises to ARMv6.
1178 else if (Arch.starts_with("armv6") && !Arch.ends_with("6m"))
1179 Arch = Arch.substr(0, 5);
1180 // ARMv7A normalises to ARMv7.
1181 else if (Arch.ends_with("v7a"))
1182 Arch = Arch.substr(0, 5);
1183 return Arch.data();
1184}
1185
1186StringRef MachO::getMachOArchName(const ArgList &Args) const {
1187 switch (getTriple().getArch()) {
1188 default:
1190
1191 case llvm::Triple::aarch64_32:
1192 return "arm64_32";
1193
1194 case llvm::Triple::aarch64: {
1195 if (getTriple().isArm64e())
1196 return "arm64e";
1197 return "arm64";
1198 }
1199
1200 case llvm::Triple::thumb:
1201 case llvm::Triple::arm:
1202 if (const Arg *A = Args.getLastArg(options::OPT_march_EQ))
1203 if (const char *Arch = ArmMachOArchName(A->getValue()))
1204 return Arch;
1205
1206 if (const Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
1207 if (const char *Arch = ArmMachOArchNameCPU(A->getValue()))
1208 return Arch;
1209
1210 return "arm";
1211 }
1212}
1213
1214VersionTuple MachO::getLinkerVersion(const llvm::opt::ArgList &Args) const {
1215 if (LinkerVersion) {
1216#ifndef NDEBUG
1217 VersionTuple NewLinkerVersion;
1218 if (Arg *A = Args.getLastArg(options::OPT_mlinker_version_EQ))
1219 (void)NewLinkerVersion.tryParse(A->getValue());
1220 assert(NewLinkerVersion == LinkerVersion);
1221#endif
1222 return *LinkerVersion;
1223 }
1224
1225 VersionTuple NewLinkerVersion;
1226 if (Arg *A = Args.getLastArg(options::OPT_mlinker_version_EQ)) {
1227 // Rejecting subbuild version is probably not necessary, but some
1228 // existing tests depend on this.
1229 if (NewLinkerVersion.tryParse(A->getValue()) ||
1230 NewLinkerVersion.getSubbuild())
1231 getDriver().Diag(diag::err_drv_invalid_version_number)
1232 << A->getAsString(Args);
1233 }
1234
1235 LinkerVersion = NewLinkerVersion;
1236 return *LinkerVersion;
1237}
1238
1240
1243 return;
1244
1245 llvm::Triple::OSType OS = getTriple().getOS();
1246
1247 DarwinPlatformKind Platform;
1248 switch (OS) {
1249 case llvm::Triple::Darwin:
1250 case llvm::Triple::MacOSX:
1251 Platform = MacOS;
1252 break;
1253 case llvm::Triple::IOS:
1254 Platform = IPhoneOS;
1255 break;
1256 case llvm::Triple::TvOS:
1257 Platform = TvOS;
1258 break;
1259 case llvm::Triple::WatchOS:
1260 Platform = WatchOS;
1261 break;
1262 case llvm::Triple::XROS:
1263 Platform = XROS;
1264 break;
1265 case llvm::Triple::DriverKit:
1266 Platform = DriverKit;
1267 break;
1268 default:
1269 // Unknown platform; leave uninitialized.
1270 return;
1271 }
1272
1274 if (getTriple().isSimulatorEnvironment())
1275 Environment = Simulator;
1276 else if (getTriple().isMacCatalystEnvironment())
1277 Environment = MacCatalyst;
1278
1279 VersionTuple OsVer;
1280 if (Platform == MacOS) {
1281 // Record the macOS product version (e.g. macosx15), not the Darwin kernel
1282 // version (e.g. darwin24.3): version checks against the lazily-recorded
1283 // target must behave as if AddDeploymentTarget() had computed it.
1284 if (!getTriple().getMacOSXVersion(OsVer))
1285 return;
1286 } else {
1287 OsVer = getTriple().getOSVersion();
1288 }
1289 setTarget(Platform, Environment, OsVer.getMajor(),
1290 OsVer.getMinor().value_or(0), OsVer.getSubminor().value_or(0),
1291 VersionTuple());
1292 // The version above is a guess from the triple alone; AddDeploymentTarget()
1293 // may later derive a different deployment target from flags, environment
1294 // variables, or the SDK, and overwrite this initialization.
1296}
1297
1299
1301
1302void Darwin::VerifyTripleForSDK(const llvm::opt::ArgList &Args,
1303 const llvm::Triple &Triple) const {
1304 if (SDKInfo) {
1305 if (!SDKInfo->supportsTriple(Triple))
1306 getDriver().Diag(diag::warn_incompatible_sysroot)
1307 << SDKInfo->getDisplayName() << Triple.getTriple();
1308 } else if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
1309 // If there is no SDK info, assume this is building against an SDK that
1310 // predates SDKSettings.json. Try to match the triple to the SDK path.
1311 const char *isysroot = A->getValue();
1312 StringRef SDKName = getSDKName(isysroot);
1313 if (!SDKName.empty()) {
1314 bool supported = true;
1315 if (Triple.isWatchOS())
1316 supported = SDKName.starts_with("Watch");
1317 else if (Triple.isTvOS())
1318 supported = SDKName.starts_with("AppleTV");
1319 else if (Triple.isDriverKit())
1320 supported = SDKName.starts_with("DriverKit");
1321 else if (Triple.isiOS())
1322 supported = SDKName.starts_with("iPhone");
1323 else if (Triple.isMacOSX())
1324 supported = SDKName.starts_with("MacOSX");
1325 // If it's not an older SDK, then it might be a damaged SDK or a
1326 // non-standard -isysroot path. Don't try to diagnose that here.
1327
1328 if (!supported)
1329 getDriver().Diag(diag::warn_incompatible_sysroot)
1330 << SDKName << Triple.getTriple();
1331 }
1332 }
1333}
1334
1335std::string Darwin::ComputeEffectiveClangTriple(const ArgList &Args,
1336 BoundArch BA,
1337 types::ID InputType) const {
1338 llvm::Triple Triple(ComputeLLVMTriple(Args, BA, InputType));
1339
1340 // If the target isn't initialized (e.g., an unknown Darwin platform, return
1341 // the default triple). Note: we intentionally do NOT call
1342 // ensureTargetInitialized() here because this method is called before
1343 // AddDeploymentTarget() in some code paths (e.g. -print-libgcc-file-name),
1344 // and lazy init with version 0.0.0 would conflict with the real version
1345 // that AddDeploymentTarget() later sets via setTarget().
1346 if (!isTargetInitialized())
1347 return Triple.getTriple();
1348
1349 SmallString<16> Str;
1351 Str += "watchos";
1352 else if (isTargetTvOSBased())
1353 Str += "tvos";
1354 else if (isTargetDriverKit())
1355 Str += "driverkit";
1356 else if (isTargetIOSBased() || isTargetMacCatalyst())
1357 Str += "ios";
1358 else if (isTargetXROS())
1359 Str += llvm::Triple::getOSTypeName(llvm::Triple::XROS);
1360 else if (isTargetFirmware())
1361 Str += llvm::Triple::getOSTypeName(llvm::Triple::Firmware);
1362 else
1363 Str += "macosx";
1364 Str += getTripleTargetVersion().getAsString();
1365 Triple.setOSName(Str);
1366
1367 VerifyTripleForSDK(Args, Triple);
1368
1369 return Triple.getTriple();
1370}
1371
1373 switch (AC) {
1375 if (!Lipo)
1376 Lipo.reset(new tools::darwin::Lipo(*this));
1377 return Lipo.get();
1379 if (!Dsymutil)
1380 Dsymutil.reset(new tools::darwin::Dsymutil(*this));
1381 return Dsymutil.get();
1383 if (!VerifyDebug)
1384 VerifyDebug.reset(new tools::darwin::VerifyDebug(*this));
1385 return VerifyDebug.get();
1386 default:
1387 return ToolChain::getTool(AC);
1388 }
1389}
1390
1391Tool *MachO::buildLinker() const { return new tools::darwin::Linker(*this); }
1392
1394 return new tools::darwin::StaticLibTool(*this);
1395}
1396
1398 return new tools::darwin::Assembler(*this);
1399}
1400
1401DarwinClang::DarwinClang(const Driver &D, const llvm::Triple &Triple,
1402 const ArgList &Args)
1403 : Darwin(D, Triple, Args) {}
1404
1405void DarwinClang::addClangWarningOptions(ArgStringList &CC1Args) const {
1406 // Always error about undefined 'TARGET_OS_*' macros.
1407 CC1Args.push_back("-Wundef-prefix=TARGET_OS_");
1408 CC1Args.push_back("-Werror=undef-prefix");
1409
1410 // For modern targets, promote certain warnings to errors.
1411 // Lazily initialize the target if needed (e.g. when Darwin is used as
1412 // a host toolchain for device offloading).
1414 if (!isTargetInitialized())
1415 return;
1416 if (isTargetWatchOSBased() || getTriple().isArch64Bit()) {
1417 // Always enable -Wdeprecated-objc-isa-usage and promote it
1418 // to an error.
1419 CC1Args.push_back("-Wdeprecated-objc-isa-usage");
1420 CC1Args.push_back("-Werror=deprecated-objc-isa-usage");
1421
1422 // For iOS and watchOS, also error about implicit function declarations,
1423 // as that can impact calling conventions.
1424 if (!isTargetMacOS())
1425 CC1Args.push_back("-Werror=implicit-function-declaration");
1426 }
1427}
1428
1430 const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args,
1431 BoundArch BA, Action::OffloadKind DeviceOffloadKind) const {
1432
1433 Darwin::addClangTargetOptions(DriverArgs, CC1Args, BA, DeviceOffloadKind);
1434}
1435
1436/// Take a path that speculatively points into Xcode and return the
1437/// `XCODE/Contents/Developer` path if it is an Xcode path, or an empty path
1438/// otherwise.
1439static StringRef getXcodeDeveloperPath(StringRef PathIntoXcode) {
1440 static constexpr llvm::StringLiteral XcodeAppSuffix(
1441 ".app/Contents/Developer");
1442 size_t Index = PathIntoXcode.find(XcodeAppSuffix);
1443 if (Index == StringRef::npos)
1444 return "";
1445 return PathIntoXcode.take_front(Index + XcodeAppSuffix.size());
1446}
1447
1448void DarwinClang::AddLinkARCArgs(const ArgList &Args,
1449 ArgStringList &CmdArgs) const {
1450 // Avoid linking compatibility stubs on i386 mac.
1451 if (isTargetMacOSBased() && getArch() == llvm::Triple::x86)
1452 return;
1454 return;
1455 // ARC runtime is supported everywhere on arm64e.
1456 if (getTriple().isArm64e())
1457 return;
1458 if (isTargetXROS())
1459 return;
1460
1461 ObjCRuntime runtime = getDefaultObjCRuntime(/*nonfragile*/ true);
1462
1463 if ((runtime.hasNativeARC() || !isObjCAutoRefCount(Args)) &&
1464 runtime.hasSubscripting())
1465 return;
1466
1467 SmallString<128> P(getDriver().DriverExecutable);
1468 llvm::sys::path::remove_filename(P); // 'clang'
1469 llvm::sys::path::remove_filename(P); // 'bin'
1470 llvm::sys::path::append(P, "lib", "arc");
1471
1472 // 'libarclite' usually lives in the same toolchain as 'clang'. However, the
1473 // Swift open source toolchains for macOS distribute Clang without libarclite.
1474 // In that case, to allow the linker to find 'libarclite', we point to the
1475 // 'libarclite' in the XcodeDefault toolchain instead.
1476 if (!getVFS().exists(P)) {
1477 auto updatePath = [&](const Arg *A) {
1478 // Try to infer the path to 'libarclite' in the toolchain from the
1479 // specified SDK path.
1480 StringRef XcodePathForSDK = getXcodeDeveloperPath(A->getValue());
1481 if (XcodePathForSDK.empty())
1482 return false;
1483
1484 P = XcodePathForSDK;
1485 llvm::sys::path::append(P, "Toolchains/XcodeDefault.xctoolchain/usr",
1486 "lib", "arc");
1487 return getVFS().exists(P);
1488 };
1489
1490 bool updated = false;
1491 if (const Arg *A = Args.getLastArg(options::OPT_isysroot))
1492 updated = updatePath(A);
1493
1494 if (!updated) {
1495 if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
1496 updatePath(A);
1497 }
1498 }
1499
1500 CmdArgs.push_back("-force_load");
1501 llvm::sys::path::append(P, "libarclite_");
1502 // Mash in the platform.
1504 P += "watchsimulator";
1505 else if (isTargetWatchOS())
1506 P += "watchos";
1507 else if (isTargetTvOSSimulator())
1508 P += "appletvsimulator";
1509 else if (isTargetTvOS())
1510 P += "appletvos";
1511 else if (isTargetIOSSimulator())
1512 P += "iphonesimulator";
1513 else if (isTargetIPhoneOS())
1514 P += "iphoneos";
1515 else
1516 P += "macosx";
1517 P += ".a";
1518
1519 if (!getVFS().exists(P))
1520 getDriver().Diag(clang::diag::err_drv_darwin_sdk_missing_arclite) << P;
1521
1522 CmdArgs.push_back(Args.MakeArgString(P));
1523}
1524
1526 // Default to use DWARF 2 on OS X 10.10 / iOS 8 and lower.
1527 if ((isTargetMacOSBased() && isMacosxVersionLT(10, 11)) ||
1529 return 2;
1530 // Default to use DWARF 4 on OS X 10.11 - macOS 14 / iOS 9 - iOS 17.
1531 if ((isTargetMacOSBased() && isMacosxVersionLT(15)) ||
1533 (isTargetWatchOSBased() && TargetVersion < llvm::VersionTuple(11)) ||
1534 (isTargetXROS() && TargetVersion < llvm::VersionTuple(2)) ||
1535 (isTargetDriverKit() && TargetVersion < llvm::VersionTuple(24)) ||
1536 (isTargetMacOSBased() &&
1537 TargetVersion.empty())) // apple-darwin, no version.
1538 return 4;
1539 return 5;
1540}
1541
1543 // Default to an OS version on which LLDB supports debugging
1544 // -gsimple-template-names programs.
1545 if ((isTargetMacOSBased() && isMacosxVersionLT(26)) ||
1547 (isTargetWatchOSBased() && TargetVersion < llvm::VersionTuple(26)) ||
1548 (isTargetXROS() && TargetVersion < llvm::VersionTuple(26)) ||
1549 (isTargetDriverKit() && TargetVersion < llvm::VersionTuple(25)) ||
1550 (isTargetMacOSBased() &&
1551 TargetVersion.empty())) // apple-darwin, no version.
1552 return false;
1553
1554 return true;
1555}
1556
1557void MachO::AddLinkRuntimeLib(const ArgList &Args, ArgStringList &CmdArgs,
1558 StringRef Component, RuntimeLinkOptions Opts,
1559 bool IsShared) const {
1560 std::string P = getCompilerRT(
1561 Args, Component, IsShared ? ToolChain::FT_Shared : ToolChain::FT_Static);
1562
1563 // For now, allow missing resource libraries to support developers who may
1564 // not have compiler-rt checked out or integrated into their build (unless
1565 // we explicitly force linking with this library).
1566 if ((Opts & RLO_AlwaysLink) || getVFS().exists(P)) {
1567 const char *LibArg = Args.MakeArgString(P);
1568 CmdArgs.push_back(LibArg);
1569 }
1570
1571 // Adding the rpaths might negatively interact when other rpaths are involved,
1572 // so we should make sure we add the rpaths last, after all user-specified
1573 // rpaths. This is currently true from this place, but we need to be
1574 // careful if this function is ever called before user's rpaths are emitted.
1575 if (Opts & RLO_AddRPath) {
1576 assert(StringRef(P).ends_with(".dylib") && "must be a dynamic library");
1577
1578 // Add @executable_path to rpath to support having the dylib copied with
1579 // the executable.
1580 CmdArgs.push_back("-rpath");
1581 CmdArgs.push_back("@executable_path");
1582
1583 // Add the compiler-rt library's directory to rpath to support using the
1584 // dylib from the default location without copying.
1585 CmdArgs.push_back("-rpath");
1586 CmdArgs.push_back(Args.MakeArgString(llvm::sys::path::parent_path(P)));
1587 }
1588}
1589
1590std::string MachO::getCompilerRT(const ArgList &Args, StringRef Component,
1591 FileType Type, bool IsFortran) const {
1592 assert(Type != ToolChain::FT_Object &&
1593 "it doesn't make sense to ask for the compiler-rt library name as an "
1594 "object file");
1595 SmallString<64> MachOLibName = StringRef("libclang_rt");
1596 // On MachO, the builtins component is not in the library name
1597 if (Component != "builtins") {
1598 MachOLibName += '.';
1599 MachOLibName += Component;
1600 }
1601 MachOLibName += Type == ToolChain::FT_Shared ? "_dynamic.dylib" : ".a";
1602
1603 SmallString<128> FullPath(getDriver().ResourceDir);
1604 llvm::sys::path::append(FullPath, "lib", "darwin", "macho_embedded",
1605 MachOLibName);
1606 return std::string(FullPath);
1607}
1608
1609std::string Darwin::getCompilerRT(const ArgList &Args, StringRef Component,
1610 FileType Type, bool IsFortran) const {
1611 // Firmware uses the "bare metal" RT.
1613 return MachO::getCompilerRT(Args, Component, Type, IsFortran);
1614
1615 assert(Type != ToolChain::FT_Object &&
1616 "it doesn't make sense to ask for the compiler-rt library name as an "
1617 "object file");
1618 SmallString<64> DarwinLibName = StringRef("libclang_rt.");
1619 // On Darwin, the builtins component is not in the library name
1620 if (Component != "builtins") {
1621 DarwinLibName += Component;
1622 DarwinLibName += '_';
1623 }
1624 DarwinLibName += getOSLibraryNameSuffix();
1625 DarwinLibName += Type == ToolChain::FT_Shared ? "_dynamic.dylib" : ".a";
1626
1627 SmallString<128> FullPath(getDriver().ResourceDir);
1628 llvm::sys::path::append(FullPath, "lib", "darwin", DarwinLibName);
1629 return std::string(FullPath);
1630}
1631
1632StringRef Darwin::getSDKName(StringRef isysroot) {
1633 // Assume SDK has path: SOME_PATH/SDKs/PlatformXX.YY.sdk
1634 auto BeginSDK = llvm::sys::path::rbegin(isysroot);
1635 auto EndSDK = llvm::sys::path::rend(isysroot);
1636 for (auto IT = BeginSDK; IT != EndSDK; ++IT) {
1637 StringRef SDK = *IT;
1638 if (SDK.consume_back(".sdk"))
1639 return SDK;
1640 }
1641 return "";
1642}
1643
1644StringRef Darwin::getOSLibraryNameSuffix(bool IgnoreSim) const {
1645 switch (TargetPlatform) {
1647 return "osx";
1650 return "osx";
1651 return TargetEnvironment == NativeEnvironment || IgnoreSim ? "ios"
1652 : "iossim";
1654 return TargetEnvironment == NativeEnvironment || IgnoreSim ? "tvos"
1655 : "tvossim";
1657 return TargetEnvironment == NativeEnvironment || IgnoreSim ? "watchos"
1658 : "watchossim";
1660 return TargetEnvironment == NativeEnvironment || IgnoreSim ? "xros"
1661 : "xrossim";
1663 return "driverkit";
1664
1666 break;
1667 }
1668 llvm_unreachable("Unsupported platform");
1669}
1670
1671/// Check if the link command contains a symbol export directive.
1672static bool hasExportSymbolDirective(const ArgList &Args) {
1673 for (Arg *A : Args) {
1674 if (A->getOption().matches(options::OPT_exported__symbols__list))
1675 return true;
1676 if (!A->getOption().matches(options::OPT_Wl_COMMA) &&
1677 !A->getOption().matches(options::OPT_Xlinker))
1678 continue;
1679 if (A->containsValue("-exported_symbols_list") ||
1680 A->containsValue("-exported_symbol"))
1681 return true;
1682 }
1683 return false;
1684}
1685
1686/// Add an export directive for \p Symbol to the link command.
1687static void addExportedSymbol(ArgStringList &CmdArgs, const char *Symbol) {
1688 CmdArgs.push_back("-exported_symbol");
1689 CmdArgs.push_back(Symbol);
1690}
1691
1692/// Add a sectalign directive for \p Segment and \p Section to the maximum
1693/// expected page size for Darwin.
1694///
1695/// On iPhone 6+ the max supported page size is 16K. On macOS, the max is 4K.
1696/// Use a common alignment constant (16K) for now, and reduce the alignment on
1697/// macOS if it proves important.
1698static void addSectalignToPage(const ArgList &Args, ArgStringList &CmdArgs,
1699 StringRef Segment, StringRef Section) {
1700 for (const char *A : {"-sectalign", Args.MakeArgString(Segment),
1701 Args.MakeArgString(Section), "0x4000"})
1702 CmdArgs.push_back(A);
1703}
1704
1705void Darwin::addProfileRTLibs(const ArgList &Args,
1706 ArgStringList &CmdArgs) const {
1707 if (!needsProfileRT(Args) && !needsGCovInstrumentation(Args))
1708 return;
1709
1710 AddLinkRuntimeLib(Args, CmdArgs, "profile",
1712
1713 bool ForGCOV = needsGCovInstrumentation(Args);
1714
1715 // If we have a symbol export directive and we're linking in the profile
1716 // runtime, automatically export symbols necessary to implement some of the
1717 // runtime's functionality.
1718 if (hasExportSymbolDirective(Args) && ForGCOV) {
1719 addExportedSymbol(CmdArgs, "___gcov_dump");
1720 addExportedSymbol(CmdArgs, "___gcov_reset");
1721 addExportedSymbol(CmdArgs, "_writeout_fn_list");
1722 addExportedSymbol(CmdArgs, "_reset_fn_list");
1723 }
1724
1725 // Align __llvm_prf_{cnts,bits,data} sections to the maximum expected page
1726 // alignment. This allows profile counters to be mmap()'d to disk. Note that
1727 // it's not enough to just page-align __llvm_prf_cnts: the following section
1728 // must also be page-aligned so that its data is not clobbered by mmap().
1729 //
1730 // The section alignment is only needed when continuous profile sync is
1731 // enabled, but this is expected to be the default in Xcode. Specifying the
1732 // extra alignment also allows the same binary to be used with/without sync
1733 // enabled.
1734 if (!ForGCOV) {
1735 for (auto IPSK : {llvm::IPSK_cnts, llvm::IPSK_bitmap, llvm::IPSK_data}) {
1737 Args, CmdArgs, "__DATA",
1738 llvm::getInstrProfSectionName(IPSK, llvm::Triple::MachO,
1739 /*AddSegmentInfo=*/false));
1740 }
1741 }
1742}
1743
1744void DarwinClang::AddLinkSanitizerLibArgs(const ArgList &Args,
1745 ArgStringList &CmdArgs,
1746 StringRef Sanitizer,
1747 bool Shared) const {
1748 auto RLO = RuntimeLinkOptions(RLO_AlwaysLink | (Shared ? RLO_AddRPath : 0U));
1749 AddLinkRuntimeLib(Args, CmdArgs, Sanitizer, RLO, Shared);
1750}
1751
1753 const ArgList &Args) const {
1754 if (Arg* A = Args.getLastArg(options::OPT_rtlib_EQ)) {
1755 StringRef Value = A->getValue();
1756 if (Value != "compiler-rt" && Value != "platform")
1757 getDriver().Diag(clang::diag::err_drv_unsupported_rtlib_for_platform)
1758 << Value << "darwin";
1759 }
1760
1761 return ToolChain::GetRuntimeLibType(Args);
1762}
1763
1764void DarwinClang::AddLinkRuntimeLibArgs(const ArgList &Args,
1765 ArgStringList &CmdArgs,
1766 bool ForceLinkBuiltinRT) const {
1767 // Firmware uses the "bare metal" runtime lib.
1769 return MachO::AddLinkRuntimeLibArgs(Args, CmdArgs, ForceLinkBuiltinRT);
1770
1771 // Call once to ensure diagnostic is printed if wrong value was specified
1772 GetRuntimeLibType(Args);
1773
1774 // Darwin doesn't support real static executables, don't link any runtime
1775 // libraries with -static.
1776 if (Args.hasArg(options::OPT_static) ||
1777 Args.hasArg(options::OPT_fapple_kext) ||
1778 Args.hasArg(options::OPT_mkernel)) {
1779 if (ForceLinkBuiltinRT)
1780 AddLinkRuntimeLib(Args, CmdArgs, "builtins");
1781 return;
1782 }
1783
1784 // Reject -static-libgcc for now, we can deal with this when and if someone
1785 // cares. This is useful in situations where someone wants to statically link
1786 // something like libstdc++, and needs its runtime support routines.
1787 if (const Arg *A = Args.getLastArg(options::OPT_static_libgcc)) {
1788 getDriver().Diag(diag::err_drv_unsupported_opt) << A->getAsString(Args);
1789 return;
1790 }
1791
1792 const SanitizerArgs &Sanitize = getSanitizerArgs(Args);
1793
1794 if (!Sanitize.needsSharedRt()) {
1795 const char *sanitizer = nullptr;
1796 if (Sanitize.needsUbsanRt()) {
1797 sanitizer = "UndefinedBehaviorSanitizer";
1798 } else if (Sanitize.needsRtsanRt()) {
1799 sanitizer = "RealtimeSanitizer";
1800 } else if (Sanitize.needsAsanRt()) {
1801 sanitizer = "AddressSanitizer";
1802 } else if (Sanitize.needsTsanRt()) {
1803 sanitizer = "ThreadSanitizer";
1804 }
1805 if (sanitizer) {
1806 getDriver().Diag(diag::err_drv_unsupported_static_sanitizer_darwin)
1807 << sanitizer;
1808 return;
1809 }
1810 }
1811
1812 if (Sanitize.linkRuntimes()) {
1813 if (Sanitize.needsAsanRt()) {
1814 if (Sanitize.needsStableAbi()) {
1815 AddLinkSanitizerLibArgs(Args, CmdArgs, "asan_abi", /*shared=*/false);
1816 } else {
1817 assert(Sanitize.needsSharedRt() &&
1818 "Static sanitizer runtimes not supported");
1819 AddLinkSanitizerLibArgs(Args, CmdArgs, "asan");
1820 }
1821 }
1822 if (Sanitize.needsRtsanRt()) {
1823 assert(Sanitize.needsSharedRt() &&
1824 "Static sanitizer runtimes not supported");
1825 AddLinkSanitizerLibArgs(Args, CmdArgs, "rtsan");
1826 }
1827 if (Sanitize.needsLsanRt())
1828 AddLinkSanitizerLibArgs(Args, CmdArgs, "lsan");
1829 if (Sanitize.needsUbsanRt()) {
1830 assert(Sanitize.needsSharedRt() &&
1831 "Static sanitizer runtimes not supported");
1832 AddLinkSanitizerLibArgs(
1833 Args, CmdArgs,
1834 Sanitize.requiresMinimalRuntime() ? "ubsan_minimal" : "ubsan");
1835 }
1836 if (Sanitize.needsTsanRt()) {
1837 assert(Sanitize.needsSharedRt() &&
1838 "Static sanitizer runtimes not supported");
1839 AddLinkSanitizerLibArgs(Args, CmdArgs, "tsan");
1840 }
1841 if (Sanitize.needsTysanRt())
1842 AddLinkSanitizerLibArgs(Args, CmdArgs, "tysan");
1843 if (Sanitize.needsFuzzer() && !Args.hasArg(options::OPT_dynamiclib)) {
1844 AddLinkSanitizerLibArgs(Args, CmdArgs, "fuzzer", /*shared=*/false);
1845
1846 // Libfuzzer is written in C++ and requires libcxx.
1847 // Since darwin::Linker::ConstructJob already adds -lc++ for clang++
1848 // by default if ShouldLinkCXXStdlib(Args), we only add the option if
1849 // !ShouldLinkCXXStdlib(Args). This avoids duplicate library errors
1850 // on Darwin.
1851 if (!ShouldLinkCXXStdlib(Args))
1852 AddCXXStdlibLibArgs(Args, CmdArgs);
1853 }
1854 if (Sanitize.needsStatsRt()) {
1855 AddLinkRuntimeLib(Args, CmdArgs, "stats_client", RLO_AlwaysLink);
1856 AddLinkSanitizerLibArgs(Args, CmdArgs, "stats");
1857 }
1858 }
1859
1860 if (Sanitize.needsMemProfRt())
1861 if (hasExportSymbolDirective(Args))
1863 CmdArgs,
1864 llvm::memprof::getMemprofOptionsSymbolDarwinLinkageName().data());
1865
1866 const XRayArgs &XRay = getXRayArgs(Args);
1867 if (XRay.needsXRayRt()) {
1868 AddLinkRuntimeLib(Args, CmdArgs, "xray");
1869 AddLinkRuntimeLib(Args, CmdArgs, "xray-basic");
1870 AddLinkRuntimeLib(Args, CmdArgs, "xray-fdr");
1871 }
1872
1873 if (isTargetDriverKit() && !Args.hasArg(options::OPT_nodriverkitlib)) {
1874 CmdArgs.push_back("-framework");
1875 CmdArgs.push_back("DriverKit");
1876 }
1877
1878 // Otherwise link libSystem, then the dynamic runtime library, and finally any
1879 // target specific static runtime library.
1880 if (!isTargetDriverKit())
1881 CmdArgs.push_back("-lSystem");
1882
1883 // Select the dynamic runtime library and the target specific static library.
1884 // Some old Darwin versions put builtins, libunwind, and some other stuff in
1885 // libgcc_s.1.dylib. MacOS X 10.6 and iOS 5 moved those functions to
1886 // libSystem, and made libgcc_s.1.dylib a stub. We never link libgcc_s when
1887 // building for aarch64 or iOS simulator, since libgcc_s was made obsolete
1888 // before either existed.
1889 if (getTriple().getArch() != llvm::Triple::aarch64 &&
1893 CmdArgs.push_back("-lgcc_s.1");
1894 AddLinkRuntimeLib(Args, CmdArgs, "builtins");
1895}
1896
1897/// Returns the most appropriate macOS target version for the current process.
1898///
1899/// If the macOS SDK version is the same or earlier than the system version,
1900/// then the SDK version is returned. Otherwise the system version is returned.
1901static std::string getSystemOrSDKMacOSVersion(StringRef MacOSSDKVersion) {
1902 llvm::Triple SystemTriple(llvm::sys::getProcessTriple());
1903 if (!SystemTriple.isMacOSX())
1904 return std::string(MacOSSDKVersion);
1905 VersionTuple SystemVersion;
1906 SystemTriple.getMacOSXVersion(SystemVersion);
1907
1908 unsigned Major, Minor, Micro;
1909 bool HadExtra;
1910 if (!Driver::GetReleaseVersion(MacOSSDKVersion, Major, Minor, Micro,
1911 HadExtra))
1912 return std::string(MacOSSDKVersion);
1913 VersionTuple SDKVersion(Major, Minor, Micro);
1914
1915 if (SDKVersion > SystemVersion)
1916 return SystemVersion.getAsString();
1917 return std::string(MacOSSDKVersion);
1918}
1919
1920namespace {
1921
1922/// The Darwin OS and version that was selected or inferred from arguments or
1923/// environment.
1924struct DarwinPlatform {
1925 enum SourceKind {
1926 /// The OS was specified using the -target argument.
1927 TargetArg,
1928 /// The OS was specified using the -mtargetos= argument.
1929 MTargetOSArg,
1930 /// The OS was specified using the -m<os>-version-min argument.
1931 OSVersionArg,
1932 /// The OS was specified using the OS_DEPLOYMENT_TARGET environment.
1933 DeploymentTargetEnv,
1934 /// The OS was inferred from the SDK.
1935 InferredFromSDK,
1936 /// The OS was inferred from the -arch.
1937 InferredFromArch
1938 };
1939
1940 using DarwinPlatformKind = Darwin::DarwinPlatformKind;
1941 using DarwinEnvironmentKind = Darwin::DarwinEnvironmentKind;
1942
1943 DarwinPlatformKind getPlatform() const { return Platform; }
1944
1945 DarwinEnvironmentKind getEnvironment() const { return Environment; }
1946
1947 void setEnvironment(DarwinEnvironmentKind Kind) {
1948 Environment = Kind;
1949 InferSimulatorFromArch = false;
1950 }
1951
1952 const VersionTuple getOSVersion() const {
1953 return UnderlyingOSVersion.value_or(VersionTuple());
1954 }
1955
1956 VersionTuple takeOSVersion() {
1957 assert(UnderlyingOSVersion.has_value() &&
1958 "attempting to get an unset OS version");
1959 VersionTuple Result = *UnderlyingOSVersion;
1960 UnderlyingOSVersion.reset();
1961 return Result;
1962 }
1963 bool isValidOSVersion() const {
1964 return llvm::Triple::isValidVersionForOS(getOSFromPlatform(Platform),
1965 getOSVersion());
1966 }
1967
1968 VersionTuple getCanonicalOSVersion() const {
1969 return llvm::Triple::getCanonicalVersionForOS(
1970 getOSFromPlatform(Platform), getOSVersion(), /*IsInValidRange=*/true);
1971 }
1972
1973 void setOSVersion(const VersionTuple &Version) {
1974 UnderlyingOSVersion = Version;
1975 }
1976
1977 bool hasOSVersion() const { return UnderlyingOSVersion.has_value(); }
1978
1979 VersionTuple getZipperedOSVersion() const {
1980 assert(Environment == DarwinEnvironmentKind::MacCatalyst &&
1981 "zippered target version is specified only for Mac Catalyst");
1982 return ZipperedOSVersion;
1983 }
1984
1985 /// Returns true if the target OS was explicitly specified.
1986 bool isExplicitlySpecified() const { return Kind <= DeploymentTargetEnv; }
1987
1988 /// Returns true if the simulator environment can be inferred from the arch.
1989 bool canInferSimulatorFromArch() const { return InferSimulatorFromArch; }
1990
1991 const std::optional<llvm::Triple> &getTargetVariantTriple() const {
1992 return TargetVariantTriple;
1993 }
1994
1995 /// Adds the -m<os>-version-min argument to the compiler invocation.
1996 void addOSVersionMinArgument(DerivedArgList &Args, const OptTable &Opts) {
1997 auto &[Arg, OSVersionStr] = Arguments;
1998 if (Arg)
1999 return;
2000 assert(Kind != TargetArg && Kind != MTargetOSArg && Kind != OSVersionArg &&
2001 "Invalid kind");
2002 options::ID Opt;
2003 switch (Platform) {
2004 case DarwinPlatformKind::MacOS:
2005 Opt = options::OPT_mmacos_version_min_EQ;
2006 break;
2007 case DarwinPlatformKind::IPhoneOS:
2008 Opt = options::OPT_mios_version_min_EQ;
2009 break;
2010 case DarwinPlatformKind::TvOS:
2011 Opt = options::OPT_mtvos_version_min_EQ;
2012 break;
2013 case DarwinPlatformKind::WatchOS:
2014 Opt = options::OPT_mwatchos_version_min_EQ;
2015 break;
2016 default:
2017 // New platforms always explicitly provide a version in the triple.
2018 return;
2019 }
2020 Arg = Args.MakeJoinedArg(nullptr, Opts.getOption(Opt), OSVersionStr);
2021 Args.append(Arg);
2022 }
2023
2024 /// Returns the OS version with the argument / environment variable that
2025 /// specified it.
2026 std::string getAsString(DerivedArgList &Args, const OptTable &Opts) {
2027 auto &[Arg, OSVersionStr] = Arguments;
2028 switch (Kind) {
2029 case TargetArg:
2030 case MTargetOSArg:
2031 case OSVersionArg:
2032 assert(Arg && "OS version argument not yet inferred");
2033 return Arg->getAsString(Args);
2034 case DeploymentTargetEnv:
2035 return (llvm::Twine(EnvVarName) + "=" + OSVersionStr).str();
2036 case InferredFromSDK:
2037 case InferredFromArch:
2038 llvm_unreachable("Cannot print arguments for inferred OS version");
2039 }
2040 llvm_unreachable("Unsupported Darwin Source Kind");
2041 }
2042
2043 // Returns the inferred source of how the OS version was resolved.
2044 std::string getInferredSource() {
2045 assert(!isExplicitlySpecified() && "OS version was not inferred");
2046 return InferredSource.str();
2047 }
2048
2049 void setEnvironment(llvm::Triple::EnvironmentType EnvType,
2050 const VersionTuple &OSVersion,
2051 const std::optional<DarwinSDKInfo> &SDKInfo) {
2052 switch (EnvType) {
2053 case llvm::Triple::Simulator:
2054 Environment = DarwinEnvironmentKind::Simulator;
2055 break;
2056 case llvm::Triple::MacABI: {
2057 Environment = DarwinEnvironmentKind::MacCatalyst;
2058 // The minimum native macOS target for MacCatalyst is macOS 10.15.
2059 ZipperedOSVersion = VersionTuple(10, 15);
2060 if (hasOSVersion() && SDKInfo) {
2061 if (const auto *MacCatalystToMacOSMapping = SDKInfo->getVersionMapping(
2063 if (auto MacOSVersion = MacCatalystToMacOSMapping->map(
2064 OSVersion, ZipperedOSVersion, std::nullopt)) {
2065 ZipperedOSVersion = *MacOSVersion;
2066 }
2067 }
2068 }
2069 // In a zippered build, we could be building for a macOS target that's
2070 // lower than the version that's implied by the OS version. In that case
2071 // we need to use the minimum version as the native target version.
2072 if (TargetVariantTriple) {
2073 auto TargetVariantVersion = TargetVariantTriple->getOSVersion();
2074 if (TargetVariantVersion.getMajor()) {
2075 if (TargetVariantVersion < ZipperedOSVersion)
2076 ZipperedOSVersion = std::move(TargetVariantVersion);
2077 }
2078 }
2079 break;
2080 }
2081 default:
2082 break;
2083 }
2084 }
2085
2086 static DarwinPlatform
2087 createFromTarget(const llvm::Triple &TT, Arg *A,
2088 std::optional<llvm::Triple> TargetVariantTriple,
2089 const std::optional<DarwinSDKInfo> &SDKInfo) {
2090 DarwinPlatform Result(TargetArg, getPlatformFromOS(TT.getOS()),
2091 TT.getOSVersion(), A);
2092 VersionTuple OsVersion = TT.getOSVersion();
2093 Result.TargetVariantTriple = std::move(TargetVariantTriple);
2094 Result.setEnvironment(TT.getEnvironment(), OsVersion, SDKInfo);
2095 return Result;
2096 }
2097 static DarwinPlatform
2098 createFromMTargetOS(llvm::Triple::OSType OS, VersionTuple OSVersion,
2099 llvm::Triple::EnvironmentType Environment, Arg *A,
2100 const std::optional<DarwinSDKInfo> &SDKInfo) {
2101 DarwinPlatform Result(MTargetOSArg, getPlatformFromOS(OS), OSVersion, A);
2102 Result.InferSimulatorFromArch = false;
2103 Result.setEnvironment(Environment, OSVersion, SDKInfo);
2104 return Result;
2105 }
2106 static DarwinPlatform createOSVersionArg(DarwinPlatformKind Platform, Arg *A,
2107 bool IsSimulator) {
2108 DarwinPlatform Result{OSVersionArg, Platform,
2109 getVersionFromString(A->getValue()), A};
2110 if (IsSimulator)
2111 Result.Environment = DarwinEnvironmentKind::Simulator;
2112 return Result;
2113 }
2114 static DarwinPlatform createDeploymentTargetEnv(DarwinPlatformKind Platform,
2115 StringRef EnvVarName,
2116 StringRef OSVersion) {
2117 DarwinPlatform Result(DeploymentTargetEnv, Platform,
2118 getVersionFromString(OSVersion));
2119 Result.EnvVarName = EnvVarName;
2120 return Result;
2121 }
2122 static DarwinPlatform createFromSDKInfo(StringRef SDKRoot,
2123 const DarwinSDKInfo &SDKInfo) {
2124 const llvm::Triple &PlatformTriple = SDKInfo.getCanonicalPlatformTriple();
2125 const llvm::Triple::OSType OS = PlatformTriple.getOS();
2126 VersionTuple Version = SDKInfo.getDefaultDeploymentTarget();
2127 if (OS == llvm::Triple::MacOSX)
2128 Version = getVersionFromString(
2129 getSystemOrSDKMacOSVersion(Version.getAsString()));
2130 DarwinPlatform Result(InferredFromSDK, getPlatformFromOS(OS), Version);
2131 Result.Environment = getEnvKindFromEnvType(PlatformTriple.getEnvironment());
2132 Result.InferSimulatorFromArch = false;
2133 Result.InferredSource = SDKRoot;
2134 return Result;
2135 }
2136 static DarwinPlatform createFromSDK(StringRef SDKRoot,
2137 DarwinPlatformKind Platform,
2138 StringRef Value,
2139 bool IsSimulator = false) {
2140 DarwinPlatform Result(InferredFromSDK, Platform,
2141 getVersionFromString(Value));
2142 if (IsSimulator)
2143 Result.Environment = DarwinEnvironmentKind::Simulator;
2144 Result.InferSimulatorFromArch = false;
2145 Result.InferredSource = SDKRoot;
2146 return Result;
2147 }
2148 static DarwinPlatform createFromArch(StringRef Arch, llvm::Triple::OSType OS,
2149 VersionTuple Version) {
2150 auto Result =
2151 DarwinPlatform(InferredFromArch, getPlatformFromOS(OS), Version);
2152 Result.InferredSource = Arch;
2153 return Result;
2154 }
2155
2156 /// Constructs an inferred SDKInfo value based on the version inferred from
2157 /// the SDK path itself. Only works for values that were created by inferring
2158 /// the platform from the SDKPath.
2159 DarwinSDKInfo inferSDKInfo() {
2160 assert(Kind == InferredFromSDK && "can infer SDK info only");
2161 llvm::Triple::OSType OS = getOSFromPlatform(Platform);
2162 llvm::Triple::EnvironmentType EnvironmentType =
2163 getEnvTypeFromEnvKind(Environment);
2164 return DarwinSDKInfo(OS, EnvironmentType, getOSVersion(),
2165 getDisplayName(Platform, Environment, getOSVersion()),
2166 /*MaximumDeploymentTarget=*/
2167 VersionTuple(getOSVersion().getMajor(), 0, 99));
2168 }
2169
2170private:
2171 DarwinPlatform(SourceKind Kind, DarwinPlatformKind Platform, Arg *Argument)
2172 : Kind(Kind), Platform(Platform),
2173 Arguments({Argument, VersionTuple().getAsString()}) {}
2174 DarwinPlatform(SourceKind Kind, DarwinPlatformKind Platform,
2175 VersionTuple Value, Arg *Argument = nullptr)
2176 : Kind(Kind), Platform(Platform),
2177 Arguments({Argument, Value.getAsString()}) {
2178 if (!Value.empty())
2179 UnderlyingOSVersion = Value;
2180 }
2181
2182 static VersionTuple getVersionFromString(const StringRef Input) {
2183 llvm::VersionTuple Version;
2184 bool IsValid = !Version.tryParse(Input);
2185 assert(IsValid && "unable to convert input version to version tuple");
2186 (void)IsValid;
2187 return Version;
2188 }
2189
2190 static DarwinPlatformKind getPlatformFromOS(llvm::Triple::OSType OS) {
2191 switch (OS) {
2192 case llvm::Triple::Darwin:
2193 case llvm::Triple::MacOSX:
2194 return DarwinPlatformKind::MacOS;
2195 case llvm::Triple::IOS:
2196 return DarwinPlatformKind::IPhoneOS;
2197 case llvm::Triple::TvOS:
2198 return DarwinPlatformKind::TvOS;
2199 case llvm::Triple::WatchOS:
2200 return DarwinPlatformKind::WatchOS;
2201 case llvm::Triple::XROS:
2202 return DarwinPlatformKind::XROS;
2203 case llvm::Triple::DriverKit:
2204 return DarwinPlatformKind::DriverKit;
2205 case llvm::Triple::Firmware:
2206 return DarwinPlatformKind::Firmware;
2207 default:
2208 llvm_unreachable("Unable to infer Darwin variant");
2209 }
2210 }
2211
2212 static llvm::Triple::OSType getOSFromPlatform(DarwinPlatformKind Platform) {
2213 switch (Platform) {
2214 case DarwinPlatformKind::MacOS:
2215 return llvm::Triple::MacOSX;
2216 case DarwinPlatformKind::IPhoneOS:
2217 return llvm::Triple::IOS;
2218 case DarwinPlatformKind::TvOS:
2219 return llvm::Triple::TvOS;
2220 case DarwinPlatformKind::WatchOS:
2221 return llvm::Triple::WatchOS;
2222 case DarwinPlatformKind::DriverKit:
2223 return llvm::Triple::DriverKit;
2224 case DarwinPlatformKind::XROS:
2225 return llvm::Triple::XROS;
2226 case DarwinPlatformKind::Firmware:
2227 return llvm::Triple::Firmware;
2228 }
2229 llvm_unreachable("Unknown DarwinPlatformKind enum");
2230 }
2231
2232 static DarwinEnvironmentKind
2233 getEnvKindFromEnvType(llvm::Triple::EnvironmentType EnvironmentType) {
2234 switch (EnvironmentType) {
2235 case llvm::Triple::UnknownEnvironment:
2236 return DarwinEnvironmentKind::NativeEnvironment;
2237 case llvm::Triple::Simulator:
2238 return DarwinEnvironmentKind::Simulator;
2239 case llvm::Triple::MacABI:
2240 return DarwinEnvironmentKind::MacCatalyst;
2241 default:
2242 llvm_unreachable("Unable to infer Darwin environment");
2243 }
2244 }
2245
2246 static llvm::Triple::EnvironmentType
2247 getEnvTypeFromEnvKind(DarwinEnvironmentKind EnvironmentKind) {
2248 switch (EnvironmentKind) {
2249 case DarwinEnvironmentKind::NativeEnvironment:
2250 return llvm::Triple::UnknownEnvironment;
2251 case DarwinEnvironmentKind::Simulator:
2252 return llvm::Triple::Simulator;
2253 case DarwinEnvironmentKind::MacCatalyst:
2254 return llvm::Triple::MacABI;
2255 }
2256 llvm_unreachable("Unknown DarwinEnvironmentKind enum");
2257 }
2258
2259 static std::string getDisplayName(DarwinPlatformKind TargetPlatform,
2260 DarwinEnvironmentKind TargetEnvironment,
2261 VersionTuple Version) {
2262 SmallVector<std::string, 3> Components;
2263 switch (TargetPlatform) {
2264 case DarwinPlatformKind::MacOS:
2265 Components.push_back("macOS");
2266 break;
2267 case DarwinPlatformKind::IPhoneOS:
2268 Components.push_back("iOS");
2269 break;
2270 case DarwinPlatformKind::TvOS:
2271 Components.push_back("tvOS");
2272 break;
2273 case DarwinPlatformKind::WatchOS:
2274 Components.push_back("watchOS");
2275 break;
2276 case DarwinPlatformKind::DriverKit:
2277 Components.push_back("DriverKit");
2278 break;
2279 default:
2280 llvm::reportFatalUsageError(Twine("Platform: '") +
2281 std::to_string(TargetPlatform) +
2282 "' is unsupported when inferring SDK Info.");
2283 }
2284 switch (TargetEnvironment) {
2285 case DarwinEnvironmentKind::NativeEnvironment:
2286 break;
2287 case DarwinEnvironmentKind::Simulator:
2288 Components.push_back("Simulator");
2289 break;
2290 default:
2291 llvm::reportFatalUsageError(Twine("Environment: '") +
2292 std::to_string(TargetEnvironment) +
2293 "' is unsupported when inferring SDK Info.");
2294 }
2295 Components.push_back(Version.getAsString());
2296 return join(Components, " ");
2297 }
2298
2299 SourceKind Kind;
2300 DarwinPlatformKind Platform;
2301 DarwinEnvironmentKind Environment = DarwinEnvironmentKind::NativeEnvironment;
2302 // When compiling for a zippered target, this means both target &
2303 // target variant is set on the command line, ZipperedOSVersion holds the
2304 // OSVersion tied to the main target value.
2305 VersionTuple ZipperedOSVersion;
2306 // We allow multiple ways to set or default the OS
2307 // version used for compilation. When set, UnderlyingOSVersion represents
2308 // the intended version to match the platform information computed from
2309 // arguments.
2310 std::optional<VersionTuple> UnderlyingOSVersion;
2311 bool InferSimulatorFromArch = true;
2312 std::pair<Arg *, std::string> Arguments;
2313 StringRef EnvVarName;
2314 // If the DarwinPlatform information is derived from an inferred source, this
2315 // captures what that source input was for error reporting.
2316 StringRef InferredSource;
2317 // When compiling for a zippered target, this value represents the target
2318 // triple encoded in the target variant.
2319 std::optional<llvm::Triple> TargetVariantTriple;
2320};
2321
2322/// Returns the deployment target that's specified using the -m<os>-version-min
2323/// argument.
2324std::optional<DarwinPlatform>
2325getDeploymentTargetFromOSVersionArg(DerivedArgList &Args,
2326 const Driver &TheDriver) {
2327 Arg *macOSVersion = Args.getLastArg(options::OPT_mmacos_version_min_EQ);
2328 Arg *iOSVersion = Args.getLastArg(options::OPT_mios_version_min_EQ,
2329 options::OPT_mios_simulator_version_min_EQ);
2330 Arg *TvOSVersion =
2331 Args.getLastArg(options::OPT_mtvos_version_min_EQ,
2332 options::OPT_mtvos_simulator_version_min_EQ);
2333 Arg *WatchOSVersion =
2334 Args.getLastArg(options::OPT_mwatchos_version_min_EQ,
2335 options::OPT_mwatchos_simulator_version_min_EQ);
2336
2337 auto GetDarwinPlatform =
2338 [&](DarwinPlatform::DarwinPlatformKind Platform, Arg *VersionArg,
2339 bool IsSimulator) -> std::optional<DarwinPlatform> {
2340 if (StringRef(VersionArg->getValue()).empty()) {
2341 TheDriver.Diag(diag::err_drv_missing_version_number)
2342 << VersionArg->getAsString(Args);
2343 return std::nullopt;
2344 }
2345 return DarwinPlatform::createOSVersionArg(Platform, VersionArg,
2346 /*IsSimulator=*/IsSimulator);
2347 };
2348
2349 if (macOSVersion) {
2350 if (iOSVersion || TvOSVersion || WatchOSVersion) {
2351 TheDriver.Diag(diag::err_drv_argument_not_allowed_with)
2352 << macOSVersion->getAsString(Args)
2353 << (iOSVersion ? iOSVersion
2354 : TvOSVersion ? TvOSVersion : WatchOSVersion)
2355 ->getAsString(Args);
2356 }
2357 return GetDarwinPlatform(Darwin::MacOS, macOSVersion,
2358 /*IsSimulator=*/false);
2359
2360 } else if (iOSVersion) {
2361 if (TvOSVersion || WatchOSVersion) {
2362 TheDriver.Diag(diag::err_drv_argument_not_allowed_with)
2363 << iOSVersion->getAsString(Args)
2364 << (TvOSVersion ? TvOSVersion : WatchOSVersion)->getAsString(Args);
2365 }
2366 return GetDarwinPlatform(Darwin::IPhoneOS, iOSVersion,
2367 iOSVersion->getOption().getID() ==
2368 options::OPT_mios_simulator_version_min_EQ);
2369 } else if (TvOSVersion) {
2370 if (WatchOSVersion) {
2371 TheDriver.Diag(diag::err_drv_argument_not_allowed_with)
2372 << TvOSVersion->getAsString(Args)
2373 << WatchOSVersion->getAsString(Args);
2374 }
2375 return GetDarwinPlatform(Darwin::TvOS, TvOSVersion,
2376 TvOSVersion->getOption().getID() ==
2377 options::OPT_mtvos_simulator_version_min_EQ);
2378 } else if (WatchOSVersion)
2379 return GetDarwinPlatform(
2380 Darwin::WatchOS, WatchOSVersion,
2381 WatchOSVersion->getOption().getID() ==
2382 options::OPT_mwatchos_simulator_version_min_EQ);
2383 return std::nullopt;
2384}
2385
2386/// Returns the deployment target that's specified using the
2387/// OS_DEPLOYMENT_TARGET environment variable.
2388std::optional<DarwinPlatform>
2389getDeploymentTargetFromEnvironmentVariables(const Driver &TheDriver,
2390 const llvm::Triple &Triple) {
2391 const char *EnvVars[] = {
2392 "MACOSX_DEPLOYMENT_TARGET",
2393 "IPHONEOS_DEPLOYMENT_TARGET",
2394 "TVOS_DEPLOYMENT_TARGET",
2395 "WATCHOS_DEPLOYMENT_TARGET",
2396 "DRIVERKIT_DEPLOYMENT_TARGET",
2397 "XROS_DEPLOYMENT_TARGET"
2398 };
2399 std::string Targets[std::size(EnvVars)];
2400 for (const auto &I : llvm::enumerate(llvm::ArrayRef(EnvVars))) {
2401 if (char *Env = ::getenv(I.value()))
2402 Targets[I.index()] = Env;
2403 }
2404
2405 // Allow conflicts among OSX and iOS for historical reasons, but choose the
2406 // default platform.
2407 if (!Targets[Darwin::MacOS].empty() &&
2408 (!Targets[Darwin::IPhoneOS].empty() ||
2409 !Targets[Darwin::WatchOS].empty() || !Targets[Darwin::TvOS].empty() ||
2410 !Targets[Darwin::XROS].empty())) {
2411 if (Triple.getArch() == llvm::Triple::arm ||
2412 Triple.getArch() == llvm::Triple::aarch64 ||
2413 Triple.getArch() == llvm::Triple::thumb)
2414 Targets[Darwin::MacOS] = "";
2415 else
2416 Targets[Darwin::IPhoneOS] = Targets[Darwin::WatchOS] =
2417 Targets[Darwin::TvOS] = Targets[Darwin::XROS] = "";
2418 } else {
2419 // Don't allow conflicts in any other platform.
2420 unsigned FirstTarget = std::size(Targets);
2421 for (unsigned I = 0; I != std::size(Targets); ++I) {
2422 if (Targets[I].empty())
2423 continue;
2424 if (FirstTarget == std::size(Targets))
2425 FirstTarget = I;
2426 else
2427 TheDriver.Diag(diag::err_drv_conflicting_deployment_targets)
2428 << Targets[FirstTarget] << Targets[I];
2429 }
2430 }
2431
2432 for (const auto &Target : llvm::enumerate(llvm::ArrayRef(Targets))) {
2433 if (!Target.value().empty())
2434 return DarwinPlatform::createDeploymentTargetEnv(
2435 (Darwin::DarwinPlatformKind)Target.index(), EnvVars[Target.index()],
2436 Target.value());
2437 }
2438 return std::nullopt;
2439}
2440
2441/// Tries to infer the deployment target from the SDK specified by -isysroot
2442/// (or SDKROOT). Uses the version specified in the SDKSettings.json file if
2443/// it's available.
2444std::optional<DarwinPlatform>
2445inferDeploymentTargetFromSDK(DerivedArgList &Args,
2446 const std::optional<DarwinSDKInfo> &SDKInfo) {
2447 const Arg *A = Args.getLastArg(options::OPT_isysroot);
2448 if (!A)
2449 return std::nullopt;
2450 StringRef isysroot = A->getValue();
2451 if (SDKInfo)
2452 return DarwinPlatform::createFromSDKInfo(isysroot, *SDKInfo);
2453
2454 StringRef SDK = Darwin::getSDKName(isysroot);
2455 if (!SDK.size())
2456 return std::nullopt;
2457
2458 std::string Version;
2459 // Slice the version number out.
2460 // Version number is between the first and the last number.
2461 size_t StartVer = SDK.find_first_of("0123456789");
2462 size_t EndVer = SDK.find_last_of("0123456789");
2463 if (StartVer != StringRef::npos && EndVer > StartVer)
2464 Version = std::string(SDK.slice(StartVer, EndVer + 1));
2465 if (Version.empty())
2466 return std::nullopt;
2467
2468 if (SDK.starts_with("iPhoneOS") || SDK.starts_with("iPhoneSimulator"))
2469 return DarwinPlatform::createFromSDK(
2470 isysroot, Darwin::IPhoneOS, Version,
2471 /*IsSimulator=*/SDK.starts_with("iPhoneSimulator"));
2472 else if (SDK.starts_with("MacOSX"))
2473 return DarwinPlatform::createFromSDK(isysroot, Darwin::MacOS,
2475 else if (SDK.starts_with("WatchOS") || SDK.starts_with("WatchSimulator"))
2476 return DarwinPlatform::createFromSDK(
2477 isysroot, Darwin::WatchOS, Version,
2478 /*IsSimulator=*/SDK.starts_with("WatchSimulator"));
2479 else if (SDK.starts_with("AppleTVOS") || SDK.starts_with("AppleTVSimulator"))
2480 return DarwinPlatform::createFromSDK(
2481 isysroot, Darwin::TvOS, Version,
2482 /*IsSimulator=*/SDK.starts_with("AppleTVSimulator"));
2483 else if (SDK.starts_with("DriverKit"))
2484 return DarwinPlatform::createFromSDK(isysroot, Darwin::DriverKit, Version);
2485 return std::nullopt;
2486}
2487
2488// Compute & get the OS Version when the target triple omitted one.
2489VersionTuple getInferredOSVersion(llvm::Triple::OSType OS,
2490 const llvm::Triple &Triple,
2491 const Driver &TheDriver) {
2492 VersionTuple OsVersion;
2493 llvm::Triple SystemTriple(llvm::sys::getProcessTriple());
2494 switch (OS) {
2495 case llvm::Triple::Darwin:
2496 case llvm::Triple::MacOSX:
2497 // If there is no version specified on triple, and both host and target are
2498 // macos, use the host triple to infer OS version.
2499 if (Triple.isMacOSX() && SystemTriple.isMacOSX() &&
2500 !Triple.getOSMajorVersion())
2501 SystemTriple.getMacOSXVersion(OsVersion);
2502 else if (!Triple.getMacOSXVersion(OsVersion))
2503 TheDriver.Diag(diag::err_drv_invalid_darwin_version)
2504 << Triple.getOSName();
2505 break;
2506 case llvm::Triple::IOS:
2507 if (Triple.isMacCatalystEnvironment() && !Triple.getOSMajorVersion()) {
2508 OsVersion = VersionTuple(13, 1);
2509 } else
2510 OsVersion = Triple.getiOSVersion();
2511 break;
2512 case llvm::Triple::TvOS:
2513 OsVersion = Triple.getOSVersion();
2514 break;
2515 case llvm::Triple::WatchOS:
2516 OsVersion = Triple.getWatchOSVersion();
2517 break;
2518 case llvm::Triple::DriverKit:
2519 OsVersion = Triple.getDriverKitVersion();
2520 break;
2521 default:
2522 OsVersion = Triple.getOSVersion();
2523 if (!OsVersion.getMajor())
2524 OsVersion = OsVersion.withMajorReplaced(1);
2525 break;
2526 }
2527 return OsVersion;
2528}
2529
2530/// Tries to infer the target OS from the -arch.
2531std::optional<DarwinPlatform>
2532inferDeploymentTargetFromArch(DerivedArgList &Args, const Darwin &Toolchain,
2533 const llvm::Triple &Triple,
2534 const Driver &TheDriver) {
2535 llvm::Triple::OSType OSTy = llvm::Triple::UnknownOS;
2536
2537 StringRef MachOArchName = Toolchain.getMachOArchName(Args);
2538 if (MachOArchName == "arm64" || MachOArchName == "arm64e")
2539 OSTy = llvm::Triple::MacOSX;
2540 else if (MachOArchName == "armv7" || MachOArchName == "armv7s" ||
2541 MachOArchName == "armv6")
2542 OSTy = llvm::Triple::IOS;
2543 else if (MachOArchName == "armv7k" || MachOArchName == "arm64_32")
2544 OSTy = llvm::Triple::WatchOS;
2545 else if (MachOArchName != "armv6m" && MachOArchName != "armv7m" &&
2546 MachOArchName != "armv7em" && MachOArchName != "armv8m.base" &&
2547 MachOArchName != "armv8m.main" && MachOArchName != "armv8.1m.main")
2548 OSTy = llvm::Triple::MacOSX;
2549 if (OSTy == llvm::Triple::UnknownOS)
2550 return std::nullopt;
2551 return DarwinPlatform::createFromArch(
2552 MachOArchName, OSTy, getInferredOSVersion(OSTy, Triple, TheDriver));
2553}
2554
2555/// Returns the deployment target that's specified using the -target option.
2556std::optional<DarwinPlatform> getDeploymentTargetFromTargetArg(
2557 DerivedArgList &Args, const llvm::Triple &Triple, const Driver &TheDriver,
2558 const std::optional<DarwinSDKInfo> &SDKInfo) {
2559 if (!Args.hasArg(options::OPT_target))
2560 return std::nullopt;
2561 if (Triple.getOS() == llvm::Triple::Darwin ||
2562 Triple.getOS() == llvm::Triple::UnknownOS)
2563 return std::nullopt;
2564 std::optional<llvm::Triple> TargetVariantTriple;
2565 for (const Arg *A : Args.filtered(options::OPT_darwin_target_variant)) {
2566 llvm::Triple TVT(A->getValue());
2567 // Find a matching <arch>-<vendor> target variant triple that can be used.
2568 if ((Triple.getArch() == llvm::Triple::aarch64 ||
2569 TVT.getArchName() == Triple.getArchName()) &&
2570 TVT.getArch() == Triple.getArch() &&
2571 TVT.getSubArch() == Triple.getSubArch() &&
2572 TVT.getVendor() == Triple.getVendor()) {
2573 if (TargetVariantTriple)
2574 continue;
2575 A->claim();
2576 // Accept a -target-variant triple when compiling code that may run on
2577 // macOS or Mac Catalyst.
2578 if ((Triple.isMacOSX() && TVT.getOS() == llvm::Triple::IOS &&
2579 TVT.isMacCatalystEnvironment()) ||
2580 (TVT.isMacOSX() && Triple.getOS() == llvm::Triple::IOS &&
2581 Triple.isMacCatalystEnvironment())) {
2582 TargetVariantTriple = TVT;
2583 continue;
2584 }
2585 TheDriver.Diag(diag::err_drv_target_variant_invalid)
2586 << A->getSpelling() << A->getValue();
2587 }
2588 }
2589 DarwinPlatform PlatformAndVersion = DarwinPlatform::createFromTarget(
2590 Triple, Args.getLastArg(options::OPT_target), TargetVariantTriple,
2591 SDKInfo);
2592
2593 return PlatformAndVersion;
2594}
2595
2596/// Returns the deployment target that's specified using the -mtargetos option.
2597std::optional<DarwinPlatform> getDeploymentTargetFromMTargetOSArg(
2598 DerivedArgList &Args, const Driver &TheDriver,
2599 const std::optional<DarwinSDKInfo> &SDKInfo) {
2600 auto *A = Args.getLastArg(options::OPT_mtargetos_EQ);
2601 if (!A)
2602 return std::nullopt;
2603 llvm::Triple TT(llvm::Twine("unknown-apple-") + A->getValue());
2604 switch (TT.getOS()) {
2605 case llvm::Triple::MacOSX:
2606 case llvm::Triple::IOS:
2607 case llvm::Triple::TvOS:
2608 case llvm::Triple::WatchOS:
2609 case llvm::Triple::XROS:
2610 break;
2611 default:
2612 TheDriver.Diag(diag::err_drv_invalid_os_in_arg)
2613 << TT.getOSName() << A->getAsString(Args);
2614 return std::nullopt;
2615 }
2616
2617 VersionTuple Version = TT.getOSVersion();
2618 if (!Version.getMajor()) {
2619 TheDriver.Diag(diag::err_drv_invalid_version_number)
2620 << A->getAsString(Args);
2621 return std::nullopt;
2622 }
2623 return DarwinPlatform::createFromMTargetOS(TT.getOS(), Version,
2624 TT.getEnvironment(), A, SDKInfo);
2625}
2626
2627std::optional<DarwinSDKInfo> parseSDKSettings(llvm::vfs::FileSystem &VFS,
2628 const ArgList &Args,
2629 const Driver &TheDriver) {
2630 const Arg *A = Args.getLastArg(options::OPT_isysroot);
2631 if (!A)
2632 return std::nullopt;
2633 StringRef isysroot = A->getValue();
2634 auto SDKInfoOrErr = parseDarwinSDKInfo(VFS, isysroot);
2635 if (!SDKInfoOrErr) {
2636 llvm::consumeError(SDKInfoOrErr.takeError());
2637 TheDriver.Diag(diag::warn_drv_darwin_sdk_invalid_settings);
2638 return std::nullopt;
2639 }
2640 return *SDKInfoOrErr;
2641}
2642
2643} // namespace
2644
2645void Darwin::AddDeploymentTarget(DerivedArgList &Args) const {
2646 const OptTable &Opts = getDriver().getOpts();
2647 // TryXcselect keeps track of whether we use xcselect to find the SDK
2648 // when CLANG_USE_XCSELECT is enabled. Currently, we do this when we
2649 // do not have a sysroot from -isysroot, --sysroot, or SDKROOT, and
2650 // we do not have --no-xcselect.
2651 bool TryXcselect = false;
2652 (void)TryXcselect;
2653
2654 // Support allowing the SDKROOT environment variable used by xcrun and other
2655 // Xcode tools to define the default sysroot, by making it the default for
2656 // isysroot.
2657 if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
2658 // Warn if the path does not exist.
2659 if (!getVFS().exists(A->getValue()))
2660 getDriver().Diag(clang::diag::warn_missing_sysroot) << A->getValue();
2661 } else if (const char *env = ::getenv("SDKROOT")) {
2662 // We only use this value as the default if it is an absolute path,
2663 // exists, and it is not the root path.
2664 if (llvm::sys::path::is_absolute(env) && getVFS().exists(env) &&
2665 StringRef(env) != "/") {
2666 Args.append(Args.MakeSeparateArg(
2667 nullptr, Opts.getOption(options::OPT_isysroot), env));
2668 }
2669 } else {
2670 TryXcselect = !Args.hasArg(options::OPT__sysroot_EQ) &&
2671 !Args.hasArg(options::OPT_no_xcselect);
2672 }
2673
2674 // Read the SDKSettings.json file for more information, like the SDK version
2675 // that we can pass down to the compiler.
2676 SDKInfo = parseSDKSettings(getVFS(), Args, getDriver());
2677 // FIXME: If SDKInfo is std::nullopt, diagnose a bad isysroot value (e.g.
2678 // doesn't end in .sdk).
2679
2680 // The OS and the version can be specified using the -target argument.
2681 std::optional<DarwinPlatform> PlatformAndVersion =
2682 getDeploymentTargetFromTargetArg(Args, getTriple(), getDriver(), SDKInfo);
2683 if (PlatformAndVersion) {
2684 // Disallow mixing -target and -mtargetos=.
2685 if (const auto *MTargetOSArg = Args.getLastArg(options::OPT_mtargetos_EQ)) {
2686 std::string TargetArgStr = PlatformAndVersion->getAsString(Args, Opts);
2687 std::string MTargetOSArgStr = MTargetOSArg->getAsString(Args);
2688 getDriver().Diag(diag::err_drv_cannot_mix_options)
2689 << TargetArgStr << MTargetOSArgStr;
2690 }
2691 // Implicitly allow resolving the OS version when it wasn't explicitly set.
2692 bool TripleProvidedOSVersion = PlatformAndVersion->hasOSVersion();
2693 if (!TripleProvidedOSVersion)
2694 PlatformAndVersion->setOSVersion(
2695 getInferredOSVersion(getTriple().getOS(), getTriple(), getDriver()));
2696
2697 std::optional<DarwinPlatform> PlatformAndVersionFromOSVersionArg =
2698 getDeploymentTargetFromOSVersionArg(Args, getDriver());
2699 if (PlatformAndVersionFromOSVersionArg) {
2700 unsigned TargetMajor, TargetMinor, TargetMicro;
2701 bool TargetExtra;
2702 unsigned ArgMajor, ArgMinor, ArgMicro;
2703 bool ArgExtra;
2704 if (PlatformAndVersion->getPlatform() !=
2705 PlatformAndVersionFromOSVersionArg->getPlatform() ||
2707 PlatformAndVersion->getOSVersion().getAsString(), TargetMajor,
2708 TargetMinor, TargetMicro, TargetExtra) &&
2710 PlatformAndVersionFromOSVersionArg->getOSVersion().getAsString(),
2711 ArgMajor, ArgMinor, ArgMicro, ArgExtra) &&
2712 (VersionTuple(TargetMajor, TargetMinor, TargetMicro) !=
2713 VersionTuple(ArgMajor, ArgMinor, ArgMicro) ||
2714 TargetExtra != ArgExtra))) {
2715 // Select the OS version from the -m<os>-version-min argument when
2716 // the -target does not include an OS version.
2717 if (PlatformAndVersion->getPlatform() ==
2718 PlatformAndVersionFromOSVersionArg->getPlatform() &&
2719 !TripleProvidedOSVersion) {
2720 PlatformAndVersion->setOSVersion(
2721 PlatformAndVersionFromOSVersionArg->getOSVersion());
2722 } else {
2723 // Warn about -m<os>-version-min that doesn't match the OS version
2724 // that's specified in the target.
2725 std::string OSVersionArg =
2726 PlatformAndVersionFromOSVersionArg->getAsString(Args, Opts);
2727 std::string TargetArg = PlatformAndVersion->getAsString(Args, Opts);
2728 getDriver().Diag(clang::diag::warn_drv_overriding_option)
2729 << OSVersionArg << TargetArg;
2730 }
2731 }
2732 }
2733 } else if ((PlatformAndVersion = getDeploymentTargetFromMTargetOSArg(
2734 Args, getDriver(), SDKInfo))) {
2735 // The OS target can be specified using the -mtargetos= argument.
2736 // Disallow mixing -mtargetos= and -m<os>version-min=.
2737 std::optional<DarwinPlatform> PlatformAndVersionFromOSVersionArg =
2738 getDeploymentTargetFromOSVersionArg(Args, getDriver());
2739 if (PlatformAndVersionFromOSVersionArg) {
2740 std::string MTargetOSArgStr = PlatformAndVersion->getAsString(Args, Opts);
2741 std::string OSVersionArgStr =
2742 PlatformAndVersionFromOSVersionArg->getAsString(Args, Opts);
2743 getDriver().Diag(diag::err_drv_cannot_mix_options)
2744 << MTargetOSArgStr << OSVersionArgStr;
2745 }
2746 } else {
2747 // The OS target can be specified using the -m<os>version-min argument.
2748 PlatformAndVersion = getDeploymentTargetFromOSVersionArg(Args, getDriver());
2749 // If no deployment target was specified on the command line, check for
2750 // environment defines.
2751 if (!PlatformAndVersion) {
2752 PlatformAndVersion =
2753 getDeploymentTargetFromEnvironmentVariables(getDriver(), getTriple());
2754 if (PlatformAndVersion) {
2755 // Don't infer simulator from the arch when the SDK is also specified.
2756 std::optional<DarwinPlatform> SDKTarget =
2757 inferDeploymentTargetFromSDK(Args, SDKInfo);
2758 if (SDKTarget)
2759 PlatformAndVersion->setEnvironment(SDKTarget->getEnvironment());
2760 }
2761 }
2762 // If there is no command-line argument to specify the Target version and
2763 // no environment variable defined, see if we can set the default based
2764 // on -isysroot using SDKSettings.json if it exists.
2765 if (!PlatformAndVersion) {
2766 PlatformAndVersion = inferDeploymentTargetFromSDK(Args, SDKInfo);
2767 /// If the target was successfully constructed from the SDK path, try to
2768 /// infer the SDK info if the SDK doesn't have it.
2769 if (PlatformAndVersion && !SDKInfo)
2770 SDKInfo = PlatformAndVersion->inferSDKInfo();
2771 }
2772 // If no OS targets have been specified, try to guess platform from -target
2773 // or arch name and compute the version from the triple.
2774 if (!PlatformAndVersion)
2775 PlatformAndVersion =
2776 inferDeploymentTargetFromArch(Args, *this, getTriple(), getDriver());
2777 }
2778
2779 assert(PlatformAndVersion && "Unable to infer Darwin variant");
2780 if (!PlatformAndVersion->isValidOSVersion()) {
2781 if (PlatformAndVersion->isExplicitlySpecified())
2782 getDriver().Diag(diag::err_drv_invalid_version_number)
2783 << PlatformAndVersion->getAsString(Args, Opts);
2784 else
2785 getDriver().Diag(diag::err_drv_invalid_version_number_inferred)
2786 << PlatformAndVersion->getOSVersion().getAsString()
2787 << PlatformAndVersion->getInferredSource();
2788 }
2789 // After the deployment OS version has been resolved, set it to the canonical
2790 // version before further error detection and converting to a proper target
2791 // triple.
2792 VersionTuple CanonicalVersion = PlatformAndVersion->getCanonicalOSVersion();
2793 if (CanonicalVersion != PlatformAndVersion->getOSVersion()) {
2794 getDriver().Diag(diag::warn_drv_overriding_deployment_version)
2795 << PlatformAndVersion->getOSVersion().getAsString()
2796 << CanonicalVersion.getAsString();
2797 PlatformAndVersion->setOSVersion(CanonicalVersion);
2798 }
2799
2800 PlatformAndVersion->addOSVersionMinArgument(Args, Opts);
2801 DarwinPlatformKind Platform = PlatformAndVersion->getPlatform();
2802
2803 unsigned Major, Minor, Micro;
2804 bool HadExtra;
2805 // The major version should not be over this number.
2806 const unsigned MajorVersionLimit = 1000;
2807 const VersionTuple OSVersion = PlatformAndVersion->takeOSVersion();
2808 const std::string OSVersionStr = OSVersion.getAsString();
2809 // Set the tool chain target information.
2810 if (Platform == MacOS) {
2811#ifdef CLANG_USE_XCSELECT
2812 if (TryXcselect) {
2813 char *p;
2814 if (!::xcselect_host_sdk_path(CLANG_XCSELECT_HOST_SDK_POLICY, &p)) {
2815 Args.append(Args.MakeSeparateArg(
2816 nullptr, Opts.getOption(options::OPT_isysroot), p));
2817 ::free(p);
2818 if (!SDKInfo)
2819 SDKInfo = parseSDKSettings(getVFS(), Args, getDriver());
2820 }
2821 }
2822#endif
2823 if (!Driver::GetReleaseVersion(OSVersionStr, Major, Minor, Micro,
2824 HadExtra) ||
2825 HadExtra || Major < 10 || Major >= MajorVersionLimit || Minor >= 100 ||
2826 Micro >= 100)
2827 getDriver().Diag(diag::err_drv_invalid_version_number)
2828 << PlatformAndVersion->getAsString(Args, Opts);
2829 } else if (Platform == IPhoneOS) {
2830 if (!Driver::GetReleaseVersion(OSVersionStr, Major, Minor, Micro,
2831 HadExtra) ||
2832 HadExtra || Major >= MajorVersionLimit || Minor >= 100 || Micro >= 100)
2833 getDriver().Diag(diag::err_drv_invalid_version_number)
2834 << PlatformAndVersion->getAsString(Args, Opts);
2835 ;
2836 if (PlatformAndVersion->getEnvironment() == MacCatalyst &&
2837 (Major < 13 || (Major == 13 && Minor < 1))) {
2838 getDriver().Diag(diag::err_drv_invalid_version_number)
2839 << PlatformAndVersion->getAsString(Args, Opts);
2840 Major = 13;
2841 Minor = 1;
2842 Micro = 0;
2843 }
2844 // For 32-bit targets, the deployment target for iOS has to be earlier than
2845 // iOS 11.
2846 if (getTriple().isArch32Bit() && Major >= 11) {
2847 // If the deployment target is explicitly specified, print a diagnostic.
2848 if (PlatformAndVersion->isExplicitlySpecified()) {
2849 if (PlatformAndVersion->getEnvironment() == MacCatalyst)
2850 getDriver().Diag(diag::err_invalid_macos_32bit_deployment_target);
2851 else
2852 getDriver().Diag(diag::warn_invalid_ios_deployment_target)
2853 << PlatformAndVersion->getAsString(Args, Opts);
2854 // Otherwise, set it to 10.99.99.
2855 } else {
2856 Major = 10;
2857 Minor = 99;
2858 Micro = 99;
2859 }
2860 }
2861 } else if (Platform == TvOS) {
2862 if (!Driver::GetReleaseVersion(OSVersionStr, Major, Minor, Micro,
2863 HadExtra) ||
2864 HadExtra || Major >= MajorVersionLimit || Minor >= 100 || Micro >= 100)
2865 getDriver().Diag(diag::err_drv_invalid_version_number)
2866 << PlatformAndVersion->getAsString(Args, Opts);
2867 } else if (Platform == WatchOS) {
2868 if (!Driver::GetReleaseVersion(OSVersionStr, Major, Minor, Micro,
2869 HadExtra) ||
2870 HadExtra || Major >= MajorVersionLimit || Minor >= 100 || Micro >= 100)
2871 getDriver().Diag(diag::err_drv_invalid_version_number)
2872 << PlatformAndVersion->getAsString(Args, Opts);
2873 } else if (Platform == DriverKit) {
2874 if (!Driver::GetReleaseVersion(OSVersionStr, Major, Minor, Micro,
2875 HadExtra) ||
2876 HadExtra || Major < 19 || Major >= MajorVersionLimit || Minor >= 100 ||
2877 Micro >= 100)
2878 getDriver().Diag(diag::err_drv_invalid_version_number)
2879 << PlatformAndVersion->getAsString(Args, Opts);
2880 } else {
2881 if (!Driver::GetReleaseVersion(OSVersionStr, Major, Minor, Micro,
2882 HadExtra) ||
2883 HadExtra || Major < 1 || Major >= MajorVersionLimit || Minor >= 100 ||
2884 Micro >= 100)
2885 getDriver().Diag(diag::err_drv_invalid_version_number)
2886 << PlatformAndVersion->getAsString(Args, Opts);
2887 }
2888
2889 DarwinEnvironmentKind Environment = PlatformAndVersion->getEnvironment();
2890 // Recognize iOS targets with an x86 architecture as the iOS simulator.
2891 if (Environment == NativeEnvironment && Platform != MacOS &&
2892 Platform != DriverKit &&
2893 PlatformAndVersion->canInferSimulatorFromArch() && getTriple().isX86())
2894 Environment = Simulator;
2895
2896 VersionTuple ZipperedOSVersion;
2897 if (Environment == MacCatalyst)
2898 ZipperedOSVersion = PlatformAndVersion->getZipperedOSVersion();
2899 setTarget(Platform, Environment, Major, Minor, Micro, ZipperedOSVersion);
2900 TargetVariantTriple = PlatformAndVersion->getTargetVariantTriple();
2901 if (TargetVariantTriple &&
2902 !llvm::Triple::isValidVersionForOS(TargetVariantTriple->getOS(),
2903 TargetVariantTriple->getOSVersion())) {
2904 getDriver().Diag(diag::err_drv_invalid_version_number)
2905 << TargetVariantTriple->str();
2906 }
2907}
2908
2909bool DarwinClang::HasPlatformPrefix(const llvm::Triple &T) const {
2910 if (SDKInfo)
2911 return !SDKInfo->getPlatformPrefix(T).empty();
2912 else
2914}
2915
2916// For certain platforms/environments almost all resources (e.g., headers) are
2917// located in sub-directories, e.g., for DriverKit they live in
2918// <SYSROOT>/System/DriverKit/usr/include (instead of <SYSROOT>/usr/include).
2920 const llvm::Triple &T) const {
2921 if (SDKInfo) {
2922 const StringRef PlatformPrefix = SDKInfo->getPlatformPrefix(T);
2923 if (!PlatformPrefix.empty())
2924 llvm::sys::path::append(Path, PlatformPrefix);
2925 } else if (T.isDriverKit()) {
2926 // The first version of DriverKit didn't have SDKSettings.json, manually add
2927 // its prefix.
2928 llvm::sys::path::append(Path, "System", "DriverKit");
2929 }
2930}
2931
2932// Returns the effective sysroot from either -isysroot or --sysroot, plus the
2933// platform prefix (if any).
2935AppleMachO::GetEffectiveSysroot(const llvm::opt::ArgList &DriverArgs) const {
2936 llvm::SmallString<128> Path("/");
2937 if (DriverArgs.hasArg(options::OPT_isysroot))
2938 Path = DriverArgs.getLastArgValue(options::OPT_isysroot);
2939 else if (!getDriver().SysRoot.empty())
2940 Path = getDriver().SysRoot;
2941
2942 if (hasEffectiveTriple()) {
2944 }
2945 return Path;
2946}
2947
2949 const llvm::opt::ArgList &DriverArgs,
2950 llvm::opt::ArgStringList &CC1Args) const {
2951 const Driver &D = getDriver();
2952
2953 llvm::SmallString<128> Sysroot = GetEffectiveSysroot(DriverArgs);
2954
2955 bool NoStdInc = DriverArgs.hasArg(options::OPT_nostdinc);
2956 bool NoStdlibInc = DriverArgs.hasArg(options::OPT_nostdlibinc);
2957 bool NoBuiltinInc = DriverArgs.hasFlag(
2958 options::OPT_nobuiltininc, options::OPT_ibuiltininc, /*Default=*/false);
2959 bool ForceBuiltinInc = DriverArgs.hasFlag(
2960 options::OPT_ibuiltininc, options::OPT_nobuiltininc, /*Default=*/false);
2961
2962 // Add <sysroot>/usr/local/include
2963 if (!NoStdInc && !NoStdlibInc) {
2964 SmallString<128> P(Sysroot);
2965 llvm::sys::path::append(P, "usr", "local", "include");
2966 addSystemInclude(DriverArgs, CC1Args, P);
2967 }
2968
2969 // Add the Clang builtin headers (<resource>/include)
2970 if (!(NoStdInc && !ForceBuiltinInc) && !NoBuiltinInc) {
2971 SmallString<128> P(D.ResourceDir);
2972 llvm::sys::path::append(P, "include");
2973 addSystemInclude(DriverArgs, CC1Args, P);
2974 }
2975
2976 if (NoStdInc || NoStdlibInc)
2977 return;
2978
2979 // Check for configure-time C include directories.
2980 llvm::StringRef CIncludeDirs(C_INCLUDE_DIRS);
2981 if (!CIncludeDirs.empty()) {
2983 CIncludeDirs.split(dirs, ":");
2984 for (llvm::StringRef dir : dirs) {
2985 llvm::StringRef Prefix =
2986 llvm::sys::path::is_absolute(dir) ? "" : llvm::StringRef(Sysroot);
2987 addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
2988 }
2989 } else {
2990 // Otherwise, add <sysroot>/usr/include.
2991 SmallString<128> P(Sysroot);
2992 llvm::sys::path::append(P, "usr", "include");
2993 addExternCSystemInclude(DriverArgs, CC1Args, P.str());
2994 }
2995}
2996
2998 const llvm::opt::ArgList &DriverArgs,
2999 llvm::opt::ArgStringList &CC1Args) const {
3000 AppleMachO::AddClangSystemIncludeArgs(DriverArgs, CC1Args);
3001
3002 if (DriverArgs.hasArg(options::OPT_nostdinc, options::OPT_nostdlibinc))
3003 return;
3004
3005 llvm::SmallString<128> Sysroot = GetEffectiveSysroot(DriverArgs);
3006
3007 // Add <sysroot>/System/Library/Frameworks
3008 // Add <sysroot>/System/Library/SubFrameworks
3009 // Add <sysroot>/Library/Frameworks
3010 SmallString<128> P1(Sysroot), P2(Sysroot), P3(Sysroot);
3011 llvm::sys::path::append(P1, "System", "Library", "Frameworks");
3012 llvm::sys::path::append(P2, "System", "Library", "SubFrameworks");
3013 llvm::sys::path::append(P3, "Library", "Frameworks");
3014 addSystemFrameworkIncludes(DriverArgs, CC1Args, {P1, P2, P3});
3015}
3016
3017bool DarwinClang::AddGnuCPlusPlusIncludePaths(const llvm::opt::ArgList &DriverArgs,
3018 llvm::opt::ArgStringList &CC1Args,
3020 llvm::StringRef Version,
3021 llvm::StringRef ArchDir,
3022 llvm::StringRef BitDir) const {
3023 llvm::sys::path::append(Base, Version);
3024
3025 // Add the base dir
3026 addSystemInclude(DriverArgs, CC1Args, Base);
3027
3028 // Add the multilib dirs
3029 {
3031 if (!ArchDir.empty())
3032 llvm::sys::path::append(P, ArchDir);
3033 if (!BitDir.empty())
3034 llvm::sys::path::append(P, BitDir);
3035 addSystemInclude(DriverArgs, CC1Args, P);
3036 }
3037
3038 // Add the backward dir
3039 {
3041 llvm::sys::path::append(P, "backward");
3042 addSystemInclude(DriverArgs, CC1Args, P);
3043 }
3044
3045 return getVFS().exists(Base);
3046}
3047
3049 const llvm::opt::ArgList &DriverArgs,
3050 llvm::opt::ArgStringList &CC1Args) const {
3051 // The implementation from a base class will pass through the -stdlib to
3052 // CC1Args.
3053 // FIXME: this should not be necessary, remove usages in the frontend
3054 // (e.g. HeaderSearchOptions::UseLibcxx) and don't pipe -stdlib.
3055 // Also check whether this is used for setting library search paths.
3056 ToolChain::AddClangCXXStdlibIncludeArgs(DriverArgs, CC1Args);
3057
3058 if (DriverArgs.hasArg(options::OPT_nostdinc, options::OPT_nostdlibinc,
3059 options::OPT_nostdincxx))
3060 return;
3061
3062 llvm::SmallString<128> Sysroot = GetEffectiveSysroot(DriverArgs);
3063
3064 switch (GetCXXStdlibType(DriverArgs)) {
3065 case ToolChain::CST_Libcxx: {
3066 // On Darwin, libc++ can be installed in one of the following places:
3067 // 1. Alongside the compiler in <clang-executable-folder>/../include/c++/v1
3068 // 2. In a SDK (or a custom sysroot) in <sysroot>/usr/include/c++/v1
3069 //
3070 // The precedence of paths is as listed above, i.e. we take the first path
3071 // that exists. Note that we never include libc++ twice -- we take the first
3072 // path that exists and don't send the other paths to CC1 (otherwise
3073 // include_next could break).
3074
3075 // Check for (1)
3076 // Get from '<install>/bin' to '<install>/include/c++/v1'.
3077 // Note that InstallBin can be relative, so we use '..' instead of
3078 // parent_path.
3079 llvm::SmallString<128> InstallBin(getDriver().Dir); // <install>/bin
3080 llvm::sys::path::append(InstallBin, "..", "include", "c++", "v1");
3081 if (getVFS().exists(InstallBin)) {
3082 addSystemInclude(DriverArgs, CC1Args, InstallBin);
3083 return;
3084 } else if (DriverArgs.hasArg(options::OPT_v)) {
3085 llvm::errs() << "ignoring nonexistent directory \"" << InstallBin
3086 << "\"\n";
3087 }
3088
3089 // Otherwise, check for (2)
3090 llvm::SmallString<128> SysrootUsr = Sysroot;
3091 llvm::sys::path::append(SysrootUsr, "usr", "include", "c++", "v1");
3092 if (getVFS().exists(SysrootUsr)) {
3093 addSystemInclude(DriverArgs, CC1Args, SysrootUsr);
3094 return;
3095 } else if (DriverArgs.hasArg(options::OPT_v)) {
3096 llvm::errs() << "ignoring nonexistent directory \"" << SysrootUsr
3097 << "\"\n";
3098 }
3099
3100 // Otherwise, don't add any path.
3101 break;
3102 }
3103
3105 AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args);
3106 break;
3107 }
3108}
3109
3110void AppleMachO::AddGnuCPlusPlusIncludePaths(
3111 const llvm::opt::ArgList &DriverArgs,
3112 llvm::opt::ArgStringList &CC1Args) const {}
3113
3114void DarwinClang::AddGnuCPlusPlusIncludePaths(
3115 const llvm::opt::ArgList &DriverArgs,
3116 llvm::opt::ArgStringList &CC1Args) const {
3117 llvm::SmallString<128> UsrIncludeCxx = GetEffectiveSysroot(DriverArgs);
3118 llvm::sys::path::append(UsrIncludeCxx, "usr", "include", "c++");
3119
3120 llvm::Triple::ArchType arch = getTriple().getArch();
3121 bool IsBaseFound = true;
3122 switch (arch) {
3123 default:
3124 break;
3125
3126 case llvm::Triple::x86:
3127 case llvm::Triple::x86_64:
3128 IsBaseFound = AddGnuCPlusPlusIncludePaths(
3129 DriverArgs, CC1Args, UsrIncludeCxx, "4.2.1", "i686-apple-darwin10",
3130 arch == llvm::Triple::x86_64 ? "x86_64" : "");
3131 IsBaseFound |= AddGnuCPlusPlusIncludePaths(
3132 DriverArgs, CC1Args, UsrIncludeCxx, "4.0.0", "i686-apple-darwin8", "");
3133 break;
3134
3135 case llvm::Triple::arm:
3136 case llvm::Triple::thumb:
3137 IsBaseFound =
3138 AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx, "4.2.1",
3139 "arm-apple-darwin10", "v7");
3140 IsBaseFound |=
3141 AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx, "4.2.1",
3142 "arm-apple-darwin10", "v6");
3143 break;
3144
3145 case llvm::Triple::aarch64:
3146 IsBaseFound =
3147 AddGnuCPlusPlusIncludePaths(DriverArgs, CC1Args, UsrIncludeCxx, "4.2.1",
3148 "arm64-apple-darwin10", "");
3149 break;
3150 }
3151
3152 if (!IsBaseFound) {
3153 getDriver().Diag(diag::warn_drv_libstdcxx_not_found);
3154 }
3155}
3156
3157void AppleMachO::AddCXXStdlibLibArgs(const ArgList &Args,
3158 ArgStringList &CmdArgs) const {
3160
3161 switch (Type) {
3163 CmdArgs.push_back("-lc++");
3164 if (Args.hasArg(options::OPT_fexperimental_library))
3165 CmdArgs.push_back("-lc++experimental");
3166 break;
3167
3169 // Unfortunately, -lstdc++ doesn't always exist in the standard search path;
3170 // it was previously found in the gcc lib dir. However, for all the Darwin
3171 // platforms we care about it was -lstdc++.6, so we search for that
3172 // explicitly if we can't see an obvious -lstdc++ candidate.
3173
3174 // Check in the sysroot first.
3175 if (const Arg *A = Args.getLastArg(options::OPT_isysroot)) {
3176 SmallString<128> P(A->getValue());
3177 llvm::sys::path::append(P, "usr", "lib", "libstdc++.dylib");
3178
3179 if (!getVFS().exists(P)) {
3180 llvm::sys::path::remove_filename(P);
3181 llvm::sys::path::append(P, "libstdc++.6.dylib");
3182 if (getVFS().exists(P)) {
3183 CmdArgs.push_back(Args.MakeArgString(P));
3184 return;
3185 }
3186 }
3187 }
3188
3189 // Otherwise, look in the root.
3190 // FIXME: This should be removed someday when we don't have to care about
3191 // 10.6 and earlier, where /usr/lib/libstdc++.dylib does not exist.
3192 if (!getVFS().exists("/usr/lib/libstdc++.dylib") &&
3193 getVFS().exists("/usr/lib/libstdc++.6.dylib")) {
3194 CmdArgs.push_back("/usr/lib/libstdc++.6.dylib");
3195 return;
3196 }
3197
3198 // Otherwise, let the linker search.
3199 CmdArgs.push_back("-lstdc++");
3200 break;
3201 }
3202}
3203
3204void DarwinClang::AddCCKextLibArgs(const ArgList &Args,
3205 ArgStringList &CmdArgs) const {
3206 // For Darwin platforms, use the compiler-rt-based support library
3207 // instead of the gcc-provided one (which is also incidentally
3208 // only present in the gcc lib dir, which makes it hard to find).
3209
3210 SmallString<128> P(getDriver().ResourceDir);
3211 llvm::sys::path::append(P, "lib", "darwin");
3212
3213 // Use the newer cc_kext for iOS ARM after 6.0.
3214 if (isTargetWatchOS()) {
3215 llvm::sys::path::append(P, "libclang_rt.cc_kext_watchos.a");
3216 } else if (isTargetTvOS()) {
3217 llvm::sys::path::append(P, "libclang_rt.cc_kext_tvos.a");
3218 } else if (isTargetIPhoneOS()) {
3219 llvm::sys::path::append(P, "libclang_rt.cc_kext_ios.a");
3220 } else if (isTargetDriverKit()) {
3221 // DriverKit doesn't want extra runtime support.
3222 } else if (isTargetXROSDevice()) {
3223 llvm::sys::path::append(
3224 P, llvm::Twine("libclang_rt.cc_kext_") +
3225 llvm::Triple::getOSTypeName(llvm::Triple::XROS) + ".a");
3226 } else {
3227 llvm::sys::path::append(P, "libclang_rt.cc_kext.a");
3228 }
3229
3230 // For now, allow missing resource libraries to support developers who may
3231 // not have compiler-rt checked out or integrated into their build.
3232 if (getVFS().exists(P))
3233 CmdArgs.push_back(Args.MakeArgString(P));
3234}
3235
3236DerivedArgList *MachO::TranslateArgs(const DerivedArgList &Args, BoundArch BA,
3237 Action::OffloadKind) const {
3238 DerivedArgList *DAL = new DerivedArgList(Args.getBaseArgs());
3239 const OptTable &Opts = getDriver().getOpts();
3240
3241 // FIXME: We really want to get out of the tool chain level argument
3242 // translation business, as it makes the driver functionality much
3243 // more opaque. For now, we follow gcc closely solely for the
3244 // purpose of easily achieving feature parity & testability. Once we
3245 // have something that works, we should reevaluate each translation
3246 // and try to push it down into tool specific logic.
3247
3248 for (Arg *A : Args) {
3249 // Sob. These is strictly gcc compatible for the time being. Apple
3250 // gcc translates options twice, which means that self-expanding
3251 // options add duplicates.
3252 switch ((options::ID)A->getOption().getID()) {
3253 default:
3254 DAL->append(A);
3255 break;
3256
3257 case options::OPT_mkernel:
3258 case options::OPT_fapple_kext:
3259 DAL->append(A);
3260 DAL->AddFlagArg(A, Opts.getOption(options::OPT_static));
3261 break;
3262
3263 case options::OPT_dependency_file:
3264 DAL->AddSeparateArg(A, Opts.getOption(options::OPT_MF), A->getValue());
3265 break;
3266
3267 case options::OPT_gfull:
3268 DAL->AddFlagArg(A, Opts.getOption(options::OPT_g_Flag));
3269 DAL->AddFlagArg(
3270 A, Opts.getOption(options::OPT_fno_eliminate_unused_debug_symbols));
3271 break;
3272
3273 case options::OPT_gused:
3274 DAL->AddFlagArg(A, Opts.getOption(options::OPT_g_Flag));
3275 DAL->AddFlagArg(
3276 A, Opts.getOption(options::OPT_feliminate_unused_debug_symbols));
3277 break;
3278
3279 case options::OPT_shared:
3280 DAL->AddFlagArg(A, Opts.getOption(options::OPT_dynamiclib));
3281 break;
3282
3283 case options::OPT_fconstant_cfstrings:
3284 DAL->AddFlagArg(A, Opts.getOption(options::OPT_mconstant_cfstrings));
3285 break;
3286
3287 case options::OPT_fno_constant_cfstrings:
3288 DAL->AddFlagArg(A, Opts.getOption(options::OPT_mno_constant_cfstrings));
3289 break;
3290
3291 case options::OPT_Wnonportable_cfstrings:
3292 DAL->AddFlagArg(A,
3293 Opts.getOption(options::OPT_mwarn_nonportable_cfstrings));
3294 break;
3295
3296 case options::OPT_Wno_nonportable_cfstrings:
3297 DAL->AddFlagArg(
3298 A, Opts.getOption(options::OPT_mno_warn_nonportable_cfstrings));
3299 break;
3300 }
3301 }
3302
3303 // Add the arch options based on the particular spelling of -arch, to match
3304 // how the driver works.
3305 if (BA) {
3306 StringRef Name = BA.ArchName;
3307 const Option MCpu = Opts.getOption(options::OPT_mcpu_EQ);
3308 const Option MArch = Opts.getOption(options::OPT_march_EQ);
3309
3310 // This code must be kept in sync with LLVM's getArchTypeForDarwinArch,
3311 // which defines the list of which architectures we accept.
3312 if (Name == "ppc")
3313 ;
3314 else if (Name == "ppc601")
3315 DAL->AddJoinedArg(nullptr, MCpu, "601");
3316 else if (Name == "ppc603")
3317 DAL->AddJoinedArg(nullptr, MCpu, "603");
3318 else if (Name == "ppc604")
3319 DAL->AddJoinedArg(nullptr, MCpu, "604");
3320 else if (Name == "ppc604e")
3321 DAL->AddJoinedArg(nullptr, MCpu, "604e");
3322 else if (Name == "ppc750")
3323 DAL->AddJoinedArg(nullptr, MCpu, "750");
3324 else if (Name == "ppc7400")
3325 DAL->AddJoinedArg(nullptr, MCpu, "7400");
3326 else if (Name == "ppc7450")
3327 DAL->AddJoinedArg(nullptr, MCpu, "7450");
3328 else if (Name == "ppc970")
3329 DAL->AddJoinedArg(nullptr, MCpu, "970");
3330
3331 else if (Name == "ppc64" || Name == "ppc64le")
3332 DAL->AddFlagArg(nullptr, Opts.getOption(options::OPT_m64));
3333
3334 else if (Name == "i386")
3335 ;
3336 else if (Name == "i486")
3337 DAL->AddJoinedArg(nullptr, MArch, "i486");
3338 else if (Name == "i586")
3339 DAL->AddJoinedArg(nullptr, MArch, "i586");
3340 else if (Name == "i686")
3341 DAL->AddJoinedArg(nullptr, MArch, "i686");
3342 else if (Name == "pentium")
3343 DAL->AddJoinedArg(nullptr, MArch, "pentium");
3344 else if (Name == "pentium2")
3345 DAL->AddJoinedArg(nullptr, MArch, "pentium2");
3346 else if (Name == "pentpro")
3347 DAL->AddJoinedArg(nullptr, MArch, "pentiumpro");
3348 else if (Name == "pentIIm3")
3349 DAL->AddJoinedArg(nullptr, MArch, "pentium2");
3350
3351 else if (Name == "x86_64" || Name == "x86_64h")
3352 DAL->AddFlagArg(nullptr, Opts.getOption(options::OPT_m64));
3353
3354 else if (Name == "arm")
3355 DAL->AddJoinedArg(nullptr, MArch, "armv4t");
3356 else if (Name == "armv4t")
3357 DAL->AddJoinedArg(nullptr, MArch, "armv4t");
3358 else if (Name == "armv5")
3359 DAL->AddJoinedArg(nullptr, MArch, "armv5tej");
3360 else if (Name == "xscale")
3361 DAL->AddJoinedArg(nullptr, MArch, "xscale");
3362 else if (Name == "armv6")
3363 DAL->AddJoinedArg(nullptr, MArch, "armv6k");
3364 else if (Name == "armv6m")
3365 DAL->AddJoinedArg(nullptr, MArch, "armv6m");
3366 else if (Name == "armv7")
3367 DAL->AddJoinedArg(nullptr, MArch, "armv7a");
3368 else if (Name == "armv7em")
3369 DAL->AddJoinedArg(nullptr, MArch, "armv7em");
3370 else if (Name == "armv7k")
3371 DAL->AddJoinedArg(nullptr, MArch, "armv7k");
3372 else if (Name == "armv7m")
3373 DAL->AddJoinedArg(nullptr, MArch, "armv7m");
3374 else if (Name == "armv7s")
3375 DAL->AddJoinedArg(nullptr, MArch, "armv7s");
3376 else if (Name == "armv8-m.base" || Name == "armv8m.base")
3377 DAL->AddJoinedArg(nullptr, MArch, "armv8m.base");
3378 else if (Name == "armv8-m.main" || Name == "armv8m.main")
3379 DAL->AddJoinedArg(nullptr, MArch, "armv8m.main");
3380 else if (Name == "armv8.1-m.main" || Name == "armv8.1m.main")
3381 DAL->AddJoinedArg(nullptr, MArch, "armv8.1m.main");
3382 }
3383
3384 return DAL;
3385}
3386
3387void MachO::AddLinkRuntimeLibArgs(const ArgList &Args,
3388 ArgStringList &CmdArgs,
3389 bool ForceLinkBuiltinRT) const {
3390 // Embedded targets are simple at the moment, not supporting sanitizers and
3391 // with different libraries for each member of the product { static, PIC } x
3392 // { hard-float, soft-float }
3393 llvm::SmallString<32> CompilerRT = StringRef("");
3394 CompilerRT +=
3396 ? "hard"
3397 : "soft";
3398 CompilerRT += Args.hasArg(options::OPT_fPIC) ? "_pic" : "_static";
3399
3400 AddLinkRuntimeLib(Args, CmdArgs, CompilerRT, RLO_IsEmbedded);
3401}
3402
3404 llvm::Triple::OSType OS;
3405
3406 if (isTargetMacCatalyst())
3407 return TargetVersion < alignedAllocMinVersion(llvm::Triple::MacOSX);
3408 switch (TargetPlatform) {
3409 case MacOS: // Earlier than 10.13.
3410 OS = llvm::Triple::MacOSX;
3411 break;
3412 case IPhoneOS:
3413 OS = llvm::Triple::IOS;
3414 break;
3415 case TvOS: // Earlier than 11.0.
3416 OS = llvm::Triple::TvOS;
3417 break;
3418 case WatchOS: // Earlier than 4.0.
3419 OS = llvm::Triple::WatchOS;
3420 break;
3421 default: // Always available on newer platforms.
3422 return false;
3423 }
3424
3426}
3427
3428static bool
3429sdkSupportsBuiltinModules(const std::optional<DarwinSDKInfo> &SDKInfo) {
3430 if (!SDKInfo)
3431 // If there is no SDK info, assume this is building against an SDK that
3432 // predates SDKSettings.json. None of those support builtin modules.
3433 return false;
3434
3435 switch (SDKInfo->getEnvironment()) {
3436 case llvm::Triple::UnknownEnvironment:
3437 case llvm::Triple::Simulator:
3438 case llvm::Triple::MacABI:
3439 // Standard xnu/Mach/Darwin based environments depend on the SDK version.
3440 break;
3441
3442 default:
3443 // All other environments support builtin modules from the start.
3444 return true;
3445 }
3446
3447 VersionTuple SDKVersion = SDKInfo->getVersion();
3448 switch (SDKInfo->getOS()) {
3449 // Existing SDKs added support for builtin modules in the fall
3450 // 2024 major releases.
3451 case llvm::Triple::MacOSX:
3452 return SDKVersion >= VersionTuple(15U);
3453 case llvm::Triple::IOS:
3454 return SDKVersion >= VersionTuple(18U);
3455 case llvm::Triple::TvOS:
3456 return SDKVersion >= VersionTuple(18U);
3457 case llvm::Triple::WatchOS:
3458 return SDKVersion >= VersionTuple(11U);
3459 case llvm::Triple::XROS:
3460 return SDKVersion >= VersionTuple(2U);
3461
3462 // New SDKs support builtin modules from the start.
3463 default:
3464 return true;
3465 }
3466}
3467
3468static inline llvm::VersionTuple
3469sizedDeallocMinVersion(llvm::Triple::OSType OS) {
3470 switch (OS) {
3471 default:
3472 break;
3473 case llvm::Triple::Darwin:
3474 case llvm::Triple::MacOSX: // Earliest supporting version is 10.12.
3475 return llvm::VersionTuple(10U, 12U);
3476 case llvm::Triple::IOS:
3477 case llvm::Triple::TvOS: // Earliest supporting version is 10.0.0.
3478 return llvm::VersionTuple(10U);
3479 case llvm::Triple::WatchOS: // Earliest supporting version is 3.0.0.
3480 return llvm::VersionTuple(3U);
3481 }
3482
3483 llvm_unreachable("Unexpected OS");
3484}
3485
3487 llvm::Triple::OSType OS;
3488
3489 if (isTargetMacCatalyst())
3490 return TargetVersion < sizedDeallocMinVersion(llvm::Triple::MacOSX);
3491 switch (TargetPlatform) {
3492 case MacOS: // Earlier than 10.12.
3493 OS = llvm::Triple::MacOSX;
3494 break;
3495 case IPhoneOS:
3496 OS = llvm::Triple::IOS;
3497 break;
3498 case TvOS: // Earlier than 10.0.
3499 OS = llvm::Triple::TvOS;
3500 break;
3501 case WatchOS: // Earlier than 3.0.
3502 OS = llvm::Triple::WatchOS;
3503 break;
3504 default:
3505 // Always available on newer platforms.
3506 return false;
3507 }
3508
3510}
3511
3512void MachO::addClangTargetOptions(const llvm::opt::ArgList &DriverArgs,
3513 llvm::opt::ArgStringList &CC1Args,
3514 BoundArch BA,
3515 Action::OffloadKind DeviceOffloadKind) const {
3516
3517 ToolChain::addClangTargetOptions(DriverArgs, CC1Args, BA, DeviceOffloadKind);
3518
3519 // On arm64e, we enable all the features required for the Darwin userspace
3520 // ABI
3521 if (getTriple().isArm64e()) {
3522 // Core platform ABI
3523 if (!DriverArgs.hasArg(options::OPT_fptrauth_calls,
3524 options::OPT_fno_ptrauth_calls))
3525 CC1Args.push_back("-fptrauth-calls");
3526 if (!DriverArgs.hasArg(options::OPT_fptrauth_returns,
3527 options::OPT_fno_ptrauth_returns))
3528 CC1Args.push_back("-fptrauth-returns");
3529 if (!DriverArgs.hasArg(options::OPT_fptrauth_intrinsics,
3530 options::OPT_fno_ptrauth_intrinsics))
3531 CC1Args.push_back("-fptrauth-intrinsics");
3532 if (!DriverArgs.hasArg(options::OPT_fptrauth_indirect_gotos,
3533 options::OPT_fno_ptrauth_indirect_gotos))
3534 CC1Args.push_back("-fptrauth-indirect-gotos");
3535 if (!DriverArgs.hasArg(options::OPT_fptrauth_auth_traps,
3536 options::OPT_fno_ptrauth_auth_traps))
3537 CC1Args.push_back("-fptrauth-auth-traps");
3538
3539 // C++ v-table ABI
3540 if (!DriverArgs.hasArg(
3541 options::OPT_fptrauth_vtable_pointer_address_discrimination,
3542 options::OPT_fno_ptrauth_vtable_pointer_address_discrimination))
3543 CC1Args.push_back("-fptrauth-vtable-pointer-address-discrimination");
3544 if (!DriverArgs.hasArg(
3545 options::OPT_fptrauth_vtable_pointer_type_discrimination,
3546 options::OPT_fno_ptrauth_vtable_pointer_type_discrimination))
3547 CC1Args.push_back("-fptrauth-vtable-pointer-type-discrimination");
3548
3549 // Objective-C ABI
3550 if (!DriverArgs.hasArg(options::OPT_fptrauth_objc_isa,
3551 options::OPT_fno_ptrauth_objc_isa))
3552 CC1Args.push_back("-fptrauth-objc-isa");
3553 if (!DriverArgs.hasArg(options::OPT_fptrauth_objc_class_ro,
3554 options::OPT_fno_ptrauth_objc_class_ro))
3555 CC1Args.push_back("-fptrauth-objc-class-ro");
3556 if (!DriverArgs.hasArg(options::OPT_fptrauth_objc_interface_sel,
3557 options::OPT_fno_ptrauth_objc_interface_sel))
3558 CC1Args.push_back("-fptrauth-objc-interface-sel");
3559 }
3560}
3561
3563 const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args,
3564 BoundArch BA, Action::OffloadKind DeviceOffloadKind) const {
3565
3566 MachO::addClangTargetOptions(DriverArgs, CC1Args, BA, DeviceOffloadKind);
3567
3568 // When compiling device code (e.g. SPIR-V for HIP), skip host-specific
3569 // flags like -faligned-alloc-unavailable and -fno-sized-deallocation
3570 // that depend on the host OS version and are irrelevant to device code.
3571 if (DeviceOffloadKind != Action::OFK_None)
3572 return;
3573
3574 // Pass "-faligned-alloc-unavailable" only when the user hasn't manually
3575 // enabled or disabled aligned allocations.
3576 if (!DriverArgs.hasArgNoClaim(options::OPT_faligned_allocation,
3577 options::OPT_fno_aligned_allocation) &&
3579 CC1Args.push_back("-faligned-alloc-unavailable");
3580
3581 // Enable objc_msgSend selector stubs by default if the linker supports it.
3582 // ld64-811.2+ does, for arm64, arm64e, and arm64_32.
3583 if (!DriverArgs.hasArgNoClaim(options::OPT_fobjc_msgsend_selector_stubs,
3584 options::OPT_fno_objc_msgsend_selector_stubs) &&
3585 getTriple().isAArch64() &&
3586 (getLinkerVersion(DriverArgs) >= VersionTuple(811, 2)))
3587 CC1Args.push_back("-fobjc-msgsend-selector-stubs");
3588
3589 // Enable objc_msgSend class selector stubs by default if the linker supports
3590 // it. ld64-1250+ does, for arm64, arm64e, and arm64_32.
3591 if (!DriverArgs.hasArgNoClaim(
3592 options::OPT_fobjc_msgsend_class_selector_stubs,
3593 options::OPT_fno_objc_msgsend_class_selector_stubs) &&
3594 getTriple().isAArch64() &&
3595 (getLinkerVersion(DriverArgs) >= VersionTuple(1250, 0)))
3596 CC1Args.push_back("-fobjc-msgsend-class-selector-stubs");
3597
3598 // Pass "-fno-sized-deallocation" only when the user hasn't manually enabled
3599 // or disabled sized deallocations.
3600 if (!DriverArgs.hasArgNoClaim(options::OPT_fsized_deallocation,
3601 options::OPT_fno_sized_deallocation) &&
3603 CC1Args.push_back("-fno-sized-deallocation");
3604
3605 addClangCC1ASTargetOptions(DriverArgs, CC1Args);
3606
3607 if (SDKInfo) {
3608 // Make the SDKSettings.json an explicit dependency for the compiler
3609 // invocation, in case the compiler needs to read it to remap versions.
3610 if (!SDKInfo->getFilePath().empty()) {
3611 SmallString<64> ExtraDepOpt("-fdepfile-entry=");
3612 ExtraDepOpt += SDKInfo->getFilePath();
3613 CC1Args.push_back(DriverArgs.MakeArgString(ExtraDepOpt));
3614 }
3615 }
3616
3617 // Enable compatibility mode for NSItemProviderCompletionHandler in
3618 // Foundation/NSItemProvider.h.
3619 CC1Args.push_back("-fcompatibility-qualified-id-block-type-checking");
3620
3621 // Give static local variables in inline functions hidden visibility when
3622 // -fvisibility-inlines-hidden is enabled.
3623 if (!DriverArgs.getLastArgNoClaim(
3624 options::OPT_fvisibility_inlines_hidden_static_local_var,
3625 options::OPT_fno_visibility_inlines_hidden_static_local_var))
3626 CC1Args.push_back("-fvisibility-inlines-hidden-static-local-var");
3627
3628 // Earlier versions of the darwin SDK have the C standard library headers
3629 // all together in the Darwin module. That leads to module cycles with
3630 // the _Builtin_ modules. e.g. <inttypes.h> on darwin includes <stdint.h>.
3631 // The builtin <stdint.h> include-nexts <stdint.h>. When both of those
3632 // darwin headers are in the Darwin module, there's a module cycle Darwin ->
3633 // _Builtin_stdint -> Darwin (i.e. inttypes.h (darwin) -> stdint.h (builtin) ->
3634 // stdint.h (darwin)). This is fixed in later versions of the darwin SDK,
3635 // but until then, the builtin headers need to join the system modules.
3636 // i.e. when the builtin stdint.h is in the Darwin module too, the cycle
3637 // goes away. Note that -fbuiltin-headers-in-system-modules does nothing
3638 // to fix the same problem with C++ headers, and is generally fragile.
3640 CC1Args.push_back("-fbuiltin-headers-in-system-modules");
3641
3642 if (!DriverArgs.hasArgNoClaim(options::OPT_fdefine_target_os_macros,
3643 options::OPT_fno_define_target_os_macros))
3644 CC1Args.push_back("-fdefine-target-os-macros");
3645}
3646
3648 const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CC1ASArgs) const {
3649 if (TargetVariantTriple) {
3650 CC1ASArgs.push_back("-darwin-target-variant-triple");
3651 CC1ASArgs.push_back(Args.MakeArgString(TargetVariantTriple->getTriple()));
3652 }
3653
3654 if (SDKInfo) {
3655 /// Pass the SDK version to the compiler when the SDK information is
3656 /// available.
3657 auto EmitTargetSDKVersionArg = [&](const VersionTuple &V) {
3658 std::string Arg;
3659 llvm::raw_string_ostream OS(Arg);
3660 OS << "-target-sdk-version=" << V;
3661 CC1ASArgs.push_back(Args.MakeArgString(Arg));
3662 };
3663
3664 if (isTargetMacCatalyst()) {
3665 if (const auto *MacOStoMacCatalystMapping = SDKInfo->getVersionMapping(
3667 std::optional<VersionTuple> SDKVersion = MacOStoMacCatalystMapping->map(
3669 std::nullopt);
3670 EmitTargetSDKVersionArg(
3671 SDKVersion ? *SDKVersion : minimumMacCatalystDeploymentTarget());
3672 }
3673 } else {
3674 EmitTargetSDKVersionArg(SDKInfo->getVersion());
3675 }
3676
3677 /// Pass the target variant SDK version to the compiler when the SDK
3678 /// information is available and is required for target variant.
3679 if (TargetVariantTriple) {
3680 if (isTargetMacCatalyst()) {
3681 std::string Arg;
3682 llvm::raw_string_ostream OS(Arg);
3683 OS << "-darwin-target-variant-sdk-version=" << SDKInfo->getVersion();
3684 CC1ASArgs.push_back(Args.MakeArgString(Arg));
3685 } else if (const auto *MacOStoMacCatalystMapping =
3686 SDKInfo->getVersionMapping(
3688 if (std::optional<VersionTuple> SDKVersion =
3689 MacOStoMacCatalystMapping->map(
3691 std::nullopt)) {
3692 std::string Arg;
3693 llvm::raw_string_ostream OS(Arg);
3694 OS << "-darwin-target-variant-sdk-version=" << *SDKVersion;
3695 CC1ASArgs.push_back(Args.MakeArgString(Arg));
3696 }
3697 }
3698 }
3699 }
3700}
3701
3702DerivedArgList *
3703Darwin::TranslateArgs(const DerivedArgList &Args, BoundArch BA,
3704 Action::OffloadKind DeviceOffloadKind) const {
3705 // First get the generic Apple args, before moving onto Darwin-specific ones.
3706 DerivedArgList *DAL = MachO::TranslateArgs(Args, BA, DeviceOffloadKind);
3707
3708 // If no architecture is bound, none of the translations here are relevant.
3709 if (!BA)
3710 return DAL;
3711
3712 // Add an explicit version min argument for the deployment target. We do this
3713 // after argument translation because -Xarch_ arguments may add a version min
3714 // argument.
3715 AddDeploymentTarget(*DAL);
3716
3717 // For iOS 6, undo the translation to add -static for -mkernel/-fapple-kext.
3718 // FIXME: It would be far better to avoid inserting those -static arguments,
3719 // but we can't check the deployment target in the translation code until
3720 // it is set here.
3722 (isTargetIOSBased() && !isIPhoneOSVersionLT(6, 0))) {
3723 for (ArgList::iterator it = DAL->begin(), ie = DAL->end(); it != ie; ) {
3724 Arg *A = *it;
3725 ++it;
3726 if (A->getOption().getID() != options::OPT_mkernel &&
3727 A->getOption().getID() != options::OPT_fapple_kext)
3728 continue;
3729 assert(it != ie && "unexpected argument translation");
3730 A = *it;
3731 assert(A->getOption().getID() == options::OPT_static &&
3732 "missing expected -static argument");
3733 *it = nullptr;
3734 ++it;
3735 }
3736 }
3737
3739 if ((Arch == llvm::Triple::arm || Arch == llvm::Triple::thumb)) {
3740 if (Args.hasFlag(options::OPT_fomit_frame_pointer,
3741 options::OPT_fno_omit_frame_pointer, false))
3742 getDriver().Diag(clang::diag::warn_drv_unsupported_opt_for_target)
3743 << "-fomit-frame-pointer" << BA.ArchName;
3744 }
3745
3746 return DAL;
3747}
3748
3750 // Unwind tables are not emitted if -fno-exceptions is supplied (except when
3751 // targeting x86_64).
3752 if (getArch() == llvm::Triple::x86_64 ||
3753 (GetExceptionModel(Args) != llvm::ExceptionHandling::SjLj &&
3754 Args.hasFlag(options::OPT_fexceptions, options::OPT_fno_exceptions,
3755 true)))
3756 return (getArch() == llvm::Triple::aarch64 ||
3757 getArch() == llvm::Triple::aarch64_32)
3760
3762}
3763
3765 if (const char *S = ::getenv("RC_DEBUG_OPTIONS"))
3766 return S[0] != '\0';
3767 return false;
3768}
3769
3771 if (const char *S = ::getenv("RC_DEBUG_PREFIX_MAP"))
3772 return S;
3773 return {};
3774}
3775
3776llvm::ExceptionHandling Darwin::GetExceptionModel(const ArgList &Args) const {
3777 // Darwin uses SjLj exceptions on ARM.
3778 if (getTriple().getArch() != llvm::Triple::arm &&
3779 getTriple().getArch() != llvm::Triple::thumb)
3780 return llvm::ExceptionHandling::Default;
3781
3782 // Only watchOS uses the new DWARF/Compact unwinding method.
3783 llvm::Triple Triple(ComputeLLVMTriple(Args));
3784 if (Triple.isWatchABI())
3785 return llvm::ExceptionHandling::DwarfCFI;
3786
3787 return llvm::ExceptionHandling::SjLj;
3788}
3789
3791 assert(TargetInitialized && "Target not initialized!");
3793 return false;
3794 return true;
3795}
3796
3797bool MachO::isPICDefault() const { return true; }
3798
3799bool MachO::isPIEDefault(const llvm::opt::ArgList &Args) const { return false; }
3800
3802 return (getArch() == llvm::Triple::x86_64 ||
3803 getArch() == llvm::Triple::aarch64);
3804}
3805
3807 // Profiling instrumentation is only supported on x86.
3808 return getTriple().isX86();
3809}
3810
3811void Darwin::addMinVersionArgs(const ArgList &Args,
3812 ArgStringList &CmdArgs) const {
3813 VersionTuple TargetVersion = getTripleTargetVersion();
3814
3815 assert(!isTargetXROS() && "xrOS always uses -platform-version");
3816
3817 if (isTargetWatchOS())
3818 CmdArgs.push_back("-watchos_version_min");
3819 else if (isTargetWatchOSSimulator())
3820 CmdArgs.push_back("-watchos_simulator_version_min");
3821 else if (isTargetTvOS())
3822 CmdArgs.push_back("-tvos_version_min");
3823 else if (isTargetTvOSSimulator())
3824 CmdArgs.push_back("-tvos_simulator_version_min");
3825 else if (isTargetDriverKit())
3826 CmdArgs.push_back("-driverkit_version_min");
3827 else if (isTargetIOSSimulator())
3828 CmdArgs.push_back("-ios_simulator_version_min");
3829 else if (isTargetIOSBased())
3830 CmdArgs.push_back("-iphoneos_version_min");
3831 else if (isTargetMacCatalyst())
3832 CmdArgs.push_back("-maccatalyst_version_min");
3833 else {
3834 assert(isTargetMacOS() && "unexpected target");
3835 CmdArgs.push_back("-macosx_version_min");
3836 }
3837
3838 VersionTuple MinTgtVers = getEffectiveTriple().getMinimumSupportedOSVersion();
3839 if (!MinTgtVers.empty() && MinTgtVers > TargetVersion)
3840 TargetVersion = MinTgtVers;
3841 CmdArgs.push_back(Args.MakeArgString(TargetVersion.getAsString()));
3842 if (TargetVariantTriple) {
3843 assert(isTargetMacOSBased() && "unexpected target");
3844 VersionTuple VariantTargetVersion;
3845 if (TargetVariantTriple->isMacOSX()) {
3846 CmdArgs.push_back("-macosx_version_min");
3847 TargetVariantTriple->getMacOSXVersion(VariantTargetVersion);
3848 } else {
3849 assert(TargetVariantTriple->isiOS() &&
3850 TargetVariantTriple->isMacCatalystEnvironment() &&
3851 "unexpected target variant triple");
3852 CmdArgs.push_back("-maccatalyst_version_min");
3853 VariantTargetVersion = TargetVariantTriple->getiOSVersion();
3854 }
3855 VersionTuple MinTgtVers =
3856 TargetVariantTriple->getMinimumSupportedOSVersion();
3857 if (MinTgtVers.getMajor() && MinTgtVers > VariantTargetVersion)
3858 VariantTargetVersion = MinTgtVers;
3859 CmdArgs.push_back(Args.MakeArgString(VariantTargetVersion.getAsString()));
3860 }
3861}
3862
3864 Darwin::DarwinEnvironmentKind Environment) {
3865 switch (Platform) {
3866 case Darwin::MacOS:
3867 return "macos";
3868 case Darwin::IPhoneOS:
3869 if (Environment == Darwin::MacCatalyst)
3870 return "mac catalyst";
3871 return "ios";
3872 case Darwin::TvOS:
3873 return "tvos";
3874 case Darwin::WatchOS:
3875 return "watchos";
3876 case Darwin::XROS:
3877 return "xros";
3878 case Darwin::DriverKit:
3879 return "driverkit";
3880 default:
3881 break;
3882 }
3883 llvm_unreachable("invalid platform");
3884}
3885
3886void Darwin::addPlatformVersionArgs(const llvm::opt::ArgList &Args,
3887 llvm::opt::ArgStringList &CmdArgs) const {
3888 // Firmware doesn't use -platform_version.
3890 return MachO::addPlatformVersionArgs(Args, CmdArgs);
3891
3892 auto EmitPlatformVersionArg =
3893 [&](const VersionTuple &TV, Darwin::DarwinPlatformKind TargetPlatform,
3895 const llvm::Triple &TT) {
3896 // -platform_version <platform> <target_version> <sdk_version>
3897 // Both the target and SDK version support only up to 3 components.
3898 CmdArgs.push_back("-platform_version");
3899 std::string PlatformName =
3902 PlatformName += "-simulator";
3903 CmdArgs.push_back(Args.MakeArgString(PlatformName));
3904 VersionTuple TargetVersion = TV.withoutBuild();
3907 getTriple().getArchName() == "arm64e" &&
3908 TargetVersion.getMajor() < 14) {
3909 // arm64e slice is supported on iOS/tvOS 14+ only.
3910 TargetVersion = VersionTuple(14, 0);
3911 }
3912 VersionTuple MinTgtVers = TT.getMinimumSupportedOSVersion();
3913 if (!MinTgtVers.empty() && MinTgtVers > TargetVersion)
3914 TargetVersion = MinTgtVers;
3915 CmdArgs.push_back(Args.MakeArgString(TargetVersion.getAsString()));
3916
3918 // Mac Catalyst programs must use the appropriate iOS SDK version
3919 // that corresponds to the macOS SDK version used for the compilation.
3920 std::optional<VersionTuple> iOSSDKVersion;
3921 if (SDKInfo) {
3922 if (const auto *MacOStoMacCatalystMapping =
3923 SDKInfo->getVersionMapping(
3925 iOSSDKVersion = MacOStoMacCatalystMapping->map(
3926 SDKInfo->getVersion().withoutBuild(),
3927 minimumMacCatalystDeploymentTarget(), std::nullopt);
3928 }
3929 }
3930 CmdArgs.push_back(Args.MakeArgString(
3931 (iOSSDKVersion ? *iOSSDKVersion
3933 .getAsString()));
3934 return;
3935 }
3936
3937 if (SDKInfo) {
3938 VersionTuple SDKVersion = SDKInfo->getVersion().withoutBuild();
3939 if (!SDKVersion.getMinor())
3940 SDKVersion = VersionTuple(SDKVersion.getMajor(), 0);
3941 CmdArgs.push_back(Args.MakeArgString(SDKVersion.getAsString()));
3942 } else {
3943 // Use an SDK version that's matching the deployment target if the SDK
3944 // version is missing. This is preferred over an empty SDK version
3945 // (0.0.0) as the system's runtime might expect the linked binary to
3946 // contain a valid SDK version in order for the binary to work
3947 // correctly. It's reasonable to use the deployment target version as
3948 // a proxy for the SDK version because older SDKs don't guarantee
3949 // support for deployment targets newer than the SDK versions, so that
3950 // rules out using some predetermined older SDK version, which leaves
3951 // the deployment target version as the only reasonable choice.
3952 CmdArgs.push_back(Args.MakeArgString(TargetVersion.getAsString()));
3953 }
3954 };
3955 EmitPlatformVersionArg(getTripleTargetVersion(), TargetPlatform,
3958 return;
3961 VersionTuple TargetVariantVersion;
3962 if (TargetVariantTriple->isMacOSX()) {
3963 TargetVariantTriple->getMacOSXVersion(TargetVariantVersion);
3964 Platform = Darwin::MacOS;
3965 Environment = Darwin::NativeEnvironment;
3966 } else {
3967 assert(TargetVariantTriple->isiOS() &&
3968 TargetVariantTriple->isMacCatalystEnvironment() &&
3969 "unexpected target variant triple");
3970 TargetVariantVersion = TargetVariantTriple->getiOSVersion();
3971 Platform = Darwin::IPhoneOS;
3972 Environment = Darwin::MacCatalyst;
3973 }
3974 EmitPlatformVersionArg(TargetVariantVersion, Platform, Environment,
3976}
3977
3978// Add additional link args for the -dynamiclib option.
3979static void addDynamicLibLinkArgs(const Darwin &D, const ArgList &Args,
3980 ArgStringList &CmdArgs) {
3981 // Derived from darwin_dylib1 spec.
3982 if (D.isTargetIPhoneOS()) {
3983 if (D.isIPhoneOSVersionLT(3, 1))
3984 CmdArgs.push_back("-ldylib1.o");
3985 return;
3986 }
3987
3988 if (!D.isTargetMacOS())
3989 return;
3990 if (D.isMacosxVersionLT(10, 5))
3991 CmdArgs.push_back("-ldylib1.o");
3992 else if (D.isMacosxVersionLT(10, 6))
3993 CmdArgs.push_back("-ldylib1.10.5.o");
3994}
3995
3996// Add additional link args for the -bundle option.
3997static void addBundleLinkArgs(const Darwin &D, const ArgList &Args,
3998 ArgStringList &CmdArgs) {
3999 if (Args.hasArg(options::OPT_static))
4000 return;
4001 // Derived from darwin_bundle1 spec.
4002 if ((D.isTargetIPhoneOS() && D.isIPhoneOSVersionLT(3, 1)) ||
4003 (D.isTargetMacOS() && D.isMacosxVersionLT(10, 6)))
4004 CmdArgs.push_back("-lbundle1.o");
4005}
4006
4007// Add additional link args for the -pg option.
4008static void addPgProfilingLinkArgs(const Darwin &D, const ArgList &Args,
4009 ArgStringList &CmdArgs) {
4010 if (D.isTargetMacOS() && D.isMacosxVersionLT(10, 9)) {
4011 if (Args.hasArg(options::OPT_static) || Args.hasArg(options::OPT_object) ||
4012 Args.hasArg(options::OPT_preload)) {
4013 CmdArgs.push_back("-lgcrt0.o");
4014 } else {
4015 CmdArgs.push_back("-lgcrt1.o");
4016
4017 // darwin_crt2 spec is empty.
4018 }
4019 // By default on OS X 10.8 and later, we don't link with a crt1.o
4020 // file and the linker knows to use _main as the entry point. But,
4021 // when compiling with -pg, we need to link with the gcrt1.o file,
4022 // so pass the -no_new_main option to tell the linker to use the
4023 // "start" symbol as the entry point.
4024 if (!D.isMacosxVersionLT(10, 8))
4025 CmdArgs.push_back("-no_new_main");
4026 } else {
4027 D.getDriver().Diag(diag::err_drv_clang_unsupported_opt_pg_darwin)
4028 << D.isTargetMacOSBased();
4029 }
4030}
4031
4032static void addDefaultCRTLinkArgs(const Darwin &D, const ArgList &Args,
4033 ArgStringList &CmdArgs) {
4034 // Derived from darwin_crt1 spec.
4035 if (D.isTargetIPhoneOS()) {
4036 if (D.getArch() == llvm::Triple::aarch64)
4037 ; // iOS does not need any crt1 files for arm64
4038 else if (D.isIPhoneOSVersionLT(3, 1))
4039 CmdArgs.push_back("-lcrt1.o");
4040 else if (D.isIPhoneOSVersionLT(6, 0))
4041 CmdArgs.push_back("-lcrt1.3.1.o");
4042 return;
4043 }
4044
4045 if (!D.isTargetMacOS())
4046 return;
4047 if (D.isMacosxVersionLT(10, 5))
4048 CmdArgs.push_back("-lcrt1.o");
4049 else if (D.isMacosxVersionLT(10, 6))
4050 CmdArgs.push_back("-lcrt1.10.5.o");
4051 else if (D.isMacosxVersionLT(10, 8))
4052 CmdArgs.push_back("-lcrt1.10.6.o");
4053 // darwin_crt2 spec is empty.
4054}
4055
4056void Darwin::addStartObjectFileArgs(const ArgList &Args,
4057 ArgStringList &CmdArgs) const {
4058 // Firmware uses the "bare metal" start object file args.
4059 if (isTargetFirmware())
4060 return MachO::addStartObjectFileArgs(Args, CmdArgs);
4061
4062 // Derived from startfile spec.
4063 if (Args.hasArg(options::OPT_dynamiclib))
4064 addDynamicLibLinkArgs(*this, Args, CmdArgs);
4065 else if (Args.hasArg(options::OPT_bundle))
4066 addBundleLinkArgs(*this, Args, CmdArgs);
4067 else if (Args.hasArg(options::OPT_pg) && SupportsProfiling())
4068 addPgProfilingLinkArgs(*this, Args, CmdArgs);
4069 else if (Args.hasArg(options::OPT_static) ||
4070 Args.hasArg(options::OPT_object) ||
4071 Args.hasArg(options::OPT_preload))
4072 CmdArgs.push_back("-lcrt0.o");
4073 else
4074 addDefaultCRTLinkArgs(*this, Args, CmdArgs);
4075
4076 if (isTargetMacOS() && Args.hasArg(options::OPT_shared_libgcc) &&
4077 isMacosxVersionLT(10, 5)) {
4078 const char *Str = Args.MakeArgString(GetFilePath("crt3.o"));
4079 CmdArgs.push_back(Str);
4080 }
4081}
4082
4085 if (!isTargetInitialized())
4086 return;
4089 return;
4090 getDriver().Diag(diag::err_arc_unsupported_on_toolchain);
4091}
4092
4095 Action::OffloadKind DeviceOffloadKind) const {
4096 const bool IsX86_64 = getTriple().getArch() == llvm::Triple::x86_64;
4097 const bool IsAArch64 = getTriple().getArch() == llvm::Triple::aarch64;
4098 SanitizerMask Res = ToolChain::getSupportedSanitizers(BA, DeviceOffloadKind);
4099 Res |= SanitizerKind::Address;
4100 Res |= SanitizerKind::PointerCompare;
4101 Res |= SanitizerKind::PointerSubtract;
4102 Res |= SanitizerKind::Realtime;
4103 Res |= SanitizerKind::Leak;
4104 Res |= SanitizerKind::Fuzzer;
4105 Res |= SanitizerKind::FuzzerNoLink;
4106 Res |= SanitizerKind::ObjCCast;
4107
4109 if (!isTargetInitialized())
4110 return Res;
4111 // Prior to 10.9, macOS shipped a version of the C++ standard library without
4112 // C++11 support. The same is true of iOS prior to version 5. These OS'es are
4113 // incompatible with -fsanitize=vptr.
4114 if (!(isTargetMacOSBased() && isMacosxVersionLT(10, 9)) &&
4116 Res |= SanitizerKind::Vptr;
4117
4118 if ((IsX86_64 || IsAArch64) &&
4121 Res |= SanitizerKind::Thread;
4122 }
4123
4124 if ((IsX86_64 || IsAArch64) && isTargetMacOSBased()) {
4125 Res |= SanitizerKind::Type;
4126 }
4127
4128 if (IsX86_64)
4129 Res |= SanitizerKind::NumericalStability;
4130
4131 return Res;
4132}
4133
4134void AppleMachO::printVerboseInfo(raw_ostream &OS) const {
4135 CudaInstallation->print(OS);
4136 RocmInstallation->print(OS);
4137}
#define V(N, I)
Defines a function that returns the minimum OS versions supporting C++17's aligned allocation functio...
static bool hasMultipleInvocations(const llvm::Triple &Triple, const ArgList &Args)
Definition Clang.cpp:1251
static bool checkRemarksOptions(const Driver &D, const ArgList &Args, const llvm::Triple &Triple)
Definition Clang.cpp:1262
static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs, const llvm::Triple &Triple, const InputInfo &Input, const InputInfo &Output, const JobAction &JA)
Definition Clang.cpp:1278
static bool sdkSupportsBuiltinModules(const std::optional< DarwinSDKInfo > &SDKInfo)
Definition Darwin.cpp:3429
static void addPgProfilingLinkArgs(const Darwin &D, const ArgList &Args, ArgStringList &CmdArgs)
Definition Darwin.cpp:4008
static const char * ArmMachOArchName(StringRef Arch)
Definition Darwin.cpp:1147
static void AddMachOSysLibRoot(Compilation &C, const ArgList &Args, ArgStringList &CmdArgs)
Definition Darwin.cpp:210
static bool shouldLinkerNotDedup(bool IsLinkerOnlyAction, const ArgList &Args)
Pass -no_deduplicate to ld64 under certain conditions:
Definition Darwin.cpp:247
static bool hasExportSymbolDirective(const ArgList &Args)
Check if the link command contains a symbol export directive.
Definition Darwin.cpp:1672
static void addDefaultCRTLinkArgs(const Darwin &D, const ArgList &Args, ArgStringList &CmdArgs)
Definition Darwin.cpp:4032
static void addBundleLinkArgs(const Darwin &D, const ArgList &Args, ArgStringList &CmdArgs)
Definition Darwin.cpp:3997
static llvm::VersionTuple sizedDeallocMinVersion(llvm::Triple::OSType OS)
Definition Darwin.cpp:3469
static VersionTuple minimumMacCatalystDeploymentTarget()
Definition Darwin.cpp:40
static std::string getSystemOrSDKMacOSVersion(StringRef MacOSSDKVersion)
Returns the most appropriate macOS target version for the current process.
Definition Darwin.cpp:1901
static void addDynamicLibLinkArgs(const Darwin &D, const ArgList &Args, ArgStringList &CmdArgs)
Definition Darwin.cpp:3979
static bool isObjCRuntimeLinked(const ArgList &Args)
Determine whether we are linking the ObjC runtime.
Definition Darwin.cpp:553
static const char * getPlatformName(Darwin::DarwinPlatformKind Platform, Darwin::DarwinEnvironmentKind Environment)
Definition Darwin.cpp:3863
static const char * ArmMachOArchNameCPU(StringRef CPU)
Definition Darwin.cpp:1167
static void addExportedSymbol(ArgStringList &CmdArgs, const char *Symbol)
Add an export directive for Symbol to the link command.
Definition Darwin.cpp:1687
static StringRef getXcodeDeveloperPath(StringRef PathIntoXcode)
Take a path that speculatively points into Xcode and return the XCODE/Contents/Developer path if it i...
Definition Darwin.cpp:1439
static void addSectalignToPage(const ArgList &Args, ArgStringList &CmdArgs, StringRef Segment, StringRef Section)
Add a sectalign directive for Segment and Section to the maximum expected page size for Darwin.
Definition Darwin.cpp:1698
Result
Implement __builtin_bit_cast and related operations.
static StringRef getTriple(const Command &Job)
Defines types useful for describing an Objective-C runtime.
const llvm::VersionTuple & getDefaultDeploymentTarget() const
const llvm::Triple & getCanonicalPlatformTriple() const
The basic abstraction for the target Objective-C runtime.
Definition ObjCRuntime.h:28
bool hasNativeARC() const
Does this runtime natively provide the ARC entrypoints?
bool hasSubscripting() const
Does this runtime directly support the subscripting methods?
@ MacOSX
'macosx' is the Apple-provided NeXT-derived runtime on Mac OS X platforms that use the non-fragile AB...
Definition ObjCRuntime.h:35
@ FragileMacOSX
'macosx-fragile' is the Apple-provided NeXT-derived runtime on Mac OS X platforms that use the fragil...
Definition ObjCRuntime.h:40
@ iOS
'ios' is the Apple-provided NeXT-derived runtime on iOS or the iOS simulator; it is always non-fragil...
Definition ObjCRuntime.h:45
@ WatchOS
'watchos' is a variant of iOS for Apple's watchOS.
Definition ObjCRuntime.h:49
The base class of the type hierarchy.
Definition TypeBase.h:1879
Action - Represent an abstract compilation step to perform.
Definition Action.h:48
types::ID getType() const
Definition Action.h:153
ActionClass getKind() const
Definition Action.h:152
ActionList & getInputs()
Definition Action.h:155
Compilation - A set of tasks to perform for a single driver invocation.
Definition Compilation.h:46
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition Driver.h:93
std::string SysRoot
sysroot, if present
Definition Driver.h:193
std::string GetTemporaryDirectory(StringRef Prefix) const
GetTemporaryDirectory - Return the pathname of a temporary directory to use as part of compilation; t...
Definition Driver.cpp:6108
DiagnosticBuilder Diag(unsigned DiagID) const
Definition Driver.h:157
static bool GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor, unsigned &Micro, bool &HadExtra)
GetReleaseVersion - Parse (([0-9]+)(.
Definition Driver.cpp:6484
const llvm::opt::OptTable & getOpts() const
Definition Driver.h:406
std::string GetTemporaryPath(StringRef Prefix, StringRef Suffix) const
GetTemporaryPath - Return the pathname of a temporary file to use as part of compilation; the file wi...
Definition Driver.cpp:6097
std::string Dir
The path the driver executable was in, as invoked from the command line.
Definition Driver.h:168
InputInfo - Wrapper for information about an input source.
Definition InputInfo.h:22
const char * getFilename() const
Definition InputInfo.h:83
bool isFilename() const
Definition InputInfo.h:75
types::ID getType() const
Definition InputInfo.h:77
static void addSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory to CC1 arguments.
virtual RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const
bool ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const
Returns if the C++ standard library should be linked in.
static void addSystemFrameworkIncludes(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, ArrayRef< StringRef > Paths)
Utility function to add a list of system framework directories to CC1.
static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, const Twine &Path)
Utility function to add a system include directory with extern "C" semantics to CC1 arguments.
std::string GetFilePath(const char *Name) const
static bool needsProfileRT(const llvm::opt::ArgList &Args)
needsProfileRT - returns true if instrumentation profile is on.
StringRef getOS() const
Definition ToolChain.h:301
virtual SanitizerMask getSupportedSanitizers(BoundArch BA, Action::OffloadKind DeviceOffloadKind) const
Return sanitizers which are available in this toolchain.
llvm::Triple::ArchType getArch() const
Definition ToolChain.h:298
const Driver & getDriver() const
Definition ToolChain.h:282
llvm::vfs::FileSystem & getVFS() const
static bool needsGCovInstrumentation(const llvm::opt::ArgList &Args)
Returns true if gcov instrumentation (-fprofile-arcs or –coverage) is on.
ToolChain(const Driver &D, const llvm::Triple &T, const llvm::opt::ArgList &Args)
Definition ToolChain.cpp:93
virtual bool SupportsEmbeddedBitcode() const
SupportsEmbeddedBitcode - Does this tool chain support embedded bitcode.
Definition ToolChain.h:697
path_list & getProgramPaths()
Definition ToolChain.h:325
bool hasEffectiveTriple() const
Definition ToolChain.h:315
virtual void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const
Add options that need to be passed to cc1 for this target.
const llvm::Triple & getEffectiveTriple() const
Get the toolchain's effective clang triple.
Definition ToolChain.h:310
const llvm::Triple & getTriple() const
Definition ToolChain.h:284
virtual types::ID LookupTypeForExtension(StringRef Ext) const
LookupTypeForExtension - Return the default language type to use for the given extension.
const XRayArgs getXRayArgs(const llvm::opt::ArgList &) const
virtual std::string ComputeLLVMTriple(const llvm::opt::ArgList &Args, BoundArch BA={}, types::ID InputType=types::TY_INVALID) const
ComputeLLVMTriple - Return the LLVM target triple to use, after taking command line arguments into ac...
virtual void AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const
AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set the include paths to use for...
StringRef getDefaultUniversalArchName() const
Provide the default architecture name (as expected by -arch) for this toolchain.
virtual CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const
SanitizerArgs getSanitizerArgs(const llvm::opt::ArgList &JobArgs, BoundArch BA={}, Action::OffloadKind DeviceOffloadKind=Action::OFK_None) const
virtual Tool * getTool(Action::ActionClass AC) const
StringRef getArchName() const
Definition ToolChain.h:299
Tool - Information on a specific compilation tool.
Definition Tool.h:32
const ToolChain & getToolChain() const
Definition Tool.h:52
bool needsXRayRt() const
Definition XRayArgs.h:38
void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
AddCXXStdlibLibArgs - Add the system specific linker arguments to use for the given C++ standard libr...
Definition Darwin.cpp:3157
void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add arguments to use system-specific CUDA includes.
Definition Darwin.cpp:1128
void AddHIPIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add arguments to use system-specific HIP includes.
Definition Darwin.cpp:1133
void printVerboseInfo(raw_ostream &OS) const override
Dispatch to the specific toolchain for verbose printing.
Definition Darwin.cpp:4134
llvm::SmallString< 128 > GetEffectiveSysroot(const llvm::opt::ArgList &DriverArgs) const
Definition Darwin.cpp:2935
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition Darwin.cpp:2948
LazyDetector< RocmInstallationDetector > RocmInstallation
Definition Darwin.h:337
LazyDetector< SYCLInstallationDetector > SYCLInstallation
Definition Darwin.h:338
void AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
AddClangCXXStdlibIncludeArgs - Add the clang -cc1 level arguments to set the include paths to use for...
Definition Darwin.cpp:3048
LazyDetector< CudaInstallationDetector > CudaInstallation
}
Definition Darwin.h:336
AppleMachO(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Definition Darwin.cpp:1070
void addSYCLIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add arguments to use system-specific SYCL includes.
Definition Darwin.cpp:1138
void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const override
Add warning options that need to be passed to cc1 for this target.
Definition Darwin.cpp:1405
void AppendPlatformPrefix(SmallString< 128 > &Path, const llvm::Triple &T) const override
Definition Darwin.cpp:2919
void AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args) const override
Add the clang cc1 arguments for system include paths.
Definition Darwin.cpp:2997
void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
Add options that need to be passed to cc1 for this target.
Definition Darwin.cpp:1429
void AddCCKextLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
AddCCKextLibArgs - Add the system specific linker arguments to use for kernel extensions (Darwin-spec...
Definition Darwin.cpp:3204
bool getDefaultDebugSimpleTemplateNames() const override
Returns true if this toolchain adds '-gsimple-template-names=simple' by default when generating debug...
Definition Darwin.cpp:1542
void AddLinkRuntimeLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool ForceLinkBuiltinRT=false) const override
Add the linker arguments to link the compiler runtime library.
Definition Darwin.cpp:1764
RuntimeLibType GetRuntimeLibType(const llvm::opt::ArgList &Args) const override
Definition Darwin.cpp:1752
DarwinClang(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Definition Darwin.cpp:1401
void AddLinkARCArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
Add the linker arguments to link the ARC runtime library.
Definition Darwin.cpp:1448
bool HasPlatformPrefix(const llvm::Triple &T) const override
Definition Darwin.cpp:2909
unsigned GetDefaultDwarfVersion() const override
Definition Darwin.cpp:1525
Darwin - The base Darwin tool chain.
Definition Darwin.h:351
VersionTuple TargetVersion
The native OS version we are targeting.
Definition Darwin.h:385
void addPlatformVersionArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
Definition Darwin.cpp:3886
bool TargetInitialized
Whether the information on the target has been initialized.
Definition Darwin.h:358
bool isIPhoneOSVersionLT(unsigned V0, unsigned V1=0, unsigned V2=0) const
Definition Darwin.h:576
bool SupportsEmbeddedBitcode() const override
SupportsEmbeddedBitcode - Does this tool chain support embedded bitcode.
Definition Darwin.cpp:3790
void addProfileRTLibs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
addProfileRTLibs - When -fprofile-instr-profile is specified, try to pass a suitable profile runtime ...
Definition Darwin.cpp:1705
Darwin(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Darwin - Darwin tool chain for i386 and x86_64.
Definition Darwin.cpp:1076
void CheckObjCARC() const override
Complain if this tool chain doesn't support Objective-C ARC.
Definition Darwin.cpp:4083
llvm::ExceptionHandling GetExceptionModel(const llvm::opt::ArgList &Args) const override
GetExceptionModel - Return the tool chain exception model.
Definition Darwin.cpp:3776
std::optional< DarwinSDKInfo > SDKInfo
The information about the darwin SDK that was used.
Definition Darwin.h:390
bool isSizedDeallocationUnavailable() const
Return true if c++14 sized deallocation functions are not implemented in the c++ standard library of ...
Definition Darwin.cpp:3486
std::string getCompilerRT(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static, bool IsFortran=false) const override
Definition Darwin.cpp:1609
void ensureTargetInitialized() const
Lazily initialize the target platform from the triple when AddDeploymentTarget has not run yet (e....
Definition Darwin.cpp:1241
llvm::opt::DerivedArgList * TranslateArgs(const llvm::opt::DerivedArgList &Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
TranslateArgs - Create a new derived argument list for any argument translations this ToolChain may w...
Definition Darwin.cpp:3703
ObjCRuntime getDefaultObjCRuntime(bool isNonFragile) const override
Darwin provides an ARC runtime starting in MacOS X 10.7 and iOS 5.0.
Definition Darwin.cpp:1097
bool hasBlocksRuntime() const override
Darwin provides a blocks runtime starting in MacOS X 10.6 and iOS 3.2.
Definition Darwin.cpp:1115
bool isMacosxVersionLT(unsigned V0, unsigned V1=0, unsigned V2=0) const
Returns true if the minimum supported macOS version for the slice that's being built is less than the...
Definition Darwin.h:586
bool isTargetAppleSiliconMac() const
Definition Darwin.h:560
static StringRef getSDKName(StringRef isysroot)
Definition Darwin.cpp:1632
void addClangCC1ASTargetOptions(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CC1ASArgs) const override
Add options that need to be passed to cc1as for this target.
Definition Darwin.cpp:3647
void setTarget(DarwinPlatformKind Platform, DarwinEnvironmentKind Environment, unsigned Major, unsigned Minor, unsigned Micro, VersionTuple NativeTargetVersion) const
Definition Darwin.h:449
CXXStdlibType GetDefaultCXXStdlibType() const override
Definition Darwin.cpp:1091
bool isTargetWatchOSSimulator() const
Definition Darwin.h:529
DarwinPlatformKind TargetPlatform
Definition Darwin.h:381
StringRef getOSLibraryNameSuffix(bool IgnoreSim=false) const override
Definition Darwin.cpp:1644
void addMinVersionArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
Definition Darwin.cpp:3811
void addStartObjectFileArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const override
Definition Darwin.cpp:4056
std::optional< llvm::Triple > TargetVariantTriple
The target variant triple that was specified (if any).
Definition Darwin.h:393
VersionTuple getTripleTargetVersion() const
The version of the OS that's used by the OS specified in the target triple.
Definition Darwin.h:571
bool TargetInitializedLazily
Whether the target was lazily initialized from the triple by ensureTargetInitialized() rather than by...
Definition Darwin.h:363
bool isAlignedAllocationUnavailable() const
Return true if c++17 aligned allocation/deallocation functions are not implemented in the c++ standar...
Definition Darwin.cpp:3403
std::string ComputeEffectiveClangTriple(const llvm::opt::ArgList &Args, BoundArch BA, types::ID InputType) const override
ComputeEffectiveClangTriple - Return the Clang triple to use for this target, which may take into acc...
Definition Darwin.cpp:1335
void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
Add options that need to be passed to cc1 for this target.
Definition Darwin.cpp:3562
SanitizerMask getSupportedSanitizers(BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
Return sanitizers which are available in this toolchain.
Definition Darwin.cpp:4094
DarwinEnvironmentKind TargetEnvironment
Definition Darwin.h:382
VersionTuple getLinkerVersion(const llvm::opt::ArgList &Args) const
Get the version of the linker known to be available for a particular compiler invocation (via the -ml...
Definition Darwin.cpp:1214
Tool * buildLinker() const override
Definition Darwin.cpp:1391
Tool * buildStaticLibTool() const override
Definition Darwin.cpp:1393
bool isTargetIOSBased() const
Is the target either iOS or an iOS simulator?
Definition Darwin.h:212
bool isPICDefault() const override
Test whether this toolchain defaults to PIC.
Definition Darwin.cpp:3797
virtual void AppendPlatformPrefix(SmallString< 128 > &Path, const llvm::Triple &T) const
Definition Darwin.h:204
bool isPICDefaultForced() const override
Tests whether this toolchain forces its default for PIC, PIE or non-PIC.
Definition Darwin.cpp:3801
llvm::opt::DerivedArgList * TranslateArgs(const llvm::opt::DerivedArgList &Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
TranslateArgs - Create a new derived argument list for any argument translations this ToolChain may w...
Definition Darwin.cpp:3236
llvm::ExceptionHandling GetExceptionModel(const llvm::opt::ArgList &Args) const override
GetExceptionModel - Return the tool chain exception model.
Definition Darwin.h:292
Tool * getTool(Action::ActionClass AC) const override
Definition Darwin.cpp:1372
types::ID LookupTypeForExtension(StringRef Ext) const override
LookupTypeForExtension - Return the default language type to use for the given extension.
Definition Darwin.cpp:1079
void AddLinkRuntimeLib(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, StringRef Component, RuntimeLinkOptions Opts=RuntimeLinkOptions(), bool IsShared=false) const
Add a runtime library to the list of items to link.
Definition Darwin.cpp:1557
virtual void addMinVersionArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
Definition Darwin.h:195
virtual void addPlatformVersionArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
Definition Darwin.h:198
UnwindTableLevel getDefaultUnwindTableLevel(const llvm::opt::ArgList &Args) const override
How detailed should the unwind tables be by default.
Definition Darwin.cpp:3749
void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args, BoundArch BA, Action::OffloadKind DeviceOffloadKind) const override
Add options that need to be passed to cc1 for this target.
Definition Darwin.cpp:3512
bool HasNativeLLVMSupport() const override
HasNativeLTOLinker - Check whether the linker and related tools have native LLVM support.
Definition Darwin.cpp:1089
std::string GetGlobalDebugPathRemapping() const override
Add an additional -fdebug-prefix-map entry.
Definition Darwin.cpp:3770
virtual void addStartObjectFileArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
Definition Darwin.h:191
virtual bool HasPlatformPrefix(const llvm::Triple &T) const
Definition Darwin.h:202
bool SupportsProfiling() const override
SupportsProfiling - Does this tool chain support -pg.
Definition Darwin.cpp:3806
RuntimeLinkOptions
Options to control how a runtime library is linked.
Definition Darwin.h:215
@ RLO_IsEmbedded
Use the embedded runtime from the macho_embedded directory.
Definition Darwin.h:220
@ RLO_AddRPath
Emit rpaths for @executable_path as well as the resource directory.
Definition Darwin.h:223
@ RLO_AlwaysLink
Link the library in even if it can't be found in the VFS.
Definition Darwin.h:217
MachO(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args)
Definition Darwin.cpp:1064
virtual void AddLinkRuntimeLibArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool ForceLinkBuiltinRT=false) const
Add the linker arguments to link the compiler runtime library.
Definition Darwin.cpp:3387
std::string getCompilerRT(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static, bool IsFortran=false) const override
Definition Darwin.cpp:1590
StringRef getMachOArchName(const llvm::opt::ArgList &Args) const
Get the "MachO" arch name for a particular compiler invocation.
Definition Darwin.cpp:1186
Tool * buildAssembler() const override
Definition Darwin.cpp:1397
bool isPIEDefault(const llvm::opt::ArgList &Args) const override
Test whether this toolchain defaults to PIE.
Definition Darwin.cpp:3799
bool UseDwarfDebugFlags() const override
UseDwarfDebugFlags - Embed the compile options to clang into the Dwarf compile unit information.
Definition Darwin.cpp:3764
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 Darwin.cpp:112
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 Darwin.cpp:1019
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 Darwin.cpp:630
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 Darwin.cpp:994
const toolchains::MachO & getMachOToolChain() const
Definition Darwin.h:45
void AddMachOArch(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
Definition Darwin.cpp:182
void AddMachOArchOnly(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const
Definition Darwin.cpp:195
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 Darwin.cpp:904
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 Darwin.cpp:1040
FloatABI getARMFloatABI(const ToolChain &TC, const llvm::opt::ArgList &Args)
llvm::Triple::ArchType getArchTypeForMachOArchName(StringRef Str)
Definition Darwin.cpp:44
void setTripleTypeForMachOArchName(llvm::Triple &T, StringRef Str, const llvm::opt::ArgList &Args)
llvm::opt::Arg * getLastProfileSampleUseArg(const llvm::opt::ArgList &Args)
llvm::opt::Arg * getLastCSProfileGenerateArg(const llvm::opt::ArgList &Args)
llvm::opt::Arg * getLastProfileUseArg(const llvm::opt::ArgList &Args)
llvm::StringRef getLTOParallelism(const llvm::opt::ArgList &Args, const Driver &D)
bool addOpenMPRuntime(const Compilation &C, llvm::opt::ArgStringList &CmdArgs, const ToolChain &TC, const llvm::opt::ArgList &Args, bool ForceStaticHostRuntime=false, bool IsOffloadingHost=false, bool GompNeedsRT=false)
Returns true, if an OpenMP runtime has been added.
void AddLinkerInputs(const ToolChain &TC, const InputInfoList &Inputs, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const JobAction &JA)
SmallString< 128 > getStatsFileName(const llvm::opt::ArgList &Args, const InputInfo &Output, const InputInfo &Input, const Driver &D)
Handles the -save-stats option and returns the filename to save statistics to.
bool isObjCAutoRefCount(const llvm::opt::ArgList &Args)
const char * getTypeTempSuffix(ID Id, bool CLStyle=false)
getTypeTempSuffix - Return the suffix to use when creating a temp file of this type,...
Definition Types.cpp:81
SmallVector< InputInfo, 4 > InputInfoList
Definition Driver.h:49
bool willEmitRemarks(const llvm::opt::ArgList &Args)
@ OS
Indicates that the tracking object is a descendant of a referenced-counted OSObject,...
SetTy< T > join(SetTy< T > A, SetTy< T > B, typename SetTy< T >::Factory &F)
Computes the union of two ImmutableSets.
Definition Utils.h:49
Top level wrappers for InstallAPI frontend operations.
Expected< std::optional< DarwinSDKInfo > > parseDarwinSDKInfo(llvm::vfs::FileSystem &VFS, StringRef SDKRootPath)
Parse the SDK information from the SDKSettings.json file.
@ Default
Set to the current date and time.
const FunctionProtoType * T
llvm::VersionTuple alignedAllocMinVersion(llvm::Triple::OSType OS)
llvm::StringRef getAsString(SyncScope S)
Definition SyncScope.h:63
bool(*)(llvm::ArrayRef< const char * >, llvm::raw_ostream &, llvm::raw_ostream &, bool, bool) Driver
Definition Wasm.cpp:39
#define false
Definition stdbool.h:26
Represents a bound architecture for offload / multiple architecture compilation.
llvm::StringRef ArchName
static constexpr OSEnvPair macCatalystToMacOSPair()
Returns the os-environment mapping pair that's used to represent the Mac Catalyst -> macOS version ma...
static constexpr OSEnvPair macOStoMacCatalystPair()
Returns the os-environment mapping pair that's used to represent the macOS -> Mac Catalyst version ma...
static constexpr ResponseFileSupport None()
Returns a ResponseFileSupport indicating that response files are not supported.
Definition Job.h:79
static constexpr ResponseFileSupport AtFileUTF8()
Definition Job.h:86