[lldb/Interpreter] Make ScriptedInterface Object creation more generic by medismailben · Pull Request #68052 · llvm/llvm-project

medismailben · 2023-10-02T23:51:25Z

This patch changes the way plugin objects used with Scripted Interfaces
are created.

Instead of implementing a different SWIG method to create the object for
every scripted interface, this patch makes the creation more generic by
re-using some of the ScriptedPythonInterface templated Dispatch code.

This patch also improves error handling of the object creation by
returning an llvm::Expected.

Signed-off-by: Med Ismail Bennani ismail@bennani.ma

github-actions · 2023-10-03T00:02:19Z

✅ With the latest revision this PR passed the C/C++ code formatter.

lldb/include/lldb/Interpreter/Interfaces/ScriptedPlatformInterface.h

lldb/source/Plugins/Process/scripted/ScriptedThread.cpp

lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedPythonInterface.h

bulbazord

Works for me generally. I'm curious to know if some of these can be pure virtual function as Jonas mentioned.

lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedPythonInterface.h

This patch changes the way plugin objects used with Scripted Interfaces are created. Instead of implementing a different SWIG method to create the object for every scripted interface, this patch makes the creation more generic by re-using some of the ScriptedPythonInterface templated Dispatch code. This patch also improves error handling of the object creation by returning an `llvm::Expected`. Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>

JDevlieghere

LGTM

DavidSpickett · 2023-10-26T14:21:00Z

We still have a failure on Windows after the follow ups:

# .---command stderr------------
# | Cannot create an instance of the ScriptedProcessInterface!
# | UNREACHABLE executed at C:\Users\tcwg\david.spickett\llvm-project\lldb\include\lldb/Interpreter/Interfaces/ScriptedProcessInterface.h:29!
# | PLEASE submit a bug report to https://github.com/llvm/llvm-project/issues/ and include the crash backtrace.
# | Stack dump:
# | 0.  Program arguments: c:\\users\\tcwg\\david.spickett\\build-llvm\\bin\\lldb-test.exe ir-memory-map C:\\Users\\tcwg\\david.spickett\\build-llvm\\tools\\lldb\\test\\Shell\\Expr\\Output\\TestIRMemoryMapWindows.test.tmp C:\\Users\\tcwg\\david.spickett\\llvm-project\\lldb\\test\\Shell\\Expr/Inputs/ir-memory-map-basic
# | 1.  HandleCommand(command = "run")
# | Exception Code: 0xC000001D
# |  #0 0x00007ff71e493e0c HandleAbort C:\Users\tcwg\david.spickett\llvm-project\llvm\lib\Support\Windows\Signals.inc:424:0
# |  #1 0x00007ffe20f30ef8 (C:\WINDOWS\SYSTEM32\ucrtbased.dll+0xa0ef8)
# |  #2 0x00007ffe20f32a50 (C:\WINDOWS\SYSTEM32\ucrtbased.dll+0xa2a50)
# |  #3 0x00007ff71e460358 llvm::llvm_unreachable_internal(char const *, char const *, unsigned int) C:\Users\tcwg\david.spickett\llvm-project\llvm\lib\Support\ErrorHandling.cpp:212:0
# |  #4 0x00007ff71e999fc4 lldb_private::ScriptedProcessInterface::CreatePluginObject(class llvm::StringRef, class lldb_private::ExecutionContext &, class std::shared_ptr<class lldb_private::StructuredData::Dictionary>, class lldb_private::StructuredData::Generic *) C:\Users\tcwg\david.spickett\llvm-project\lldb\include\lldb\Interpreter\Interfaces\ScriptedProcessInterface.h:28:0

I'm looking into it.

DavidSpickett · 2023-10-26T14:33:32Z

Somehow it is getting to:

  virtual llvm::Expected<StructuredData::GenericSP>
  CreatePluginObject(llvm::StringRef class_name, ExecutionContext &exe_ctx,
                     StructuredData::DictionarySP args_sp,
                     StructuredData::Generic *script_obj = nullptr) {
    llvm_unreachable(
        "Cannot create an instance of the ScriptedProcessInterface!");
  }

Starting to wonder if we're relying on some undefined order of evaluation somewhere.

DavidSpickett · 2023-10-26T15:19:17Z

Never mind, this could have been the result of using an incompatible Python version. I'll get a stacktrace with one I know is used on the bot.

Since #68052 this has been failing. https://lab.llvm.org/buildbot/#/builders/219/builds/6545 Follow up changes have not fixed it, XFAIL while I debug it.

