Skip to content

[lldb] Make GetOutputStreamSP and GetErrorStreamSP protected #127682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2025
Merged

[lldb] Make GetOutputStreamSP and GetErrorStreamSP protected #127682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions lldb/include/lldb/Core/Debugger.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,13 @@ class Debugger : public std::enable_shared_from_this<Debugger>,

void SetAsyncExecution(bool async);

lldb::FileSP GetInputFileSP() { return m_input_file_sp; }

lldb::StreamFileSP GetOutputStreamSP() { return m_output_stream_sp; }

lldb::StreamFileSP GetErrorStreamSP() { return m_error_stream_sp; }

File &GetInputFile() { return *m_input_file_sp; }

File &GetOutputFile() { return m_output_stream_sp->GetFile(); }
lldb::FileSP GetInputFileSP() { return m_input_file_sp; }

lldb::FileSP GetOutputFileSP() { return m_output_stream_sp->GetFileSP(); }

File &GetErrorFile() { return m_error_stream_sp->GetFile(); }
lldb::FileSP GetErrorFileSP() { return m_error_stream_sp->GetFileSP(); }

repro::DataRecorder *GetInputRecorder();

Expand Down Expand Up @@ -649,6 +645,14 @@ class Debugger : public std::enable_shared_from_this<Debugger>,

void PrintProgress(const ProgressEventData &data);

/// Except for Debugger and IOHandler, GetOutputStreamSP and GetErrorStreamSP
/// should not be used directly. Use GetAsyncOutputStream and
/// GetAsyncErrorStream instead.
/// @{
lldb::StreamFileSP GetOutputStreamSP() { return m_output_stream_sp; }
lldb::StreamFileSP GetErrorStreamSP() { return m_error_stream_sp; }
/// @}

void PushIOHandler(const lldb::IOHandlerSP &reader_sp,
bool cancel_top_handler = true);

