[flang][driver] Fix `-fdebug-dump-provenance`

[awarzynski]

Summary

The -fdebug-dump-provenance flag is meant to be used with
needProvenanceRangeToCharBlockMappings set to true. This way, extra
mapping is generated that allows e.g. IDEs to retrieve symbol's scope
(offset into cooked character stream) based on symbol's source code
location. This patch makes sure that this option is set when
using -fdebug-dump-provenance.

With this patch, the implementation of -fdebug-dump-provenance in
flang-new -fc1 becomes consistent with f18. The corresponding LIT
test is updated so that it can be shared with f18. I refined it a bit
so that:

• it becomes a frontend-only test
• it's stricter about the expected output

Depends on: https://reviews.llvm.org/D99292

[awarzynski]

Rebase on top of D99292

[arnamoy10]

LGTM

flang/include/flang/Frontend/FrontendOptions.h

 //===- FrontendOptions.h ----------------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 #ifndef LLVM_FLANG_FRONTEND_FRONTENDOPTIONS_H
 #define LLVM_FLANG_FRONTEND_FRONTENDOPTIONS_H
 
 #include "flang/Common/Fortran-features.h"
 #include "flang/Parser/characters.h"
 #include "flang/Parser/unparse.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/MemoryBuffer.h"
 
 #include <cstdint>
 #include <string>
 
public:
   unsigned showHelp_ : 1;
 
   /// Show the -version text.
   unsigned showVersion_ : 1;
 
   /// Instrument the parse to get a more verbose log
   unsigned instrumentedParse_ : 1;
 
+  /// Enable Provenance to character-stream mapping. Allows e.g. IDEs to find
+  /// symbols based on source-code location. This is not needed in regular
+  /// compilation.
+  unsigned needProvenanceRangeToCharBlockMappings_ : 1;
+
   /// The input files and their types.
   std::vector<FrontendInputFile> inputs_;
 
   /// The output file, if any.
   std::string outputFile_;
 
   /// The frontend action to perform.
   frontend::ActionKind programAction_;
 
   // The form to process files in, if specified.
   FortranForm fortranForm_ = FortranForm::Unknown;
 
   // The column after which characters are ignored in fixed form lines in the
   // source file.
   int fixedFormColumns_ = 72;
 
   // Language features
   common::LanguageFeatureControl features_;
 
   // Source file encoding
   Fortran::parser::Encoding encoding_{Fortran::parser::Encoding::UTF_8};
 
 public:
-  FrontendOptions() : showHelp_(false), showVersion_(false) {}
+  FrontendOptions()
+      : showHelp_(false), showVersion_(false), instrumentedParse_(false),
+        needProvenanceRangeToCharBlockMappings_(false) {}
 
   // Return the appropriate input kind for a file extension. For example,
   /// "*.f" would return Language::Fortran.
   ///
   /// \return The input kind for the extension, or Language::Unknown if the
   /// extension is not recognized.
   static InputKind GetInputKindForExtension(llvm::StringRef extension);
 };
 } // namespace Fortran::frontend
 
 #endif // LLVM_FLANG_FRONTEND_FRONTENDOPTIONS_H