…tePluginObject After #68052 this function changed from returning a nullptr with `return {};` to returning Expected and hitting `llvm_unreachable` before it could do so. I gather that we're never supposed to call this function, but on Windows we actually do call this function because `interpreter->CreateScriptedProcessInterface()` returns `ScriptedProcessInterface` not `ScriptedProcessPythonInterface`. Likely because `target_sp->GetDebugger().GetScriptInterpreter()` also does not return a Python related class. The previously XFAILed test crashed with: ``` # .---command stderr------------ # | PLEASE submit a bug report to https://github.com/llvm/llvm-project/issues/ and include the crash backtrace. # | Stack dump: # | 0. Program arguments: c:\\users\\tcwg\\david.spickett\\build-llvm\\bin\\lldb-test.exe ir-memory-map C:\\Users\\tcwg\\david.spickett\\build-llvm\\tools\\lldb\\test\\Shell\\Expr\\Output\\TestIRMemoryMapWindows.test.tmp C:\\Users\\tcwg\\david.spickett\\llvm-project\\lldb\\test\\Shell\\Expr/Inputs/ir-memory-map-basic # | 1. HandleCommand(command = "run") # | Exception Code: 0xC000001D # | #0 0x00007ff696b5f588 lldb_private::ScriptedProcessInterface::CreatePluginObject(class llvm::StringRef, class lldb_private::ExecutionContext &, class std::shared_ptr<class lldb_private::StructuredData::Dictionary>, class lldb_private::StructuredData::Generic *) C:\Users\tcwg\david.spickett\llvm-project\lldb\include\lldb\Interpreter\Interfaces\ScriptedProcessInterface.h:28:0 # | #1 0x00007ff696b1d808 llvm::Expected<std::shared_ptr<lldb_private::StructuredData::Generic> >::operator bool C:\Users\tcwg\david.spickett\llvm-project\llvm\include\llvm\Support\Error.h:567:0 # | #2 0x00007ff696b1d808 lldb_private::ScriptedProcess::ScriptedProcess(class std::shared_ptr<class lldb_private::Target>, class std::shared_ptr<class lldb_private::Listener>, class lldb_private::ScriptedMetadata const &, class lldb_private::Status &) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Plugins\Process\scripted\ScriptedProcess.cpp:115:0 # | #3 0x00007ff696b1d124 std::shared_ptr<lldb_private::ScriptedProcess>::shared_ptr C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1478:0 # | #4 0x00007ff696b1d124 lldb_private::ScriptedProcess::CreateInstance(class std::shared_ptr<class lldb_private::Target>, class std::shared_ptr<class lldb_private::Listener>, class lldb_private::FileSpec const *, bool) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Plugins\Process\scripted\ScriptedProcess.cpp:61:0 # | #5 0x00007ff69699c8f4 std::_Ptr_base<lldb_private::Process>::_Move_construct_from C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1237:0 # | #6 0x00007ff69699c8f4 std::shared_ptr<lldb_private::Process>::shared_ptr C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1534:0 # | #7 0x00007ff69699c8f4 std::shared_ptr<lldb_private::Process>::operator= C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1594:0 # | #8 0x00007ff69699c8f4 lldb_private::Process::FindPlugin(class std::shared_ptr<class lldb_private::Target>, class llvm::StringRef, class std::shared_ptr<class lldb_private::Listener>, class lldb_private::FileSpec const *, bool) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Target\Process.cpp:396:0 # | #9 0x00007ff6969bd708 std::_Ptr_base<lldb_private::Process>::_Move_construct_from C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1237:0 # | #10 0x00007ff6969bd708 std::shared_ptr<lldb_private::Process>::shared_ptr C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1534:0 # | #11 0x00007ff6969bd708 std::shared_ptr<lldb_private::Process>::operator= C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1594:0 # | #12 0x00007ff6969bd708 lldb_private::Target::CreateProcess(class std::shared_ptr<class lldb_private::Listener>, class llvm::StringRef, class lldb_private::FileSpec const *, bool) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Target\Target.cpp:215:0 # | #13 0x00007ff696b13af0 std::_Ptr_base<lldb_private::Process>::_Ptr_base C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1230:0 # | #14 0x00007ff696b13af0 std::shared_ptr<lldb_private::Process>::shared_ptr C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1524:0 # | #15 0x00007ff696b13af0 lldb_private::PlatformWindows::DebugProcess(class lldb_private::ProcessLaunchInfo &, class lldb_private::Debugger &, class lldb_private::Target &, class lldb_private::Status &) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Plugins\Platform\Windows\PlatformWindows.cpp:495:0 # | #16 0x00007ff6969cf590 std::_Ptr_base<lldb_private::Process>::_Move_construct_from C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1237:0 # | #17 0x00007ff6969cf590 std::shared_ptr<lldb_private::Process>::shared_ptr C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1534:0 # | #18 0x00007ff6969cf590 std::shared_ptr<lldb_private::Process>::operator= C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\Tools\MSVC\14.35.32124\include\memory:1594:0 # | #19 0x00007ff6969cf590 lldb_private::Target::Launch(class lldb_private::ProcessLaunchInfo &, class lldb_private::Stream *) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Target\Target.cpp:3274:0 # | #20 0x00007ff696fff82c CommandObjectProcessLaunch::DoExecute(class lldb_private::Args &, class lldb_private::CommandReturnObject &) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Commands\CommandObjectProcess.cpp:258:0 # | #21 0x00007ff696fab6c0 lldb_private::CommandObjectParsed::Execute(char const *, class lldb_private::CommandReturnObject &) C:\Users\tcwg\david.spickett\llvm-project\lldb\source\Interpreter\CommandObject.cpp:751:0 # `----------------------------- # error: command failed with exit status: 0xc000001d ``` That might be a bug on the Windows side, or an artifact of how our build is setup, but whatever it is, having `CreatePluginObject` return an error and the caller check it, fixes the failing test. The built lldb can run the script command to use Python, but I'm not sure if that means anything.

