1//===--- MinGW.cpp - MinGWToolChain Implementation ------------------------===//
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 "MinGW.h"
10#include "clang/Config/config.h"
11#include "clang/Driver/CommonArgs.h"
12#include "clang/Driver/Compilation.h"
13#include "clang/Driver/Driver.h"
14#include "clang/Driver/InputInfo.h"
15#include "clang/Driver/SanitizerArgs.h"
16#include "clang/Options/Options.h"
17#include "llvm/Config/llvm-config.h" // for LLVM_HOST_TRIPLE
18#include "llvm/Option/ArgList.h"
19#include "llvm/Support/FileSystem.h"
20#include "llvm/Support/Path.h"
21#include "llvm/Support/VirtualFileSystem.h"
22#include <system_error>
23
24using namespace clang::diag;
25using namespace clang::driver;
26using namespace clang;
27using namespace llvm::opt;
28
29/// MinGW Tools
30void tools::MinGW::Assembler::ConstructJob(Compilation &C, const JobAction &JA,
31 const InputInfo &Output,
32 const InputInfoList &Inputs,
33 const ArgList &Args,
34 const char *LinkingOutput) const {
35 claimNoWarnArgs(Args);
36 ArgStringList CmdArgs;
37
38 if (getToolChain().getArch() == llvm::Triple::x86) {
39 CmdArgs.push_back(Elt: "--32");
40 } else if (getToolChain().getArch() == llvm::Triple::x86_64) {
41 CmdArgs.push_back(Elt: "--64");
42 }
43
44 Args.AddAllArgValues(Output&: CmdArgs, Id0: options::OPT_Wa_COMMA, Id1: options::OPT_Xassembler);
45
46 CmdArgs.push_back(Elt: "-o");
47 CmdArgs.push_back(Elt: Output.getFilename());
48
49 for (const auto &II : Inputs)
50 CmdArgs.push_back(Elt: II.getFilename());
51
52 const char *Exec = Args.MakeArgString(Str: getToolChain().GetProgramPath(Name: "as"));
53 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: *this, args: ResponseFileSupport::None(),
54 args&: Exec, args&: CmdArgs, args: Inputs, args: Output));
55
56 if (Args.hasArg(Ids: options::OPT_gsplit_dwarf))
57 SplitDebugInfo(TC: getToolChain(), C, T: *this, JA, Args, Output,
58 OutFile: SplitDebugName(JA, Args, Input: Inputs[0], Output));
59}
60
61void tools::MinGW::Linker::AddLibGCC(const ArgList &Args,
62 ArgStringList &CmdArgs) const {
63 bool NoLibc = Args.hasArg(Ids: options::OPT_nolibc);
64 if (Args.hasArg(Ids: options::OPT_mthreads))
65 CmdArgs.push_back(Elt: "-lmingwthrd");
66 if (!NoLibc)
67 CmdArgs.push_back(Elt: "-lmingw32");
68
69 // Make use of compiler-rt if --rtlib option is used
70 ToolChain::RuntimeLibType RLT = getToolChain().GetRuntimeLibType(Args);
71 if (RLT == ToolChain::RLT_Libgcc) {
72 bool Static = Args.hasArg(Ids: options::OPT_static_libgcc) ||
73 Args.hasArg(Ids: options::OPT_static);
74 bool Shared = Args.hasArg(Ids: options::OPT_shared);
75 bool CXX = getToolChain().getDriver().CCCIsCXX();
76
77 if (Static || (!CXX && !Shared)) {
78 CmdArgs.push_back(Elt: "-lgcc");
79 CmdArgs.push_back(Elt: "-lgcc_eh");
80 } else {
81 CmdArgs.push_back(Elt: "-lgcc_s");
82 CmdArgs.push_back(Elt: "-lgcc");
83 }
84 } else {
85 AddRunTimeLibs(TC: getToolChain(), D: getToolChain().getDriver(), CmdArgs, Args);
86 }
87
88 if (!NoLibc) {
89 CmdArgs.push_back(Elt: "-lmoldname");
90 CmdArgs.push_back(Elt: "-lmingwex");
91 for (auto Lib : Args.getAllArgValues(Id: options::OPT_l)) {
92 if (StringRef(Lib).starts_with(Prefix: "msvcr") ||
93 StringRef(Lib).starts_with(Prefix: "ucrt") ||
94 StringRef(Lib).starts_with(Prefix: "crtdll")) {
95 std::string CRTLib = (llvm::Twine("-l") + Lib).str();
96 // Respect the user's chosen crt variant, but still provide it
97 // again as the last linker argument, because some of the libraries
98 // we added above may depend on it.
99 CmdArgs.push_back(Elt: Args.MakeArgStringRef(Str: CRTLib));
100 return;
101 }
102 }
103 CmdArgs.push_back(Elt: "-lmsvcrt");
104 }
105}
106
107void tools::MinGW::Linker::ConstructJob(Compilation &C, const JobAction &JA,
108 const InputInfo &Output,
109 const InputInfoList &Inputs,
110 const ArgList &Args,
111 const char *LinkingOutput) const {
112 const ToolChain &TC = getToolChain();
113 const Driver &D = TC.getDriver();
114 const SanitizerArgs &Sanitize = TC.getSanitizerArgs(JobArgs: Args);
115
116 ArgStringList CmdArgs;
117
118 // Silence warning for "clang -g foo.o -o foo"
119 Args.ClaimAllArgs(Id0: options::OPT_g_Group);
120 // and "clang -emit-llvm foo.o -o foo"
121 Args.ClaimAllArgs(Id0: options::OPT_emit_llvm);
122 // and for "clang -w foo.o -o foo". Other warning options are already
123 // handled somewhere else.
124 Args.ClaimAllArgs(Id0: options::OPT_w);
125
126 if (!D.SysRoot.empty())
127 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "--sysroot=" + D.SysRoot));
128
129 if (Args.hasArg(Ids: options::OPT_s))
130 CmdArgs.push_back(Elt: "-s");
131
132 CmdArgs.push_back(Elt: "-m");
133 switch (TC.getArch()) {
134 case llvm::Triple::x86:
135 CmdArgs.push_back(Elt: "i386pe");
136 break;
137 case llvm::Triple::x86_64:
138 CmdArgs.push_back(Elt: "i386pep");
139 break;
140 case llvm::Triple::arm:
141 case llvm::Triple::thumb:
142 // FIXME: this is incorrect for WinCE
143 CmdArgs.push_back(Elt: "thumb2pe");
144 break;
145 case llvm::Triple::aarch64:
146 if (Args.hasArg(Ids: options::OPT_marm64x))
147 CmdArgs.push_back(Elt: "arm64xpe");
148 else if (TC.getEffectiveTriple().isWindowsArm64EC())
149 CmdArgs.push_back(Elt: "arm64ecpe");
150 else
151 CmdArgs.push_back(Elt: "arm64pe");
152 break;
153 case llvm::Triple::mipsel:
154 CmdArgs.push_back(Elt: "mipspe");
155 break;
156 default:
157 D.Diag(DiagID: diag::err_target_unknown_triple) << TC.getEffectiveTriple().str();
158 }
159
160 Arg *SubsysArg =
161 Args.getLastArg(Ids: options::OPT_mwindows, Ids: options::OPT_mconsole);
162 if (SubsysArg && SubsysArg->getOption().matches(ID: options::OPT_mwindows)) {
163 CmdArgs.push_back(Elt: "--subsystem");
164 CmdArgs.push_back(Elt: "windows");
165 } else if (SubsysArg &&
166 SubsysArg->getOption().matches(ID: options::OPT_mconsole)) {
167 CmdArgs.push_back(Elt: "--subsystem");
168 CmdArgs.push_back(Elt: "console");
169 }
170
171 if (Args.hasArg(Ids: options::OPT_mdll))
172 CmdArgs.push_back(Elt: "--dll");
173 else if (Args.hasArg(Ids: options::OPT_shared))
174 CmdArgs.push_back(Elt: "--shared");
175 if (Args.hasArg(Ids: options::OPT_static))
176 CmdArgs.push_back(Elt: "-Bstatic");
177 else
178 CmdArgs.push_back(Elt: "-Bdynamic");
179 if (Args.hasArg(Ids: options::OPT_mdll) || Args.hasArg(Ids: options::OPT_shared)) {
180 CmdArgs.push_back(Elt: "-e");
181 if (TC.getArch() == llvm::Triple::x86)
182 CmdArgs.push_back(Elt: "_DllMainCRTStartup@12");
183 else
184 CmdArgs.push_back(Elt: "DllMainCRTStartup");
185 CmdArgs.push_back(Elt: "--enable-auto-image-base");
186 }
187
188 if (Args.hasArg(Ids: options::OPT_Z_Xlinker__no_demangle))
189 CmdArgs.push_back(Elt: "--no-demangle");
190
191 if (!Args.hasFlag(Pos: options::OPT_fauto_import, Neg: options::OPT_fno_auto_import,
192 Default: true))
193 CmdArgs.push_back(Elt: "--disable-auto-import");
194
195 if (Arg *A = Args.getLastArg(Ids: options::OPT_mguard_EQ)) {
196 StringRef GuardArgs = A->getValue();
197 if (GuardArgs == "none")
198 CmdArgs.push_back(Elt: "--no-guard-cf");
199 else if (GuardArgs == "cf" || GuardArgs == "cf-nochecks")
200 CmdArgs.push_back(Elt: "--guard-cf");
201 else
202 D.Diag(DiagID: diag::err_drv_unsupported_option_argument)
203 << A->getSpelling() << GuardArgs;
204 }
205
206 if (Args.hasArg(Ids: options::OPT_fms_hotpatch))
207 CmdArgs.push_back(Elt: "--functionpadmin");
208
209 CmdArgs.push_back(Elt: "-o");
210 const char *OutputFile = Output.getFilename();
211 // GCC implicitly adds an .exe extension if it is given an output file name
212 // that lacks an extension.
213 // GCC used to do this only when the compiler itself runs on windows, but
214 // since GCC 8 it does the same when cross compiling as well.
215 if (!llvm::sys::path::has_extension(path: OutputFile)) {
216 CmdArgs.push_back(Elt: Args.MakeArgString(Str: Twine(OutputFile) + ".exe"));
217 OutputFile = CmdArgs.back();
218 } else
219 CmdArgs.push_back(Elt: OutputFile);
220
221 // FIXME: add -N, -n flags
222 Args.AddLastArg(Output&: CmdArgs, Ids: options::OPT_r);
223 Args.AddLastArg(Output&: CmdArgs, Ids: options::OPT_s);
224 Args.AddLastArg(Output&: CmdArgs, Ids: options::OPT_t);
225 Args.AddAllArgs(Output&: CmdArgs, Id0: options::OPT_u_Group);
226
227 // Add asan_dynamic as the first import lib before other libs. This allows
228 // asan to be initialized as early as possible to increase its instrumentation
229 // coverage to include other user DLLs which has not been built with asan.
230 if (Sanitize.needsAsanRt() && !Args.hasArg(Ids: options::OPT_nostdlib) &&
231 !Args.hasArg(Ids: options::OPT_nodefaultlibs)) {
232 // MinGW always links against a shared MSVCRT.
233 CmdArgs.push_back(
234 Elt: TC.getCompilerRTArgString(Args, Component: "asan_dynamic", Type: ToolChain::FT_Shared));
235 }
236
237 if (!Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nostartfiles)) {
238 if (Args.hasArg(Ids: options::OPT_shared) || Args.hasArg(Ids: options::OPT_mdll)) {
239 CmdArgs.push_back(Elt: Args.MakeArgString(Str: TC.GetFilePath(Name: "dllcrt2.o")));
240 } else {
241 if (Args.hasArg(Ids: options::OPT_municode))
242 CmdArgs.push_back(Elt: Args.MakeArgString(Str: TC.GetFilePath(Name: "crt2u.o")));
243 else
244 CmdArgs.push_back(Elt: Args.MakeArgString(Str: TC.GetFilePath(Name: "crt2.o")));
245 }
246 if (Args.hasArg(Ids: options::OPT_pg))
247 CmdArgs.push_back(Elt: Args.MakeArgString(Str: TC.GetFilePath(Name: "gcrt2.o")));
248 CmdArgs.push_back(Elt: Args.MakeArgString(Str: TC.GetFilePath(Name: "crtbegin.o")));
249 }
250
251 Args.AddAllArgs(Output&: CmdArgs, Id0: options::OPT_L);
252 TC.AddFilePathLibArgs(Args, CmdArgs);
253
254 // Add the compiler-rt library directories if they exist to help
255 // the linker find the various sanitizer, builtin, and profiling runtimes.
256 for (const auto &LibPath : TC.getLibraryPaths()) {
257 if (TC.getVFS().exists(Path: LibPath))
258 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "-L" + LibPath));
259 }
260 auto CRTPath = TC.getCompilerRTPath();
261 if (TC.getVFS().exists(Path: CRTPath))
262 CmdArgs.push_back(Elt: Args.MakeArgString(Str: "-L" + CRTPath));
263
264 AddLinkerInputs(TC, Inputs, Args, CmdArgs, JA);
265
266 if (auto LTO = TC.getLTOMode(Args); LTO != LTOK_None)
267 addLTOOptions(ToolChain: TC, Args, CmdArgs, Output, Inputs, IsThinLTO: LTO == LTOK_Thin);
268
269 if (C.getDriver().IsFlangMode() &&
270 !Args.hasArg(Ids: options::OPT_nostdlib, Ids: options::OPT_nodefaultlibs)) {
271 TC.addFortranRuntimeLibraryPath(Args, CmdArgs);
272 TC.addFortranRuntimeLibs(Args, CmdArgs);
273 }
274
275 // TODO: Add profile stuff here
276
277 if (TC.ShouldLinkCXXStdlib(Args)) {
278 bool OnlyLibstdcxxStatic = Args.hasArg(Ids: options::OPT_static_libstdcxx) &&
279 !Args.hasArg(Ids: options::OPT_static);
280 if (OnlyLibstdcxxStatic)
281 CmdArgs.push_back(Elt: "-Bstatic");
282 TC.AddCXXStdlibLibArgs(Args, CmdArgs);
283 if (OnlyLibstdcxxStatic)
284 CmdArgs.push_back(Elt: "-Bdynamic");
285 }
286
287 bool HasWindowsApp = false;
288 for (auto Lib : Args.getAllArgValues(Id: options::OPT_l)) {
289 if (Lib == "windowsapp") {
290 HasWindowsApp = true;
291 break;
292 }
293 }
294
295 bool NoLibc = Args.hasArg(Ids: options::OPT_nolibc);
296 if (!Args.hasArg(Ids: options::OPT_nostdlib)) {
297 if (!Args.hasArg(Ids: options::OPT_nodefaultlibs)) {
298 if (Args.hasArg(Ids: options::OPT_static))
299 CmdArgs.push_back(Elt: "--start-group");
300
301 if (Args.hasArg(Ids: options::OPT_fstack_protector) ||
302 Args.hasArg(Ids: options::OPT_fstack_protector_strong) ||
303 Args.hasArg(Ids: options::OPT_fstack_protector_all)) {
304 CmdArgs.push_back(Elt: "-lssp_nonshared");
305 CmdArgs.push_back(Elt: "-lssp");
306 }
307
308 if (Args.hasFlag(Pos: options::OPT_fopenmp, PosAlias: options::OPT_fopenmp_EQ,
309 Neg: options::OPT_fno_openmp, Default: false)) {
310 switch (TC.getDriver().getOpenMPRuntime(Args)) {
311 case Driver::OMPRT_OMP:
312 CmdArgs.push_back(Elt: "-lomp");
313 break;
314 case Driver::OMPRT_IOMP5:
315 CmdArgs.push_back(Elt: "-liomp5md");
316 break;
317 case Driver::OMPRT_GOMP:
318 CmdArgs.push_back(Elt: "-lgomp");
319 break;
320 case Driver::OMPRT_Unknown:
321 // Already diagnosed.
322 break;
323 }
324 }
325
326 AddLibGCC(Args, CmdArgs);
327
328 if (Args.hasArg(Ids: options::OPT_pg))
329 CmdArgs.push_back(Elt: "-lgmon");
330
331 if (Args.hasArg(Ids: options::OPT_pthread))
332 CmdArgs.push_back(Elt: "-lpthread");
333
334 if (Sanitize.needsAsanRt()) {
335 // MinGW always links against a shared MSVCRT.
336 CmdArgs.push_back(Elt: TC.getCompilerRTArgString(Args, Component: "asan_dynamic",
337 Type: ToolChain::FT_Shared));
338 CmdArgs.push_back(
339 Elt: TC.getCompilerRTArgString(Args, Component: "asan_dynamic_runtime_thunk"));
340 CmdArgs.push_back(Elt: "--require-defined");
341 CmdArgs.push_back(Elt: TC.getArch() == llvm::Triple::x86
342 ? "___asan_seh_interceptor"
343 : "__asan_seh_interceptor");
344 // Make sure the linker consider all object files from the dynamic
345 // runtime thunk.
346 CmdArgs.push_back(Elt: "--whole-archive");
347 CmdArgs.push_back(
348 Elt: TC.getCompilerRTArgString(Args, Component: "asan_dynamic_runtime_thunk"));
349 CmdArgs.push_back(Elt: "--no-whole-archive");
350 }
351
352 TC.addProfileRTLibs(Args, CmdArgs);
353
354 if (!HasWindowsApp && !NoLibc) {
355 // Add system libraries. If linking to libwindowsapp.a, that import
356 // library replaces all these and we shouldn't accidentally try to
357 // link to the normal desktop mode dlls.
358 if (Args.hasArg(Ids: options::OPT_mwindows)) {
359 CmdArgs.push_back(Elt: "-lgdi32");
360 CmdArgs.push_back(Elt: "-lcomdlg32");
361 }
362 CmdArgs.push_back(Elt: "-ladvapi32");
363 CmdArgs.push_back(Elt: "-lshell32");
364 CmdArgs.push_back(Elt: "-luser32");
365 CmdArgs.push_back(Elt: "-lkernel32");
366 }
367
368 if (Args.hasArg(Ids: options::OPT_static)) {
369 CmdArgs.push_back(Elt: "--end-group");
370 } else {
371 AddLibGCC(Args, CmdArgs);
372 if (!HasWindowsApp && !NoLibc)
373 CmdArgs.push_back(Elt: "-lkernel32");
374 }
375 }
376
377 if (!Args.hasArg(Ids: options::OPT_nostartfiles)) {
378 // Add crtfastmath.o if available and fast math is enabled.
379 TC.addFastMathRuntimeIfAvailable(Args, CmdArgs);
380
381 CmdArgs.push_back(Elt: Args.MakeArgString(Str: TC.GetFilePath(Name: "crtend.o")));
382 }
383 }
384 const char *Exec = Args.MakeArgString(Str: TC.GetLinkerPath());
385 C.addCommand(Cmd: std::make_unique<Command>(args: JA, args: *this,
386 args: ResponseFileSupport::AtFileUTF8(),
387 args&: Exec, args&: CmdArgs, args: Inputs, args: Output));
388}
389
390static bool isCrossCompiling(const llvm::Triple &T, bool RequireArchMatch) {
391 llvm::Triple HostTriple(llvm::Triple::normalize(LLVM_HOST_TRIPLE));
392 if (HostTriple.getOS() != llvm::Triple::Win32)
393 return true;
394 if (RequireArchMatch && HostTriple.getArch() != T.getArch())
395 return true;
396 return false;
397}
398
399// Simplified from Generic_GCC::GCCInstallationDetector::ScanLibDirForGCCTriple.
400static bool findGccVersion(StringRef LibDir, std::string &GccLibDir,
401 std::string &Ver,
402 toolchains::Generic_GCC::GCCVersion &Version) {
403 Version = toolchains::Generic_GCC::GCCVersion::Parse(VersionText: "0.0.0");
404 std::error_code EC;
405 for (llvm::sys::fs::directory_iterator LI(LibDir, EC), LE; !EC && LI != LE;
406 LI = LI.increment(ec&: EC)) {
407 StringRef VersionText = llvm::sys::path::filename(path: LI->path());
408 auto CandidateVersion =
409 toolchains::Generic_GCC::GCCVersion::Parse(VersionText);
410 if (CandidateVersion.Major == -1)
411 continue;
412 if (CandidateVersion <= Version)
413 continue;
414 Version = CandidateVersion;
415 Ver = std::string(VersionText);
416 GccLibDir = LI->path();
417 }
418 return Ver.size();
419}
420
421static llvm::Triple getLiteralTriple(const Driver &D, const llvm::Triple &T) {
422 llvm::Triple LiteralTriple(D.getTargetTriple());
423 // The arch portion of the triple may be overridden by -m32/-m64.
424 LiteralTriple.setArchName(T.getArchName());
425 return LiteralTriple;
426}
427
428void toolchains::MinGW::findGccLibDir(const llvm::Triple &LiteralTriple) {
429 llvm::SmallVector<llvm::SmallString<32>, 5> SubdirNames;
430 SubdirNames.emplace_back(Args: LiteralTriple.str());
431 SubdirNames.emplace_back(Args: getTriple().str());
432 SubdirNames.emplace_back(Args: getTriple().getArchName());
433 SubdirNames.back() += "-w64-mingw32";
434 SubdirNames.emplace_back(Args: getTriple().getArchName());
435 SubdirNames.back() += "-w64-mingw32ucrt";
436 SubdirNames.emplace_back(Args: "mingw32");
437 if (SubdirName.empty()) {
438 SubdirName = getTriple().getArchName();
439 SubdirName += "-w64-mingw32";
440 }
441 // lib: Arch Linux, Ubuntu, Windows
442 // lib64: openSUSE Linux
443 for (StringRef CandidateLib : {"lib", "lib64"}) {
444 for (StringRef CandidateSysroot : SubdirNames) {
445 llvm::SmallString<1024> LibDir(Base);
446 llvm::sys::path::append(path&: LibDir, a: CandidateLib, b: "gcc", c: CandidateSysroot);
447 if (findGccVersion(LibDir, GccLibDir, Ver, Version&: GccVer)) {
448 SubdirName = std::string(CandidateSysroot);
449 return;
450 }
451 }
452 }
453}
454
455static llvm::ErrorOr<std::string> findGcc(const llvm::Triple &LiteralTriple,
456 const llvm::Triple &T) {
457 llvm::SmallVector<llvm::SmallString<32>, 5> Gccs;
458 Gccs.emplace_back(Args: LiteralTriple.str());
459 Gccs.back() += "-gcc";
460 Gccs.emplace_back(Args: T.str());
461 Gccs.back() += "-gcc";
462 Gccs.emplace_back(Args: T.getArchName());
463 Gccs.back() += "-w64-mingw32-gcc";
464 Gccs.emplace_back(Args: T.getArchName());
465 Gccs.back() += "-w64-mingw32ucrt-gcc";
466 Gccs.emplace_back(Args: "mingw32-gcc");
467 // Please do not add "gcc" here
468 for (StringRef CandidateGcc : Gccs)
469 if (llvm::ErrorOr<std::string> GPPName = llvm::sys::findProgramByName(Name: CandidateGcc))
470 return GPPName;
471 return make_error_code(e: std::errc::no_such_file_or_directory);
472}
473
474static llvm::ErrorOr<std::string>
475findClangRelativeSysroot(const Driver &D, const llvm::Triple &LiteralTriple,
476 const llvm::Triple &T, std::string &SubdirName) {
477 llvm::SmallVector<llvm::SmallString<32>, 4> Subdirs;
478 Subdirs.emplace_back(Args: LiteralTriple.str());
479 // On ARM64EC targets, also try native aarch64 sysroot, which may contain
480 // support for both targets.
481 if (LiteralTriple.isWindowsArm64EC()) {
482 llvm::Triple NativeTriple(LiteralTriple);
483 NativeTriple.setArchName("aarch64");
484 Subdirs.emplace_back(Args: NativeTriple.str());
485 }
486 Subdirs.emplace_back(Args: T.str());
487 Subdirs.emplace_back(Args: T.getArchName());
488 Subdirs.back() += "-w64-mingw32";
489 Subdirs.emplace_back(Args: T.getArchName());
490 Subdirs.back() += "-w64-mingw32ucrt";
491 if (T.isWindowsArm64EC()) {
492 llvm::Triple NativeTriple(T);
493 NativeTriple.setArchName("aarch64");
494 Subdirs.emplace_back(Args: NativeTriple.str());
495
496 Subdirs.emplace_back(Args: "aarch64-w64-mingw32");
497 Subdirs.emplace_back(Args: "aarch64-w64-mingw32ucrt");
498 }
499 StringRef ClangRoot = llvm::sys::path::parent_path(path: D.Dir);
500 StringRef Sep = llvm::sys::path::get_separator();
501 for (StringRef CandidateSubdir : Subdirs) {
502 if (llvm::sys::fs::is_directory(Path: ClangRoot + Sep + CandidateSubdir)) {
503 SubdirName = std::string(CandidateSubdir);
504 return (ClangRoot + Sep + CandidateSubdir).str();
505 }
506 }
507 return make_error_code(e: std::errc::no_such_file_or_directory);
508}
509
510static bool looksLikeMinGWSysroot(const std::string &Directory) {
511 StringRef Sep = llvm::sys::path::get_separator();
512 if (!llvm::sys::fs::exists(Path: Directory + Sep + "include" + Sep + "_mingw.h"))
513 return false;
514 if (!llvm::sys::fs::exists(Path: Directory + Sep + "lib" + Sep + "libkernel32.a"))
515 return false;
516 return true;
517}
518
519toolchains::MinGW::MinGW(const Driver &D, const llvm::Triple &Triple,
520 const ArgList &Args)
521 : ToolChain(D, Triple, Args), CudaInstallation(D, Triple, Args),
522 RocmInstallation(D, Triple, Args) {
523 getProgramPaths().push_back(Elt: getDriver().Dir);
524
525 std::string InstallBase =
526 std::string(llvm::sys::path::parent_path(path: getDriver().Dir));
527 // The sequence for detecting a sysroot here should be kept in sync with
528 // the testTriple function below.
529 llvm::Triple LiteralTriple = getLiteralTriple(D, T: getTriple());
530 if (getDriver().SysRoot.size())
531 Base = getDriver().SysRoot;
532 // Look for <clang-bin>/../<triplet>; if found, use <clang-bin>/.. as the
533 // base as it could still be a base for a gcc setup with libgcc.
534 else if (llvm::ErrorOr<std::string> TargetSubdir = findClangRelativeSysroot(
535 D: getDriver(), LiteralTriple, T: getTriple(), SubdirName))
536 Base = std::string(llvm::sys::path::parent_path(path: TargetSubdir.get()));
537 // If the install base of Clang seems to have mingw sysroot files directly
538 // in the toplevel include and lib directories, use this as base instead of
539 // looking for a triple prefixed GCC in the path.
540 else if (looksLikeMinGWSysroot(Directory: InstallBase))
541 Base = InstallBase;
542 else if (llvm::ErrorOr<std::string> GPPName =
543 findGcc(LiteralTriple, T: getTriple()))
544 Base = std::string(llvm::sys::path::parent_path(
545 path: llvm::sys::path::parent_path(path: GPPName.get())));
546 else
547 Base = InstallBase;
548
549 Base += llvm::sys::path::get_separator();
550 findGccLibDir(LiteralTriple);
551 TripleDirName = SubdirName;
552 // GccLibDir must precede Base/lib so that the
553 // correct crtbegin.o ,cetend.o would be found.
554 getFilePaths().push_back(Elt: GccLibDir);
555
556 // openSUSE/Fedora
557 std::string CandidateSubdir = SubdirName + "/sys-root/mingw";
558 if (getDriver().getVFS().exists(Path: Base + CandidateSubdir))
559 SubdirName = CandidateSubdir;
560
561 getFilePaths().push_back(
562 Elt: (Base + SubdirName + llvm::sys::path::get_separator() + "lib").str());
563
564 // Gentoo
565 getFilePaths().push_back(
566 Elt: (Base + SubdirName + llvm::sys::path::get_separator() + "mingw/lib").str());
567
568 // Only include <base>/lib if we're not cross compiling (not even for
569 // windows->windows to a different arch), or if the sysroot has been set
570 // (where we presume the user has pointed it at an arch specific
571 // subdirectory).
572 if (!::isCrossCompiling(T: getTriple(), /*RequireArchMatch=*/true) ||
573 getDriver().SysRoot.size())
574 getFilePaths().push_back(Elt: Base + "lib");
575
576 loadMultilibsFromYAML(Args, D);
577
578 NativeLLVMSupport =
579 Args.getLastArgValue(Id: options::OPT_fuse_ld_EQ, Default: D.getPreferredLinker())
580 .equals_insensitive(RHS: "lld");
581}
582
583Tool *toolchains::MinGW::getTool(Action::ActionClass AC) const {
584 switch (AC) {
585 case Action::PreprocessJobClass:
586 if (!Preprocessor)
587 Preprocessor.reset(p: new tools::gcc::Preprocessor(*this));
588 return Preprocessor.get();
589 case Action::CompileJobClass:
590 if (!Compiler)
591 Compiler.reset(p: new tools::gcc::Compiler(*this));
592 return Compiler.get();
593 case Action::ObjcopyJobClass:
594 if (!Objcopy)
595 Objcopy.reset(p: new tools::ARM64XObjcopy(*this));
596 return Objcopy.get();
597 default:
598 return ToolChain::getTool(AC);
599 }
600}
601
602Tool *toolchains::MinGW::buildAssembler() const {
603 return new tools::MinGW::Assembler(*this);
604}
605
606Tool *toolchains::MinGW::buildLinker() const {
607 return new tools::MinGW::Linker(*this);
608}
609
610bool toolchains::MinGW::HasNativeLLVMSupport() const {
611 return NativeLLVMSupport;
612}
613
614ToolChain::UnwindTableLevel
615toolchains::MinGW::getDefaultUnwindTableLevel(const ArgList &Args) const {
616 Arg *ExceptionArg = Args.getLastArg(Ids: options::OPT_fsjlj_exceptions,
617 Ids: options::OPT_fseh_exceptions,
618 Ids: options::OPT_fdwarf_exceptions);
619 if (ExceptionArg &&
620 ExceptionArg->getOption().matches(ID: options::OPT_fseh_exceptions))
621 return UnwindTableLevel::Asynchronous;
622
623 if (getArch() == llvm::Triple::x86_64 || getArch() == llvm::Triple::arm ||
624 getArch() == llvm::Triple::thumb || getArch() == llvm::Triple::aarch64)
625 return UnwindTableLevel::Asynchronous;
626 return UnwindTableLevel::None;
627}
628
629bool toolchains::MinGW::isPICDefault() const {
630 return getArch() == llvm::Triple::x86_64 ||
631 getArch() == llvm::Triple::aarch64;
632}
633
634bool toolchains::MinGW::isPIEDefault(const llvm::opt::ArgList &Args) const {
635 return false;
636}
637
638bool toolchains::MinGW::isPICDefaultForced() const { return true; }
639
640llvm::ExceptionHandling
641toolchains::MinGW::GetExceptionModel(const ArgList &Args) const {
642 if (getArch() == llvm::Triple::x86_64 || getArch() == llvm::Triple::aarch64 ||
643 getArch() == llvm::Triple::arm || getArch() == llvm::Triple::thumb)
644 return llvm::ExceptionHandling::WinEH;
645 return llvm::ExceptionHandling::DwarfCFI;
646}
647
648SanitizerMask toolchains::MinGW::getSupportedSanitizers(
649 BoundArch BA, Action::OffloadKind DeviceOffloadKind) const {
650 SanitizerMask Res = ToolChain::getSupportedSanitizers(BA, DeviceOffloadKind);
651 Res |= SanitizerKind::Address;
652 Res |= SanitizerKind::PointerCompare;
653 Res |= SanitizerKind::PointerSubtract;
654 Res |= SanitizerKind::Vptr;
655 return Res;
656}
657
658void toolchains::MinGW::AddCudaIncludeArgs(const ArgList &DriverArgs,
659 ArgStringList &CC1Args) const {
660 CudaInstallation->AddCudaIncludeArgs(DriverArgs, CC1Args);
661}
662
663void toolchains::MinGW::AddHIPIncludeArgs(const ArgList &DriverArgs,
664 ArgStringList &CC1Args) const {
665 RocmInstallation->AddHIPIncludeArgs(DriverArgs, CC1Args);
666}
667
668void toolchains::MinGW::printVerboseInfo(raw_ostream &OS) const {
669 CudaInstallation->print(OS);
670 RocmInstallation->print(OS);
671}
672
673// Include directories for various hosts:
674
675// Windows, mingw.org
676// c:\mingw\lib\gcc\mingw32\4.8.1\include\c++
677// c:\mingw\lib\gcc\mingw32\4.8.1\include\c++\mingw32
678// c:\mingw\lib\gcc\mingw32\4.8.1\include\c++\backward
679// c:\mingw\include
680// c:\mingw\mingw32\include
681
682// Windows, mingw-w64 mingw-builds
683// c:\mingw32\i686-w64-mingw32\include
684// c:\mingw32\i686-w64-mingw32\include\c++
685// c:\mingw32\i686-w64-mingw32\include\c++\i686-w64-mingw32
686// c:\mingw32\i686-w64-mingw32\include\c++\backward
687
688// Windows, mingw-w64 msys2
689// c:\msys64\mingw32\include
690// c:\msys64\mingw32\i686-w64-mingw32\include
691// c:\msys64\mingw32\include\c++\4.9.2
692// c:\msys64\mingw32\include\c++\4.9.2\i686-w64-mingw32
693// c:\msys64\mingw32\include\c++\4.9.2\backward
694
695// openSUSE
696// /usr/lib64/gcc/x86_64-w64-mingw32/5.1.0/include/c++
697// /usr/lib64/gcc/x86_64-w64-mingw32/5.1.0/include/c++/x86_64-w64-mingw32
698// /usr/lib64/gcc/x86_64-w64-mingw32/5.1.0/include/c++/backward
699// /usr/x86_64-w64-mingw32/sys-root/mingw/include
700
701// Arch Linux
702// /usr/i686-w64-mingw32/include/c++/5.1.0
703// /usr/i686-w64-mingw32/include/c++/5.1.0/i686-w64-mingw32
704// /usr/i686-w64-mingw32/include/c++/5.1.0/backward
705// /usr/i686-w64-mingw32/include
706
707// Ubuntu
708// /usr/include/c++/4.8
709// /usr/include/c++/4.8/x86_64-w64-mingw32
710// /usr/include/c++/4.8/backward
711// /usr/x86_64-w64-mingw32/include
712
713// Fedora
714// /usr/x86_64-w64-mingw32ucrt/sys-root/mingw/include/c++/x86_64-w64-mingw32ucrt
715// /usr/x86_64-w64-mingw32ucrt/sys-root/mingw/include/c++/backward
716// /usr/x86_64-w64-mingw32ucrt/sys-root/mingw/include
717// /usr/lib/gcc/x86_64-w64-mingw32ucrt/12.2.1/include-fixed
718
719void toolchains::MinGW::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
720 ArgStringList &CC1Args) const {
721 if (DriverArgs.hasArg(Ids: options::OPT_nostdinc))
722 return;
723
724 if (!DriverArgs.hasArg(Ids: options::OPT_nobuiltininc)) {
725 SmallString<1024> P(getDriver().ResourceDir);
726 llvm::sys::path::append(path&: P, a: "include");
727 addSystemInclude(DriverArgs, CC1Args, Path: P.str());
728 }
729
730 if (DriverArgs.hasArg(Ids: options::OPT_nostdlibinc))
731 return;
732
733 // Add multilib variant include paths in priority order.
734 for (const Multilib &M : getOrderedMultilibs()) {
735 if (M.isDefault())
736 continue;
737 if (std::optional<std::string> StdlibIncDir = getStdlibIncludePath()) {
738 SmallString<128> Dir(*StdlibIncDir);
739 llvm::sys::path::append(path&: Dir, a: M.includeSuffix());
740 if (getDriver().getVFS().exists(Path: Dir))
741 addSystemInclude(DriverArgs, CC1Args, Path: Dir);
742 }
743 }
744
745 if (std::optional<std::string> Path = getStdlibIncludePath())
746 addSystemInclude(DriverArgs, CC1Args, Path: *Path);
747
748 addSystemInclude(DriverArgs, CC1Args,
749 Path: Base + SubdirName + llvm::sys::path::get_separator() +
750 "include");
751
752 // Gentoo
753 addSystemInclude(DriverArgs, CC1Args,
754 Path: Base + SubdirName + llvm::sys::path::get_separator() + "usr/include");
755
756 // Only include <base>/include if we're not cross compiling (but do allow it
757 // if we're on Windows and building for Windows on another architecture),
758 // or if the sysroot has been set (where we presume the user has pointed it
759 // at an arch specific subdirectory).
760 if (!::isCrossCompiling(T: getTriple(), /*RequireArchMatch=*/false) ||
761 getDriver().SysRoot.size())
762 addSystemInclude(DriverArgs, CC1Args, Path: Base + "include");
763}
764
765void toolchains::MinGW::addClangTargetOptions(
766 const llvm::opt::ArgList &DriverArgs, llvm::opt::ArgStringList &CC1Args,
767 BoundArch BA, Action::OffloadKind DeviceOffloadKind) const {
768 if (Arg *A = DriverArgs.getLastArg(Ids: options::OPT_mguard_EQ)) {
769 StringRef GuardArgs = A->getValue();
770 if (GuardArgs == "none") {
771 // Do nothing.
772 } else if (GuardArgs == "cf") {
773 // Emit CFG instrumentation and the table of address-taken functions.
774 CC1Args.push_back(Elt: "-cfguard");
775 } else if (GuardArgs == "cf-nochecks") {
776 // Emit only the table of address-taken functions.
777 CC1Args.push_back(Elt: "-cfguard-no-checks");
778 } else {
779 getDriver().Diag(DiagID: diag::err_drv_unsupported_option_argument)
780 << A->getSpelling() << GuardArgs;
781 }
782 }
783
784 // Default to not enabling sized deallocation, but let user provided options
785 // override it.
786 //
787 // If using sized deallocation, user code that invokes delete will end up
788 // calling delete(void*,size_t). If the user wanted to override the
789 // operator delete(void*), there may be a fallback operator
790 // delete(void*,size_t) which calls the regular operator delete(void*).
791 //
792 // However, if the C++ standard library is linked in the form of a DLL,
793 // and the fallback operator delete(void*,size_t) is within this DLL (which is
794 // the case for libc++ at least) it will only redirect towards the library's
795 // default operator delete(void*), not towards the user's provided operator
796 // delete(void*).
797 //
798 // This issue can be avoided, if the fallback operators are linked statically
799 // into the callers, even if the C++ standard library is linked as a DLL.
800 //
801 // This is meant as a temporary workaround until libc++ implements this
802 // technique, which is tracked in
803 // https://github.com/llvm/llvm-project/issues/96899.
804 if (!DriverArgs.hasArgNoClaim(Ids: options::OPT_fsized_deallocation,
805 Ids: options::OPT_fno_sized_deallocation))
806 CC1Args.push_back(Elt: "-fno-sized-deallocation");
807
808 CC1Args.push_back(Elt: "-fno-use-init-array");
809
810 for (auto Opt : {options::OPT_mthreads, options::OPT_mwindows,
811 options::OPT_mconsole, options::OPT_mdll}) {
812 if (Arg *A = DriverArgs.getLastArgNoClaim(Ids: Opt))
813 A->ignoreTargetSpecific();
814 }
815}
816
817void toolchains::MinGW::AddClangCXXStdlibIncludeArgs(
818 const ArgList &DriverArgs, ArgStringList &CC1Args) const {
819 if (DriverArgs.hasArg(Ids: options::OPT_nostdinc, Ids: options::OPT_nostdlibinc,
820 Ids: options::OPT_nostdincxx))
821 return;
822
823 StringRef Slash = llvm::sys::path::get_separator();
824
825 switch (GetCXXStdlibType(Args: DriverArgs)) {
826 case ToolChain::CST_Libcxx: {
827 std::string TargetDir = (Base + "include" + Slash + getTripleString() +
828 Slash + "c++" + Slash + "v1")
829 .str();
830 if (getDriver().getVFS().exists(Path: TargetDir))
831 addSystemInclude(DriverArgs, CC1Args, Path: TargetDir);
832 addSystemInclude(DriverArgs, CC1Args,
833 Path: Base + SubdirName + Slash + "include" + Slash + "c++" +
834 Slash + "v1");
835 addSystemInclude(DriverArgs, CC1Args,
836 Path: Base + "include" + Slash + "c++" + Slash + "v1");
837 break;
838 }
839
840 case ToolChain::CST_Libstdcxx:
841 llvm::SmallVector<llvm::SmallString<1024>, 7> CppIncludeBases;
842 CppIncludeBases.emplace_back(Args: Base);
843 llvm::sys::path::append(path&: CppIncludeBases[0], a: SubdirName, b: "include", c: "c++");
844 CppIncludeBases.emplace_back(Args: Base);
845 llvm::sys::path::append(path&: CppIncludeBases[1], a: SubdirName, b: "include", c: "c++",
846 d: Ver);
847 CppIncludeBases.emplace_back(Args: Base);
848 llvm::sys::path::append(path&: CppIncludeBases[2], a: "include", b: "c++", c: Ver);
849 CppIncludeBases.emplace_back(Args: GccLibDir);
850 llvm::sys::path::append(path&: CppIncludeBases[3], a: "include", b: "c++");
851 CppIncludeBases.emplace_back(Args: GccLibDir);
852 llvm::sys::path::append(path&: CppIncludeBases[4], a: "include",
853 b: "g++-v" + GccVer.Text);
854 CppIncludeBases.emplace_back(Args: GccLibDir);
855 llvm::sys::path::append(path&: CppIncludeBases[5], a: "include",
856 b: "g++-v" + GccVer.MajorStr + "." + GccVer.MinorStr);
857 CppIncludeBases.emplace_back(Args: GccLibDir);
858 llvm::sys::path::append(path&: CppIncludeBases[6], a: "include",
859 b: "g++-v" + GccVer.MajorStr);
860 for (auto &CppIncludeBase : CppIncludeBases) {
861 addSystemInclude(DriverArgs, CC1Args, Path: CppIncludeBase);
862 CppIncludeBase += Slash;
863 addSystemInclude(DriverArgs, CC1Args, Path: CppIncludeBase + TripleDirName);
864 addSystemInclude(DriverArgs, CC1Args, Path: CppIncludeBase + "backward");
865 }
866 break;
867 }
868}
869
870static bool testTriple(const Driver &D, const llvm::Triple &Triple,
871 const ArgList &Args) {
872 // If an explicit sysroot is set, that will be used and we shouldn't try to
873 // detect anything else.
874 std::string SubdirName;
875 if (D.SysRoot.size())
876 return true;
877 llvm::Triple LiteralTriple = getLiteralTriple(D, T: Triple);
878 std::string InstallBase = std::string(llvm::sys::path::parent_path(path: D.Dir));
879 if (llvm::ErrorOr<std::string> TargetSubdir =
880 findClangRelativeSysroot(D, LiteralTriple, T: Triple, SubdirName))
881 return true;
882 // If the install base itself looks like a mingw sysroot, we'll use that
883 // - don't use any potentially unrelated gcc to influence what triple to use.
884 if (looksLikeMinGWSysroot(Directory: InstallBase))
885 return false;
886 if (llvm::ErrorOr<std::string> GPPName = findGcc(LiteralTriple, T: Triple))
887 return true;
888 // If we neither found a colocated sysroot or a matching gcc executable,
889 // conclude that we can't know if this is the correct spelling of the triple.
890 return false;
891}
892
893static llvm::Triple adjustTriple(const Driver &D, const llvm::Triple &Triple,
894 const ArgList &Args) {
895 // First test if the original triple can find a sysroot with the triple
896 // name.
897 if (testTriple(D, Triple, Args))
898 return Triple;
899 llvm::SmallVector<llvm::StringRef, 3> Archs;
900 // If not, test a couple other possible arch names that might be what was
901 // intended.
902 if (Triple.getArch() == llvm::Triple::x86) {
903 Archs.emplace_back(Args: "i386");
904 Archs.emplace_back(Args: "i586");
905 Archs.emplace_back(Args: "i686");
906 } else if (Triple.getArch() == llvm::Triple::arm ||
907 Triple.getArch() == llvm::Triple::thumb) {
908 Archs.emplace_back(Args: "armv7");
909 }
910 for (auto A : Archs) {
911 llvm::Triple TestTriple(Triple);
912 TestTriple.setArchName(A);
913 if (testTriple(D, Triple: TestTriple, Args))
914 return TestTriple;
915 }
916 // If none was found, just proceed with the original value.
917 return Triple;
918}
919
920void toolchains::MinGW::fixTripleArch(const Driver &D, llvm::Triple &Triple,
921 const ArgList &Args) {
922 if (Triple.getArch() == llvm::Triple::x86 ||
923 Triple.getArch() == llvm::Triple::arm ||
924 Triple.getArch() == llvm::Triple::thumb)
925 Triple = adjustTriple(D, Triple, Args);
926}
927