LLDB  mainline
HexagonDYLDRendezvous.h
Go to the documentation of this file.
1 //===-- HexagonDYLDRendezvous.h ---------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLDB_SOURCE_PLUGINS_DYNAMICLOADER_HEXAGON_DYLD_HEXAGONDYLDRENDEZVOUS_H
10 #define LLDB_SOURCE_PLUGINS_DYNAMICLOADER_HEXAGON_DYLD_HEXAGONDYLDRENDEZVOUS_H
11 
12 #include <limits.h>
13 #include <list>
14 #include <map>
15 #include <string>
16 
17 #include "lldb/lldb-defines.h"
18 #include "lldb/lldb-types.h"
19 
20 namespace lldb_private {
21 class Process;
22 }
23 
24 /// \class HexagonDYLDRendezvous
25 /// Interface to the runtime linker.
26 ///
27 /// A structure is present in a processes memory space which is updated by the
28 /// runtime liker each time a module is loaded or unloaded. This class
29 /// provides an interface to this structure and maintains a consistent
30 /// snapshot of the currently loaded modules.
32 
33  // This structure is used to hold the contents of the debug rendezvous
34  // information (struct r_debug) as found in the inferiors memory. Note that
35  // the layout of this struct is not binary compatible, it is simply large
36  // enough to hold the information on both 32 and 64 bit platforms.
37  struct Rendezvous {
38  uint64_t version = 0;
41  uint64_t state = 0;
43 
44  Rendezvous() = default;
45  };
46 
47 public:
48  // Various metadata supplied by the inferior's threading library to describe
49  // the per-thread state.
50  struct ThreadInfo {
51  bool valid; // whether we read valid metadata
52  uint32_t dtv_offset; // offset of DTV pointer within pthread
53  uint32_t dtv_slot_size; // size of one DTV slot
54  uint32_t modid_offset; // offset of module ID within link_map
55  uint32_t tls_offset; // offset of TLS pointer within DTV slot
56  };
57 
59 
60  /// Update the internal snapshot of runtime linker rendezvous and recompute
61  /// the currently loaded modules.
62  ///
63  /// This method should be called once one start up, then once each time the
64  /// runtime linker enters the function given by GetBreakAddress().
65  ///
66  /// \returns true on success and false on failure.
67  ///
68  /// \see GetBreakAddress().
69  bool Resolve();
70 
71  /// \returns true if this rendezvous has been located in the inferiors
72  /// address space and false otherwise.
73  bool IsValid();
74 
75  /// \returns the address of the rendezvous structure in the inferiors
76  /// address space.
78 
79  /// Provide the dyld structure address
81 
82  /// \returns the version of the rendezvous protocol being used.
83  uint64_t GetVersion() const { return m_current.version; }
84 
85  /// \returns address in the inferiors address space containing the linked
86  /// list of shared object descriptors.
88 
89  /// A breakpoint should be set at this address and Resolve called on each
90  /// hit.
91  ///
92  /// \returns the address of a function called by the runtime linker each
93  /// time a module is loaded/unloaded, or about to be loaded/unloaded.
94  ///
95  /// \see Resolve()
97 
98  /// In hexagon it is possible that we can know the dyld breakpoint without
99  /// having to find it from the rendezvous structure
100  ///
101  void SetBreakAddress(lldb::addr_t addr) { m_current.brk = addr; }
102 
103  /// Returns the current state of the rendezvous structure.
104  uint64_t GetState() const { return m_current.state; }
105 
106  /// \returns the base address of the runtime linker in the inferiors address
107  /// space.
109 
110  /// \returns the thread layout metadata from the inferiors thread library.
111  const ThreadInfo &GetThreadInfo();
112 
113  /// \returns true if modules have been loaded into the inferior since the
114  /// last call to Resolve().
115  bool ModulesDidLoad() const { return !m_added_soentries.empty(); }
116 
117  /// \returns true if modules have been unloaded from the inferior since the
118  /// last call to Resolve().
119  bool ModulesDidUnload() const { return !m_removed_soentries.empty(); }
120 
121  void DumpToLog(lldb_private::Log *log) const;
122 
123  /// Constants describing the state of the rendezvous.
124  ///
125  /// \see GetState().
130  };
131 
132  /// Structure representing the shared objects currently loaded into the
133  /// inferior process.
134  ///
135  /// This object is a rough analogue to the struct link_map object which
136  /// actually lives in the inferiors memory.
137  struct SOEntry {
138  lldb::addr_t link_addr; ///< Address of this link_map.
139  lldb::addr_t base_addr; ///< Base address of the loaded object.
140  lldb::addr_t path_addr; ///< String naming the shared object.
141  lldb::addr_t dyn_addr; ///< Dynamic section of shared object.
142  lldb::addr_t next; ///< Address of next so_entry.
143  lldb::addr_t prev; ///< Address of previous so_entry.
144  std::string path; ///< File name of shared object.
145 
146  SOEntry() { clear(); }
147 
148  bool operator==(const SOEntry &entry) { return this->path == entry.path; }
149 
150  void clear() {
151  link_addr = 0;
152  base_addr = 0;
153  path_addr = 0;
154  dyn_addr = 0;
155  next = 0;
156  prev = 0;
157  path.clear();
158  }
159  };
160 
161 protected:
162  typedef std::list<SOEntry> SOEntryList;
163 
164 public:
165  typedef SOEntryList::const_iterator iterator;
166 
167  /// Iterators over all currently loaded modules.
168  iterator begin() const { return m_soentries.begin(); }
169  iterator end() const { return m_soentries.end(); }
170 
171  /// Iterators over all modules loaded into the inferior since the last call
172  /// to Resolve().
173  iterator loaded_begin() const { return m_added_soentries.begin(); }
174  iterator loaded_end() const { return m_added_soentries.end(); }
175 
176  /// Iterators over all modules unloaded from the inferior since the last
177  /// call to Resolve().
178  iterator unloaded_begin() const { return m_removed_soentries.begin(); }
179  iterator unloaded_end() const { return m_removed_soentries.end(); }
180 
181 protected:
183 
184  // Cached copy of executable pathname
186 
187  /// Location of the r_debug structure in the inferiors address space.
189 
190  /// Current and previous snapshots of the rendezvous structure.
193 
194  /// List of SOEntry objects corresponding to the current link map state.
196 
197  /// List of SOEntry's added to the link map since the last call to
198  /// Resolve().
200 
201  /// List of SOEntry's removed from the link map since the last call to
202  /// Resolve().
204 
205  /// Threading metadata read from the inferior.
207 
208  /// Reads an unsigned integer of \p size bytes from the inferior's address
209  /// space starting at \p addr.
210  ///
211  /// \returns addr + size if the read was successful and false otherwise.
212  lldb::addr_t ReadWord(lldb::addr_t addr, uint64_t *dst, size_t size);
213 
214  /// Reads an address from the inferior's address space starting at \p addr.
215  ///
216  /// \returns addr + target address size if the read was successful and
217  /// 0 otherwise.
219 
220  /// Reads a null-terminated C string from the memory location starting at @p
221  /// addr.
223 
224  /// Reads an SOEntry starting at \p addr.
225  bool ReadSOEntryFromMemory(lldb::addr_t addr, SOEntry &entry);
226 
227  /// Updates the current set of SOEntries, the set of added entries, and the
228  /// set of removed entries.
229  bool UpdateSOEntries();
230 
232 
234 
235  /// Reads the current list of shared objects according to the link map
236  /// supplied by the runtime linker.
237  bool TakeSnapshot(SOEntryList &entry_list);
238 
240 
241  bool FindMetadata(const char *name, PThreadField field, uint32_t &value);
242 };
243 
244 #endif // LLDB_SOURCE_PLUGINS_DYNAMICLOADER_HEXAGON_DYLD_HEXAGONDYLDRENDEZVOUS_H
HexagonDYLDRendezvous::SOEntry::operator==
bool operator==(const SOEntry &entry)
Definition: HexagonDYLDRendezvous.h:148
HexagonDYLDRendezvous::Rendezvous::Rendezvous
Rendezvous()=default
HexagonDYLDRendezvous::ThreadInfo::dtv_offset
uint32_t dtv_offset
Definition: HexagonDYLDRendezvous.h:52
HexagonDYLDRendezvous::eOffset
@ eOffset
Definition: HexagonDYLDRendezvous.h:239
HexagonDYLDRendezvous::GetLinkMapAddress
lldb::addr_t GetLinkMapAddress() const
Definition: HexagonDYLDRendezvous.h:87
HexagonDYLDRendezvous::iterator
SOEntryList::const_iterator iterator
Definition: HexagonDYLDRendezvous.h:165
HexagonDYLDRendezvous::ModulesDidUnload
bool ModulesDidUnload() const
Definition: HexagonDYLDRendezvous.h:119
HexagonDYLDRendezvous::RendezvousState
RendezvousState
Constants describing the state of the rendezvous.
Definition: HexagonDYLDRendezvous.h:126
HexagonDYLDRendezvous::UpdateSOEntries
bool UpdateSOEntries()
Updates the current set of SOEntries, the set of added entries, and the set of removed entries.
Definition: HexagonDYLDRendezvous.cpp:111
lldb-defines.h
HexagonDYLDRendezvous::Rendezvous::state
uint64_t state
Definition: HexagonDYLDRendezvous.h:41
HexagonDYLDRendezvous::GetRendezvousAddress
lldb::addr_t GetRendezvousAddress() const
Definition: HexagonDYLDRendezvous.h:77
HexagonDYLDRendezvous::ModulesDidLoad
bool ModulesDidLoad() const
Definition: HexagonDYLDRendezvous.h:115
lldb_private::Process
Definition: Process.h:342
HexagonDYLDRendezvous::SOEntry
Structure representing the shared objects currently loaded into the inferior process.
Definition: HexagonDYLDRendezvous.h:137
HexagonDYLDRendezvous::Rendezvous::map_addr
lldb::addr_t map_addr
Definition: HexagonDYLDRendezvous.h:39
HexagonDYLDRendezvous::GetLDBase
lldb::addr_t GetLDBase() const
Definition: HexagonDYLDRendezvous.h:108
HexagonDYLDRendezvous::end
iterator end() const
Definition: HexagonDYLDRendezvous.h:169
HexagonDYLDRendezvous::Rendezvous::ldbase
lldb::addr_t ldbase
Definition: HexagonDYLDRendezvous.h:42
HexagonDYLDRendezvous::PThreadField
PThreadField
Definition: HexagonDYLDRendezvous.h:239
HexagonDYLDRendezvous::GetVersion
uint64_t GetVersion() const
Definition: HexagonDYLDRendezvous.h:83
HexagonDYLDRendezvous::TakeSnapshot
bool TakeSnapshot(SOEntryList &entry_list)
Reads the current list of shared objects according to the link map supplied by the runtime linker.
Definition: HexagonDYLDRendezvous.cpp:196
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
HexagonDYLDRendezvous::m_previous
Rendezvous m_previous
Definition: HexagonDYLDRendezvous.h:192
HexagonDYLDRendezvous::ThreadInfo::valid
bool valid
Definition: HexagonDYLDRendezvous.h:51
HexagonDYLDRendezvous::SOEntry::path
std::string path
File name of shared object.
Definition: HexagonDYLDRendezvous.h:144
HexagonDYLDRendezvous::GetBreakAddress
lldb::addr_t GetBreakAddress() const
A breakpoint should be set at this address and Resolve called on each hit.
Definition: HexagonDYLDRendezvous.h:96
HexagonDYLDRendezvous::m_process
lldb_private::Process * m_process
Definition: HexagonDYLDRendezvous.h:182
HexagonDYLDRendezvous::eAdd
@ eAdd
Definition: HexagonDYLDRendezvous.h:128
HexagonDYLDRendezvous::ThreadInfo::tls_offset
uint32_t tls_offset
Definition: HexagonDYLDRendezvous.h:55
HexagonDYLDRendezvous::SOEntry::prev
lldb::addr_t prev
Address of previous so_entry.
Definition: HexagonDYLDRendezvous.h:143
HexagonDYLDRendezvous::IsValid
bool IsValid()
Definition: HexagonDYLDRendezvous.cpp:107
HexagonDYLDRendezvous::m_added_soentries
SOEntryList m_added_soentries
List of SOEntry's added to the link map since the last call to Resolve().
Definition: HexagonDYLDRendezvous.h:199
HexagonDYLDRendezvous::SOEntry::clear
void clear()
Definition: HexagonDYLDRendezvous.h:150
HexagonDYLDRendezvous::m_removed_soentries
SOEntryList m_removed_soentries
List of SOEntry's removed from the link map since the last call to Resolve().
Definition: HexagonDYLDRendezvous.h:203
HexagonDYLDRendezvous::m_current
Rendezvous m_current
Current and previous snapshots of the rendezvous structure.
Definition: HexagonDYLDRendezvous.h:191
HexagonDYLDRendezvous::Resolve
bool Resolve()
Update the internal snapshot of runtime linker rendezvous and recompute the currently loaded modules.
Definition: HexagonDYLDRendezvous.cpp:61
HexagonDYLDRendezvous::ReadStringFromMemory
std::string ReadStringFromMemory(lldb::addr_t addr)
Reads a null-terminated C string from the memory location starting at addr.
Definition: HexagonDYLDRendezvous.cpp:239
HexagonDYLDRendezvous::ThreadInfo
Definition: HexagonDYLDRendezvous.h:50
HexagonDYLDRendezvous::loaded_end
iterator loaded_end() const
Definition: HexagonDYLDRendezvous.h:174
HexagonDYLDRendezvous::GetState
uint64_t GetState() const
Returns the current state of the rendezvous structure.
Definition: HexagonDYLDRendezvous.h:104
HexagonDYLDRendezvous::loaded_begin
iterator loaded_begin() const
Iterators over all modules loaded into the inferior since the last call to Resolve().
Definition: HexagonDYLDRendezvous.h:173
HexagonDYLDRendezvous::eDelete
@ eDelete
Definition: HexagonDYLDRendezvous.h:129
HexagonDYLDRendezvous::ThreadInfo::dtv_slot_size
uint32_t dtv_slot_size
Definition: HexagonDYLDRendezvous.h:53
HexagonDYLDRendezvous::SetBreakAddress
void SetBreakAddress(lldb::addr_t addr)
In hexagon it is possible that we can know the dyld breakpoint without having to find it from the ren...
Definition: HexagonDYLDRendezvous.h:101
HexagonDYLDRendezvous::eSize
@ eSize
Definition: HexagonDYLDRendezvous.h:239
HexagonDYLDRendezvous::UpdateSOEntriesForAddition
bool UpdateSOEntriesForAddition()
Definition: HexagonDYLDRendezvous.cpp:148
HexagonDYLDRendezvous::ReadSOEntryFromMemory
bool ReadSOEntryFromMemory(lldb::addr_t addr, SOEntry &entry)
Reads an SOEntry starting at addr.
Definition: HexagonDYLDRendezvous.cpp:263
HexagonDYLDRendezvous::HexagonDYLDRendezvous
HexagonDYLDRendezvous(lldb_private::Process *process)
Definition: HexagonDYLDRendezvous.cpp:48
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:39
HexagonDYLDRendezvous
Definition: HexagonDYLDRendezvous.h:31
HexagonDYLDRendezvous::Rendezvous::brk
lldb::addr_t brk
Definition: HexagonDYLDRendezvous.h:40
HexagonDYLDRendezvous::GetThreadInfo
const ThreadInfo & GetThreadInfo()
Definition: HexagonDYLDRendezvous.cpp:316
HexagonDYLDRendezvous::ReadWord
lldb::addr_t ReadWord(lldb::addr_t addr, uint64_t *dst, size_t size)
Reads an unsigned integer of size bytes from the inferior's address space starting at addr.
Definition: HexagonDYLDRendezvous.cpp:218
lldb-types.h
HexagonDYLDRendezvous::Rendezvous::version
uint64_t version
Definition: HexagonDYLDRendezvous.h:38
HexagonDYLDRendezvous::SOEntry::link_addr
lldb::addr_t link_addr
Address of this link_map.
Definition: HexagonDYLDRendezvous.h:138
HexagonDYLDRendezvous::begin
iterator begin() const
Iterators over all currently loaded modules.
Definition: HexagonDYLDRendezvous.h:168
uint32_t
HexagonDYLDRendezvous::ReadPointer
lldb::addr_t ReadPointer(lldb::addr_t addr, lldb::addr_t *dst)
Reads an address from the inferior's address space starting at addr.
Definition: HexagonDYLDRendezvous.cpp:229
HexagonDYLDRendezvous::SOEntryList
std::list< SOEntry > SOEntryList
Definition: HexagonDYLDRendezvous.h:162
HexagonDYLDRendezvous::SOEntry::dyn_addr
lldb::addr_t dyn_addr
Dynamic section of shared object.
Definition: HexagonDYLDRendezvous.h:141
HexagonDYLDRendezvous::DumpToLog
void DumpToLog(lldb_private::Log *log) const
Definition: HexagonDYLDRendezvous.cpp:336
LLDB_INVALID_ADDRESS
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:86
HexagonDYLDRendezvous::SOEntry::next
lldb::addr_t next
Address of next so_entry.
Definition: HexagonDYLDRendezvous.h:142
HexagonDYLDRendezvous::eConsistent
@ eConsistent
Definition: HexagonDYLDRendezvous.h:127
HexagonDYLDRendezvous::SOEntry::base_addr
lldb::addr_t base_addr
Base address of the loaded object.
Definition: HexagonDYLDRendezvous.h:139
HexagonDYLDRendezvous::ThreadInfo::modid_offset
uint32_t modid_offset
Definition: HexagonDYLDRendezvous.h:54
HexagonDYLDRendezvous::unloaded_begin
iterator unloaded_begin() const
Iterators over all modules unloaded from the inferior since the last call to Resolve().
Definition: HexagonDYLDRendezvous.h:178
HexagonDYLDRendezvous::m_soentries
SOEntryList m_soentries
List of SOEntry objects corresponding to the current link map state.
Definition: HexagonDYLDRendezvous.h:195
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
HexagonDYLDRendezvous::m_rendezvous_addr
lldb::addr_t m_rendezvous_addr
Location of the r_debug structure in the inferiors address space.
Definition: HexagonDYLDRendezvous.h:188
HexagonDYLDRendezvous::SOEntry::SOEntry
SOEntry()
Definition: HexagonDYLDRendezvous.h:146
HexagonDYLDRendezvous::Rendezvous
Definition: HexagonDYLDRendezvous.h:37
lldb_private::Log
Definition: Log.h:49
HexagonDYLDRendezvous::unloaded_end
iterator unloaded_end() const
Definition: HexagonDYLDRendezvous.h:179
HexagonDYLDRendezvous::SetRendezvousAddress
void SetRendezvousAddress(lldb::addr_t)
Provide the dyld structure address.
Definition: HexagonDYLDRendezvous.cpp:103
HexagonDYLDRendezvous::FindMetadata
bool FindMetadata(const char *name, PThreadField field, uint32_t &value)
Definition: HexagonDYLDRendezvous.cpp:288
PATH_MAX
#define PATH_MAX
Definition: windows/PosixApi.h:25
HexagonDYLDRendezvous::m_exe_path
char m_exe_path[PATH_MAX]
Definition: HexagonDYLDRendezvous.h:185
HexagonDYLDRendezvous::UpdateSOEntriesForDeletion
bool UpdateSOEntriesForDeletion()
Definition: HexagonDYLDRendezvous.cpp:177
HexagonDYLDRendezvous::eNElem
@ eNElem
Definition: HexagonDYLDRendezvous.h:239
HexagonDYLDRendezvous::SOEntry::path_addr
lldb::addr_t path_addr
String naming the shared object.
Definition: HexagonDYLDRendezvous.h:140
HexagonDYLDRendezvous::m_thread_info
ThreadInfo m_thread_info
Threading metadata read from the inferior.
Definition: HexagonDYLDRendezvous.h:206