flang/lib/Frontend/CompilerInvocation.cpp

 //===- CompilerInvocation.cpp ---------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "flang/Frontend/CompilerInvocation.h"
 #include "flang/Common/Fortran-features.h"
 #include "flang/Frontend/PreprocessorOptions.h"
 #include "flang/Semantics/semantics.h"
 #include "flang/Version.inc"
 #include "clang/Basic/AllDiagnostics.h"
 #include "clang/Basic/DiagnosticDriver.h"
 #include "clang/Basic/DiagnosticOptions.h"
 #include "clang/Driver/DriverDiagnostic.h"

 
 // Tweak the frontend configuration based on the frontend action
 static void setUpFrontendBasedOnAction(FrontendOptions &opts) {
   assert(opts.programAction_ != Fortran::frontend::InvalidAction &&
       "Fortran frontend action not set!");
 
   if (opts.programAction_ == DebugDumpParsingLog)
     opts.instrumentedParse_ = true;
+
+  if (opts.programAction_ == DebugDumpProvenance)
+    opts.needProvenanceRangeToCharBlockMappings_ = true;
 }
 
 static InputKind ParseFrontendArgs(FrontendOptions &opts,
     llvm::opt::ArgList &args, clang::DiagnosticsEngine &diags) {
 
   // By default the frontend driver creates a ParseSyntaxOnly action.
   opts.programAction_ = ParseSyntaxOnly;
 
void CompilerInvocation::setFortranOpts() {
 
   // Add the directory supplied through -J/-module-dir to the list of search
   // directories
   if (moduleDirJ.compare(".") != 0)
     fortranOptions.searchDirectories.emplace_back(moduleDirJ);
 
   if (frontendOptions.instrumentedParse_)
     fortranOptions.instrumentedParse = true;
+
+  if (frontendOptions.needProvenanceRangeToCharBlockMappings_)
+    fortranOptions.needProvenanceRangeToCharBlockMappings = true;
 }
 
 void CompilerInvocation::setSemanticsOpts(
     Fortran::parser::AllCookedSources &allCookedSources) {
   const auto &fortranOptions = fortranOpts();
 
   semanticsContext_ = std::make_unique<semantics::SemanticsContext>(
       defaultKinds(), fortranOptions.features, allCookedSources);
 
   semanticsContext_->set_moduleDirectory(moduleDir())
       .set_searchDirectories(fortranOptions.searchDirectories);
 }

flang/test/Driver/debug-provenance.f90

 ! Ensure argument -fdebug-dump-provenance works as expected.
 
-! REQUIRES: new-flang-driver
+!----------
+! RUN LINE
+!----------
+! RUN: %flang_fc1 -fdebug-dump-provenance %s  2>&1 | FileCheck %s
 
-!--------------------------
-! FLANG DRIVER (flang-new)
-!--------------------------
-! RUN: not %flang-new -fdebug-dump-provenance %s  2>&1 | FileCheck %s --check-prefix=FLANG
+!----------------
+! EXPECTED OUTPUT
+!----------------
+! CHECK: AllSources:
+! CHECK-NEXT: AllSources range_ [{{[0-9]*}}..{{[0-9]*}}] ({{[0-9]*}} bytes)
+! CHECK-NEXT:    [1..1] (1 bytes) -> compiler '?'(0x3f)
+! CHECK-NEXT:    [2..2] (1 bytes) -> compiler ' '(0x20)
+! CHECK-NEXT:    [3..3] (1 bytes) -> compiler '\'(0x5c)
+! CHECK-NEXT:    [{{[0-9]*}}..{{[0-9]*}}] ({{[0-9]*}} bytes) -> file {{.*}}/debug-provenance.f90
+! CHECK-NEXT:    [{{[0-9]*}}..{{[0-9]*}}] ({{[0-9]*}} bytes) -> compiler '(after end of source)'
+! CHECK-NEXT: CookedSource::provenanceMap_:
+! CHECK-NEXT: offsets [{{[0-9]*}}..{{[0-9]*}}] -> provenances [{{[0-9]*}}..{{[0-9]*}}] ({{[0-9]*}} bytes)
+! CHECK-NEXT: CookedSource::invertedMap_:
+! CHECK-NEXT: provenances [{{[0-9]*}}..{{[0-9]*}}] ({{[0-9]*}} bytes) -> offsets [{{[0-9]*}}..{{[0-9]*}}]
+! CHECK-EMPTY:
 
-!----------------------------------------
-! FRONTEND FLANG DRIVER (flang-new -fc1)
-!----------------------------------------
-! RUN: %flang-new -fc1 -fdebug-dump-provenance %s  2>&1 | FileCheck %s --check-prefix=FRONTEND
-
-!----------------------------------
-! EXPECTED OUTPUT WITH `flang-new`
-!----------------------------------
-! FLANG:warning: argument unused during compilation: '-fdebug-dump-provenance'
-
-!---------------------------------------
-! EXPECTED OUTPUT WITH `flang-new -fc1`
-!---------------------------------------
-! FRONTEND:AllSources:
-! FRONTEND:CookedSource::provenanceMap_:
+!-------------
+! TEST INPUT
+!------------
 program A
 end