ClangExpressionDeclMap.h revision 39d1af981f6a76603356fd84b2e9372a9172297c
1//===-- ClangExpressionDeclMap.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_ClangExpressionDeclMap_h_ 11#define liblldb_ClangExpressionDeclMap_h_ 12 13// C Includes 14#include <signal.h> 15#include <stdint.h> 16 17// C++ Includes 18#include <vector> 19 20// Other libraries and framework includes 21// Project includes 22#include "llvm/ADT/APInt.h" 23#include "llvm/ADT/DenseMap.h" 24#include "clang/AST/Decl.h" 25#include "lldb/lldb-public.h" 26#include "lldb/Core/ClangForward.h" 27#include "lldb/Core/Value.h" 28#include "lldb/Expression/ClangASTSource.h" 29#include "lldb/Expression/ClangExpressionVariable.h" 30#include "lldb/Symbol/TaggedASTType.h" 31#include "lldb/Symbol/SymbolContext.h" 32#include "lldb/Target/ExecutionContext.h" 33 34namespace lldb_private { 35 36//---------------------------------------------------------------------- 37/// @class ClangExpressionDeclMap ClangExpressionDeclMap.h "lldb/Expression/ClangExpressionDeclMap.h" 38/// @brief Manages named entities that are defined in LLDB's debug information. 39/// 40/// The Clang parser uses the ClangASTSource as an interface to request named 41/// entities from outside an expression. The ClangASTSource reports back, listing 42/// all possible objects corresponding to a particular name. But it in turn 43/// relies on ClangExpressionDeclMap, which performs several important functions. 44/// 45/// First, it records what variables and functions were looked up and what Decls 46/// were returned for them. 47/// 48/// Second, it constructs a struct on behalf of IRForTarget, recording which 49/// variables should be placed where and relaying this information back so that 50/// IRForTarget can generate context-independent code. 51/// 52/// Third, it "materializes" this struct on behalf of the expression command, 53/// finding the current values of each variable and placing them into the 54/// struct so that it can be passed to the JITted version of the IR. 55/// 56/// Fourth and finally, it "dematerializes" the struct after the JITted code has 57/// has executed, placing the new values back where it found the old ones. 58//---------------------------------------------------------------------- 59class ClangExpressionDeclMap : 60 public ClangASTSource 61{ 62public: 63 //------------------------------------------------------------------ 64 /// Constructor 65 /// 66 /// Initializes class variables. 67 /// 68 /// @param[in] keep_result_in_memory 69 /// If true, inhibits the normal deallocation of the memory for 70 /// the result persistent variable, and instead marks the variable 71 /// as persisting. 72 //------------------------------------------------------------------ 73 ClangExpressionDeclMap (bool keep_result_in_memory, 74 ExecutionContext &exe_ctx); 75 76 //------------------------------------------------------------------ 77 /// Destructor 78 //------------------------------------------------------------------ 79 ~ClangExpressionDeclMap (); 80 81 //------------------------------------------------------------------ 82 /// Enable the state needed for parsing and IR transformation. 83 /// 84 /// @param[in] exe_ctx 85 /// The execution context to use when finding types for variables. 86 /// Also used to find a "scratch" AST context to store result types. 87 /// 88 /// @return 89 /// True if parsing is possible; false if it is unsafe to continue. 90 //------------------------------------------------------------------ 91 bool 92 WillParse (ExecutionContext &exe_ctx); 93 94 //------------------------------------------------------------------ 95 /// [Used by ClangExpressionParser] For each variable that had an unknown 96 /// type at the beginning of parsing, determine its final type now. 97 /// 98 /// @return 99 /// True on success; false otherwise. 100 //------------------------------------------------------------------ 101 bool 102 ResolveUnknownTypes(); 103 104 //------------------------------------------------------------------ 105 /// Disable the state needed for parsing and IR transformation. 106 //------------------------------------------------------------------ 107 void 108 DidParse (); 109 110 //------------------------------------------------------------------ 111 /// [Used by IRForTarget] Get a new result variable name of the form 112 /// $n, where n is a natural number starting with 0. 113 /// 114 /// @param[in] name 115 /// The std::string to place the name into. 116 //------------------------------------------------------------------ 117 const ConstString & 118 GetPersistentResultName (); 119 120 //------------------------------------------------------------------ 121 /// [Used by IRForTarget] Get a constant variable given a name, 122 /// a type, and an llvm::APInt. 123 /// 124 /// @param[in] name 125 /// The name of the variable 126 /// 127 /// @param[in] type 128 /// The type of the variable, which will be imported into the 129 /// target's AST context 130 /// 131 /// @param[in] value 132 /// The value of the variable 133 /// 134 /// @return 135 /// The created variable 136 //------------------------------------------------------------------ 137 lldb::ClangExpressionVariableSP 138 BuildIntegerVariable (const ConstString &name, 139 lldb_private::TypeFromParser type, 140 const llvm::APInt& value); 141 142 //------------------------------------------------------------------ 143 /// [Used by IRForTarget] Cast an existing variable given a Decl and 144 /// a type. 145 /// 146 /// @param[in] name 147 /// The name of the new variable 148 /// 149 /// @param[in] decl 150 /// The Clang variable declaration for the original variable, 151 /// which must be looked up in the map 152 /// 153 /// @param[in] type 154 /// The desired type of the variable after casting 155 /// 156 /// @return 157 /// The created variable 158 //------------------------------------------------------------------ 159 lldb::ClangExpressionVariableSP 160 BuildCastVariable (const ConstString &name, 161 clang::VarDecl *decl, 162 lldb_private::TypeFromParser type); 163 164 //------------------------------------------------------------------ 165 /// [Used by IRForTarget] Add a variable to the list of persistent 166 /// variables for the process. 167 /// 168 /// @param[in] decl 169 /// The Clang declaration for the persistent variable, used for 170 /// lookup during parsing. 171 /// 172 /// @param[in] name 173 /// The name of the persistent variable, usually $something. 174 /// 175 /// @param[in] type 176 /// The type of the variable, in the Clang parser's context. 177 /// 178 /// @return 179 /// True on success; false otherwise. 180 //------------------------------------------------------------------ 181 bool 182 AddPersistentVariable (const clang::NamedDecl *decl, 183 const ConstString &name, 184 TypeFromParser type, 185 bool is_result, 186 bool is_lvalue); 187 188 //------------------------------------------------------------------ 189 /// [Used by IRForTarget] Add a variable to the struct that needs to 190 /// be materialized each time the expression runs. 191 /// 192 /// @param[in] decl 193 /// The Clang declaration for the variable. 194 /// 195 /// @param[in] name 196 /// The name of the variable. 197 /// 198 /// @param[in] value 199 /// The LLVM IR value for this variable. 200 /// 201 /// @param[in] size 202 /// The size of the variable in bytes. 203 /// 204 /// @param[in] alignment 205 /// The required alignment of the variable in bytes. 206 /// 207 /// @return 208 /// True on success; false otherwise. 209 //------------------------------------------------------------------ 210 bool 211 AddValueToStruct (const clang::NamedDecl *decl, 212 const ConstString &name, 213 llvm::Value *value, 214 size_t size, 215 off_t alignment); 216 217 //------------------------------------------------------------------ 218 /// [Used by IRForTarget] Finalize the struct, laying out the position 219 /// of each object in it. 220 /// 221 /// @return 222 /// True on success; false otherwise. 223 //------------------------------------------------------------------ 224 bool 225 DoStructLayout (); 226 227 //------------------------------------------------------------------ 228 /// [Used by IRForTarget] Get general information about the laid-out 229 /// struct after DoStructLayout() has been called. 230 /// 231 /// @param[out] num_elements 232 /// The number of elements in the struct. 233 /// 234 /// @param[out] size 235 /// The size of the struct, in bytes. 236 /// 237 /// @param[out] alignment 238 /// The alignment of the struct, in bytes. 239 /// 240 /// @return 241 /// True if the information could be retrieved; false otherwise. 242 //------------------------------------------------------------------ 243 bool 244 GetStructInfo (uint32_t &num_elements, 245 size_t &size, 246 off_t &alignment); 247 248 //------------------------------------------------------------------ 249 /// [Used by IRForTarget] Get specific information about one field 250 /// of the laid-out struct after DoStructLayout() has been called. 251 /// 252 /// @param[out] decl 253 /// The parsed Decl for the field, as generated by ClangASTSource 254 /// on ClangExpressionDeclMap's behalf. In the case of the result 255 /// value, this will have the name $__lldb_result even if the 256 /// result value ends up having the name $1. This is an 257 /// implementation detail of IRForTarget. 258 /// 259 /// @param[out] value 260 /// The IR value for the field (usually a GlobalVariable). In 261 /// the case of the result value, this will have the correct 262 /// name ($1, for instance). This is an implementation detail 263 /// of IRForTarget. 264 /// 265 /// @param[out] offset 266 /// The offset of the field from the beginning of the struct. 267 /// As long as the struct is aligned according to its required 268 /// alignment, this offset will align the field correctly. 269 /// 270 /// @param[out] name 271 /// The name of the field as used in materialization. 272 /// 273 /// @param[in] index 274 /// The index of the field about which information is requested. 275 /// 276 /// @return 277 /// True if the information could be retrieved; false otherwise. 278 //------------------------------------------------------------------ 279 bool 280 GetStructElement (const clang::NamedDecl *&decl, 281 llvm::Value *&value, 282 off_t &offset, 283 ConstString &name, 284 uint32_t index); 285 286 //------------------------------------------------------------------ 287 /// [Used by IRForTarget] Get information about a function given its 288 /// Decl. 289 /// 290 /// @param[in] decl 291 /// The parsed Decl for the Function, as generated by ClangASTSource 292 /// on ClangExpressionDeclMap's behalf. 293 /// 294 /// @param[out] ptr 295 /// The absolute address of the function in the target. 296 /// 297 /// @return 298 /// True if the information could be retrieved; false otherwise. 299 //------------------------------------------------------------------ 300 bool 301 GetFunctionInfo (const clang::NamedDecl *decl, 302 uint64_t &ptr); 303 304 //------------------------------------------------------------------ 305 /// [Used by IRForTarget] Get the address of a function given nothing 306 /// but its name. Some functions are needed but didn't get Decls made 307 /// during parsing -- specifically, sel_registerName is never called 308 /// in the generated IR but we need to call it nonetheless. 309 /// 310 /// @param[in] name 311 /// The name of the function. 312 /// 313 /// @param[out] ptr 314 /// The absolute address of the function in the target. 315 /// 316 /// @return 317 /// True if the address could be retrieved; false otherwise. 318 //------------------------------------------------------------------ 319 bool 320 GetFunctionAddress (const ConstString &name, 321 uint64_t &ptr); 322 323 //------------------------------------------------------------------ 324 /// [Used by IRForTarget] Get the address of a symbol given nothing 325 /// but its name. 326 /// 327 /// @param[in] target 328 /// The target to find the symbol in. If not provided, 329 /// then the current parsing context's Target. 330 /// 331 /// @param[in] name 332 /// The name of the symbol. 333 /// 334 /// @return 335 /// Valid load address for the symbol 336 //------------------------------------------------------------------ 337 lldb::addr_t 338 GetSymbolAddress (Target &target, 339 const ConstString &name, 340 lldb::SymbolType symbol_type); 341 342 lldb::addr_t 343 GetSymbolAddress (const ConstString &name, 344 lldb::SymbolType symbol_type); 345 346 //------------------------------------------------------------------ 347 /// [Used by IRInterpreter] Get basic target information. 348 /// 349 /// @param[out] byte_order 350 /// The byte order of the target. 351 /// 352 /// @param[out] address_byte_size 353 /// The size of a pointer in bytes. 354 /// 355 /// @return 356 /// True if the information could be determined; false 357 /// otherwise. 358 //------------------------------------------------------------------ 359 struct TargetInfo 360 { 361 lldb::ByteOrder byte_order; 362 size_t address_byte_size; 363 364 TargetInfo() : 365 byte_order(lldb::eByteOrderInvalid), 366 address_byte_size(0) 367 { 368 } 369 370 bool IsValid() 371 { 372 return (byte_order != lldb::eByteOrderInvalid && 373 address_byte_size != 0); 374 } 375 }; 376 TargetInfo GetTargetInfo(); 377 378 //------------------------------------------------------------------ 379 /// [Used by IRInterpreter] Promote an unknown address to a 380 /// LoadAddress or FileAddress depending on the presence of a 381 /// process. 382 /// 383 /// @param[in] addr 384 /// The address to promote. 385 /// 386 /// @return 387 /// The wrapped entity. 388 //------------------------------------------------------------------ 389 lldb_private::Value WrapBareAddress (lldb::addr_t addr); 390 391 //------------------------------------------------------------------ 392 /// [Used by IRInterpreter] Write to the target. 393 /// 394 /// @param[in] value 395 /// The address to write to. 396 /// 397 /// @param[in] addr 398 /// The address of the data buffer to read from. 399 /// 400 /// @param[in] length 401 /// The amount of data to write, in bytes. 402 /// 403 /// @return 404 /// True if the write could be performed; false otherwise. 405 //------------------------------------------------------------------ 406 bool 407 WriteTarget (lldb_private::Value &value, 408 const uint8_t *data, 409 size_t length); 410 411 //------------------------------------------------------------------ 412 /// [Used by IRInterpreter] Read from the target. 413 /// 414 /// @param[in] data 415 /// The address of the data buffer to write to. 416 /// 417 /// @param[in] value 418 /// The address to read from. 419 /// 420 /// @param[in] length 421 /// The amount of data to read, in bytes. 422 /// 423 /// @return 424 /// True if the read could be performed; false otherwise. 425 //------------------------------------------------------------------ 426 bool 427 ReadTarget (uint8_t *data, 428 lldb_private::Value &value, 429 size_t length); 430 431 //------------------------------------------------------------------ 432 /// [Used by IRInterpreter] Get the Value for a NamedDecl. 433 /// 434 /// @param[in] decl 435 /// The Decl whose value is to be found. 436 /// 437 /// @param[out] flags 438 /// The flags for the found variable. 439 /// 440 /// @return 441 /// The value, or NULL. 442 //------------------------------------------------------------------ 443 lldb_private::Value 444 LookupDecl (clang::NamedDecl *decl, 445 ClangExpressionVariable::FlagType &flags); 446 447 //------------------------------------------------------------------ 448 /// [Used by IRInterpreter] Get the Value for "this", "self", or 449 /// "_cmd". 450 /// 451 /// @param[in] name 452 /// The name of the entity to be found. 453 /// 454 /// @return 455 /// The value, or NULL. 456 //------------------------------------------------------------------ 457 lldb_private::Value 458 GetSpecialValue (const ConstString &name); 459 460 //------------------------------------------------------------------ 461 /// [Used by IRInterpreter] Returns true if the result is a 462 /// reference to data in the target, meaning it must be 463 /// dereferenced once more to get its data. 464 /// 465 /// @param[in] name 466 /// The name of the result. 467 /// 468 /// @return 469 /// True if the result is a reference; false otherwise (or on 470 /// error). 471 //------------------------------------------------------------------ 472 bool 473 ResultIsReference (const ConstString &name); 474 475 //------------------------------------------------------------------ 476 /// [Used by IRInterpreter] Find the result persistent variable, 477 /// propagate the given value to it, and return it. 478 /// 479 /// @param[out] valobj 480 /// Set to the complete object. 481 /// 482 /// @param[in] value 483 /// A value indicating the location of the value's contents. 484 /// 485 /// @param[in] name 486 /// The name of the result. 487 /// 488 /// @param[in] type 489 /// The type of the data. 490 /// 491 /// @param[in] transient 492 /// True if the data should be treated as disappearing after the 493 /// expression completes. In that case, it gets no live data. 494 /// 495 /// @param[in] maybe_make_load 496 /// True if the value is a file address but should be potentially 497 /// upgraded to a load address if a target is presence. 498 /// 499 /// @return 500 /// True on success; false otherwise. 501 //------------------------------------------------------------------ 502 bool 503 CompleteResultVariable (lldb::ClangExpressionVariableSP &valobj, 504 lldb_private::Value &value, 505 const ConstString &name, 506 lldb_private::TypeFromParser type, 507 bool transient, 508 bool maybe_make_load); 509 510 511 void 512 RemoveResultVariable (const ConstString &name); 513 514 //------------------------------------------------------------------ 515 /// [Used by CommandObjectExpression] Materialize the entire struct 516 /// at a given address, which should be aligned as specified by 517 /// GetStructInfo(). 518 /// 519 /// @param[in] struct_address 520 /// The address at which the struct should be written. 521 /// 522 /// @param[in] error 523 /// An Error to populate with any messages related to 524 /// materializing the struct. 525 /// 526 /// @return 527 /// True on success; false otherwise. 528 //------------------------------------------------------------------ 529 bool 530 Materialize (lldb::addr_t &struct_address, 531 Error &error); 532 533 //------------------------------------------------------------------ 534 /// [Used by CommandObjectExpression] Get the "this" pointer 535 /// from a given execution context. 536 /// 537 /// @param[out] object_ptr 538 /// The this pointer. 539 /// 540 /// @param[in] object_name 541 /// The name of the object pointer -- "this," "self," or similar 542 /// depending on language 543 /// 544 /// @param[in] error 545 /// An Error to populate with any messages related to 546 /// finding the "this" pointer. 547 /// 548 /// @param[in] suppress_type_check 549 /// True if the type is not needed. 550 /// 551 /// @return 552 /// True on success; false otherwise. 553 //------------------------------------------------------------------ 554 bool 555 GetObjectPointer (lldb::addr_t &object_ptr, 556 ConstString &object_name, 557 Error &error, 558 bool suppress_type_check = false); 559 560 //------------------------------------------------------------------ 561 /// [Used by CommandObjectExpression] Pretty-print a materialized 562 /// struct, which must have been materialized by Materialize(), 563 /// byte for byte on a given stream. 564 /// 565 /// @param[in] exe_ctx 566 /// The execution context from which to read the struct. 567 /// 568 /// @param[in] s 569 /// The stream on which to write the pretty-printed output. 570 /// 571 /// @param[in] error 572 /// An Error to populate with any messages related to 573 /// pretty-printing the struct. 574 /// 575 /// @return 576 /// True on success; false otherwise. 577 //------------------------------------------------------------------ 578 bool 579 DumpMaterializedStruct (Stream &s, 580 Error &error); 581 582 //------------------------------------------------------------------ 583 /// [Used by CommandObjectExpression] Deaterialize the entire struct. 584 /// 585 /// @param[in] exe_ctx 586 /// The execution context from which to read the struct. 587 /// 588 /// @param[out] result 589 /// A ClangExpressionVariable containing the result of the 590 /// expression, for potential re-use. 591 /// 592 /// @param[in] stack_frame_top, stack_frame_bottom 593 /// If not LLDB_INVALID_ADDRESS, the bounds for the stack frame 594 /// in which the expression ran. A result whose address falls 595 /// inside this stack frame is dematerialized as a value 596 /// requiring rematerialization. 597 /// 598 /// @param[in] error 599 /// An Error to populate with any messages related to 600 /// dematerializing the struct. 601 /// 602 /// @return 603 /// True on success; false otherwise. 604 //------------------------------------------------------------------ 605 bool 606 Dematerialize (lldb::ClangExpressionVariableSP &result_sp, 607 lldb::addr_t stack_frame_top, 608 lldb::addr_t stack_frame_bottom, 609 Error &error); 610 611 //------------------------------------------------------------------ 612 /// [Used by ClangASTSource] Find all entities matching a given name, 613 /// using a NameSearchContext to make Decls for them. 614 /// 615 /// @param[in] context 616 /// The NameSearchContext that can construct Decls for this name. 617 /// 618 /// @return 619 /// True on success; false otherwise. 620 //------------------------------------------------------------------ 621 void 622 FindExternalVisibleDecls (NameSearchContext &context); 623 624 //------------------------------------------------------------------ 625 /// Find all entities matching a given name in a given module/namespace, 626 /// using a NameSearchContext to make Decls for them. 627 /// 628 /// @param[in] context 629 /// The NameSearchContext that can construct Decls for this name. 630 /// 631 /// @param[in] module 632 /// If non-NULL, the module to query. 633 /// 634 /// @param[in] namespace_decl 635 /// If valid and module is non-NULL, the parent namespace. 636 /// 637 /// @param[in] name 638 /// The name as a plain C string. The NameSearchContext contains 639 /// a DeclarationName for the name so at first the name may seem 640 /// redundant, but ClangExpressionDeclMap operates in RTTI land so 641 /// it can't access DeclarationName. 642 /// 643 /// @param[in] current_id 644 /// The ID for the current FindExternalVisibleDecls invocation, 645 /// for logging purposes. 646 /// 647 /// @return 648 /// True on success; false otherwise. 649 //------------------------------------------------------------------ 650 void 651 FindExternalVisibleDecls (NameSearchContext &context, 652 lldb::ModuleSP module, 653 ClangNamespaceDecl &namespace_decl, 654 unsigned int current_id); 655private: 656 ClangExpressionVariableList m_found_entities; ///< All entities that were looked up for the parser. 657 ClangExpressionVariableList m_struct_members; ///< All entities that need to be placed in the struct. 658 bool m_keep_result_in_memory; ///< True if result persistent variables generated by this expression should stay in memory. 659 660 //---------------------------------------------------------------------- 661 /// The following values should not live beyond parsing 662 //---------------------------------------------------------------------- 663 class ParserVars 664 { 665 public: 666 ParserVars(ClangExpressionDeclMap &decl_map) : 667 m_exe_ctx(), 668 m_sym_ctx(), 669 m_persistent_vars(NULL), 670 m_enable_lookups(false), 671 m_decl_map(decl_map) 672 { 673 } 674 675 Target * 676 GetTarget() 677 { 678 if (m_exe_ctx.GetTargetPtr()) 679 return m_exe_ctx.GetTargetPtr(); 680 else if (m_sym_ctx.target_sp) 681 m_sym_ctx.target_sp.get(); 682 return NULL; 683 } 684 685 ExecutionContext m_exe_ctx; ///< The execution context to use when parsing. 686 SymbolContext m_sym_ctx; ///< The symbol context to use in finding variables and types. 687 ClangPersistentVariables *m_persistent_vars; ///< The persistent variables for the process. 688 bool m_enable_lookups; ///< Set to true during parsing if we have found the first "$__lldb" name. 689 TargetInfo m_target_info; ///< Basic information about the target. 690 private: 691 ClangExpressionDeclMap &m_decl_map; 692 DISALLOW_COPY_AND_ASSIGN (ParserVars); 693 }; 694 695 std::auto_ptr<ParserVars> m_parser_vars; 696 697 //---------------------------------------------------------------------- 698 /// Activate parser-specific variables 699 //---------------------------------------------------------------------- 700 void 701 EnableParserVars() 702 { 703 if (!m_parser_vars.get()) 704 m_parser_vars.reset(new ParserVars(*this)); 705 } 706 707 //---------------------------------------------------------------------- 708 /// Deallocate parser-specific variables 709 //---------------------------------------------------------------------- 710 void 711 DisableParserVars() 712 { 713 m_parser_vars.reset(); 714 } 715 716 //---------------------------------------------------------------------- 717 /// The following values contain layout information for the materialized 718 /// struct, but are not specific to a single materialization 719 //---------------------------------------------------------------------- 720 struct StructVars { 721 StructVars() : 722 m_struct_alignment(0), 723 m_struct_size(0), 724 m_struct_laid_out(false), 725 m_result_name(), 726 m_object_pointer_type(NULL, NULL) 727 { 728 } 729 730 off_t m_struct_alignment; ///< The alignment of the struct in bytes. 731 size_t m_struct_size; ///< The size of the struct in bytes. 732 bool m_struct_laid_out; ///< True if the struct has been laid out and the layout is valid (that is, no new fields have been added since). 733 ConstString m_result_name; ///< The name of the result variable ($1, for example) 734 TypeFromUser m_object_pointer_type; ///< The type of the "this" variable, if one exists 735 }; 736 737 std::auto_ptr<StructVars> m_struct_vars; 738 739 //---------------------------------------------------------------------- 740 /// Activate struct variables 741 //---------------------------------------------------------------------- 742 void 743 EnableStructVars() 744 { 745 if (!m_struct_vars.get()) 746 m_struct_vars.reset(new struct StructVars); 747 } 748 749 //---------------------------------------------------------------------- 750 /// Deallocate struct variables 751 //---------------------------------------------------------------------- 752 void 753 DisableStructVars() 754 { 755 m_struct_vars.reset(); 756 } 757 758 //---------------------------------------------------------------------- 759 /// The following values refer to a specific materialization of the 760 /// structure in a process 761 //---------------------------------------------------------------------- 762 struct MaterialVars { 763 MaterialVars() : 764 m_allocated_area(0), 765 m_materialized_location(0) 766 { 767 } 768 769 Process *m_process; ///< The process that the struct is materialized into. 770 lldb::addr_t m_allocated_area; ///< The base of the memory allocated for the struct. Starts on a potentially unaligned address and may therefore be larger than the struct. 771 lldb::addr_t m_materialized_location; ///< The address at which the struct is placed. Falls inside the allocated area. 772 }; 773 774 std::auto_ptr<MaterialVars> m_material_vars; 775 776 //---------------------------------------------------------------------- 777 /// Activate materialization-specific variables 778 //---------------------------------------------------------------------- 779 void 780 EnableMaterialVars() 781 { 782 if (!m_material_vars.get()) 783 m_material_vars.reset(new struct MaterialVars); 784 } 785 786 //---------------------------------------------------------------------- 787 /// Deallocate materialization-specific variables 788 //---------------------------------------------------------------------- 789 void 790 DisableMaterialVars() 791 { 792 m_material_vars.reset(); 793 } 794 795 //------------------------------------------------------------------ 796 /// Given a stack frame, find a variable that matches the given name and 797 /// type. We need this for expression re-use; we may not always get the 798 /// same lldb::Variable back, and we want the expression to work wherever 799 /// it can. Returns the variable defined in the tightest scope. 800 /// 801 /// @param[in] frame 802 /// The stack frame to use as a basis for finding the variable. 803 /// 804 /// @param[in] name 805 /// The name as a plain C string. 806 /// 807 /// @param[in] type 808 /// The required type for the variable. This function may be called 809 /// during parsing, in which case we don't know its type; hence the 810 /// default. 811 /// 812 /// @param[in] object_pointer 813 /// The type expected is an object type. This means we will ignore 814 /// constness of the pointer target. 815 /// 816 /// @return 817 /// The LLDB Variable found, or NULL if none was found. 818 //------------------------------------------------------------------ 819 lldb::VariableSP 820 FindVariableInScope (StackFrame &frame, 821 const ConstString &name, 822 TypeFromUser *type = NULL, 823 bool object_pointer = false); 824 825 //------------------------------------------------------------------ 826 /// Given a target, find a data symbol that has the given name. 827 /// 828 /// @param[in] target 829 /// The target to use as the basis for the search. 830 /// 831 /// @param[in] name 832 /// The name as a plain C string. 833 /// 834 /// @return 835 /// The LLDB Symbol found, or NULL if none was found. 836 //--------------------------------------------------------- 837 Symbol * 838 FindGlobalDataSymbol (Target &target, 839 const ConstString &name); 840 841 //------------------------------------------------------------------ 842 /// Given a target, find a variable that matches the given name and 843 /// type. 844 /// 845 /// @param[in] target 846 /// The target to use as a basis for finding the variable. 847 /// 848 /// @param[in] module 849 /// If non-NULL, the module to search. 850 /// 851 /// @param[in] name 852 /// The name as a plain C string. 853 /// 854 /// @param[in] namespace_decl 855 /// If non-NULL and module is non-NULL, the parent namespace. 856 /// 857 /// @param[in] type 858 /// The required type for the variable. This function may be called 859 /// during parsing, in which case we don't know its type; hence the 860 /// default. 861 /// 862 /// @return 863 /// The LLDB Variable found, or NULL if none was found. 864 //------------------------------------------------------------------ 865 lldb::VariableSP 866 FindGlobalVariable (Target &target, 867 lldb::ModuleSP &module, 868 const ConstString &name, 869 ClangNamespaceDecl *namespace_decl, 870 TypeFromUser *type = NULL); 871 872 //------------------------------------------------------------------ 873 /// Get the value of a variable in a given execution context and return 874 /// the associated Types if needed. 875 /// 876 /// @param[in] var 877 /// The variable to evaluate. 878 /// 879 /// @param[in] parser_ast_context 880 /// The AST context of the parser, to store the found type in. 881 /// 882 /// @param[out] found_type 883 /// The type of the found value, as it was found in the user process. 884 /// This is only useful when the variable is being inspected on behalf 885 /// of the parser, hence the default. 886 /// 887 /// @param[out] parser_type 888 /// The type of the found value, as it was copied into the parser's 889 /// AST context. This is only useful when the variable is being 890 /// inspected on behalf of the parser, hence the default. 891 /// 892 /// @param[in] decl 893 /// The Decl to be looked up. 894 /// 895 /// @return 896 /// The LLDB Value for the variable. 897 //------------------------------------------------------------------ 898 Value * 899 GetVariableValue (lldb::VariableSP &var, 900 clang::ASTContext *parser_ast_context, 901 TypeFromUser *found_type = NULL, 902 TypeFromParser *parser_type = NULL); 903 904 //------------------------------------------------------------------ 905 /// Use the NameSearchContext to generate a Decl for the given LLDB 906 /// Variable, and put it in the Tuple list. 907 /// 908 /// @param[in] context 909 /// The NameSearchContext to use when constructing the Decl. 910 /// 911 /// @param[in] var 912 /// The LLDB Variable that needs a Decl. 913 /// 914 /// @param[in] valobj 915 /// The LLDB ValueObject for that variable. 916 //------------------------------------------------------------------ 917 void 918 AddOneVariable (NameSearchContext &context, 919 lldb::VariableSP var, 920 lldb::ValueObjectSP valobj, 921 unsigned int current_id); 922 923 //------------------------------------------------------------------ 924 /// Use the NameSearchContext to generate a Decl for the given 925 /// persistent variable, and put it in the list of found entities. 926 /// 927 /// @param[in] context 928 /// The NameSearchContext to use when constructing the Decl. 929 /// 930 /// @param[in] pvar 931 /// The persistent variable that needs a Decl. 932 /// 933 /// @param[in] current_id 934 /// The ID of the current invocation of FindExternalVisibleDecls 935 /// for logging purposes. 936 //------------------------------------------------------------------ 937 void 938 AddOneVariable (NameSearchContext &context, 939 lldb::ClangExpressionVariableSP &pvar_sp, 940 unsigned int current_id); 941 942 //------------------------------------------------------------------ 943 /// Use the NameSearchContext to generate a Decl for the given LLDB 944 /// symbol (treated as a variable), and put it in the list of found 945 /// entities. 946 /// 947 /// @param[in] context 948 /// The NameSearchContext to use when constructing the Decl. 949 /// 950 /// @param[in] var 951 /// The LLDB Variable that needs a Decl. 952 //------------------------------------------------------------------ 953 void 954 AddOneGenericVariable (NameSearchContext &context, 955 Symbol &symbol, 956 unsigned int current_id); 957 958 //------------------------------------------------------------------ 959 /// Use the NameSearchContext to generate a Decl for the given 960 /// function. (Functions are not placed in the Tuple list.) Can 961 /// handle both fully typed functions and generic functions. 962 /// 963 /// @param[in] context 964 /// The NameSearchContext to use when constructing the Decl. 965 /// 966 /// @param[in] fun 967 /// The Function that needs to be created. If non-NULL, this is 968 /// a fully-typed function. 969 /// 970 /// @param[in] sym 971 /// The Symbol that corresponds to a function that needs to be 972 /// created with generic type (unitptr_t foo(...)). 973 //------------------------------------------------------------------ 974 void 975 AddOneFunction (NameSearchContext &context, 976 Function *fun, 977 Symbol *sym, 978 unsigned int current_id); 979 980 //------------------------------------------------------------------ 981 /// Use the NameSearchContext to generate a Decl for the given 982 /// register. 983 /// 984 /// @param[in] context 985 /// The NameSearchContext to use when constructing the Decl. 986 /// 987 /// @param[in] reg_info 988 /// The information corresponding to that register. 989 //------------------------------------------------------------------ 990 void 991 AddOneRegister (NameSearchContext &context, 992 const RegisterInfo *reg_info, 993 unsigned int current_id); 994 995 //------------------------------------------------------------------ 996 /// Use the NameSearchContext to generate a Decl for the given 997 /// type. (Types are not placed in the Tuple list.) 998 /// 999 /// @param[in] context 1000 /// The NameSearchContext to use when constructing the Decl. 1001 /// 1002 /// @param[in] type 1003 /// The type that needs to be created. 1004 /// 1005 /// @param[in] add_method 1006 /// True if a method with signature void $__lldb_expr(void*) 1007 /// should be added to the C++ class type passed in 1008 //------------------------------------------------------------------ 1009 void 1010 AddOneType (NameSearchContext &context, 1011 TypeFromUser &type, 1012 unsigned int current_id, 1013 bool add_method); 1014 1015 //------------------------------------------------------------------ 1016 /// Actually do the task of materializing or dematerializing the struct. 1017 /// Since both tasks are very similar, although ClangExpressionDeclMap 1018 /// exposes two functions to the outside, both call DoMaterialize. 1019 /// 1020 /// @param[in] dematerialize 1021 /// True if the struct is to be dematerialized; false if it is to 1022 /// be materialized. 1023 /// 1024 /// @param[in] stack_frame_top, stack_frame_bottom 1025 /// If not LLDB_INVALID_ADDRESS, the bounds for the stack frame 1026 /// in which the expression ran. A result whose address falls 1027 /// inside this stack frame is dematerialized as a value 1028 /// requiring rematerialization. 1029 /// 1030 /// @param[out] result 1031 /// If the struct is being dematerialized, a pointer into which the 1032 /// location of the result persistent variable is placed. If not, 1033 /// NULL. 1034 /// 1035 /// @param[in] err 1036 /// An Error to populate with any messages related to 1037 /// (de)materializing the struct. 1038 /// 1039 /// @return 1040 /// True on success; false otherwise. 1041 //------------------------------------------------------------------ 1042 bool 1043 DoMaterialize (bool dematerialize, 1044 lldb::addr_t stack_frame_top, 1045 lldb::addr_t stack_frame_bottom, 1046 lldb::ClangExpressionVariableSP *result_sp_ptr, 1047 Error &err); 1048 1049 //------------------------------------------------------------------ 1050 /// Clean up the state required to dematerialize the variable. 1051 //------------------------------------------------------------------ 1052 void 1053 DidDematerialize (); 1054 1055 //------------------------------------------------------------------ 1056 /// Actually do the task of materializing or dematerializing a persistent 1057 /// variable. 1058 /// 1059 /// @param[in] dematerialize 1060 /// True if the variable is to be dematerialized; false if it is to 1061 /// be materialized. 1062 /// 1063 /// @param[in] var_sp 1064 /// The persistent variable to materialize 1065 /// 1066 /// @param[in] addr 1067 /// The address at which to materialize the variable. 1068 /// 1069 /// @param[in] stack_frame_top, stack_frame_bottom 1070 /// If not LLDB_INVALID_ADDRESS, the bounds for the stack frame 1071 /// in which the expression ran. A result whose address falls 1072 /// inside this stack frame is dematerialized as a value 1073 /// requiring rematerialization. 1074 /// 1075 /// @param[in] err 1076 /// An Error to populate with any messages related to 1077 /// (de)materializing the persistent variable. 1078 /// 1079 /// @return 1080 /// True on success; false otherwise. 1081 //------------------------------------------------------------------ 1082 bool 1083 DoMaterializeOnePersistentVariable (bool dematerialize, 1084 lldb::ClangExpressionVariableSP &var_sp, 1085 lldb::addr_t addr, 1086 lldb::addr_t stack_frame_top, 1087 lldb::addr_t stack_frame_bottom, 1088 Error &err); 1089 1090 //------------------------------------------------------------------ 1091 /// Actually do the task of materializing or dematerializing a 1092 /// variable. 1093 /// 1094 /// @param[in] dematerialize 1095 /// True if the variable is to be dematerialized; false if it is to 1096 /// be materialized. 1097 /// 1098 /// @param[in] sym_ctx 1099 /// The symbol context to use (for looking the variable up). 1100 /// 1101 /// @param[in] expr_var 1102 /// The entity that the expression parser uses for the variable. 1103 /// In case the variable needs to be copied into the target's 1104 /// memory, this location is stored in the variable during 1105 /// materialization and cleared when it is demateralized. 1106 /// 1107 /// @param[in] addr 1108 /// The address at which to materialize the variable. 1109 /// 1110 /// @param[in] err 1111 /// An Error to populate with any messages related to 1112 /// (de)materializing the persistent variable. 1113 /// 1114 /// @return 1115 /// True on success; false otherwise. 1116 //------------------------------------------------------------------ 1117 bool 1118 DoMaterializeOneVariable (bool dematerialize, 1119 const SymbolContext &sym_ctx, 1120 lldb::ClangExpressionVariableSP &expr_var, 1121 lldb::addr_t addr, 1122 Error &err); 1123 1124 //------------------------------------------------------------------ 1125 /// Actually do the task of materializing or dematerializing a 1126 /// register variable. 1127 /// 1128 /// @param[in] dematerialize 1129 /// True if the variable is to be dematerialized; false if it is to 1130 /// be materialized. 1131 /// 1132 /// @param[in] reg_ctx 1133 /// The register context to use. 1134 /// 1135 /// @param[in] reg_info 1136 /// The information for the register to read/write. 1137 /// 1138 /// @param[in] addr 1139 /// The address at which to materialize the variable. 1140 /// 1141 /// @param[in] err 1142 /// An Error to populate with any messages related to 1143 /// (de)materializing the persistent variable. 1144 /// 1145 /// @return 1146 /// True on success; false otherwise. 1147 //------------------------------------------------------------------ 1148 bool 1149 DoMaterializeOneRegister (bool dematerialize, 1150 RegisterContext ®_ctx, 1151 const RegisterInfo ®_info, 1152 lldb::addr_t addr, 1153 Error &err); 1154}; 1155 1156} // namespace lldb_private 1157 1158#endif // liblldb_ClangExpressionDeclMap_h_ 1159