[clang] 1d9e8e1 - [clang][deps] Support inferred modules
Jan Svoboda via cfe-commits
cfe-commits at lists.llvm.org
Mon May 17 02:42:45 PDT 2021
Author: Michael Spencer
Date: 2021-05-17T11:41:54+02:00
New Revision: 1d9e8e13dd7b3204fa51ada17d1608bdbd1bed66
URL: https://github.com/llvm/llvm-project/commit/1d9e8e13dd7b3204fa51ada17d1608bdbd1bed66
DIFF: https://github.com/llvm/llvm-project/commit/1d9e8e13dd7b3204fa51ada17d1608bdbd1bed66.diff
LOG: [clang][deps] Support inferred modules
This patch adds support for inferred modules to the dependency scanner.
Effectively a cherry-pick of https://github.com/apple/llvm-project/pull/699 authored by @Bigcheese with libclang and other changes omitted.
Contains following changes:
1. [Clang][ScanDeps] Ignore __inferred_module.map dependency.
* This shows up with inferred modules, but it doesn't exist on disk, so don't report it as a dependency.
2. [Clang][ScanDeps] Use the module map a module was inferred from for inferred modules.
Also includes a smoke test that uses clang-scan-deps output to perform an explicit build. There's no intention to duplicate whatever `test/Modules` contains, just to verify the produced command-line does "work" (with very loose definition of work).
Split from D100934.
Reviewed By: dexonsmith
Differential Revision: https://reviews.llvm.org/D102495
Added:
clang/test/ClangScanDeps/Inputs/frameworks/Inferred.framework/Frameworks/Sub.framework/Headers/Sub.h
clang/test/ClangScanDeps/Inputs/frameworks/Inferred.framework/Headers/Inferred.h
clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Headers/System.h
clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Modules/module.modulemap
clang/test/ClangScanDeps/Inputs/frameworks/module.modulemap
clang/test/ClangScanDeps/Inputs/modules_inferred_cdb.json
clang/test/ClangScanDeps/modules-inferred-explicit-build.m
clang/test/ClangScanDeps/modules-inferred.m
clang/utils/module-deps-to-rsp.py
Modified:
clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp
clang/test/ClangScanDeps/modules-full.cpp
Removed:
################################################################################
diff --git a/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp b/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp
index 51b7fc48628c1..d9e0bead13bc5 100644
--- a/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp
+++ b/clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp
@@ -33,7 +33,6 @@ makeInvocationForModuleBuildWithoutPaths(const ModuleDeps &Deps,
CI.getFrontendOpts().IsSystemModule = Deps.IsSystem;
CI.getLangOpts()->ImplicitModules = false;
- CI.getHeaderSearchOpts().ImplicitModuleMaps = false;
return CI;
}
@@ -179,13 +178,22 @@ ModuleID ModuleDepCollectorPP::handleTopLevelModule(const Module *M) {
const FileEntry *ModuleMap = Instance.getPreprocessor()
.getHeaderSearchInfo()
.getModuleMap()
- .getContainingModuleMapFile(M);
+ .getModuleMapFileForUniquing(M);
MD.ClangModuleMapFile = std::string(ModuleMap ? ModuleMap->getName() : "");
serialization::ModuleFile *MF =
MDC.Instance.getASTReader()->getModuleManager().lookup(M->getASTFile());
MDC.Instance.getASTReader()->visitInputFiles(
*MF, true, true, [&](const serialization::InputFile &IF, bool isSystem) {
+ // __inferred_module.map is the result of the way in which an implicit
+ // module build handles inferred modules. It adds an overlay VFS with
+ // this file in the proper directory and relies on the rest of Clang to
+ // handle it like normal. With explicitly built modules we don't need
+ // to play VFS tricks, so replace it with the correct module map.
+ if (IF.getFile()->getName().endswith("__inferred_module.map")) {
+ MD.FileDeps.insert(ModuleMap->getName());
+ return;
+ }
MD.FileDeps.insert(IF.getFile()->getName());
});
diff --git a/clang/test/ClangScanDeps/Inputs/frameworks/Inferred.framework/Frameworks/Sub.framework/Headers/Sub.h b/clang/test/ClangScanDeps/Inputs/frameworks/Inferred.framework/Frameworks/Sub.framework/Headers/Sub.h
new file mode 100644
index 0000000000000..e69de29bb2d1d
diff --git a/clang/test/ClangScanDeps/Inputs/frameworks/Inferred.framework/Headers/Inferred.h b/clang/test/ClangScanDeps/Inputs/frameworks/Inferred.framework/Headers/Inferred.h
new file mode 100644
index 0000000000000..1855e4fad5f8d
--- /dev/null
+++ b/clang/test/ClangScanDeps/Inputs/frameworks/Inferred.framework/Headers/Inferred.h
@@ -0,0 +1 @@
+typedef int inferred;
diff --git a/clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Headers/System.h b/clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Headers/System.h
new file mode 100644
index 0000000000000..a90c62886749f
--- /dev/null
+++ b/clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Headers/System.h
@@ -0,0 +1 @@
+enum { bigger_than_int = 0x80000000 };
diff --git a/clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Modules/module.modulemap b/clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Modules/module.modulemap
new file mode 100644
index 0000000000000..51f72f6642351
--- /dev/null
+++ b/clang/test/ClangScanDeps/Inputs/frameworks/System.framework/Modules/module.modulemap
@@ -0,0 +1,3 @@
+framework module System [system] {
+ umbrella header "System.h"
+}
diff --git a/clang/test/ClangScanDeps/Inputs/frameworks/module.modulemap b/clang/test/ClangScanDeps/Inputs/frameworks/module.modulemap
new file mode 100644
index 0000000000000..e3bad873c7e7b
--- /dev/null
+++ b/clang/test/ClangScanDeps/Inputs/frameworks/module.modulemap
@@ -0,0 +1 @@
+framework module * {}
diff --git a/clang/test/ClangScanDeps/Inputs/modules_inferred_cdb.json b/clang/test/ClangScanDeps/Inputs/modules_inferred_cdb.json
new file mode 100644
index 0000000000000..e88dc88fa1b49
--- /dev/null
+++ b/clang/test/ClangScanDeps/Inputs/modules_inferred_cdb.json
@@ -0,0 +1,7 @@
+[
+{
+ "directory": "DIR",
+ "command": "clang -E DIR/modules_cdb_input.cpp -FFRAMEWORKS -fmodules -fmodules-cache-path=DIR/module-cache -fimplicit-modules -fimplicit-module-maps -pedantic -Werror",
+ "file": "DIR/modules_cdb_input.cpp"
+}
+]
diff --git a/clang/test/ClangScanDeps/modules-full.cpp b/clang/test/ClangScanDeps/modules-full.cpp
index ebd86e79a3fb8..a8d18abea41e6 100644
--- a/clang/test/ClangScanDeps/modules-full.cpp
+++ b/clang/test/ClangScanDeps/modules-full.cpp
@@ -48,7 +48,6 @@
// CHECK: "-emit-module"
// CHECK-NO-ABS-NOT: "-fmodule-file={{.*}}"
// CHECK-ABS: "-fmodule-file=[[PREFIX]]/module-cache{{(_clangcl)?}}/[[CONTEXT_HASH_H1]]/header2-{{[A-Z0-9]+}}.pcm"
-// CHECK-NOT: "-fimplicit-module-maps"
// CHECK: "-fmodule-name=header1"
// CHECK: "-fno-implicit-modules"
// CHECK: ],
@@ -65,7 +64,6 @@
// CHECK-NEXT: "command-line": [
// CHECK-NEXT: "-cc1",
// CHECK: "-emit-module",
-// CHECK-NOT: "-fimplicit-module-maps",
// CHECK: "-fmodule-name=header1",
// CHECK: "-fno-implicit-modules",
// CHECK: ],
@@ -82,7 +80,6 @@
// CHECK-NEXT: "command-line": [
// CHECK-NEXT: "-cc1",
// CHECK: "-emit-module",
-// CHECK-NOT: "-fimplicit-module-maps",
// CHECK: "-fmodule-name=header2",
// CHECK: "-fno-implicit-modules",
// CHECK: ],
diff --git a/clang/test/ClangScanDeps/modules-inferred-explicit-build.m b/clang/test/ClangScanDeps/modules-inferred-explicit-build.m
new file mode 100644
index 0000000000000..00a855f487dd3
--- /dev/null
+++ b/clang/test/ClangScanDeps/modules-inferred-explicit-build.m
@@ -0,0 +1,22 @@
+// RUN: rm -rf %t.dir
+// RUN: rm -rf %t.cdb
+// RUN: mkdir -p %t.dir
+// RUN: cp %s %t.dir/modules_cdb_input.cpp
+// RUN: sed -e "s|DIR|%/t.dir|g" -e "s|FRAMEWORKS|%/S/Inputs/frameworks|g" -e "s|-E|-x objective-c -E|g" \
+// RUN: %S/Inputs/modules_inferred_cdb.json > %t.cdb
+//
+// RUN: clang-scan-deps -compilation-database %t.cdb -j 1 -format experimental-full \
+// RUN: -mode preprocess-minimized-sources > %t.db
+// RUN: %S/../../utils/module-deps-to-rsp.py %t.db --module-name=Inferred > %t.inferred.cc1.rsp
+// RUN: %S/../../utils/module-deps-to-rsp.py %t.db --module-name=System > %t.system.cc1.rsp
+// RUN: %S/../../utils/module-deps-to-rsp.py %t.db --tu-index=0 > %t.tu.rsp
+// RUN: %clang @%t.inferred.cc1.rsp -pedantic -Werror
+// RUN: %clang @%t.system.cc1.rsp -pedantic -Werror
+// RUN: %clang -x objective-c -fsyntax-only %t.dir/modules_cdb_input.cpp \
+// RUN: -F%S/Inputs/frameworks -fmodules -fimplicit-module-maps \
+// RUN: -pedantic -Werror @%t.tu.rsp
+
+#include <Inferred/Inferred.h>
+#include <System/System.h>
+
+inferred a = bigger_than_int;
diff --git a/clang/test/ClangScanDeps/modules-inferred.m b/clang/test/ClangScanDeps/modules-inferred.m
new file mode 100644
index 0000000000000..5d42903720d8c
--- /dev/null
+++ b/clang/test/ClangScanDeps/modules-inferred.m
@@ -0,0 +1,61 @@
+// RUN: rm -rf %t.dir
+// RUN: rm -rf %t.cdb
+// RUN: mkdir -p %t.dir
+// RUN: cp %s %t.dir/modules_cdb_input.cpp
+// RUN: sed -e "s|DIR|%/t.dir|g" -e "s|FRAMEWORKS|%S/Inputs/frameworks|g" \
+// RUN: %S/Inputs/modules_inferred_cdb.json > %t.cdb
+//
+// RUN: echo -%t.dir > %t.result
+// RUN: echo -%S >> %t.result
+// RUN: clang-scan-deps -compilation-database %t.cdb -j 1 -format experimental-full \
+// RUN: -generate-modules-path-args -mode preprocess-minimized-sources >> %t.result
+// RUN: cat %t.result | sed 's/\\/\//g' | FileCheck --check-prefixes=CHECK %s
+
+#include <Inferred/Inferred.h>
+
+inferred a = 0;
+
+// CHECK: -[[PREFIX:.*]]
+// CHECK-NEXT: -[[SOURCEDIR:.*]]
+// CHECK-NEXT: {
+// CHECK-NEXT: "modules": [
+// CHECK-NEXT: {
+// CHECK-NEXT: "clang-module-deps": [],
+// CHECK-NEXT: "clang-modulemap-file": "[[SOURCEDIR]]/Inputs/frameworks/module.modulemap",
+// CHECK-NEXT: "command-line": [
+// CHECK-NEXT: "-cc1",
+// CHECK: "-emit-module",
+// CHECK: "-fmodule-name=Inferred",
+// CHECK: "-fno-implicit-modules",
+// CHECK: ],
+// CHECK-NEXT: "context-hash": "[[CONTEXT_HASH_H1:[A-Z0-9]+]]",
+// CHECK-NEXT: "file-deps": [
+// CHECK-NEXT: "[[SOURCEDIR]]/Inputs/frameworks/Inferred.framework/Frameworks/Sub.framework/Headers/Sub.h",
+// CHECK-NEXT: "[[SOURCEDIR]]/Inputs/frameworks/Inferred.framework/Headers/Inferred.h",
+// CHECK-NEXT: "[[SOURCEDIR]]/Inputs/frameworks/module.modulemap"
+// CHECK-NEXT: ],
+// CHECK-NEXT: "name": "Inferred"
+// CHECK-NEXT: }
+// CHECK-NEXT: ],
+// CHECK-NEXT: "translation-units": [
+// CHECK-NEXT: {
+// CHECK-NEXT: "clang-context-hash": "[[CONTEXT_HASH_H1]]",
+// CHECK-NEXT: "clang-module-deps": [
+// CHECK-NEXT: {
+// CHECK-NEXT: "context-hash": "[[CONTEXT_HASH_H1]]",
+// CHECK-NEXT: "module-name": "Inferred"
+// CHECK-NEXT: }
+// CHECK-NEXT: ],
+// CHECK-NEXT: "command-line": [
+// CHECK-NEXT: "-fno-implicit-modules",
+// CHECK-NEXT: "-fno-implicit-module-maps",
+// CHECK-NEXT: "-fmodule-file=[[PREFIX]]/module-cache/[[CONTEXT_HASH_H1]]/Inferred-{{[A-Z0-9]+}}.pcm",
+// CHECK-NEXT: "-fmodule-map-file=[[SOURCEDIR]]/Inputs/frameworks/module.modulemap"
+// CHECK-NEXT: ],
+// CHECK-NEXT: "file-deps": [
+// CHECK-NEXT: "[[PREFIX]]/modules_cdb_input.cpp"
+// CHECK-NEXT: ],
+// CHECK-NEXT: "input-file": "[[PREFIX]]/modules_cdb_input.cpp"
+// CHECK-NEXT: }
+// CHECK-NEXT: ]
+// CHECK-NEXT: }
diff --git a/clang/utils/module-deps-to-rsp.py b/clang/utils/module-deps-to-rsp.py
new file mode 100755
index 0000000000000..56402bf029b67
--- /dev/null
+++ b/clang/utils/module-deps-to-rsp.py
@@ -0,0 +1,88 @@
+#!/usr/bin/env python
+
+# Converts clang-scan-deps output into response files.
+# * For modules, arguments in the resulting response file are enough to build a PCM.
+# * For translation units, the response file needs to be added to the original Clang invocation from compilation
+# database.
+#
+# Usage:
+#
+# clang-scan-deps -compilation-database compile_commands.json ... > deps.json
+# module-deps-to-rsp.py deps.json --module-name=ModuleName > module_name.cc1.rsp
+# module-deps-to-rsp.py deps.json --tu-index=0 > tu.rsp
+# clang @module_name.cc1.rsp
+# clang ... @tu.rsp
+
+import argparse
+import json
+import sys
+
+class ModuleNotFoundError(Exception):
+ def __init__(self, module_name):
+ self.module_name = module_name
+
+class FullDeps:
+ def __init__(self):
+ self.modules = dict()
+ self.translation_units = str()
+
+def getModulePathArgs(modules, full_deps):
+ cmd = []
+ for md in modules:
+ m = full_deps.modules[md['module-name'] + '-' + md['context-hash']]
+ cmd += [u'-fmodule-map-file=' + m['clang-modulemap-file']]
+ cmd += [u'-fmodule-file=' + md['module-name'] + '-' + md['context-hash'] + '.pcm']
+ return cmd
+
+def getCommandLineForModule(module_name, full_deps):
+ for m in full_deps.modules.values():
+ if m['name'] == module_name:
+ module = m
+ break
+ else:
+ raise ModuleNotFoundError(module_name)
+
+ cmd = m['command-line']
+ cmd += getModulePathArgs(m['clang-module-deps'], full_deps)
+ cmd += [u'-o', m['name'] + '-' + m['context-hash'] + '.pcm']
+ cmd += [m['clang-modulemap-file']]
+
+ return cmd
+
+def getCommandLineForTU(tu, full_deps):
+ cmd = tu['command-line']
+ cmd += getModulePathArgs(tu['clang-module-deps'], full_deps)
+ return cmd
+
+def parseFullDeps(json):
+ ret = FullDeps()
+ for m in json['modules']:
+ ret.modules[m['name'] + '-' + m['context-hash']] = m
+ ret.translation_units = json['translation-units']
+ return ret
+
+def main():
+ parser = argparse.ArgumentParser()
+ parser.add_argument("full_deps_file", help="Path to the full dependencies json file",
+ type=str)
+ action = parser.add_mutually_exclusive_group(required=True)
+ action.add_argument("--module-name", help="The name of the module to get arguments for",
+ type=str)
+ action.add_argument("--tu-index", help="The index of the translation unit to get arguments for",
+ type=int)
+ args = parser.parse_args()
+
+ full_deps = parseFullDeps(json.load(open(args.full_deps_file, 'r')))
+
+ try:
+ if args.module_name:
+ print(" ".join(getCommandLineForModule(args.module_name, full_deps)))
+
+ elif args.tu_index != None:
+ print(" ".join(getCommandLineForTU(full_deps.translation_units[args.tu_index], full_deps)))
+ except:
+ print("Unexpected error:", sys.exc_info()[0])
+ raise
+
+if __name__ == '__main__':
+ main()
More information about the cfe-commits
mailing list