1 //===-- Materializer.cpp ----------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/Core/Log.h"
11 #include "lldb/Core/RegisterValue.h"
12 #include "lldb/Core/ValueObjectConstResult.h"
13 #include "lldb/Core/ValueObjectVariable.h"
14 #include "lldb/Expression/ClangExpressionVariable.h"
15 #include "lldb/Expression/Materializer.h"
16 #include "lldb/Symbol/ClangASTContext.h"
17 #include "lldb/Symbol/Symbol.h"
18 #include "lldb/Symbol/Type.h"
19 #include "lldb/Symbol/Variable.h"
20 #include "lldb/Target/ExecutionContext.h"
21 #include "lldb/Target/RegisterContext.h"
22 #include "lldb/Target/StackFrame.h"
23 #include "lldb/Target/Target.h"
24 #include "lldb/Target/Thread.h"
26 using namespace lldb_private;
29 Materializer::AddStructMember (Entity &entity)
31 uint32_t size = entity.GetSize();
32 uint32_t alignment = entity.GetAlignment();
36 if (m_current_offset == 0)
37 m_struct_alignment = alignment;
39 if (m_current_offset % alignment)
40 m_current_offset += (alignment - (m_current_offset % alignment));
42 ret = m_current_offset;
44 m_current_offset += size;
50 Materializer::Entity::SetSizeAndAlignmentFromType (ClangASTType &type)
52 m_size = type.GetByteSize();
54 uint32_t bit_alignment = type.GetTypeBitAlign();
56 if (bit_alignment % 8)
59 bit_alignment &= ~((uint32_t)0x111u);
62 m_alignment = bit_alignment / 8;
65 class EntityPersistentVariable : public Materializer::Entity
68 EntityPersistentVariable (lldb::ClangExpressionVariableSP &persistent_variable_sp) :
70 m_persistent_variable_sp(persistent_variable_sp)
72 // Hard-coding to maximum size of a pointer since persistent variables are materialized by reference
77 void MakeAllocation (IRMemoryMap &map, Error &err)
79 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
81 // Allocate a spare memory area to store the persistent variable's contents.
85 lldb::addr_t mem = map.Malloc(m_persistent_variable_sp->GetByteSize(),
87 lldb::ePermissionsReadable | lldb::ePermissionsWritable,
88 IRMemoryMap::eAllocationPolicyMirror,
91 if (!allocate_error.Success())
93 err.SetErrorStringWithFormat("couldn't allocate a memory area to store %s: %s", m_persistent_variable_sp->GetName().GetCString(), allocate_error.AsCString());
98 log->Printf("Allocated %s (0x%" PRIx64 ") sucessfully", m_persistent_variable_sp->GetName().GetCString(), mem);
100 // Put the location of the spare memory into the live data of the ValueObject.
102 m_persistent_variable_sp->m_live_sp = ValueObjectConstResult::Create (map.GetBestExecutionContextScope(),
103 m_persistent_variable_sp->GetTypeFromUser(),
104 m_persistent_variable_sp->GetName(),
107 m_persistent_variable_sp->GetByteSize());
109 // Clear the flag if the variable will never be deallocated.
111 if (m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVKeepInTarget)
114 map.Leak(mem, leak_error);
115 m_persistent_variable_sp->m_flags &= ~ClangExpressionVariable::EVNeedsAllocation;
118 // Write the contents of the variable to the area.
122 map.WriteMemory (mem,
123 m_persistent_variable_sp->GetValueBytes(),
124 m_persistent_variable_sp->GetByteSize(),
127 if (!write_error.Success())
129 err.SetErrorStringWithFormat ("couldn't write %s to the target: %s", m_persistent_variable_sp->GetName().AsCString(),
130 write_error.AsCString());
135 void DestroyAllocation (IRMemoryMap &map, Error &err)
137 Error deallocate_error;
139 map.Free((lldb::addr_t)m_persistent_variable_sp->m_live_sp->GetValue().GetScalar().ULongLong(), deallocate_error);
141 m_persistent_variable_sp->m_live_sp.reset();
143 if (!deallocate_error.Success())
145 err.SetErrorStringWithFormat ("couldn't deallocate memory for %s: %s", m_persistent_variable_sp->GetName().GetCString(), deallocate_error.AsCString());
149 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
151 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
153 const lldb::addr_t load_addr = process_address + m_offset;
157 log->Printf("EntityPersistentVariable::Materialize [address = 0x%" PRIx64 ", m_name = %s, m_flags = 0x%hx]",
159 m_persistent_variable_sp->GetName().AsCString(),
160 m_persistent_variable_sp->m_flags);
163 if (m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVNeedsAllocation)
165 MakeAllocation(map, err);
166 m_persistent_variable_sp->m_flags |= ClangExpressionVariable::EVIsLLDBAllocated;
172 if ((m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVIsProgramReference && m_persistent_variable_sp->m_live_sp) ||
173 m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVIsLLDBAllocated)
177 map.WriteScalarToMemory(load_addr,
178 m_persistent_variable_sp->m_live_sp->GetValue().GetScalar(),
179 map.GetAddressByteSize(),
182 if (!write_error.Success())
184 err.SetErrorStringWithFormat("couldn't write the location of %s to memory: %s", m_persistent_variable_sp->GetName().AsCString(), write_error.AsCString());
189 err.SetErrorStringWithFormat("no materialization happened for persistent variable %s", m_persistent_variable_sp->GetName().AsCString());
194 void Dematerialize (lldb::StackFrameSP &frame_sp,
196 lldb::addr_t process_address,
197 lldb::addr_t frame_top,
198 lldb::addr_t frame_bottom,
201 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
203 const lldb::addr_t load_addr = process_address + m_offset;
207 log->Printf("EntityPersistentVariable::Dematerialize [address = 0x%" PRIx64 ", m_name = %s, m_flags = 0x%hx]",
208 (uint64_t)process_address + m_offset,
209 m_persistent_variable_sp->GetName().AsCString(),
210 m_persistent_variable_sp->m_flags);
213 if ((m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVIsLLDBAllocated) ||
214 (m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVIsProgramReference))
216 if (m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVIsProgramReference &&
217 !m_persistent_variable_sp->m_live_sp)
219 // If the reference comes from the program, then the ClangExpressionVariable's
220 // live variable data hasn't been set up yet. Do this now.
222 lldb::addr_t location;
225 map.ReadPointerFromMemory(&location, load_addr, read_error);
227 if (!read_error.Success())
229 err.SetErrorStringWithFormat("couldn't read the address of program-allocated variable %s: %s", m_persistent_variable_sp->GetName().GetCString(), read_error.AsCString());
233 m_persistent_variable_sp->m_live_sp = ValueObjectConstResult::Create (map.GetBestExecutionContextScope (),
234 m_persistent_variable_sp->GetTypeFromUser(),
235 m_persistent_variable_sp->GetName(),
238 m_persistent_variable_sp->GetByteSize());
240 if (frame_top != LLDB_INVALID_ADDRESS &&
241 frame_bottom != LLDB_INVALID_ADDRESS &&
242 location >= frame_bottom &&
243 location <= frame_top)
245 // If the variable is resident in the stack frame created by the expression,
246 // then it cannot be relied upon to stay around. We treat it as needing
248 m_persistent_variable_sp->m_flags |= ClangExpressionVariable::EVIsLLDBAllocated;
249 m_persistent_variable_sp->m_flags |= ClangExpressionVariable::EVNeedsAllocation;
250 m_persistent_variable_sp->m_flags |= ClangExpressionVariable::EVNeedsFreezeDry;
251 m_persistent_variable_sp->m_flags &= ~ClangExpressionVariable::EVIsProgramReference;
255 lldb::addr_t mem = m_persistent_variable_sp->m_live_sp->GetValue().GetScalar().ULongLong();
257 if (!m_persistent_variable_sp->m_live_sp)
259 err.SetErrorStringWithFormat("couldn't find the memory area used to store %s", m_persistent_variable_sp->GetName().GetCString());
263 if (m_persistent_variable_sp->m_live_sp->GetValue().GetValueAddressType() != eAddressTypeLoad)
265 err.SetErrorStringWithFormat("the address of the memory area for %s is in an incorrect format", m_persistent_variable_sp->GetName().GetCString());
269 if (m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVNeedsFreezeDry ||
270 m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVKeepInTarget)
273 log->Printf("Dematerializing %s from 0x%" PRIx64 " (size = %llu)", m_persistent_variable_sp->GetName().GetCString(), (uint64_t)mem, (unsigned long long)m_persistent_variable_sp->GetByteSize());
275 // Read the contents of the spare memory area
277 m_persistent_variable_sp->ValueUpdated ();
281 map.ReadMemory(m_persistent_variable_sp->GetValueBytes(),
283 m_persistent_variable_sp->GetByteSize(),
286 if (!read_error.Success())
288 err.SetErrorStringWithFormat ("couldn't read the contents of %s from memory: %s", m_persistent_variable_sp->GetName().GetCString(), read_error.AsCString());
292 m_persistent_variable_sp->m_flags &= ~ClangExpressionVariable::EVNeedsFreezeDry;
297 err.SetErrorStringWithFormat("no dematerialization happened for persistent variable %s", m_persistent_variable_sp->GetName().AsCString());
301 lldb::ProcessSP process_sp = map.GetBestExecutionContextScope()->CalculateProcess();
303 !process_sp->CanJIT())
305 // Allocations are not persistent so persistent variables cannot stay materialized.
307 m_persistent_variable_sp->m_flags |= ClangExpressionVariable::EVNeedsAllocation;
309 DestroyAllocation(map, err);
313 else if (m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVNeedsAllocation &&
314 !(m_persistent_variable_sp->m_flags & ClangExpressionVariable::EVKeepInTarget))
316 DestroyAllocation(map, err);
322 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
324 StreamString dump_stream;
328 const lldb::addr_t load_addr = process_address + m_offset;
330 dump_stream.Printf("0x%" PRIx64 ": EntityPersistentVariable (%s)\n", load_addr, m_persistent_variable_sp->GetName().AsCString());
333 dump_stream.Printf("Pointer:\n");
335 DataBufferHeap data (m_size, 0);
337 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
341 dump_stream.Printf(" <could not be read>\n");
345 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
347 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
349 dump_stream.PutChar('\n');
354 dump_stream.Printf("Target:\n");
356 lldb::addr_t target_address;
358 map.ReadPointerFromMemory (&target_address, load_addr, err);
362 dump_stream.Printf(" <could not be read>\n");
366 DataBufferHeap data (m_persistent_variable_sp->GetByteSize(), 0);
368 map.ReadMemory(data.GetBytes(), target_address, m_persistent_variable_sp->GetByteSize(), err);
372 dump_stream.Printf(" <could not be read>\n");
376 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
378 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, target_address);
380 dump_stream.PutChar('\n');
385 log->PutCString(dump_stream.GetData());
388 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
392 lldb::ClangExpressionVariableSP m_persistent_variable_sp;
396 Materializer::AddPersistentVariable (lldb::ClangExpressionVariableSP &persistent_variable_sp, Error &err)
398 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
399 iter->reset (new EntityPersistentVariable (persistent_variable_sp));
400 uint32_t ret = AddStructMember(**iter);
401 (*iter)->SetOffset(ret);
405 class EntityVariable : public Materializer::Entity
408 EntityVariable (lldb::VariableSP &variable_sp) :
410 m_variable_sp(variable_sp),
411 m_is_reference(false),
412 m_temporary_allocation(LLDB_INVALID_ADDRESS),
413 m_temporary_allocation_size(0)
415 // Hard-coding to maximum size of a pointer since all variables are materialized by reference
418 m_is_reference = m_variable_sp->GetType()->GetClangForwardType().IsReferenceType();
421 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
423 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
425 const lldb::addr_t load_addr = process_address + m_offset;
428 log->Printf("EntityVariable::Materialize [address = 0x%" PRIx64 ", m_variable_sp = %s]",
430 m_variable_sp->GetName().AsCString());
433 ExecutionContextScope *scope = frame_sp.get();
436 scope = map.GetBestExecutionContextScope();
438 lldb::ValueObjectSP valobj_sp = ValueObjectVariable::Create(scope, m_variable_sp);
442 err.SetErrorStringWithFormat("couldn't get a value object for variable %s", m_variable_sp->GetName().AsCString());
448 DataExtractor valobj_extractor;
449 valobj_sp->GetData(valobj_extractor);
450 lldb::offset_t offset = 0;
451 lldb::addr_t reference_addr = valobj_extractor.GetAddress(&offset);
454 map.WritePointerToMemory(load_addr, reference_addr, write_error);
456 if (!write_error.Success())
458 err.SetErrorStringWithFormat("couldn't write the contents of reference variable %s to memory: %s", m_variable_sp->GetName().AsCString(), write_error.AsCString());
464 Error get_address_error;
465 lldb::ValueObjectSP addr_of_valobj_sp = valobj_sp->AddressOf(get_address_error);
466 if (get_address_error.Success())
468 DataExtractor valobj_extractor;
469 addr_of_valobj_sp->GetData(valobj_extractor);
470 lldb::offset_t offset = 0;
471 lldb::addr_t addr_of_valobj_addr = valobj_extractor.GetAddress(&offset);
474 map.WritePointerToMemory(load_addr, addr_of_valobj_addr, write_error);
476 if (!write_error.Success())
478 err.SetErrorStringWithFormat("couldn't write the address of variable %s to memory: %s", m_variable_sp->GetName().AsCString(), write_error.AsCString());
485 valobj_sp->GetData(data);
487 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
489 err.SetErrorStringWithFormat("trying to create a temporary region for %s but one exists", m_variable_sp->GetName().AsCString());
493 if (data.GetByteSize() != m_variable_sp->GetType()->GetByteSize())
495 if (data.GetByteSize() == 0 && m_variable_sp->LocationExpression().IsValid() == false)
497 err.SetErrorStringWithFormat("the variable '%s' has no location, it may have been optimized out", m_variable_sp->GetName().AsCString());
501 err.SetErrorStringWithFormat("size of variable %s disagrees with the ValueObject's size", m_variable_sp->GetName().AsCString());
506 size_t bit_align = m_variable_sp->GetType()->GetClangLayoutType().GetTypeBitAlign();
507 size_t byte_align = (bit_align + 7) / 8;
511 m_temporary_allocation = map.Malloc(data.GetByteSize(), byte_align, lldb::ePermissionsReadable | lldb::ePermissionsWritable, IRMemoryMap::eAllocationPolicyMirror, alloc_error);
512 m_temporary_allocation_size = data.GetByteSize();
514 if (!alloc_error.Success())
516 err.SetErrorStringWithFormat("couldn't allocate a temporary region for %s: %s", m_variable_sp->GetName().AsCString(), alloc_error.AsCString());
522 map.WriteMemory(m_temporary_allocation, data.GetDataStart(), data.GetByteSize(), write_error);
524 if (!write_error.Success())
526 err.SetErrorStringWithFormat("couldn't write to the temporary region for %s: %s", m_variable_sp->GetName().AsCString(), write_error.AsCString());
530 Error pointer_write_error;
532 map.WritePointerToMemory(load_addr, m_temporary_allocation, pointer_write_error);
534 if (!pointer_write_error.Success())
536 err.SetErrorStringWithFormat("couldn't write the address of the temporary region for %s: %s", m_variable_sp->GetName().AsCString(), pointer_write_error.AsCString());
542 void Dematerialize (lldb::StackFrameSP &frame_sp,
544 lldb::addr_t process_address,
545 lldb::addr_t frame_top,
546 lldb::addr_t frame_bottom,
549 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
551 const lldb::addr_t load_addr = process_address + m_offset;
554 log->Printf("EntityVariable::Dematerialize [address = 0x%" PRIx64 ", m_variable_sp = %s]",
556 m_variable_sp->GetName().AsCString());
559 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
561 ExecutionContextScope *scope = frame_sp.get();
564 scope = map.GetBestExecutionContextScope();
566 lldb::ValueObjectSP valobj_sp = ValueObjectVariable::Create(scope, m_variable_sp);
570 err.SetErrorStringWithFormat("couldn't get a value object for variable %s", m_variable_sp->GetName().AsCString());
574 lldb_private::DataExtractor data;
578 map.GetMemoryData(data, m_temporary_allocation, valobj_sp->GetByteSize(), extract_error);
580 if (!extract_error.Success())
582 err.SetErrorStringWithFormat("couldn't get the data for variable %s", m_variable_sp->GetName().AsCString());
588 valobj_sp->SetData(data, set_error);
590 if (!set_error.Success())
592 err.SetErrorStringWithFormat("couldn't write the new contents of %s back into the variable", m_variable_sp->GetName().AsCString());
598 map.Free(m_temporary_allocation, free_error);
600 if (!free_error.Success())
602 err.SetErrorStringWithFormat("couldn't free the temporary region for %s: %s", m_variable_sp->GetName().AsCString(), free_error.AsCString());
606 m_temporary_allocation = LLDB_INVALID_ADDRESS;
607 m_temporary_allocation_size = 0;
611 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
613 StreamString dump_stream;
615 const lldb::addr_t load_addr = process_address + m_offset;
616 dump_stream.Printf("0x%" PRIx64 ": EntityVariable\n", load_addr);
620 lldb::addr_t ptr = LLDB_INVALID_ADDRESS;
623 dump_stream.Printf("Pointer:\n");
625 DataBufferHeap data (m_size, 0);
627 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
631 dump_stream.Printf(" <could not be read>\n");
635 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
637 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
639 lldb::offset_t offset;
641 ptr = extractor.GetPointer(&offset);
643 dump_stream.PutChar('\n');
647 if (m_temporary_allocation == LLDB_INVALID_ADDRESS)
649 dump_stream.Printf("Points to process memory:\n");
653 dump_stream.Printf("Temporary allocation:\n");
656 if (ptr == LLDB_INVALID_ADDRESS)
658 dump_stream.Printf(" <could not be be found>\n");
662 DataBufferHeap data (m_temporary_allocation_size, 0);
664 map.ReadMemory(data.GetBytes(), m_temporary_allocation, m_temporary_allocation_size, err);
668 dump_stream.Printf(" <could not be read>\n");
672 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
674 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
676 dump_stream.PutChar('\n');
680 log->PutCString(dump_stream.GetData());
683 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
685 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
689 map.Free(m_temporary_allocation, free_error);
691 m_temporary_allocation = LLDB_INVALID_ADDRESS;
692 m_temporary_allocation_size = 0;
697 lldb::VariableSP m_variable_sp;
699 lldb::addr_t m_temporary_allocation;
700 size_t m_temporary_allocation_size;
704 Materializer::AddVariable (lldb::VariableSP &variable_sp, Error &err)
706 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
707 iter->reset (new EntityVariable (variable_sp));
708 uint32_t ret = AddStructMember(**iter);
709 (*iter)->SetOffset(ret);
713 class EntityResultVariable : public Materializer::Entity
716 EntityResultVariable (const TypeFromUser &type, bool is_program_reference, bool keep_in_memory) :
719 m_is_program_reference(is_program_reference),
720 m_keep_in_memory(keep_in_memory),
721 m_temporary_allocation(LLDB_INVALID_ADDRESS),
722 m_temporary_allocation_size(0)
724 // Hard-coding to maximum size of a pointer since all results are materialized by reference
729 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
731 if (!m_is_program_reference)
733 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
735 err.SetErrorString("Trying to create a temporary region for the result but one exists");
739 const lldb::addr_t load_addr = process_address + m_offset;
741 size_t byte_size = m_type.GetByteSize();
742 size_t bit_align = m_type.GetTypeBitAlign();
743 size_t byte_align = (bit_align + 7) / 8;
747 m_temporary_allocation = map.Malloc(byte_size, byte_align, lldb::ePermissionsReadable | lldb::ePermissionsWritable, IRMemoryMap::eAllocationPolicyMirror, alloc_error);
748 m_temporary_allocation_size = byte_size;
750 if (!alloc_error.Success())
752 err.SetErrorStringWithFormat("couldn't allocate a temporary region for the result: %s", alloc_error.AsCString());
756 Error pointer_write_error;
758 map.WritePointerToMemory(load_addr, m_temporary_allocation, pointer_write_error);
760 if (!pointer_write_error.Success())
762 err.SetErrorStringWithFormat("couldn't write the address of the temporary region for the result: %s", pointer_write_error.AsCString());
767 void Dematerialize (lldb::StackFrameSP &frame_sp,
769 lldb::addr_t process_address,
770 lldb::addr_t frame_top,
771 lldb::addr_t frame_bottom,
774 err.SetErrorString("Tried to detmaterialize a result variable with the normal Dematerialize method");
777 void Dematerialize (lldb::ClangExpressionVariableSP &result_variable_sp,
778 lldb::StackFrameSP &frame_sp,
780 lldb::addr_t process_address,
781 lldb::addr_t frame_top,
782 lldb::addr_t frame_bottom,
787 ExecutionContextScope *exe_scope = map.GetBestExecutionContextScope();
791 err.SetErrorString("Couldn't dematerialize a result variable: invalid execution context scope");
795 lldb::addr_t address;
797 const lldb::addr_t load_addr = process_address + m_offset;
799 map.ReadPointerFromMemory (&address, load_addr, read_error);
801 if (!read_error.Success())
803 err.SetErrorString("Couldn't dematerialize a result variable: couldn't read its address");
807 lldb::TargetSP target_sp = exe_scope->CalculateTarget();
811 err.SetErrorString("Couldn't dematerialize a result variable: no target");
815 ConstString name = target_sp->GetPersistentVariables().GetNextPersistentVariableName();
817 lldb::ClangExpressionVariableSP ret;
819 ret = target_sp->GetPersistentVariables().CreateVariable(exe_scope,
823 map.GetAddressByteSize());
827 err.SetErrorStringWithFormat("couldn't dematerialize a result variable: failed to make persistent variable %s", name.AsCString());
831 lldb::ProcessSP process_sp = map.GetBestExecutionContextScope()->CalculateProcess();
833 bool can_persist = (m_is_program_reference && process_sp && process_sp->CanJIT() && !(address >= frame_bottom && address < frame_top));
835 if (can_persist && m_keep_in_memory)
837 ret->m_live_sp = ValueObjectConstResult::Create(exe_scope,
847 const size_t pvar_byte_size = ret->GetByteSize();
848 uint8_t *pvar_data = ret->GetValueBytes();
850 map.ReadMemory(pvar_data, address, pvar_byte_size, read_error);
852 if (!read_error.Success())
854 err.SetErrorString("Couldn't dematerialize a result variable: couldn't read its memory");
858 result_variable_sp = ret;
860 if (!can_persist || !m_keep_in_memory)
862 ret->m_flags |= ClangExpressionVariable::EVNeedsAllocation;
864 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
867 map.Free(m_temporary_allocation, free_error);
872 ret->m_flags |= ClangExpressionVariable::EVIsLLDBAllocated;
875 m_temporary_allocation = LLDB_INVALID_ADDRESS;
876 m_temporary_allocation_size = 0;
879 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
881 StreamString dump_stream;
883 const lldb::addr_t load_addr = process_address + m_offset;
885 dump_stream.Printf("0x%" PRIx64 ": EntityResultVariable\n", load_addr);
889 lldb::addr_t ptr = LLDB_INVALID_ADDRESS;
892 dump_stream.Printf("Pointer:\n");
894 DataBufferHeap data (m_size, 0);
896 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
900 dump_stream.Printf(" <could not be read>\n");
904 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
906 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
908 lldb::offset_t offset;
910 ptr = extractor.GetPointer(&offset);
912 dump_stream.PutChar('\n');
916 if (m_temporary_allocation == LLDB_INVALID_ADDRESS)
918 dump_stream.Printf("Points to process memory:\n");
922 dump_stream.Printf("Temporary allocation:\n");
925 if (ptr == LLDB_INVALID_ADDRESS)
927 dump_stream.Printf(" <could not be be found>\n");
931 DataBufferHeap data (m_temporary_allocation_size, 0);
933 map.ReadMemory(data.GetBytes(), m_temporary_allocation, m_temporary_allocation_size, err);
937 dump_stream.Printf(" <could not be read>\n");
941 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
943 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
945 dump_stream.PutChar('\n');
949 log->PutCString(dump_stream.GetData());
952 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
954 if (!m_keep_in_memory && m_temporary_allocation != LLDB_INVALID_ADDRESS)
958 map.Free(m_temporary_allocation, free_error);
961 m_temporary_allocation = LLDB_INVALID_ADDRESS;
962 m_temporary_allocation_size = 0;
966 bool m_is_program_reference;
967 bool m_keep_in_memory;
969 lldb::addr_t m_temporary_allocation;
970 size_t m_temporary_allocation_size;
974 Materializer::AddResultVariable (const TypeFromUser &type, bool is_program_reference, bool keep_in_memory, Error &err)
976 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
977 iter->reset (new EntityResultVariable (type, is_program_reference, keep_in_memory));
978 uint32_t ret = AddStructMember(**iter);
979 (*iter)->SetOffset(ret);
980 m_result_entity = iter->get();
984 class EntitySymbol : public Materializer::Entity
987 EntitySymbol (const Symbol &symbol) :
991 // Hard-coding to maximum size of a symbol
996 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
998 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
1000 const lldb::addr_t load_addr = process_address + m_offset;
1004 log->Printf("EntitySymbol::Materialize [address = 0x%" PRIx64 ", m_symbol = %s]",
1005 (uint64_t)load_addr,
1006 m_symbol.GetName().AsCString());
1009 Address &sym_address = m_symbol.GetAddress();
1011 ExecutionContextScope *exe_scope = map.GetBestExecutionContextScope();
1013 lldb::TargetSP target_sp;
1016 target_sp = map.GetBestExecutionContextScope()->CalculateTarget();
1020 err.SetErrorStringWithFormat("couldn't resolve symbol %s because there is no target", m_symbol.GetName().AsCString());
1024 lldb::addr_t resolved_address = sym_address.GetLoadAddress(target_sp.get());
1026 if (resolved_address == LLDB_INVALID_ADDRESS)
1027 resolved_address = sym_address.GetFileAddress();
1029 Error pointer_write_error;
1031 map.WritePointerToMemory(load_addr, resolved_address, pointer_write_error);
1033 if (!pointer_write_error.Success())
1035 err.SetErrorStringWithFormat("couldn't write the address of symbol %s: %s", m_symbol.GetName().AsCString(), pointer_write_error.AsCString());
1040 void Dematerialize (lldb::StackFrameSP &frame_sp,
1042 lldb::addr_t process_address,
1043 lldb::addr_t frame_top,
1044 lldb::addr_t frame_bottom,
1047 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
1049 const lldb::addr_t load_addr = process_address + m_offset;
1053 log->Printf("EntitySymbol::Dematerialize [address = 0x%" PRIx64 ", m_symbol = %s]",
1054 (uint64_t)load_addr,
1055 m_symbol.GetName().AsCString());
1058 // no work needs to be done
1061 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
1063 StreamString dump_stream;
1067 const lldb::addr_t load_addr = process_address + m_offset;
1069 dump_stream.Printf("0x%" PRIx64 ": EntitySymbol (%s)\n", load_addr, m_symbol.GetName().AsCString());
1072 dump_stream.Printf("Pointer:\n");
1074 DataBufferHeap data (m_size, 0);
1076 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
1080 dump_stream.Printf(" <could not be read>\n");
1084 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
1086 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
1088 dump_stream.PutChar('\n');
1092 log->PutCString(dump_stream.GetData());
1095 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
1103 Materializer::AddSymbol (const Symbol &symbol_sp, Error &err)
1105 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
1106 iter->reset (new EntitySymbol (symbol_sp));
1107 uint32_t ret = AddStructMember(**iter);
1108 (*iter)->SetOffset(ret);
1112 class EntityRegister : public Materializer::Entity
1115 EntityRegister (const RegisterInfo ®ister_info) :
1117 m_register_info(register_info)
1119 // Hard-coding alignment conservatively
1120 m_size = m_register_info.byte_size;
1121 m_alignment = m_register_info.byte_size;
1124 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
1126 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
1128 const lldb::addr_t load_addr = process_address + m_offset;
1132 log->Printf("EntityRegister::Materialize [address = 0x%" PRIx64 ", m_register_info = %s]",
1133 (uint64_t)load_addr,
1134 m_register_info.name);
1137 RegisterValue reg_value;
1139 if (!frame_sp.get())
1141 err.SetErrorStringWithFormat("couldn't materialize register %s without a stack frame", m_register_info.name);
1145 lldb::RegisterContextSP reg_context_sp = frame_sp->GetRegisterContext();
1147 if (!reg_context_sp->ReadRegister(&m_register_info, reg_value))
1149 err.SetErrorStringWithFormat("couldn't read the value of register %s", m_register_info.name);
1153 DataExtractor register_data;
1155 if (!reg_value.GetData(register_data))
1157 err.SetErrorStringWithFormat("couldn't get the data for register %s", m_register_info.name);
1161 if (register_data.GetByteSize() != m_register_info.byte_size)
1163 err.SetErrorStringWithFormat("data for register %s had size %llu but we expected %llu", m_register_info.name, (unsigned long long)register_data.GetByteSize(), (unsigned long long)m_register_info.byte_size);
1167 m_register_contents.reset(new DataBufferHeap(register_data.GetDataStart(), register_data.GetByteSize()));
1171 map.WriteMemory(load_addr, register_data.GetDataStart(), register_data.GetByteSize(), write_error);
1173 if (!write_error.Success())
1175 err.SetErrorStringWithFormat("couldn't write the contents of register %s: %s", m_register_info.name, write_error.AsCString());
1180 void Dematerialize (lldb::StackFrameSP &frame_sp,
1182 lldb::addr_t process_address,
1183 lldb::addr_t frame_top,
1184 lldb::addr_t frame_bottom,
1187 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
1189 const lldb::addr_t load_addr = process_address + m_offset;
1193 log->Printf("EntityRegister::Dematerialize [address = 0x%" PRIx64 ", m_register_info = %s]",
1194 (uint64_t)load_addr,
1195 m_register_info.name);
1198 Error extract_error;
1200 DataExtractor register_data;
1202 if (!frame_sp.get())
1204 err.SetErrorStringWithFormat("couldn't dematerialize register %s without a stack frame", m_register_info.name);
1208 lldb::RegisterContextSP reg_context_sp = frame_sp->GetRegisterContext();
1210 map.GetMemoryData(register_data, load_addr, m_register_info.byte_size, extract_error);
1212 if (!extract_error.Success())
1214 err.SetErrorStringWithFormat("couldn't get the data for register %s: %s", m_register_info.name, extract_error.AsCString());
1218 if (!memcmp(register_data.GetDataStart(), m_register_contents->GetBytes(), register_data.GetByteSize()))
1220 // No write required, and in particular we avoid errors if the register wasn't writable
1222 m_register_contents.reset();
1226 m_register_contents.reset();
1228 RegisterValue register_value (const_cast<uint8_t*>(register_data.GetDataStart()), register_data.GetByteSize(), register_data.GetByteOrder());
1230 if (!reg_context_sp->WriteRegister(&m_register_info, register_value))
1232 err.SetErrorStringWithFormat("couldn't write the value of register %s", m_register_info.name);
1237 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
1239 StreamString dump_stream;
1243 const lldb::addr_t load_addr = process_address + m_offset;
1246 dump_stream.Printf("0x%" PRIx64 ": EntityRegister (%s)\n", load_addr, m_register_info.name);
1249 dump_stream.Printf("Value:\n");
1251 DataBufferHeap data (m_size, 0);
1253 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
1257 dump_stream.Printf(" <could not be read>\n");
1261 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
1263 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
1265 dump_stream.PutChar('\n');
1269 log->PutCString(dump_stream.GetData());
1272 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
1276 RegisterInfo m_register_info;
1277 lldb::DataBufferSP m_register_contents;
1281 Materializer::AddRegister (const RegisterInfo ®ister_info, Error &err)
1283 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
1284 iter->reset (new EntityRegister (register_info));
1285 uint32_t ret = AddStructMember(**iter);
1286 (*iter)->SetOffset(ret);
1290 Materializer::Materializer () :
1291 m_dematerializer_wp(),
1292 m_result_entity(NULL),
1293 m_current_offset(0),
1294 m_struct_alignment(8)
1298 Materializer::~Materializer ()
1300 DematerializerSP dematerializer_sp = m_dematerializer_wp.lock();
1302 if (dematerializer_sp)
1303 dematerializer_sp->Wipe();
1306 Materializer::DematerializerSP
1307 Materializer::Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &error)
1309 ExecutionContextScope *exe_scope = frame_sp.get();
1312 exe_scope = map.GetBestExecutionContextScope();
1314 DematerializerSP dematerializer_sp = m_dematerializer_wp.lock();
1316 if (dematerializer_sp)
1318 error.SetErrorToGenericError();
1319 error.SetErrorString("Couldn't materialize: already materialized");
1322 DematerializerSP ret(new Dematerializer(*this, frame_sp, map, process_address));
1326 error.SetErrorToGenericError();
1327 error.SetErrorString("Couldn't materialize: target doesn't exist");
1330 for (EntityUP &entity_up : m_entities)
1332 entity_up->Materialize(frame_sp, map, process_address, error);
1334 if (!error.Success())
1335 return DematerializerSP();
1338 if (Log *log = lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS))
1340 log->Printf("Materializer::Materialize (frame_sp = %p, process_address = 0x%" PRIx64 ") materialized:", frame_sp.get(), process_address);
1341 for (EntityUP &entity_up : m_entities)
1342 entity_up->DumpToLog(map, process_address, log);
1345 m_dematerializer_wp = ret;
1351 Materializer::Dematerializer::Dematerialize (Error &error, lldb::ClangExpressionVariableSP &result_sp, lldb::addr_t frame_bottom, lldb::addr_t frame_top)
1353 lldb::StackFrameSP frame_sp;
1355 lldb::ThreadSP thread_sp = m_thread_wp.lock();
1357 frame_sp = thread_sp->GetFrameWithStackID(m_stack_id);
1359 ExecutionContextScope *exe_scope = m_map->GetBestExecutionContextScope();
1363 error.SetErrorToGenericError();
1364 error.SetErrorString("Couldn't dematerialize: invalid dematerializer");
1369 error.SetErrorToGenericError();
1370 error.SetErrorString("Couldn't dematerialize: target is gone");
1374 if (Log *log =lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS))
1376 log->Printf("Materializer::Dematerialize (frame_sp = %p, process_address = 0x%" PRIx64 ") about to dematerialize:", frame_sp.get(), m_process_address);
1377 for (EntityUP &entity_up : m_materializer->m_entities)
1378 entity_up->DumpToLog(*m_map, m_process_address, log);
1381 for (EntityUP &entity_up : m_materializer->m_entities)
1383 if (entity_up.get() == m_materializer->m_result_entity)
1385 static_cast<EntityResultVariable*>(m_materializer->m_result_entity)->Dematerialize (result_sp, frame_sp, *m_map, m_process_address, frame_top, frame_bottom, error);
1389 entity_up->Dematerialize (frame_sp, *m_map, m_process_address, frame_top, frame_bottom, error);
1392 if (!error.Success())
1401 Materializer::Dematerializer::Wipe ()
1406 for (EntityUP &entity_up : m_materializer->m_entities)
1408 entity_up->Wipe (*m_map, m_process_address);
1411 m_materializer = NULL;
1413 m_process_address = LLDB_INVALID_ADDRESS;