Skip to content

[Dependency Scanning] Add a compiler statistic for # of dependency module queries and a simple test for it #85912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
artemcm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Dependency Scanning] Add a compiler statistic for # of dependency module queries and a simple test for it #85912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions lib/DependencyScan/ModuleDependencyScanner.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include "swift/Basic/Defer.h"
#include "swift/Basic/FileTypes.h"
#include "swift/Basic/PrettyStackTrace.h"
#include "swift/Basic/Statistic.h"
#include "swift/ClangImporter/ClangImporter.h"
#include "swift/Frontend/CompileJobCacheKey.h"
#include "swift/Frontend/ModuleInterfaceLoader.h"
Expand Down Expand Up @@ -53,6 +54,12 @@

using namespace swift;

#define DEBUG_TYPE "DependencyScanner"
STATISTIC(DepScanSwiftModuleQueries,
"# of times the dependency scanner performed a named lookup of a Swift module");
STATISTIC(DepScanClangModuleQueries,
"# of times the dependency scanner performed a named lookup of a Clang module");

static void findPath_dfs(ModuleDependencyID X, ModuleDependencyID Y,
ModuleDependencyIDSet &visited,
std::vector<ModuleDependencyID> &stack,
Expand Down Expand Up @@ -299,6 +306,7 @@ ModuleDependencyScanningWorker::ModuleDependencyScanningWorker(
SwiftModuleScannerQueryResult
ModuleDependencyScanningWorker::scanFilesystemForSwiftModuleDependency(
Identifier moduleName, bool isTestableImport) {
DepScanSwiftModuleQueries++;
return swiftModuleScannerLoader->lookupSwiftModule(moduleName,
isTestableImport);
}
Expand All @@ -309,6 +317,7 @@ ModuleDependencyScanningWorker::scanFilesystemForClangModuleDependency(
LookupModuleOutputCallback lookupModuleOutput,
const llvm::DenseSet<clang::tooling::dependencies::ModuleID>
&alreadySeenModules) {
DepScanClangModuleQueries++;
auto clangModuleDependencies = clangScanningTool.getModuleDependencies(
moduleName.str(), clangScanningModuleCommandLineArgs,
clangScanningWorkingDirectoryPath, alreadySeenModules,
Expand Down
39 changes: 39 additions & 0 deletions test/ScanDependencies/basic_query_stats.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// REQUIRES: asserts
// RUN: %empty-directory(%t)
// RUN: %empty-directory(%t/module-cache)
// RUN: %empty-directory(%t/inputs)
// RUN: split-file %s %t

// RUN: %target-swift-frontend -scan-dependencies -module-name Test -module-cache-path %t/module-cache -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import -parse-stdlib %t/test.swift -o %t/deps.json -I %t/inputs -print-stats &> %t/stats.txt
// RUN: cat %t/stats.txt | %FileCheck %s

// Ensure that despite being a common dependency to multiple Swift modules, only 1 query is performed to find 'C'
// CHECK: ... Statistics Collected ...
// CHECK: 1 DependencyScanner - # of times the dependency scanner performed a named lookup of a Clang module

//--- test.swift
import A
import B
public func test() {}

//--- inputs/A.swiftinterface
// swift-interface-format-version: 1.0
// swift-module-flags: -module-name A -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import -parse-stdlib -user-module-version 1.0
import C
public func a() { }

//--- inputs/B.swiftinterface
// swift-interface-format-version: 1.0
// swift-module-flags: -module-name B -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import -parse-stdlib -user-module-version 1.0
import C
public func b() { }

//--- inputs/c.h
void c(void);

//--- inputs/module.modulemap
module C {
header "C.h"
export *
}