xref: /llvm-project/flang/lib/Frontend/CompilerInvocation.cpp (revision 40d8c0666f19599c16e5345abee371d016409c12) 
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/Frontend/CodeGenOptions.h"
16 #include "flang/Frontend/PreprocessorOptions.h"
17 #include "flang/Frontend/TargetOptions.h"
18 #include "flang/Semantics/semantics.h"
19 #include "flang/Version.inc"
20 #include "clang/Basic/AllDiagnostics.h"
21 #include "clang/Basic/DiagnosticDriver.h"
22 #include "clang/Basic/DiagnosticOptions.h"
23 #include "clang/Driver/DriverDiagnostic.h"
24 #include "clang/Driver/OptionUtils.h"
25 #include "clang/Driver/Options.h"
26 #include "llvm/ADT/StringRef.h"
27 #include "llvm/ADT/StringSwitch.h"
28 #include "llvm/ADT/Triple.h"
29 #include "llvm/Option/Arg.h"
30 #include "llvm/Option/ArgList.h"
31 #include "llvm/Option/OptTable.h"
32 #include "llvm/Support/FileSystem.h"
33 #include "llvm/Support/FileUtilities.h"
34 #include "llvm/Support/Host.h"
35 #include "llvm/Support/Path.h"
36 #include "llvm/Support/Process.h"
37 #include "llvm/Support/raw_ostream.h"
38 #include <memory>
39 #include <optional>
40 
41 using namespace Fortran::frontend;
42 
43 //===----------------------------------------------------------------------===//
44 // Initialization.
45 //===----------------------------------------------------------------------===//
46 CompilerInvocationBase::CompilerInvocationBase()
47     : diagnosticOpts(new clang::DiagnosticOptions()),
48       preprocessorOpts(new PreprocessorOptions()) {}
49 
50 CompilerInvocationBase::CompilerInvocationBase(const CompilerInvocationBase &x)
51     : diagnosticOpts(new clang::DiagnosticOptions(x.getDiagnosticOpts())),
52       preprocessorOpts(new PreprocessorOptions(x.getPreprocessorOpts())) {}
53 
54 CompilerInvocationBase::~CompilerInvocationBase() = default;
55 
56 //===----------------------------------------------------------------------===//
57 // Deserialization (from args)
58 //===----------------------------------------------------------------------===//
59 static bool parseShowColorsArgs(const llvm::opt::ArgList &args,
60                                 bool defaultColor = true) {
61   // Color diagnostics default to auto ("on" if terminal supports) in the
62   // compiler driver `flang-new` but default to off in the frontend driver
63   // `flang-new -fc1`, needing an explicit OPT_fdiagnostics_color.
64   // Support both clang's -f[no-]color-diagnostics and gcc's
65   // -f[no-]diagnostics-colors[=never|always|auto].
66   enum {
67     Colors_On,
68     Colors_Off,
69     Colors_Auto
70   } showColors = defaultColor ? Colors_Auto : Colors_Off;
71 
72   for (auto *a : args) {
73     const llvm::opt::Option &opt = a->getOption();
74     if (opt.matches(clang::driver::options::OPT_fcolor_diagnostics)) {
75       showColors = Colors_On;
76     } else if (opt.matches(clang::driver::options::OPT_fno_color_diagnostics)) {
77       showColors = Colors_Off;
78     } else if (opt.matches(clang::driver::options::OPT_fdiagnostics_color_EQ)) {
79       llvm::StringRef value(a->getValue());
80       if (value == "always")
81         showColors = Colors_On;
82       else if (value == "never")
83         showColors = Colors_Off;
84       else if (value == "auto")
85         showColors = Colors_Auto;
86     }
87   }
88 
89   return showColors == Colors_On ||
90          (showColors == Colors_Auto &&
91           llvm::sys::Process::StandardErrHasColors());
92 }
93 
94 /// Extracts the optimisation level from \a args.
95 static unsigned getOptimizationLevel(llvm::opt::ArgList &args,
96                                      clang::DiagnosticsEngine &diags) {
97   unsigned defaultOpt = llvm::CodeGenOpt::None;
98 
99   if (llvm::opt::Arg *a =
100           args.getLastArg(clang::driver::options::OPT_O_Group)) {
101     if (a->getOption().matches(clang::driver::options::OPT_O0))
102       return llvm::CodeGenOpt::None;
103 
104     assert(a->getOption().matches(clang::driver::options::OPT_O));
105 
106     return getLastArgIntValue(args, clang::driver::options::OPT_O, defaultOpt,
107                               diags);
108   }
109 
110   return defaultOpt;
111 }
112 
113 bool Fortran::frontend::parseDiagnosticArgs(clang::DiagnosticOptions &opts,
114                                             llvm::opt::ArgList &args) {
115   opts.ShowColors = parseShowColorsArgs(args);
116 
117   return true;
118 }
119 
120 static void parseCodeGenArgs(Fortran::frontend::CodeGenOptions &opts,
121                              llvm::opt::ArgList &args,
122                              clang::DiagnosticsEngine &diags) {
123   opts.OptimizationLevel = getOptimizationLevel(args, diags);
124 
125   if (args.hasFlag(clang::driver::options::OPT_fdebug_pass_manager,
126                    clang::driver::options::OPT_fno_debug_pass_manager, false))
127     opts.DebugPassManager = 1;
128 
129   for (auto *a : args.filtered(clang::driver::options::OPT_fpass_plugin_EQ))
130     opts.LLVMPassPlugins.push_back(a->getValue());
131 
132   // -fembed-offload-object option
133   for (auto *a :
134        args.filtered(clang::driver::options::OPT_fembed_offload_object_EQ))
135     opts.OffloadObjects.push_back(a->getValue());
136 
137   // -mrelocation-model option.
138   if (const llvm::opt::Arg *A =
139           args.getLastArg(clang::driver::options::OPT_mrelocation_model)) {
140     llvm::StringRef ModelName = A->getValue();
141     auto RM = llvm::StringSwitch<std::optional<llvm::Reloc::Model>>(ModelName)
142                   .Case("static", llvm::Reloc::Static)
143                   .Case("pic", llvm::Reloc::PIC_)
144                   .Case("dynamic-no-pic", llvm::Reloc::DynamicNoPIC)
145                   .Case("ropi", llvm::Reloc::ROPI)
146                   .Case("rwpi", llvm::Reloc::RWPI)
147                   .Case("ropi-rwpi", llvm::Reloc::ROPI_RWPI)
148                   .Default(std::nullopt);
149     if (RM.has_value())
150       opts.setRelocationModel(*RM);
151     else
152       diags.Report(clang::diag::err_drv_invalid_value)
153           << A->getAsString(args) << ModelName;
154   }
155 
156   // -pic-level and -pic-is-pie option.
157   if (int PICLevel = getLastArgIntValue(
158           args, clang::driver::options::OPT_pic_level, 0, diags)) {
159     if (PICLevel > 2)
160       diags.Report(clang::diag::err_drv_invalid_value)
161           << args.getLastArg(clang::driver::options::OPT_pic_level)
162                  ->getAsString(args)
163           << PICLevel;
164 
165     opts.PICLevel = PICLevel;
166     if (args.hasArg(clang::driver::options::OPT_pic_is_pie))
167       opts.IsPIE = 1;
168   }
169 }
170 
171 /// Parses all target input arguments and populates the target
172 /// options accordingly.
173 ///
174 /// \param [in] opts The target options instance to update
175 /// \param [in] args The list of input arguments (from the compiler invocation)
176 static void parseTargetArgs(TargetOptions &opts, llvm::opt::ArgList &args) {
177   if (const llvm::opt::Arg *a =
178           args.getLastArg(clang::driver::options::OPT_triple))
179     opts.triple = a->getValue();
180 
181   if (const llvm::opt::Arg *a =
182           args.getLastArg(clang::driver::options::OPT_target_cpu))
183     opts.cpu = a->getValue();
184 
185   for (const llvm::opt::Arg *currentArg :
186        args.filtered(clang::driver::options::OPT_target_feature))
187     opts.featuresAsWritten.emplace_back(currentArg->getValue());
188 }
189 
190 // Tweak the frontend configuration based on the frontend action
191 static void setUpFrontendBasedOnAction(FrontendOptions &opts) {
192   if (opts.programAction == DebugDumpParsingLog)
193     opts.instrumentedParse = true;
194 
195   if (opts.programAction == DebugDumpProvenance ||
196       opts.programAction == Fortran::frontend::GetDefinition)
197     opts.needProvenanceRangeToCharBlockMappings = true;
198 }
199 
200 /// Parse the argument specified for the -fconvert=<value> option
201 static std::optional<const char *> parseConvertArg(const char *s) {
202   return llvm::StringSwitch<std::optional<const char *>>(s)
203       .Case("unknown", "UNKNOWN")
204       .Case("native", "NATIVE")
205       .Case("little-endian", "LITTLE_ENDIAN")
206       .Case("big-endian", "BIG_ENDIAN")
207       .Case("swap", "SWAP")
208       .Default(std::nullopt);
209 }
210 
211 static bool parseFrontendArgs(FrontendOptions &opts, llvm::opt::ArgList &args,
212                               clang::DiagnosticsEngine &diags) {
213   unsigned numErrorsBefore = diags.getNumErrors();
214 
215   // By default the frontend driver creates a ParseSyntaxOnly action.
216   opts.programAction = ParseSyntaxOnly;
217 
218   // Treat multiple action options as an invocation error. Note that `clang
219   // -cc1` does accept multiple action options, but will only consider the
220   // rightmost one.
221   if (args.hasMultipleArgs(clang::driver::options::OPT_Action_Group)) {
222     const unsigned diagID = diags.getCustomDiagID(
223         clang::DiagnosticsEngine::Error, "Only one action option is allowed");
224     diags.Report(diagID);
225     return false;
226   }
227 
228   // Identify the action (i.e. opts.ProgramAction)
229   if (const llvm::opt::Arg *a =
230           args.getLastArg(clang::driver::options::OPT_Action_Group)) {
231     switch (a->getOption().getID()) {
232     default: {
233       llvm_unreachable("Invalid option in group!");
234     }
235     case clang::driver::options::OPT_test_io:
236       opts.programAction = InputOutputTest;
237       break;
238     case clang::driver::options::OPT_E:
239       opts.programAction = PrintPreprocessedInput;
240       break;
241     case clang::driver::options::OPT_fsyntax_only:
242       opts.programAction = ParseSyntaxOnly;
243       break;
244     case clang::driver::options::OPT_emit_mlir:
245       opts.programAction = EmitMLIR;
246       break;
247     case clang::driver::options::OPT_emit_llvm:
248       opts.programAction = EmitLLVM;
249       break;
250     case clang::driver::options::OPT_emit_llvm_bc:
251       opts.programAction = EmitLLVMBitcode;
252       break;
253     case clang::driver::options::OPT_emit_obj:
254       opts.programAction = EmitObj;
255       break;
256     case clang::driver::options::OPT_S:
257       opts.programAction = EmitAssembly;
258       break;
259     case clang::driver::options::OPT_fdebug_unparse:
260       opts.programAction = DebugUnparse;
261       break;
262     case clang::driver::options::OPT_fdebug_unparse_no_sema:
263       opts.programAction = DebugUnparseNoSema;
264       break;
265     case clang::driver::options::OPT_fdebug_unparse_with_symbols:
266       opts.programAction = DebugUnparseWithSymbols;
267       break;
268     case clang::driver::options::OPT_fdebug_dump_symbols:
269       opts.programAction = DebugDumpSymbols;
270       break;
271     case clang::driver::options::OPT_fdebug_dump_parse_tree:
272       opts.programAction = DebugDumpParseTree;
273       break;
274     case clang::driver::options::OPT_fdebug_dump_pft:
275       opts.programAction = DebugDumpPFT;
276       break;
277     case clang::driver::options::OPT_fdebug_dump_all:
278       opts.programAction = DebugDumpAll;
279       break;
280     case clang::driver::options::OPT_fdebug_dump_parse_tree_no_sema:
281       opts.programAction = DebugDumpParseTreeNoSema;
282       break;
283     case clang::driver::options::OPT_fdebug_dump_provenance:
284       opts.programAction = DebugDumpProvenance;
285       break;
286     case clang::driver::options::OPT_fdebug_dump_parsing_log:
287       opts.programAction = DebugDumpParsingLog;
288       break;
289     case clang::driver::options::OPT_fdebug_measure_parse_tree:
290       opts.programAction = DebugMeasureParseTree;
291       break;
292     case clang::driver::options::OPT_fdebug_pre_fir_tree:
293       opts.programAction = DebugPreFIRTree;
294       break;
295     case clang::driver::options::OPT_fget_symbols_sources:
296       opts.programAction = GetSymbolsSources;
297       break;
298     case clang::driver::options::OPT_fget_definition:
299       opts.programAction = GetDefinition;
300       break;
301     case clang::driver::options::OPT_init_only:
302       opts.programAction = InitOnly;
303       break;
304 
305       // TODO:
306       // case clang::driver::options::OPT_emit_llvm:
307       // case clang::driver::options::OPT_emit_llvm_only:
308       // case clang::driver::options::OPT_emit_codegen_only:
309       // case clang::driver::options::OPT_emit_module:
310       // (...)
311     }
312 
313     // Parse the values provided with `-fget-definition` (there should be 3
314     // integers)
315     if (llvm::opt::OptSpecifier(a->getOption().getID()) ==
316         clang::driver::options::OPT_fget_definition) {
317       unsigned optVals[3] = {0, 0, 0};
318 
319       for (unsigned i = 0; i < 3; i++) {
320         llvm::StringRef val = a->getValue(i);
321 
322         if (val.getAsInteger(10, optVals[i])) {
323           // A non-integer was encountered - that's an error.
324           diags.Report(clang::diag::err_drv_invalid_value)
325               << a->getOption().getName() << val;
326           break;
327         }
328       }
329       opts.getDefVals.line = optVals[0];
330       opts.getDefVals.startColumn = optVals[1];
331       opts.getDefVals.endColumn = optVals[2];
332     }
333   }
334 
335   // Parsing -load <dsopath> option and storing shared object path
336   if (llvm::opt::Arg *a = args.getLastArg(clang::driver::options::OPT_load)) {
337     opts.plugins.push_back(a->getValue());
338   }
339 
340   // Parsing -plugin <name> option and storing plugin name and setting action
341   if (const llvm::opt::Arg *a =
342           args.getLastArg(clang::driver::options::OPT_plugin)) {
343     opts.programAction = PluginAction;
344     opts.actionName = a->getValue();
345   }
346 
347   opts.outputFile = args.getLastArgValue(clang::driver::options::OPT_o);
348   opts.showHelp = args.hasArg(clang::driver::options::OPT_help);
349   opts.showVersion = args.hasArg(clang::driver::options::OPT_version);
350 
351   // Get the input kind (from the value passed via `-x`)
352   InputKind dashX(Language::Unknown);
353   if (const llvm::opt::Arg *a =
354           args.getLastArg(clang::driver::options::OPT_x)) {
355     llvm::StringRef xValue = a->getValue();
356     // Principal languages.
357     dashX = llvm::StringSwitch<InputKind>(xValue)
358                 // Flang does not differentiate between pre-processed and not
359                 // pre-processed inputs.
360                 .Case("f95", Language::Fortran)
361                 .Case("f95-cpp-input", Language::Fortran)
362                 .Default(Language::Unknown);
363 
364     // Flang's intermediate representations.
365     if (dashX.isUnknown())
366       dashX = llvm::StringSwitch<InputKind>(xValue)
367                   .Case("ir", Language::LLVM_IR)
368                   .Case("fir", Language::MLIR)
369                   .Case("mlir", Language::MLIR)
370                   .Default(Language::Unknown);
371 
372     if (dashX.isUnknown())
373       diags.Report(clang::diag::err_drv_invalid_value)
374           << a->getAsString(args) << a->getValue();
375   }
376 
377   // Collect the input files and save them in our instance of FrontendOptions.
378   std::vector<std::string> inputs =
379       args.getAllArgValues(clang::driver::options::OPT_INPUT);
380   opts.inputs.clear();
381   if (inputs.empty())
382     // '-' is the default input if none is given.
383     inputs.push_back("-");
384   for (unsigned i = 0, e = inputs.size(); i != e; ++i) {
385     InputKind ik = dashX;
386     if (ik.isUnknown()) {
387       ik = FrontendOptions::getInputKindForExtension(
388           llvm::StringRef(inputs[i]).rsplit('.').second);
389       if (ik.isUnknown())
390         ik = Language::Unknown;
391       if (i == 0)
392         dashX = ik;
393     }
394 
395     opts.inputs.emplace_back(std::move(inputs[i]), ik);
396   }
397 
398   // Set fortranForm based on options -ffree-form and -ffixed-form.
399   if (const auto *arg =
400           args.getLastArg(clang::driver::options::OPT_ffixed_form,
401                           clang::driver::options::OPT_ffree_form)) {
402     opts.fortranForm =
403         arg->getOption().matches(clang::driver::options::OPT_ffixed_form)
404             ? FortranForm::FixedForm
405             : FortranForm::FreeForm;
406   }
407 
408   // Set fixedFormColumns based on -ffixed-line-length=<value>
409   if (const auto *arg =
410           args.getLastArg(clang::driver::options::OPT_ffixed_line_length_EQ)) {
411     llvm::StringRef argValue = llvm::StringRef(arg->getValue());
412     std::int64_t columns = -1;
413     if (argValue == "none") {
414       columns = 0;
415     } else if (argValue.getAsInteger(/*Radix=*/10, columns)) {
416       columns = -1;
417     }
418     if (columns < 0) {
419       diags.Report(clang::diag::err_drv_negative_columns)
420           << arg->getOption().getName() << arg->getValue();
421     } else if (columns == 0) {
422       opts.fixedFormColumns = 1000000;
423     } else if (columns < 7) {
424       diags.Report(clang::diag::err_drv_small_columns)
425           << arg->getOption().getName() << arg->getValue() << "7";
426     } else {
427       opts.fixedFormColumns = columns;
428     }
429   }
430 
431   // Set conversion based on -fconvert=<value>
432   if (const auto *arg =
433           args.getLastArg(clang::driver::options::OPT_fconvert_EQ)) {
434     const char *argValue = arg->getValue();
435     if (auto convert = parseConvertArg(argValue))
436       opts.envDefaults.push_back({"FORT_CONVERT", *convert});
437     else
438       diags.Report(clang::diag::err_drv_invalid_value)
439           << arg->getAsString(args) << argValue;
440   }
441 
442   // -f{no-}implicit-none
443   opts.features.Enable(
444       Fortran::common::LanguageFeature::ImplicitNoneTypeAlways,
445       args.hasFlag(clang::driver::options::OPT_fimplicit_none,
446                    clang::driver::options::OPT_fno_implicit_none, false));
447 
448   // -f{no-}backslash
449   opts.features.Enable(Fortran::common::LanguageFeature::BackslashEscapes,
450                        args.hasFlag(clang::driver::options::OPT_fbackslash,
451                                     clang::driver::options::OPT_fno_backslash,
452                                     false));
453 
454   // -f{no-}logical-abbreviations
455   opts.features.Enable(
456       Fortran::common::LanguageFeature::LogicalAbbreviations,
457       args.hasFlag(clang::driver::options::OPT_flogical_abbreviations,
458                    clang::driver::options::OPT_fno_logical_abbreviations,
459                    false));
460 
461   // -f{no-}xor-operator
462   opts.features.Enable(
463       Fortran::common::LanguageFeature::XOROperator,
464       args.hasFlag(clang::driver::options::OPT_fxor_operator,
465                    clang::driver::options::OPT_fno_xor_operator, false));
466 
467   // -fno-automatic
468   if (args.hasArg(clang::driver::options::OPT_fno_automatic)) {
469     opts.features.Enable(Fortran::common::LanguageFeature::DefaultSave);
470   }
471 
472   if (args.hasArg(
473           clang::driver::options::OPT_falternative_parameter_statement)) {
474     opts.features.Enable(Fortran::common::LanguageFeature::OldStyleParameter);
475   }
476   if (const llvm::opt::Arg *arg =
477           args.getLastArg(clang::driver::options::OPT_finput_charset_EQ)) {
478     llvm::StringRef argValue = arg->getValue();
479     if (argValue == "utf-8") {
480       opts.encoding = Fortran::parser::Encoding::UTF_8;
481     } else if (argValue == "latin-1") {
482       opts.encoding = Fortran::parser::Encoding::LATIN_1;
483     } else {
484       diags.Report(clang::diag::err_drv_invalid_value)
485           << arg->getAsString(args) << argValue;
486     }
487   }
488 
489   setUpFrontendBasedOnAction(opts);
490   opts.dashX = dashX;
491 
492   return diags.getNumErrors() == numErrorsBefore;
493 }
494 
495 // Generate the path to look for intrinsic modules
496 static std::string getIntrinsicDir() {
497   // TODO: Find a system independent API
498   llvm::SmallString<128> driverPath;
499   driverPath.assign(llvm::sys::fs::getMainExecutable(nullptr, nullptr));
500   llvm::sys::path::remove_filename(driverPath);
501   driverPath.append("/../include/flang/");
502   return std::string(driverPath);
503 }
504 
505 // Generate the path to look for OpenMP headers
506 static std::string getOpenMPHeadersDir() {
507   llvm::SmallString<128> includePath;
508   includePath.assign(llvm::sys::fs::getMainExecutable(nullptr, nullptr));
509   llvm::sys::path::remove_filename(includePath);
510   includePath.append("/../include/flang/OpenMP/");
511   return std::string(includePath);
512 }
513 
514 /// Parses all preprocessor input arguments and populates the preprocessor
515 /// options accordingly.
516 ///
517 /// \param [in] opts The preprocessor options instance
518 /// \param [out] args The list of input arguments
519 static void parsePreprocessorArgs(Fortran::frontend::PreprocessorOptions &opts,
520                                   llvm::opt::ArgList &args) {
521   // Add macros from the command line.
522   for (const auto *currentArg : args.filtered(clang::driver::options::OPT_D,
523                                               clang::driver::options::OPT_U)) {
524     if (currentArg->getOption().matches(clang::driver::options::OPT_D)) {
525       opts.addMacroDef(currentArg->getValue());
526     } else {
527       opts.addMacroUndef(currentArg->getValue());
528     }
529   }
530 
531   // Add the ordered list of -I's.
532   for (const auto *currentArg : args.filtered(clang::driver::options::OPT_I))
533     opts.searchDirectoriesFromDashI.emplace_back(currentArg->getValue());
534 
535   // Prepend the ordered list of -intrinsic-modules-path
536   // to the default location to search.
537   for (const auto *currentArg :
538        args.filtered(clang::driver::options::OPT_fintrinsic_modules_path))
539     opts.searchDirectoriesFromIntrModPath.emplace_back(currentArg->getValue());
540 
541   // -cpp/-nocpp
542   if (const auto *currentArg = args.getLastArg(
543           clang::driver::options::OPT_cpp, clang::driver::options::OPT_nocpp))
544     opts.macrosFlag =
545         (currentArg->getOption().matches(clang::driver::options::OPT_cpp))
546             ? PPMacrosFlag::Include
547             : PPMacrosFlag::Exclude;
548 
549   opts.noReformat = args.hasArg(clang::driver::options::OPT_fno_reformat);
550   opts.noLineDirectives = args.hasArg(clang::driver::options::OPT_P);
551 }
552 
553 /// Parses all semantic related arguments and populates the variables
554 /// options accordingly. Returns false if new errors are generated.
555 static bool parseSemaArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
556                           clang::DiagnosticsEngine &diags) {
557   unsigned numErrorsBefore = diags.getNumErrors();
558 
559   // -J/module-dir option
560   auto moduleDirList =
561       args.getAllArgValues(clang::driver::options::OPT_module_dir);
562   // User can only specify -J/-module-dir once
563   // https://gcc.gnu.org/onlinedocs/gfortran/Directory-Options.html
564   if (moduleDirList.size() > 1) {
565     const unsigned diagID =
566         diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
567                               "Only one '-module-dir/-J' option allowed");
568     diags.Report(diagID);
569   }
570   if (moduleDirList.size() == 1)
571     res.setModuleDir(moduleDirList[0]);
572 
573   // -fdebug-module-writer option
574   if (args.hasArg(clang::driver::options::OPT_fdebug_module_writer)) {
575     res.setDebugModuleDir(true);
576   }
577 
578   // -module-suffix
579   if (const auto *moduleSuffix =
580           args.getLastArg(clang::driver::options::OPT_module_suffix)) {
581     res.setModuleFileSuffix(moduleSuffix->getValue());
582   }
583 
584   // -f{no-}analyzed-objects-for-unparse
585   res.setUseAnalyzedObjectsForUnparse(args.hasFlag(
586       clang::driver::options::OPT_fanalyzed_objects_for_unparse,
587       clang::driver::options::OPT_fno_analyzed_objects_for_unparse, true));
588 
589   return diags.getNumErrors() == numErrorsBefore;
590 }
591 
592 /// Parses all diagnostics related arguments and populates the variables
593 /// options accordingly. Returns false if new errors are generated.
594 static bool parseDiagArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
595                           clang::DiagnosticsEngine &diags) {
596   unsigned numErrorsBefore = diags.getNumErrors();
597 
598   // -Werror option
599   // TODO: Currently throws a Diagnostic for anything other than -W<error>,
600   // this has to change when other -W<opt>'s are supported.
601   if (args.hasArg(clang::driver::options::OPT_W_Joined)) {
602     if (args.getLastArgValue(clang::driver::options::OPT_W_Joined)
603             .equals("error")) {
604       res.setWarnAsErr(true);
605     } else {
606       const unsigned diagID =
607           diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
608                                 "Only `-Werror` is supported currently.");
609       diags.Report(diagID);
610     }
611   }
612 
613   // Default to off for `flang-new -fc1`.
614   res.getFrontendOpts().showColors =
615       parseShowColorsArgs(args, /*defaultDiagColor=*/false);
616 
617   return diags.getNumErrors() == numErrorsBefore;
618 }
619 
620 /// Parses all Dialect related arguments and populates the variables
621 /// options accordingly. Returns false if new errors are generated.
622 static bool parseDialectArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
623                              clang::DiagnosticsEngine &diags) {
624   unsigned numErrorsBefore = diags.getNumErrors();
625 
626   // -fdefault* family
627   if (args.hasArg(clang::driver::options::OPT_fdefault_real_8)) {
628     res.getDefaultKinds().set_defaultRealKind(8);
629     res.getDefaultKinds().set_doublePrecisionKind(16);
630   }
631   if (args.hasArg(clang::driver::options::OPT_fdefault_integer_8)) {
632     res.getDefaultKinds().set_defaultIntegerKind(8);
633     res.getDefaultKinds().set_subscriptIntegerKind(8);
634     res.getDefaultKinds().set_sizeIntegerKind(8);
635   }
636   if (args.hasArg(clang::driver::options::OPT_fdefault_double_8)) {
637     if (!args.hasArg(clang::driver::options::OPT_fdefault_real_8)) {
638       // -fdefault-double-8 has to be used with -fdefault-real-8
639       // to be compatible with gfortran
640       const unsigned diagID = diags.getCustomDiagID(
641           clang::DiagnosticsEngine::Error,
642           "Use of `-fdefault-double-8` requires `-fdefault-real-8`");
643       diags.Report(diagID);
644     }
645     // https://gcc.gnu.org/onlinedocs/gfortran/Fortran-Dialect-Options.html
646     res.getDefaultKinds().set_doublePrecisionKind(8);
647   }
648   if (args.hasArg(clang::driver::options::OPT_flarge_sizes))
649     res.getDefaultKinds().set_sizeIntegerKind(8);
650 
651   // -fopenmp and -fopenacc
652   if (args.hasArg(clang::driver::options::OPT_fopenacc)) {
653     res.getFrontendOpts().features.Enable(
654         Fortran::common::LanguageFeature::OpenACC);
655   }
656   if (args.hasArg(clang::driver::options::OPT_fopenmp)) {
657     res.getFrontendOpts().features.Enable(
658         Fortran::common::LanguageFeature::OpenMP);
659   }
660 
661   // -pedantic
662   if (args.hasArg(clang::driver::options::OPT_pedantic)) {
663     res.setEnableConformanceChecks();
664   }
665   // -std=f2018 (currently this implies -pedantic)
666   // TODO: Set proper options when more fortran standards
667   // are supported.
668   if (args.hasArg(clang::driver::options::OPT_std_EQ)) {
669     auto standard = args.getLastArgValue(clang::driver::options::OPT_std_EQ);
670     // We only allow f2018 as the given standard
671     if (standard.equals("f2018")) {
672       res.setEnableConformanceChecks();
673     } else {
674       const unsigned diagID =
675           diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
676                                 "Only -std=f2018 is allowed currently.");
677       diags.Report(diagID);
678     }
679   }
680   return diags.getNumErrors() == numErrorsBefore;
681 }
682 
683 /// Parses all floating point related arguments and populates the
684 /// CompilerInvocation accordingly.
685 /// Returns false if new errors are generated.
686 ///
687 /// \param [out] invoc Stores the processed arguments
688 /// \param [in] args The compiler invocation arguments to parse
689 /// \param [out] diags DiagnosticsEngine to report erros with
690 static bool parseFloatingPointArgs(CompilerInvocation &invoc,
691                                    llvm::opt::ArgList &args,
692                                    clang::DiagnosticsEngine &diags) {
693   LangOptions &opts = invoc.getLangOpts();
694 
695   if (const llvm::opt::Arg *a =
696           args.getLastArg(clang::driver::options::OPT_ffp_contract)) {
697     const llvm::StringRef val = a->getValue();
698     enum LangOptions::FPModeKind fpContractMode;
699 
700     if (val == "off")
701       fpContractMode = LangOptions::FPM_Off;
702     else if (val == "fast")
703       fpContractMode = LangOptions::FPM_Fast;
704     else {
705       diags.Report(clang::diag::err_drv_unsupported_option_argument)
706           << a->getSpelling() << val;
707       return false;
708     }
709 
710     opts.setFPContractMode(fpContractMode);
711   }
712 
713   if (args.getLastArg(clang::driver::options::OPT_menable_no_infinities)) {
714     opts.NoHonorInfs = true;
715   }
716 
717   if (args.getLastArg(clang::driver::options::OPT_menable_no_nans)) {
718     opts.NoHonorNaNs = true;
719   }
720 
721   if (args.getLastArg(clang::driver::options::OPT_fapprox_func)) {
722     opts.ApproxFunc = true;
723   }
724 
725   if (args.getLastArg(clang::driver::options::OPT_fno_signed_zeros)) {
726     opts.NoSignedZeros = true;
727   }
728 
729   if (args.getLastArg(clang::driver::options::OPT_mreassociate)) {
730     opts.AssociativeMath = true;
731   }
732 
733   if (args.getLastArg(clang::driver::options::OPT_freciprocal_math)) {
734     opts.ReciprocalMath = true;
735   }
736 
737   if (args.getLastArg(clang::driver::options::OPT_ffast_math)) {
738     opts.NoHonorInfs = true;
739     opts.NoHonorNaNs = true;
740     opts.AssociativeMath = true;
741     opts.ReciprocalMath = true;
742     opts.ApproxFunc = true;
743     opts.NoSignedZeros = true;
744     opts.setFPContractMode(LangOptions::FPM_Fast);
745   }
746 
747   return true;
748 }
749 
750 bool CompilerInvocation::createFromArgs(
751     CompilerInvocation &res, llvm::ArrayRef<const char *> commandLineArgs,
752     clang::DiagnosticsEngine &diags) {
753 
754   bool success = true;
755 
756   // Set the default triple for this CompilerInvocation. This might be
757   // overridden by users with `-triple` (see the call to `ParseTargetArgs`
758   // below).
759   // NOTE: Like in Clang, it would be nice to use option marshalling
760   // for this so that the entire logic for setting-up the triple is in one
761   // place.
762   res.getTargetOpts().triple =
763       llvm::Triple::normalize(llvm::sys::getDefaultTargetTriple());
764 
765   // Parse the arguments
766   const llvm::opt::OptTable &opts = clang::driver::getDriverOptTable();
767   const unsigned includedFlagsBitmask = clang::driver::options::FC1Option;
768   unsigned missingArgIndex, missingArgCount;
769   llvm::opt::InputArgList args = opts.ParseArgs(
770       commandLineArgs, missingArgIndex, missingArgCount, includedFlagsBitmask);
771 
772   // Check for missing argument error.
773   if (missingArgCount) {
774     diags.Report(clang::diag::err_drv_missing_argument)
775         << args.getArgString(missingArgIndex) << missingArgCount;
776     success = false;
777   }
778 
779   // Issue errors on unknown arguments
780   for (const auto *a : args.filtered(clang::driver::options::OPT_UNKNOWN)) {
781     auto argString = a->getAsString(args);
782     std::string nearest;
783     if (opts.findNearest(argString, nearest, includedFlagsBitmask) > 1)
784       diags.Report(clang::diag::err_drv_unknown_argument) << argString;
785     else
786       diags.Report(clang::diag::err_drv_unknown_argument_with_suggestion)
787           << argString << nearest;
788     success = false;
789   }
790 
791   success &= parseFrontendArgs(res.getFrontendOpts(), args, diags);
792   parseTargetArgs(res.getTargetOpts(), args);
793   parsePreprocessorArgs(res.getPreprocessorOpts(), args);
794   parseCodeGenArgs(res.getCodeGenOpts(), args, diags);
795   success &= parseSemaArgs(res, args, diags);
796   success &= parseDialectArgs(res, args, diags);
797   success &= parseDiagArgs(res, args, diags);
798   res.frontendOpts.llvmArgs =
799       args.getAllArgValues(clang::driver::options::OPT_mllvm);
800 
801   res.frontendOpts.mlirArgs =
802       args.getAllArgValues(clang::driver::options::OPT_mmlir);
803 
804   success &= parseFloatingPointArgs(res, args, diags);
805 
806   return success;
807 }
808 
809 void CompilerInvocation::collectMacroDefinitions() {
810   auto &ppOpts = this->getPreprocessorOpts();
811 
812   for (unsigned i = 0, n = ppOpts.macros.size(); i != n; ++i) {
813     llvm::StringRef macro = ppOpts.macros[i].first;
814     bool isUndef = ppOpts.macros[i].second;
815 
816     std::pair<llvm::StringRef, llvm::StringRef> macroPair = macro.split('=');
817     llvm::StringRef macroName = macroPair.first;
818     llvm::StringRef macroBody = macroPair.second;
819 
820     // For an #undef'd macro, we only care about the name.
821     if (isUndef) {
822       parserOpts.predefinitions.emplace_back(macroName.str(),
823                                              std::optional<std::string>{});
824       continue;
825     }
826 
827     // For a #define'd macro, figure out the actual definition.
828     if (macroName.size() == macro.size())
829       macroBody = "1";
830     else {
831       // Note: GCC drops anything following an end-of-line character.
832       llvm::StringRef::size_type end = macroBody.find_first_of("\n\r");
833       macroBody = macroBody.substr(0, end);
834     }
835     parserOpts.predefinitions.emplace_back(
836         macroName, std::optional<std::string>(macroBody.str()));
837   }
838 }
839 
840 void CompilerInvocation::setDefaultFortranOpts() {
841   auto &fortranOptions = getFortranOpts();
842 
843   std::vector<std::string> searchDirectories{"."s};
844   fortranOptions.searchDirectories = searchDirectories;
845 
846   // Add the location of omp_lib.h to the search directories. Currently this is
847   // identical to the modules' directory.
848   fortranOptions.searchDirectories.emplace_back(getOpenMPHeadersDir());
849 
850   fortranOptions.isFixedForm = false;
851 }
852 
853 // TODO: When expanding this method, consider creating a dedicated API for
854 // this. Also at some point we will need to differentiate between different
855 // targets and add dedicated predefines for each.
856 void CompilerInvocation::setDefaultPredefinitions() {
857   auto &fortranOptions = getFortranOpts();
858   const auto &frontendOptions = getFrontendOpts();
859 
860   // Populate the macro list with version numbers and other predefinitions.
861   fortranOptions.predefinitions.emplace_back("__flang__", "1");
862   fortranOptions.predefinitions.emplace_back("__flang_major__",
863                                              FLANG_VERSION_MAJOR_STRING);
864   fortranOptions.predefinitions.emplace_back("__flang_minor__",
865                                              FLANG_VERSION_MINOR_STRING);
866   fortranOptions.predefinitions.emplace_back("__flang_patchlevel__",
867                                              FLANG_VERSION_PATCHLEVEL_STRING);
868 
869   // Add predefinitions based on extensions enabled
870   if (frontendOptions.features.IsEnabled(
871           Fortran::common::LanguageFeature::OpenACC)) {
872     fortranOptions.predefinitions.emplace_back("_OPENACC", "202011");
873   }
874   if (frontendOptions.features.IsEnabled(
875           Fortran::common::LanguageFeature::OpenMP)) {
876     fortranOptions.predefinitions.emplace_back("_OPENMP", "201511");
877   }
878   llvm::Triple targetTriple{llvm::Triple(this->targetOpts.triple)};
879   if (targetTriple.getArch() == llvm::Triple::ArchType::x86_64) {
880     fortranOptions.predefinitions.emplace_back("__x86_64__", "1");
881     fortranOptions.predefinitions.emplace_back("__x86_64", "1");
882   }
883 }
884 
885 void CompilerInvocation::setFortranOpts() {
886   auto &fortranOptions = getFortranOpts();
887   const auto &frontendOptions = getFrontendOpts();
888   const auto &preprocessorOptions = getPreprocessorOpts();
889   auto &moduleDirJ = getModuleDir();
890 
891   if (frontendOptions.fortranForm != FortranForm::Unknown) {
892     fortranOptions.isFixedForm =
893         frontendOptions.fortranForm == FortranForm::FixedForm;
894   }
895   fortranOptions.fixedFormColumns = frontendOptions.fixedFormColumns;
896 
897   fortranOptions.features = frontendOptions.features;
898   fortranOptions.encoding = frontendOptions.encoding;
899 
900   // Adding search directories specified by -I
901   fortranOptions.searchDirectories.insert(
902       fortranOptions.searchDirectories.end(),
903       preprocessorOptions.searchDirectoriesFromDashI.begin(),
904       preprocessorOptions.searchDirectoriesFromDashI.end());
905 
906   // Add the ordered list of -intrinsic-modules-path
907   fortranOptions.searchDirectories.insert(
908       fortranOptions.searchDirectories.end(),
909       preprocessorOptions.searchDirectoriesFromIntrModPath.begin(),
910       preprocessorOptions.searchDirectoriesFromIntrModPath.end());
911 
912   //  Add the default intrinsic module directory
913   fortranOptions.intrinsicModuleDirectories.emplace_back(getIntrinsicDir());
914 
915   // Add the directory supplied through -J/-module-dir to the list of search
916   // directories
917   if (moduleDirJ != ".")
918     fortranOptions.searchDirectories.emplace_back(moduleDirJ);
919 
920   if (frontendOptions.instrumentedParse)
921     fortranOptions.instrumentedParse = true;
922 
923   if (frontendOptions.showColors)
924     fortranOptions.showColors = true;
925 
926   if (frontendOptions.needProvenanceRangeToCharBlockMappings)
927     fortranOptions.needProvenanceRangeToCharBlockMappings = true;
928 
929   if (getEnableConformanceChecks()) {
930     fortranOptions.features.WarnOnAllNonstandard();
931   }
932 }
933 
934 void CompilerInvocation::setSemanticsOpts(
935     Fortran::parser::AllCookedSources &allCookedSources) {
936   auto &fortranOptions = getFortranOpts();
937 
938   semanticsContext = std::make_unique<semantics::SemanticsContext>(
939       getDefaultKinds(), fortranOptions.features, allCookedSources);
940 
941   semanticsContext->set_moduleDirectory(getModuleDir())
942       .set_searchDirectories(fortranOptions.searchDirectories)
943       .set_intrinsicModuleDirectories(fortranOptions.intrinsicModuleDirectories)
944       .set_warnOnNonstandardUsage(getEnableConformanceChecks())
945       .set_warningsAreErrors(getWarnAsErr())
946       .set_moduleFileSuffix(getModuleFileSuffix());
947 
948   llvm::Triple targetTriple{llvm::Triple(this->targetOpts.triple)};
949   // FIXME: Handle real(3) ?
950   if (targetTriple.getArch() != llvm::Triple::ArchType::x86_64) {
951     semanticsContext->targetCharacteristics().DisableType(
952         Fortran::common::TypeCategory::Real, /*kind=*/10);
953   }
954 }
955 
956 /// Set \p loweringOptions controlling lowering behavior based
957 /// on the \p optimizationLevel.
958 void CompilerInvocation::setLoweringOptions() {
959   const CodeGenOptions &codegenOpts = getCodeGenOpts();
960 
961   // Lower TRANSPOSE as a runtime call under -O0.
962   loweringOpts.setOptimizeTranspose(codegenOpts.OptimizationLevel > 0);
963 
964   const LangOptions &langOptions = getLangOpts();
965   Fortran::common::MathOptionsBase &mathOpts = loweringOpts.getMathOptions();
966   // TODO: when LangOptions are finalized, we can represent
967   //       the math related options using Fortran::commmon::MathOptionsBase,
968   //       so that we can just copy it into LoweringOptions.
969   mathOpts
970       .setFPContractEnabled(langOptions.getFPContractMode() ==
971                             LangOptions::FPM_Fast)
972       .setNoHonorInfs(langOptions.NoHonorInfs)
973       .setNoHonorNaNs(langOptions.NoHonorNaNs)
974       .setApproxFunc(langOptions.ApproxFunc)
975       .setNoSignedZeros(langOptions.NoSignedZeros)
976       .setAssociativeMath(langOptions.AssociativeMath)
977       .setReciprocalMath(langOptions.ReciprocalMath);
978 }
979