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