[lldb][Target] Flush the scratch TypeSystem when owning lldb_private::Module gets...
authorMichael Buch <michaelbuch12@gmail.com>
Fri, 25 Nov 2022 14:45:09 +0000 (14:45 +0000)
committerMichael Buch <michaelbuch12@gmail.com>
Fri, 2 Dec 2022 10:52:41 +0000 (10:52 +0000)
commit4df11394a10b3b15d2fb9bde8b831cf68785aa45
tree6b52f17d3348ff35e8146bb85dbf3e211bc8af00
parent5941858efdca72425c29bf043d3ec84e7fec6f62
[lldb][Target] Flush the scratch TypeSystem when owning lldb_private::Module gets unloaded

**Summary**

This patch addresses #59128, where LLDB would crash when evaluating
importing a type that has been imported before into the same target.
The proposed solution is to clear the scratch AST (and associated
persistent variables, `ClangASTImporter`, etc.) whenever a module that
could've owned one of the stale `TypeSystem`s gets unloaded/destroyed.

Details:
1. The first time we evaluate the expression we import the decl for Foo into the Targets scratch AST
   context (lives in m_scratch_type_system_map). During this process we also create a ClangASTImporter
   that lives in the ClangPersistentVariables::m_ast_importer_sp. This importer has decl tracking
   structures which reference the source AST that the decl got imported from. This importer also gets
   re-used for all calls to DeportType (which we use to copy the final decl into the Targets scratch AST).
2. Rebuilding the executable triggers a tear-down of the Module that was backing the ASTContext that
   we originally got the Foo decl from (which lived in the Module::m_type_system_map). However, the Target’s scratch AST lives on.
3. Re-running the same expression will now create a new ASTImporterDelegate where the destination TranslationUnitDecl is
   the same as the one from step (1).
4. When importing the new Foo decl we first try to find it in the destination DeclContext, which happens to be
   the scratch destination TranslationUnitDecl. The `Foo` decl exists in this context since we copied it into
   the scratch AST in the first run. The ASTImporter then queries LLDB for the origin of that decl. Using the
   same persistent variable ClangASTImporter we claim the decl has an origin in the AST context that got torn
   down with the Module. This faulty origin leads to a use-after-free.

**Testing**

- Added API test

Differential Revision: https://reviews.llvm.org/D138724
lldb/source/Target/Target.cpp
lldb/test/API/functionalities/rerun_and_expr/Makefile [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr/TestRerunAndExpr.py [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr/main.cpp [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr/rebuild.cpp [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr_dylib/Makefile [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr_dylib/TestRerunAndExprDylib.py [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr_dylib/lib.cpp [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr_dylib/main.cpp [new file with mode: 0644]
lldb/test/API/functionalities/rerun_and_expr_dylib/rebuild.cpp [new file with mode: 0644]