Add -index-include-locals flag.

When this flag is passed, index store data emitted during a build
will also contain definitions/references for local symbols.

Author: allevato

include/swift/Frontend/FrontendOptions.h

@@ -105,6 +105,9 @@ class FrontendOptions {
   /// If indexing system modules, don't index the stdlib.
   bool IndexIgnoreStdlib = false;
 
+  /// Include local definitions/references in the index data.
+  bool IndexIncludeLocals = false;
+
   /// The module for which we should verify all of the generic signatures.
   std::string VerifyGenericSignaturesInModule;
 

include/swift/Index/IndexRecord.h

@@ -43,6 +43,9 @@ namespace index {
 /// \param skipStdlib If indexing system modules, don't index the standard
 /// library.
 ///
+/// \param includeLocals If true, emit index data for local definitions and
+/// references.
+///
 /// \param isDebugCompilation true for non-optimized compiler invocation.
 ///
 /// \param targetTriple The target for this compilation.
@@ -53,7 +56,8 @@ namespace index {
 bool indexAndRecord(SourceFile *primarySourceFile, StringRef indexUnitToken,
                     StringRef indexStorePath, bool indexClangModules,
                     bool indexSystemModules, bool skipStdlib,
-                    bool isDebugCompilation, StringRef targetTriple,
+                    bool includeLocals, bool isDebugCompilation,
+                    StringRef targetTriple,
                     const DependencyTracker &dependencyTracker,
                     const PathRemapper &pathRemapper);
 
@@ -81,6 +85,9 @@ bool indexAndRecord(SourceFile *primarySourceFile, StringRef indexUnitToken,
 /// \param skipStdlib If indexing system modules, don't index the standard
 /// library.
 ///
+/// \param includeLocals If true, emit index data for local definitions and
+/// references.
+///
 /// \param isDebugCompilation true for non-optimized compiler invocation.
 ///
 /// \param targetTriple The target for this compilation.
@@ -91,8 +98,8 @@ bool indexAndRecord(SourceFile *primarySourceFile, StringRef indexUnitToken,
 bool indexAndRecord(ModuleDecl *module, ArrayRef<std::string> indexUnitTokens,
                     StringRef moduleUnitToken, StringRef indexStorePath,
                     bool indexClangModules, bool indexSystemModules,
-                    bool skipStdlib, bool isDebugCompilation,
-                    StringRef targetTriple,
+                    bool skipStdlib, bool includeLocals,
+                    bool isDebugCompilation, StringRef targetTriple,
                     const DependencyTracker &dependencyTracker,
                     const PathRemapper &pathRemapper);
 // FIXME: indexUnitTokens could be StringRef, but that creates an impedance

include/swift/Option/Options.td

@@ -1262,6 +1262,10 @@ def index_ignore_clang_modules : Flag<["-"], "index-ignore-clang-modules">,
   Flags<[FrontendOption]>,
   HelpText<"Avoid indexing clang modules (pcms)">;
 
+def index_include_locals : Flag<["-"], "index-include-locals">,
+  Flags<[FrontendOption]>,
+  HelpText<"Include local definitions/references in the produced index data.">;
+
 def index_ignore_system_modules : Flag<["-"], "index-ignore-system-modules">,
   Flags<[NoInteractiveOption]>,
   HelpText<"Avoid indexing system modules">;

lib/Driver/ToolChains.cpp

@@ -575,6 +575,7 @@ ToolChain::constructInvocation(const CompileJobAction &job,
     if (!context.Args.hasArg(options::OPT_index_ignore_system_modules))
       Arguments.push_back("-index-system-modules");
     context.Args.AddLastArg(Arguments, options::OPT_index_ignore_clang_modules);
+    context.Args.AddLastArg(Arguments, options::OPT_index_include_locals);
   }
 
   if (context.Args.hasArg(options::OPT_debug_info_store_invocation) ||

lib/Frontend/ArgsToFrontendOptionsConverter.cpp

@@ -72,6 +72,7 @@ bool ArgsToFrontendOptionsConverter::convert(
   Opts.IndexIgnoreClangModules |= Args.hasArg(OPT_index_ignore_clang_modules);
   Opts.IndexSystemModules |= Args.hasArg(OPT_index_system_modules);
   Opts.IndexIgnoreStdlib |= Args.hasArg(OPT_index_ignore_stdlib);
+  Opts.IndexIncludeLocals |= Args.hasArg(OPT_index_include_locals);
 
   Opts.EmitVerboseSIL |= Args.hasArg(OPT_emit_verbose_sil);
   Opts.EmitSortedSIL |= Args.hasArg(OPT_emit_sorted_sil);

lib/FrontendTool/FrontendTool.cpp

@@ -1775,7 +1775,9 @@ static void emitIndexDataForSourceFile(SourceFile *PrimarySourceFile,
                                  opts.IndexStorePath,
                                  !opts.IndexIgnoreClangModules,
                                  opts.IndexSystemModules,
-                                 opts.IndexIgnoreStdlib, isDebugCompilation,
+                                 opts.IndexIgnoreStdlib,
+                                 opts.IndexIncludeLocals,
+                                 isDebugCompilation,
                                  Invocation.getTargetTriple(),
                                  *Instance.getDependencyTracker(),
                                  Invocation.getIRGenOptions().FilePrefixMap);
@@ -1792,6 +1794,7 @@ static void emitIndexDataForSourceFile(SourceFile *PrimarySourceFile,
                                  !opts.IndexIgnoreClangModules,
                                  opts.IndexSystemModules,
                                  opts.IndexIgnoreStdlib,
+                                 opts.IndexIncludeLocals,
                                  isDebugCompilation,
                                  Invocation.getTargetTriple(),
                                  *Instance.getDependencyTracker(),

lib/Index/IndexRecord.cpp

@@ -156,11 +156,14 @@ class IndexRecordingConsumer : public IndexDataConsumer {
   // we actually need it (once per Decl instead of once per occurrence).
   std::vector<IndexSymbol> symbolStack;
 
+  bool includeLocals;
+
   std::function<void(SymbolTracker &)> onFinish;
 
 public:
-  IndexRecordingConsumer(std::function<void(SymbolTracker &)> onFinish)
-      : onFinish(std::move(onFinish)) {}
+  IndexRecordingConsumer(bool includeLocals,
+                         std::function<void(SymbolTracker &)> onFinish)
+      : includeLocals(includeLocals), onFinish(std::move(onFinish)) {}
 
   void failed(StringRef error) override {
     // FIXME: expose errors?
@@ -183,6 +186,8 @@ class IndexRecordingConsumer : public IndexDataConsumer {
   }
 
   void finish() override { onFinish(record); }
+
+  bool indexLocals() override { return includeLocals; }
 };
 
 class StdlibGroupsIndexRecordingConsumer : public IndexDataConsumer {
@@ -323,24 +328,25 @@ static bool writeRecord(SymbolTracker &record, std::string Filename,
 
 static std::unique_ptr<IndexRecordingConsumer>
 makeRecordingConsumer(std::string Filename, std::string indexStorePath,
-                      DiagnosticEngine *diags,
+                      bool includeLocals, DiagnosticEngine *diags,
                       std::string *outRecordFile,
                       bool *outFailed) {
-  return std::make_unique<IndexRecordingConsumer>([=](SymbolTracker &record) {
+  return std::make_unique<IndexRecordingConsumer>(includeLocals,
+                                                  [=](SymbolTracker &record) {
     *outFailed = writeRecord(record, Filename, indexStorePath, diags,
                              *outRecordFile);
   });
 }
 
 static bool
 recordSourceFile(SourceFile *SF, StringRef indexStorePath,
-                 DiagnosticEngine &diags,
+                 bool includeLocals, DiagnosticEngine &diags,
                  llvm::function_ref<void(StringRef, StringRef)> callback) {
   std::string recordFile;
   bool failed = false;
   auto consumer =
       makeRecordingConsumer(SF->getFilename().str(), indexStorePath.str(),
-                            &diags, &recordFile, &failed);
+                            includeLocals, &diags, &recordFile, &failed);
   indexSourceFile(SF, *consumer);
 
   if (!failed && !recordFile.empty())
@@ -379,6 +385,7 @@ emitDataForSwiftSerializedModule(ModuleDecl *module,
                                  bool indexClangModules,
                                  bool indexSystemModules,
                                  bool skipStdlib,
+                                 bool includeLocals,
                                  StringRef targetTriple,
                                  const clang::CompilerInstance &clangCI,
                                  DiagnosticEngine &diags,
@@ -391,6 +398,7 @@ static void addModuleDependencies(ArrayRef<ImportedModule> imports,
                                   bool indexClangModules,
                                   bool indexSystemModules,
                                   bool skipStdlib,
+                                  bool includeLocals,
                                   StringRef targetTriple,
                                   const clang::CompilerInstance &clangCI,
                                   DiagnosticEngine &diags,
@@ -448,7 +456,8 @@ static void addModuleDependencies(ArrayRef<ImportedModule> imports,
               emitDataForSwiftSerializedModule(mod, indexStorePath,
                                                indexClangModules,
                                                indexSystemModules, skipStdlib,
-                                               targetTriple, clangCI, diags,
+                                               includeLocals, targetTriple,
+                                               clangCI, diags,
                                                unitWriter,
                                                pathRemapper,
                                                initialFile);
@@ -479,6 +488,7 @@ emitDataForSwiftSerializedModule(ModuleDecl *module,
                                  bool indexClangModules,
                                  bool indexSystemModules,
                                  bool skipStdlib,
+                                 bool includeLocals,
                                  StringRef targetTriple,
                                  const clang::CompilerInstance &clangCI,
                                  DiagnosticEngine &diags,
@@ -514,7 +524,7 @@ emitDataForSwiftSerializedModule(ModuleDecl *module,
     std::string recordFile;
     bool failed = false;
     auto consumer = makeRecordingConsumer(filename.str(), indexStorePath.str(),
-                                          &diags, &recordFile, &failed);
+                                          includeLocals, &diags, &recordFile, &failed);
     indexModule(module, *consumer);
 
     if (failed)
@@ -602,9 +612,9 @@ emitDataForSwiftSerializedModule(ModuleDecl *module,
                                        ModuleDecl::ImportFilterKind::Default});
   StringScratchSpace moduleNameScratch;
   addModuleDependencies(imports, indexStorePath, indexClangModules,
-                        indexSystemModules, skipStdlib, targetTriple, clangCI,
-                        diags, unitWriter, moduleNameScratch, pathRemapper,
-                        initialFile);
+                        indexSystemModules, skipStdlib, includeLocals,
+                        targetTriple, clangCI, diags, unitWriter,
+                        moduleNameScratch, pathRemapper, initialFile);
 
   if (unitWriter.write(error)) {
     diags.diagnose(SourceLoc(), diag::error_write_index_unit, error);
@@ -618,7 +628,8 @@ static bool
 recordSourceFileUnit(SourceFile *primarySourceFile, StringRef indexUnitToken,
                      StringRef indexStorePath, bool indexClangModules,
                      bool indexSystemModules, bool skipStdlib,
-                     bool isDebugCompilation, StringRef targetTriple,
+                     bool includeLocals, bool isDebugCompilation,
+                     StringRef targetTriple,
                      ArrayRef<const clang::FileEntry *> fileDependencies,
                      const clang::CompilerInstance &clangCI,
                      const PathRemapper &pathRemapper,
@@ -645,15 +656,15 @@ recordSourceFileUnit(SourceFile *primarySourceFile, StringRef indexUnitToken,
                 ModuleDecl::ImportFilterKind::ImplementationOnly});
   StringScratchSpace moduleNameScratch;
   addModuleDependencies(imports, indexStorePath, indexClangModules,
-                        indexSystemModules, skipStdlib, targetTriple, clangCI,
-                        diags, unitWriter, moduleNameScratch, pathRemapper,
-                        primarySourceFile);
+                        indexSystemModules, skipStdlib, includeLocals,
+                        targetTriple, clangCI, diags, unitWriter,
+                        moduleNameScratch, pathRemapper, primarySourceFile);
 
   // File dependencies.
   for (auto *F : fileDependencies)
     unitWriter.addFileDependency(F, /*FIXME:isSystem=*/false, /*Module=*/nullptr);
 
-  recordSourceFile(primarySourceFile, indexStorePath, diags,
+  recordSourceFile(primarySourceFile, indexStorePath, includeLocals, diags,
                    [&](StringRef recordFile, StringRef filename) {
                      auto file = fileMgr.getFile(filename);
                      unitWriter.addRecordFile(
@@ -700,6 +711,7 @@ bool index::indexAndRecord(SourceFile *primarySourceFile,
                            bool indexClangModules,
                            bool indexSystemModules,
                            bool skipStdlib,
+                           bool includeLocals,
                            bool isDebugCompilation,
                            StringRef targetTriple,
                            const DependencyTracker &dependencyTracker,
@@ -729,7 +741,7 @@ bool index::indexAndRecord(SourceFile *primarySourceFile,
 
   return recordSourceFileUnit(primarySourceFile, indexUnitToken,
                               indexStorePath, indexClangModules,
-                              indexSystemModules, skipStdlib,
+                              indexSystemModules, skipStdlib, includeLocals,
                               isDebugCompilation, targetTriple,
                               fileDependencies.getArrayRef(),
                               clangCI, pathRemapper, diags);
@@ -742,6 +754,7 @@ bool index::indexAndRecord(ModuleDecl *module,
                            bool indexClangModules,
                            bool indexSystemModules,
                            bool skipStdlib,
+                           bool includeLocals,
                            bool isDebugCompilation,
                            StringRef targetTriple,
                            const DependencyTracker &dependencyTracker,
@@ -779,7 +792,7 @@ bool index::indexAndRecord(ModuleDecl *module,
       }
       if (recordSourceFileUnit(SF, indexUnitTokens[unitIndex],
                                indexStorePath, indexClangModules,
-                               indexSystemModules, skipStdlib,
+                               indexSystemModules, skipStdlib, includeLocals,
                                isDebugCompilation, targetTriple,
                                fileDependencies.getArrayRef(),
                                clangCI, pathRemapper, diags))

test/Index/Store/driver-include-locals.swift

@@ -0,0 +1,24 @@
+// This test just verifies that the flag is passed from the driver to the
+// frontend. More thorough testing of the frontend behavior is in
+// test/Index/local.swift.
+//
+// Verify the driver sets the flag for the frontend jobs:
+//
+// RUN: %target-swiftc_driver -driver-print-jobs -emit-object -index-ignore-system-modules -index-store-path %t/index_store -o %t/file.o %s | %FileCheck -check-prefix=JOBS %s
+// RUN: %target-swiftc_driver -driver-print-jobs -emit-object -index-ignore-system-modules -index-include-locals -index-store-path %t/index_store -o %t/file.o %s | %FileCheck -check-prefix=LOCAL-JOBS %s
+// JOBS-NOT: {{.*}}swift{{(-frontend)?(c\.exe")?}} -frontend {{.*}}-index-store-path {{.*}}/index_store{{"?}} -index-include-locals
+// LOCAL-JOBS: {{.*}}swift{{(-frontend)?(c\.exe")?}} -frontend {{.*}}-index-store-path {{.*}}/index_store{{"?}} -index-include-locals
+//
+// Verify the frontend actually generates local index data:
+//
+// RUN: rm -rf %t
+// RUN: %target-swiftc_driver -emit-object -index-ignore-system-modules -index-store-path %t/idx-no-locals -o %t/file.o %s
+// RUN: %target-swiftc_driver -emit-object -index-ignore-system-modules -index-include-locals -index-store-path %t/idx-include-locals -o %t/file.o %s
+// RUN: c-index-test core -print-record %t/idx-no-locals | %FileCheck -check-prefix=CHECK %s
+// RUN: c-index-test core -print-record %t/idx-include-locals | %FileCheck -check-prefix=LOCAL %s
+
+func foo(a: Int, b: Int) {
+    let x = a + b
+    // LOCAL: [[@LINE-1]]:9 | variable(local)/Swift | [[x_USR:.*]] | Def,RelChild | rel: 1
+    // CHECK-NOT: [[@LINE-2]]:9 | variable(local)/Swift | {{.*}} | Def,RelChild | rel: 1
+}