forked from swiftlang/llvm-project
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[lldb/interpreter] Add ability to save lldb session to a file
This patch introduce a new feature that allows the users to save their debugging session's transcript (commands + outputs) to a file. It differs from the reproducers since it doesn't require to capture a session preemptively and replay the reproducer file in lldb. The user can choose the save its session manually using the session save command or automatically by setting the interpreter.save-session-on-quit on their init file. To do so, the patch adds a Stream object to the CommandInterpreter that will hold the input command from the IOHandler and the CommandReturnObject output and error. This way, that stream object accumulates passively all the interactions throughout the session and will save them to disk on demand. The user can specify a file path where the session's transcript will be saved. However, it is optional, and when it is not provided, lldb will create a temporary file name according to the session date and time. rdar://63347792 Differential Revision: https://reviews.llvm.org/D82155 Signed-off-by: Med Ismail Bennani <medismail.bennani@gmail.com>
- Loading branch information
1 parent
a4bbc3b
commit 5bb742b
Showing
8 changed files
with
246 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| #include "CommandObjectSession.h" | ||
| #include "lldb/Interpreter/CommandInterpreter.h" | ||
| #include "lldb/Interpreter/CommandReturnObject.h" | ||
|
|
||
| using namespace lldb; | ||
| using namespace lldb_private; | ||
|
|
||
| class CommandObjectSessionSave : public CommandObjectParsed { | ||
| public: | ||
| CommandObjectSessionSave(CommandInterpreter &interpreter) | ||
| : CommandObjectParsed(interpreter, "session save", | ||
| "Save the current session transcripts to a file.\n" | ||
| "If no file if specified, transcripts will be " | ||
| "saved to a temporary file.", | ||
| "session save [file]") { | ||
| CommandArgumentEntry arg1; | ||
| arg1.emplace_back(eArgTypePath, eArgRepeatOptional); | ||
| m_arguments.push_back(arg1); | ||
| } | ||
|
|
||
| ~CommandObjectSessionSave() override = default; | ||
|
|
||
| void | ||
| HandleArgumentCompletion(CompletionRequest &request, | ||
| OptionElementVector &opt_element_vector) override { | ||
| CommandCompletions::InvokeCommonCompletionCallbacks( | ||
| GetCommandInterpreter(), CommandCompletions::eDiskFileCompletion, | ||
| request, nullptr); | ||
| } | ||
|
|
||
| protected: | ||
| bool DoExecute(Args &args, CommandReturnObject &result) override { | ||
| llvm::StringRef file_path; | ||
|
|
||
| if (!args.empty()) | ||
| file_path = args[0].ref(); | ||
|
|
||
| if (m_interpreter.SaveTranscript(result, file_path.str())) | ||
| result.SetStatus(eReturnStatusSuccessFinishNoResult); | ||
| else | ||
| result.SetStatus(eReturnStatusFailed); | ||
| return result.Succeeded(); | ||
| } | ||
| }; | ||
|
|
||
| CommandObjectSession::CommandObjectSession(CommandInterpreter &interpreter) | ||
| : CommandObjectMultiword(interpreter, "session", | ||
| "Commands controlling LLDB session.", | ||
| "session <subcommand> [<command-options>]") { | ||
| LoadSubCommand("save", | ||
| CommandObjectSP(new CommandObjectSessionSave(interpreter))); | ||
| // TODO: Move 'history' subcommand from CommandObjectCommands. | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| //===-- CommandObjectSession.h ----------------------------------*- C++ -*-===// | ||
| // | ||
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | ||
| // See https://llvm.org/LICENSE.txt for license information. | ||
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #ifndef LLDB_SOURCE_COMMANDS_COMMANDOBJECTSESSION_H | ||
| #define LLDB_SOURCE_COMMANDS_COMMANDOBJECTSESSION_H | ||
|
|
||
| #include "lldb/Interpreter/CommandObjectMultiword.h" | ||
|
|
||
| namespace lldb_private { | ||
|
|
||
| class CommandObjectSession : public CommandObjectMultiword { | ||
| public: | ||
| CommandObjectSession(CommandInterpreter &interpreter); | ||
| }; | ||
|
|
||
| } // namespace lldb_private | ||
|
|
||
| #endif // LLDB_SOURCE_COMMANDS_COMMANDOBJECTSESSION_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| """ | ||
| Test the session save feature | ||
| """ | ||
|
|
||
| import lldb | ||
| from lldbsuite.test.decorators import * | ||
| from lldbsuite.test.lldbtest import * | ||
| from lldbsuite.test import lldbutil | ||
|
|
||
|
|
||
| class SessionSaveTestCase(TestBase): | ||
|
|
||
| mydir = TestBase.compute_mydir(__file__) | ||
|
|
||
| def raw_transcript_builder(self, cmd, res): | ||
| raw = "(lldb) " + cmd + "\n" | ||
| if res.GetOutputSize(): | ||
| raw += res.GetOutput() | ||
| if res.GetErrorSize(): | ||
| raw += res.GetError() | ||
| return raw | ||
|
|
||
|
|
||
| @skipIfWindows | ||
| @skipIfReproducer | ||
| @no_debug_info_test | ||
| def test_session_save(self): | ||
| raw = "" | ||
| interpreter = self.dbg.GetCommandInterpreter() | ||
|
|
||
| settings = [ | ||
| 'settings set interpreter.echo-commands true', | ||
| 'settings set interpreter.echo-comment-commands true', | ||
| 'settings set interpreter.stop-command-source-on-error false' | ||
| ] | ||
|
|
||
| for setting in settings: | ||
| interpreter.HandleCommand(setting, lldb.SBCommandReturnObject()) | ||
|
|
||
| inputs = [ | ||
| '# This is a comment', # Comment | ||
| 'help session', # Valid command | ||
| 'Lorem ipsum' # Invalid command | ||
| ] | ||
|
|
||
| for cmd in inputs: | ||
| res = lldb.SBCommandReturnObject() | ||
| interpreter.HandleCommand(cmd, res) | ||
| raw += self.raw_transcript_builder(cmd, res) | ||
|
|
||
| self.assertTrue(interpreter.HasCommands()) | ||
| self.assertTrue(len(raw) != 0) | ||
|
|
||
| # Check for error | ||
| cmd = 'session save /root/file' | ||
| interpreter.HandleCommand(cmd, res) | ||
| self.assertFalse(res.Succeeded()) | ||
| raw += self.raw_transcript_builder(cmd, res) | ||
|
|
||
| import tempfile | ||
| tf = tempfile.NamedTemporaryFile() | ||
| output_file = tf.name | ||
|
|
||
| res = lldb.SBCommandReturnObject() | ||
| interpreter.HandleCommand('session save ' + output_file, res) | ||
| self.assertTrue(res.Succeeded()) | ||
| raw += self.raw_transcript_builder(cmd, res) | ||
|
|
||
| with open(output_file, "r") as file: | ||
| content = file.read() | ||
| # Exclude last line, since session won't record it's own output | ||
| lines = raw.splitlines()[:-1] | ||
| for line in lines: | ||
| self.assertIn(line, content) |