Block.h revision b04e7a805310f2f2cc77947a8b263de9061617ae
1//===-- Block.h -------------------------------------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9 10#ifndef liblldb_Block_h_ 11#define liblldb_Block_h_ 12 13#include "lldb/lldb-private.h" 14#include "lldb/Core/AddressRange.h" 15#include "lldb/Core/Stream.h" 16#include "lldb/Core/UserID.h" 17#include "lldb/Core/VMRange.h" 18#include "lldb/Symbol/LineEntry.h" 19#include "lldb/Symbol/SymbolContext.h" 20 21namespace lldb_private { 22 23//---------------------------------------------------------------------- 24/// @class Block Block.h "lldb/Symbol/Block.h" 25/// @brief A class that describes a single lexical block. 26/// 27/// A Function object owns a BlockList object which owns one or more 28/// Block objects. The BlockList object contains a section offset 29/// address range, and Block objects contain one or more ranges 30/// which are offsets into that range. Blocks are can have discontiguous 31/// ranges within the BlockList adress range, and each block can 32/// contain child blocks each with their own sets of ranges. 33/// 34/// Each block has a variable list that represents local, argument, and 35/// static variables that are scoped to the block. 36/// 37/// Inlined functions are representated by attaching a 38/// InlineFunctionInfo shared pointer object to a block. Inlined 39/// functions are represented as named blocks. 40//---------------------------------------------------------------------- 41class Block : 42 public UserID, 43 public SymbolContextScope 44{ 45public: 46 47 //------------------------------------------------------------------ 48 /// Construct with a User ID \a uid, \a depth. 49 /// 50 /// Initialize this block with the specified UID \a uid. The 51 /// \a depth in the \a block_list is used to represent the parent, 52 /// sibling, and child block information and also allows for partial 53 /// parsing at the block level. 54 /// 55 /// @param[in] uid 56 /// The UID for a given block. This value is given by the 57 /// SymbolFile plug-in and can be any value that helps the 58 /// SymbolFile plug-in to match this block back to the debug 59 /// information data that it parses for further or more in 60 /// depth parsing. Common values would be the index into a 61 /// table, or an offset into the debug information. 62 /// 63 /// @param[in] depth 64 /// The integer depth of this block in the block list hierarchy. 65 /// 66 /// @param[in] block_list 67 /// The block list that this object belongs to. 68 /// 69 /// @see BlockList 70 //------------------------------------------------------------------ 71 Block (lldb::user_id_t uid); 72 73 //------------------------------------------------------------------ 74 /// Destructor. 75 //------------------------------------------------------------------ 76 ~Block (); 77 78 //------------------------------------------------------------------ 79 /// Add a child to this object. 80 /// 81 /// @param[in] child_block_sp 82 /// A shared pointer to a child block that will get added to 83 /// this block. 84 //------------------------------------------------------------------ 85 void 86 AddChild (const lldb::BlockSP &child_block_sp); 87 88 //------------------------------------------------------------------ 89 /// Add a new offset range to this block. 90 /// 91 /// @param[in] start_offset 92 /// An offset into this Function's address range that 93 /// describes the start address of a range for this block. 94 /// 95 /// @param[in] end_offset 96 /// An offset into this Function's address range that 97 /// describes the end address of a range for this block. 98 //------------------------------------------------------------------ 99 void 100 AddRange(lldb::addr_t start_offset, lldb::addr_t end_offset); 101 102 //------------------------------------------------------------------ 103 /// @copydoc SymbolContextScope::CalculateSymbolContext(SymbolContext*) 104 /// 105 /// @see SymbolContextScope 106 //------------------------------------------------------------------ 107 virtual void 108 CalculateSymbolContext(SymbolContext* sc); 109 110 //------------------------------------------------------------------ 111 /// Check if an offset is in one of the block offset ranges. 112 /// 113 /// @param[in] range_offset 114 /// An offset into the Function's address range. 115 /// 116 /// @return 117 /// Returns \b true if \a range_offset falls in one of this 118 /// block's ranges, \b false otherwise. 119 //------------------------------------------------------------------ 120 bool 121 Contains (lldb::addr_t range_offset) const; 122 123 //------------------------------------------------------------------ 124 /// Check if a offset range is in one of the block offset ranges. 125 /// 126 /// @param[in] range 127 /// An offset range into the Function's address range. 128 /// 129 /// @return 130 /// Returns \b true if \a range falls in one of this 131 /// block's ranges, \b false otherwise. 132 //------------------------------------------------------------------ 133 bool 134 Contains (const VMRange& range) const; 135 136 //------------------------------------------------------------------ 137 /// Dump the block contents. 138 /// 139 /// @param[in] s 140 /// The stream to which to dump the object descripton. 141 /// 142 /// @param[in] base_addr 143 /// The resolved start address of the Function's address 144 /// range. This should be resolved as the file or load address 145 /// prior to passing the value into this function for dumping. 146 /// 147 /// @param[in] depth 148 /// Limit the number of levels deep that this function should 149 /// print as this block can contain child blocks. Specify 150 /// INT_MAX to dump all child blocks. 151 /// 152 /// @param[in] show_context 153 /// If \b true, variables will dump their context information. 154 //------------------------------------------------------------------ 155 void 156 Dump (Stream *s, lldb::addr_t base_addr, int32_t depth, bool show_context) const; 157 158 void 159 DumpStopContext (Stream *s, const SymbolContext *sc); 160 161 //------------------------------------------------------------------ 162 /// @copydoc SymbolContextScope::DumpSymbolContext(Stream*) 163 /// 164 /// @see SymbolContextScope 165 //------------------------------------------------------------------ 166 virtual void 167 DumpSymbolContext(Stream *s); 168 169 void 170 GetDescription (Stream *s, 171 Function *function, 172 lldb::DescriptionLevel level, 173 Process *process) const; 174 175 //------------------------------------------------------------------ 176 /// Get the parent block. 177 /// 178 /// @return 179 /// The parent block pointer, or NULL if this block has no 180 /// parent. 181 //------------------------------------------------------------------ 182 Block * 183 GetParent () const; 184 185 186 //------------------------------------------------------------------ 187 /// Get the inlined block that contains this block. 188 /// 189 /// @return 190 /// If this block contains inlined function info, it will return 191 /// this block, else parent blocks will be searched to see if 192 /// any contain this block. NULL will be returned if this block 193 /// nor any parent blocks are inlined function blocks. 194 //------------------------------------------------------------------ 195 Block * 196 GetContainingInlinedBlock (); 197 198 //------------------------------------------------------------------ 199 /// Get the inlined parent block for this block. 200 /// 201 /// @return 202 /// The parent block pointer, or NULL if this block has no 203 /// parent. 204 //------------------------------------------------------------------ 205 Block * 206 GetInlinedParent (); 207 208 //------------------------------------------------------------------ 209 /// Get the sibling block for this block. 210 /// 211 /// @return 212 /// The sibling block pointer, or NULL if this block has no 213 /// sibling. 214 //------------------------------------------------------------------ 215 Block * 216 GetSibling () const 217 { 218 return m_sibling; 219 } 220 221 //------------------------------------------------------------------ 222 /// Get the first child block. 223 /// 224 /// @return 225 /// The first child block pointer, or NULL if this block has no 226 /// children. 227 //------------------------------------------------------------------ 228 Block * 229 GetFirstChild () const 230 { 231 if (m_children.empty()) 232 return NULL; 233 return m_children.front().get(); 234 } 235 236 //------------------------------------------------------------------ 237 /// Get the variable list for this block and optionally all child 238 /// blocks if \a get_child_variables is \b true. 239 /// 240 /// @param[in] get_child_variables 241 /// If \b true, all variables from all child blocks will be 242 /// added to the variable list. 243 /// 244 /// @param[in] can_create 245 /// If \b true, the variables can be parsed if they already 246 /// haven't been, else the current state of the block will be 247 /// returned. Passing \b true for this parameter can be used 248 /// to see the current state of what has been parsed up to this 249 /// point. 250 /// 251 /// @return 252 /// A variable list shared pointer that contains all variables 253 /// for this block. 254 //------------------------------------------------------------------ 255 lldb::VariableListSP 256 GetVariableList (bool get_child_variables, bool can_create); 257 258 259 //------------------------------------------------------------------ 260 /// Appends the variables from this block, and optionally from all 261 /// parent blocks, to \a variable_list. 262 /// 263 /// @param[in] can_create 264 /// If \b true, the variables can be parsed if they already 265 /// haven't been, else the current state of the block will be 266 /// returned. Passing \b true for this parameter can be used 267 /// to see the current state of what has been parsed up to this 268 /// point. 269 /// 270 /// @param[in] get_parent_variables 271 /// If \b true, all variables from all parent blocks will be 272 /// added to the variable list. 273 /// 274 /// @param[in] stop_if_block_is_inlined_function 275 /// If \b true, all variables from all parent blocks will be 276 /// added to the variable list until there are no parent blocks 277 /// or the parent block has inlined function info. 278 /// 279 /// @param[in/out] variable_list 280 /// All variables in this block, and optionally all parent 281 /// blocks will be added to this list. 282 /// 283 /// @return 284 /// The number of variable that were appended to \a 285 /// variable_list. 286 //------------------------------------------------------------------ 287 uint32_t 288 AppendVariables (bool can_create, 289 bool get_parent_variables, 290 bool stop_if_block_is_inlined_function, 291 VariableList *variable_list); 292 293 //------------------------------------------------------------------ 294 /// Get const accessor for any inlined function information. 295 /// 296 /// @return 297 /// A cpmst pointer to any inlined function information, or NULL 298 /// if this is a regular block. 299 //------------------------------------------------------------------ 300 const InlineFunctionInfo* 301 InlinedFunctionInfo () const 302 { 303 return m_inlineInfoSP.get(); 304 } 305 306 //------------------------------------------------------------------ 307 /// Get the memory cost of this object. 308 /// 309 /// Returns the cost of this object plus any owned objects from the 310 /// ranges, variables, and inline function information. 311 /// 312 /// @return 313 /// The number of bytes that this object occupies in memory. 314 //------------------------------------------------------------------ 315 size_t 316 MemorySize() const; 317 318 //------------------------------------------------------------------ 319 /// Set accessor for any inlined function information. 320 /// 321 /// @param[in] name 322 /// The method name for the inlined function. This value should 323 /// not be NULL. 324 /// 325 /// @param[in] mangled 326 /// The mangled method name for the inlined function. This can 327 /// be NULL if there is no mangled name for an inlined function 328 /// or if the name is the same as \a name. 329 /// 330 /// @param[in] decl_ptr 331 /// A optional pointer to declaration information for the 332 /// inlined function information. This value can be NULL to 333 /// indicate that no declaration information is available. 334 /// 335 /// @param[in] call_decl_ptr 336 /// Optional calling location declaration information that 337 /// describes from where this inlined function was called. 338 //------------------------------------------------------------------ 339 void 340 SetInlinedFunctionInfo (const char *name, 341 const char *mangled, 342 const Declaration *decl_ptr, 343 const Declaration *call_decl_ptr); 344 345 346 void 347 SetParentScope (SymbolContextScope *parent_scope) 348 { 349 m_parent_scope = parent_scope; 350 } 351 352 void 353 SetSibling (Block *block) 354 { 355 m_sibling = block; 356 } 357 358 //------------------------------------------------------------------ 359 /// Set accessor for the variable list. 360 /// 361 /// Called by the SymbolFile plug-ins after they have parsed the 362 /// variable lists and are ready to hand ownership of the list over 363 /// to this object. 364 /// 365 /// @param[in] variable_list_sp 366 /// A shared pointer to a VariableList. 367 //------------------------------------------------------------------ 368 void 369 SetVariableList (lldb::VariableListSP& variable_list_sp) 370 { 371 m_variable_list_sp = variable_list_sp; 372 } 373 374 375 376 bool 377 BlockInfoHasBeenParsed() const 378 { 379 return m_parsed_block_info; 380 } 381 382 void 383 SetBlockInfoHasBeenParsed (bool b, bool set_children); 384 385 Block * 386 FindBlockByID (lldb::user_id_t block_id); 387 388 bool 389 GetRangeContainingOffset (const lldb::addr_t offset, VMRange &range); 390 391 bool 392 GetRangeContainingAddress (const Address& addr, AddressRange &range); 393 394 395protected: 396 typedef std::vector<lldb::BlockSP> collection; 397 //------------------------------------------------------------------ 398 // Member variables. 399 //------------------------------------------------------------------ 400 SymbolContextScope *m_parent_scope; 401 Block *m_sibling; 402 collection m_children; 403 VMRange::collection m_ranges; ///< A list of address offset ranges relative to the function's section/offset address. 404 lldb::InlineFunctionInfoSP m_inlineInfoSP; ///< Inlined function information. 405 lldb::VariableListSP m_variable_list_sp; ///< The variable list for all local, static and paramter variables scoped to this block. 406 bool m_parsed_block_info:1, ///< Set to true if this block and it's children have all been parsed 407 m_parsed_block_variables:1, 408 m_parsed_child_blocks:1; 409 410private: 411 DISALLOW_COPY_AND_ASSIGN (Block); 412}; 413 414 415} // namespace lldb_private 416 417#endif // liblldb_Block_h_ 418