Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
3 changes: 3 additions & 0 deletions lldb/include/lldb/API/SBDebugger.h
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,9 @@ class LLDB_API SBDebugger {
lldb::SBTarget FindTargetWithFileAndArch(const char *filename,
const char *arch);

/// Find a target with the specified unique ID
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// Find a target with the specified unique ID
/// Find a target with the specified unique ID.

lldb::SBTarget FindTargetWithUniqueID(uint32_t id);

/// Get the number of targets in the debugger.
uint32_t GetNumTargets();

Expand Down
2 changes: 2 additions & 0 deletions lldb/include/lldb/API/SBTarget.h
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,8 @@ class LLDB_API SBTarget {

const char *GetLabel() const;

uint32_t GetUniqueID() const;

SBError SetLabel(const char *label);

/// Architecture opcode byte size width accessor
Expand Down
7 changes: 7 additions & 0 deletions lldb/include/lldb/Target/Target.h
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,12 @@ class Target : public std::enable_shared_from_this<Target>,

bool IsDummyTarget() const { return m_is_dummy_target; }

/// Get the unique ID for this target.
///
/// \return
/// The unique ID for this target, or 0 if no ID has been assigned.
uint32_t GetUniqueID() const { return m_target_unique_id; }

const std::string &GetLabel() const { return m_label; }

/// Set a label for a target.
Expand Down Expand Up @@ -1651,6 +1657,7 @@ class Target : public std::enable_shared_from_this<Target>,
bool m_suppress_stop_hooks; /// Used to not run stop hooks for expressions
bool m_is_dummy_target;
unsigned m_next_persistent_variable_index = 0;
uint32_t m_target_unique_id = 0; /// The unique ID assigned to this target
/// An optional \a lldb_private::Trace object containing processor trace
/// information of this target.
lldb::TraceSP m_trace_sp;
Expand Down
2 changes: 2 additions & 0 deletions lldb/include/lldb/Target/TargetList.h
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ class TargetList : public Broadcaster {

lldb::TargetSP FindTargetWithProcess(lldb_private::Process *process) const;

lldb::TargetSP FindTargetWithUniqueID(uint32_t id) const;

lldb::TargetSP GetTargetSP(Target *target) const;

/// Send an async interrupt to one or all processes.
Expand Down
10 changes: 10 additions & 0 deletions lldb/source/API/SBDebugger.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -983,6 +983,16 @@ uint32_t SBDebugger::GetIndexOfTarget(lldb::SBTarget target) {
return m_opaque_sp->GetTargetList().GetIndexOfTarget(target.GetSP());
}

SBTarget SBDebugger::FindTargetWithUniqueID(uint32_t id) {
LLDB_INSTRUMENT_VA(this, id);
SBTarget sb_target;
if (m_opaque_sp) {
// No need to lock, the target list is thread safe
sb_target.SetSP(m_opaque_sp->GetTargetList().FindTargetWithUniqueID(id));
}
return sb_target;
}

SBTarget SBDebugger::FindTargetWithProcessID(lldb::pid_t pid) {
LLDB_INSTRUMENT_VA(this, pid);

Expand Down
8 changes: 8 additions & 0 deletions lldb/source/API/SBTarget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1632,6 +1632,14 @@ const char *SBTarget::GetLabel() const {
return nullptr;
}

uint32_t SBTarget::GetUniqueID() const {
LLDB_INSTRUMENT_VA(this);

if (TargetSP target_sp = GetSP())
return target_sp->GetUniqueID();
return 0;
}

SBError SBTarget::SetLabel(const char *label) {
LLDB_INSTRUMENT_VA(this, label);

Expand Down
16 changes: 16 additions & 0 deletions lldb/source/Target/TargetList.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,8 @@ Status TargetList::CreateTargetInternal(Debugger &debugger,
Status error;
const bool is_dummy_target = false;

static uint32_t g_target_unique_id = 0;

ArchSpec arch(specified_arch);

if (arch.IsValid()) {
Expand Down Expand Up @@ -344,6 +346,8 @@ Status TargetList::CreateTargetInternal(Debugger &debugger,
if (!target_sp)
return error;

target_sp->m_target_unique_id = ++g_target_unique_id;
Copy link
Member

Choose a reason for hiding this comment

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

instead of having a temporary state in which the unique_id is 0, better set this ID within the constructor of lldb_private::Target.
The ID should be > 0. This will cause that naturally the dummy target has ID 1.

For the SBTarget case, if the SBTarget is invalid (no valid pointer to *Target), you can create a new define LLDB_INVALID_TARGET_ID=0, just like LLDB_INVALID_ADDRESS. And then you return it in that case.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, this seems much simpler to me, and I see no reason to delay assigning the Target's unique ID.


// Set argv0 with what the user typed, unless the user specified a
// directory. If the user specified a directory, then it is probably a
// bundle that was resolved and we need to use the resolved bundle path
Expand Down Expand Up @@ -428,6 +432,18 @@ TargetSP TargetList::FindTargetWithProcess(Process *process) const {
return target_sp;
}

TargetSP TargetList::FindTargetWithUniqueID(uint32_t id) const {
std::lock_guard<std::recursive_mutex> guard(m_target_list_mutex);
auto it = llvm::find_if(m_target_list, [id](const TargetSP &item) {
return item->GetUniqueID() == id;
});

if (it != m_target_list.end())
return *it;

return TargetSP();
}

TargetSP TargetList::GetTargetSP(Target *target) const {
TargetSP target_sp;
if (!target)
Expand Down
103 changes: 103 additions & 0 deletions lldb/test/API/python_api/debugger/TestDebuggerAPI.py
Original file line number Diff line number Diff line change
Expand Up @@ -294,3 +294,106 @@ def test_version(self):

self.assertEqual(instance_str, class_str)
self.assertEqual(class_str, property_str)

def test_find_target_with_unique_id(self):
"""Test SBDebugger.FindTargetWithUniqueID() functionality."""

# Test with invalid ID - should return invalid target
invalid_target = self.dbg.FindTargetWithUniqueID(999999)
self.assertFalse(invalid_target.IsValid())

# Test with ID 0 - should return invalid target
zero_target = self.dbg.FindTargetWithUniqueID(0)
self.assertFalse(zero_target.IsValid())

# Build a real executable and create target with it
self.build()
exe = self.getBuildArtifact("a.out")
target = self.dbg.CreateTarget(exe)
self.assertTrue(target.IsValid())

# Find the target using its unique ID
unique_id = target.GetUniqueID()
self.assertNotEqual(unique_id, 0)
found_target = self.dbg.FindTargetWithUniqueID(unique_id)
self.assertTrue(found_target.IsValid())
self.assertEqual(
self.dbg.GetIndexOfTarget(target), self.dbg.GetIndexOfTarget(found_target)
)
self.assertEqual(found_target.GetUniqueID(), unique_id)

def test_target_unique_id_uniqueness(self):
"""Test that Target.GetUniqueID() returns unique values across multiple targets."""

# Create multiple targets and verify they all have unique IDs
self.build()
exe = self.getBuildArtifact("a.out")
targets = []
unique_ids = set()

for i in range(10):
target = self.dbg.CreateTarget(exe)
self.assertTrue(target.IsValid())

unique_id = target.GetUniqueID()
self.assertNotEqual(unique_id, 0)

# Verify this ID hasn't been used before
self.assertNotIn(
unique_id, unique_ids, f"Duplicate unique ID found: {unique_id}"
)

unique_ids.add(unique_id)
targets.append(target)

# Verify all targets can still be found by their IDs
for target in targets:
unique_id = target.GetUniqueID()
found = self.dbg.FindTargetWithUniqueID(unique_id)
self.assertTrue(found.IsValid())
self.assertEqual(found.GetUniqueID(), unique_id)

def test_target_unique_id_uniqueness_after_deletion(self):
"""Test finding targets have unique ID after target deletion."""
# Create two targets
self.build()
exe = self.getBuildArtifact("a.out")
target1 = self.dbg.CreateTarget(exe)
target2 = self.dbg.CreateTarget(exe)
self.assertTrue(target1.IsValid())
self.assertTrue(target2.IsValid())

unique_id1 = target1.GetUniqueID()
unique_id2 = target2.GetUniqueID()
self.assertNotEqual(unique_id1, 0)
self.assertNotEqual(unique_id2, 0)
self.assertNotEqual(unique_id1, unique_id2)

# Verify we can find them initially
found_target1 = self.dbg.FindTargetWithUniqueID(unique_id1)
found_target2 = self.dbg.FindTargetWithUniqueID(unique_id2)
self.assertTrue(found_target1.IsValid())
self.assertTrue(found_target2.IsValid())
target2_index = self.dbg.GetIndexOfTarget(target2)

# Delete target 2
deleted = self.dbg.DeleteTarget(target2)
self.assertTrue(deleted)

# Try to find the deleted target - should not be found
not_found_target = self.dbg.FindTargetWithUniqueID(unique_id2)
self.assertFalse(not_found_target.IsValid())

# Create a new target
target3 = self.dbg.CreateTarget(exe)
self.assertTrue(target3.IsValid())
# Target list index of target3 should be the same as target2's
# since it was deleted, but it should have a distinct unique ID
target3_index = self.dbg.GetIndexOfTarget(target3)
unique_id3 = target3.GetUniqueID()
self.assertEqual(target3_index, target2_index)
self.assertNotEqual(unique_id3, unique_id2)
self.assertNotEqual(unique_id3, unique_id1)
# Make sure we can find the new target
found_target3 = self.dbg.FindTargetWithUniqueID(target3.GetUniqueID())
self.assertTrue(found_target3.IsValid())
Loading