/
Flang.cpp
541 lines (469 loc) · 19 KB
/
Flang.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
//===-- Flang.cpp - Flang+LLVM ToolChain Implementations --------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "Flang.h"
#include "CommonArgs.h"
#include "clang/Driver/Options.h"
#include "llvm/Frontend/Debug/Options.h"
#include <cassert>
using namespace clang::driver;
using namespace clang::driver::tools;
using namespace clang;
using namespace llvm::opt;
/// Add -x lang to \p CmdArgs for \p Input.
static void addDashXForInput(const ArgList &Args, const InputInfo &Input,
ArgStringList &CmdArgs) {
CmdArgs.push_back("-x");
// Map the driver type to the frontend type.
CmdArgs.push_back(types::getTypeName(Input.getType()));
}
void Flang::addFortranDialectOptions(const ArgList &Args,
ArgStringList &CmdArgs) const {
Args.AddAllArgs(CmdArgs, {options::OPT_ffixed_form,
options::OPT_ffree_form,
options::OPT_ffixed_line_length_EQ,
options::OPT_fopenmp,
options::OPT_fopenmp_version_EQ,
options::OPT_fopenacc,
options::OPT_finput_charset_EQ,
options::OPT_fimplicit_none,
options::OPT_fno_implicit_none,
options::OPT_fbackslash,
options::OPT_fno_backslash,
options::OPT_flogical_abbreviations,
options::OPT_fno_logical_abbreviations,
options::OPT_fxor_operator,
options::OPT_fno_xor_operator,
options::OPT_falternative_parameter_statement,
options::OPT_fdefault_real_8,
options::OPT_fdefault_integer_8,
options::OPT_fdefault_double_8,
options::OPT_flarge_sizes,
options::OPT_fno_automatic});
}
void Flang::addPreprocessingOptions(const ArgList &Args,
ArgStringList &CmdArgs) const {
Args.AddAllArgs(CmdArgs,
{options::OPT_P, options::OPT_D, options::OPT_U,
options::OPT_I, options::OPT_cpp, options::OPT_nocpp});
}
/// @C shouldLoopVersion
///
/// Check if Loop Versioning should be enabled.
/// We look for the last of one of the following:
/// -Ofast, -O4, -O<number> and -f[no-]version-loops-for-stride.
/// Loop versioning is disabled if the last option is
/// -fno-version-loops-for-stride.
/// Loop versioning is enabled if the last option is one of:
/// -floop-versioning
/// -Ofast
/// -O4
/// -O3
/// For all other cases, loop versioning is is disabled.
///
/// The gfortran compiler automatically enables the option for -O3 or -Ofast.
///
/// @return true if loop-versioning should be enabled, otherwise false.
static bool shouldLoopVersion(const ArgList &Args) {
const Arg *LoopVersioningArg = Args.getLastArg(
options::OPT_Ofast, options::OPT_O, options::OPT_O4,
options::OPT_floop_versioning, options::OPT_fno_loop_versioning);
if (!LoopVersioningArg)
return false;
if (LoopVersioningArg->getOption().matches(options::OPT_fno_loop_versioning))
return false;
if (LoopVersioningArg->getOption().matches(options::OPT_floop_versioning))
return true;
if (LoopVersioningArg->getOption().matches(options::OPT_Ofast) ||
LoopVersioningArg->getOption().matches(options::OPT_O4))
return true;
if (LoopVersioningArg->getOption().matches(options::OPT_O)) {
StringRef S(LoopVersioningArg->getValue());
unsigned OptLevel = 0;
// Note -Os or Oz woould "fail" here, so return false. Which is the
// desiered behavior.
if (S.getAsInteger(10, OptLevel))
return false;
return OptLevel > 2;
}
llvm_unreachable("We should not end up here");
return false;
}
void Flang::addOtherOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
Args.AddAllArgs(CmdArgs,
{options::OPT_module_dir, options::OPT_fdebug_module_writer,
options::OPT_fintrinsic_modules_path, options::OPT_pedantic,
options::OPT_std_EQ, options::OPT_W_Joined,
options::OPT_fconvert_EQ, options::OPT_fpass_plugin_EQ,
options::OPT_funderscoring, options::OPT_fno_underscoring});
llvm::codegenoptions::DebugInfoKind DebugInfoKind;
if (Args.hasArg(options::OPT_gN_Group)) {
Arg *gNArg = Args.getLastArg(options::OPT_gN_Group);
DebugInfoKind = debugLevelToInfoKind(*gNArg);
} else if (Args.hasArg(options::OPT_g_Flag)) {
DebugInfoKind = llvm::codegenoptions::DebugLineTablesOnly;
} else {
DebugInfoKind = llvm::codegenoptions::NoDebugInfo;
}
addDebugInfoKind(CmdArgs, DebugInfoKind);
}
void Flang::addCodegenOptions(const ArgList &Args,
ArgStringList &CmdArgs) const {
Arg *stackArrays =
Args.getLastArg(options::OPT_Ofast, options::OPT_fstack_arrays,
options::OPT_fno_stack_arrays);
if (stackArrays &&
!stackArrays->getOption().matches(options::OPT_fno_stack_arrays))
CmdArgs.push_back("-fstack-arrays");
if (Args.hasArg(options::OPT_flang_experimental_hlfir))
CmdArgs.push_back("-flang-experimental-hlfir");
if (Args.hasArg(options::OPT_flang_experimental_polymorphism))
CmdArgs.push_back("-flang-experimental-polymorphism");
if (shouldLoopVersion(Args))
CmdArgs.push_back("-fversion-loops-for-stride");
}
void Flang::addPicOptions(const ArgList &Args, ArgStringList &CmdArgs) const {
// ParsePICArgs parses -fPIC/-fPIE and their variants and returns a tuple of
// (RelocationModel, PICLevel, IsPIE).
llvm::Reloc::Model RelocationModel;
unsigned PICLevel;
bool IsPIE;
std::tie(RelocationModel, PICLevel, IsPIE) =
ParsePICArgs(getToolChain(), Args);
if (auto *RMName = RelocationModelName(RelocationModel)) {
CmdArgs.push_back("-mrelocation-model");
CmdArgs.push_back(RMName);
}
if (PICLevel > 0) {
CmdArgs.push_back("-pic-level");
CmdArgs.push_back(PICLevel == 1 ? "1" : "2");
if (IsPIE)
CmdArgs.push_back("-pic-is-pie");
}
}
void Flang::addTargetOptions(const ArgList &Args,
ArgStringList &CmdArgs) const {
const ToolChain &TC = getToolChain();
const llvm::Triple &Triple = TC.getEffectiveTriple();
const Driver &D = TC.getDriver();
std::string CPU = getCPUName(D, Args, Triple);
if (!CPU.empty()) {
CmdArgs.push_back("-target-cpu");
CmdArgs.push_back(Args.MakeArgString(CPU));
}
// Add the target features.
switch (TC.getArch()) {
default:
break;
case llvm::Triple::r600:
case llvm::Triple::amdgcn:
case llvm::Triple::aarch64:
case llvm::Triple::riscv64:
case llvm::Triple::x86_64:
getTargetFeatures(D, Triple, Args, CmdArgs, /*ForAs*/ false);
break;
}
// TODO: Add target specific flags, ABI, mtune option etc.
}
void Flang::addOffloadOptions(Compilation &C, const InputInfoList &Inputs,
const JobAction &JA, const ArgList &Args,
ArgStringList &CmdArgs) const {
bool IsOpenMPDevice = JA.isDeviceOffloading(Action::OFK_OpenMP);
bool IsHostOffloadingAction = JA.isHostOffloading(Action::OFK_OpenMP) ||
JA.isHostOffloading(C.getActiveOffloadKinds());
// Skips the primary input file, which is the input file that the compilation
// proccess will be executed upon (e.g. the host bitcode file) and
// adds other secondary input (e.g. device bitcode files for embedding to the
// -fembed-offload-object argument or the host IR file for proccessing
// during device compilation to the fopenmp-host-ir-file-path argument via
// OpenMPDeviceInput). This is condensed logic from the ConstructJob
// function inside of the Clang driver for pushing on further input arguments
// needed for offloading during various phases of compilation.
for (size_t i = 1; i < Inputs.size(); ++i) {
if (Inputs[i].getType() == types::TY_Nothing) {
// contains nothing, so it's skippable
} else if (IsHostOffloadingAction) {
CmdArgs.push_back(
Args.MakeArgString("-fembed-offload-object=" +
getToolChain().getInputFilename(Inputs[i])));
} else if (IsOpenMPDevice) {
if (Inputs[i].getFilename()) {
CmdArgs.push_back("-fopenmp-host-ir-file-path");
CmdArgs.push_back(Args.MakeArgString(Inputs[i].getFilename()));
} else {
llvm_unreachable("missing openmp host-ir file for device offloading");
}
} else {
llvm_unreachable(
"unexpectedly given multiple inputs or given unknown input");
}
}
if (IsOpenMPDevice) {
// -fopenmp-is-device is passed along to tell the frontend that it is
// generating code for a device, so that only the relevant code is
// emitted.
CmdArgs.push_back("-fopenmp-is-device");
// When in OpenMP offloading mode, enable debugging on the device.
Args.AddAllArgs(CmdArgs, options::OPT_fopenmp_target_debug_EQ);
if (Args.hasFlag(options::OPT_fopenmp_target_debug,
options::OPT_fno_openmp_target_debug, /*Default=*/false))
CmdArgs.push_back("-fopenmp-target-debug");
// When in OpenMP offloading mode, forward assumptions information about
// thread and team counts in the device.
if (Args.hasFlag(options::OPT_fopenmp_assume_teams_oversubscription,
options::OPT_fno_openmp_assume_teams_oversubscription,
/*Default=*/false))
CmdArgs.push_back("-fopenmp-assume-teams-oversubscription");
if (Args.hasFlag(options::OPT_fopenmp_assume_threads_oversubscription,
options::OPT_fno_openmp_assume_threads_oversubscription,
/*Default=*/false))
CmdArgs.push_back("-fopenmp-assume-threads-oversubscription");
if (Args.hasArg(options::OPT_fopenmp_assume_no_thread_state))
CmdArgs.push_back("-fopenmp-assume-no-thread-state");
if (Args.hasArg(options::OPT_fopenmp_assume_no_nested_parallelism))
CmdArgs.push_back("-fopenmp-assume-no-nested-parallelism");
}
}
static void addFloatingPointOptions(const Driver &D, const ArgList &Args,
ArgStringList &CmdArgs) {
StringRef FPContract;
bool HonorINFs = true;
bool HonorNaNs = true;
bool ApproxFunc = false;
bool SignedZeros = true;
bool AssociativeMath = false;
bool ReciprocalMath = false;
if (const Arg *A = Args.getLastArg(options::OPT_ffp_contract)) {
const StringRef Val = A->getValue();
if (Val == "fast" || Val == "off") {
FPContract = Val;
} else if (Val == "on") {
// Warn instead of error because users might have makefiles written for
// gfortran (which accepts -ffp-contract=on)
D.Diag(diag::warn_drv_unsupported_option_for_flang)
<< Val << A->getOption().getName() << "off";
FPContract = "off";
} else
// Clang's "fast-honor-pragmas" option is not supported because it is
// non-standard
D.Diag(diag::err_drv_unsupported_option_argument)
<< A->getSpelling() << Val;
}
for (const Arg *A : Args) {
auto optId = A->getOption().getID();
switch (optId) {
// if this isn't an FP option, skip the claim below
default:
continue;
case options::OPT_fhonor_infinities:
HonorINFs = true;
break;
case options::OPT_fno_honor_infinities:
HonorINFs = false;
break;
case options::OPT_fhonor_nans:
HonorNaNs = true;
break;
case options::OPT_fno_honor_nans:
HonorNaNs = false;
break;
case options::OPT_fapprox_func:
ApproxFunc = true;
break;
case options::OPT_fno_approx_func:
ApproxFunc = false;
break;
case options::OPT_fsigned_zeros:
SignedZeros = true;
break;
case options::OPT_fno_signed_zeros:
SignedZeros = false;
break;
case options::OPT_fassociative_math:
AssociativeMath = true;
break;
case options::OPT_fno_associative_math:
AssociativeMath = false;
break;
case options::OPT_freciprocal_math:
ReciprocalMath = true;
break;
case options::OPT_fno_reciprocal_math:
ReciprocalMath = false;
break;
case options::OPT_Ofast:
[[fallthrough]];
case options::OPT_ffast_math:
HonorINFs = false;
HonorNaNs = false;
AssociativeMath = true;
ReciprocalMath = true;
ApproxFunc = true;
SignedZeros = false;
FPContract = "fast";
break;
case options::OPT_fno_fast_math:
HonorINFs = true;
HonorNaNs = true;
AssociativeMath = false;
ReciprocalMath = false;
ApproxFunc = false;
SignedZeros = true;
// -fno-fast-math should undo -ffast-math so I return FPContract to the
// default. It is important to check it is "fast" (the default) so that
// --ffp-contract=off -fno-fast-math --> -ffp-contract=off
if (FPContract == "fast")
FPContract = "";
break;
}
// If we handled this option claim it
A->claim();
}
if (!HonorINFs && !HonorNaNs && AssociativeMath && ReciprocalMath &&
ApproxFunc && !SignedZeros &&
(FPContract == "fast" || FPContract == "")) {
CmdArgs.push_back("-ffast-math");
return;
}
if (!FPContract.empty())
CmdArgs.push_back(Args.MakeArgString("-ffp-contract=" + FPContract));
if (!HonorINFs)
CmdArgs.push_back("-menable-no-infs");
if (!HonorNaNs)
CmdArgs.push_back("-menable-no-nans");
if (ApproxFunc)
CmdArgs.push_back("-fapprox-func");
if (!SignedZeros)
CmdArgs.push_back("-fno-signed-zeros");
if (AssociativeMath && !SignedZeros)
CmdArgs.push_back("-mreassociate");
if (ReciprocalMath)
CmdArgs.push_back("-freciprocal-math");
}
void Flang::ConstructJob(Compilation &C, const JobAction &JA,
const InputInfo &Output, const InputInfoList &Inputs,
const ArgList &Args, const char *LinkingOutput) const {
const auto &TC = getToolChain();
const llvm::Triple &Triple = TC.getEffectiveTriple();
const std::string &TripleStr = Triple.getTriple();
const Driver &D = TC.getDriver();
ArgStringList CmdArgs;
DiagnosticsEngine &Diags = D.getDiags();
// Invoke ourselves in -fc1 mode.
CmdArgs.push_back("-fc1");
// Add the "effective" target triple.
CmdArgs.push_back("-triple");
CmdArgs.push_back(Args.MakeArgString(TripleStr));
if (isa<PreprocessJobAction>(JA)) {
CmdArgs.push_back("-E");
} else if (isa<CompileJobAction>(JA) || isa<BackendJobAction>(JA)) {
if (JA.getType() == types::TY_Nothing) {
CmdArgs.push_back("-fsyntax-only");
} else if (JA.getType() == types::TY_AST) {
CmdArgs.push_back("-emit-ast");
} else if (JA.getType() == types::TY_LLVM_IR ||
JA.getType() == types::TY_LTO_IR) {
CmdArgs.push_back("-emit-llvm");
} else if (JA.getType() == types::TY_LLVM_BC ||
JA.getType() == types::TY_LTO_BC) {
CmdArgs.push_back("-emit-llvm-bc");
} else if (JA.getType() == types::TY_PP_Asm) {
CmdArgs.push_back("-S");
} else {
assert(false && "Unexpected output type!");
}
} else if (isa<AssembleJobAction>(JA)) {
CmdArgs.push_back("-emit-obj");
} else {
assert(false && "Unexpected action class for Flang tool.");
}
const InputInfo &Input = Inputs[0];
types::ID InputType = Input.getType();
// Add preprocessing options like -I, -D, etc. if we are using the
// preprocessor (i.e. skip when dealing with e.g. binary files).
if (types::getPreprocessedType(InputType) != types::TY_INVALID)
addPreprocessingOptions(Args, CmdArgs);
addFortranDialectOptions(Args, CmdArgs);
// Color diagnostics are parsed by the driver directly from argv and later
// re-parsed to construct this job; claim any possible color diagnostic here
// to avoid warn_drv_unused_argument.
Args.getLastArg(options::OPT_fcolor_diagnostics,
options::OPT_fno_color_diagnostics);
if (Diags.getDiagnosticOptions().ShowColors)
CmdArgs.push_back("-fcolor-diagnostics");
// LTO mode is parsed by the Clang driver library.
LTOKind LTOMode = D.getLTOMode(/* IsOffload */ false);
assert(LTOMode != LTOK_Unknown && "Unknown LTO mode.");
if (LTOMode == LTOK_Full)
CmdArgs.push_back("-flto=full");
else if (LTOMode == LTOK_Thin) {
Diags.Report(
Diags.getCustomDiagID(DiagnosticsEngine::Warning,
"the option '-flto=thin' is a work in progress"));
CmdArgs.push_back("-flto=thin");
}
// -fPIC and related options.
addPicOptions(Args, CmdArgs);
// Floating point related options
addFloatingPointOptions(D, Args, CmdArgs);
// Add target args, features, etc.
addTargetOptions(Args, CmdArgs);
// Add Codegen options
addCodegenOptions(Args, CmdArgs);
// Add other compile options
addOtherOptions(Args, CmdArgs);
// Offloading related options
addOffloadOptions(C, Inputs, JA, Args, CmdArgs);
// Forward -Xflang arguments to -fc1
Args.AddAllArgValues(CmdArgs, options::OPT_Xflang);
// Forward -mllvm options to the LLVM option parser. In practice, this means
// forwarding to `-fc1` as that's where the LLVM parser is run.
for (const Arg *A : Args.filtered(options::OPT_mllvm)) {
A->claim();
A->render(Args, CmdArgs);
}
for (const Arg *A : Args.filtered(options::OPT_mmlir)) {
A->claim();
A->render(Args, CmdArgs);
}
// Remove any unsupported gfortran diagnostic options
for (const Arg *A : Args.filtered(options::OPT_flang_ignored_w_Group)) {
A->claim();
D.Diag(diag::warn_drv_unsupported_diag_option_for_flang)
<< A->getOption().getName();
}
// Optimization level for CodeGen.
if (const Arg *A = Args.getLastArg(options::OPT_O_Group)) {
if (A->getOption().matches(options::OPT_O4)) {
CmdArgs.push_back("-O3");
D.Diag(diag::warn_O4_is_O3);
} else if (A->getOption().matches(options::OPT_Ofast)) {
CmdArgs.push_back("-O3");
} else {
A->render(Args, CmdArgs);
}
}
if (Output.isFilename()) {
CmdArgs.push_back("-o");
CmdArgs.push_back(Output.getFilename());
} else {
assert(Output.isNothing() && "Invalid output.");
}
assert(Input.isFilename() && "Invalid input.");
if (Args.getLastArg(options::OPT_save_temps_EQ))
Args.AddLastArg(CmdArgs, options::OPT_save_temps_EQ);
addDashXForInput(Args, Input, CmdArgs);
CmdArgs.push_back(Input.getFilename());
// TODO: Replace flang-new with flang once the new driver replaces the
// throwaway driver
const char *Exec = Args.MakeArgString(D.GetProgramPath("flang-new", TC));
C.addCommand(std::make_unique<Command>(JA, *this,
ResponseFileSupport::AtFileUTF8(),
Exec, CmdArgs, Inputs, Output));
}
Flang::Flang(const ToolChain &TC) : Tool("flang-new", "flang frontend", TC) {}
Flang::~Flang() {}