clang 24.0.0git
Flang.cpp
Go to the documentation of this file.
1//===-- Flang.cpp - Flang+LLVM 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 "Flang.h"
10#include "Arch/RISCV.h"
11#include "Cuda.h"
12
17#include "llvm/Frontend/Debug/Options.h"
18#include "llvm/Support/Path.h"
19#include "llvm/TargetParser/Host.h"
20#include "llvm/TargetParser/RISCVISAInfo.h"
21#include "llvm/TargetParser/RISCVTargetParser.h"
22
23#include <cassert>
24
25using namespace clang::driver;
26using namespace clang::driver::tools;
27using namespace clang;
28using namespace llvm::opt;
29
30/// Add -x lang to \p CmdArgs for \p Input.
31static void addDashXForInput(const ArgList &Args, const InputInfo &Input,
32 ArgStringList &CmdArgs) {
33 CmdArgs.push_back("-x");
34 // Map the driver type to the frontend type.
35 CmdArgs.push_back(types::getTypeName(Input.getType()));
36}
37
38void Flang::addFortranDialectOptions(const ArgList &Args,
39 ArgStringList &CmdArgs) const {
40 Args.addAllArgs(CmdArgs, {options::OPT_ffixed_form,
41 options::OPT_ffree_form,
42 options::OPT_ffixed_line_length_EQ,
43 options::OPT_fopenacc,
44 options::OPT_finput_charset_EQ,
45 options::OPT_fimplicit_none,
46 options::OPT_fimplicit_none_ext,
47 options::OPT_fno_implicit_none,
48 options::OPT_fbackslash,
49 options::OPT_fno_backslash,
50 options::OPT_flogical_abbreviations,
51 options::OPT_fno_logical_abbreviations,
52 options::OPT_fxor_operator,
53 options::OPT_fno_xor_operator,
54 options::OPT_falternative_parameter_statement,
55 options::OPT_fdefault_integer_4,
56 options::OPT_fdefault_real_4,
57 options::OPT_fdefault_real_8,
58 options::OPT_fdefault_integer_8,
59 options::OPT_fdefault_double_8,
60 options::OPT_flarge_sizes,
61 options::OPT_fno_automatic,
62 options::OPT_fhermetic_module_files,
63 options::OPT_frealloc_lhs,
64 options::OPT_fno_realloc_lhs,
65 options::OPT_fsave_main_program,
66 options::OPT_fd_lines_as_code,
67 options::OPT_fd_lines_as_comments,
68 options::OPT_fno_save_main_program});
69}
70
71void Flang::addPreprocessingOptions(const ArgList &Args,
72 ArgStringList &CmdArgs) const {
73 Args.addAllArgs(CmdArgs,
74 {options::OPT_P, options::OPT_D, options::OPT_U,
75 options::OPT_I, options::OPT_cpp, options::OPT_nocpp});
76}
77
78/// @C shouldLoopVersion
79///
80/// Check if Loop Versioning should be enabled.
81/// We look for the last of one of the following:
82/// -Ofast, -O4, -O<number> and -f[no-]version-loops-for-stride.
83/// Loop versioning is disabled if the last option is
84/// -fno-version-loops-for-stride.
85/// Loop versioning is enabled if the last option is one of:
86/// -floop-versioning
87/// -Ofast
88/// -O4
89/// -O3
90/// For all other cases, loop versioning is disabled.
91///
92/// The gfortran compiler automatically enables the option for -O3 or -Ofast.
93///
94/// @return true if loop-versioning should be enabled, otherwise false.
95static bool shouldLoopVersion(const ArgList &Args) {
96 const Arg *LoopVersioningArg = Args.getLastArg(
97 options::OPT_Ofast, options::OPT_O, options::OPT_O4,
98 options::OPT_floop_versioning, options::OPT_fno_loop_versioning);
99 if (!LoopVersioningArg)
100 return false;
101
102 if (LoopVersioningArg->getOption().matches(options::OPT_fno_loop_versioning))
103 return false;
104
105 if (LoopVersioningArg->getOption().matches(options::OPT_floop_versioning))
106 return true;
107
108 if (LoopVersioningArg->getOption().matches(options::OPT_Ofast) ||
109 LoopVersioningArg->getOption().matches(options::OPT_O4))
110 return true;
111
112 if (LoopVersioningArg->getOption().matches(options::OPT_O)) {
113 StringRef S(LoopVersioningArg->getValue());
114 unsigned OptLevel = 0;
115 // Note -Os or Oz woould "fail" here, so return false. Which is the
116 // desiered behavior.
117 if (S.getAsInteger(10, OptLevel))
118 return false;
119
120 return OptLevel > 2;
121 }
122
123 llvm_unreachable("We should not end up here");
124 return false;
125}
126
127void Flang::addDebugOptions(const llvm::opt::ArgList &Args, const JobAction &JA,
128 const InputInfo &Output, const InputInfo &Input,
129 llvm::opt::ArgStringList &CmdArgs) const {
130 const auto &TC = getToolChain();
131 const Driver &D = TC.getDriver();
132 Args.addAllArgs(CmdArgs,
133 {options::OPT_module_dir, options::OPT_fdebug_module_writer,
134 options::OPT_fintrinsic_modules_path, options::OPT_pedantic,
135 options::OPT_std_EQ, options::OPT_W_Joined,
136 options::OPT_fconvert_EQ, options::OPT_fpass_plugin_EQ,
137 options::OPT_funderscoring, options::OPT_fno_underscoring,
138 options::OPT_funsigned, options::OPT_fno_unsigned,
139 options::OPT_fenumeration_type,
140 options::OPT_fno_enumeration_type,
141 options::OPT_fopenacc_default_none_scalars_strict,
142 options::OPT_fno_openacc_default_none_scalars_strict,
143 options::OPT_fopenacc_multiple_names_in_routine,
144 options::OPT_fno_openacc_multiple_names_in_routine,
145 options::OPT_finstrument_functions});
146
147 llvm::codegenoptions::DebugInfoKind DebugInfoKind;
148 bool hasDwarfNArg = getDwarfNArg(Args) != nullptr;
149 if (Args.hasArg(options::OPT_gN_Group)) {
150 Arg *gNArg = Args.getLastArg(options::OPT_gN_Group);
151 DebugInfoKind = debugLevelToInfoKind(*gNArg);
152 } else if (Args.hasArg(options::OPT_g_Flag) || hasDwarfNArg) {
153 DebugInfoKind = llvm::codegenoptions::FullDebugInfo;
154 } else {
155 DebugInfoKind = llvm::codegenoptions::NoDebugInfo;
156 }
157 addDebugInfoKind(CmdArgs, DebugInfoKind);
158 if (hasDwarfNArg) {
159 const unsigned DwarfVersion = getDwarfVersion(getToolChain(), Args);
160 CmdArgs.push_back(
161 Args.MakeArgString("-dwarf-version=" + Twine(DwarfVersion)));
162 }
163 if (Args.hasArg(options::OPT_gsplit_dwarf) ||
164 Args.hasArg(options::OPT_gsplit_dwarf_EQ)) {
165 // FIXME: -gsplit-dwarf on AIX is currently unimplemented.
166 if (TC.getTriple().isOSAIX()) {
167 D.Diag(diag::err_drv_unsupported_opt_for_target)
168 << Args.getLastArg(options::OPT_gsplit_dwarf)->getSpelling()
169 << TC.getTriple().str();
170 return;
171 }
172 if (DebugInfoKind == llvm::codegenoptions::NoDebugInfo)
173 return;
174
175 Arg *SplitDWARFArg;
176 DwarfFissionKind DwarfFission = getDebugFissionKind(D, Args, SplitDWARFArg);
177
178 if (DwarfFission == DwarfFissionKind::None ||
179 !checkDebugInfoOption(SplitDWARFArg, Args, D, TC))
180 return;
181
182 if (!TC.getTriple().isOSBinFormatELF() &&
183 !TC.getTriple().isOSBinFormatWasm() &&
184 !TC.getTriple().isOSBinFormatCOFF()) {
185 D.Diag(diag::warn_drv_unsupported_debug_info_opt_for_target)
186 << SplitDWARFArg->getSpelling() << TC.getTriple().str();
187 return;
188 }
189
192 return;
193
194 const char *SplitDWARFOut = SplitDebugName(JA, Args, Input, Output);
195 CmdArgs.push_back("-split-dwarf-file");
196 CmdArgs.push_back(SplitDWARFOut);
197 if (DwarfFission == DwarfFissionKind::Split) {
198 CmdArgs.push_back("-split-dwarf-output");
199 CmdArgs.push_back(SplitDWARFOut);
200 }
201 }
202 addDebugInfoForProfilingArgs(D, TC, Args, CmdArgs);
203}
204
205void Flang::addCodegenOptions(const ArgList &Args,
206 ArgStringList &CmdArgs) const {
207 Arg *stackArrays =
208 Args.getLastArg(options::OPT_Ofast, options::OPT_fstack_arrays,
209 options::OPT_fno_stack_arrays);
210 if (stackArrays &&
211 !stackArrays->getOption().matches(options::OPT_fno_stack_arrays))
212 CmdArgs.push_back("-fstack-arrays");
213
214 if (Args.hasFlag(options::OPT_fsafe_trampoline,
215 options::OPT_fno_safe_trampoline, false)) {
216 const llvm::Triple &T = getToolChain().getTriple();
217 if (T.getArch() == llvm::Triple::x86_64 ||
218 T.getArch() == llvm::Triple::aarch64 ||
219 T.getArch() == llvm::Triple::aarch64_be) {
220 CmdArgs.push_back("-fsafe-trampoline");
221 } else {
223 diag::warn_drv_unsupported_option_for_target)
224 << "-fsafe-trampoline" << T.str();
225 }
226 }
227
228 // -fno-protect-parens is the default for -Ofast.
229 if (!Args.hasFlag(options::OPT_fprotect_parens,
230 options::OPT_fno_protect_parens,
231 /*Default=*/!Args.hasArg(options::OPT_Ofast)))
232 CmdArgs.push_back("-fno-protect-parens");
233
234 if (Args.hasFlag(options::OPT_funsafe_cray_pointers,
235 options::OPT_fno_unsafe_cray_pointers, false)) {
236 // TODO: currently passed as MLIR option
237 CmdArgs.push_back("-mmlir");
238 CmdArgs.push_back("-unsafe-cray-pointers");
239 }
240
241 Args.addOptInFlag(CmdArgs, options::OPT_fexperimental_loop_fusion,
242 options::OPT_fno_experimental_loop_fusion);
243 Args.addOptInFlag(CmdArgs, options::OPT_freal_sum_reassociation,
244 options::OPT_fno_real_sum_reassociation);
245
246 handleInterchangeLoopsArgs(Args, CmdArgs);
247 handleVectorizeLoopsArgs(Args, CmdArgs);
248 handleVectorizeSLPArgs(Args, CmdArgs);
249
250 if (shouldLoopVersion(Args))
251 CmdArgs.push_back("-fversion-loops-for-stride");
252
253 for (const auto &arg :
254 Args.getAllArgValues(options::OPT_frepack_arrays_contiguity_EQ))
255 if (arg != "whole" && arg != "innermost") {
256 getToolChain().getDriver().Diag(diag::err_drv_unsupported_option_argument)
257 << "-frepack-arrays-contiguity=" << arg;
258 }
259
260 Args.addAllArgs(
261 CmdArgs,
262 {options::OPT_fdo_concurrent_to_openmp_EQ,
263 options::OPT_fno_ppc_native_vec_elem_order,
264 options::OPT_fppc_native_vec_elem_order, options::OPT_finit_global_zero,
265 options::OPT_fno_init_global_zero, options::OPT_frepack_arrays,
266 options::OPT_fno_repack_arrays,
267 options::OPT_frepack_arrays_contiguity_EQ,
268 options::OPT_fstack_repack_arrays, options::OPT_fno_stack_repack_arrays,
269 options::OPT_ftime_report, options::OPT_ftime_report_EQ,
270 options::OPT_funroll_loops, options::OPT_fno_unroll_loops,
271 options::OPT_relaxed_c_loc});
272
273 const llvm::Triple &Triple = getToolChain().getEffectiveTriple();
274 addSeparateSectionFlags(Triple, Args, CmdArgs);
275
276 if (Args.hasArg(options::OPT_fcoarray))
277 CmdArgs.push_back("-fcoarray");
278}
279
280void Flang::addLTOOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
281 const ToolChain &TC = getToolChain();
282 LTOKind LTOMode = TC.getLTOMode(Args);
283 // LTO mode is parsed by the Clang driver library.
284 assert(LTOMode != LTOK_Unknown && "Unknown LTO mode.");
285 if (LTOMode == LTOK_Full)
286 CmdArgs.push_back("-flto=full");
287 else if (LTOMode == LTOK_Thin)
288 CmdArgs.push_back("-flto=thin");
289
290 if (Args.hasFlag(options::OPT_fsplit_lto_unit,
291 options::OPT_fno_split_lto_unit, /*Default=*/false))
292 CmdArgs.push_back("-fsplit-lto-unit");
293
294 Args.addAllArgs(CmdArgs, {options::OPT_ffat_lto_objects,
295 options::OPT_fno_fat_lto_objects});
296}
297
298void Flang::addPicOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
299 // ParsePICArgs parses -fPIC/-fPIE and their variants and returns a tuple of
300 // (RelocationModel, PICLevel, IsPIE).
301 llvm::Reloc::Model RelocationModel;
302 unsigned PICLevel;
303 bool IsPIE;
304 std::tie(RelocationModel, PICLevel, IsPIE) =
305 ParsePICArgs(getToolChain(), Args);
306
307 if (auto *RMName = RelocationModelName(RelocationModel)) {
308 CmdArgs.push_back("-mrelocation-model");
309 CmdArgs.push_back(RMName);
310 }
311 if (PICLevel > 0) {
312 CmdArgs.push_back("-pic-level");
313 CmdArgs.push_back(PICLevel == 1 ? "1" : "2");
314 if (IsPIE)
315 CmdArgs.push_back("-pic-is-pie");
316 }
317}
318
319void Flang::AddAArch64TargetArgs(const ArgList &Args,
320 ArgStringList &CmdArgs) const {
321 // Handle -msve_vector_bits=<bits>
322 if (Arg *A = Args.getLastArg(options::OPT_msve_vector_bits_EQ)) {
323 StringRef Val = A->getValue();
324 const Driver &D = getToolChain().getDriver();
325 if (Val == "128" || Val == "256" || Val == "512" || Val == "1024" ||
326 Val == "2048" || Val == "128+" || Val == "256+" || Val == "512+" ||
327 Val == "1024+" || Val == "2048+") {
328 unsigned Bits = 0;
329 if (!Val.consume_back("+")) {
330 [[maybe_unused]] bool Invalid = Val.getAsInteger(10, Bits);
331 assert(!Invalid && "Failed to parse value");
332 CmdArgs.push_back(
333 Args.MakeArgString("-mvscale-max=" + llvm::Twine(Bits / 128)));
334 }
335
336 [[maybe_unused]] bool Invalid = Val.getAsInteger(10, Bits);
337 assert(!Invalid && "Failed to parse value");
338 CmdArgs.push_back(
339 Args.MakeArgString("-mvscale-min=" + llvm::Twine(Bits / 128)));
340 // Silently drop requests for vector-length agnostic code as it's implied.
341 } else if (Val != "scalable")
342 // Handle the unsupported values passed to msve-vector-bits.
343 D.Diag(diag::err_drv_unsupported_option_argument)
344 << A->getSpelling() << Val;
345 }
346}
347
348void Flang::AddLoongArch64TargetArgs(const ArgList &Args,
349 ArgStringList &CmdArgs) const {
350 const Driver &D = getToolChain().getDriver();
351 // Currently, flang only support `-mabi=lp64d` in LoongArch64.
352 if (const Arg *A = Args.getLastArg(options::OPT_mabi_EQ)) {
353 StringRef V = A->getValue();
354 if (V != "lp64d") {
355 D.Diag(diag::err_drv_argument_not_allowed_with) << "-mabi" << V;
356 }
357 }
358
359 if (const Arg *A = Args.getLastArg(options::OPT_mannotate_tablejump,
360 options::OPT_mno_annotate_tablejump)) {
361 if (A->getOption().matches(options::OPT_mannotate_tablejump)) {
362 CmdArgs.push_back("-mllvm");
363 CmdArgs.push_back("-loongarch-annotate-tablejump");
364 }
365 }
366}
367
368void Flang::AddPPCTargetArgs(const ArgList &Args,
369 ArgStringList &CmdArgs) const {
370 const Driver &D = getToolChain().getDriver();
371 bool VecExtabi = false;
372
373 if (const Arg *A = Args.getLastArg(options::OPT_mabi_EQ)) {
374 StringRef V = A->getValue();
375 if (V == "vec-extabi")
376 VecExtabi = true;
377 else if (V == "vec-default")
378 VecExtabi = false;
379 else
380 D.Diag(diag::err_drv_unsupported_option_argument)
381 << A->getSpelling() << V;
382 }
383
384 const llvm::Triple &T = getToolChain().getTriple();
385 if (VecExtabi) {
386 if (!T.isOSAIX()) {
387 D.Diag(diag::err_drv_unsupported_opt_for_target)
388 << "-mabi=vec-extabi" << T.str();
389 }
390 CmdArgs.push_back("-mabi=vec-extabi");
391 }
392}
393
394void Flang::AddRISCVTargetArgs(const ArgList &Args,
395 ArgStringList &CmdArgs) const {
396 const Driver &D = getToolChain().getDriver();
397 const llvm::Triple &Triple = getToolChain().getTriple();
398
399 StringRef ABIName = riscv::getRISCVABI(Args, Triple);
400 if (ABIName == "lp64" || ABIName == "lp64f" || ABIName == "lp64d")
401 CmdArgs.push_back(Args.MakeArgString("-mabi=" + ABIName));
402 else
403 D.Diag(diag::err_drv_unsupported_option_argument) << "-mabi=" << ABIName;
404
405 // Handle -mrvv-vector-bits=<bits>
406 if (Arg *A = Args.getLastArg(options::OPT_mrvv_vector_bits_EQ)) {
407 StringRef Val = A->getValue();
408
409 // Get minimum VLen from march.
410 unsigned MinVLen = 0;
411 std::string Arch = riscv::getRISCVArch(Args, Triple);
412 auto ISAInfo = llvm::RISCVISAInfo::parseArchString(
413 Arch, /*EnableExperimentalExtensions*/ true);
414 // Ignore parsing error.
415 if (!errorToBool(ISAInfo.takeError()))
416 MinVLen = (*ISAInfo)->getMinVLen();
417
418 // If the value is "zvl", use MinVLen from march. Otherwise, try to parse
419 // as integer as long as we have a MinVLen.
420 unsigned Bits = 0;
421 if (Val == "zvl" && MinVLen >= llvm::RISCV::RVVBitsPerBlock) {
422 Bits = MinVLen;
423 } else if (!Val.getAsInteger(10, Bits)) {
424 // Only accept power of 2 values beteen RVVBitsPerBlock and 65536 that
425 // at least MinVLen.
426 if (Bits < MinVLen || Bits < llvm::RISCV::RVVBitsPerBlock ||
427 Bits > 65536 || !llvm::isPowerOf2_32(Bits))
428 Bits = 0;
429 }
430
431 // If we got a valid value try to use it.
432 if (Bits != 0) {
433 unsigned VScaleMin = Bits / llvm::RISCV::RVVBitsPerBlock;
434 CmdArgs.push_back(
435 Args.MakeArgString("-mvscale-max=" + llvm::Twine(VScaleMin)));
436 CmdArgs.push_back(
437 Args.MakeArgString("-mvscale-min=" + llvm::Twine(VScaleMin)));
438 } else if (Val != "scalable") {
439 // Handle the unsupported values passed to mrvv-vector-bits.
440 D.Diag(diag::err_drv_unsupported_option_argument)
441 << A->getSpelling() << Val;
442 }
443 }
444}
445
446void Flang::AddX86_64TargetArgs(const ArgList &Args,
447 ArgStringList &CmdArgs) const {
448 if (Arg *A = Args.getLastArg(options::OPT_masm_EQ)) {
449 StringRef Value = A->getValue();
450 if (Value == "intel" || Value == "att") {
451 CmdArgs.push_back(Args.MakeArgString("-mllvm"));
452 CmdArgs.push_back(Args.MakeArgString("-x86-asm-syntax=" + Value));
453 } else {
454 getToolChain().getDriver().Diag(diag::err_drv_unsupported_option_argument)
455 << A->getSpelling() << Value;
456 }
457 }
458}
459
460static void addVSDefines(const ToolChain &TC, const ArgList &Args,
461 ArgStringList &CmdArgs) {
462
463 unsigned ver = 0;
464 const VersionTuple vt = TC.computeMSVCVersion(nullptr, Args);
465 ver = vt.getMajor() * 10000000 + vt.getMinor().value_or(0) * 100000 +
466 vt.getSubminor().value_or(0);
467 CmdArgs.push_back(Args.MakeArgString("-D_MSC_VER=" + Twine(ver / 100000)));
468 CmdArgs.push_back(Args.MakeArgString("-D_MSC_FULL_VER=" + Twine(ver)));
469 CmdArgs.push_back(Args.MakeArgString("-D_WIN32"));
470
471 const llvm::Triple &triple = TC.getTriple();
472 if (triple.isAArch64()) {
473 CmdArgs.push_back("-D_M_ARM64=1");
474 } else if (triple.isX86() && triple.isArch32Bit()) {
475 CmdArgs.push_back("-D_M_IX86=600");
476 } else if (triple.isX86() && triple.isArch64Bit()) {
477 CmdArgs.push_back("-D_M_X64=100");
478 } else {
479 llvm_unreachable(
480 "Flang on Windows only supports X86_32, X86_64 and AArch64");
481 }
482}
483
484static void processVSRuntimeLibrary(const ToolChain &TC, const ArgList &Args,
485 ArgStringList &CmdArgs) {
486 assert(TC.getTriple().isKnownWindowsMSVCEnvironment() &&
487 "can only add VS runtime library on Windows!");
488
489 // Flang/Clang (including clang-cl) -compiled programs targeting the MSVC ABI
490 // should only depend on msv(u)crt. LLVM still emits libgcc/compiler-rt
491 // functions in some cases like 128-bit integer math (__udivti3, __modti3,
492 // __fixsfti, __floattidf, ...) that msvc does not support. We are injecting a
493 // dependency to Compiler-RT's builtin library where these are implemented.
494 CmdArgs.push_back(Args.MakeArgString(
495 "--dependent-lib=" + TC.getCompilerRTBasename(Args, "builtins")));
496
497 unsigned RTOptionID = options::OPT__SLASH_MT;
498 if (auto *rtl = Args.getLastArg(options::OPT_fms_runtime_lib_EQ)) {
499 RTOptionID = llvm::StringSwitch<unsigned>(rtl->getValue())
500 .Case("static", options::OPT__SLASH_MT)
501 .Case("static_dbg", options::OPT__SLASH_MTd)
502 .Case("dll", options::OPT__SLASH_MD)
503 .Case("dll_dbg", options::OPT__SLASH_MDd)
504 .Default(options::OPT__SLASH_MT);
505 }
506 switch (RTOptionID) {
507 case options::OPT__SLASH_MT:
508 CmdArgs.push_back("-D_MT");
509 CmdArgs.push_back("--dependent-lib=libcmt");
510 CmdArgs.push_back("--dependent-lib=flang_rt.runtime.static.lib");
511 break;
512 case options::OPT__SLASH_MTd:
513 CmdArgs.push_back("-D_MT");
514 CmdArgs.push_back("-D_DEBUG");
515 CmdArgs.push_back("--dependent-lib=libcmtd");
516 CmdArgs.push_back("--dependent-lib=flang_rt.runtime.static_dbg.lib");
517 break;
518 case options::OPT__SLASH_MD:
519 CmdArgs.push_back("-D_MT");
520 CmdArgs.push_back("-D_DLL");
521 CmdArgs.push_back("--dependent-lib=msvcrt");
522 CmdArgs.push_back("--dependent-lib=flang_rt.runtime.dynamic.lib");
523 break;
524 case options::OPT__SLASH_MDd:
525 CmdArgs.push_back("-D_MT");
526 CmdArgs.push_back("-D_DEBUG");
527 CmdArgs.push_back("-D_DLL");
528 CmdArgs.push_back("--dependent-lib=msvcrtd");
529 CmdArgs.push_back("--dependent-lib=flang_rt.runtime.dynamic_dbg.lib");
530 break;
531 }
532}
533
534void Flang::AddAMDGPUTargetArgs(const ArgList &Args, ArgStringList &CmdArgs,
535 BoundArch BA,
536 Action::OffloadKind DeviceOffloadKind) const {
537 if (Arg *A = Args.getLastArg(options::OPT_mcode_object_version_EQ)) {
538 StringRef Val = A->getValue();
539 CmdArgs.push_back(Args.MakeArgString("-mcode-object-version=" + Val));
540 CmdArgs.push_back(Args.MakeArgString("-mllvm"));
541 CmdArgs.push_back(
542 Args.MakeArgString("--amdhsa-code-object-version=" + Val));
543 }
544
545 const ToolChain &TC = getToolChain();
546 TC.addClangTargetOptions(Args, CmdArgs, BA, DeviceOffloadKind);
547}
548
549void Flang::AddNVPTXTargetArgs(const ArgList &Args, ArgStringList &CmdArgs,
550 BoundArch BA,
551 Action::OffloadKind DeviceOffloadKind) const {
552 // we cannot use addClangTargetOptions, as it appends unsupported args for
553 // flang: -fcuda-is-device, -fno-threadsafe-statics,
554 // -fcuda-allow-variadic-functions and -target-sdk-version Instead we manually
555 // detect the CUDA installation and link libdevice
556 const ToolChain &TC = getToolChain();
557 const Driver &D = TC.getDriver();
558 const llvm::Triple &Triple = TC.getEffectiveTriple();
559
560 if (!Args.hasFlag(options::OPT_offloadlib, options::OPT_no_offloadlib, true))
561 return;
562
563 // Detect CUDA installation and link libdevice
564 CudaInstallationDetector CudaInstallation(D, Triple, Args);
565 if (!CudaInstallation.isValid()) {
566 D.Diag(diag::err_drv_no_cuda_installation);
567 return;
568 }
569
570 StringRef GpuArch = Args.getLastArgValue(options::OPT_march_EQ);
571 if (GpuArch.empty()) {
572 D.Diag(diag::err_drv_offload_missing_gpu_arch) << "NVPTX" << "flang";
573 return;
574 }
575
576 std::string LibDeviceFile = CudaInstallation.getLibDeviceFile(GpuArch);
577 if (LibDeviceFile.empty()) {
578 D.Diag(diag::err_drv_no_cuda_libdevice) << GpuArch;
579 return;
580 }
581
582 CmdArgs.push_back("-mlink-builtin-bitcode");
583 CmdArgs.push_back(Args.MakeArgString(LibDeviceFile));
584}
585
586void Flang::addTargetOptions(const ArgList &Args, ArgStringList &CmdArgs,
587 BoundArch BA,
588 Action::OffloadKind DeviceOffloadKind) const {
589 const ToolChain &TC = getToolChain();
590 const llvm::Triple &Triple = TC.getEffectiveTriple();
591 const Driver &D = TC.getDriver();
592
593 std::string CPU = getCPUName(D, Args, Triple);
594 if (!CPU.empty()) {
595 CmdArgs.push_back("-target-cpu");
596 CmdArgs.push_back(Args.MakeArgString(CPU));
597 }
598
599 addOutlineAtomicsArgs(D, getToolChain(), Args, CmdArgs, Triple);
600
601 // Add the target features.
602 switch (TC.getArch()) {
603 default:
604 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
605 break;
606 case llvm::Triple::aarch64:
607 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
608 AddAArch64TargetArgs(Args, CmdArgs);
609 break;
610 case llvm::Triple::amdgpu:
611 case llvm::Triple::r600:
612 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
613 AddAMDGPUTargetArgs(Args, CmdArgs, BA, DeviceOffloadKind);
614 break;
615 case llvm::Triple::nvptx:
616 case llvm::Triple::nvptx64:
617 AddNVPTXTargetArgs(Args, CmdArgs, BA, DeviceOffloadKind);
618 break;
619 case llvm::Triple::riscv64:
620 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
621 AddRISCVTargetArgs(Args, CmdArgs);
622 break;
623 case llvm::Triple::x86_64:
624 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
625 AddX86_64TargetArgs(Args, CmdArgs);
626 break;
627 case llvm::Triple::ppc:
628 case llvm::Triple::ppc64:
629 case llvm::Triple::ppc64le:
630 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
631 AddPPCTargetArgs(Args, CmdArgs);
632 break;
633 case llvm::Triple::loongarch64:
634 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
635 AddLoongArch64TargetArgs(Args, CmdArgs);
636 break;
637 }
638
639 if (Arg *A = Args.getLastArg(options::OPT_fveclib)) {
640 StringRef Name = A->getValue();
641 if (Name == "SVML") {
642 if (Triple.getArch() != llvm::Triple::x86 &&
643 Triple.getArch() != llvm::Triple::x86_64)
644 D.Diag(diag::err_drv_unsupported_opt_for_target)
645 << Name << Triple.getArchName();
646 } else if (Name == "AMDLIBM") {
647 if (Triple.getArch() != llvm::Triple::x86 &&
648 Triple.getArch() != llvm::Triple::x86_64)
649 D.Diag(diag::err_drv_unsupported_opt_for_target)
650 << Name << Triple.getArchName();
651 } else if (Name == "libmvec") {
652 if (Triple.getArch() != llvm::Triple::x86 &&
653 Triple.getArch() != llvm::Triple::x86_64 &&
654 Triple.getArch() != llvm::Triple::aarch64 &&
655 Triple.getArch() != llvm::Triple::aarch64_be)
656 D.Diag(diag::err_drv_unsupported_opt_for_target)
657 << Name << Triple.getArchName();
658 } else if (Name == "SLEEF" || Name == "ArmPL") {
659 if (Triple.getArch() != llvm::Triple::aarch64 &&
660 Triple.getArch() != llvm::Triple::aarch64_be)
661 D.Diag(diag::err_drv_unsupported_opt_for_target)
662 << Name << Triple.getArchName();
663 }
664
665 if (Triple.isOSDarwin()) {
666 // flang doesn't currently suport nostdlib, nodefaultlibs. Adding these
667 // here incase they are added someday
668 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
669 if (A->getValue() == StringRef{"Accelerate"}) {
670 CmdArgs.push_back("-framework");
671 CmdArgs.push_back("Accelerate");
672 }
673 }
674 }
675 A->render(Args, CmdArgs);
676 }
677
678 if (Triple.isKnownWindowsMSVCEnvironment()) {
679 processVSRuntimeLibrary(TC, Args, CmdArgs);
680 addVSDefines(TC, Args, CmdArgs);
681 }
682
683 // TODO: Add target specific flags, ABI, mtune option etc.
684 if (const Arg *A = Args.getLastArg(options::OPT_mtune_EQ)) {
685 CmdArgs.push_back("-tune-cpu");
686 if (A->getValue() == StringRef{"native"})
687 CmdArgs.push_back(Args.MakeArgString(llvm::sys::getHostCPUName()));
688 else
689 CmdArgs.push_back(A->getValue());
690 }
691
692 Args.addAllArgs(CmdArgs,
693 {options::OPT_fverbose_asm, options::OPT_fno_verbose_asm,
694 options::OPT_fatomic_ignore_denormal_mode,
695 options::OPT_fno_atomic_ignore_denormal_mode,
696 options::OPT_fatomic_fine_grained_memory,
697 options::OPT_fno_atomic_fine_grained_memory,
698 options::OPT_fatomic_remote_memory,
699 options::OPT_fno_atomic_remote_memory,
700 options::OPT_munsafe_fp_atomics});
701}
702
703void Flang::addOffloadOptions(Compilation &C, const InputInfoList &Inputs,
704 const JobAction &JA, const ArgList &Args,
705 ArgStringList &CmdArgs) const {
706 bool IsOpenMPDevice = JA.isDeviceOffloading(Action::OFK_OpenMP);
707 bool IsHostOffloadingAction = JA.isHostOffloading(Action::OFK_OpenMP) ||
708 JA.isHostOffloading(C.getActiveOffloadKinds());
709
710 // Tell the frontend when it is compiling for an offloading device, regardless
711 // of offloading programming model.
713 CmdArgs.push_back("-foffload-device");
714
715 // Skips the primary input file, which is the input file that the compilation
716 // proccess will be executed upon (e.g. the host bitcode file) and
717 // adds other secondary input (e.g. device bitcode files for embedding to the
718 // -fembed-offload-object argument or the host IR file for proccessing
719 // during device compilation to the fopenmp-host-ir-file-path argument via
720 // OpenMPDeviceInput). This is condensed logic from the ConstructJob
721 // function inside of the Clang driver for pushing on further input arguments
722 // needed for offloading during various phases of compilation.
723 for (size_t i = 1; i < Inputs.size(); ++i) {
724 if (Inputs[i].getType() == types::TY_Nothing) {
725 // contains nothing, so it's skippable
726 } else if (IsHostOffloadingAction) {
727 CmdArgs.push_back(
728 Args.MakeArgString("-fembed-offload-object=" +
729 getToolChain().getInputFilename(Inputs[i])));
730 } else if (IsOpenMPDevice) {
731 if (Inputs[i].getFilename()) {
732 CmdArgs.push_back("-fopenmp-host-ir-file-path");
733 CmdArgs.push_back(Args.MakeArgString(Inputs[i].getFilename()));
734 } else {
735 llvm_unreachable("missing openmp host-ir file for device offloading");
736 }
737 } else {
738 llvm_unreachable(
739 "unexpectedly given multiple inputs or given unknown input");
740 }
741 }
742
743 // When in OpenMP offloading mode, forward assumptions information about
744 // thread and team counts in the target device. The host needs to know about
745 // this to prevent the SPMD to SPMD-no-loop promotion being done differently
746 // for host and device on the same target region.
747 if (Args.hasFlag(options::OPT_fopenmp_assume_teams_oversubscription,
748 options::OPT_fno_openmp_assume_teams_oversubscription,
749 /*Default=*/false))
750 CmdArgs.push_back("-fopenmp-assume-teams-oversubscription");
751 if (Args.hasFlag(options::OPT_fopenmp_assume_threads_oversubscription,
752 options::OPT_fno_openmp_assume_threads_oversubscription,
753 /*Default=*/false))
754 CmdArgs.push_back("-fopenmp-assume-threads-oversubscription");
755
756 if (IsOpenMPDevice) {
757 // -fopenmp-is-target-device is passed along to tell the frontend that it is
758 // generating code for a device, so that only the relevant code is emitted.
759 CmdArgs.push_back("-fopenmp-is-target-device");
760
761 // When in OpenMP offloading mode, enable debugging on the device.
762 Args.AddAllArgs(CmdArgs, options::OPT_fopenmp_target_debug_EQ);
763 if (Args.hasFlag(options::OPT_fopenmp_target_debug,
764 options::OPT_fno_openmp_target_debug, /*Default=*/false))
765 CmdArgs.push_back("-fopenmp-target-debug");
766 if (Args.hasArg(options::OPT_fopenmp_assume_no_thread_state))
767 CmdArgs.push_back("-fopenmp-assume-no-thread-state");
768 if (Args.hasArg(options::OPT_fopenmp_assume_no_nested_parallelism))
769 CmdArgs.push_back("-fopenmp-assume-no-nested-parallelism");
770 if (!Args.hasFlag(options::OPT_offloadlib, options::OPT_no_offloadlib,
771 true))
772 CmdArgs.push_back("-nogpulib");
773 }
774
775 addOpenMPHostOffloadingArgs(C, JA, Args, CmdArgs);
776}
777
778static void addFloatingPointOptions(const Driver &D, const ArgList &Args,
779 ArgStringList &CmdArgs) {
780 StringRef FPContract;
781 bool HonorINFs = true;
782 bool HonorNaNs = true;
783 bool ApproxFunc = false;
784 bool SignedZeros = true;
785 bool AssociativeMath = false;
786 bool ReciprocalMath = false;
787
788 StringRef LastComplexRangeOption;
790
791 if (const Arg *A = Args.getLastArg(options::OPT_ffp_contract)) {
792 const StringRef Val = A->getValue();
793 if (Val == "fast" || Val == "off") {
794 FPContract = Val;
795 } else if (Val == "on") {
796 // Warn instead of error because users might have makefiles written for
797 // gfortran (which accepts -ffp-contract=on)
798 D.Diag(diag::warn_drv_unsupported_option_for_flang)
799 << Val << A->getOption().getName() << "off";
800 FPContract = "off";
801 } else
802 // Clang's "fast-honor-pragmas" option is not supported because it is
803 // non-standard
804 D.Diag(diag::err_drv_unsupported_option_argument)
805 << A->getSpelling() << Val;
806 }
807
808 for (const Arg *A : Args) {
809 auto optId = A->getOption().getID();
810 switch (optId) {
811 // if this isn't an FP option, skip the claim below
812 default:
813 continue;
814
815 case options::OPT_fcomplex_arithmetic_EQ: {
817 StringRef Val = A->getValue();
818 if (Val == "full")
820 else if (Val == "improved")
822 else if (Val == "basic")
824 else {
825 D.Diag(diag::err_drv_unsupported_option_argument)
826 << A->getSpelling() << Val;
827 break;
828 }
829
830 setComplexRange(D, Args.MakeArgString(A->getSpelling() + Val), NewRange,
831 LastComplexRangeOption, Range);
832 break;
833 }
834 case options::OPT_fhonor_infinities:
835 HonorINFs = true;
836 break;
837 case options::OPT_fno_honor_infinities:
838 HonorINFs = false;
839 break;
840 case options::OPT_fhonor_nans:
841 HonorNaNs = true;
842 break;
843 case options::OPT_fno_honor_nans:
844 HonorNaNs = false;
845 break;
846 case options::OPT_fapprox_func:
847 ApproxFunc = true;
848 break;
849 case options::OPT_fno_approx_func:
850 ApproxFunc = false;
851 break;
852 case options::OPT_fsigned_zeros:
853 SignedZeros = true;
854 break;
855 case options::OPT_fno_signed_zeros:
856 SignedZeros = false;
857 break;
858 case options::OPT_fassociative_math:
859 AssociativeMath = true;
860 break;
861 case options::OPT_fno_associative_math:
862 AssociativeMath = false;
863 break;
864 case options::OPT_freciprocal_math:
865 ReciprocalMath = true;
866 break;
867 case options::OPT_fno_reciprocal_math:
868 ReciprocalMath = false;
869 break;
870 case options::OPT_Ofast:
871 [[fallthrough]];
872 case options::OPT_ffast_math:
873 HonorINFs = false;
874 HonorNaNs = false;
875 AssociativeMath = true;
876 ReciprocalMath = true;
877 ApproxFunc = true;
878 SignedZeros = false;
879 FPContract = "fast";
880 setComplexRange(D, A->getSpelling(),
882 LastComplexRangeOption, Range);
883 break;
884 case options::OPT_fno_fast_math:
885 HonorINFs = true;
886 HonorNaNs = true;
887 AssociativeMath = false;
888 ReciprocalMath = false;
889 ApproxFunc = false;
890 SignedZeros = true;
891 // -fno-fast-math should undo -ffast-math so I return FPContract to the
892 // default. It is important to check it is "fast" (the default) so that
893 // --ffp-contract=off -fno-fast-math --> -ffp-contract=off
894 if (FPContract == "fast")
895 FPContract = "";
896 setComplexRange(D, A->getSpelling(),
898 LastComplexRangeOption, Range);
899 break;
900 }
901
902 // If we handled this option claim it
903 A->claim();
904 }
905
906 StringRef Recip = parseMRecipOption(D.getDiags(), Args);
907 if (!Recip.empty())
908 CmdArgs.push_back(Args.MakeArgString("-mrecip=" + Recip));
909
911 std::string ComplexRangeStr = renderComplexRangeOption(Range);
912 CmdArgs.push_back(Args.MakeArgString(ComplexRangeStr));
913 CmdArgs.push_back(Args.MakeArgString("-fcomplex-arithmetic=" +
914 complexRangeKindToStr(Range)));
915 }
916
917 if (llvm::opt::Arg *A =
918 Args.getLastArg(clang::options::OPT_ffast_real_mod,
919 clang::options::OPT_fno_fast_real_mod)) {
920 if (A->getOption().matches(clang::options::OPT_ffast_real_mod))
921 CmdArgs.push_back("-ffast-real-mod");
922 else if (A->getOption().matches(clang::options::OPT_fno_fast_real_mod))
923 CmdArgs.push_back("-fno-fast-real-mod");
924 }
925
926 if (!HonorINFs && !HonorNaNs && AssociativeMath && ReciprocalMath &&
927 ApproxFunc && !SignedZeros &&
928 (FPContract == "fast" || FPContract.empty())) {
929 CmdArgs.push_back("-ffast-math");
930 return;
931 }
932
933 if (!FPContract.empty())
934 CmdArgs.push_back(Args.MakeArgString("-ffp-contract=" + FPContract));
935
936 if (!HonorINFs)
937 CmdArgs.push_back("-menable-no-infs");
938
939 if (!HonorNaNs)
940 CmdArgs.push_back("-menable-no-nans");
941
942 if (ApproxFunc)
943 CmdArgs.push_back("-fapprox-func");
944
945 if (!SignedZeros)
946 CmdArgs.push_back("-fno-signed-zeros");
947
948 if (AssociativeMath && !SignedZeros)
949 CmdArgs.push_back("-mreassociate");
950
951 if (ReciprocalMath)
952 CmdArgs.push_back("-freciprocal-math");
953}
954
955static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
956 const InputInfo &Input) {
957 StringRef Format = "yaml";
958 if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
959 Format = A->getValue();
960
961 CmdArgs.push_back("-opt-record-file");
962
963 const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
964 if (A) {
965 CmdArgs.push_back(A->getValue());
966 } else {
968
969 if (Args.hasArg(options::OPT_c) || Args.hasArg(options::OPT_S)) {
970 if (Arg *FinalOutput = Args.getLastArg(options::OPT_o))
971 F = FinalOutput->getValue();
972 }
973
974 if (F.empty()) {
975 // Use the input filename.
976 F = llvm::sys::path::stem(Input.getBaseInput());
977 }
978
979 SmallString<32> Extension;
980 Extension += "opt.";
981 Extension += Format;
982
983 llvm::sys::path::replace_extension(F, Extension);
984 CmdArgs.push_back(Args.MakeArgString(F));
985 }
986
987 if (const Arg *A =
988 Args.getLastArg(options::OPT_foptimization_record_passes_EQ)) {
989 CmdArgs.push_back("-opt-record-passes");
990 CmdArgs.push_back(A->getValue());
991 }
992
993 if (!Format.empty()) {
994 CmdArgs.push_back("-opt-record-format");
995 CmdArgs.push_back(Format.data());
996 }
997}
998
999static void addPGOAndCoverageFlags(const ToolChain &TC, const JobAction &JA,
1000 const ArgList &Args,
1001 ArgStringList &CmdArgs) {
1002 const Driver &D = TC.getDriver();
1003 const llvm::Triple &T = TC.getTriple();
1004
1005 bool IsCudaDevice = JA.isDeviceOffloading(Action::OFK_Cuda);
1006 bool IsHIPDevice = JA.isDeviceOffloading(Action::OFK_HIP);
1007
1008 if (T.isOSAIX()) {
1009 if (Arg *ProfileSampleUseArg = getLastProfileSampleUseArg(Args))
1010 D.Diag(diag::err_drv_unsupported_opt_for_target)
1011 << ProfileSampleUseArg->getSpelling() << TC.getTriple().str();
1012 }
1013
1014 if (!(IsCudaDevice || IsHIPDevice)) {
1015 // recognise options: -fprofile-sample-use= and -fno-profile-sample-use=
1016 if (Arg *A = getLastProfileSampleUseArg(Args)) {
1017 if (Arg *PGOArg = Args.getLastArg(options::OPT_fprofile_generate,
1018 options::OPT_fprofile_generate_EQ)) {
1019 D.Diag(diag::err_drv_argument_not_allowed_with)
1020 << PGOArg->getAsString(Args) << A->getAsString(Args);
1021 }
1022
1023 StringRef fname = A->getValue();
1024 if (!llvm::sys::fs::exists(fname))
1025 D.Diag(diag::err_drv_no_such_file) << fname;
1026 else
1027 A->render(Args, CmdArgs);
1028 }
1029 }
1030
1031 //-fpseudo-probe-for-profiling
1032 if (Args.hasFlag(options::OPT_fpseudo_probe_for_profiling,
1033 options::OPT_fno_pseudo_probe_for_profiling, false))
1034 CmdArgs.push_back("-fpseudo-probe-for-profiling");
1035}
1036
1038 const InputInfo &Output, const InputInfoList &Inputs,
1039 const ArgList &Args, const char *LinkingOutput) const {
1040 const auto &TC = getToolChain();
1041 const llvm::Triple &Triple = TC.getEffectiveTriple();
1042 const std::string &TripleStr = Triple.getTriple();
1043
1044 const Driver &D = TC.getDriver();
1045 ArgStringList CmdArgs;
1046
1047 // Invoke ourselves in -fc1 mode.
1048 CmdArgs.push_back("-fc1");
1049
1050 // Add the "effective" target triple.
1051 CmdArgs.push_back("-triple");
1052 CmdArgs.push_back(Args.MakeArgString(TripleStr));
1053
1054 if (isa<PreprocessJobAction>(JA)) {
1055 CmdArgs.push_back("-E");
1056 if (Args.getLastArg(options::OPT_dM)) {
1057 CmdArgs.push_back("-dM");
1058 }
1059 } else if (isa<CompileJobAction>(JA) || isa<BackendJobAction>(JA)) {
1060 if (JA.getType() == types::TY_Nothing) {
1061 CmdArgs.push_back("-fsyntax-only");
1062 } else if (JA.getType() == types::TY_AST) {
1063 CmdArgs.push_back("-emit-ast");
1064 } else if (JA.getType() == types::TY_LLVM_IR ||
1065 JA.getType() == types::TY_LTO_IR) {
1066 CmdArgs.push_back("-emit-llvm");
1067 } else if (JA.getType() == types::TY_LLVM_BC ||
1068 JA.getType() == types::TY_LTO_BC) {
1069 CmdArgs.push_back("-emit-llvm-bc");
1070 } else if (JA.getType() == types::TY_PP_Asm) {
1071 CmdArgs.push_back("-S");
1072 } else {
1073 assert(false && "Unexpected output type!");
1074 }
1075 } else if (isa<AssembleJobAction>(JA)) {
1076 CmdArgs.push_back("-emit-obj");
1077 } else if (isa<PrecompileJobAction>(JA)) {
1078 // The precompile job action is only needed for options such as -mcpu=help.
1079 // Those will already have been handled by the fc1 driver.
1080 } else {
1081 assert(false && "Unexpected action class for Flang tool.");
1082 }
1083
1084 // We support some options that are invalid for Fortran and have no effect.
1085 // These are solely for compatibility with other compilers. Emit a warning if
1086 // any such options are provided, then proceed normally.
1087 for (options::ID Opt : {options::OPT_fbuiltin, options::OPT_fno_builtin})
1088 if (const Arg *A = Args.getLastArg(Opt))
1089 D.Diag(diag::warn_drv_invalid_argument_for_flang) << A->getSpelling();
1090
1091 // Warn about options that are ignored by flang. These are options that are
1092 // accepted by gfortran, but have no equivalent in flang.
1093 for (const Arg *A :
1094 Args.filtered(options::OPT_clang_ignored_gcc_optimization_f_Group)) {
1095 D.Diag(diag::warn_ignored_gcc_optimization) << A->getAsString(Args);
1096 A->claim();
1097 }
1098
1099 const InputInfo &Input = Inputs[0];
1100 types::ID InputType = Input.getType();
1101
1102 // Add preprocessing options like -I, -D, etc. if we are using the
1103 // preprocessor (i.e. skip when dealing with e.g. binary files).
1105 addPreprocessingOptions(Args, CmdArgs);
1106
1107 addFortranDialectOptions(Args, CmdArgs);
1108
1109 // 'flang -E' always produces output that is suitable for use as fixed form
1110 // Fortran. However it is only valid free form source if the original is also
1111 // free form. Ensure this logic does not incorrectly assume fixed-form for
1112 // cases where it shouldn't, such as `flang -x f95 foo.f90`.
1113 bool isAtemporaryPreprocessedFile =
1114 Input.isFilename() &&
1115 llvm::sys::path::extension(Input.getFilename())
1116 .ends_with(types::getTypeTempSuffix(InputType, /*CLStyle=*/false));
1117 if (InputType == types::TY_PP_Fortran && isAtemporaryPreprocessedFile &&
1118 !Args.getLastArg(options::OPT_ffixed_form, options::OPT_ffree_form))
1119 CmdArgs.push_back("-ffixed-form");
1120
1121 handleColorDiagnosticsArgs(D, Args, CmdArgs);
1122
1123 addLTOOptions(Args, CmdArgs);
1124
1125 // -fPIC and related options.
1126 addPicOptions(Args, CmdArgs);
1127
1128 // Floating point related options
1129 addFloatingPointOptions(D, Args, CmdArgs);
1130
1131 // Add target args, features, etc.
1132 addTargetOptions(Args, CmdArgs, JA.getOffloadingArch(),
1134
1135 if (!TC.useIntegratedAs())
1136 CmdArgs.push_back("-no-integrated-as");
1137
1138 llvm::Reloc::Model RelocationModel =
1139 std::get<0>(ParsePICArgs(getToolChain(), Args));
1140 // Add MCModel information
1141 addMCModel(D, Args, Triple, RelocationModel, CmdArgs);
1142
1143 // Add Codegen options
1144 addCodegenOptions(Args, CmdArgs);
1145
1146 // Add R Group options
1147 Args.AddAllArgs(CmdArgs, options::OPT_R_Group);
1148
1149 // Remarks can be enabled with any of the `-f.*optimization-record.*` flags.
1150 if (willEmitRemarks(Args))
1151 renderRemarksOptions(Args, CmdArgs, Input);
1152
1153 // Add debug compile options
1154 addDebugOptions(Args, JA, Output, Input, CmdArgs);
1155
1156 // Disable all warnings
1157 // TODO: Handle interactions between -w, -pedantic, -Wall, -WOption
1158 Args.AddLastArg(CmdArgs, options::OPT_w);
1159
1160 // recognise options: fprofile-generate -fprofile-use=
1161 Args.addAllArgs(
1162 CmdArgs, {options::OPT_fprofile_generate, options::OPT_fprofile_use_EQ});
1163
1164 addPGOAndCoverageFlags(TC, JA, Args, CmdArgs);
1165
1166 // Forward flags for OpenMP. We don't do this if the current action is an
1167 // device offloading action other than OpenMP.
1168 if (Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
1169 options::OPT_fno_openmp, false) &&
1172 switch (D.getOpenMPRuntime(Args)) {
1173 case Driver::OMPRT_OMP:
1175 // Clang can generate useful OpenMP code for these two runtime libraries.
1176 CmdArgs.push_back("-fopenmp");
1177 Args.AddAllArgs(CmdArgs, options::OPT_fopenmp_version_EQ);
1178
1179 if (Args.hasArg(options::OPT_fopenmp_force_usm))
1180 CmdArgs.push_back("-fopenmp-force-usm");
1181 Args.AddLastArg(CmdArgs, options::OPT_fopenmp_simd,
1182 options::OPT_fno_openmp_simd);
1183
1184 // FIXME: Clang supports a whole bunch more flags here.
1185 break;
1186 default:
1187 // By default, if Clang doesn't know how to generate useful OpenMP code
1188 // for a specific runtime library, we just don't pass the '-fopenmp' flag
1189 // down to the actual compilation.
1190 // FIXME: It would be better to have a mode which *only* omits IR
1191 // generation based on the OpenMP support so that we get consistent
1192 // semantic analysis, etc.
1193 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
1194 D.Diag(diag::warn_drv_unsupported_openmp_library)
1195 << A->getSpelling() << A->getValue();
1196 break;
1197 }
1198 } else {
1199 Args.AddLastArg(CmdArgs, options::OPT_fopenmp_simd,
1200 options::OPT_fno_openmp_simd);
1201 }
1202
1203 // Pass the path to compiler resource files.
1204 CmdArgs.push_back("-resource-dir");
1205 CmdArgs.push_back(D.ResourceDir.c_str());
1206
1207 // Default intrinsic module dirs must be added after any user-provided dirs in
1208 // -fintrinsic-modules-path since the default dirs have lower precedence than
1209 // user-provided dirs
1210 if (std::optional<std::string> IntrModPath =
1212 CmdArgs.push_back("-fintrinsic-modules-path");
1213 CmdArgs.push_back(Args.MakeArgString(*IntrModPath));
1214 }
1215
1216 // Ideally, every target triple has its own set of builtin modules since they
1217 // are compiled with platform-dependent conditionals such as `#if __x86_64__`.
1218 // However, getting the builtin modules for offload targets requires building
1219 // the flang-rt and openmp for those targets as well:
1220 // -DLLVM_RUNTIME_TARGETS=default;amdgcn-amd-amdhsa;nvptx64-nvidia-cuda.
1221 // To reduce friction when build systems have not yet been updated, we also
1222 // add the host's builtin module to the search path (with lower priority), in
1223 // case a module file has not been found for the offload targets itself.
1224 // FIXME: This workaround may mix module files targeting different triples and
1225 // should eventually be removed.
1226 auto &&HostTCs =
1227 C.getOffloadToolChains<clang::driver::OffloadAction ::OFK_Host>();
1228 for (auto [OKind, HostTC] : llvm::make_range(HostTCs.first, HostTCs.second)) {
1229 if (HostTC == &TC)
1230 continue;
1231
1232 if (std::optional<std::string> IntrModPath =
1233 HostTC->getDefaultIntrinsicModuleDir()) {
1234 CmdArgs.push_back("-fintrinsic-modules-path");
1235 CmdArgs.push_back(Args.MakeArgString(*IntrModPath));
1236 }
1237 }
1238
1239 // Offloading related options
1240 addOffloadOptions(C, Inputs, JA, Args, CmdArgs);
1241
1242 // Forward -Xflang arguments to -fc1
1243 Args.AddAllArgValues(CmdArgs, options::OPT_Xflang);
1244
1246 getFramePointerKind(Args, Triple);
1247
1248 const char *FPKeepKindStr = nullptr;
1249 switch (FPKeepKind) {
1251 FPKeepKindStr = "-mframe-pointer=none";
1252 break;
1254 FPKeepKindStr = "-mframe-pointer=reserved";
1255 break;
1257 FPKeepKindStr = "-mframe-pointer=non-leaf-no-reserve";
1258 break;
1260 FPKeepKindStr = "-mframe-pointer=non-leaf";
1261 break;
1263 FPKeepKindStr = "-mframe-pointer=all";
1264 break;
1265 }
1266 assert(FPKeepKindStr && "unknown FramePointerKind");
1267 CmdArgs.push_back(FPKeepKindStr);
1268
1269 // Forward -mllvm options to the LLVM option parser. In practice, this means
1270 // forwarding to `-fc1` as that's where the LLVM parser is run.
1271 for (const Arg *A : Args.filtered(options::OPT_mllvm)) {
1272 A->claim();
1273 A->render(Args, CmdArgs);
1274 }
1275
1276 for (const Arg *A : Args.filtered(options::OPT_mmlir)) {
1277 A->claim();
1278 A->render(Args, CmdArgs);
1279 }
1280
1281 // Remove any unsupported gfortran diagnostic options
1282 for (const Arg *A : Args.filtered(options::OPT_flang_ignored_w_Group)) {
1283 A->claim();
1284 D.Diag(diag::warn_drv_unsupported_diag_option_for_flang)
1285 << A->getOption().getName();
1286 }
1287
1288 // Optimization level for CodeGen.
1289 if (const Arg *A = Args.getLastArg(options::OPT_O_Group)) {
1290 if (A->getOption().matches(options::OPT_O4)) {
1291 CmdArgs.push_back("-O3");
1292 D.Diag(diag::warn_O4_is_O3);
1293 } else if (A->getOption().matches(options::OPT_Ofast)) {
1294 CmdArgs.push_back("-O3");
1295 D.Diag(diag::warn_drv_deprecated_arg_ofast_for_flang);
1296 } else {
1297 A->render(Args, CmdArgs);
1298 }
1299 }
1300
1301 renderGlobalISelOptions(D, Args, CmdArgs, Triple);
1302 renderCommonIntegerOverflowOptions(Args, CmdArgs, false);
1303
1304 assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");
1305 if (Output.isFilename()) {
1306 CmdArgs.push_back("-o");
1307 CmdArgs.push_back(Output.getFilename());
1308 }
1309
1310 if (Args.getLastArg(options::OPT_save_temps_EQ))
1311 Args.AddLastArg(CmdArgs, options::OPT_save_temps_EQ);
1312
1313 addDashXForInput(Args, Input, CmdArgs);
1314
1315 bool FRecordCmdLine = false;
1316 bool GRecordCmdLine = false;
1317 bool DXRecordCmdLine = false;
1318 if (shouldRecordCommandLine(TC, Args, FRecordCmdLine, GRecordCmdLine,
1319 DXRecordCmdLine)) {
1320 const char *CmdLine = renderEscapedCommandLine(TC, Args);
1321 if (FRecordCmdLine) {
1322 CmdArgs.push_back("-record-command-line");
1323 CmdArgs.push_back(CmdLine);
1324 }
1325 if (TC.UseDwarfDebugFlags() || GRecordCmdLine) {
1326 CmdArgs.push_back("-dwarf-debug-flags");
1327 CmdArgs.push_back(CmdLine);
1328 }
1329 }
1330
1331 // The input could be Ty_Nothing when "querying" options such as -mcpu=help
1332 // are used.
1333 ArrayRef<InputInfo> FrontendInputs = Input;
1334 if (Input.isNothing())
1335 FrontendInputs = {};
1336
1337 for (const InputInfo &Input : FrontendInputs) {
1338 if (Input.isFilename())
1339 CmdArgs.push_back(Input.getFilename());
1340 else
1341 Input.getInputArg().renderAsInput(Args, CmdArgs);
1342 }
1343
1344 // Handle "clang --driver-mode=flang" case
1345 bool isClangDriverWithFlangMode = false;
1346 std::string DriverName = D.Name;
1347 if (const char *PA = D.getPrependArg())
1348 DriverName = PA;
1349 if (DriverName.find("clang") != std::string::npos && D.IsFlangMode())
1350 isClangDriverWithFlangMode = true;
1351
1352 const char *Exec = isClangDriverWithFlangMode
1353 ? Args.MakeArgString(D.GetProgramPath("flang", TC))
1355 C.addCommand(std::make_unique<Command>(JA, *this,
1357 Exec, CmdArgs, Inputs, Output));
1358}
1359
1360Flang::Flang(const ToolChain &TC) : Tool("flang", "flang frontend", TC) {}
1361
#define V(N, I)
static void addDashXForInput(const ArgList &Args, const InputInfo &Input, ArgStringList &CmdArgs)
Add -x lang to CmdArgs for Input.
Definition Clang.cpp:338
static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs, const llvm::Triple &Triple, const InputInfo &Input, const InputInfo &Output, const JobAction &JA)
Definition Clang.cpp:1276
static void addPGOAndCoverageFlags(const ToolChain &TC, Compilation &C, const JobAction &JA, const InputInfo &Output, const ArgList &Args, SanitizerArgs &SanArgs, ArgStringList &CmdArgs)
Definition Clang.cpp:369
clang::CodeGenOptions::FramePointerKind getFramePointerKind(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
static void processVSRuntimeLibrary(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs)
Definition Flang.cpp:484
static void addVSDefines(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs)
Definition Flang.cpp:460
static bool shouldLoopVersion(const ArgList &Args)
@C shouldLoopVersion
Definition Flang.cpp:95
static void addDashXForInput(const ArgList &Args, const InputInfo &Input, ArgStringList &CmdArgs)
Add -x lang to CmdArgs for Input.
Definition Flang.cpp:31
static void addFloatingPointOptions(const Driver &D, const ArgList &Args, ArgStringList &CmdArgs)
Definition Flang.cpp:778
TokenType getType() const
Returns the token's type, e.g.
ComplexRangeKind
Controls the various implementations for complex multiplication and.
@ CX_Full
Implementation of complex division and multiplication using a call to runtime library functions(gener...
@ CX_Basic
Implementation of complex division and multiplication using algebraic formulas at source precision.
@ CX_None
No range rule is enabled.
@ CX_Improved
Implementation of complex division offering an improved handling for overflow in intermediate calcula...
types::ID getType() const
Definition Action.h:154
BoundArch getOffloadingArch() const
Definition Action.h:217
OffloadKind getOffloadingDeviceKind() const
Definition Action.h:216
bool isHostOffloading(unsigned int OKind) const
Check if this action have any offload kinds.
Definition Action.h:224
bool isDeviceOffloading(OffloadKind OKind) const
Definition Action.h:227
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:95
DiagnosticsEngine & getDiags() const
Definition Driver.h:409
const char * getPrependArg() const
Definition Driver.h:420
OpenMPRuntimeKind getOpenMPRuntime(const llvm::opt::ArgList &Args) const
Compute the desired OpenMP runtime from the flags provided.
Definition Driver.cpp:853
DiagnosticBuilder Diag(unsigned DiagID) const
Definition Driver.h:159
std::string Name
The name the driver was invoked as.
Definition Driver.h:166
const char * getDriverProgramPath() const
Get the path to the main driver executable.
Definition Driver.h:431
std::string GetProgramPath(StringRef Name, const ToolChain &TC) const
GetProgramPath - Lookup Name in the list of program search paths.
Definition Driver.cpp:6880
std::string ResourceDir
The path to the compiler resource directory.
Definition Driver.h:179
@ OMPRT_IOMP5
The legacy name for the LLVM OpenMP runtime from when it was the Intel OpenMP runtime.
Definition Driver.h:155
@ OMPRT_OMP
The LLVM OpenMP runtime.
Definition Driver.h:145
bool IsFlangMode() const
Whether the driver should invoke flang for fortran inputs.
Definition Driver.h:235
InputInfo - Wrapper for information about an input source.
Definition InputInfo.h:22
const char * getBaseInput() const
Definition InputInfo.h:78
const llvm::opt::Arg & getInputArg() const
Definition InputInfo.h:87
const char * getFilename() const
Definition InputInfo.h:83
bool isNothing() const
Definition InputInfo.h:74
bool isFilename() const
Definition InputInfo.h:75
types::ID getType() const
Definition InputInfo.h:77
ToolChain - Access to tools for a single platform.
Definition ToolChain.h:96
virtual bool useIntegratedAs() const
Check if the toolchain should use the integrated assembler.
llvm::Triple::ArchType getArch() const
Definition ToolChain.h:302
const Driver & getDriver() const
Definition ToolChain.h:286
virtual LTOKind getLTOMode(const llvm::opt::ArgList &Args, Action::OffloadKind Kind=Action::OFK_None) const
Resolve the requested LTO mode for this toolchain.
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:314
const llvm::Triple & getTriple() const
Definition ToolChain.h:288
virtual bool UseDwarfDebugFlags() const
UseDwarfDebugFlags - Embed the compile options to clang into the Dwarf compile unit information.
Definition ToolChain.h:655
virtual VersionTuple computeMSVCVersion(const Driver *D, const llvm::opt::ArgList &Args) const
On Windows, returns the MSVC compatibility version.
std::string getCompilerRTBasename(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
std::optional< std::string > getDefaultIntrinsicModuleDir() const
Returns the target-specific path for Flang's intrinsic modules in the resource directory if it exists...
const ToolChain & getToolChain() const
Definition Tool.h:52
Tool(const char *Name, const char *ShortName, const ToolChain &TC)
Definition Tool.cpp:14
Flang(const ToolChain &TC)
Definition Flang.cpp:1360
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 Flang.cpp:1037
std::string getRISCVArch(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
Definition RISCV.cpp:275
StringRef getRISCVABI(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
void addMCModel(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &Triple, const llvm::Reloc::Model &RelocationModel, llvm::opt::ArgStringList &CmdArgs)
llvm::opt::Arg * getLastProfileSampleUseArg(const llvm::opt::ArgList &Args)
void handleVectorizeSLPArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Enable -fslp-vectorize based on the optimization level selected.
const char * SplitDebugName(const JobAction &JA, const llvm::opt::ArgList &Args, const InputInfo &Input, const InputInfo &Output)
void addOutlineAtomicsArgs(const Driver &D, const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const llvm::Triple &Triple)
void getTargetFeatures(const Driver &D, const llvm::Triple &Triple, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool ForAS, bool IsAux=false)
std::string complexRangeKindToStr(LangOptions::ComplexRangeKind Range)
void handleColorDiagnosticsArgs(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Handle the -f{no}-color-diagnostics and -f{no}-diagnostics-colors options.
std::string getCPUName(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T, bool FromAs=false)
void setComplexRange(const Driver &D, StringRef NewOpt, LangOptions::ComplexRangeKind NewRange, StringRef &LastOpt, LangOptions::ComplexRangeKind &Range)
void addDebugInfoForProfilingArgs(const Driver &D, const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
void addDebugInfoKind(llvm::opt::ArgStringList &CmdArgs, llvm::codegenoptions::DebugInfoKind DebugInfoKind)
llvm::codegenoptions::DebugInfoKind debugLevelToInfoKind(const llvm::opt::Arg &A)
void renderGlobalISelOptions(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, const llvm::Triple &Triple)
std::string renderComplexRangeOption(LangOptions::ComplexRangeKind Range)
DwarfFissionKind getDebugFissionKind(const Driver &D, const llvm::opt::ArgList &Args, llvm::opt::Arg *&Arg)
void handleInterchangeLoopsArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Enable -floop-interchange based on the optimization level selected.
const char * renderEscapedCommandLine(const ToolChain &TC, const llvm::opt::ArgList &Args)
Join the args in the given ArgList, escape spaces and backslashes and return the joined string.
void renderCommonIntegerOverflowOptions(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, bool IsMSVCCompat)
bool checkDebugInfoOption(const llvm::opt::Arg *A, const llvm::opt::ArgList &Args, const Driver &D, const ToolChain &TC)
std::tuple< llvm::Reloc::Model, unsigned, bool > ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args)
unsigned getDwarfVersion(const ToolChain &TC, const llvm::opt::ArgList &Args)
bool shouldRecordCommandLine(const ToolChain &TC, const llvm::opt::ArgList &Args, bool &FRecordCommandLine, bool &GRecordCommandLine, bool &DXRecordCommandLine)
Check if the command line should be recorded in the object file.
const llvm::opt::Arg * getDwarfNArg(const llvm::opt::ArgList &Args)
void addSeparateSectionFlags(const llvm::Triple &Triple, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Append -ffunction-sections / -fdata-sections to CmdArgs when the corresponding flags are enabled (exp...
void handleVectorizeLoopsArgs(const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Enable -fvectorize based on the optimization level selected.
const char * RelocationModelName(llvm::Reloc::Model Model)
void addOpenMPHostOffloadingArgs(const Compilation &C, const JobAction &JA, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs)
Adds offloading options for OpenMP host compilation to CmdArgs.
ID getPreprocessedType(ID Id)
getPreprocessedType - Get the ID of the type for this input when it has been preprocessed,...
Definition Types.cpp:53
const char * getTypeName(ID Id)
getTypeName - Return the name of the type for Id.
Definition Types.cpp:49
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
LTOKind
Describes the kind of LTO mode selected via -f(no-)?lto(=.*)? options.
Definition Driver.h:59
SmallVector< InputInfo, 4 > InputInfoList
Definition Driver.h:51
bool willEmitRemarks(const llvm::opt::ArgList &Args)
The JSON file list parser is used to communicate input to InstallAPI.
bool isa(CodeGen::Address addr)
Definition Address.h:330
StringRef parseMRecipOption(clang::DiagnosticsEngine &Diags, const llvm::opt::ArgList &Args)
bool(*)(llvm::ArrayRef< const char * >, llvm::raw_ostream &, llvm::raw_ostream &, bool, bool) Driver
Definition Wasm.cpp:36
__DEVICE__ _Tp arg(const std::complex< _Tp > &__c)
static constexpr ResponseFileSupport AtFileUTF8()
Definition Job.h:86