xref: /llvm-project/flang/lib/Frontend/CompilerInvocation.cpp (revision 737c414e1d9578e5037e68e3b3f6ddea507f8243) 
1 //===- CompilerInvocation.cpp ---------------------------------------------===//
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 // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "flang/Frontend/CompilerInvocation.h"
14 #include "flang/Common/Fortran-features.h"
15 #include "flang/Common/OpenMP-features.h"
16 #include "flang/Common/Version.h"
17 #include "flang/Frontend/CodeGenOptions.h"
18 #include "flang/Frontend/PreprocessorOptions.h"
19 #include "flang/Frontend/TargetOptions.h"
20 #include "flang/Semantics/semantics.h"
21 #include "flang/Tools/TargetSetup.h"
22 #include "flang/Version.inc"
23 #include "clang/Basic/AllDiagnostics.h"
24 #include "clang/Basic/DiagnosticDriver.h"
25 #include "clang/Basic/DiagnosticOptions.h"
26 #include "clang/Driver/DriverDiagnostic.h"
27 #include "clang/Driver/OptionUtils.h"
28 #include "clang/Driver/Options.h"
29 #include "llvm/ADT/StringRef.h"
30 #include "llvm/ADT/StringSwitch.h"
31 #include "llvm/Frontend/Debug/Options.h"
32 #include "llvm/Option/Arg.h"
33 #include "llvm/Option/ArgList.h"
34 #include "llvm/Option/OptTable.h"
35 #include "llvm/Support/CodeGen.h"
36 #include "llvm/Support/FileSystem.h"
37 #include "llvm/Support/FileUtilities.h"
38 #include "llvm/Support/Path.h"
39 #include "llvm/Support/Process.h"
40 #include "llvm/Support/raw_ostream.h"
41 #include "llvm/TargetParser/Host.h"
42 #include "llvm/TargetParser/Triple.h"
43 #include <cstdlib>
44 #include <memory>
45 #include <optional>
46 
47 using namespace Fortran::frontend;
48 
49 //===----------------------------------------------------------------------===//
50 // Initialization.
51 //===----------------------------------------------------------------------===//
52 CompilerInvocationBase::CompilerInvocationBase()
53     : diagnosticOpts(new clang::DiagnosticOptions()),
54       preprocessorOpts(new PreprocessorOptions()) {}
55 
56 CompilerInvocationBase::CompilerInvocationBase(const CompilerInvocationBase &x)
57     : diagnosticOpts(new clang::DiagnosticOptions(x.getDiagnosticOpts())),
58       preprocessorOpts(new PreprocessorOptions(x.getPreprocessorOpts())) {}
59 
60 CompilerInvocationBase::~CompilerInvocationBase() = default;
61 
62 //===----------------------------------------------------------------------===//
63 // Deserialization (from args)
64 //===----------------------------------------------------------------------===//
65 static bool parseShowColorsArgs(const llvm::opt::ArgList &args,
66                                 bool defaultColor = true) {
67   // Color diagnostics default to auto ("on" if terminal supports) in the
68   // compiler driver `flang-new` but default to off in the frontend driver
69   // `flang-new -fc1`, needing an explicit OPT_fdiagnostics_color.
70   // Support both clang's -f[no-]color-diagnostics and gcc's
71   // -f[no-]diagnostics-colors[=never|always|auto].
72   enum {
73     Colors_On,
74     Colors_Off,
75     Colors_Auto
76   } showColors = defaultColor ? Colors_Auto : Colors_Off;
77 
78   for (auto *a : args) {
79     const llvm::opt::Option &opt = a->getOption();
80     if (opt.matches(clang::driver::options::OPT_fcolor_diagnostics)) {
81       showColors = Colors_On;
82     } else if (opt.matches(clang::driver::options::OPT_fno_color_diagnostics)) {
83       showColors = Colors_Off;
84     } else if (opt.matches(clang::driver::options::OPT_fdiagnostics_color_EQ)) {
85       llvm::StringRef value(a->getValue());
86       if (value == "always")
87         showColors = Colors_On;
88       else if (value == "never")
89         showColors = Colors_Off;
90       else if (value == "auto")
91         showColors = Colors_Auto;
92     }
93   }
94 
95   return showColors == Colors_On ||
96          (showColors == Colors_Auto &&
97           llvm::sys::Process::StandardErrHasColors());
98 }
99 
100 /// Extracts the optimisation level from \a args.
101 static unsigned getOptimizationLevel(llvm::opt::ArgList &args,
102                                      clang::DiagnosticsEngine &diags) {
103   unsigned defaultOpt = 0;
104 
105   if (llvm::opt::Arg *a =
106           args.getLastArg(clang::driver::options::OPT_O_Group)) {
107     if (a->getOption().matches(clang::driver::options::OPT_O0))
108       return 0;
109 
110     assert(a->getOption().matches(clang::driver::options::OPT_O));
111 
112     return getLastArgIntValue(args, clang::driver::options::OPT_O, defaultOpt,
113                               diags);
114   }
115 
116   return defaultOpt;
117 }
118 
119 bool Fortran::frontend::parseDiagnosticArgs(clang::DiagnosticOptions &opts,
120                                             llvm::opt::ArgList &args) {
121   opts.ShowColors = parseShowColorsArgs(args);
122 
123   return true;
124 }
125 
126 static bool parseDebugArgs(Fortran::frontend::CodeGenOptions &opts,
127                            llvm::opt::ArgList &args,
128                            clang::DiagnosticsEngine &diags) {
129   using DebugInfoKind = llvm::codegenoptions::DebugInfoKind;
130   if (llvm::opt::Arg *arg =
131           args.getLastArg(clang::driver::options::OPT_debug_info_kind_EQ)) {
132     std::optional<DebugInfoKind> val =
133         llvm::StringSwitch<std::optional<DebugInfoKind>>(arg->getValue())
134             .Case("line-tables-only", llvm::codegenoptions::DebugLineTablesOnly)
135             .Case("line-directives-only",
136                   llvm::codegenoptions::DebugDirectivesOnly)
137             .Case("constructor", llvm::codegenoptions::DebugInfoConstructor)
138             .Case("limited", llvm::codegenoptions::LimitedDebugInfo)
139             .Case("standalone", llvm::codegenoptions::FullDebugInfo)
140             .Case("unused-types", llvm::codegenoptions::UnusedTypeInfo)
141             .Default(std::nullopt);
142     if (!val.has_value()) {
143       diags.Report(clang::diag::err_drv_invalid_value)
144           << arg->getAsString(args) << arg->getValue();
145       return false;
146     }
147     opts.setDebugInfo(val.value());
148     if (val != llvm::codegenoptions::DebugLineTablesOnly &&
149         val != llvm::codegenoptions::FullDebugInfo &&
150         val != llvm::codegenoptions::NoDebugInfo) {
151       const auto debugWarning = diags.getCustomDiagID(
152           clang::DiagnosticsEngine::Warning, "Unsupported debug option: %0");
153       diags.Report(debugWarning) << arg->getValue();
154     }
155   }
156   return true;
157 }
158 
159 static bool parseVectorLibArg(Fortran::frontend::CodeGenOptions &opts,
160                               llvm::opt::ArgList &args,
161                               clang::DiagnosticsEngine &diags) {
162   llvm::opt::Arg *arg = args.getLastArg(clang::driver::options::OPT_fveclib);
163   if (!arg)
164     return true;
165 
166   using VectorLibrary = llvm::driver::VectorLibrary;
167   std::optional<VectorLibrary> val =
168       llvm::StringSwitch<std::optional<VectorLibrary>>(arg->getValue())
169           .Case("Accelerate", VectorLibrary::Accelerate)
170           .Case("LIBMVEC", VectorLibrary::LIBMVEC)
171           .Case("MASSV", VectorLibrary::MASSV)
172           .Case("SVML", VectorLibrary::SVML)
173           .Case("SLEEF", VectorLibrary::SLEEF)
174           .Case("Darwin_libsystem_m", VectorLibrary::Darwin_libsystem_m)
175           .Case("ArmPL", VectorLibrary::ArmPL)
176           .Case("NoLibrary", VectorLibrary::NoLibrary)
177           .Default(std::nullopt);
178   if (!val.has_value()) {
179     diags.Report(clang::diag::err_drv_invalid_value)
180         << arg->getAsString(args) << arg->getValue();
181     return false;
182   }
183   opts.setVecLib(val.value());
184   return true;
185 }
186 
187 // Generate an OptRemark object containing info on if the -Rgroup
188 // specified is enabled or not.
189 static CodeGenOptions::OptRemark
190 parseOptimizationRemark(clang::DiagnosticsEngine &diags,
191                         llvm::opt::ArgList &args, llvm::opt::OptSpecifier optEq,
192                         llvm::StringRef remarkOptName) {
193   assert((remarkOptName == "pass" || remarkOptName == "pass-missed" ||
194           remarkOptName == "pass-analysis") &&
195          "Unsupported remark option name provided.");
196   CodeGenOptions::OptRemark result;
197 
198   for (llvm::opt::Arg *a : args) {
199     if (a->getOption().matches(clang::driver::options::OPT_R_Joined)) {
200       llvm::StringRef value = a->getValue();
201 
202       if (value == remarkOptName) {
203         result.Kind = CodeGenOptions::RemarkKind::RK_Enabled;
204         // Enable everything
205         result.Pattern = ".*";
206         result.Regex = std::make_shared<llvm::Regex>(result.Pattern);
207 
208       } else if (value.split('-') ==
209                  std::make_pair(llvm::StringRef("no"), remarkOptName)) {
210         result.Kind = CodeGenOptions::RemarkKind::RK_Disabled;
211         // Disable everything
212         result.Pattern = "";
213         result.Regex = nullptr;
214       }
215     } else if (a->getOption().matches(optEq)) {
216       result.Kind = CodeGenOptions::RemarkKind::RK_WithPattern;
217       result.Pattern = a->getValue();
218       result.Regex = std::make_shared<llvm::Regex>(result.Pattern);
219       std::string regexError;
220 
221       if (!result.Regex->isValid(regexError)) {
222         diags.Report(clang::diag::err_drv_optimization_remark_pattern)
223             << regexError << a->getAsString(args);
224         return CodeGenOptions::OptRemark();
225       }
226     }
227   }
228   return result;
229 }
230 
231 static void parseCodeGenArgs(Fortran::frontend::CodeGenOptions &opts,
232                              llvm::opt::ArgList &args,
233                              clang::DiagnosticsEngine &diags) {
234   opts.OptimizationLevel = getOptimizationLevel(args, diags);
235 
236   if (args.hasFlag(clang::driver::options::OPT_fdebug_pass_manager,
237                    clang::driver::options::OPT_fno_debug_pass_manager, false))
238     opts.DebugPassManager = 1;
239 
240   if (args.hasFlag(clang::driver::options::OPT_fstack_arrays,
241                    clang::driver::options::OPT_fno_stack_arrays, false))
242     opts.StackArrays = 1;
243 
244   if (args.hasFlag(clang::driver::options::OPT_floop_versioning,
245                    clang::driver::options::OPT_fno_loop_versioning, false))
246     opts.LoopVersioning = 1;
247 
248   opts.AliasAnalysis = opts.OptimizationLevel > 0;
249 
250   // -mframe-pointer=none/non-leaf/all option.
251   if (const llvm::opt::Arg *a =
252           args.getLastArg(clang::driver::options::OPT_mframe_pointer_EQ)) {
253     std::optional<llvm::FramePointerKind> val =
254         llvm::StringSwitch<std::optional<llvm::FramePointerKind>>(a->getValue())
255             .Case("none", llvm::FramePointerKind::None)
256             .Case("non-leaf", llvm::FramePointerKind::NonLeaf)
257             .Case("all", llvm::FramePointerKind::All)
258             .Default(std::nullopt);
259 
260     if (!val.has_value()) {
261       diags.Report(clang::diag::err_drv_invalid_value)
262           << a->getAsString(args) << a->getValue();
263     } else
264       opts.setFramePointer(val.value());
265   }
266 
267   for (auto *a : args.filtered(clang::driver::options::OPT_fpass_plugin_EQ))
268     opts.LLVMPassPlugins.push_back(a->getValue());
269 
270   // -fembed-offload-object option
271   for (auto *a :
272        args.filtered(clang::driver::options::OPT_fembed_offload_object_EQ))
273     opts.OffloadObjects.push_back(a->getValue());
274 
275   // -flto=full/thin option.
276   if (const llvm::opt::Arg *a =
277           args.getLastArg(clang::driver::options::OPT_flto_EQ)) {
278     llvm::StringRef s = a->getValue();
279     assert((s == "full" || s == "thin") && "Unknown LTO mode.");
280     if (s == "full")
281       opts.PrepareForFullLTO = true;
282     else
283       opts.PrepareForThinLTO = true;
284   }
285 
286   if (const llvm::opt::Arg *a = args.getLastArg(
287           clang::driver::options::OPT_mcode_object_version_EQ)) {
288     llvm::StringRef s = a->getValue();
289     if (s == "6")
290       opts.CodeObjectVersion = llvm::CodeObjectVersionKind::COV_6;
291     if (s == "5")
292       opts.CodeObjectVersion = llvm::CodeObjectVersionKind::COV_5;
293     if (s == "4")
294       opts.CodeObjectVersion = llvm::CodeObjectVersionKind::COV_4;
295     if (s == "none")
296       opts.CodeObjectVersion = llvm::CodeObjectVersionKind::COV_None;
297   }
298 
299   // -f[no-]save-optimization-record[=<format>]
300   if (const llvm::opt::Arg *a =
301           args.getLastArg(clang::driver::options::OPT_opt_record_file))
302     opts.OptRecordFile = a->getValue();
303 
304   // Optimization file format. Defaults to yaml
305   if (const llvm::opt::Arg *a =
306           args.getLastArg(clang::driver::options::OPT_opt_record_format))
307     opts.OptRecordFormat = a->getValue();
308 
309   // Specifies, using a regex, which successful optimization passes(middle and
310   // backend), to include in the final optimization record file generated. If
311   // not provided -fsave-optimization-record will include all passes.
312   if (const llvm::opt::Arg *a =
313           args.getLastArg(clang::driver::options::OPT_opt_record_passes))
314     opts.OptRecordPasses = a->getValue();
315 
316   // Create OptRemark that allows printing of all successful optimization
317   // passes applied.
318   opts.OptimizationRemark =
319       parseOptimizationRemark(diags, args, clang::driver::options::OPT_Rpass_EQ,
320                               /*remarkOptName=*/"pass");
321 
322   // Create OptRemark that allows all missed optimization passes to be printed.
323   opts.OptimizationRemarkMissed = parseOptimizationRemark(
324       diags, args, clang::driver::options::OPT_Rpass_missed_EQ,
325       /*remarkOptName=*/"pass-missed");
326 
327   // Create OptRemark that allows all optimization decisions made by LLVM
328   // to be printed.
329   opts.OptimizationRemarkAnalysis = parseOptimizationRemark(
330       diags, args, clang::driver::options::OPT_Rpass_analysis_EQ,
331       /*remarkOptName=*/"pass-analysis");
332 
333   if (opts.getDebugInfo() == llvm::codegenoptions::NoDebugInfo) {
334     // If the user requested a flag that requires source locations available in
335     // the backend, make sure that the backend tracks source location
336     // information.
337     bool needLocTracking = !opts.OptRecordFile.empty() ||
338                            !opts.OptRecordPasses.empty() ||
339                            !opts.OptRecordFormat.empty() ||
340                            opts.OptimizationRemark.hasValidPattern() ||
341                            opts.OptimizationRemarkMissed.hasValidPattern() ||
342                            opts.OptimizationRemarkAnalysis.hasValidPattern();
343 
344     if (needLocTracking)
345       opts.setDebugInfo(llvm::codegenoptions::LocTrackingOnly);
346   }
347 
348   if (auto *a = args.getLastArg(clang::driver::options::OPT_save_temps_EQ))
349     opts.SaveTempsDir = a->getValue();
350 
351   // -mlink-builtin-bitcode
352   for (auto *a :
353        args.filtered(clang::driver::options::OPT_mlink_builtin_bitcode))
354     opts.BuiltinBCLibs.push_back(a->getValue());
355 
356   // -mrelocation-model option.
357   if (const llvm::opt::Arg *a =
358           args.getLastArg(clang::driver::options::OPT_mrelocation_model)) {
359     llvm::StringRef modelName = a->getValue();
360     auto relocModel =
361         llvm::StringSwitch<std::optional<llvm::Reloc::Model>>(modelName)
362             .Case("static", llvm::Reloc::Static)
363             .Case("pic", llvm::Reloc::PIC_)
364             .Case("dynamic-no-pic", llvm::Reloc::DynamicNoPIC)
365             .Case("ropi", llvm::Reloc::ROPI)
366             .Case("rwpi", llvm::Reloc::RWPI)
367             .Case("ropi-rwpi", llvm::Reloc::ROPI_RWPI)
368             .Default(std::nullopt);
369     if (relocModel.has_value())
370       opts.setRelocationModel(*relocModel);
371     else
372       diags.Report(clang::diag::err_drv_invalid_value)
373           << a->getAsString(args) << modelName;
374   }
375 
376   // -pic-level and -pic-is-pie option.
377   if (int picLevel = getLastArgIntValue(
378           args, clang::driver::options::OPT_pic_level, 0, diags)) {
379     if (picLevel > 2)
380       diags.Report(clang::diag::err_drv_invalid_value)
381           << args.getLastArg(clang::driver::options::OPT_pic_level)
382                  ->getAsString(args)
383           << picLevel;
384 
385     opts.PICLevel = picLevel;
386     if (args.hasArg(clang::driver::options::OPT_pic_is_pie))
387       opts.IsPIE = 1;
388   }
389 
390   // -mcmodel option.
391   if (const llvm::opt::Arg *a =
392           args.getLastArg(clang::driver::options::OPT_mcmodel_EQ)) {
393     llvm::StringRef modelName = a->getValue();
394     std::optional<llvm::CodeModel::Model> codeModel = getCodeModel(modelName);
395 
396     if (codeModel.has_value())
397       opts.CodeModel = modelName;
398     else
399       diags.Report(clang::diag::err_drv_invalid_value)
400           << a->getAsString(args) << modelName;
401   }
402 
403   if (const llvm::opt::Arg *arg = args.getLastArg(
404           clang::driver::options::OPT_mlarge_data_threshold_EQ)) {
405     uint64_t LDT;
406     if (llvm::StringRef(arg->getValue()).getAsInteger(/*Radix=*/10, LDT)) {
407       diags.Report(clang::diag::err_drv_invalid_value)
408           << arg->getSpelling() << arg->getValue();
409     }
410     opts.LargeDataThreshold = LDT;
411   }
412 
413   // This option is compatible with -f[no-]underscoring in gfortran.
414   if (args.hasFlag(clang::driver::options::OPT_fno_underscoring,
415                    clang::driver::options::OPT_funderscoring, false)) {
416     opts.Underscoring = 0;
417   }
418 }
419 
420 /// Parses all target input arguments and populates the target
421 /// options accordingly.
422 ///
423 /// \param [in] opts The target options instance to update
424 /// \param [in] args The list of input arguments (from the compiler invocation)
425 static void parseTargetArgs(TargetOptions &opts, llvm::opt::ArgList &args) {
426   if (const llvm::opt::Arg *a =
427           args.getLastArg(clang::driver::options::OPT_triple))
428     opts.triple = a->getValue();
429 
430   if (const llvm::opt::Arg *a =
431           args.getLastArg(clang::driver::options::OPT_target_cpu))
432     opts.cpu = a->getValue();
433 
434   if (const llvm::opt::Arg *a =
435           args.getLastArg(clang::driver::options::OPT_tune_cpu))
436     opts.cpuToTuneFor = a->getValue();
437 
438   for (const llvm::opt::Arg *currentArg :
439        args.filtered(clang::driver::options::OPT_target_feature))
440     opts.featuresAsWritten.emplace_back(currentArg->getValue());
441 
442   if (args.hasArg(clang::driver::options::OPT_fdisable_real_10))
443     opts.disabledRealKinds.push_back(10);
444 
445   if (args.hasArg(clang::driver::options::OPT_fdisable_real_3))
446     opts.disabledRealKinds.push_back(3);
447 
448   if (args.hasArg(clang::driver::options::OPT_fdisable_integer_2))
449     opts.disabledIntegerKinds.push_back(2);
450 
451   if (args.hasArg(clang::driver::options::OPT_fdisable_integer_16))
452     opts.disabledIntegerKinds.push_back(16);
453 }
454 // Tweak the frontend configuration based on the frontend action
455 static void setUpFrontendBasedOnAction(FrontendOptions &opts) {
456   if (opts.programAction == DebugDumpParsingLog)
457     opts.instrumentedParse = true;
458 
459   if (opts.programAction == DebugDumpProvenance ||
460       opts.programAction == Fortran::frontend::GetDefinition)
461     opts.needProvenanceRangeToCharBlockMappings = true;
462 }
463 
464 /// Parse the argument specified for the -fconvert=<value> option
465 static std::optional<const char *> parseConvertArg(const char *s) {
466   return llvm::StringSwitch<std::optional<const char *>>(s)
467       .Case("unknown", "UNKNOWN")
468       .Case("native", "NATIVE")
469       .Case("little-endian", "LITTLE_ENDIAN")
470       .Case("big-endian", "BIG_ENDIAN")
471       .Case("swap", "SWAP")
472       .Default(std::nullopt);
473 }
474 
475 static bool parseFrontendArgs(FrontendOptions &opts, llvm::opt::ArgList &args,
476                               clang::DiagnosticsEngine &diags) {
477   unsigned numErrorsBefore = diags.getNumErrors();
478 
479   // By default the frontend driver creates a ParseSyntaxOnly action.
480   opts.programAction = ParseSyntaxOnly;
481 
482   // Treat multiple action options as an invocation error. Note that `clang
483   // -cc1` does accept multiple action options, but will only consider the
484   // rightmost one.
485   if (args.hasMultipleArgs(clang::driver::options::OPT_Action_Group)) {
486     const unsigned diagID = diags.getCustomDiagID(
487         clang::DiagnosticsEngine::Error, "Only one action option is allowed");
488     diags.Report(diagID);
489     return false;
490   }
491 
492   // Identify the action (i.e. opts.ProgramAction)
493   if (const llvm::opt::Arg *a =
494           args.getLastArg(clang::driver::options::OPT_Action_Group)) {
495     switch (a->getOption().getID()) {
496     default: {
497       llvm_unreachable("Invalid option in group!");
498     }
499     case clang::driver::options::OPT_test_io:
500       opts.programAction = InputOutputTest;
501       break;
502     case clang::driver::options::OPT_E:
503       opts.programAction = PrintPreprocessedInput;
504       break;
505     case clang::driver::options::OPT_fsyntax_only:
506       opts.programAction = ParseSyntaxOnly;
507       break;
508     case clang::driver::options::OPT_emit_fir:
509       opts.programAction = EmitFIR;
510       break;
511     case clang::driver::options::OPT_emit_hlfir:
512       opts.programAction = EmitHLFIR;
513       break;
514     case clang::driver::options::OPT_emit_llvm:
515       opts.programAction = EmitLLVM;
516       break;
517     case clang::driver::options::OPT_emit_llvm_bc:
518       opts.programAction = EmitLLVMBitcode;
519       break;
520     case clang::driver::options::OPT_emit_obj:
521       opts.programAction = EmitObj;
522       break;
523     case clang::driver::options::OPT_S:
524       opts.programAction = EmitAssembly;
525       break;
526     case clang::driver::options::OPT_fdebug_unparse:
527       opts.programAction = DebugUnparse;
528       break;
529     case clang::driver::options::OPT_fdebug_unparse_no_sema:
530       opts.programAction = DebugUnparseNoSema;
531       break;
532     case clang::driver::options::OPT_fdebug_unparse_with_symbols:
533       opts.programAction = DebugUnparseWithSymbols;
534       break;
535     case clang::driver::options::OPT_fdebug_unparse_with_modules:
536       opts.programAction = DebugUnparseWithModules;
537       break;
538     case clang::driver::options::OPT_fdebug_dump_symbols:
539       opts.programAction = DebugDumpSymbols;
540       break;
541     case clang::driver::options::OPT_fdebug_dump_parse_tree:
542       opts.programAction = DebugDumpParseTree;
543       break;
544     case clang::driver::options::OPT_fdebug_dump_pft:
545       opts.programAction = DebugDumpPFT;
546       break;
547     case clang::driver::options::OPT_fdebug_dump_all:
548       opts.programAction = DebugDumpAll;
549       break;
550     case clang::driver::options::OPT_fdebug_dump_parse_tree_no_sema:
551       opts.programAction = DebugDumpParseTreeNoSema;
552       break;
553     case clang::driver::options::OPT_fdebug_dump_provenance:
554       opts.programAction = DebugDumpProvenance;
555       break;
556     case clang::driver::options::OPT_fdebug_dump_parsing_log:
557       opts.programAction = DebugDumpParsingLog;
558       break;
559     case clang::driver::options::OPT_fdebug_measure_parse_tree:
560       opts.programAction = DebugMeasureParseTree;
561       break;
562     case clang::driver::options::OPT_fdebug_pre_fir_tree:
563       opts.programAction = DebugPreFIRTree;
564       break;
565     case clang::driver::options::OPT_fget_symbols_sources:
566       opts.programAction = GetSymbolsSources;
567       break;
568     case clang::driver::options::OPT_fget_definition:
569       opts.programAction = GetDefinition;
570       break;
571     case clang::driver::options::OPT_init_only:
572       opts.programAction = InitOnly;
573       break;
574 
575       // TODO:
576       // case clang::driver::options::OPT_emit_llvm:
577       // case clang::driver::options::OPT_emit_llvm_only:
578       // case clang::driver::options::OPT_emit_codegen_only:
579       // case clang::driver::options::OPT_emit_module:
580       // (...)
581     }
582 
583     // Parse the values provided with `-fget-definition` (there should be 3
584     // integers)
585     if (llvm::opt::OptSpecifier(a->getOption().getID()) ==
586         clang::driver::options::OPT_fget_definition) {
587       unsigned optVals[3] = {0, 0, 0};
588 
589       for (unsigned i = 0; i < 3; i++) {
590         llvm::StringRef val = a->getValue(i);
591 
592         if (val.getAsInteger(10, optVals[i])) {
593           // A non-integer was encountered - that's an error.
594           diags.Report(clang::diag::err_drv_invalid_value)
595               << a->getOption().getName() << val;
596           break;
597         }
598       }
599       opts.getDefVals.line = optVals[0];
600       opts.getDefVals.startColumn = optVals[1];
601       opts.getDefVals.endColumn = optVals[2];
602     }
603   }
604 
605   // Parsing -load <dsopath> option and storing shared object path
606   if (llvm::opt::Arg *a = args.getLastArg(clang::driver::options::OPT_load)) {
607     opts.plugins.push_back(a->getValue());
608   }
609 
610   // Parsing -plugin <name> option and storing plugin name and setting action
611   if (const llvm::opt::Arg *a =
612           args.getLastArg(clang::driver::options::OPT_plugin)) {
613     opts.programAction = PluginAction;
614     opts.actionName = a->getValue();
615   }
616 
617   opts.outputFile = args.getLastArgValue(clang::driver::options::OPT_o);
618   opts.showHelp = args.hasArg(clang::driver::options::OPT_help);
619   opts.showVersion = args.hasArg(clang::driver::options::OPT_version);
620 
621   // Get the input kind (from the value passed via `-x`)
622   InputKind dashX(Language::Unknown);
623   if (const llvm::opt::Arg *a =
624           args.getLastArg(clang::driver::options::OPT_x)) {
625     llvm::StringRef xValue = a->getValue();
626     // Principal languages.
627     dashX = llvm::StringSwitch<InputKind>(xValue)
628                 // Flang does not differentiate between pre-processed and not
629                 // pre-processed inputs.
630                 .Case("f95", Language::Fortran)
631                 .Case("f95-cpp-input", Language::Fortran)
632                 // CUDA Fortran
633                 .Case("cuda", Language::Fortran)
634                 .Default(Language::Unknown);
635 
636     // Flang's intermediate representations.
637     if (dashX.isUnknown())
638       dashX = llvm::StringSwitch<InputKind>(xValue)
639                   .Case("ir", Language::LLVM_IR)
640                   .Case("fir", Language::MLIR)
641                   .Case("mlir", Language::MLIR)
642                   .Default(Language::Unknown);
643 
644     if (dashX.isUnknown())
645       diags.Report(clang::diag::err_drv_invalid_value)
646           << a->getAsString(args) << a->getValue();
647   }
648 
649   // Collect the input files and save them in our instance of FrontendOptions.
650   std::vector<std::string> inputs =
651       args.getAllArgValues(clang::driver::options::OPT_INPUT);
652   opts.inputs.clear();
653   if (inputs.empty())
654     // '-' is the default input if none is given.
655     inputs.push_back("-");
656   for (unsigned i = 0, e = inputs.size(); i != e; ++i) {
657     InputKind ik = dashX;
658     if (ik.isUnknown()) {
659       ik = FrontendOptions::getInputKindForExtension(
660           llvm::StringRef(inputs[i]).rsplit('.').second);
661       if (ik.isUnknown())
662         ik = Language::Unknown;
663       if (i == 0)
664         dashX = ik;
665     }
666 
667     opts.inputs.emplace_back(std::move(inputs[i]), ik);
668   }
669 
670   // Set fortranForm based on options -ffree-form and -ffixed-form.
671   if (const auto *arg =
672           args.getLastArg(clang::driver::options::OPT_ffixed_form,
673                           clang::driver::options::OPT_ffree_form)) {
674     opts.fortranForm =
675         arg->getOption().matches(clang::driver::options::OPT_ffixed_form)
676             ? FortranForm::FixedForm
677             : FortranForm::FreeForm;
678   }
679 
680   // Set fixedFormColumns based on -ffixed-line-length=<value>
681   if (const auto *arg =
682           args.getLastArg(clang::driver::options::OPT_ffixed_line_length_EQ)) {
683     llvm::StringRef argValue = llvm::StringRef(arg->getValue());
684     std::int64_t columns = -1;
685     if (argValue == "none") {
686       columns = 0;
687     } else if (argValue.getAsInteger(/*Radix=*/10, columns)) {
688       columns = -1;
689     }
690     if (columns < 0) {
691       diags.Report(clang::diag::err_drv_negative_columns)
692           << arg->getOption().getName() << arg->getValue();
693     } else if (columns == 0) {
694       opts.fixedFormColumns = 1000000;
695     } else if (columns < 7) {
696       diags.Report(clang::diag::err_drv_small_columns)
697           << arg->getOption().getName() << arg->getValue() << "7";
698     } else {
699       opts.fixedFormColumns = columns;
700     }
701   }
702 
703   // Set conversion based on -fconvert=<value>
704   if (const auto *arg =
705           args.getLastArg(clang::driver::options::OPT_fconvert_EQ)) {
706     const char *argValue = arg->getValue();
707     if (auto convert = parseConvertArg(argValue))
708       opts.envDefaults.push_back({"FORT_CONVERT", *convert});
709     else
710       diags.Report(clang::diag::err_drv_invalid_value)
711           << arg->getAsString(args) << argValue;
712   }
713 
714   // -f{no-}implicit-none
715   opts.features.Enable(
716       Fortran::common::LanguageFeature::ImplicitNoneTypeAlways,
717       args.hasFlag(clang::driver::options::OPT_fimplicit_none,
718                    clang::driver::options::OPT_fno_implicit_none, false));
719 
720   // -f{no-}backslash
721   opts.features.Enable(Fortran::common::LanguageFeature::BackslashEscapes,
722                        args.hasFlag(clang::driver::options::OPT_fbackslash,
723                                     clang::driver::options::OPT_fno_backslash,
724                                     false));
725 
726   // -f{no-}logical-abbreviations
727   opts.features.Enable(
728       Fortran::common::LanguageFeature::LogicalAbbreviations,
729       args.hasFlag(clang::driver::options::OPT_flogical_abbreviations,
730                    clang::driver::options::OPT_fno_logical_abbreviations,
731                    false));
732 
733   // -f{no-}xor-operator
734   opts.features.Enable(
735       Fortran::common::LanguageFeature::XOROperator,
736       args.hasFlag(clang::driver::options::OPT_fxor_operator,
737                    clang::driver::options::OPT_fno_xor_operator, false));
738 
739   // -fno-automatic
740   if (args.hasArg(clang::driver::options::OPT_fno_automatic)) {
741     opts.features.Enable(Fortran::common::LanguageFeature::DefaultSave);
742   }
743 
744   if (args.hasArg(
745           clang::driver::options::OPT_falternative_parameter_statement)) {
746     opts.features.Enable(Fortran::common::LanguageFeature::OldStyleParameter);
747   }
748   if (const llvm::opt::Arg *arg =
749           args.getLastArg(clang::driver::options::OPT_finput_charset_EQ)) {
750     llvm::StringRef argValue = arg->getValue();
751     if (argValue == "utf-8") {
752       opts.encoding = Fortran::parser::Encoding::UTF_8;
753     } else if (argValue == "latin-1") {
754       opts.encoding = Fortran::parser::Encoding::LATIN_1;
755     } else {
756       diags.Report(clang::diag::err_drv_invalid_value)
757           << arg->getAsString(args) << argValue;
758     }
759   }
760 
761   setUpFrontendBasedOnAction(opts);
762   opts.dashX = dashX;
763 
764   return diags.getNumErrors() == numErrorsBefore;
765 }
766 
767 // Generate the path to look for intrinsic modules
768 static std::string getIntrinsicDir(const char *argv) {
769   // TODO: Find a system independent API
770   llvm::SmallString<128> driverPath;
771   driverPath.assign(llvm::sys::fs::getMainExecutable(argv, nullptr));
772   llvm::sys::path::remove_filename(driverPath);
773   driverPath.append("/../include/flang/");
774   return std::string(driverPath);
775 }
776 
777 // Generate the path to look for OpenMP headers
778 static std::string getOpenMPHeadersDir(const char *argv) {
779   llvm::SmallString<128> includePath;
780   includePath.assign(llvm::sys::fs::getMainExecutable(argv, nullptr));
781   llvm::sys::path::remove_filename(includePath);
782   includePath.append("/../include/flang/OpenMP/");
783   return std::string(includePath);
784 }
785 
786 /// Parses all preprocessor input arguments and populates the preprocessor
787 /// options accordingly.
788 ///
789 /// \param [in] opts The preprocessor options instance
790 /// \param [out] args The list of input arguments
791 static void parsePreprocessorArgs(Fortran::frontend::PreprocessorOptions &opts,
792                                   llvm::opt::ArgList &args) {
793   // Add macros from the command line.
794   for (const auto *currentArg : args.filtered(clang::driver::options::OPT_D,
795                                               clang::driver::options::OPT_U)) {
796     if (currentArg->getOption().matches(clang::driver::options::OPT_D)) {
797       opts.addMacroDef(currentArg->getValue());
798     } else {
799       opts.addMacroUndef(currentArg->getValue());
800     }
801   }
802 
803   // Add the ordered list of -I's.
804   for (const auto *currentArg : args.filtered(clang::driver::options::OPT_I))
805     opts.searchDirectoriesFromDashI.emplace_back(currentArg->getValue());
806 
807   // Prepend the ordered list of -intrinsic-modules-path
808   // to the default location to search.
809   for (const auto *currentArg :
810        args.filtered(clang::driver::options::OPT_fintrinsic_modules_path))
811     opts.searchDirectoriesFromIntrModPath.emplace_back(currentArg->getValue());
812 
813   // -cpp/-nocpp
814   if (const auto *currentArg = args.getLastArg(
815           clang::driver::options::OPT_cpp, clang::driver::options::OPT_nocpp))
816     opts.macrosFlag =
817         (currentArg->getOption().matches(clang::driver::options::OPT_cpp))
818             ? PPMacrosFlag::Include
819             : PPMacrosFlag::Exclude;
820 
821   opts.noReformat = args.hasArg(clang::driver::options::OPT_fno_reformat);
822   opts.noLineDirectives = args.hasArg(clang::driver::options::OPT_P);
823   opts.showMacros = args.hasArg(clang::driver::options::OPT_dM);
824 }
825 
826 /// Parses all semantic related arguments and populates the variables
827 /// options accordingly. Returns false if new errors are generated.
828 static bool parseSemaArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
829                           clang::DiagnosticsEngine &diags) {
830   unsigned numErrorsBefore = diags.getNumErrors();
831 
832   // -J/module-dir option
833   auto moduleDirList =
834       args.getAllArgValues(clang::driver::options::OPT_module_dir);
835   // User can only specify -J/-module-dir once
836   // https://gcc.gnu.org/onlinedocs/gfortran/Directory-Options.html
837   if (moduleDirList.size() > 1) {
838     const unsigned diagID =
839         diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
840                               "Only one '-module-dir/-J' option allowed");
841     diags.Report(diagID);
842   }
843   if (moduleDirList.size() == 1)
844     res.setModuleDir(moduleDirList[0]);
845 
846   // -fdebug-module-writer option
847   if (args.hasArg(clang::driver::options::OPT_fdebug_module_writer)) {
848     res.setDebugModuleDir(true);
849   }
850 
851   // -fhermetic-module-files option
852   if (args.hasArg(clang::driver::options::OPT_fhermetic_module_files)) {
853     res.setHermeticModuleFileOutput(true);
854   }
855 
856   // -module-suffix
857   if (const auto *moduleSuffix =
858           args.getLastArg(clang::driver::options::OPT_module_suffix)) {
859     res.setModuleFileSuffix(moduleSuffix->getValue());
860   }
861 
862   // -f{no-}analyzed-objects-for-unparse
863   res.setUseAnalyzedObjectsForUnparse(args.hasFlag(
864       clang::driver::options::OPT_fanalyzed_objects_for_unparse,
865       clang::driver::options::OPT_fno_analyzed_objects_for_unparse, true));
866 
867   return diags.getNumErrors() == numErrorsBefore;
868 }
869 
870 /// Parses all diagnostics related arguments and populates the variables
871 /// options accordingly. Returns false if new errors are generated.
872 static bool parseDiagArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
873                           clang::DiagnosticsEngine &diags) {
874   unsigned numErrorsBefore = diags.getNumErrors();
875 
876   // -Werror option
877   // TODO: Currently throws a Diagnostic for anything other than -W<error>,
878   // this has to change when other -W<opt>'s are supported.
879   if (args.hasArg(clang::driver::options::OPT_W_Joined)) {
880     const auto &wArgs =
881         args.getAllArgValues(clang::driver::options::OPT_W_Joined);
882     for (const auto &wArg : wArgs) {
883       if (wArg == "error") {
884         res.setWarnAsErr(true);
885       } else {
886         const unsigned diagID =
887             diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
888                                   "Only `-Werror` is supported currently.");
889         diags.Report(diagID);
890       }
891     }
892   }
893 
894   // Default to off for `flang-new -fc1`.
895   res.getFrontendOpts().showColors =
896       parseShowColorsArgs(args, /*defaultDiagColor=*/false);
897 
898   // Honor color diagnostics.
899   res.getDiagnosticOpts().ShowColors = res.getFrontendOpts().showColors;
900 
901   return diags.getNumErrors() == numErrorsBefore;
902 }
903 
904 /// Parses all Dialect related arguments and populates the variables
905 /// options accordingly. Returns false if new errors are generated.
906 static bool parseDialectArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
907                              clang::DiagnosticsEngine &diags) {
908   unsigned numErrorsBefore = diags.getNumErrors();
909 
910   // -fdefault* family
911   if (args.hasArg(clang::driver::options::OPT_fdefault_real_8)) {
912     res.getDefaultKinds().set_defaultRealKind(8);
913     res.getDefaultKinds().set_doublePrecisionKind(16);
914   }
915   if (args.hasArg(clang::driver::options::OPT_fdefault_integer_8)) {
916     res.getDefaultKinds().set_defaultIntegerKind(8);
917     res.getDefaultKinds().set_subscriptIntegerKind(8);
918     res.getDefaultKinds().set_sizeIntegerKind(8);
919     res.getDefaultKinds().set_defaultLogicalKind(8);
920   }
921   if (args.hasArg(clang::driver::options::OPT_fdefault_double_8)) {
922     if (!args.hasArg(clang::driver::options::OPT_fdefault_real_8)) {
923       // -fdefault-double-8 has to be used with -fdefault-real-8
924       // to be compatible with gfortran
925       const unsigned diagID = diags.getCustomDiagID(
926           clang::DiagnosticsEngine::Error,
927           "Use of `-fdefault-double-8` requires `-fdefault-real-8`");
928       diags.Report(diagID);
929     }
930     // https://gcc.gnu.org/onlinedocs/gfortran/Fortran-Dialect-Options.html
931     res.getDefaultKinds().set_doublePrecisionKind(8);
932   }
933   if (args.hasArg(clang::driver::options::OPT_flarge_sizes))
934     res.getDefaultKinds().set_sizeIntegerKind(8);
935 
936   // -x cuda
937   auto language = args.getLastArgValue(clang::driver::options::OPT_x);
938   if (language == "cuda") {
939     res.getFrontendOpts().features.Enable(
940         Fortran::common::LanguageFeature::CUDA);
941   }
942 
943   // -fopenacc
944   if (args.hasArg(clang::driver::options::OPT_fopenacc)) {
945     res.getFrontendOpts().features.Enable(
946         Fortran::common::LanguageFeature::OpenACC);
947   }
948 
949   // -pedantic
950   if (args.hasArg(clang::driver::options::OPT_pedantic)) {
951     res.setEnableConformanceChecks();
952     res.setEnableUsageChecks();
953   }
954 
955   // -w
956   if (args.hasArg(clang::driver::options::OPT_w))
957     res.setDisableWarnings();
958 
959   // -std=f2018
960   // TODO: Set proper options when more fortran standards
961   // are supported.
962   if (args.hasArg(clang::driver::options::OPT_std_EQ)) {
963     auto standard = args.getLastArgValue(clang::driver::options::OPT_std_EQ);
964     // We only allow f2018 as the given standard
965     if (standard == "f2018") {
966       res.setEnableConformanceChecks();
967     } else {
968       const unsigned diagID =
969           diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
970                                 "Only -std=f2018 is allowed currently.");
971       diags.Report(diagID);
972     }
973   }
974   return diags.getNumErrors() == numErrorsBefore;
975 }
976 
977 /// Parses all OpenMP related arguments if the -fopenmp option is present,
978 /// populating the \c res object accordingly. Returns false if new errors are
979 /// generated.
980 static bool parseOpenMPArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
981                             clang::DiagnosticsEngine &diags) {
982   llvm::opt::Arg *arg = args.getLastArg(clang::driver::options::OPT_fopenmp,
983                                         clang::driver::options::OPT_fno_openmp);
984   if (!arg || arg->getOption().matches(clang::driver::options::OPT_fno_openmp))
985     return true;
986 
987   unsigned numErrorsBefore = diags.getNumErrors();
988   llvm::Triple t(res.getTargetOpts().triple);
989 
990   // By default OpenMP is set to 1.1 version
991   res.getLangOpts().OpenMPVersion = 11;
992   res.getFrontendOpts().features.Enable(
993       Fortran::common::LanguageFeature::OpenMP);
994   if (int Version = getLastArgIntValue(
995           args, clang::driver::options::OPT_fopenmp_version_EQ,
996           res.getLangOpts().OpenMPVersion, diags)) {
997     res.getLangOpts().OpenMPVersion = Version;
998   }
999   if (args.hasArg(clang::driver::options::OPT_fopenmp_force_usm)) {
1000     res.getLangOpts().OpenMPForceUSM = 1;
1001   }
1002   if (args.hasArg(clang::driver::options::OPT_fopenmp_is_target_device)) {
1003     res.getLangOpts().OpenMPIsTargetDevice = 1;
1004 
1005     // Get OpenMP host file path if any and report if a non existent file is
1006     // found
1007     if (auto *arg = args.getLastArg(
1008             clang::driver::options::OPT_fopenmp_host_ir_file_path)) {
1009       res.getLangOpts().OMPHostIRFile = arg->getValue();
1010       if (!llvm::sys::fs::exists(res.getLangOpts().OMPHostIRFile))
1011         diags.Report(clang::diag::err_drv_omp_host_ir_file_not_found)
1012             << res.getLangOpts().OMPHostIRFile;
1013     }
1014 
1015     if (args.hasFlag(
1016             clang::driver::options::OPT_fopenmp_assume_teams_oversubscription,
1017             clang::driver::options::
1018                 OPT_fno_openmp_assume_teams_oversubscription,
1019             /*Default=*/false))
1020       res.getLangOpts().OpenMPTeamSubscription = true;
1021 
1022     if (args.hasArg(clang::driver::options::OPT_fopenmp_assume_no_thread_state))
1023       res.getLangOpts().OpenMPNoThreadState = 1;
1024 
1025     if (args.hasArg(
1026             clang::driver::options::OPT_fopenmp_assume_no_nested_parallelism))
1027       res.getLangOpts().OpenMPNoNestedParallelism = 1;
1028 
1029     if (args.hasFlag(
1030             clang::driver::options::OPT_fopenmp_assume_threads_oversubscription,
1031             clang::driver::options::
1032                 OPT_fno_openmp_assume_threads_oversubscription,
1033             /*Default=*/false))
1034       res.getLangOpts().OpenMPThreadSubscription = true;
1035 
1036     if ((args.hasArg(clang::driver::options::OPT_fopenmp_target_debug) ||
1037          args.hasArg(clang::driver::options::OPT_fopenmp_target_debug_EQ))) {
1038       res.getLangOpts().OpenMPTargetDebug = getLastArgIntValue(
1039           args, clang::driver::options::OPT_fopenmp_target_debug_EQ,
1040           res.getLangOpts().OpenMPTargetDebug, diags);
1041 
1042       if (!res.getLangOpts().OpenMPTargetDebug &&
1043           args.hasArg(clang::driver::options::OPT_fopenmp_target_debug))
1044         res.getLangOpts().OpenMPTargetDebug = 1;
1045     }
1046     if (args.hasArg(clang::driver::options::OPT_nogpulib))
1047       res.getLangOpts().NoGPULib = 1;
1048   }
1049 
1050   switch (llvm::Triple(res.getTargetOpts().triple).getArch()) {
1051   case llvm::Triple::nvptx:
1052   case llvm::Triple::nvptx64:
1053   case llvm::Triple::amdgcn:
1054     if (!res.getLangOpts().OpenMPIsTargetDevice) {
1055       const unsigned diagID = diags.getCustomDiagID(
1056           clang::DiagnosticsEngine::Error,
1057           "OpenMP AMDGPU/NVPTX is only prepared to deal with device code.");
1058       diags.Report(diagID);
1059     }
1060     res.getLangOpts().OpenMPIsGPU = 1;
1061     break;
1062   default:
1063     res.getLangOpts().OpenMPIsGPU = 0;
1064     break;
1065   }
1066 
1067   // Get the OpenMP target triples if any.
1068   if (auto *arg =
1069           args.getLastArg(clang::driver::options::OPT_fopenmp_targets_EQ)) {
1070     enum ArchPtrSize { Arch16Bit, Arch32Bit, Arch64Bit };
1071     auto getArchPtrSize = [](const llvm::Triple &triple) {
1072       if (triple.isArch16Bit())
1073         return Arch16Bit;
1074       if (triple.isArch32Bit())
1075         return Arch32Bit;
1076       assert(triple.isArch64Bit() && "Expected 64-bit architecture");
1077       return Arch64Bit;
1078     };
1079 
1080     for (unsigned i = 0; i < arg->getNumValues(); ++i) {
1081       llvm::Triple tt(arg->getValue(i));
1082 
1083       if (tt.getArch() == llvm::Triple::UnknownArch ||
1084           !(tt.getArch() == llvm::Triple::aarch64 || tt.isPPC() ||
1085             tt.getArch() == llvm::Triple::systemz ||
1086             tt.getArch() == llvm::Triple::nvptx ||
1087             tt.getArch() == llvm::Triple::nvptx64 ||
1088             tt.getArch() == llvm::Triple::amdgcn ||
1089             tt.getArch() == llvm::Triple::x86 ||
1090             tt.getArch() == llvm::Triple::x86_64))
1091         diags.Report(clang::diag::err_drv_invalid_omp_target)
1092             << arg->getValue(i);
1093       else if (getArchPtrSize(t) != getArchPtrSize(tt))
1094         diags.Report(clang::diag::err_drv_incompatible_omp_arch)
1095             << arg->getValue(i) << t.str();
1096       else
1097         res.getLangOpts().OMPTargetTriples.push_back(tt);
1098     }
1099   }
1100   return diags.getNumErrors() == numErrorsBefore;
1101 }
1102 
1103 /// Parses all floating point related arguments and populates the
1104 /// CompilerInvocation accordingly.
1105 /// Returns false if new errors are generated.
1106 ///
1107 /// \param [out] invoc Stores the processed arguments
1108 /// \param [in] args The compiler invocation arguments to parse
1109 /// \param [out] diags DiagnosticsEngine to report erros with
1110 static bool parseFloatingPointArgs(CompilerInvocation &invoc,
1111                                    llvm::opt::ArgList &args,
1112                                    clang::DiagnosticsEngine &diags) {
1113   LangOptions &opts = invoc.getLangOpts();
1114 
1115   if (const llvm::opt::Arg *a =
1116           args.getLastArg(clang::driver::options::OPT_ffp_contract)) {
1117     const llvm::StringRef val = a->getValue();
1118     enum LangOptions::FPModeKind fpContractMode;
1119 
1120     if (val == "off")
1121       fpContractMode = LangOptions::FPM_Off;
1122     else if (val == "fast")
1123       fpContractMode = LangOptions::FPM_Fast;
1124     else {
1125       diags.Report(clang::diag::err_drv_unsupported_option_argument)
1126           << a->getSpelling() << val;
1127       return false;
1128     }
1129 
1130     opts.setFPContractMode(fpContractMode);
1131   }
1132 
1133   if (args.getLastArg(clang::driver::options::OPT_menable_no_infs)) {
1134     opts.NoHonorInfs = true;
1135   }
1136 
1137   if (args.getLastArg(clang::driver::options::OPT_menable_no_nans)) {
1138     opts.NoHonorNaNs = true;
1139   }
1140 
1141   if (args.getLastArg(clang::driver::options::OPT_fapprox_func)) {
1142     opts.ApproxFunc = true;
1143   }
1144 
1145   if (args.getLastArg(clang::driver::options::OPT_fno_signed_zeros)) {
1146     opts.NoSignedZeros = true;
1147   }
1148 
1149   if (args.getLastArg(clang::driver::options::OPT_mreassociate)) {
1150     opts.AssociativeMath = true;
1151   }
1152 
1153   if (args.getLastArg(clang::driver::options::OPT_freciprocal_math)) {
1154     opts.ReciprocalMath = true;
1155   }
1156 
1157   if (args.getLastArg(clang::driver::options::OPT_ffast_math)) {
1158     opts.NoHonorInfs = true;
1159     opts.NoHonorNaNs = true;
1160     opts.AssociativeMath = true;
1161     opts.ReciprocalMath = true;
1162     opts.ApproxFunc = true;
1163     opts.NoSignedZeros = true;
1164     opts.setFPContractMode(LangOptions::FPM_Fast);
1165   }
1166 
1167   return true;
1168 }
1169 
1170 /// Parses vscale range options and populates the CompilerInvocation
1171 /// accordingly.
1172 /// Returns false if new errors are generated.
1173 ///
1174 /// \param [out] invoc Stores the processed arguments
1175 /// \param [in] args The compiler invocation arguments to parse
1176 /// \param [out] diags DiagnosticsEngine to report erros with
1177 static bool parseVScaleArgs(CompilerInvocation &invoc, llvm::opt::ArgList &args,
1178                             clang::DiagnosticsEngine &diags) {
1179   const auto *vscaleMin =
1180       args.getLastArg(clang::driver::options::OPT_mvscale_min_EQ);
1181   const auto *vscaleMax =
1182       args.getLastArg(clang::driver::options::OPT_mvscale_max_EQ);
1183 
1184   if (!vscaleMin && !vscaleMax)
1185     return true;
1186 
1187   llvm::Triple triple = llvm::Triple(invoc.getTargetOpts().triple);
1188   if (!triple.isAArch64() && !triple.isRISCV()) {
1189     const unsigned diagID =
1190         diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
1191                               "`-mvscale-max` and `-mvscale-min` are not "
1192                               "supported for this architecture: %0");
1193     diags.Report(diagID) << triple.getArchName();
1194     return false;
1195   }
1196 
1197   LangOptions &opts = invoc.getLangOpts();
1198   if (vscaleMin) {
1199     llvm::StringRef argValue = llvm::StringRef(vscaleMin->getValue());
1200     unsigned vscaleMinVal;
1201     if (argValue.getAsInteger(/*Radix=*/10, vscaleMinVal)) {
1202       diags.Report(clang::diag::err_drv_unsupported_option_argument)
1203           << vscaleMax->getSpelling() << argValue;
1204       return false;
1205     }
1206     opts.VScaleMin = vscaleMinVal;
1207   }
1208 
1209   if (vscaleMax) {
1210     llvm::StringRef argValue = llvm::StringRef(vscaleMax->getValue());
1211     unsigned vscaleMaxVal;
1212     if (argValue.getAsInteger(/*Radix=w*/ 10, vscaleMaxVal)) {
1213       diags.Report(clang::diag::err_drv_unsupported_option_argument)
1214           << vscaleMax->getSpelling() << argValue;
1215       return false;
1216     }
1217     opts.VScaleMax = vscaleMaxVal;
1218   }
1219   return true;
1220 }
1221 
1222 static bool parseLinkerOptionsArgs(CompilerInvocation &invoc,
1223                                    llvm::opt::ArgList &args,
1224                                    clang::DiagnosticsEngine &diags) {
1225   llvm::Triple triple = llvm::Triple(invoc.getTargetOpts().triple);
1226 
1227   // TODO: support --dependent-lib on other platforms when MLIR supports
1228   //       !llvm.dependent.lib
1229   if (args.hasArg(clang::driver::options::OPT_dependent_lib) &&
1230       !triple.isOSWindows()) {
1231     const unsigned diagID =
1232         diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
1233                               "--dependent-lib is only supported on Windows");
1234     diags.Report(diagID);
1235     return false;
1236   }
1237 
1238   invoc.getCodeGenOpts().DependentLibs =
1239       args.getAllArgValues(clang::driver::options::OPT_dependent_lib);
1240   return true;
1241 }
1242 
1243 bool CompilerInvocation::createFromArgs(
1244     CompilerInvocation &invoc, llvm::ArrayRef<const char *> commandLineArgs,
1245     clang::DiagnosticsEngine &diags, const char *argv0) {
1246 
1247   bool success = true;
1248 
1249   // Set the default triple for this CompilerInvocation. This might be
1250   // overridden by users with `-triple` (see the call to `ParseTargetArgs`
1251   // below).
1252   // NOTE: Like in Clang, it would be nice to use option marshalling
1253   // for this so that the entire logic for setting-up the triple is in one
1254   // place.
1255   invoc.getTargetOpts().triple =
1256       llvm::Triple::normalize(llvm::sys::getDefaultTargetTriple());
1257 
1258   // Parse the arguments
1259   const llvm::opt::OptTable &opts = clang::driver::getDriverOptTable();
1260   llvm::opt::Visibility visibilityMask(clang::driver::options::FC1Option);
1261   unsigned missingArgIndex, missingArgCount;
1262   llvm::opt::InputArgList args = opts.ParseArgs(
1263       commandLineArgs, missingArgIndex, missingArgCount, visibilityMask);
1264 
1265   // Check for missing argument error.
1266   if (missingArgCount) {
1267     diags.Report(clang::diag::err_drv_missing_argument)
1268         << args.getArgString(missingArgIndex) << missingArgCount;
1269     success = false;
1270   }
1271 
1272   // Issue errors on unknown arguments
1273   for (const auto *a : args.filtered(clang::driver::options::OPT_UNKNOWN)) {
1274     auto argString = a->getAsString(args);
1275     std::string nearest;
1276     if (opts.findNearest(argString, nearest, visibilityMask) > 1)
1277       diags.Report(clang::diag::err_drv_unknown_argument) << argString;
1278     else
1279       diags.Report(clang::diag::err_drv_unknown_argument_with_suggestion)
1280           << argString << nearest;
1281     success = false;
1282   }
1283 
1284   // -flang-experimental-hlfir
1285   if (args.hasArg(clang::driver::options::OPT_flang_experimental_hlfir) ||
1286       args.hasArg(clang::driver::options::OPT_emit_hlfir)) {
1287     invoc.loweringOpts.setLowerToHighLevelFIR(true);
1288   }
1289 
1290   // -flang-deprecated-no-hlfir
1291   if (args.hasArg(clang::driver::options::OPT_flang_deprecated_no_hlfir) &&
1292       !args.hasArg(clang::driver::options::OPT_emit_hlfir)) {
1293     if (args.hasArg(clang::driver::options::OPT_flang_experimental_hlfir)) {
1294       const unsigned diagID = diags.getCustomDiagID(
1295           clang::DiagnosticsEngine::Error,
1296           "Options '-flang-experimental-hlfir' and "
1297           "'-flang-deprecated-no-hlfir' cannot be both specified");
1298       diags.Report(diagID);
1299     }
1300     invoc.loweringOpts.setLowerToHighLevelFIR(false);
1301   }
1302 
1303   // -fno-ppc-native-vector-element-order
1304   if (args.hasArg(clang::driver::options::OPT_fno_ppc_native_vec_elem_order)) {
1305     invoc.loweringOpts.setNoPPCNativeVecElemOrder(true);
1306   }
1307 
1308   // -flang-experimental-integer-overflow
1309   if (args.hasArg(
1310           clang::driver::options::OPT_flang_experimental_integer_overflow)) {
1311     invoc.loweringOpts.setNSWOnLoopVarInc(true);
1312   }
1313 
1314   // Preserve all the remark options requested, i.e. -Rpass, -Rpass-missed or
1315   // -Rpass-analysis. This will be used later when processing and outputting the
1316   // remarks generated by LLVM in ExecuteCompilerInvocation.cpp.
1317   for (auto *a : args.filtered(clang::driver::options::OPT_R_Group)) {
1318     if (a->getOption().matches(clang::driver::options::OPT_R_value_Group))
1319       // This is -Rfoo=, where foo is the name of the diagnostic
1320       // group. Add only the remark option name to the diagnostics. e.g. for
1321       // -Rpass= we will add the string "pass".
1322       invoc.getDiagnosticOpts().Remarks.push_back(
1323           std::string(a->getOption().getName().drop_front(1).rtrim("=-")));
1324     else
1325       // If no regex was provided, add the provided value, e.g. for -Rpass add
1326       // the string "pass".
1327       invoc.getDiagnosticOpts().Remarks.push_back(a->getValue());
1328   }
1329 
1330   success &= parseFrontendArgs(invoc.getFrontendOpts(), args, diags);
1331   parseTargetArgs(invoc.getTargetOpts(), args);
1332   parsePreprocessorArgs(invoc.getPreprocessorOpts(), args);
1333   parseCodeGenArgs(invoc.getCodeGenOpts(), args, diags);
1334   success &= parseDebugArgs(invoc.getCodeGenOpts(), args, diags);
1335   success &= parseVectorLibArg(invoc.getCodeGenOpts(), args, diags);
1336   success &= parseSemaArgs(invoc, args, diags);
1337   success &= parseDialectArgs(invoc, args, diags);
1338   success &= parseOpenMPArgs(invoc, args, diags);
1339   success &= parseDiagArgs(invoc, args, diags);
1340 
1341   // Collect LLVM (-mllvm) and MLIR (-mmlir) options.
1342   // NOTE: Try to avoid adding any options directly to `llvmArgs` or
1343   // `mlirArgs`. Instead, you can use
1344   //    * `-mllvm <your-llvm-option>`, or
1345   //    * `-mmlir <your-mlir-option>`.
1346   invoc.frontendOpts.llvmArgs =
1347       args.getAllArgValues(clang::driver::options::OPT_mllvm);
1348   invoc.frontendOpts.mlirArgs =
1349       args.getAllArgValues(clang::driver::options::OPT_mmlir);
1350 
1351   success &= parseFloatingPointArgs(invoc, args, diags);
1352 
1353   success &= parseVScaleArgs(invoc, args, diags);
1354 
1355   success &= parseLinkerOptionsArgs(invoc, args, diags);
1356 
1357   // Set the string to be used as the return value of the COMPILER_OPTIONS
1358   // intrinsic of iso_fortran_env. This is either passed in from the parent
1359   // compiler driver invocation with an environment variable, or failing that
1360   // set to the command line arguments of the frontend driver invocation.
1361   invoc.allCompilerInvocOpts = std::string();
1362   llvm::raw_string_ostream os(invoc.allCompilerInvocOpts);
1363   char *compilerOptsEnv = std::getenv("FLANG_COMPILER_OPTIONS_STRING");
1364   if (compilerOptsEnv != nullptr) {
1365     os << compilerOptsEnv;
1366   } else {
1367     os << argv0 << ' ';
1368     for (auto it = commandLineArgs.begin(), e = commandLineArgs.end(); it != e;
1369          ++it) {
1370       os << ' ' << *it;
1371     }
1372   }
1373 
1374   invoc.setArgv0(argv0);
1375 
1376   return success;
1377 }
1378 
1379 void CompilerInvocation::collectMacroDefinitions() {
1380   auto &ppOpts = this->getPreprocessorOpts();
1381 
1382   for (unsigned i = 0, n = ppOpts.macros.size(); i != n; ++i) {
1383     llvm::StringRef macro = ppOpts.macros[i].first;
1384     bool isUndef = ppOpts.macros[i].second;
1385 
1386     std::pair<llvm::StringRef, llvm::StringRef> macroPair = macro.split('=');
1387     llvm::StringRef macroName = macroPair.first;
1388     llvm::StringRef macroBody = macroPair.second;
1389 
1390     // For an #undef'd macro, we only care about the name.
1391     if (isUndef) {
1392       parserOpts.predefinitions.emplace_back(macroName.str(),
1393                                              std::optional<std::string>{});
1394       continue;
1395     }
1396 
1397     // For a #define'd macro, figure out the actual definition.
1398     if (macroName.size() == macro.size())
1399       macroBody = "1";
1400     else {
1401       // Note: GCC drops anything following an end-of-line character.
1402       llvm::StringRef::size_type end = macroBody.find_first_of("\n\r");
1403       macroBody = macroBody.substr(0, end);
1404     }
1405     parserOpts.predefinitions.emplace_back(
1406         macroName, std::optional<std::string>(macroBody.str()));
1407   }
1408 }
1409 
1410 void CompilerInvocation::setDefaultFortranOpts() {
1411   auto &fortranOptions = getFortranOpts();
1412 
1413   std::vector<std::string> searchDirectories{"."s};
1414   fortranOptions.searchDirectories = searchDirectories;
1415 
1416   // Add the location of omp_lib.h to the search directories. Currently this is
1417   // identical to the modules' directory.
1418   fortranOptions.searchDirectories.emplace_back(
1419       getOpenMPHeadersDir(getArgv0()));
1420 
1421   fortranOptions.isFixedForm = false;
1422 }
1423 
1424 // TODO: When expanding this method, consider creating a dedicated API for
1425 // this. Also at some point we will need to differentiate between different
1426 // targets and add dedicated predefines for each.
1427 void CompilerInvocation::setDefaultPredefinitions() {
1428   auto &fortranOptions = getFortranOpts();
1429   const auto &frontendOptions = getFrontendOpts();
1430   // Populate the macro list with version numbers and other predefinitions.
1431   fortranOptions.predefinitions.emplace_back("__flang__", "1");
1432   fortranOptions.predefinitions.emplace_back("__flang_major__",
1433                                              FLANG_VERSION_MAJOR_STRING);
1434   fortranOptions.predefinitions.emplace_back("__flang_minor__",
1435                                              FLANG_VERSION_MINOR_STRING);
1436   fortranOptions.predefinitions.emplace_back("__flang_patchlevel__",
1437                                              FLANG_VERSION_PATCHLEVEL_STRING);
1438 
1439   // Add predefinitions based on extensions enabled
1440   if (frontendOptions.features.IsEnabled(
1441           Fortran::common::LanguageFeature::OpenACC)) {
1442     fortranOptions.predefinitions.emplace_back("_OPENACC", "202211");
1443   }
1444   if (frontendOptions.features.IsEnabled(
1445           Fortran::common::LanguageFeature::OpenMP)) {
1446     Fortran::common::setOpenMPMacro(getLangOpts().OpenMPVersion,
1447                                     fortranOptions.predefinitions);
1448   }
1449 
1450   llvm::Triple targetTriple{llvm::Triple(this->targetOpts.triple)};
1451   if (targetTriple.isPPC()) {
1452     // '__powerpc__' is a generic macro for any PowerPC cases. e.g. Max integer
1453     // size.
1454     fortranOptions.predefinitions.emplace_back("__powerpc__", "1");
1455   }
1456   if (targetTriple.isOSLinux()) {
1457     fortranOptions.predefinitions.emplace_back("__linux__", "1");
1458   }
1459 
1460   switch (targetTriple.getArch()) {
1461   default:
1462     break;
1463   case llvm::Triple::ArchType::x86_64:
1464     fortranOptions.predefinitions.emplace_back("__x86_64__", "1");
1465     fortranOptions.predefinitions.emplace_back("__x86_64", "1");
1466     break;
1467   }
1468 }
1469 
1470 void CompilerInvocation::setFortranOpts() {
1471   auto &fortranOptions = getFortranOpts();
1472   const auto &frontendOptions = getFrontendOpts();
1473   const auto &preprocessorOptions = getPreprocessorOpts();
1474   auto &moduleDirJ = getModuleDir();
1475 
1476   if (frontendOptions.fortranForm != FortranForm::Unknown) {
1477     fortranOptions.isFixedForm =
1478         frontendOptions.fortranForm == FortranForm::FixedForm;
1479   }
1480   fortranOptions.fixedFormColumns = frontendOptions.fixedFormColumns;
1481 
1482   fortranOptions.features = frontendOptions.features;
1483   fortranOptions.encoding = frontendOptions.encoding;
1484 
1485   // Adding search directories specified by -I
1486   fortranOptions.searchDirectories.insert(
1487       fortranOptions.searchDirectories.end(),
1488       preprocessorOptions.searchDirectoriesFromDashI.begin(),
1489       preprocessorOptions.searchDirectoriesFromDashI.end());
1490 
1491   // Add the ordered list of -intrinsic-modules-path
1492   fortranOptions.searchDirectories.insert(
1493       fortranOptions.searchDirectories.end(),
1494       preprocessorOptions.searchDirectoriesFromIntrModPath.begin(),
1495       preprocessorOptions.searchDirectoriesFromIntrModPath.end());
1496 
1497   //  Add the default intrinsic module directory
1498   fortranOptions.intrinsicModuleDirectories.emplace_back(
1499       getIntrinsicDir(getArgv0()));
1500 
1501   // Add the directory supplied through -J/-module-dir to the list of search
1502   // directories
1503   if (moduleDirJ != ".")
1504     fortranOptions.searchDirectories.emplace_back(moduleDirJ);
1505 
1506   if (frontendOptions.instrumentedParse)
1507     fortranOptions.instrumentedParse = true;
1508 
1509   if (frontendOptions.showColors)
1510     fortranOptions.showColors = true;
1511 
1512   if (frontendOptions.needProvenanceRangeToCharBlockMappings)
1513     fortranOptions.needProvenanceRangeToCharBlockMappings = true;
1514 
1515   if (getEnableConformanceChecks())
1516     fortranOptions.features.WarnOnAllNonstandard();
1517 
1518   if (getEnableUsageChecks())
1519     fortranOptions.features.WarnOnAllUsage();
1520 
1521   if (getDisableWarnings()) {
1522     fortranOptions.features.DisableAllNonstandardWarnings();
1523     fortranOptions.features.DisableAllUsageWarnings();
1524   }
1525 }
1526 
1527 std::unique_ptr<Fortran::semantics::SemanticsContext>
1528 CompilerInvocation::getSemanticsCtx(
1529     Fortran::parser::AllCookedSources &allCookedSources,
1530     const llvm::TargetMachine &targetMachine) {
1531   auto &fortranOptions = getFortranOpts();
1532 
1533   auto semanticsContext = std::make_unique<semantics::SemanticsContext>(
1534       getDefaultKinds(), fortranOptions.features, allCookedSources);
1535 
1536   semanticsContext->set_moduleDirectory(getModuleDir())
1537       .set_searchDirectories(fortranOptions.searchDirectories)
1538       .set_intrinsicModuleDirectories(fortranOptions.intrinsicModuleDirectories)
1539       .set_warningsAreErrors(getWarnAsErr())
1540       .set_moduleFileSuffix(getModuleFileSuffix())
1541       .set_underscoring(getCodeGenOpts().Underscoring);
1542 
1543   std::string compilerVersion = Fortran::common::getFlangFullVersion();
1544   Fortran::tools::setUpTargetCharacteristics(
1545       semanticsContext->targetCharacteristics(), targetMachine, getTargetOpts(),
1546       compilerVersion, allCompilerInvocOpts);
1547   return semanticsContext;
1548 }
1549 
1550 /// Set \p loweringOptions controlling lowering behavior based
1551 /// on the \p optimizationLevel.
1552 void CompilerInvocation::setLoweringOptions() {
1553   const CodeGenOptions &codegenOpts = getCodeGenOpts();
1554 
1555   // Lower TRANSPOSE as a runtime call under -O0.
1556   loweringOpts.setOptimizeTranspose(codegenOpts.OptimizationLevel > 0);
1557   loweringOpts.setUnderscoring(codegenOpts.Underscoring);
1558 
1559   const LangOptions &langOptions = getLangOpts();
1560   Fortran::common::MathOptionsBase &mathOpts = loweringOpts.getMathOptions();
1561   // TODO: when LangOptions are finalized, we can represent
1562   //       the math related options using Fortran::commmon::MathOptionsBase,
1563   //       so that we can just copy it into LoweringOptions.
1564   mathOpts
1565       .setFPContractEnabled(langOptions.getFPContractMode() ==
1566                             LangOptions::FPM_Fast)
1567       .setNoHonorInfs(langOptions.NoHonorInfs)
1568       .setNoHonorNaNs(langOptions.NoHonorNaNs)
1569       .setApproxFunc(langOptions.ApproxFunc)
1570       .setNoSignedZeros(langOptions.NoSignedZeros)
1571       .setAssociativeMath(langOptions.AssociativeMath)
1572       .setReciprocalMath(langOptions.ReciprocalMath);
1573 }
1574