From 83c633ea1a5b015cf25056aa1855842cd92c077d Mon Sep 17 00:00:00 2001 From: Jan Svoboda Date: Wed, 25 Aug 2021 10:14:15 +0200 Subject: [PATCH] [clang][deps] Collect precompiled deps from submodules too In this patch, the dependency scanner starts collecting precompiled dependencies from all encountered submodules, not only from top-level modules. Reviewed By: dexonsmith Differential Revision: https://reviews.llvm.org/D108540 --- .../DependencyScanning/ModuleDepCollector.h | 6 +- .../DependencyScanning/ModuleDepCollector.cpp | 20 ++- .../modules-pch-common-via-submodule/cdb_pch.json | 7 ++ .../modules-pch-common-via-submodule/cdb_tu.json | 7 ++ .../modules-pch-common-via-submodule/mod_common.h | 0 .../modules-pch-common-via-submodule/mod_tu.h | 0 .../modules-pch-common-via-submodule/mod_tu_sub.h | 1 + .../module.modulemap | 11 ++ .../Inputs/modules-pch-common-via-submodule/pch.h | 1 + .../Inputs/modules-pch-common-via-submodule/tu.c | 1 + .../modules-pch-common-via-submodule.c | 137 +++++++++++++++++++++ 11 files changed, 186 insertions(+), 5 deletions(-) create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_pch.json create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_tu.json create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_common.h create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_tu.h create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_tu_sub.h create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/module.modulemap create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/pch.h create mode 100644 clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/tu.c create mode 100644 clang/test/ClangScanDeps/modules-pch-common-via-submodule.c diff --git a/clang/include/clang/Tooling/DependencyScanning/ModuleDepCollector.h b/clang/include/clang/Tooling/DependencyScanning/ModuleDepCollector.h index fbdb34f..c539d7a 100644 --- a/clang/include/clang/Tooling/DependencyScanning/ModuleDepCollector.h +++ b/clang/include/clang/Tooling/DependencyScanning/ModuleDepCollector.h @@ -172,7 +172,11 @@ private: /// Adds direct modular dependencies that have already been built to the /// ModuleDeps instance. - void addDirectPrebuiltModuleDeps(const Module *M, ModuleDeps &MD); + void + addAllSubmodulePrebuiltDeps(const Module *M, ModuleDeps &MD, + llvm::DenseSet &SeenSubmodules); + void addModulePrebuiltDeps(const Module *M, ModuleDeps &MD, + llvm::DenseSet &SeenSubmodules); /// Traverses the previously collected direct modular dependencies to discover /// transitive modular dependencies and fills the parent \c ModuleDepCollector diff --git a/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp b/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp index bd2c515..cc1f64e 100644 --- a/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp +++ b/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp @@ -231,7 +231,8 @@ ModuleID ModuleDepCollectorPP::handleTopLevelModule(const Module *M) { // Add direct prebuilt module dependencies now, so that we can use them when // creating a CompilerInvocation and computing context hash for this // ModuleDeps instance. - addDirectPrebuiltModuleDeps(M, MD); + llvm::DenseSet SeenModules; + addAllSubmodulePrebuiltDeps(M, MD, SeenModules); MD.Invocation = MDC.makeInvocationForModuleBuildWithoutPaths(MD); MD.ID.ContextHash = MD.Invocation.getModuleHash(); @@ -242,12 +243,23 @@ ModuleID ModuleDepCollectorPP::handleTopLevelModule(const Module *M) { return MD.ID; } -void ModuleDepCollectorPP::addDirectPrebuiltModuleDeps(const Module *M, - ModuleDeps &MD) { +void ModuleDepCollectorPP::addAllSubmodulePrebuiltDeps( + const Module *M, ModuleDeps &MD, + llvm::DenseSet &SeenSubmodules) { + addModulePrebuiltDeps(M, MD, SeenSubmodules); + + for (const Module *SubM : M->submodules()) + addAllSubmodulePrebuiltDeps(SubM, MD, SeenSubmodules); +} + +void ModuleDepCollectorPP::addModulePrebuiltDeps( + const Module *M, ModuleDeps &MD, + llvm::DenseSet &SeenSubmodules) { for (const Module *Import : M->Imports) if (Import->getTopLevelModule() != M->getTopLevelModule()) if (MDC.isPrebuiltModule(Import)) - MD.PrebuiltModuleDeps.emplace_back(Import); + if (SeenSubmodules.insert(Import).second) + MD.PrebuiltModuleDeps.emplace_back(Import); } void ModuleDepCollectorPP::addAllSubmoduleDeps( diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_pch.json b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_pch.json new file mode 100644 index 0000000..dc2fc55 --- /dev/null +++ b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_pch.json @@ -0,0 +1,7 @@ +[ + { + "directory": "DIR", + "command": "clang -x c-header DIR/pch.h -fmodules -gmodules -fimplicit-module-maps -fmodules-cache-path=DIR/cache -o DIR/pch.h.gch", + "file": "DIR/pch.h" + } +] diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_tu.json b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_tu.json new file mode 100644 index 0000000..8aad2cc --- /dev/null +++ b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/cdb_tu.json @@ -0,0 +1,7 @@ +[ + { + "directory": "DIR", + "command": "clang -fsyntax-only DIR/tu.c -fmodules -gmodules -fimplicit-module-maps -fmodules-cache-path=DIR/cache -include DIR/pch.h -o DIR/tu.o", + "file": "DIR/tu.c" + } +] diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_common.h b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_common.h new file mode 100644 index 0000000..e69de29 diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_tu.h b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_tu.h new file mode 100644 index 0000000..e69de29 diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_tu_sub.h b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_tu_sub.h new file mode 100644 index 0000000..d160b83 --- /dev/null +++ b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/mod_tu_sub.h @@ -0,0 +1 @@ +#include "mod_common.h" diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/module.modulemap b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/module.modulemap new file mode 100644 index 0000000..4b3600a --- /dev/null +++ b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/module.modulemap @@ -0,0 +1,11 @@ +module ModCommon { + header "mod_common.h" +} + +module ModTU { + header "mod_tu.h" + + module ModTUSub { + header "mod_tu_sub.h" + } +} diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/pch.h b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/pch.h new file mode 100644 index 0000000..d160b83 --- /dev/null +++ b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/pch.h @@ -0,0 +1 @@ +#include "mod_common.h" diff --git a/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/tu.c b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/tu.c new file mode 100644 index 0000000..085d398 --- /dev/null +++ b/clang/test/ClangScanDeps/Inputs/modules-pch-common-via-submodule/tu.c @@ -0,0 +1 @@ +#include "mod_tu.h" diff --git a/clang/test/ClangScanDeps/modules-pch-common-via-submodule.c b/clang/test/ClangScanDeps/modules-pch-common-via-submodule.c new file mode 100644 index 0000000..9fb8ad8 --- /dev/null +++ b/clang/test/ClangScanDeps/modules-pch-common-via-submodule.c @@ -0,0 +1,137 @@ +// Check that we discover dependency on a precompiled module (and generate the +// appropriate `-fmodule-file=` argument) when it's imported by a **submodule** +// instead of a top-level module. + +// RUN: rm -rf %t && mkdir %t +// RUN: cp %S/Inputs/modules-pch-common-via-submodule/* %t + +// Scan dependencies of the PCH: +// +// RUN: sed "s|DIR|%/t|g" %S/Inputs/modules-pch-common-via-submodule/cdb_pch.json > %t/cdb.json +// RUN: echo -%t > %t/result_pch.json +// RUN: clang-scan-deps -compilation-database %t/cdb.json -format experimental-full \ +// RUN: -generate-modules-path-args -module-files-dir %t/build >> %t/result_pch.json +// RUN: cat %t/result_pch.json | sed 's:\\\\\?:/:g' | FileCheck %s -check-prefix=CHECK-PCH +// +// CHECK-PCH: -[[PREFIX:.*]] +// CHECK-PCH-NEXT: { +// CHECK-PCH-NEXT: "modules": [ +// CHECK-PCH-NEXT: { +// CHECK-PCH-NEXT: "clang-module-deps": [], +// CHECK-PCH-NEXT: "clang-modulemap-file": "[[PREFIX]]/module.modulemap", +// CHECK-PCH-NEXT: "command-line": [ +// CHECK-PCH-NEXT: "-cc1" +// CHECK-PCH: "-emit-module" +// CHECK-PCH: "-fmodules" +// CHECK-PCH: "-fmodule-name=ModCommon" +// CHECK-PCH: "-fno-implicit-modules" +// CHECK-PCH: ], +// CHECK-PCH-NEXT: "context-hash": "[[HASH_MOD_COMMON:.*]]", +// CHECK-PCH-NEXT: "file-deps": [ +// CHECK-PCH-NEXT: "[[PREFIX]]/mod_common.h", +// CHECK-PCH-NEXT: "[[PREFIX]]/module.modulemap" +// CHECK-PCH-NEXT: ], +// CHECK-PCH-NEXT: "name": "ModCommon" +// CHECK-PCH-NEXT: } +// CHECK-PCH-NEXT: ], +// CHECK-PCH-NEXT: "translation-units": [ +// CHECK-PCH-NEXT: { +// CHECK-PCH-NEXT: "clang-context-hash": "[[HASH_PCH:.*]]", +// CHECK-PCH-NEXT: "clang-module-deps": [ +// CHECK-PCH-NEXT: { +// CHECK-PCH-NEXT: "context-hash": "[[HASH_MOD_COMMON]]", +// CHECK-PCH-NEXT: "module-name": "ModCommon" +// CHECK-PCH-NEXT: } +// CHECK-PCH-NEXT: ], +// CHECK-PCH-NEXT: "command-line": [ +// CHECK-PCH-NEXT: "-fno-implicit-modules" +// CHECK-PCH-NEXT: "-fno-implicit-module-maps" +// CHECK-PCH-NEXT: "-fmodule-file=[[PREFIX]]/build/[[HASH_MOD_COMMON]]/ModCommon-{{.*}}.pcm" +// CHECK-PCH-NEXT: "-fmodule-map-file=[[PREFIX]]/module.modulemap" +// CHECK-PCH-NEXT: ], +// CHECK-PCH-NEXT: "file-deps": [ +// CHECK-PCH-NEXT: "[[PREFIX]]/pch.h" +// CHECK-PCH-NEXT: ], +// CHECK-PCH-NEXT: "input-file": "[[PREFIX]]/pch.h" +// CHECK-PCH-NEXT: } +// CHECK-PCH-NEXT: ] +// CHECK-PCH-NEXT: } + +// Explicitly build the PCH: +// +// RUN: tail -n +2 %t/result_pch.json > %t/result_pch_stripped.json +// RUN: %python %S/../../utils/module-deps-to-rsp.py %t/result_pch_stripped.json \ +// RUN: --module-name=ModCommon > %t/mod_common.cc1.rsp +// RUN: %python %S/../../utils/module-deps-to-rsp.py %t/result_pch_stripped.json \ +// RUN: --tu-index=0 > %t/pch.rsp +// +// RUN: %clang @%t/mod_common.cc1.rsp +// RUN: %clang -x c-header %t/pch.h -fmodules -gmodules -fimplicit-module-maps \ +// RUN: -fmodules-cache-path=%t/cache -o %t/pch.h.gch @%t/pch.rsp + +// Scan dependencies of the TU: +// +// RUN: sed "s|DIR|%/t|g" %S/Inputs/modules-pch-common-via-submodule/cdb_tu.json > %t/cdb.json +// RUN: echo -%t > %t/result_tu.json +// RUN: clang-scan-deps -compilation-database %t/cdb.json -format experimental-full \ +// RUN: -generate-modules-path-args -module-files-dir %t/build >> %t/result_tu.json +// RUN: cat %t/result_tu.json | sed 's:\\\\\?:/:g' | FileCheck %s -check-prefix=CHECK-TU +// +// CHECK-TU: -[[PREFIX:.*]] +// CHECK-TU-NEXT: { +// CHECK-TU-NEXT: "modules": [ +// CHECK-TU-NEXT: { +// CHECK-TU-NEXT: "clang-module-deps": [], +// CHECK-TU-NEXT: "clang-modulemap-file": "[[PREFIX]]/module.modulemap", +// CHECK-TU-NEXT: "command-line": [ +// CHECK-TU-NEXT: "-cc1" +// CHECK-TU: "-emit-module" +// CHECK-TU: "-fmodule-file=[[PREFIX]]/build/[[HASH_MOD_COMMON:.*]]/ModCommon-{{.*}}.pcm" +// CHECK-TU: "-fmodules" +// CHECK-TU: "-fmodule-name=ModTU" +// CHECK-TU: "-fno-implicit-modules" +// CHECK-TU: ], +// CHECK-TU-NEXT: "context-hash": "[[HASH_MOD_TU:.*]]", +// CHECK-TU-NEXT: "file-deps": [ +// CHECK-TU-NEXT: "[[PREFIX]]/mod_tu.h", +// CHECK-TU-NEXT: "[[PREFIX]]/mod_tu_sub.h", +// CHECK-TU-NEXT: "[[PREFIX]]/module.modulemap" +// CHECK-TU-NEXT: ], +// CHECK-TU-NEXT: "name": "ModTU" +// CHECK-TU-NEXT: } +// CHECK-TU-NEXT: ], +// CHECK-TU-NEXT: "translation-units": [ +// CHECK-TU-NEXT: { +// CHECK-TU-NEXT: "clang-context-hash": "[[HASH_TU:.*]]", +// CHECK-TU-NEXT: "clang-module-deps": [ +// CHECK-TU-NEXT: { +// CHECK-TU-NEXT: "context-hash": "[[HASH_MOD_TU]]" +// CHECK-TU-NEXT: "module-name": "ModTU" +// CHECK-TU-NEXT: } +// CHECK-TU-NEXT: ], +// CHECK-TU-NEXT: "command-line": [ +// CHECK-TU-NEXT: "-fno-implicit-modules", +// CHECK-TU-NEXT: "-fno-implicit-module-maps", +// CHECK-TU-NEXT: "-fmodule-file=[[PREFIX]]/build/[[HASH_MOD_TU:.*]]/ModTU-{{.*}}.pcm", +// CHECK-TU-NEXT: "-fmodule-map-file=[[PREFIX]]/module.modulemap" +// CHECK-TU-NEXT: ], +// CHECK-TU-NEXT: "file-deps": [ +// CHECK-TU-NEXT: "[[PREFIX]]/tu.c", +// CHECK-TU-NEXT: "[[PREFIX]]/pch.h.gch" +// CHECK-TU-NEXT: ], +// CHECK-TU-NEXT: "input-file": "[[PREFIX]]/tu.c" +// CHECK-TU-NEXT: } +// CHECK-TU-NEXT: ] +// CHECK-TU-NEXT: } + +// Explicitly build the TU: +// +// RUN: tail -n +2 %t/result_tu.json > %t/result_tu_stripped.json +// RUN: %python %S/../../utils/module-deps-to-rsp.py %t/result_tu_stripped.json \ +// RUN: --module-name=ModTU > %t/mod_tu.cc1.rsp +// RUN: %python %S/../../utils/module-deps-to-rsp.py %t/result_tu_stripped.json \ +// RUN: --tu-index=0 > %t/tu.rsp +// +// RUN: %clang @%t/mod_tu.cc1.rsp +// RUN: %clang -fsyntax-only %t/tu.c -fmodules -gmodules -fimplicit-module-maps \ +// RUN: -fmodules-cache-path=%t/cache -include %t/pch.h -o %t/tu.o @%t/tu.rsp -- 2.7.4