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