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