5bb742b10d
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>
113 lines
3.9 KiB
C++
113 lines
3.9 KiB
C++
//===-- CommandObjectQuit.cpp ---------------------------------------------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "CommandObjectQuit.h"
|
|
|
|
#include "lldb/Interpreter/CommandInterpreter.h"
|
|
#include "lldb/Interpreter/CommandReturnObject.h"
|
|
#include "lldb/Target/Process.h"
|
|
#include "lldb/Utility/StreamString.h"
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
|
|
// CommandObjectQuit
|
|
|
|
CommandObjectQuit::CommandObjectQuit(CommandInterpreter &interpreter)
|
|
: CommandObjectParsed(interpreter, "quit", "Quit the LLDB debugger.",
|
|
"quit [exit-code]") {}
|
|
|
|
CommandObjectQuit::~CommandObjectQuit() {}
|
|
|
|
// returns true if there is at least one alive process is_a_detach will be true
|
|
// if all alive processes will be detached when you quit and false if at least
|
|
// one process will be killed instead
|
|
bool CommandObjectQuit::ShouldAskForConfirmation(bool &is_a_detach) {
|
|
if (!m_interpreter.GetPromptOnQuit())
|
|
return false;
|
|
bool should_prompt = false;
|
|
is_a_detach = true;
|
|
for (uint32_t debugger_idx = 0; debugger_idx < Debugger::GetNumDebuggers();
|
|
debugger_idx++) {
|
|
DebuggerSP debugger_sp(Debugger::GetDebuggerAtIndex(debugger_idx));
|
|
if (!debugger_sp)
|
|
continue;
|
|
const TargetList &target_list(debugger_sp->GetTargetList());
|
|
for (uint32_t target_idx = 0;
|
|
target_idx < static_cast<uint32_t>(target_list.GetNumTargets());
|
|
target_idx++) {
|
|
TargetSP target_sp(target_list.GetTargetAtIndex(target_idx));
|
|
if (!target_sp)
|
|
continue;
|
|
ProcessSP process_sp(target_sp->GetProcessSP());
|
|
if (process_sp && process_sp->IsValid() && process_sp->IsAlive() &&
|
|
process_sp->WarnBeforeDetach()) {
|
|
should_prompt = true;
|
|
if (!process_sp->GetShouldDetach()) {
|
|
// if we need to kill at least one process, just say so and return
|
|
is_a_detach = false;
|
|
return should_prompt;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return should_prompt;
|
|
}
|
|
|
|
bool CommandObjectQuit::DoExecute(Args &command, CommandReturnObject &result) {
|
|
bool is_a_detach = true;
|
|
if (ShouldAskForConfirmation(is_a_detach)) {
|
|
StreamString message;
|
|
message.Printf("Quitting LLDB will %s one or more processes. Do you really "
|
|
"want to proceed",
|
|
(is_a_detach ? "detach from" : "kill"));
|
|
if (!m_interpreter.Confirm(message.GetString(), true)) {
|
|
result.SetStatus(eReturnStatusFailed);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (command.GetArgumentCount() > 1) {
|
|
result.AppendError("Too many arguments for 'quit'. Only an optional exit "
|
|
"code is allowed");
|
|
result.SetStatus(eReturnStatusFailed);
|
|
return false;
|
|
}
|
|
|
|
// We parse the exit code argument if there is one.
|
|
if (command.GetArgumentCount() == 1) {
|
|
llvm::StringRef arg = command.GetArgumentAtIndex(0);
|
|
int exit_code;
|
|
if (arg.getAsInteger(/*autodetect radix*/ 0, exit_code)) {
|
|
lldb_private::StreamString s;
|
|
std::string arg_str = arg.str();
|
|
s.Printf("Couldn't parse '%s' as integer for exit code.", arg_str.data());
|
|
result.AppendError(s.GetString());
|
|
result.SetStatus(eReturnStatusFailed);
|
|
return false;
|
|
}
|
|
if (!m_interpreter.SetQuitExitCode(exit_code)) {
|
|
result.AppendError("The current driver doesn't allow custom exit codes"
|
|
" for the quit command.");
|
|
result.SetStatus(eReturnStatusFailed);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
const uint32_t event_type =
|
|
CommandInterpreter::eBroadcastBitQuitCommandReceived;
|
|
m_interpreter.BroadcastEvent(event_type);
|
|
result.SetStatus(eReturnStatusQuit);
|
|
|
|
|
|
if (m_interpreter.GetSaveSessionOnQuit())
|
|
m_interpreter.SaveTranscript(result);
|
|
|
|
return true;
|
|
}
|