Expand Down
2 changes: 1 addition & 1 deletion lldb/include/lldb/Target/ThreadPlanTracer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class ThreadPlanTracer {
Process &m_process;
lldb::tid_t m_tid;

Stream *GetLogStream();
lldb::StreamSP GetLogStreamSP();

virtual void Log();

Expand Down
12 changes: 6 additions & 6 deletions lldb/source/API/SBDebugger.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,30 +509,30 @@ SBFile SBDebugger::GetInputFile() {
FILE *SBDebugger::GetOutputFileHandle() {
LLDB_INSTRUMENT_VA(this);
if (m_opaque_sp)
return m_opaque_sp->GetOutputStreamSP()->GetFile().GetStream();
return m_opaque_sp->GetOutputFileSP()->GetStream();
return nullptr;
}

SBFile SBDebugger::GetOutputFile() {
LLDB_INSTRUMENT_VA(this);
if (m_opaque_sp)
return SBFile(m_opaque_sp->GetOutputStreamSP()->GetFileSP());
return SBFile(m_opaque_sp->GetOutputFileSP());
return SBFile();
}

FILE *SBDebugger::GetErrorFileHandle() {
LLDB_INSTRUMENT_VA(this);

if (m_opaque_sp)
return m_opaque_sp->GetErrorStreamSP()->GetFile().GetStream();
return m_opaque_sp->GetErrorFileSP()->GetStream();
return nullptr;
}

SBFile SBDebugger::GetErrorFile() {
LLDB_INSTRUMENT_VA(this);
SBFile file;
if (m_opaque_sp)
return SBFile(m_opaque_sp->GetErrorStreamSP()->GetFileSP());
return SBFile(m_opaque_sp->GetErrorFileSP());
return SBFile();
}

Expand Down Expand Up @@ -573,8 +573,8 @@ void SBDebugger::HandleCommand(const char *command) {

sb_interpreter.HandleCommand(command, result, false);

result.PutError(m_opaque_sp->GetErrorStreamSP()->GetFileSP());
result.PutOutput(m_opaque_sp->GetOutputStreamSP()->GetFileSP());
result.PutError(m_opaque_sp->GetErrorFileSP());
result.PutOutput(m_opaque_sp->GetOutputFileSP());

if (!m_opaque_sp->GetAsyncExecution()) {
SBProcess process(GetCommandInterpreter().GetProcess());
Expand Down
8 changes: 4 additions & 4 deletions lldb/source/Commands/CommandObjectGUI.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ void CommandObjectGUI::DoExecute(Args &args, CommandReturnObject &result) {
#if LLDB_ENABLE_CURSES
Debugger &debugger = GetDebugger();

File &input = debugger.GetInputFile();
File &output = debugger.GetOutputFile();
if (input.GetStream() && output.GetStream() && input.GetIsRealTerminal() &&
input.GetIsInteractive()) {
FileSP input_sp = debugger.GetInputFileSP();
FileSP output_sp = debugger.GetOutputFileSP();
if (input_sp->GetStream() && output_sp->GetStream() &&
input_sp->GetIsRealTerminal() && input_sp->GetIsInteractive()) {
IOHandlerSP io_handler_sp(new IOHandlerCursesGUI(debugger));
if (io_handler_sp)
debugger.RunIOHandlerAsync(io_handler_sp);
Expand Down
3 changes: 2 additions & 1 deletion lldb/source/Commands/CommandObjectLog.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,8 @@ class CommandObjectLogDump : public CommandObjectParsed {
(*file)->GetDescriptor(), /*shouldClose=*/true);
} else {
stream_up = std::make_unique<llvm::raw_fd_ostream>(
GetDebugger().GetOutputFile().GetDescriptor(), /*shouldClose=*/false);
GetDebugger().GetOutputFileSP()->GetDescriptor(),
/*shouldClose=*/false);
}

const std::string channel = std::string(args[0].ref());
Expand Down
8 changes: 4 additions & 4 deletions lldb/source/Core/Debugger.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -947,7 +947,7 @@ Debugger::Debugger(lldb::LogOutputCallback log_callback, void *baton)
if (term && !strcmp(term, "dumb"))
SetUseColor(false);
// Turn off use-color if we don't write to a terminal with color support.
if (!GetOutputFile().GetIsTerminalWithColors())
if (!GetOutputFileSP()->GetIsTerminalWithColors())
SetUseColor(false);

if (Diagnostics::Enabled()) {
Expand Down Expand Up @@ -1678,7 +1678,7 @@ bool Debugger::EnableLog(llvm::StringRef channel,
LLDB_LOG_OPTION_PREPEND_TIMESTAMP | LLDB_LOG_OPTION_PREPEND_THREAD_NAME;
} else if (log_file.empty()) {
log_handler_sp =
CreateLogHandler(log_handler_kind, GetOutputFile().GetDescriptor(),
CreateLogHandler(log_handler_kind, GetOutputFileSP()->GetDescriptor(),
/*should_close=*/false, buffer_size);
} else {
auto pos = m_stream_handlers.find(log_file);
Expand Down Expand Up @@ -2111,8 +2111,8 @@ void Debugger::HandleProgressEvent(const lldb::EventSP &event_sp) {
// Determine whether the current output file is an interactive terminal with
// color support. We assume that if we support ANSI escape codes we support
// vt100 escape codes.
File &file = GetOutputFile();
if (!file.GetIsInteractive() || !file.GetIsTerminalWithColors())
FileSP file_sp = GetOutputFileSP();
if (!file_sp->GetIsInteractive() || !file_sp->GetIsTerminalWithColors())
return;

StreamSP output = GetAsyncOutputStream();
Expand Down
4 changes: 2 additions & 2 deletions lldb/source/Interpreter/CommandInterpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2837,8 +2837,8 @@ void CommandInterpreter::HandleCommandsFromFile(
}

if (flags & eHandleCommandFlagPrintResult) {
debugger.GetOutputFile().Printf("Executing commands in '%s'.\n",
cmd_file_path.c_str());
debugger.GetOutputFileSP()->Printf("Executing commands in '%s'.\n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one of those suspicious calls.

cmd_file_path.c_str());
}

// Used for inheriting the right settings when "command source" might
Expand Down
4 changes: 2 additions & 2 deletions lldb/source/Interpreter/ScriptInterpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,8 @@ ScriptInterpreterIORedirect::ScriptInterpreterIORedirect(
if (outfile_handle)
::setbuf(outfile_handle, nullptr);

result->SetImmediateOutputFile(debugger.GetOutputStreamSP()->GetFileSP());
result->SetImmediateErrorFile(debugger.GetErrorStreamSP()->GetFileSP());
result->SetImmediateOutputFile(debugger.GetOutputFileSP());
result->SetImmediateErrorFile(debugger.GetErrorFileSP());
}
}

Expand Down
9 changes: 5 additions & 4 deletions lldb/source/Plugins/DynamicLoader/Darwin-Kernel/DynamicLoaderDarwinKernel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1193,7 +1193,7 @@ bool DynamicLoaderDarwinKernel::ReadKextSummaryHeader() {
m_kext_summary_header.version = data.GetU32(&offset);
if (m_kext_summary_header.version > 128) {
lldb::StreamSP s =
m_process->GetTarget().GetDebugger().GetOutputStreamSP();
m_process->GetTarget().GetDebugger().GetAsyncOutputStream();
s->Printf("WARNING: Unable to read kext summary header, got "
"improbable version number %u\n",
m_kext_summary_header.version);
Expand All @@ -1208,7 +1208,7 @@ bool DynamicLoaderDarwinKernel::ReadKextSummaryHeader() {
// If we get an improbably large entry_size, we're probably
// getting bad memory.
lldb::StreamSP s =
m_process->GetTarget().GetDebugger().GetOutputStreamSP();
m_process->GetTarget().GetDebugger().GetAsyncOutputStream();
s->Printf("WARNING: Unable to read kext summary header, got "
"improbable entry_size %u\n",
m_kext_summary_header.entry_size);
Expand All @@ -1226,7 +1226,7 @@ bool DynamicLoaderDarwinKernel::ReadKextSummaryHeader() {
// If we get an improbably large number of kexts, we're probably
// getting bad memory.
lldb::StreamSP s =
m_process->GetTarget().GetDebugger().GetOutputStreamSP();
m_process->GetTarget().GetDebugger().GetAsyncOutputStream();
s->Printf("WARNING: Unable to read kext summary header, got "
"improbable number of kexts %u\n",
m_kext_summary_header.entry_count);
Expand Down Expand Up @@ -1330,7 +1330,8 @@ bool DynamicLoaderDarwinKernel::ParseKextSummaries(
number_of_old_kexts_being_removed == 0)
return true;

lldb::StreamSP s = m_process->GetTarget().GetDebugger().GetOutputStreamSP();
lldb::StreamSP s =
m_process->GetTarget().GetDebugger().GetAsyncOutputStream();
if (load_kexts) {
if (number_of_new_kexts_being_added > 0 &&
number_of_old_kexts_being_removed > 0) {
Expand Down
2 changes: 0 additions & 2 deletions lldb/source/Plugins/InstrumentationRuntime/UBSan/InstrumentationRuntimeUBSan.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,6 @@ StructuredData::ObjectSP InstrumentationRuntimeUBSan::RetrieveReportData(
if (!frame_sp)
return StructuredData::ObjectSP();

StreamFileSP Stream = target.GetDebugger().GetOutputStreamSP();

EvaluateExpressionOptions options;
options.SetUnwindOnError(true);
options.SetTryAllThreads(true);
Expand Down
4 changes: 2 additions & 2 deletions lldb/source/Plugins/InstrumentationRuntime/Utility/ReportRetriever.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,8 @@ bool ReportRetriever::NotifyBreakpointHit(ProcessSP process_sp,
InstrumentationRuntimeStopInfo::CreateStopReasonWithInstrumentationData(
*thread_sp, description, report));

if (StreamFileSP stream_sp = StreamFileSP(
process_sp->GetTarget().GetDebugger().GetOutputStreamSP()))
if (StreamSP stream_sp =
process_sp->GetTarget().GetDebugger().GetAsyncOutputStream())
stream_sp->Printf("AddressSanitizer report breakpoint hit. Use 'thread "
"info -s' to get extended information about the "
"report.\n");
Expand Down
4 changes: 2 additions & 2 deletions lldb/source/Plugins/ScriptInterpreter/Lua/ScriptInterpreterLua.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ class IOHandlerLuaInterpreter : public IOHandlerDelegate,
m_script_interpreter(script_interpreter),
m_active_io_handler(active_io_handler) {
llvm::cantFail(m_script_interpreter.GetLua().ChangeIO(
debugger.GetOutputFile().GetStream(),
debugger.GetErrorFile().GetStream()));
debugger.GetOutputFileSP()->GetStream(),
debugger.GetErrorFileSP()->GetStream()));
llvm::cantFail(m_script_interpreter.EnterSession(debugger.GetID()));
}

Expand Down
39 changes: 20 additions & 19 deletions lldb/source/Target/ThreadPlanTracer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
#include "lldb/Utility/LLDBLog.h"
#include "lldb/Utility/Log.h"
#include "lldb/Utility/State.h"
#include "lldb/lldb-forward.h"

using namespace lldb;
using namespace lldb_private;
Expand All @@ -41,13 +42,13 @@ ThreadPlanTracer::ThreadPlanTracer(Thread &thread)
: m_process(*thread.GetProcess().get()), m_tid(thread.GetID()),
m_enabled(false), m_stream_sp(), m_thread(nullptr) {}

Stream *ThreadPlanTracer::GetLogStream() {
StreamSP ThreadPlanTracer::GetLogStreamSP() {
if (m_stream_sp)
return m_stream_sp.get();
return m_stream_sp;
else {
TargetSP target_sp(GetThread().CalculateTarget());
if (target_sp)
return target_sp->GetDebugger().GetOutputStreamSP().get();
return target_sp->GetDebugger().GetAsyncOutputStream();
}
return nullptr;
}
Expand All @@ -65,12 +66,11 @@ void ThreadPlanTracer::Log() {
bool show_frame_index = false;
bool show_fullpaths = false;

Stream *stream = GetLogStream();
if (stream) {
GetThread().GetStackFrameAtIndex(0)->Dump(stream, show_frame_index,
if (StreamSP stream_sp = GetLogStreamSP()) {
GetThread().GetStackFrameAtIndex(0)->Dump(stream_sp.get(), show_frame_index,
show_fullpaths);
stream->Printf("\n");
stream->Flush();
stream_sp->Printf("\n");
stream_sp->Flush();
}
}

Expand Down Expand Up @@ -129,9 +129,9 @@ void ThreadPlanAssemblyTracer::TracingStarted() {
void ThreadPlanAssemblyTracer::TracingEnded() { m_register_values.clear(); }

void ThreadPlanAssemblyTracer::Log() {
Stream *stream = GetLogStream();
StreamSP stream_sp = GetLogStreamSP();

if (!stream)
if (!stream_sp)
return;

RegisterContext *reg_ctx = GetThread().GetRegisterContext().get();
Expand All @@ -142,9 +142,10 @@ void ThreadPlanAssemblyTracer::Log() {
uint8_t buffer[16] = {0}; // Must be big enough for any single instruction
addr_valid = m_process.GetTarget().ResolveLoadAddress(pc, pc_addr);

pc_addr.Dump(stream, &GetThread(), Address::DumpStyleResolvedDescription,
pc_addr.Dump(stream_sp.get(), &GetThread(),
Address::DumpStyleResolvedDescription,
Address::DumpStyleModuleWithFileAddress);
stream->PutCString(" ");
stream_sp->PutCString(" ");

Disassembler *disassembler = GetDisassembler();
if (disassembler) {
Expand Down Expand Up @@ -175,7 +176,7 @@ void ThreadPlanAssemblyTracer::Log() {
instruction_list.GetInstructionAtIndex(0).get();
const FormatEntity::Entry *disassemble_format =
m_process.GetTarget().GetDebugger().GetDisassemblyFormat();
instruction->Dump(stream, max_opcode_byte_size, show_address,
instruction->Dump(stream_sp.get(), max_opcode_byte_size, show_address,
show_bytes, show_control_flow_kind, nullptr, nullptr,
nullptr, disassemble_format, 0);
}
Expand All @@ -198,12 +199,12 @@ void ThreadPlanAssemblyTracer::Log() {

if (abi->GetArgumentValues(GetThread(), value_list)) {
for (int arg_index = 0; arg_index < num_args; ++arg_index) {
stream->Printf(
stream_sp->Printf(
"\n\targ[%d]=%llx", arg_index,
value_list.GetValueAtIndex(arg_index)->GetScalar().ULongLong());

if (arg_index + 1 < num_args)
stream->PutCString(", ");
stream_sp->PutCString(", ");
}
}
}
Expand All @@ -222,14 +223,14 @@ void ThreadPlanAssemblyTracer::Log() {
if (m_register_values[reg_num].GetType() == RegisterValue::eTypeInvalid ||
reg_value != m_register_values[reg_num]) {
if (reg_value.GetType() != RegisterValue::eTypeInvalid) {
stream->PutCString("\n\t");
DumpRegisterValue(reg_value, *stream, *reg_info, true, false,
stream_sp->PutCString("\n\t");
DumpRegisterValue(reg_value, *stream_sp, *reg_info, true, false,
eFormatDefault);
}
}
m_register_values[reg_num] = reg_value;
}
}
stream->EOL();
stream->Flush();
stream_sp->EOL();
stream_sp->Flush();
}