DavidSpickett · 2023-10-27T11:26:16Z

02ef12d fixes the Windows test. If the behaviour seems suspicious to you, I can check more details of the build but I don't know anything about Scripted... so I'll need you to tell me what to look for.

…tedObject This was causing a build failure and I *think* holding up the automerger. It looks like this was deleted by an upstream commit llvm#68052 and perhaps mis-merged and therefore retained.

medismailben changed the title ~~[lldb] Unifying Scripted Affordance Interfaces~~ [lldb] Unifying Scripted Affordance Interfaces (wip) Oct 2, 2023

llvmbot added the lldb label Oct 2, 2023

medismailben force-pushed the main branch from 3ef039a to 286164f Compare October 21, 2023 09:53

medismailben requested a review from JDevlieghere as a code owner October 21, 2023 09:53

medismailben force-pushed the main branch 2 times, most recently from b0c7d2c to cd6c231 Compare October 24, 2023 00:14

medismailben changed the title ~~[lldb] Unifying Scripted Affordance Interfaces (wip)~~ [lldb/Interpreter] Make ScriptedInterface Object creation more generic Oct 24, 2023

medismailben requested a review from bulbazord October 24, 2023 00:16

JDevlieghere reviewed Oct 24, 2023

View reviewed changes

bulbazord reviewed Oct 24, 2023

View reviewed changes

medismailben force-pushed the main branch from cd6c231 to 4942cb5 Compare October 25, 2023 03:39

medismailben force-pushed the main branch from 4942cb5 to ef90c8a Compare October 25, 2023 03:41

JDevlieghere approved these changes Oct 25, 2023

View reviewed changes

medismailben merged commit f22d82c into llvm:main Oct 25, 2023

DavidSpickett added a commit that referenced this pull request Oct 26, 2023

[lldb][test][Windows] XFAIL IR memory map test

45ccc16

Since #68052 this has been failing. https://lab.llvm.org/buildbot/#/builders/219/builds/6545 Follow up changes have not fixed it, XFAIL while I debug it.

medismailben mentioned this pull request Oct 27, 2023

[lldb] Make use of Scripted{Python,}Interface for ScriptedThreadPlan #70392

Merged

aemerson mentioned this pull request Nov 6, 2023

Delete undeclared out-of-line definition of LLDBSwigPythonCreateScriptedObject swiftlang/llvm-project#7755

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[lldb/Interpreter] Make ScriptedInterface Object creation more generic#68052

[lldb/Interpreter] Make ScriptedInterface Object creation more generic#68052
medismailben merged 1 commit intollvm:mainfrom
medismailben:main

medismailben commented Oct 2, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Oct 3, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bulbazord left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JDevlieghere left a comment

Uh oh!

DavidSpickett commented Oct 26, 2023

Uh oh!

DavidSpickett commented Oct 26, 2023

Uh oh!

DavidSpickett commented Oct 26, 2023

Uh oh!

DavidSpickett commented Oct 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

medismailben commented Oct 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bulbazord left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JDevlieghere left a comment

Choose a reason for hiding this comment

Uh oh!

DavidSpickett commented Oct 26, 2023

Uh oh!

DavidSpickett commented Oct 26, 2023

Uh oh!

DavidSpickett commented Oct 26, 2023

Uh oh!

DavidSpickett commented Oct 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

medismailben commented Oct 2, 2023 •

edited

Loading

github-actions bot commented Oct 3, 2023 •

edited

Loading