clang 19.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 "CommonArgs.h"
12
15#include "llvm/Frontend/Debug/Options.h"
16#include "llvm/Support/FileSystem.h"
17#include "llvm/Support/Path.h"
18#include "llvm/TargetParser/RISCVISAInfo.h"
19#include "llvm/TargetParser/RISCVTargetParser.h"
20
21#include <cassert>
22
23using namespace clang::driver;
24using namespace clang::driver::tools;
25using namespace clang;
26using namespace llvm::opt;
27
28/// Add -x lang to \p CmdArgs for \p Input.
29static void addDashXForInput(const ArgList &Args, const InputInfo &Input,
30 ArgStringList &CmdArgs) {
31 CmdArgs.push_back("-x");
32 // Map the driver type to the frontend type.
33 CmdArgs.push_back(types::getTypeName(Input.getType()));
34}
35
36void Flang::addFortranDialectOptions(const ArgList &Args,
37 ArgStringList &CmdArgs) const {
38 Args.addAllArgs(
39 CmdArgs, {options::OPT_ffixed_form, options::OPT_ffree_form,
40 options::OPT_ffixed_line_length_EQ, options::OPT_fopenacc,
41 options::OPT_finput_charset_EQ, options::OPT_fimplicit_none,
42 options::OPT_fno_implicit_none, options::OPT_fbackslash,
43 options::OPT_fno_backslash, options::OPT_flogical_abbreviations,
44 options::OPT_fno_logical_abbreviations,
45 options::OPT_fxor_operator, options::OPT_fno_xor_operator,
46 options::OPT_falternative_parameter_statement,
47 options::OPT_fdefault_real_8, options::OPT_fdefault_integer_8,
48 options::OPT_fdefault_double_8, options::OPT_flarge_sizes,
49 options::OPT_fno_automatic});
50}
51
52void Flang::addPreprocessingOptions(const ArgList &Args,
53 ArgStringList &CmdArgs) const {
54 Args.addAllArgs(CmdArgs,
55 {options::OPT_P, options::OPT_D, options::OPT_U,
56 options::OPT_I, options::OPT_cpp, options::OPT_nocpp});
57}
58
59/// @C shouldLoopVersion
60///
61/// Check if Loop Versioning should be enabled.
62/// We look for the last of one of the following:
63/// -Ofast, -O4, -O<number> and -f[no-]version-loops-for-stride.
64/// Loop versioning is disabled if the last option is
65/// -fno-version-loops-for-stride.
66/// Loop versioning is enabled if the last option is one of:
67/// -floop-versioning
68/// -Ofast
69/// -O4
70/// -O3
71/// For all other cases, loop versioning is is disabled.
72///
73/// The gfortran compiler automatically enables the option for -O3 or -Ofast.
74///
75/// @return true if loop-versioning should be enabled, otherwise false.
76static bool shouldLoopVersion(const ArgList &Args) {
77 const Arg *LoopVersioningArg = Args.getLastArg(
78 options::OPT_Ofast, options::OPT_O, options::OPT_O4,
79 options::OPT_floop_versioning, options::OPT_fno_loop_versioning);
80 if (!LoopVersioningArg)
81 return false;
82
83 if (LoopVersioningArg->getOption().matches(options::OPT_fno_loop_versioning))
84 return false;
85
86 if (LoopVersioningArg->getOption().matches(options::OPT_floop_versioning))
87 return true;
88
89 if (LoopVersioningArg->getOption().matches(options::OPT_Ofast) ||
90 LoopVersioningArg->getOption().matches(options::OPT_O4))
91 return true;
92
93 if (LoopVersioningArg->getOption().matches(options::OPT_O)) {
94 StringRef S(LoopVersioningArg->getValue());
95 unsigned OptLevel = 0;
96 // Note -Os or Oz woould "fail" here, so return false. Which is the
97 // desiered behavior.
98 if (S.getAsInteger(10, OptLevel))
99 return false;
100
101 return OptLevel > 2;
102 }
103
104 llvm_unreachable("We should not end up here");
105 return false;
106}
107
108void Flang::addOtherOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
109 Args.addAllArgs(CmdArgs,
110 {options::OPT_module_dir, options::OPT_fdebug_module_writer,
111 options::OPT_fintrinsic_modules_path, options::OPT_pedantic,
112 options::OPT_std_EQ, options::OPT_W_Joined,
113 options::OPT_fconvert_EQ, options::OPT_fpass_plugin_EQ,
114 options::OPT_funderscoring, options::OPT_fno_underscoring});
115
116 llvm::codegenoptions::DebugInfoKind DebugInfoKind;
117 if (Args.hasArg(options::OPT_gN_Group)) {
118 Arg *gNArg = Args.getLastArg(options::OPT_gN_Group);
119 DebugInfoKind = debugLevelToInfoKind(*gNArg);
120 } else if (Args.hasArg(options::OPT_g_Flag)) {
121 DebugInfoKind = llvm::codegenoptions::FullDebugInfo;
122 } else {
123 DebugInfoKind = llvm::codegenoptions::NoDebugInfo;
124 }
125 addDebugInfoKind(CmdArgs, DebugInfoKind);
126}
127
128void Flang::addCodegenOptions(const ArgList &Args,
129 ArgStringList &CmdArgs) const {
130 Arg *stackArrays =
131 Args.getLastArg(options::OPT_Ofast, options::OPT_fstack_arrays,
132 options::OPT_fno_stack_arrays);
133 if (stackArrays &&
134 !stackArrays->getOption().matches(options::OPT_fno_stack_arrays))
135 CmdArgs.push_back("-fstack-arrays");
136
137 if (shouldLoopVersion(Args))
138 CmdArgs.push_back("-fversion-loops-for-stride");
139
140 Args.addAllArgs(CmdArgs, {options::OPT_flang_experimental_hlfir,
141 options::OPT_flang_deprecated_no_hlfir,
142 options::OPT_flang_experimental_integer_overflow,
143 options::OPT_fno_ppc_native_vec_elem_order,
144 options::OPT_fppc_native_vec_elem_order});
145}
146
147void Flang::addPicOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
148 // ParsePICArgs parses -fPIC/-fPIE and their variants and returns a tuple of
149 // (RelocationModel, PICLevel, IsPIE).
150 llvm::Reloc::Model RelocationModel;
151 unsigned PICLevel;
152 bool IsPIE;
153 std::tie(RelocationModel, PICLevel, IsPIE) =
154 ParsePICArgs(getToolChain(), Args);
155
156 if (auto *RMName = RelocationModelName(RelocationModel)) {
157 CmdArgs.push_back("-mrelocation-model");
158 CmdArgs.push_back(RMName);
159 }
160 if (PICLevel > 0) {
161 CmdArgs.push_back("-pic-level");
162 CmdArgs.push_back(PICLevel == 1 ? "1" : "2");
163 if (IsPIE)
164 CmdArgs.push_back("-pic-is-pie");
165 }
166}
167
168void Flang::AddAArch64TargetArgs(const ArgList &Args,
169 ArgStringList &CmdArgs) const {
170 // Handle -msve_vector_bits=<bits>
171 if (Arg *A = Args.getLastArg(options::OPT_msve_vector_bits_EQ)) {
172 StringRef Val = A->getValue();
173 const Driver &D = getToolChain().getDriver();
174 if (Val == "128" || Val == "256" || Val == "512" || Val == "1024" ||
175 Val == "2048" || Val == "128+" || Val == "256+" || Val == "512+" ||
176 Val == "1024+" || Val == "2048+") {
177 unsigned Bits = 0;
178 if (!Val.consume_back("+")) {
179 [[maybe_unused]] bool Invalid = Val.getAsInteger(10, Bits);
180 assert(!Invalid && "Failed to parse value");
181 CmdArgs.push_back(
182 Args.MakeArgString("-mvscale-max=" + llvm::Twine(Bits / 128)));
183 }
184
185 [[maybe_unused]] bool Invalid = Val.getAsInteger(10, Bits);
186 assert(!Invalid && "Failed to parse value");
187 CmdArgs.push_back(
188 Args.MakeArgString("-mvscale-min=" + llvm::Twine(Bits / 128)));
189 // Silently drop requests for vector-length agnostic code as it's implied.
190 } else if (Val != "scalable")
191 // Handle the unsupported values passed to msve-vector-bits.
192 D.Diag(diag::err_drv_unsupported_option_argument)
193 << A->getSpelling() << Val;
194 }
195}
196
197void Flang::AddRISCVTargetArgs(const ArgList &Args,
198 ArgStringList &CmdArgs) const {
199 const llvm::Triple &Triple = getToolChain().getTriple();
200 // Handle -mrvv-vector-bits=<bits>
201 if (Arg *A = Args.getLastArg(options::OPT_mrvv_vector_bits_EQ)) {
202 StringRef Val = A->getValue();
203 const Driver &D = getToolChain().getDriver();
204
205 // Get minimum VLen from march.
206 unsigned MinVLen = 0;
207 StringRef Arch = riscv::getRISCVArch(Args, Triple);
208 auto ISAInfo = llvm::RISCVISAInfo::parseArchString(
209 Arch, /*EnableExperimentalExtensions*/ true);
210 // Ignore parsing error.
211 if (!errorToBool(ISAInfo.takeError()))
212 MinVLen = (*ISAInfo)->getMinVLen();
213
214 // If the value is "zvl", use MinVLen from march. Otherwise, try to parse
215 // as integer as long as we have a MinVLen.
216 unsigned Bits = 0;
217 if (Val == "zvl" && MinVLen >= llvm::RISCV::RVVBitsPerBlock) {
218 Bits = MinVLen;
219 } else if (!Val.getAsInteger(10, Bits)) {
220 // Only accept power of 2 values beteen RVVBitsPerBlock and 65536 that
221 // at least MinVLen.
222 if (Bits < MinVLen || Bits < llvm::RISCV::RVVBitsPerBlock ||
223 Bits > 65536 || !llvm::isPowerOf2_32(Bits))
224 Bits = 0;
225 }
226
227 // If we got a valid value try to use it.
228 if (Bits != 0) {
229 unsigned VScaleMin = Bits / llvm::RISCV::RVVBitsPerBlock;
230 CmdArgs.push_back(
231 Args.MakeArgString("-mvscale-max=" + llvm::Twine(VScaleMin)));
232 CmdArgs.push_back(
233 Args.MakeArgString("-mvscale-min=" + llvm::Twine(VScaleMin)));
234 } else if (Val != "scalable") {
235 // Handle the unsupported values passed to mrvv-vector-bits.
236 D.Diag(diag::err_drv_unsupported_option_argument)
237 << A->getSpelling() << Val;
238 }
239 }
240}
241
242void Flang::AddX86_64TargetArgs(const ArgList &Args,
243 ArgStringList &CmdArgs) const {
244 if (Arg *A = Args.getLastArg(options::OPT_masm_EQ)) {
245 StringRef Value = A->getValue();
246 if (Value == "intel" || Value == "att") {
247 CmdArgs.push_back(Args.MakeArgString("-mllvm"));
248 CmdArgs.push_back(Args.MakeArgString("-x86-asm-syntax=" + Value));
249 } else {
250 getToolChain().getDriver().Diag(diag::err_drv_unsupported_option_argument)
251 << A->getSpelling() << Value;
252 }
253 }
254}
255
256static void addVSDefines(const ToolChain &TC, const ArgList &Args,
257 ArgStringList &CmdArgs) {
258
259 unsigned ver = 0;
260 const VersionTuple vt = TC.computeMSVCVersion(nullptr, Args);
261 ver = vt.getMajor() * 10000000 + vt.getMinor().value_or(0) * 100000 +
262 vt.getSubminor().value_or(0);
263 CmdArgs.push_back(Args.MakeArgString("-D_MSC_VER=" + Twine(ver / 100000)));
264 CmdArgs.push_back(Args.MakeArgString("-D_MSC_FULL_VER=" + Twine(ver)));
265 CmdArgs.push_back(Args.MakeArgString("-D_WIN32"));
266
267 const llvm::Triple &triple = TC.getTriple();
268 if (triple.isAArch64()) {
269 CmdArgs.push_back("-D_M_ARM64=1");
270 } else if (triple.isX86() && triple.isArch32Bit()) {
271 CmdArgs.push_back("-D_M_IX86=600");
272 } else if (triple.isX86() && triple.isArch64Bit()) {
273 CmdArgs.push_back("-D_M_X64=100");
274 } else {
275 llvm_unreachable(
276 "Flang on Windows only supports X86_32, X86_64 and AArch64");
277 }
278}
279
280static void processVSRuntimeLibrary(const ToolChain &TC, const ArgList &Args,
281 ArgStringList &CmdArgs) {
282 assert(TC.getTriple().isKnownWindowsMSVCEnvironment() &&
283 "can only add VS runtime library on Windows!");
284 // if -fno-fortran-main has been passed, skip linking Fortran_main.a
285 if (TC.getTriple().isKnownWindowsMSVCEnvironment()) {
286 CmdArgs.push_back(Args.MakeArgString(
287 "--dependent-lib=" + TC.getCompilerRTBasename(Args, "builtins")));
288 }
289 unsigned RTOptionID = options::OPT__SLASH_MT;
290 if (auto *rtl = Args.getLastArg(options::OPT_fms_runtime_lib_EQ)) {
291 RTOptionID = llvm::StringSwitch<unsigned>(rtl->getValue())
292 .Case("static", options::OPT__SLASH_MT)
293 .Case("static_dbg", options::OPT__SLASH_MTd)
294 .Case("dll", options::OPT__SLASH_MD)
295 .Case("dll_dbg", options::OPT__SLASH_MDd)
296 .Default(options::OPT__SLASH_MT);
297 }
298 switch (RTOptionID) {
299 case options::OPT__SLASH_MT:
300 CmdArgs.push_back("-D_MT");
301 CmdArgs.push_back("--dependent-lib=libcmt");
302 CmdArgs.push_back("--dependent-lib=FortranRuntime.static.lib");
303 CmdArgs.push_back("--dependent-lib=FortranDecimal.static.lib");
304 break;
305 case options::OPT__SLASH_MTd:
306 CmdArgs.push_back("-D_MT");
307 CmdArgs.push_back("-D_DEBUG");
308 CmdArgs.push_back("--dependent-lib=libcmtd");
309 CmdArgs.push_back("--dependent-lib=FortranRuntime.static_dbg.lib");
310 CmdArgs.push_back("--dependent-lib=FortranDecimal.static_dbg.lib");
311 break;
312 case options::OPT__SLASH_MD:
313 CmdArgs.push_back("-D_MT");
314 CmdArgs.push_back("-D_DLL");
315 CmdArgs.push_back("--dependent-lib=msvcrt");
316 CmdArgs.push_back("--dependent-lib=FortranRuntime.dynamic.lib");
317 CmdArgs.push_back("--dependent-lib=FortranDecimal.dynamic.lib");
318 break;
319 case options::OPT__SLASH_MDd:
320 CmdArgs.push_back("-D_MT");
321 CmdArgs.push_back("-D_DEBUG");
322 CmdArgs.push_back("-D_DLL");
323 CmdArgs.push_back("--dependent-lib=msvcrtd");
324 CmdArgs.push_back("--dependent-lib=FortranRuntime.dynamic_dbg.lib");
325 CmdArgs.push_back("--dependent-lib=FortranDecimal.dynamic_dbg.lib");
326 break;
327 }
328}
329
330void Flang::AddAMDGPUTargetArgs(const ArgList &Args,
331 ArgStringList &CmdArgs) const {
332 if (Arg *A = Args.getLastArg(options::OPT_mcode_object_version_EQ)) {
333 StringRef Val = A->getValue();
334 CmdArgs.push_back(Args.MakeArgString("-mcode-object-version=" + Val));
335 }
336}
337
338void Flang::addTargetOptions(const ArgList &Args,
339 ArgStringList &CmdArgs) const {
340 const ToolChain &TC = getToolChain();
341 const llvm::Triple &Triple = TC.getEffectiveTriple();
342 const Driver &D = TC.getDriver();
343
344 std::string CPU = getCPUName(D, Args, Triple);
345 if (!CPU.empty()) {
346 CmdArgs.push_back("-target-cpu");
347 CmdArgs.push_back(Args.MakeArgString(CPU));
348 }
349
350 addOutlineAtomicsArgs(D, getToolChain(), Args, CmdArgs, Triple);
351
352 // Add the target features.
353 switch (TC.getArch()) {
354 default:
355 break;
356 case llvm::Triple::aarch64:
357 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
358 AddAArch64TargetArgs(Args, CmdArgs);
359 break;
360
361 case llvm::Triple::r600:
362 case llvm::Triple::amdgcn:
363 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
364 AddAMDGPUTargetArgs(Args, CmdArgs);
365 break;
366 case llvm::Triple::riscv64:
367 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
368 AddRISCVTargetArgs(Args, CmdArgs);
369 break;
370 case llvm::Triple::x86_64:
371 getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
372 AddX86_64TargetArgs(Args, CmdArgs);
373 break;
374 }
375
376 if (Arg *A = Args.getLastArg(options::OPT_fveclib)) {
377 StringRef Name = A->getValue();
378 if (Name == "SVML") {
379 if (Triple.getArch() != llvm::Triple::x86 &&
380 Triple.getArch() != llvm::Triple::x86_64)
381 D.Diag(diag::err_drv_unsupported_opt_for_target)
382 << Name << Triple.getArchName();
383 } else if (Name == "LIBMVEC-X86") {
384 if (Triple.getArch() != llvm::Triple::x86 &&
385 Triple.getArch() != llvm::Triple::x86_64)
386 D.Diag(diag::err_drv_unsupported_opt_for_target)
387 << Name << Triple.getArchName();
388 } else if (Name == "SLEEF" || Name == "ArmPL") {
389 if (Triple.getArch() != llvm::Triple::aarch64 &&
390 Triple.getArch() != llvm::Triple::aarch64_be)
391 D.Diag(diag::err_drv_unsupported_opt_for_target)
392 << Name << Triple.getArchName();
393 }
394
395 if (Triple.isOSDarwin()) {
396 // flang doesn't currently suport nostdlib, nodefaultlibs. Adding these
397 // here incase they are added someday
398 if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
399 if (A->getValue() == StringRef{"Accelerate"}) {
400 CmdArgs.push_back("-framework");
401 CmdArgs.push_back("Accelerate");
402 }
403 }
404 }
405 A->render(Args, CmdArgs);
406 }
407
408 if (Triple.isKnownWindowsMSVCEnvironment()) {
409 processVSRuntimeLibrary(TC, Args, CmdArgs);
410 addVSDefines(TC, Args, CmdArgs);
411 }
412
413 // TODO: Add target specific flags, ABI, mtune option etc.
414}
415
416void Flang::addOffloadOptions(Compilation &C, const InputInfoList &Inputs,
417 const JobAction &JA, const ArgList &Args,
418 ArgStringList &CmdArgs) const {
419 bool IsOpenMPDevice = JA.isDeviceOffloading(Action::OFK_OpenMP);
420 bool IsHostOffloadingAction = JA.isHostOffloading(Action::OFK_OpenMP) ||
421 JA.isHostOffloading(C.getActiveOffloadKinds());
422
423 // Skips the primary input file, which is the input file that the compilation
424 // proccess will be executed upon (e.g. the host bitcode file) and
425 // adds other secondary input (e.g. device bitcode files for embedding to the
426 // -fembed-offload-object argument or the host IR file for proccessing
427 // during device compilation to the fopenmp-host-ir-file-path argument via
428 // OpenMPDeviceInput). This is condensed logic from the ConstructJob
429 // function inside of the Clang driver for pushing on further input arguments
430 // needed for offloading during various phases of compilation.
431 for (size_t i = 1; i < Inputs.size(); ++i) {
432 if (Inputs[i].getType() == types::TY_Nothing) {
433 // contains nothing, so it's skippable
434 } else if (IsHostOffloadingAction) {
435 CmdArgs.push_back(
436 Args.MakeArgString("-fembed-offload-object=" +
437 getToolChain().getInputFilename(Inputs[i])));
438 } else if (IsOpenMPDevice) {
439 if (Inputs[i].getFilename()) {
440 CmdArgs.push_back("-fopenmp-host-ir-file-path");
441 CmdArgs.push_back(Args.MakeArgString(Inputs[i].getFilename()));
442 } else {
443 llvm_unreachable("missing openmp host-ir file for device offloading");
444 }
445 } else {
446 llvm_unreachable(
447 "unexpectedly given multiple inputs or given unknown input");
448 }
449 }
450
451 if (IsOpenMPDevice) {
452 // -fopenmp-is-target-device is passed along to tell the frontend that it is
453 // generating code for a device, so that only the relevant code is emitted.
454 CmdArgs.push_back("-fopenmp-is-target-device");
455
456 // When in OpenMP offloading mode, enable debugging on the device.
457 Args.AddAllArgs(CmdArgs, options::OPT_fopenmp_target_debug_EQ);
458 if (Args.hasFlag(options::OPT_fopenmp_target_debug,
459 options::OPT_fno_openmp_target_debug, /*Default=*/false))
460 CmdArgs.push_back("-fopenmp-target-debug");
461
462 // When in OpenMP offloading mode, forward assumptions information about
463 // thread and team counts in the device.
464 if (Args.hasFlag(options::OPT_fopenmp_assume_teams_oversubscription,
465 options::OPT_fno_openmp_assume_teams_oversubscription,
466 /*Default=*/false))
467 CmdArgs.push_back("-fopenmp-assume-teams-oversubscription");
468 if (Args.hasFlag(options::OPT_fopenmp_assume_threads_oversubscription,
469 options::OPT_fno_openmp_assume_threads_oversubscription,
470 /*Default=*/false))
471 CmdArgs.push_back("-fopenmp-assume-threads-oversubscription");
472 if (Args.hasArg(options::OPT_fopenmp_assume_no_thread_state))
473 CmdArgs.push_back("-fopenmp-assume-no-thread-state");
474 if (Args.hasArg(options::OPT_fopenmp_assume_no_nested_parallelism))
475 CmdArgs.push_back("-fopenmp-assume-no-nested-parallelism");
476 if (Args.hasArg(options::OPT_nogpulib))
477 CmdArgs.push_back("-nogpulib");
478 }
479}
480
481static void addFloatingPointOptions(const Driver &D, const ArgList &Args,
482 ArgStringList &CmdArgs) {
483 StringRef FPContract;
484 bool HonorINFs = true;
485 bool HonorNaNs = true;
486 bool ApproxFunc = false;
487 bool SignedZeros = true;
488 bool AssociativeMath = false;
489 bool ReciprocalMath = false;
490
491 if (const Arg *A = Args.getLastArg(options::OPT_ffp_contract)) {
492 const StringRef Val = A->getValue();
493 if (Val == "fast" || Val == "off") {
494 FPContract = Val;
495 } else if (Val == "on") {
496 // Warn instead of error because users might have makefiles written for
497 // gfortran (which accepts -ffp-contract=on)
498 D.Diag(diag::warn_drv_unsupported_option_for_flang)
499 << Val << A->getOption().getName() << "off";
500 FPContract = "off";
501 } else
502 // Clang's "fast-honor-pragmas" option is not supported because it is
503 // non-standard
504 D.Diag(diag::err_drv_unsupported_option_argument)
505 << A->getSpelling() << Val;
506 }
507
508 for (const Arg *A : Args) {
509 auto optId = A->getOption().getID();
510 switch (optId) {
511 // if this isn't an FP option, skip the claim below
512 default:
513 continue;
514
515 case options::OPT_fhonor_infinities:
516 HonorINFs = true;
517 break;
518 case options::OPT_fno_honor_infinities:
519 HonorINFs = false;
520 break;
521 case options::OPT_fhonor_nans:
522 HonorNaNs = true;
523 break;
524 case options::OPT_fno_honor_nans:
525 HonorNaNs = false;
526 break;
527 case options::OPT_fapprox_func:
528 ApproxFunc = true;
529 break;
530 case options::OPT_fno_approx_func:
531 ApproxFunc = false;
532 break;
533 case options::OPT_fsigned_zeros:
534 SignedZeros = true;
535 break;
536 case options::OPT_fno_signed_zeros:
537 SignedZeros = false;
538 break;
539 case options::OPT_fassociative_math:
540 AssociativeMath = true;
541 break;
542 case options::OPT_fno_associative_math:
543 AssociativeMath = false;
544 break;
545 case options::OPT_freciprocal_math:
546 ReciprocalMath = true;
547 break;
548 case options::OPT_fno_reciprocal_math:
549 ReciprocalMath = false;
550 break;
551 case options::OPT_Ofast:
552 [[fallthrough]];
553 case options::OPT_ffast_math:
554 HonorINFs = false;
555 HonorNaNs = false;
556 AssociativeMath = true;
557 ReciprocalMath = true;
558 ApproxFunc = true;
559 SignedZeros = false;
560 FPContract = "fast";
561 break;
562 case options::OPT_fno_fast_math:
563 HonorINFs = true;
564 HonorNaNs = true;
565 AssociativeMath = false;
566 ReciprocalMath = false;
567 ApproxFunc = false;
568 SignedZeros = true;
569 // -fno-fast-math should undo -ffast-math so I return FPContract to the
570 // default. It is important to check it is "fast" (the default) so that
571 // --ffp-contract=off -fno-fast-math --> -ffp-contract=off
572 if (FPContract == "fast")
573 FPContract = "";
574 break;
575 }
576
577 // If we handled this option claim it
578 A->claim();
579 }
580
581 if (!HonorINFs && !HonorNaNs && AssociativeMath && ReciprocalMath &&
582 ApproxFunc && !SignedZeros &&
583 (FPContract == "fast" || FPContract.empty())) {
584 CmdArgs.push_back("-ffast-math");
585 return;
586 }
587
588 if (!FPContract.empty())
589 CmdArgs.push_back(Args.MakeArgString("-ffp-contract=" + FPContract));
590
591 if (!HonorINFs)
592 CmdArgs.push_back("-menable-no-infs");
593
594 if (!HonorNaNs)
595 CmdArgs.push_back("-menable-no-nans");
596
597 if (ApproxFunc)
598 CmdArgs.push_back("-fapprox-func");
599
600 if (!SignedZeros)
601 CmdArgs.push_back("-fno-signed-zeros");
602
603 if (AssociativeMath && !SignedZeros)
604 CmdArgs.push_back("-mreassociate");
605
606 if (ReciprocalMath)
607 CmdArgs.push_back("-freciprocal-math");
608}
609
610static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs,
611 const InputInfo &Input) {
612 StringRef Format = "yaml";
613 if (const Arg *A = Args.getLastArg(options::OPT_fsave_optimization_record_EQ))
614 Format = A->getValue();
615
616 CmdArgs.push_back("-opt-record-file");
617
618 const Arg *A = Args.getLastArg(options::OPT_foptimization_record_file_EQ);
619 if (A) {
620 CmdArgs.push_back(A->getValue());
621 } else {
623
624 if (Args.hasArg(options::OPT_c) || Args.hasArg(options::OPT_S)) {
625 if (Arg *FinalOutput = Args.getLastArg(options::OPT_o))
626 F = FinalOutput->getValue();
627 }
628
629 if (F.empty()) {
630 // Use the input filename.
631 F = llvm::sys::path::stem(Input.getBaseInput());
632 }
633
634 SmallString<32> Extension;
635 Extension += "opt.";
636 Extension += Format;
637
638 llvm::sys::path::replace_extension(F, Extension);
639 CmdArgs.push_back(Args.MakeArgString(F));
640 }
641
642 if (const Arg *A =
643 Args.getLastArg(options::OPT_foptimization_record_passes_EQ)) {
644 CmdArgs.push_back("-opt-record-passes");
645 CmdArgs.push_back(A->getValue());
646 }
647
648 if (!Format.empty()) {
649 CmdArgs.push_back("-opt-record-format");
650 CmdArgs.push_back(Format.data());
651 }
652}
653
655 const InputInfo &Output, const InputInfoList &Inputs,
656 const ArgList &Args, const char *LinkingOutput) const {
657 const auto &TC = getToolChain();
658 const llvm::Triple &Triple = TC.getEffectiveTriple();
659 const std::string &TripleStr = Triple.getTriple();
660
661 const Driver &D = TC.getDriver();
662 ArgStringList CmdArgs;
663 DiagnosticsEngine &Diags = D.getDiags();
664
665 // Invoke ourselves in -fc1 mode.
666 CmdArgs.push_back("-fc1");
667
668 // Add the "effective" target triple.
669 CmdArgs.push_back("-triple");
670 CmdArgs.push_back(Args.MakeArgString(TripleStr));
671
672 if (isa<PreprocessJobAction>(JA)) {
673 CmdArgs.push_back("-E");
674 if (Args.getLastArg(options::OPT_dM)) {
675 CmdArgs.push_back("-dM");
676 }
677 } else if (isa<CompileJobAction>(JA) || isa<BackendJobAction>(JA)) {
678 if (JA.getType() == types::TY_Nothing) {
679 CmdArgs.push_back("-fsyntax-only");
680 } else if (JA.getType() == types::TY_AST) {
681 CmdArgs.push_back("-emit-ast");
682 } else if (JA.getType() == types::TY_LLVM_IR ||
683 JA.getType() == types::TY_LTO_IR) {
684 CmdArgs.push_back("-emit-llvm");
685 } else if (JA.getType() == types::TY_LLVM_BC ||
686 JA.getType() == types::TY_LTO_BC) {
687 CmdArgs.push_back("-emit-llvm-bc");
688 } else if (JA.getType() == types::TY_PP_Asm) {
689 CmdArgs.push_back("-S");
690 } else {
691 assert(false && "Unexpected output type!");
692 }
693 } else if (isa<AssembleJobAction>(JA)) {
694 CmdArgs.push_back("-emit-obj");
695 } else {
696 assert(false && "Unexpected action class for Flang tool.");
697 }
698
699 const InputInfo &Input = Inputs[0];
700 types::ID InputType = Input.getType();
701
702 // Add preprocessing options like -I, -D, etc. if we are using the
703 // preprocessor (i.e. skip when dealing with e.g. binary files).
705 addPreprocessingOptions(Args, CmdArgs);
706
707 addFortranDialectOptions(Args, CmdArgs);
708
709 // Color diagnostics are parsed by the driver directly from argv and later
710 // re-parsed to construct this job; claim any possible color diagnostic here
711 // to avoid warn_drv_unused_argument.
712 Args.getLastArg(options::OPT_fcolor_diagnostics,
713 options::OPT_fno_color_diagnostics);
714 if (Diags.getDiagnosticOptions().ShowColors)
715 CmdArgs.push_back("-fcolor-diagnostics");
716
717 // LTO mode is parsed by the Clang driver library.
718 LTOKind LTOMode = D.getLTOMode(/* IsOffload */ false);
719 assert(LTOMode != LTOK_Unknown && "Unknown LTO mode.");
720 if (LTOMode == LTOK_Full)
721 CmdArgs.push_back("-flto=full");
722 else if (LTOMode == LTOK_Thin) {
723 Diags.Report(
725 "the option '-flto=thin' is a work in progress"));
726 CmdArgs.push_back("-flto=thin");
727 }
728
729 // -fPIC and related options.
730 addPicOptions(Args, CmdArgs);
731
732 // Floating point related options
733 addFloatingPointOptions(D, Args, CmdArgs);
734
735 // Add target args, features, etc.
736 addTargetOptions(Args, CmdArgs);
737
738 // Add Codegen options
739 addCodegenOptions(Args, CmdArgs);
740
741 // Add R Group options
742 Args.AddAllArgs(CmdArgs, options::OPT_R_Group);
743
744 // Remarks can be enabled with any of the `-f.*optimization-record.*` flags.
745 if (willEmitRemarks(Args))
746 renderRemarksOptions(Args, CmdArgs, Input);
747
748 // Add other compile options
749 addOtherOptions(Args, CmdArgs);
750
751 // Disable all warnings
752 // TODO: Handle interactions between -w, -pedantic, -Wall, -WOption
753 Args.AddLastArg(CmdArgs, options::OPT_w);
754
755 // Forward flags for OpenMP. We don't do this if the current action is an
756 // device offloading action other than OpenMP.
757 if (Args.hasFlag(options::OPT_fopenmp, options::OPT_fopenmp_EQ,
758 options::OPT_fno_openmp, false) &&
761 switch (D.getOpenMPRuntime(Args)) {
764 // Clang can generate useful OpenMP code for these two runtime libraries.
765 CmdArgs.push_back("-fopenmp");
766 Args.AddAllArgs(CmdArgs, options::OPT_fopenmp_version_EQ);
767
768 // FIXME: Clang supports a whole bunch more flags here.
769 break;
770 default:
771 // By default, if Clang doesn't know how to generate useful OpenMP code
772 // for a specific runtime library, we just don't pass the '-fopenmp' flag
773 // down to the actual compilation.
774 // FIXME: It would be better to have a mode which *only* omits IR
775 // generation based on the OpenMP support so that we get consistent
776 // semantic analysis, etc.
777 const Arg *A = Args.getLastArg(options::OPT_fopenmp_EQ);
778 D.Diag(diag::warn_drv_unsupported_openmp_library)
779 << A->getSpelling() << A->getValue();
780 break;
781 }
782 }
783
784 // Pass the path to compiler resource files.
785 CmdArgs.push_back("-resource-dir");
786 CmdArgs.push_back(D.ResourceDir.c_str());
787
788 // Offloading related options
789 addOffloadOptions(C, Inputs, JA, Args, CmdArgs);
790
791 // Forward -Xflang arguments to -fc1
792 Args.AddAllArgValues(CmdArgs, options::OPT_Xflang);
793
795 getFramePointerKind(Args, Triple);
796
797 const char *FPKeepKindStr = nullptr;
798 switch (FPKeepKind) {
800 FPKeepKindStr = "-mframe-pointer=none";
801 break;
803 FPKeepKindStr = "-mframe-pointer=non-leaf";
804 break;
806 FPKeepKindStr = "-mframe-pointer=all";
807 break;
808 }
809 assert(FPKeepKindStr && "unknown FramePointerKind");
810 CmdArgs.push_back(FPKeepKindStr);
811
812 // Forward -mllvm options to the LLVM option parser. In practice, this means
813 // forwarding to `-fc1` as that's where the LLVM parser is run.
814 for (const Arg *A : Args.filtered(options::OPT_mllvm)) {
815 A->claim();
816 A->render(Args, CmdArgs);
817 }
818
819 for (const Arg *A : Args.filtered(options::OPT_mmlir)) {
820 A->claim();
821 A->render(Args, CmdArgs);
822 }
823
824 // Remove any unsupported gfortran diagnostic options
825 for (const Arg *A : Args.filtered(options::OPT_flang_ignored_w_Group)) {
826 A->claim();
827 D.Diag(diag::warn_drv_unsupported_diag_option_for_flang)
828 << A->getOption().getName();
829 }
830
831 // Optimization level for CodeGen.
832 if (const Arg *A = Args.getLastArg(options::OPT_O_Group)) {
833 if (A->getOption().matches(options::OPT_O4)) {
834 CmdArgs.push_back("-O3");
835 D.Diag(diag::warn_O4_is_O3);
836 } else if (A->getOption().matches(options::OPT_Ofast)) {
837 CmdArgs.push_back("-O3");
838 } else {
839 A->render(Args, CmdArgs);
840 }
841 }
842
843 assert((Output.isFilename() || Output.isNothing()) && "Invalid output.");
844 if (Output.isFilename()) {
845 CmdArgs.push_back("-o");
846 CmdArgs.push_back(Output.getFilename());
847 }
848
849 assert(Input.isFilename() && "Invalid input.");
850
851 if (Args.getLastArg(options::OPT_save_temps_EQ))
852 Args.AddLastArg(CmdArgs, options::OPT_save_temps_EQ);
853
854 addDashXForInput(Args, Input, CmdArgs);
855
856 CmdArgs.push_back(Input.getFilename());
857
858 // TODO: Replace flang-new with flang once the new driver replaces the
859 // throwaway driver
860 const char *Exec = Args.MakeArgString(D.GetProgramPath("flang-new", TC));
861 C.addCommand(std::make_unique<Command>(JA, *this,
863 Exec, CmdArgs, Inputs, Output));
864}
865
866Flang::Flang(const ToolChain &TC) : Tool("flang-new", "flang frontend", TC) {}
867
static void addDashXForInput(const ArgList &Args, const InputInfo &Input, ArgStringList &CmdArgs)
Add -x lang to CmdArgs for Input.
Definition: Clang.cpp:555
static void renderRemarksOptions(const ArgList &Args, ArgStringList &CmdArgs, const llvm::Triple &Triple, const InputInfo &Input, const InputInfo &Output, const JobAction &JA)
Definition: Clang.cpp:1364
clang::CodeGenOptions::FramePointerKind getFramePointerKind(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
Definition: CommonArgs.cpp:180
static void processVSRuntimeLibrary(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs)
Definition: Flang.cpp:280
static void addVSDefines(const ToolChain &TC, const ArgList &Args, ArgStringList &CmdArgs)
Definition: Flang.cpp:256
static bool shouldLoopVersion(const ArgList &Args)
@C shouldLoopVersion
Definition: Flang.cpp:76
static void addDashXForInput(const ArgList &Args, const InputInfo &Input, ArgStringList &CmdArgs)
Add -x lang to CmdArgs for Input.
Definition: Flang.cpp:29
static void addFloatingPointOptions(const Driver &D, const ArgList &Args, ArgStringList &CmdArgs)
Definition: Flang.cpp:481
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:192
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1547
unsigned getCustomDiagID(Level L, const char(&FormatString)[N])
Return an ID for a diagnostic with the specified format string and level.
Definition: Diagnostic.h:873
DiagnosticOptions & getDiagnosticOptions() const
Retrieve the diagnostic options.
Definition: Diagnostic.h:562
types::ID getType() const
Definition: Action.h:148
bool isHostOffloading(unsigned int OKind) const
Check if this action have any offload kinds.
Definition: Action.h:218
bool isDeviceOffloading(OffloadKind OKind) const
Definition: Action.h:221
Compilation - A set of tasks to perform for a single driver invocation.
Definition: Compilation.h:45
Driver - Encapsulate logic for constructing compilation processes from a set of gcc-driver-like comma...
Definition: Driver.h:77
DiagnosticsEngine & getDiags() const
Definition: Driver.h:401
OpenMPRuntimeKind getOpenMPRuntime(const llvm::opt::ArgList &Args) const
Compute the desired OpenMP runtime from the flags provided.
Definition: Driver.cpp:751
DiagnosticBuilder Diag(unsigned DiagID) const
Definition: Driver.h:144
LTOKind getLTOMode(bool IsOffload=false) const
Get the specific kind of LTO being performed.
Definition: Driver.h:722
std::string GetProgramPath(StringRef Name, const ToolChain &TC) const
GetProgramPath - Lookup Name in the list of program search paths.
Definition: Driver.cpp:6190
std::string ResourceDir
The path to the compiler resource directory.
Definition: Driver.h:164
@ OMPRT_IOMP5
The legacy name for the LLVM OpenMP runtime from when it was the Intel OpenMP runtime.
Definition: Driver.h:140
@ OMPRT_OMP
The LLVM OpenMP runtime.
Definition: Driver.h:130
InputInfo - Wrapper for information about an input source.
Definition: InputInfo.h:22
const char * getBaseInput() const
Definition: InputInfo.h:78
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:92
llvm::Triple::ArchType getArch() const
Definition: ToolChain.h:268
const Driver & getDriver() const
Definition: ToolChain.h:252
const llvm::Triple & getEffectiveTriple() const
Get the toolchain's effective clang triple.
Definition: ToolChain.h:282
const llvm::Triple & getTriple() const
Definition: ToolChain.h:254
virtual VersionTuple computeMSVCVersion(const Driver *D, const llvm::opt::ArgList &Args) const
On Windows, returns the MSVC compatibility version.
Definition: ToolChain.cpp:1413
std::string getCompilerRTBasename(const llvm::opt::ArgList &Args, StringRef Component, FileType Type=ToolChain::FT_Static) const
Definition: ToolChain.cpp:632
Tool - Information on a specific compilation tool.
Definition: Tool.h:32
const ToolChain & getToolChain() const
Definition: Tool.h:52
Flang(const ToolChain &TC)
Definition: Flang.cpp:866
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:654
StringRef getRISCVArch(const llvm::opt::ArgList &Args, const llvm::Triple &Triple)
Definition: RISCV.cpp:251
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 getCPUName(const Driver &D, const llvm::opt::ArgList &Args, const llvm::Triple &T, bool FromAs=false)
void addDebugInfoKind(llvm::opt::ArgStringList &CmdArgs, llvm::codegenoptions::DebugInfoKind DebugInfoKind)
llvm::codegenoptions::DebugInfoKind debugLevelToInfoKind(const llvm::opt::Arg &A)
std::tuple< llvm::Reloc::Model, unsigned, bool > ParsePICArgs(const ToolChain &ToolChain, const llvm::opt::ArgList &Args)
const char * RelocationModelName(llvm::Reloc::Model Model)
ID getPreprocessedType(ID Id)
getPreprocessedType - Get the ID of the type for this input when it has been preprocessed,...
Definition: Types.cpp:56
const char * getTypeName(ID Id)
getTypeName - Return the name of the type for Id.
Definition: Types.cpp:52
LTOKind
Describes the kind of LTO mode selected via -f(no-)?lto(=.*)? options.
Definition: Driver.h:58
@ LTOK_Unknown
Definition: Driver.h:62
bool willEmitRemarks(const llvm::opt::ArgList &Args)
The JSON file list parser is used to communicate input to InstallAPI.
static constexpr ResponseFileSupport AtFileUTF8()
Definition: Job.h:85