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 #include "flang/Frontend/CompilerInvocation.h"
10 #include "flang/Common/Fortran-features.h"
11 #include "flang/Frontend/PreprocessorOptions.h"
12 #include "flang/Semantics/semantics.h"
13 #include "flang/Version.inc"
14 #include "clang/Basic/AllDiagnostics.h"
15 #include "clang/Basic/DiagnosticDriver.h"
16 #include "clang/Basic/DiagnosticOptions.h"
17 #include "clang/Driver/DriverDiagnostic.h"
18 #include "clang/Driver/Options.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ADT/StringSwitch.h"
21 #include "llvm/Option/Arg.h"
22 #include "llvm/Option/ArgList.h"
23 #include "llvm/Option/OptTable.h"
24 #include "llvm/Support/Process.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include <memory>
27 
28 using namespace Fortran::frontend;
29 
30 //===----------------------------------------------------------------------===//
31 // Initialization.
32 //===----------------------------------------------------------------------===//
33 CompilerInvocationBase::CompilerInvocationBase()
34     : diagnosticOpts_(new clang::DiagnosticOptions()),
35       preprocessorOpts_(new PreprocessorOptions()) {}
36 
37 CompilerInvocationBase::CompilerInvocationBase(const CompilerInvocationBase &x)
38     : diagnosticOpts_(new clang::DiagnosticOptions(x.GetDiagnosticOpts())),
39       preprocessorOpts_(new PreprocessorOptions(x.preprocessorOpts())) {}
40 
41 CompilerInvocationBase::~CompilerInvocationBase() = default;
42 
43 //===----------------------------------------------------------------------===//
44 // Deserialization (from args)
45 //===----------------------------------------------------------------------===//
46 static bool parseShowColorsArgs(
47     const llvm::opt::ArgList &args, bool defaultColor) {
48   // Color diagnostics default to auto ("on" if terminal supports) in the driver
49   // but default to off in cc1, needing an explicit OPT_fdiagnostics_color.
50   // Support both clang's -f[no-]color-diagnostics and gcc's
51   // -f[no-]diagnostics-colors[=never|always|auto].
52   enum {
53     Colors_On,
54     Colors_Off,
55     Colors_Auto
56   } ShowColors = defaultColor ? Colors_Auto : Colors_Off;
57 
58   for (auto *a : args) {
59     const llvm::opt::Option &O = a->getOption();
60     if (O.matches(clang::driver::options::OPT_fcolor_diagnostics) ||
61         O.matches(clang::driver::options::OPT_fdiagnostics_color)) {
62       ShowColors = Colors_On;
63     } else if (O.matches(clang::driver::options::OPT_fno_color_diagnostics) ||
64         O.matches(clang::driver::options::OPT_fno_diagnostics_color)) {
65       ShowColors = Colors_Off;
66     } else if (O.matches(clang::driver::options::OPT_fdiagnostics_color_EQ)) {
67       llvm::StringRef value(a->getValue());
68       if (value == "always")
69         ShowColors = Colors_On;
70       else if (value == "never")
71         ShowColors = Colors_Off;
72       else if (value == "auto")
73         ShowColors = Colors_Auto;
74     }
75   }
76 
77   return ShowColors == Colors_On ||
78       (ShowColors == Colors_Auto && llvm::sys::Process::StandardErrHasColors());
79 }
80 
81 bool Fortran::frontend::ParseDiagnosticArgs(clang::DiagnosticOptions &opts,
82     llvm::opt::ArgList &args, bool defaultDiagColor) {
83   opts.ShowColors = parseShowColorsArgs(args, defaultDiagColor);
84 
85   return true;
86 }
87 
88 static InputKind ParseFrontendArgs(FrontendOptions &opts,
89     llvm::opt::ArgList &args, clang::DiagnosticsEngine &diags) {
90 
91   // By default the frontend driver creates a ParseSyntaxOnly action.
92   opts.programAction_ = ParseSyntaxOnly;
93 
94   // Identify the action (i.e. opts.ProgramAction)
95   if (const llvm::opt::Arg *a =
96           args.getLastArg(clang::driver::options::OPT_Action_Group)) {
97     switch (a->getOption().getID()) {
98     default: {
99       llvm_unreachable("Invalid option in group!");
100     }
101     case clang::driver::options::OPT_test_io:
102       opts.programAction_ = InputOutputTest;
103       break;
104     case clang::driver::options::OPT_E:
105       opts.programAction_ = PrintPreprocessedInput;
106       break;
107     case clang::driver::options::OPT_fsyntax_only:
108       opts.programAction_ = ParseSyntaxOnly;
109       break;
110     case clang::driver::options::OPT_emit_obj:
111       opts.programAction_ = EmitObj;
112       break;
113     case clang::driver::options::OPT_fdebug_unparse:
114       opts.programAction_ = DebugUnparse;
115       break;
116     case clang::driver::options::OPT_fdebug_unparse_with_symbols:
117       opts.programAction_ = DebugUnparseWithSymbols;
118       break;
119 
120       // TODO:
121       // case calng::driver::options::OPT_emit_llvm:
122       // case clang::driver::options::OPT_emit_llvm_only:
123       // case clang::driver::options::OPT_emit_codegen_only:
124       // case clang::driver::options::OPT_emit_module:
125       // (...)
126     }
127   }
128 
129   opts.outputFile_ = args.getLastArgValue(clang::driver::options::OPT_o);
130   opts.showHelp_ = args.hasArg(clang::driver::options::OPT_help);
131   opts.showVersion_ = args.hasArg(clang::driver::options::OPT_version);
132 
133   // Get the input kind (from the value passed via `-x`)
134   InputKind dashX(Language::Unknown);
135   if (const llvm::opt::Arg *a =
136           args.getLastArg(clang::driver::options::OPT_x)) {
137     llvm::StringRef XValue = a->getValue();
138     // Principal languages.
139     dashX = llvm::StringSwitch<InputKind>(XValue)
140                 .Case("f90", Language::Fortran)
141                 .Default(Language::Unknown);
142 
143     // Some special cases cannot be combined with suffixes.
144     if (dashX.IsUnknown())
145       dashX = llvm::StringSwitch<InputKind>(XValue)
146                   .Case("ir", Language::LLVM_IR)
147                   .Default(Language::Unknown);
148 
149     if (dashX.IsUnknown())
150       diags.Report(clang::diag::err_drv_invalid_value)
151           << a->getAsString(args) << a->getValue();
152   }
153 
154   // Collect the input files and save them in our instance of FrontendOptions.
155   std::vector<std::string> inputs =
156       args.getAllArgValues(clang::driver::options::OPT_INPUT);
157   opts.inputs_.clear();
158   if (inputs.empty())
159     // '-' is the default input if none is given.
160     inputs.push_back("-");
161   for (unsigned i = 0, e = inputs.size(); i != e; ++i) {
162     InputKind ik = dashX;
163     if (ik.IsUnknown()) {
164       ik = FrontendOptions::GetInputKindForExtension(
165           llvm::StringRef(inputs[i]).rsplit('.').second);
166       if (ik.IsUnknown())
167         ik = Language::Unknown;
168       if (i == 0)
169         dashX = ik;
170     }
171 
172     opts.inputs_.emplace_back(std::move(inputs[i]), ik);
173   }
174 
175   // Set fortranForm_ based on options -ffree-form and -ffixed-form.
176   if (const auto *arg = args.getLastArg(clang::driver::options::OPT_ffixed_form,
177           clang::driver::options::OPT_ffree_form)) {
178     opts.fortranForm_ =
179         arg->getOption().matches(clang::driver::options::OPT_ffixed_form)
180         ? FortranForm::FixedForm
181         : FortranForm::FreeForm;
182   }
183 
184   // Set fixedFormColumns_ based on -ffixed-line-length=<value>
185   if (const auto *arg =
186           args.getLastArg(clang::driver::options::OPT_ffixed_line_length_EQ)) {
187     llvm::StringRef argValue = llvm::StringRef(arg->getValue());
188     std::int64_t columns = -1;
189     if (argValue == "none") {
190       columns = 0;
191     } else if (argValue.getAsInteger(/*Radix=*/10, columns)) {
192       columns = -1;
193     }
194     if (columns < 0) {
195       diags.Report(clang::diag::err_drv_invalid_value_with_suggestion)
196           << arg->getOption().getName() << arg->getValue()
197           << "value must be 'none' or a non-negative integer";
198     } else if (columns == 0) {
199       opts.fixedFormColumns_ = 1000000;
200     } else if (columns < 7) {
201       diags.Report(clang::diag::err_drv_invalid_value_with_suggestion)
202           << arg->getOption().getName() << arg->getValue()
203           << "value must be at least seven";
204     } else {
205       opts.fixedFormColumns_ = columns;
206     }
207   }
208 
209   // Extensions
210   if (args.hasArg(clang::driver::options::OPT_fopenacc)) {
211     opts.features_.Enable(Fortran::common::LanguageFeature::OpenACC);
212   }
213   if (args.hasArg(clang::driver::options::OPT_fopenmp)) {
214     opts.features_.Enable(Fortran::common::LanguageFeature::OpenMP);
215   }
216   if (const llvm::opt::Arg *arg =
217           args.getLastArg(clang::driver::options::OPT_fimplicit_none,
218               clang::driver::options::OPT_fno_implicit_none)) {
219     opts.features_.Enable(
220         Fortran::common::LanguageFeature::ImplicitNoneTypeAlways,
221         arg->getOption().matches(clang::driver::options::OPT_fimplicit_none));
222   }
223   if (const llvm::opt::Arg *arg =
224           args.getLastArg(clang::driver::options::OPT_fbackslash,
225               clang::driver::options::OPT_fno_backslash)) {
226     opts.features_.Enable(Fortran::common::LanguageFeature::BackslashEscapes,
227         arg->getOption().matches(clang::driver::options::OPT_fbackslash));
228   }
229   if (const llvm::opt::Arg *arg =
230           args.getLastArg(clang::driver::options::OPT_flogical_abbreviations,
231               clang::driver::options::OPT_fno_logical_abbreviations)) {
232     opts.features_.Enable(
233         Fortran::common::LanguageFeature::LogicalAbbreviations,
234         arg->getOption().matches(
235             clang::driver::options::OPT_flogical_abbreviations));
236   }
237   if (const llvm::opt::Arg *arg =
238           args.getLastArg(clang::driver::options::OPT_fxor_operator,
239               clang::driver::options::OPT_fno_xor_operator)) {
240     opts.features_.Enable(Fortran::common::LanguageFeature::XOROperator,
241         arg->getOption().matches(clang::driver::options::OPT_fxor_operator));
242   }
243   if (args.hasArg(
244           clang::driver::options::OPT_falternative_parameter_statement)) {
245     opts.features_.Enable(Fortran::common::LanguageFeature::OldStyleParameter);
246   }
247   if (const llvm::opt::Arg *arg =
248           args.getLastArg(clang::driver::options::OPT_finput_charset_EQ)) {
249     llvm::StringRef argValue = arg->getValue();
250     if (argValue == "utf-8") {
251       opts.encoding_ = Fortran::parser::Encoding::UTF_8;
252     } else if (argValue == "latin-1") {
253       opts.encoding_ = Fortran::parser::Encoding::LATIN_1;
254     } else {
255       diags.Report(clang::diag::err_drv_invalid_value)
256           << arg->getAsString(args) << argValue;
257     }
258   }
259   return dashX;
260 }
261 
262 /// Parses all preprocessor input arguments and populates the preprocessor
263 /// options accordingly.
264 ///
265 /// \param [in] opts The preprocessor options instance
266 /// \param [out] args The list of input arguments
267 static void parsePreprocessorArgs(
268     Fortran::frontend::PreprocessorOptions &opts, llvm::opt::ArgList &args) {
269   // Add macros from the command line.
270   for (const auto *currentArg : args.filtered(
271            clang::driver::options::OPT_D, clang::driver::options::OPT_U)) {
272     if (currentArg->getOption().matches(clang::driver::options::OPT_D)) {
273       opts.addMacroDef(currentArg->getValue());
274     } else {
275       opts.addMacroUndef(currentArg->getValue());
276     }
277   }
278 
279   // Add the ordered list of -I's.
280   for (const auto *currentArg : args.filtered(clang::driver::options::OPT_I))
281     opts.searchDirectoriesFromDashI.emplace_back(currentArg->getValue());
282 }
283 
284 /// Parses all semantic related arguments and populates the variables
285 /// options accordingly.
286 static void parseSemaArgs(std::string &moduleDir, llvm::opt::ArgList &args,
287     clang::DiagnosticsEngine &diags) {
288 
289   auto moduleDirList =
290       args.getAllArgValues(clang::driver::options::OPT_module_dir);
291   // User can only specify -J/-module-dir once
292   // https://gcc.gnu.org/onlinedocs/gfortran/Directory-Options.html
293   if (moduleDirList.size() > 1) {
294     const unsigned diagID =
295         diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
296             "Only one '-module-dir/-J' option allowed");
297     diags.Report(diagID);
298   }
299   if (moduleDirList.size() == 1)
300     moduleDir = moduleDirList[0];
301 }
302 
303 bool CompilerInvocation::CreateFromArgs(CompilerInvocation &res,
304     llvm::ArrayRef<const char *> commandLineArgs,
305     clang::DiagnosticsEngine &diags) {
306 
307   bool success = true;
308 
309   // Parse the arguments
310   const llvm::opt::OptTable &opts = clang::driver::getDriverOptTable();
311   const unsigned includedFlagsBitmask = clang::driver::options::FC1Option;
312   unsigned missingArgIndex, missingArgCount;
313   llvm::opt::InputArgList args = opts.ParseArgs(
314       commandLineArgs, missingArgIndex, missingArgCount, includedFlagsBitmask);
315 
316   // Issue errors on unknown arguments
317   for (const auto *a : args.filtered(clang::driver::options::OPT_UNKNOWN)) {
318     auto argString = a->getAsString(args);
319     std::string nearest;
320     if (opts.findNearest(argString, nearest, includedFlagsBitmask) > 1)
321       diags.Report(clang::diag::err_drv_unknown_argument) << argString;
322     else
323       diags.Report(clang::diag::err_drv_unknown_argument_with_suggestion)
324           << argString << nearest;
325     success = false;
326   }
327 
328   // Parse the frontend args
329   ParseFrontendArgs(res.frontendOpts(), args, diags);
330   // Parse the preprocessor args
331   parsePreprocessorArgs(res.preprocessorOpts(), args);
332   // Parse semantic args
333   parseSemaArgs(res.moduleDir(), args, diags);
334 
335   return success;
336 }
337 
338 /// Collect the macro definitions provided by the given preprocessor
339 /// options into the parser options.
340 ///
341 /// \param [in] ppOpts The preprocessor options
342 /// \param [out] opts The fortran options
343 static void collectMacroDefinitions(
344     const PreprocessorOptions &ppOpts, Fortran::parser::Options &opts) {
345   for (unsigned i = 0, n = ppOpts.macros.size(); i != n; ++i) {
346     llvm::StringRef macro = ppOpts.macros[i].first;
347     bool isUndef = ppOpts.macros[i].second;
348 
349     std::pair<llvm::StringRef, llvm::StringRef> macroPair = macro.split('=');
350     llvm::StringRef macroName = macroPair.first;
351     llvm::StringRef macroBody = macroPair.second;
352 
353     // For an #undef'd macro, we only care about the name.
354     if (isUndef) {
355       opts.predefinitions.emplace_back(
356           macroName.str(), std::optional<std::string>{});
357       continue;
358     }
359 
360     // For a #define'd macro, figure out the actual definition.
361     if (macroName.size() == macro.size())
362       macroBody = "1";
363     else {
364       // Note: GCC drops anything following an end-of-line character.
365       llvm::StringRef::size_type End = macroBody.find_first_of("\n\r");
366       macroBody = macroBody.substr(0, End);
367     }
368     opts.predefinitions.emplace_back(
369         macroName, std::optional<std::string>(macroBody.str()));
370   }
371 }
372 
373 void CompilerInvocation::SetDefaultFortranOpts() {
374   auto &fortranOptions = fortranOpts();
375 
376   // These defaults are based on the defaults in f18/f18.cpp.
377   std::vector<std::string> searchDirectories{"."s};
378   fortranOptions.searchDirectories = searchDirectories;
379   fortranOptions.isFixedForm = false;
380 }
381 
382 // TODO: When expanding this method, consider creating a dedicated API for
383 // this. Also at some point we will need to differentiate between different
384 // targets and add dedicated predefines for each.
385 void CompilerInvocation::setDefaultPredefinitions() {
386   auto &fortranOptions = fortranOpts();
387   const auto &frontendOptions = frontendOpts();
388 
389   // Populate the macro list with version numbers and other predefinitions.
390   fortranOptions.predefinitions.emplace_back("__flang__", "1");
391   fortranOptions.predefinitions.emplace_back(
392       "__flang_major__", FLANG_VERSION_MAJOR_STRING);
393   fortranOptions.predefinitions.emplace_back(
394       "__flang_minor__", FLANG_VERSION_MINOR_STRING);
395   fortranOptions.predefinitions.emplace_back(
396       "__flang_patchlevel__", FLANG_VERSION_PATCHLEVEL_STRING);
397 
398   // Add predefinitions based on extensions enabled
399   if (frontendOptions.features_.IsEnabled(
400           Fortran::common::LanguageFeature::OpenACC)) {
401     fortranOptions.predefinitions.emplace_back("_OPENACC", "202011");
402   }
403   if (frontendOptions.features_.IsEnabled(
404           Fortran::common::LanguageFeature::OpenMP)) {
405     fortranOptions.predefinitions.emplace_back("_OPENMP", "201511");
406   }
407 }
408 
409 void CompilerInvocation::setFortranOpts() {
410   auto &fortranOptions = fortranOpts();
411   const auto &frontendOptions = frontendOpts();
412   const auto &preprocessorOptions = preprocessorOpts();
413   auto &moduleDirJ = moduleDir();
414 
415   if (frontendOptions.fortranForm_ != FortranForm::Unknown) {
416     fortranOptions.isFixedForm =
417         frontendOptions.fortranForm_ == FortranForm::FixedForm;
418   }
419   fortranOptions.fixedFormColumns = frontendOptions.fixedFormColumns_;
420 
421   fortranOptions.features = frontendOptions.features_;
422   fortranOptions.encoding = frontendOptions.encoding_;
423 
424   collectMacroDefinitions(preprocessorOptions, fortranOptions);
425 
426   fortranOptions.searchDirectories.insert(
427       fortranOptions.searchDirectories.end(),
428       preprocessorOptions.searchDirectoriesFromDashI.begin(),
429       preprocessorOptions.searchDirectoriesFromDashI.end());
430 
431   // Add the directory supplied through -J/-module-dir to the list of search
432   // directories
433   if (moduleDirJ.compare(".") != 0)
434     fortranOptions.searchDirectories.emplace_back(moduleDirJ);
435 }
436 
437 void CompilerInvocation::setSemanticsOpts(
438     Fortran::parser::AllCookedSources &allCookedSources) {
439   const auto &fortranOptions = fortranOpts();
440 
441   semanticsContext_ = std::make_unique<semantics::SemanticsContext>(
442       *(new Fortran::common::IntrinsicTypeDefaultKinds()),
443       fortranOptions.features, allCookedSources);
444 
445   auto &moduleDirJ = moduleDir();
446   semanticsContext_->set_moduleDirectory(moduleDirJ)
447       .set_searchDirectories(fortranOptions.searchDirectories);
448 }
449