Add GetSessionName, remove GetSessionNameFromEvent

Author: qxy11

lldb/include/lldb/API/SBTarget.h

@@ -70,8 +70,6 @@ class LLDB_API SBTarget {
   static lldb::SBModule GetModuleAtIndexFromEvent(const uint32_t idx,
                                                   const lldb::SBEvent &event);
 
-  static const char *GetSessionNameFromEvent(const SBEvent &event);
-
   static const char *GetBroadcasterClassName();
 
   lldb::SBProcess GetProcess();
@@ -368,6 +366,16 @@ class LLDB_API SBTarget {
   ///     LLDB_INVALID_GLOBALLY_UNIQUE_TARGET_ID if the target is invalid.
   lldb::user_id_t GetGloballyUniqueID() const;
 
+  /// Get the target session name for this target.
+  ///
+  /// The target session name provides a meaningful name for IDEs or tools to
+  /// display to help the user identify the origin and purpose of the target.
+  ///
+  /// \return
+  ///     The target session name for this target, or nullptr if the target is
+  ///     invalid or has no target session name.
+  const char *GetTargetSessionName() const;
+
   SBError SetLabel(const char *label);
 
   /// Architecture opcode byte size width accessor

lldb/include/lldb/Target/Target.h

@@ -557,11 +557,6 @@ class Target : public std::enable_shared_from_this<Target>,
     TargetEventData(const lldb::TargetSP &target_sp,
                     const ModuleList &module_list);
 
-    TargetEventData(const lldb::TargetSP &target_sp, std::string session_name);
-
-    TargetEventData(const lldb::TargetSP &target_sp,
-                    const ModuleList &module_list, std::string session_name);
-
     ~TargetEventData() override;
 
     static llvm::StringRef GetFlavorString();
@@ -570,8 +565,6 @@ class Target : public std::enable_shared_from_this<Target>,
       return TargetEventData::GetFlavorString();
     }
 
-    static llvm::StringRef GetSessionNameFromEvent(const Event *event_ptr);
-
     void Dump(Stream *s) const override;
 
     static const TargetEventData *GetEventDataFromEvent(const Event *event_ptr);
@@ -587,7 +580,6 @@ class Target : public std::enable_shared_from_this<Target>,
   private:
     lldb::TargetSP m_target_sp;
     ModuleList m_module_list;
-    std::string m_session_name;
 
     TargetEventData(const TargetEventData &) = delete;
     const TargetEventData &operator=(const TargetEventData &) = delete;
@@ -631,6 +623,30 @@ class Target : public std::enable_shared_from_this<Target>,
   ///     requirements.
   llvm::Error SetLabel(llvm::StringRef label);
 
+  /// Get the target session name for this target.
+  ///
+  /// Provides a meaningful name for IDEs or tools to display for dynamically
+  /// created targets. Defaults to "Session {ID}" based on the globally unique
+  /// ID.
+  ///
+  /// \return
+  ///     The target session name for this target.
+  const std::string &GetTargetSessionName() { return m_target_session_name; }
+
+  /// Set the target session name for this target.
+  ///
+  /// This should typically be set along with the event
+  /// eBroadcastBitNewTargetCreated. Useful for scripts or triggers that
+  /// automatically create targets and want to provide meaningful names that
+  /// IDEs or other tools can display to help users identify the origin and
+  /// purpose of each target.
+  ///
+  /// \param[in] target_session_name
+  ///     The target session name to set for this target.
+  void SetTargetSessionName(llvm::StringRef target_session_name) {
+    m_target_session_name = target_session_name.str();
+  }
+
   /// Find a binary on the system and return its Module,
   /// or return an existing Module that is already in the Target.
   ///
@@ -1672,8 +1688,11 @@ class Target : public std::enable_shared_from_this<Target>,
   bool m_is_dummy_target;
   unsigned m_next_persistent_variable_index = 0;
   lldb::user_id_t m_target_unique_id =
-      LLDB_INVALID_GLOBALLY_UNIQUE_TARGET_ID; /// The globally unique ID
+      LLDB_INVALID_GLOBALLY_UNIQUE_TARGET_ID; ///< The globally unique ID
                                               /// assigned to this target
+  std::string m_target_session_name; ///< The target session name for this
+                                     /// target, used to name debugging
+                                     /// sessions in DAP.
   /// An optional \a lldb_private::Trace object containing processor trace
   /// information of this target.
   lldb::TraceSP m_trace_sp;

lldb/source/API/SBTarget.cpp

@@ -145,14 +145,6 @@ SBModule SBTarget::GetModuleAtIndexFromEvent(const uint32_t idx,
   return SBModule(module_list.GetModuleAtIndex(idx));
 }
 
-const char *SBTarget::GetSessionNameFromEvent(const SBEvent &event) {
-  LLDB_INSTRUMENT_VA(event);
-
-  return ConstString(
-             Target::TargetEventData::GetSessionNameFromEvent(event.get()))
-      .AsCString();
-}
-
 const char *SBTarget::GetBroadcasterClassName() {
   LLDB_INSTRUMENT();
 
@@ -1649,6 +1641,14 @@ lldb::user_id_t SBTarget::GetGloballyUniqueID() const {
   return LLDB_INVALID_GLOBALLY_UNIQUE_TARGET_ID;
 }
 
+const char *SBTarget::GetTargetSessionName() const {
+  LLDB_INSTRUMENT_VA(this);
+
+  if (TargetSP target_sp = GetSP())
+    return ConstString(target_sp->GetTargetSessionName().data()).AsCString();
+  return nullptr;
+}
+
 SBError SBTarget::SetLabel(const char *label) {
   LLDB_INSTRUMENT_VA(this, label);
 

lldb/source/Target/Target.cpp

@@ -186,6 +186,8 @@ Target::Target(Debugger &debugger, const ArchSpec &target_arch,
       m_latest_stop_hook_id(0), m_valid(true), m_suppress_stop_hooks(false),
       m_is_dummy_target(is_dummy_target),
       m_target_unique_id(g_target_unique_id++),
+      m_target_session_name(
+          llvm::formatv("Session {0}", m_target_unique_id).str()),
       m_frame_recognizer_manager_up(
           std::make_unique<StackFrameRecognizerManager>()) {
   SetEventName(eBroadcastBitBreakpointChanged, "breakpoint-changed");
@@ -5170,21 +5172,11 @@ void TargetProperties::SetDebugUtilityExpression(bool debug) {
 // Target::TargetEventData
 
 Target::TargetEventData::TargetEventData(const lldb::TargetSP &target_sp)
-    : TargetEventData(target_sp, ModuleList(), "") {}
+    : EventData(), m_target_sp(target_sp), m_module_list() {}
 
 Target::TargetEventData::TargetEventData(const lldb::TargetSP &target_sp,
                                          const ModuleList &module_list)
-    : TargetEventData(target_sp, module_list, "") {}
-
-Target::TargetEventData::TargetEventData(const lldb::TargetSP &target_sp,
-                                         std::string session_name)
-    : TargetEventData(target_sp, ModuleList(), std::move(session_name)) {}
-
-Target::TargetEventData::TargetEventData(const lldb::TargetSP &target_sp,
-                                         const ModuleList &module_list,
-                                         std::string session_name)
-    : EventData(), m_target_sp(target_sp), m_module_list(module_list),
-      m_session_name(std::move(session_name)) {}
+    : EventData(), m_target_sp(target_sp), m_module_list(module_list) {}
 
 Target::TargetEventData::~TargetEventData() = default;
 
@@ -5220,25 +5212,6 @@ TargetSP Target::TargetEventData::GetTargetFromEvent(const Event *event_ptr) {
   return target_sp;
 }
 
-llvm::StringRef
-Target::TargetEventData::GetSessionNameFromEvent(const Event *event_ptr) {
-  const TargetEventData *event_data = GetEventDataFromEvent(event_ptr);
-  if (!event_data)
-    return llvm::StringRef();
-
-  if (!event_data->m_session_name.empty())
-    return event_data->m_session_name;
-
-  // Generate default session name if not provided
-  if (event_data->m_target_sp) {
-    lldb::user_id_t target_id = event_data->m_target_sp->GetGloballyUniqueID();
-    std::string default_name = llvm::formatv("Session {0}", target_id).str();
-    return ConstString(default_name).GetStringRef();
-  }
-
-  return llvm::StringRef();
-}
-
 ModuleList
 Target::TargetEventData::GetModuleListFromEvent(const Event *event_ptr) {
   ModuleList module_list;

lldb/tools/lldb-dap/DAP.cpp

@@ -1581,8 +1581,7 @@ void DAP::EventThread() {
           // process name.
           attach_config.try_emplace("type", "lldb");
           attach_config.try_emplace("targetId", target_id);
-          const char *session_name =
-              lldb::SBTarget::GetSessionNameFromEvent(event);
+          const char *session_name = target.GetTargetSessionName();
           attach_config.try_emplace("name", session_name);
 
           // 2. Construct the main 'startDebugging' request arguments.