ClangExpressionDeclMap.h revision dd1dcfdbad297562951169ad621f895daf32b382
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 /// @return 438 /// The value, or NULL. 439 //------------------------------------------------------------------ 440 lldb_private::Value 441 LookupDecl (clang::NamedDecl *decl); 442 443 //------------------------------------------------------------------ 444 /// [Used by IRInterpreter] Get the Value for "this", "self", or 445 /// "_cmd". 446 /// 447 /// @param[in] name 448 /// The name of the entity to be found. 449 /// 450 /// @return 451 /// The value, or NULL. 452 //------------------------------------------------------------------ 453 lldb_private::Value 454 GetSpecialValue (const ConstString &name); 455 456 //------------------------------------------------------------------ 457 /// [Used by IRInterpreter] Returns true if the result is a 458 /// reference to data in the target, meaning it must be 459 /// dereferenced once more to get its data. 460 /// 461 /// @param[in] name 462 /// The name of the result. 463 /// 464 /// @return 465 /// True if the result is a reference; false otherwise (or on 466 /// error). 467 //------------------------------------------------------------------ 468 bool 469 ResultIsReference (const ConstString &name); 470 471 //------------------------------------------------------------------ 472 /// [Used by IRInterpreter] Find the result persistent variable, 473 /// propagate the given value to it, and return it. 474 /// 475 /// @param[out] valobj 476 /// Set to the complete object. 477 /// 478 /// @param[in] value 479 /// A value indicating the location of the value's contents. 480 /// 481 /// @param[in] name 482 /// The name of the result. 483 /// 484 /// @param[in] type 485 /// The type of the data. 486 /// 487 /// @param[in] transient 488 /// True if the data should be treated as disappearing after the 489 /// expression completes. In that case, it gets no live data. 490 /// 491 /// @param[in] maybe_make_load 492 /// True if the value is a file address but should be potentially 493 /// upgraded to a load address if a target is presence. 494 /// 495 /// @return 496 /// True on success; false otherwise. 497 //------------------------------------------------------------------ 498 bool 499 CompleteResultVariable (lldb::ClangExpressionVariableSP &valobj, 500 lldb_private::Value &value, 501 const ConstString &name, 502 lldb_private::TypeFromParser type, 503 bool transient, 504 bool maybe_make_load); 505 506 507 void 508 RemoveResultVariable (const ConstString &name); 509 510 //------------------------------------------------------------------ 511 /// [Used by CommandObjectExpression] Materialize the entire struct 512 /// at a given address, which should be aligned as specified by 513 /// GetStructInfo(). 514 /// 515 /// @param[in] struct_address 516 /// The address at which the struct should be written. 517 /// 518 /// @param[in] error 519 /// An Error to populate with any messages related to 520 /// materializing the struct. 521 /// 522 /// @return 523 /// True on success; false otherwise. 524 //------------------------------------------------------------------ 525 bool 526 Materialize (lldb::addr_t &struct_address, 527 Error &error); 528 529 //------------------------------------------------------------------ 530 /// [Used by CommandObjectExpression] Get the "this" pointer 531 /// from a given execution context. 532 /// 533 /// @param[out] object_ptr 534 /// The this pointer. 535 /// 536 /// @param[in] object_name 537 /// The name of the object pointer -- "this," "self," or similar 538 /// depending on language 539 /// 540 /// @param[in] error 541 /// An Error to populate with any messages related to 542 /// finding the "this" pointer. 543 /// 544 /// @param[in] suppress_type_check 545 /// True if the type is not needed. 546 /// 547 /// @return 548 /// True on success; false otherwise. 549 //------------------------------------------------------------------ 550 bool 551 GetObjectPointer (lldb::addr_t &object_ptr, 552 ConstString &object_name, 553 Error &error, 554 bool suppress_type_check = false); 555 556 //------------------------------------------------------------------ 557 /// [Used by CommandObjectExpression] Pretty-print a materialized 558 /// struct, which must have been materialized by Materialize(), 559 /// byte for byte on a given stream. 560 /// 561 /// @param[in] exe_ctx 562 /// The execution context from which to read the struct. 563 /// 564 /// @param[in] s 565 /// The stream on which to write the pretty-printed output. 566 /// 567 /// @param[in] error 568 /// An Error to populate with any messages related to 569 /// pretty-printing the struct. 570 /// 571 /// @return 572 /// True on success; false otherwise. 573 //------------------------------------------------------------------ 574 bool 575 DumpMaterializedStruct (Stream &s, 576 Error &error); 577 578 //------------------------------------------------------------------ 579 /// [Used by CommandObjectExpression] Deaterialize the entire struct. 580 /// 581 /// @param[in] exe_ctx 582 /// The execution context from which to read the struct. 583 /// 584 /// @param[out] result 585 /// A ClangExpressionVariable containing the result of the 586 /// expression, for potential re-use. 587 /// 588 /// @param[in] stack_frame_top, stack_frame_bottom 589 /// If not LLDB_INVALID_ADDRESS, the bounds for the stack frame 590 /// in which the expression ran. A result whose address falls 591 /// inside this stack frame is dematerialized as a value 592 /// requiring rematerialization. 593 /// 594 /// @param[in] error 595 /// An Error to populate with any messages related to 596 /// dematerializing the struct. 597 /// 598 /// @return 599 /// True on success; false otherwise. 600 //------------------------------------------------------------------ 601 bool 602 Dematerialize (lldb::ClangExpressionVariableSP &result_sp, 603 lldb::addr_t stack_frame_top, 604 lldb::addr_t stack_frame_bottom, 605 Error &error); 606 607 //------------------------------------------------------------------ 608 /// [Used by ClangASTSource] Find all entities matching a given name, 609 /// using a NameSearchContext to make Decls for them. 610 /// 611 /// @param[in] context 612 /// The NameSearchContext that can construct Decls for this name. 613 /// 614 /// @return 615 /// True on success; false otherwise. 616 //------------------------------------------------------------------ 617 void 618 FindExternalVisibleDecls (NameSearchContext &context); 619 620 //------------------------------------------------------------------ 621 /// Find all entities matching a given name in a given module/namespace, 622 /// using a NameSearchContext to make Decls for them. 623 /// 624 /// @param[in] context 625 /// The NameSearchContext that can construct Decls for this name. 626 /// 627 /// @param[in] module 628 /// If non-NULL, the module to query. 629 /// 630 /// @param[in] namespace_decl 631 /// If valid and module is non-NULL, the parent namespace. 632 /// 633 /// @param[in] name 634 /// The name as a plain C string. The NameSearchContext contains 635 /// a DeclarationName for the name so at first the name may seem 636 /// redundant, but ClangExpressionDeclMap operates in RTTI land so 637 /// it can't access DeclarationName. 638 /// 639 /// @param[in] current_id 640 /// The ID for the current FindExternalVisibleDecls invocation, 641 /// for logging purposes. 642 /// 643 /// @return 644 /// True on success; false otherwise. 645 //------------------------------------------------------------------ 646 void 647 FindExternalVisibleDecls (NameSearchContext &context, 648 lldb::ModuleSP module, 649 ClangNamespaceDecl &namespace_decl, 650 unsigned int current_id); 651private: 652 ClangExpressionVariableList m_found_entities; ///< All entities that were looked up for the parser. 653 ClangExpressionVariableList m_struct_members; ///< All entities that need to be placed in the struct. 654 bool m_keep_result_in_memory; ///< True if result persistent variables generated by this expression should stay in memory. 655 656 //---------------------------------------------------------------------- 657 /// The following values should not live beyond parsing 658 //---------------------------------------------------------------------- 659 class ParserVars 660 { 661 public: 662 ParserVars(ClangExpressionDeclMap &decl_map) : 663 m_exe_ctx(), 664 m_sym_ctx(), 665 m_persistent_vars(NULL), 666 m_enable_lookups(false), 667 m_decl_map(decl_map) 668 { 669 } 670 671 Target * 672 GetTarget() 673 { 674 if (m_exe_ctx.GetTargetPtr()) 675 return m_exe_ctx.GetTargetPtr(); 676 else if (m_sym_ctx.target_sp) 677 m_sym_ctx.target_sp.get(); 678 return NULL; 679 } 680 681 ExecutionContext m_exe_ctx; ///< The execution context to use when parsing. 682 SymbolContext m_sym_ctx; ///< The symbol context to use in finding variables and types. 683 ClangPersistentVariables *m_persistent_vars; ///< The persistent variables for the process. 684 bool m_enable_lookups; ///< Set to true during parsing if we have found the first "$__lldb" name. 685 TargetInfo m_target_info; ///< Basic information about the target. 686 private: 687 ClangExpressionDeclMap &m_decl_map; 688 DISALLOW_COPY_AND_ASSIGN (ParserVars); 689 }; 690 691 std::auto_ptr<ParserVars> m_parser_vars; 692 693 //---------------------------------------------------------------------- 694 /// Activate parser-specific variables 695 //---------------------------------------------------------------------- 696 void 697 EnableParserVars() 698 { 699 if (!m_parser_vars.get()) 700 m_parser_vars.reset(new ParserVars(*this)); 701 } 702 703 //---------------------------------------------------------------------- 704 /// Deallocate parser-specific variables 705 //---------------------------------------------------------------------- 706 void 707 DisableParserVars() 708 { 709 m_parser_vars.reset(); 710 } 711 712 //---------------------------------------------------------------------- 713 /// The following values contain layout information for the materialized 714 /// struct, but are not specific to a single materialization 715 //---------------------------------------------------------------------- 716 struct StructVars { 717 StructVars() : 718 m_struct_alignment(0), 719 m_struct_size(0), 720 m_struct_laid_out(false), 721 m_result_name(), 722 m_object_pointer_type(NULL, NULL) 723 { 724 } 725 726 off_t m_struct_alignment; ///< The alignment of the struct in bytes. 727 size_t m_struct_size; ///< The size of the struct in bytes. 728 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). 729 ConstString m_result_name; ///< The name of the result variable ($1, for example) 730 TypeFromUser m_object_pointer_type; ///< The type of the "this" variable, if one exists 731 }; 732 733 std::auto_ptr<StructVars> m_struct_vars; 734 735 //---------------------------------------------------------------------- 736 /// Activate struct variables 737 //---------------------------------------------------------------------- 738 void 739 EnableStructVars() 740 { 741 if (!m_struct_vars.get()) 742 m_struct_vars.reset(new struct StructVars); 743 } 744 745 //---------------------------------------------------------------------- 746 /// Deallocate struct variables 747 //---------------------------------------------------------------------- 748 void 749 DisableStructVars() 750 { 751 m_struct_vars.reset(); 752 } 753 754 //---------------------------------------------------------------------- 755 /// The following values refer to a specific materialization of the 756 /// structure in a process 757 //---------------------------------------------------------------------- 758 struct MaterialVars { 759 MaterialVars() : 760 m_allocated_area(0), 761 m_materialized_location(0) 762 { 763 } 764 765 Process *m_process; ///< The process that the struct is materialized into. 766 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. 767 lldb::addr_t m_materialized_location; ///< The address at which the struct is placed. Falls inside the allocated area. 768 }; 769 770 std::auto_ptr<MaterialVars> m_material_vars; 771 772 //---------------------------------------------------------------------- 773 /// Activate materialization-specific variables 774 //---------------------------------------------------------------------- 775 void 776 EnableMaterialVars() 777 { 778 if (!m_material_vars.get()) 779 m_material_vars.reset(new struct MaterialVars); 780 } 781 782 //---------------------------------------------------------------------- 783 /// Deallocate materialization-specific variables 784 //---------------------------------------------------------------------- 785 void 786 DisableMaterialVars() 787 { 788 m_material_vars.reset(); 789 } 790 791 //------------------------------------------------------------------ 792 /// Given a stack frame, find a variable that matches the given name and 793 /// type. We need this for expression re-use; we may not always get the 794 /// same lldb::Variable back, and we want the expression to work wherever 795 /// it can. Returns the variable defined in the tightest scope. 796 /// 797 /// @param[in] frame 798 /// The stack frame to use as a basis for finding the variable. 799 /// 800 /// @param[in] name 801 /// The name as a plain C string. 802 /// 803 /// @param[in] type 804 /// The required type for the variable. This function may be called 805 /// during parsing, in which case we don't know its type; hence the 806 /// default. 807 /// 808 /// @return 809 /// The LLDB Variable found, or NULL if none was found. 810 //------------------------------------------------------------------ 811 lldb::VariableSP 812 FindVariableInScope (StackFrame &frame, 813 const ConstString &name, 814 TypeFromUser *type = NULL); 815 816 //------------------------------------------------------------------ 817 /// Given a target, find a data symbol that has the given name. 818 /// 819 /// @param[in] target 820 /// The target to use as the basis for the search. 821 /// 822 /// @param[in] name 823 /// The name as a plain C string. 824 /// 825 /// @return 826 /// The LLDB Symbol found, or NULL if none was found. 827 //--------------------------------------------------------- 828 Symbol * 829 FindGlobalDataSymbol (Target &target, 830 const ConstString &name); 831 832 //------------------------------------------------------------------ 833 /// Given a target, find a variable that matches the given name and 834 /// type. 835 /// 836 /// @param[in] target 837 /// The target to use as a basis for finding the variable. 838 /// 839 /// @param[in] module 840 /// If non-NULL, the module to search. 841 /// 842 /// @param[in] name 843 /// The name as a plain C string. 844 /// 845 /// @param[in] namespace_decl 846 /// If non-NULL and module is non-NULL, the parent namespace. 847 /// 848 /// @param[in] type 849 /// The required type for the variable. This function may be called 850 /// during parsing, in which case we don't know its type; hence the 851 /// default. 852 /// 853 /// @return 854 /// The LLDB Variable found, or NULL if none was found. 855 //------------------------------------------------------------------ 856 lldb::VariableSP 857 FindGlobalVariable (Target &target, 858 lldb::ModuleSP &module, 859 const ConstString &name, 860 ClangNamespaceDecl *namespace_decl, 861 TypeFromUser *type = NULL); 862 863 //------------------------------------------------------------------ 864 /// Get the value of a variable in a given execution context and return 865 /// the associated Types if needed. 866 /// 867 /// @param[in] var 868 /// The variable to evaluate. 869 /// 870 /// @param[in] parser_ast_context 871 /// The AST context of the parser, to store the found type in. 872 /// 873 /// @param[out] found_type 874 /// The type of the found value, as it was found in the user process. 875 /// This is only useful when the variable is being inspected on behalf 876 /// of the parser, hence the default. 877 /// 878 /// @param[out] parser_type 879 /// The type of the found value, as it was copied into the parser's 880 /// AST context. This is only useful when the variable is being 881 /// inspected on behalf of the parser, hence the default. 882 /// 883 /// @param[in] decl 884 /// The Decl to be looked up. 885 /// 886 /// @return 887 /// The LLDB Value for the variable. 888 //------------------------------------------------------------------ 889 Value * 890 GetVariableValue (lldb::VariableSP &var, 891 clang::ASTContext *parser_ast_context, 892 TypeFromUser *found_type = NULL, 893 TypeFromParser *parser_type = NULL); 894 895 //------------------------------------------------------------------ 896 /// Use the NameSearchContext to generate a Decl for the given LLDB 897 /// Variable, and put it in the Tuple list. 898 /// 899 /// @param[in] context 900 /// The NameSearchContext to use when constructing the Decl. 901 /// 902 /// @param[in] var 903 /// The LLDB Variable that needs a Decl. 904 /// 905 /// @param[in] valobj 906 /// The LLDB ValueObject for that variable. 907 //------------------------------------------------------------------ 908 void 909 AddOneVariable (NameSearchContext &context, 910 lldb::VariableSP var, 911 lldb::ValueObjectSP valobj, 912 unsigned int current_id); 913 914 //------------------------------------------------------------------ 915 /// Use the NameSearchContext to generate a Decl for the given 916 /// persistent variable, and put it in the list of found entities. 917 /// 918 /// @param[in] context 919 /// The NameSearchContext to use when constructing the Decl. 920 /// 921 /// @param[in] pvar 922 /// The persistent variable that needs a Decl. 923 /// 924 /// @param[in] current_id 925 /// The ID of the current invocation of FindExternalVisibleDecls 926 /// for logging purposes. 927 //------------------------------------------------------------------ 928 void 929 AddOneVariable (NameSearchContext &context, 930 lldb::ClangExpressionVariableSP &pvar_sp, 931 unsigned int current_id); 932 933 //------------------------------------------------------------------ 934 /// Use the NameSearchContext to generate a Decl for the given LLDB 935 /// symbol (treated as a variable), and put it in the list of found 936 /// entities. 937 /// 938 /// @param[in] context 939 /// The NameSearchContext to use when constructing the Decl. 940 /// 941 /// @param[in] var 942 /// The LLDB Variable that needs a Decl. 943 //------------------------------------------------------------------ 944 void 945 AddOneGenericVariable (NameSearchContext &context, 946 Symbol &symbol, 947 unsigned int current_id); 948 949 //------------------------------------------------------------------ 950 /// Use the NameSearchContext to generate a Decl for the given 951 /// function. (Functions are not placed in the Tuple list.) Can 952 /// handle both fully typed functions and generic functions. 953 /// 954 /// @param[in] context 955 /// The NameSearchContext to use when constructing the Decl. 956 /// 957 /// @param[in] fun 958 /// The Function that needs to be created. If non-NULL, this is 959 /// a fully-typed function. 960 /// 961 /// @param[in] sym 962 /// The Symbol that corresponds to a function that needs to be 963 /// created with generic type (unitptr_t foo(...)). 964 //------------------------------------------------------------------ 965 void 966 AddOneFunction (NameSearchContext &context, 967 Function *fun, 968 Symbol *sym, 969 unsigned int current_id); 970 971 //------------------------------------------------------------------ 972 /// Use the NameSearchContext to generate a Decl for the given 973 /// register. 974 /// 975 /// @param[in] context 976 /// The NameSearchContext to use when constructing the Decl. 977 /// 978 /// @param[in] reg_info 979 /// The information corresponding to that register. 980 //------------------------------------------------------------------ 981 void 982 AddOneRegister (NameSearchContext &context, 983 const RegisterInfo *reg_info, 984 unsigned int current_id); 985 986 //------------------------------------------------------------------ 987 /// Use the NameSearchContext to generate a Decl for the given 988 /// type. (Types are not placed in the Tuple list.) 989 /// 990 /// @param[in] context 991 /// The NameSearchContext to use when constructing the Decl. 992 /// 993 /// @param[in] type 994 /// The type that needs to be created. 995 /// 996 /// @param[in] add_method 997 /// True if a method with signature void $__lldb_expr(void*) 998 /// should be added to the C++ class type passed in 999 //------------------------------------------------------------------ 1000 void 1001 AddOneType (NameSearchContext &context, 1002 TypeFromUser &type, 1003 unsigned int current_id, 1004 bool add_method); 1005 1006 //------------------------------------------------------------------ 1007 /// Actually do the task of materializing or dematerializing the struct. 1008 /// Since both tasks are very similar, although ClangExpressionDeclMap 1009 /// exposes two functions to the outside, both call DoMaterialize. 1010 /// 1011 /// @param[in] dematerialize 1012 /// True if the struct is to be dematerialized; false if it is to 1013 /// be materialized. 1014 /// 1015 /// @param[in] stack_frame_top, stack_frame_bottom 1016 /// If not LLDB_INVALID_ADDRESS, the bounds for the stack frame 1017 /// in which the expression ran. A result whose address falls 1018 /// inside this stack frame is dematerialized as a value 1019 /// requiring rematerialization. 1020 /// 1021 /// @param[out] result 1022 /// If the struct is being dematerialized, a pointer into which the 1023 /// location of the result persistent variable is placed. If not, 1024 /// NULL. 1025 /// 1026 /// @param[in] err 1027 /// An Error to populate with any messages related to 1028 /// (de)materializing the struct. 1029 /// 1030 /// @return 1031 /// True on success; false otherwise. 1032 //------------------------------------------------------------------ 1033 bool 1034 DoMaterialize (bool dematerialize, 1035 lldb::addr_t stack_frame_top, 1036 lldb::addr_t stack_frame_bottom, 1037 lldb::ClangExpressionVariableSP *result_sp_ptr, 1038 Error &err); 1039 1040 //------------------------------------------------------------------ 1041 /// Clean up the state required to dematerialize the variable. 1042 //------------------------------------------------------------------ 1043 void 1044 DidDematerialize (); 1045 1046 //------------------------------------------------------------------ 1047 /// Actually do the task of materializing or dematerializing a persistent 1048 /// variable. 1049 /// 1050 /// @param[in] dematerialize 1051 /// True if the variable is to be dematerialized; false if it is to 1052 /// be materialized. 1053 /// 1054 /// @param[in] var_sp 1055 /// The persistent variable to materialize 1056 /// 1057 /// @param[in] addr 1058 /// The address at which to materialize the variable. 1059 /// 1060 /// @param[in] stack_frame_top, stack_frame_bottom 1061 /// If not LLDB_INVALID_ADDRESS, the bounds for the stack frame 1062 /// in which the expression ran. A result whose address falls 1063 /// inside this stack frame is dematerialized as a value 1064 /// requiring rematerialization. 1065 /// 1066 /// @param[in] err 1067 /// An Error to populate with any messages related to 1068 /// (de)materializing the persistent variable. 1069 /// 1070 /// @return 1071 /// True on success; false otherwise. 1072 //------------------------------------------------------------------ 1073 bool 1074 DoMaterializeOnePersistentVariable (bool dematerialize, 1075 lldb::ClangExpressionVariableSP &var_sp, 1076 lldb::addr_t addr, 1077 lldb::addr_t stack_frame_top, 1078 lldb::addr_t stack_frame_bottom, 1079 Error &err); 1080 1081 //------------------------------------------------------------------ 1082 /// Actually do the task of materializing or dematerializing a 1083 /// variable. 1084 /// 1085 /// @param[in] dematerialize 1086 /// True if the variable is to be dematerialized; false if it is to 1087 /// be materialized. 1088 /// 1089 /// @param[in] sym_ctx 1090 /// The symbol context to use (for looking the variable up). 1091 /// 1092 /// @param[in] expr_var 1093 /// The entity that the expression parser uses for the variable. 1094 /// In case the variable needs to be copied into the target's 1095 /// memory, this location is stored in the variable during 1096 /// materialization and cleared when it is demateralized. 1097 /// 1098 /// @param[in] addr 1099 /// The address at which to materialize the variable. 1100 /// 1101 /// @param[in] err 1102 /// An Error to populate with any messages related to 1103 /// (de)materializing the persistent variable. 1104 /// 1105 /// @return 1106 /// True on success; false otherwise. 1107 //------------------------------------------------------------------ 1108 bool 1109 DoMaterializeOneVariable (bool dematerialize, 1110 const SymbolContext &sym_ctx, 1111 lldb::ClangExpressionVariableSP &expr_var, 1112 lldb::addr_t addr, 1113 Error &err); 1114 1115 //------------------------------------------------------------------ 1116 /// Actually do the task of materializing or dematerializing a 1117 /// register variable. 1118 /// 1119 /// @param[in] dematerialize 1120 /// True if the variable is to be dematerialized; false if it is to 1121 /// be materialized. 1122 /// 1123 /// @param[in] reg_ctx 1124 /// The register context to use. 1125 /// 1126 /// @param[in] reg_info 1127 /// The information for the register to read/write. 1128 /// 1129 /// @param[in] addr 1130 /// The address at which to materialize the variable. 1131 /// 1132 /// @param[in] err 1133 /// An Error to populate with any messages related to 1134 /// (de)materializing the persistent variable. 1135 /// 1136 /// @return 1137 /// True on success; false otherwise. 1138 //------------------------------------------------------------------ 1139 bool 1140 DoMaterializeOneRegister (bool dematerialize, 1141 RegisterContext ®_ctx, 1142 const RegisterInfo ®_info, 1143 lldb::addr_t addr, 1144 Error &err); 1145}; 1146 1147} // namespace lldb_private 1148 1149#endif // liblldb_ClangExpressionDeclMap_h_ 1150