FarisRehman created this revision.
Herald added a reviewer: sscalpone.
Herald added a subscriber: dang.
FarisRehman requested review of this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.
Add support for options -D and -U in the Flang driver along with a regression
test for them.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D93401
Files:
clang/include/clang/Driver/Options.td
clang/lib/Driver/ToolChains/Flang.cpp
flang/include/flang/Frontend/CompilerInstance.h
flang/include/flang/Frontend/CompilerInvocation.h
flang/include/flang/Frontend/PreprocessorOptions.h
flang/lib/Frontend/CompilerInstance.cpp
flang/lib/Frontend/CompilerInvocation.cpp
flang/test/Flang-Driver/driver-help-hidden.f90
flang/test/Flang-Driver/driver-help.f90
flang/test/Flang-Driver/macro.f90
Index: flang/test/Flang-Driver/macro.f90
===================================================================
--- /dev/null
+++ flang/test/Flang-Driver/macro.f90
@@ -0,0 +1,49 @@
+! Ensure arguments -D and -U work as expected.
+
+! REQUIRES: new-flang-driver
+
+!--------------------------
+! FLANG DRIVER (flang-new)
+!--------------------------
+! RUN: %flang-new -E %s 2>&1 | FileCheck %s --check-prefix=UNDEFINED
+! RUN: %flang-new -E -DNEW %s 2>&1 | FileCheck %s --check-prefix=DEFINED
+! RUN: %flang-new -E -DNEW -UNEW %s 2>&1 | FileCheck %s --check-prefix=UNDEFINED
+
+!-----------------------------------------
+! FRONTEND FLANG DRIVER (flang-new -fc1)
+!-----------------------------------------
+! RUN: %flang-new -fc1 -E %s 2>&1 | FileCheck %s --check-prefix=UNDEFINED
+! RUN: %flang-new -fc1 -E -DNEW %s 2>&1 | FileCheck %s --check-prefix=DEFINED
+! RUN: %flang-new -fc1 -E -DNEW -UNEW %s 2>&1 | FileCheck %s --check-prefix=UNDEFINED
+
+
+!--------------------------------------------
+! EXPECTED OUTPUT FOR MACRO 'NEW' UNDEFINED
+!--------------------------------------------
+! flang-new -E %s
+! flang-new -E -DNEW -UNEW %s
+! UNDEFINED:program b
+! UNDEFINED-NOT:program a
+! UNDEFINED-NEXT:x = 1
+! UNDEFINED-NEXT:write(*,*) x
+! UNDEFINED-NEXT:end
+
+!--------------------------------------------
+! EXPECTED OUTPUT FOR MACRO 'NEW' DEFINED
+!--------------------------------------------
+! flang-new -E -DNEW %s
+! DEFINED:program a
+! DEFINED-NOT:program b
+! DEFINED-NEXT:x = 1
+! DEFINED-NEXT:write(*,*) x
+! DEFINED-NEXT:end
+
+! Macro.F:
+#ifdef NEW
+program A
+#else
+program B
+#endif
+ x = 1
+ write(*,*) x
+end
\ No newline at end of file
Index: flang/test/Flang-Driver/driver-help.f90
===================================================================
--- flang/test/Flang-Driver/driver-help.f90
+++ flang/test/Flang-Driver/driver-help.f90
@@ -19,11 +19,13 @@
! HELP-EMPTY:
! HELP-NEXT:OPTIONS:
! HELP-NEXT: -### Print (but do not run) the commands to run for this compilation
+! HELP-NEXT: -D <macro>=<value> Define <macro> to <value> (or 1 if <value> omitted)
! HELP-NEXT: -E Only run the preprocessor
! HELP-NEXT: -fcolor-diagnostics Enable colors in diagnostics
! HELP-NEXT: -fno-color-diagnostics Disable colors in diagnostics
! HELP-NEXT: -help Display available options
! HELP-NEXT: -o <file> Write output to <file>
+! HELP-NEXT: -U <macro> Undefine macro <macro>
! HELP-NEXT: --version Print version information
!-------------------------------------------------------------
@@ -32,10 +34,12 @@
! HELP-FC1:USAGE: flang-new
! HELP-FC1-EMPTY:
! HELP-FC1-NEXT:OPTIONS:
-! HELP-FC1-NEXT: -E Only run the preprocessor
-! HELP-FC1-NEXT: -help Display available options
-! HELP-FC1-NEXT: -o <file> Write output to <file>
-! HELP-FC1-NEXT: --version Print version information
+! HELP-FC1-NEXT: -D <macro>=<value> Define <macro> to <value> (or 1 if <value> omitted)
+! HELP-FC1-NEXT: -E Only run the preprocessor
+! HELP-FC1-NEXT: -help Display available options
+! HELP-FC1-NEXT: -o <file> Write output to <file>
+! HELP-FC1-NEXT: -U <macro> Undefine macro <macro>
+! HELP-FC1-NEXT: --version Print version information
!---------------
! EXPECTED ERROR
Index: flang/test/Flang-Driver/driver-help-hidden.f90
===================================================================
--- flang/test/Flang-Driver/driver-help-hidden.f90
+++ flang/test/Flang-Driver/driver-help-hidden.f90
@@ -19,12 +19,14 @@
! CHECK-EMPTY:
! CHECK-NEXT:OPTIONS:
! CHECK-NEXT: -### Print (but do not run) the commands to run for this compilation
+! CHECK-NEXT: -D <macro>=<value> Define <macro> to <value> (or 1 if <value> omitted)
! CHECK-NEXT: -E Only run the preprocessor
! CHECK-NEXT: -fcolor-diagnostics Enable colors in diagnostics
! CHECK-NEXT: -fno-color-diagnostics Disable colors in diagnostics
! CHECK-NEXT: -help Display available options
! CHECK-NEXT: -o <file> Write output to <file>
! CHECK-NEXT: -test-io Run the InputOuputTest action. Use for development and testing only.
+! CHECK-NEXT: -U <macro> Undefine macro <macro>
! CHECK-NEXT: --version Print version information
!-------------------------------------------------------------
Index: flang/lib/Frontend/CompilerInvocation.cpp
===================================================================
--- flang/lib/Frontend/CompilerInvocation.cpp
+++ flang/lib/Frontend/CompilerInvocation.cpp
@@ -7,6 +7,7 @@
//===----------------------------------------------------------------------===//
#include "flang/Frontend/CompilerInvocation.h"
+#include "flang/Frontend/PreprocessorOptions.h"
#include "clang/Basic/AllDiagnostics.h"
#include "clang/Basic/DiagnosticDriver.h"
#include "clang/Basic/DiagnosticOptions.h"
@@ -26,10 +27,11 @@
// Initialization.
//===----------------------------------------------------------------------===//
CompilerInvocationBase::CompilerInvocationBase()
- : diagnosticOpts_(new clang::DiagnosticOptions()) {}
+ : diagnosticOpts_(new clang::DiagnosticOptions()), preprocessorOpts_() {}
CompilerInvocationBase::CompilerInvocationBase(const CompilerInvocationBase &x)
- : diagnosticOpts_(new clang::DiagnosticOptions(x.GetDiagnosticOpts())) {}
+ : diagnosticOpts_(new clang::DiagnosticOptions(x.GetDiagnosticOpts())),
+ preprocessorOpts_(x.preprocessorOpts()) {}
CompilerInvocationBase::~CompilerInvocationBase() = default;
@@ -152,6 +154,19 @@
return dashX;
}
+static void ParsePreprocessorArgs(
+ Fortran::frontend::PreprocessorOptions &opts, llvm::opt::ArgList &args) {
+ // Add macros from the command line.
+ for (const auto *A : args.filtered(
+ clang::driver::options::OPT_D, clang::driver::options::OPT_U)) {
+ if (A->getOption().matches(clang::driver::options::OPT_D)) {
+ opts.addMacroDef(A->getValue());
+ } else {
+ opts.addMacroUndef(A->getValue());
+ }
+ }
+}
+
bool CompilerInvocation::CreateFromArgs(CompilerInvocation &res,
llvm::ArrayRef<const char *> commandLineArgs,
clang::DiagnosticsEngine &diags) {
@@ -180,15 +195,52 @@
// Parse the frontend args
ParseFrontendArgs(res.frontendOpts(), args, diags);
+ // Parse the preprocessor args
+ ParsePreprocessorArgs(res.preprocessorOpts(), args);
return success;
}
-void CompilerInvocation::SetDefaultFortranOpts() {
+/// Collect the macro definitions provided by the given preprocessor
+/// options into the parser options.
+void collectMacroDefinitions(
+ Fortran::parser::Options &opts, const PreprocessorOptions &ppOpts) {
+ for (unsigned I = 0, N = ppOpts.Macros.size(); I != N; ++I) {
+ llvm::StringRef Macro = ppOpts.Macros[I].first;
+ bool IsUndef = ppOpts.Macros[I].second;
+
+ std::pair<llvm::StringRef, llvm::StringRef> MacroPair = Macro.split('=');
+ llvm::StringRef MacroName = MacroPair.first;
+ llvm::StringRef MacroBody = MacroPair.second;
+
+ // For an #undef'd macro, we only care about the name.
+ if (IsUndef) {
+ opts.predefinitions.emplace_back(
+ MacroName.str(), std::optional<std::string>{});
+ continue;
+ }
+
+ // For a #define'd macro, figure out the actual definition.
+ if (MacroName.size() == Macro.size())
+ MacroBody = "1";
+ else {
+ // Note: GCC drops anything following an end-of-line character.
+ llvm::StringRef::size_type End = MacroBody.find_first_of("\n\r");
+ MacroBody = MacroBody.substr(0, End);
+ }
+ opts.predefinitions.emplace_back(
+ MacroName, std::optional<std::string>(MacroBody.str()));
+ }
+}
+
+void CompilerInvocation::SetFortranOpts() {
auto &fortranOptions = fortranOpts();
+ const auto &preprocessorOptions = preprocessorOpts();
// These defaults are based on the defaults in f18/f18.cpp.
std::vector<std::string> searchDirectories{"."s};
fortranOptions.searchDirectories = searchDirectories;
fortranOptions.isFixedForm = false;
+
+ collectMacroDefinitions(fortranOptions, preprocessorOptions);
}
Index: flang/lib/Frontend/CompilerInstance.cpp
===================================================================
--- flang/lib/Frontend/CompilerInstance.cpp
+++ flang/lib/Frontend/CompilerInstance.cpp
@@ -129,7 +129,7 @@
// Set some sane defaults for the frontend.
// TODO: Instead of defaults we should be setting these options based on the
// user input.
- this->invocation().SetDefaultFortranOpts();
+ this->invocation().SetFortranOpts();
// Connect Input to a CompileInstance
for (const FrontendInputFile &fif : frontendOpts().inputs_) {
Index: flang/include/flang/Frontend/PreprocessorOptions.h
===================================================================
--- /dev/null
+++ flang/include/flang/Frontend/PreprocessorOptions.h
@@ -0,0 +1,28 @@
+#ifndef LLVM_FLANG_PREPROCESSOROPTIONS_H
+#define LLVM_FLANG_PREPROCESSOROPTIONS_H
+
+#include "llvm/ADT/StringRef.h"
+
+namespace Fortran::frontend {
+
+/// PreprocessorOptions - This class is used for passing the various options
+/// used in preprocessor initialization to the parser options.
+class PreprocessorOptions {
+public:
+ std::vector<std::pair<std::string, bool /*isUndef*/>> Macros;
+
+public:
+ PreprocessorOptions() {}
+
+ void addMacroDef(llvm::StringRef Name) {
+ Macros.emplace_back(std::string(Name), false);
+ }
+
+ void addMacroUndef(llvm::StringRef Name) {
+ Macros.emplace_back(std::string(Name), true);
+ }
+};
+
+} // namespace Fortran::frontend
+
+#endif // LLVM_FLANG_PREPROCESSOROPTIONS_H
\ No newline at end of file
Index: flang/include/flang/Frontend/CompilerInvocation.h
===================================================================
--- flang/include/flang/Frontend/CompilerInvocation.h
+++ flang/include/flang/Frontend/CompilerInvocation.h
@@ -9,6 +9,7 @@
#define LLVM_FLANG_FRONTEND_COMPILERINVOCATION_H
#include "flang/Frontend/FrontendOptions.h"
+#include "flang/Frontend/PreprocessorOptions.h"
#include "flang/Parser/parsing.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/DiagnosticOptions.h"
@@ -28,6 +29,8 @@
/// Options controlling the diagnostic engine.
llvm::IntrusiveRefCntPtr<clang::DiagnosticOptions> diagnosticOpts_;
+ Fortran::frontend::PreprocessorOptions preprocessorOpts_;
+
CompilerInvocationBase();
CompilerInvocationBase(const CompilerInvocationBase &x);
~CompilerInvocationBase();
@@ -38,6 +41,11 @@
const clang::DiagnosticOptions &GetDiagnosticOpts() const {
return *diagnosticOpts_.get();
}
+
+ PreprocessorOptions &preprocessorOpts() { return preprocessorOpts_; }
+ const PreprocessorOptions &preprocessorOpts() const {
+ return preprocessorOpts_;
+ }
};
class CompilerInvocation : public CompilerInvocationBase {
@@ -73,7 +81,7 @@
// TODO: We should map frontendOpts_ to parserOpts_ instead. For that, we
// need to extend frontendOpts_ first. Next, we need to add the corresponding
// compiler driver options in libclangDriver.
- void SetDefaultFortranOpts();
+ void SetFortranOpts();
};
} // end namespace Fortran::frontend
Index: flang/include/flang/Frontend/CompilerInstance.h
===================================================================
--- flang/include/flang/Frontend/CompilerInstance.h
+++ flang/include/flang/Frontend/CompilerInstance.h
@@ -10,6 +10,7 @@
#include "flang/Frontend/CompilerInvocation.h"
#include "flang/Frontend/FrontendAction.h"
+#include "flang/Frontend/PreprocessorOptions.h"
#include "flang/Parser/parsing.h"
#include "flang/Parser/provenance.h"
#include "llvm/Support/raw_ostream.h"
@@ -110,6 +111,13 @@
return invocation_->frontendOpts();
}
+ PreprocessorOptions &preprocessorOpts() {
+ return invocation_->preprocessorOpts();
+ }
+ const PreprocessorOptions &preprocessorOpts() const {
+ return invocation_->preprocessorOpts();
+ }
+
/// }
/// @name Diagnostics Engine
/// {
Index: clang/lib/Driver/ToolChains/Flang.cpp
===================================================================
--- clang/lib/Driver/ToolChains/Flang.cpp
+++ clang/lib/Driver/ToolChains/Flang.cpp
@@ -26,8 +26,11 @@
const llvm::Triple &Triple = TC.getEffectiveTriple();
const std::string &TripleStr = Triple.getTriple();
+ const auto &D = C.getDriver();
ArgStringList CmdArgs;
+ const InputInfo &Input = Inputs[0];
+
CmdArgs.push_back("-fc1");
// TODO: Eventually all actions will require a triple (e.g. `-triple
@@ -63,6 +66,12 @@
assert(false && "Unexpected action class for Flang tool.");
}
+ types::ID InputType = Input.getType();
+ if (types::getPreprocessedType(InputType) != types::TY_INVALID) {
+ Args.AddAllArgs(CmdArgs, {options::OPT_D, options::OPT_U});
+ }
+ Args.ClaimAllArgs(options::OPT_D);
+
if (Output.isFilename()) {
CmdArgs.push_back("-o");
CmdArgs.push_back(Output.getFilename());
@@ -70,11 +79,9 @@
assert(Output.isNothing() && "Invalid output.");
}
- const InputInfo &Input = Inputs[0];
assert(Input.isFilename() && "Invalid input.");
CmdArgs.push_back(Input.getFilename());
- const auto& D = C.getDriver();
// TODO: Replace flang-new with flang once the new driver replaces the
// throwaway driver
const char *Exec = Args.MakeArgString(D.GetProgramPath("flang-new", TC));
Index: clang/include/clang/Driver/Options.td
===================================================================
--- clang/include/clang/Driver/Options.td
+++ clang/include/clang/Driver/Options.td
@@ -644,7 +644,7 @@
HelpText<"Include comments in preprocessed output">,
MarshallingInfoFlag<"PreprocessorOutputOpts.ShowComments">;
def D : JoinedOrSeparate<["-"], "D">, Group<Preprocessor_Group>,
- Flags<[CC1Option]>, MetaVarName<"<macro>=<value>">,
+ Flags<[CC1Option, FlangOption, FC1Option]>, MetaVarName<"<macro>=<value>">,
HelpText<"Define <macro> to <value> (or 1 if <value> omitted)">;
def E : Flag<["-"], "E">, Flags<[NoXarchOption,CC1Option, FlangOption, FC1Option]>, Group<Action_Group>,
HelpText<"Only run the preprocessor">;
@@ -743,7 +743,7 @@
def T : JoinedOrSeparate<["-"], "T">, Group<T_Group>,
MetaVarName<"<script>">, HelpText<"Specify <script> as linker script">;
def U : JoinedOrSeparate<["-"], "U">, Group<Preprocessor_Group>,
- Flags<[CC1Option]>, MetaVarName<"<macro>">, HelpText<"Undefine macro <macro>">;
+ Flags<[CC1Option, FlangOption, FC1Option]>, MetaVarName<"<macro>">, HelpText<"Undefine macro <macro>">;
def V : JoinedOrSeparate<["-"], "V">, Flags<[NoXarchOption, Unsupported]>;
def Wa_COMMA : CommaJoined<["-"], "Wa,">,
HelpText<"Pass the comma separated arguments in <arg> to the assembler">,
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
