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 lldb::addr_t addr_of_valobj = valobj_sp->GetAddressOf();
465 if (addr_of_valobj != LLDB_INVALID_ADDRESS)
468 map.WritePointerToMemory(load_addr, addr_of_valobj, write_error);
470 if (!write_error.Success())
472 err.SetErrorStringWithFormat("couldn't write the address of variable %s to memory: %s", m_variable_sp->GetName().AsCString(), write_error.AsCString());
479 valobj_sp->GetData(data);
481 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
483 err.SetErrorStringWithFormat("trying to create a temporary region for %s but one exists", m_variable_sp->GetName().AsCString());
487 if (data.GetByteSize() != m_variable_sp->GetType()->GetByteSize())
489 if (data.GetByteSize() == 0 && m_variable_sp->LocationExpression().IsValid() == false)
491 err.SetErrorStringWithFormat("the variable '%s' has no location, it may have been optimized out", m_variable_sp->GetName().AsCString());
495 err.SetErrorStringWithFormat("size of variable %s disagrees with the ValueObject's size", m_variable_sp->GetName().AsCString());
500 size_t bit_align = m_variable_sp->GetType()->GetClangLayoutType().GetTypeBitAlign();
501 size_t byte_align = (bit_align + 7) / 8;
505 m_temporary_allocation = map.Malloc(data.GetByteSize(), byte_align, lldb::ePermissionsReadable | lldb::ePermissionsWritable, IRMemoryMap::eAllocationPolicyMirror, alloc_error);
506 m_temporary_allocation_size = data.GetByteSize();
508 if (!alloc_error.Success())
510 err.SetErrorStringWithFormat("couldn't allocate a temporary region for %s: %s", m_variable_sp->GetName().AsCString(), alloc_error.AsCString());
516 map.WriteMemory(m_temporary_allocation, data.GetDataStart(), data.GetByteSize(), write_error);
518 if (!write_error.Success())
520 err.SetErrorStringWithFormat("couldn't write to the temporary region for %s: %s", m_variable_sp->GetName().AsCString(), write_error.AsCString());
524 Error pointer_write_error;
526 map.WritePointerToMemory(load_addr, m_temporary_allocation, pointer_write_error);
528 if (!pointer_write_error.Success())
530 err.SetErrorStringWithFormat("couldn't write the address of the temporary region for %s: %s", m_variable_sp->GetName().AsCString(), pointer_write_error.AsCString());
536 void Dematerialize (lldb::StackFrameSP &frame_sp,
538 lldb::addr_t process_address,
539 lldb::addr_t frame_top,
540 lldb::addr_t frame_bottom,
543 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
545 const lldb::addr_t load_addr = process_address + m_offset;
548 log->Printf("EntityVariable::Dematerialize [address = 0x%" PRIx64 ", m_variable_sp = %s]",
550 m_variable_sp->GetName().AsCString());
553 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
555 ExecutionContextScope *scope = frame_sp.get();
558 scope = map.GetBestExecutionContextScope();
560 lldb::ValueObjectSP valobj_sp = ValueObjectVariable::Create(scope, m_variable_sp);
564 err.SetErrorStringWithFormat("couldn't get a value object for variable %s", m_variable_sp->GetName().AsCString());
568 lldb_private::DataExtractor data;
572 map.GetMemoryData(data, m_temporary_allocation, valobj_sp->GetByteSize(), extract_error);
574 if (!extract_error.Success())
576 err.SetErrorStringWithFormat("couldn't get the data for variable %s", m_variable_sp->GetName().AsCString());
582 valobj_sp->SetData(data, set_error);
584 if (!set_error.Success())
586 err.SetErrorStringWithFormat("couldn't write the new contents of %s back into the variable", m_variable_sp->GetName().AsCString());
592 map.Free(m_temporary_allocation, free_error);
594 if (!free_error.Success())
596 err.SetErrorStringWithFormat("couldn't free the temporary region for %s: %s", m_variable_sp->GetName().AsCString(), free_error.AsCString());
600 m_temporary_allocation = LLDB_INVALID_ADDRESS;
601 m_temporary_allocation_size = 0;
605 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
607 StreamString dump_stream;
609 const lldb::addr_t load_addr = process_address + m_offset;
610 dump_stream.Printf("0x%" PRIx64 ": EntityVariable\n", load_addr);
614 lldb::addr_t ptr = LLDB_INVALID_ADDRESS;
617 dump_stream.Printf("Pointer:\n");
619 DataBufferHeap data (m_size, 0);
621 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
625 dump_stream.Printf(" <could not be read>\n");
629 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
631 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
633 lldb::offset_t offset;
635 ptr = extractor.GetPointer(&offset);
637 dump_stream.PutChar('\n');
641 if (m_temporary_allocation == LLDB_INVALID_ADDRESS)
643 dump_stream.Printf("Points to process memory:\n");
647 dump_stream.Printf("Temporary allocation:\n");
650 if (ptr == LLDB_INVALID_ADDRESS)
652 dump_stream.Printf(" <could not be be found>\n");
656 DataBufferHeap data (m_temporary_allocation_size, 0);
658 map.ReadMemory(data.GetBytes(), m_temporary_allocation, m_temporary_allocation_size, err);
662 dump_stream.Printf(" <could not be read>\n");
666 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
668 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
670 dump_stream.PutChar('\n');
674 log->PutCString(dump_stream.GetData());
677 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
679 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
683 map.Free(m_temporary_allocation, free_error);
685 m_temporary_allocation = LLDB_INVALID_ADDRESS;
686 m_temporary_allocation_size = 0;
691 lldb::VariableSP m_variable_sp;
693 lldb::addr_t m_temporary_allocation;
694 size_t m_temporary_allocation_size;
698 Materializer::AddVariable (lldb::VariableSP &variable_sp, Error &err)
700 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
701 iter->reset (new EntityVariable (variable_sp));
702 uint32_t ret = AddStructMember(**iter);
703 (*iter)->SetOffset(ret);
707 class EntityResultVariable : public Materializer::Entity
710 EntityResultVariable (const TypeFromUser &type, bool is_program_reference, bool keep_in_memory) :
713 m_is_program_reference(is_program_reference),
714 m_keep_in_memory(keep_in_memory),
715 m_temporary_allocation(LLDB_INVALID_ADDRESS),
716 m_temporary_allocation_size(0)
718 // Hard-coding to maximum size of a pointer since all results are materialized by reference
723 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
725 if (!m_is_program_reference)
727 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
729 err.SetErrorString("Trying to create a temporary region for the result but one exists");
733 const lldb::addr_t load_addr = process_address + m_offset;
735 size_t byte_size = m_type.GetByteSize();
736 size_t bit_align = m_type.GetTypeBitAlign();
737 size_t byte_align = (bit_align + 7) / 8;
741 m_temporary_allocation = map.Malloc(byte_size, byte_align, lldb::ePermissionsReadable | lldb::ePermissionsWritable, IRMemoryMap::eAllocationPolicyMirror, alloc_error);
742 m_temporary_allocation_size = byte_size;
744 if (!alloc_error.Success())
746 err.SetErrorStringWithFormat("couldn't allocate a temporary region for the result: %s", alloc_error.AsCString());
750 Error pointer_write_error;
752 map.WritePointerToMemory(load_addr, m_temporary_allocation, pointer_write_error);
754 if (!pointer_write_error.Success())
756 err.SetErrorStringWithFormat("couldn't write the address of the temporary region for the result: %s", pointer_write_error.AsCString());
761 void Dematerialize (lldb::StackFrameSP &frame_sp,
763 lldb::addr_t process_address,
764 lldb::addr_t frame_top,
765 lldb::addr_t frame_bottom,
768 err.SetErrorString("Tried to detmaterialize a result variable with the normal Dematerialize method");
771 void Dematerialize (lldb::ClangExpressionVariableSP &result_variable_sp,
772 lldb::StackFrameSP &frame_sp,
774 lldb::addr_t process_address,
775 lldb::addr_t frame_top,
776 lldb::addr_t frame_bottom,
781 ExecutionContextScope *exe_scope = map.GetBestExecutionContextScope();
785 err.SetErrorString("Couldn't dematerialize a result variable: invalid execution context scope");
789 lldb::addr_t address;
791 const lldb::addr_t load_addr = process_address + m_offset;
793 map.ReadPointerFromMemory (&address, load_addr, read_error);
795 if (!read_error.Success())
797 err.SetErrorString("Couldn't dematerialize a result variable: couldn't read its address");
801 lldb::TargetSP target_sp = exe_scope->CalculateTarget();
805 err.SetErrorString("Couldn't dematerialize a result variable: no target");
809 ConstString name = target_sp->GetPersistentVariables().GetNextPersistentVariableName();
811 lldb::ClangExpressionVariableSP ret;
813 ret = target_sp->GetPersistentVariables().CreateVariable(exe_scope,
817 map.GetAddressByteSize());
821 err.SetErrorStringWithFormat("couldn't dematerialize a result variable: failed to make persistent variable %s", name.AsCString());
825 lldb::ProcessSP process_sp = map.GetBestExecutionContextScope()->CalculateProcess();
827 bool can_persist = (m_is_program_reference && process_sp && process_sp->CanJIT() && !(address >= frame_bottom && address < frame_top));
829 if (can_persist && m_keep_in_memory)
831 ret->m_live_sp = ValueObjectConstResult::Create(exe_scope,
836 map.GetAddressByteSize());
841 const size_t pvar_byte_size = ret->GetByteSize();
842 uint8_t *pvar_data = ret->GetValueBytes();
844 map.ReadMemory(pvar_data, address, pvar_byte_size, read_error);
846 if (!read_error.Success())
848 err.SetErrorString("Couldn't dematerialize a result variable: couldn't read its memory");
852 result_variable_sp = ret;
854 if (!can_persist || !m_keep_in_memory)
856 ret->m_flags |= ClangExpressionVariable::EVNeedsAllocation;
858 if (m_temporary_allocation != LLDB_INVALID_ADDRESS)
861 map.Free(m_temporary_allocation, free_error);
866 ret->m_flags |= ClangExpressionVariable::EVIsLLDBAllocated;
869 m_temporary_allocation = LLDB_INVALID_ADDRESS;
870 m_temporary_allocation_size = 0;
873 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
875 StreamString dump_stream;
877 const lldb::addr_t load_addr = process_address + m_offset;
879 dump_stream.Printf("0x%" PRIx64 ": EntityResultVariable\n", load_addr);
883 lldb::addr_t ptr = LLDB_INVALID_ADDRESS;
886 dump_stream.Printf("Pointer:\n");
888 DataBufferHeap data (m_size, 0);
890 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
894 dump_stream.Printf(" <could not be read>\n");
898 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
900 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
902 lldb::offset_t offset;
904 ptr = extractor.GetPointer(&offset);
906 dump_stream.PutChar('\n');
910 if (m_temporary_allocation == LLDB_INVALID_ADDRESS)
912 dump_stream.Printf("Points to process memory:\n");
916 dump_stream.Printf("Temporary allocation:\n");
919 if (ptr == LLDB_INVALID_ADDRESS)
921 dump_stream.Printf(" <could not be be found>\n");
925 DataBufferHeap data (m_temporary_allocation_size, 0);
927 map.ReadMemory(data.GetBytes(), m_temporary_allocation, m_temporary_allocation_size, err);
931 dump_stream.Printf(" <could not be read>\n");
935 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
937 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
939 dump_stream.PutChar('\n');
943 log->PutCString(dump_stream.GetData());
946 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
948 if (!m_keep_in_memory && m_temporary_allocation != LLDB_INVALID_ADDRESS)
952 map.Free(m_temporary_allocation, free_error);
955 m_temporary_allocation = LLDB_INVALID_ADDRESS;
956 m_temporary_allocation_size = 0;
960 bool m_is_program_reference;
961 bool m_keep_in_memory;
963 lldb::addr_t m_temporary_allocation;
964 size_t m_temporary_allocation_size;
968 Materializer::AddResultVariable (const TypeFromUser &type, bool is_program_reference, bool keep_in_memory, Error &err)
970 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
971 iter->reset (new EntityResultVariable (type, is_program_reference, keep_in_memory));
972 uint32_t ret = AddStructMember(**iter);
973 (*iter)->SetOffset(ret);
974 m_result_entity = iter->get();
978 class EntitySymbol : public Materializer::Entity
981 EntitySymbol (const Symbol &symbol) :
985 // Hard-coding to maximum size of a symbol
990 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
992 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
994 const lldb::addr_t load_addr = process_address + m_offset;
998 log->Printf("EntitySymbol::Materialize [address = 0x%" PRIx64 ", m_symbol = %s]",
1000 m_symbol.GetName().AsCString());
1003 Address &sym_address = m_symbol.GetAddress();
1005 ExecutionContextScope *exe_scope = map.GetBestExecutionContextScope();
1007 lldb::TargetSP target_sp;
1010 target_sp = map.GetBestExecutionContextScope()->CalculateTarget();
1014 err.SetErrorStringWithFormat("couldn't resolve symbol %s because there is no target", m_symbol.GetName().AsCString());
1018 lldb::addr_t resolved_address = sym_address.GetLoadAddress(target_sp.get());
1020 if (resolved_address == LLDB_INVALID_ADDRESS)
1021 resolved_address = sym_address.GetFileAddress();
1023 Error pointer_write_error;
1025 map.WritePointerToMemory(load_addr, resolved_address, pointer_write_error);
1027 if (!pointer_write_error.Success())
1029 err.SetErrorStringWithFormat("couldn't write the address of symbol %s: %s", m_symbol.GetName().AsCString(), pointer_write_error.AsCString());
1034 void Dematerialize (lldb::StackFrameSP &frame_sp,
1036 lldb::addr_t process_address,
1037 lldb::addr_t frame_top,
1038 lldb::addr_t frame_bottom,
1041 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
1043 const lldb::addr_t load_addr = process_address + m_offset;
1047 log->Printf("EntitySymbol::Dematerialize [address = 0x%" PRIx64 ", m_symbol = %s]",
1048 (uint64_t)load_addr,
1049 m_symbol.GetName().AsCString());
1052 // no work needs to be done
1055 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
1057 StreamString dump_stream;
1061 const lldb::addr_t load_addr = process_address + m_offset;
1063 dump_stream.Printf("0x%" PRIx64 ": EntitySymbol (%s)\n", load_addr, m_symbol.GetName().AsCString());
1066 dump_stream.Printf("Pointer:\n");
1068 DataBufferHeap data (m_size, 0);
1070 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
1074 dump_stream.Printf(" <could not be read>\n");
1078 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
1080 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
1082 dump_stream.PutChar('\n');
1086 log->PutCString(dump_stream.GetData());
1089 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
1097 Materializer::AddSymbol (const Symbol &symbol_sp, Error &err)
1099 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
1100 iter->reset (new EntitySymbol (symbol_sp));
1101 uint32_t ret = AddStructMember(**iter);
1102 (*iter)->SetOffset(ret);
1106 class EntityRegister : public Materializer::Entity
1109 EntityRegister (const RegisterInfo ®ister_info) :
1111 m_register_info(register_info)
1113 // Hard-coding alignment conservatively
1114 m_size = m_register_info.byte_size;
1115 m_alignment = m_register_info.byte_size;
1118 void Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &err)
1120 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
1122 const lldb::addr_t load_addr = process_address + m_offset;
1126 log->Printf("EntityRegister::Materialize [address = 0x%" PRIx64 ", m_register_info = %s]",
1127 (uint64_t)load_addr,
1128 m_register_info.name);
1131 RegisterValue reg_value;
1133 if (!frame_sp.get())
1135 err.SetErrorStringWithFormat("couldn't materialize register %s without a stack frame", m_register_info.name);
1139 lldb::RegisterContextSP reg_context_sp = frame_sp->GetRegisterContext();
1141 if (!reg_context_sp->ReadRegister(&m_register_info, reg_value))
1143 err.SetErrorStringWithFormat("couldn't read the value of register %s", m_register_info.name);
1147 DataExtractor register_data;
1149 if (!reg_value.GetData(register_data))
1151 err.SetErrorStringWithFormat("couldn't get the data for register %s", m_register_info.name);
1155 if (register_data.GetByteSize() != m_register_info.byte_size)
1157 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);
1161 m_register_contents.reset(new DataBufferHeap(register_data.GetDataStart(), register_data.GetByteSize()));
1165 map.WriteMemory(load_addr, register_data.GetDataStart(), register_data.GetByteSize(), write_error);
1167 if (!write_error.Success())
1169 err.SetErrorStringWithFormat("couldn't write the contents of register %s: %s", m_register_info.name, write_error.AsCString());
1174 void Dematerialize (lldb::StackFrameSP &frame_sp,
1176 lldb::addr_t process_address,
1177 lldb::addr_t frame_top,
1178 lldb::addr_t frame_bottom,
1181 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
1183 const lldb::addr_t load_addr = process_address + m_offset;
1187 log->Printf("EntityRegister::Dematerialize [address = 0x%" PRIx64 ", m_register_info = %s]",
1188 (uint64_t)load_addr,
1189 m_register_info.name);
1192 Error extract_error;
1194 DataExtractor register_data;
1196 if (!frame_sp.get())
1198 err.SetErrorStringWithFormat("couldn't dematerialize register %s without a stack frame", m_register_info.name);
1202 lldb::RegisterContextSP reg_context_sp = frame_sp->GetRegisterContext();
1204 map.GetMemoryData(register_data, load_addr, m_register_info.byte_size, extract_error);
1206 if (!extract_error.Success())
1208 err.SetErrorStringWithFormat("couldn't get the data for register %s: %s", m_register_info.name, extract_error.AsCString());
1212 if (!memcmp(register_data.GetDataStart(), m_register_contents->GetBytes(), register_data.GetByteSize()))
1214 // No write required, and in particular we avoid errors if the register wasn't writable
1216 m_register_contents.reset();
1220 m_register_contents.reset();
1222 RegisterValue register_value (const_cast<uint8_t*>(register_data.GetDataStart()), register_data.GetByteSize(), register_data.GetByteOrder());
1224 if (!reg_context_sp->WriteRegister(&m_register_info, register_value))
1226 err.SetErrorStringWithFormat("couldn't write the value of register %s", m_register_info.name);
1231 void DumpToLog (IRMemoryMap &map, lldb::addr_t process_address, Log *log)
1233 StreamString dump_stream;
1237 const lldb::addr_t load_addr = process_address + m_offset;
1240 dump_stream.Printf("0x%" PRIx64 ": EntityRegister (%s)\n", load_addr, m_register_info.name);
1243 dump_stream.Printf("Value:\n");
1245 DataBufferHeap data (m_size, 0);
1247 map.ReadMemory(data.GetBytes(), load_addr, m_size, err);
1251 dump_stream.Printf(" <could not be read>\n");
1255 DataExtractor extractor (data.GetBytes(), data.GetByteSize(), map.GetByteOrder(), map.GetAddressByteSize());
1257 extractor.DumpHexBytes(&dump_stream, data.GetBytes(), data.GetByteSize(), 16, load_addr);
1259 dump_stream.PutChar('\n');
1263 log->PutCString(dump_stream.GetData());
1266 void Wipe (IRMemoryMap &map, lldb::addr_t process_address)
1270 RegisterInfo m_register_info;
1271 lldb::DataBufferSP m_register_contents;
1275 Materializer::AddRegister (const RegisterInfo ®ister_info, Error &err)
1277 EntityVector::iterator iter = m_entities.insert(m_entities.end(), EntityUP());
1278 iter->reset (new EntityRegister (register_info));
1279 uint32_t ret = AddStructMember(**iter);
1280 (*iter)->SetOffset(ret);
1284 Materializer::Materializer () :
1285 m_dematerializer_wp(),
1286 m_result_entity(NULL),
1287 m_current_offset(0),
1288 m_struct_alignment(8)
1292 Materializer::~Materializer ()
1294 DematerializerSP dematerializer_sp = m_dematerializer_wp.lock();
1296 if (dematerializer_sp)
1297 dematerializer_sp->Wipe();
1300 Materializer::DematerializerSP
1301 Materializer::Materialize (lldb::StackFrameSP &frame_sp, IRMemoryMap &map, lldb::addr_t process_address, Error &error)
1303 ExecutionContextScope *exe_scope = frame_sp.get();
1306 exe_scope = map.GetBestExecutionContextScope();
1308 DematerializerSP dematerializer_sp = m_dematerializer_wp.lock();
1310 if (dematerializer_sp)
1312 error.SetErrorToGenericError();
1313 error.SetErrorString("Couldn't materialize: already materialized");
1316 DematerializerSP ret(new Dematerializer(*this, frame_sp, map, process_address));
1320 error.SetErrorToGenericError();
1321 error.SetErrorString("Couldn't materialize: target doesn't exist");
1324 for (EntityUP &entity_up : m_entities)
1326 entity_up->Materialize(frame_sp, map, process_address, error);
1328 if (!error.Success())
1329 return DematerializerSP();
1332 if (Log *log = lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS))
1334 log->Printf("Materializer::Materialize (frame_sp = %p, process_address = 0x%" PRIx64 ") materialized:", frame_sp.get(), process_address);
1335 for (EntityUP &entity_up : m_entities)
1336 entity_up->DumpToLog(map, process_address, log);
1339 m_dematerializer_wp = ret;
1345 Materializer::Dematerializer::Dematerialize (Error &error, lldb::ClangExpressionVariableSP &result_sp, lldb::addr_t frame_bottom, lldb::addr_t frame_top)
1347 lldb::StackFrameSP frame_sp;
1349 lldb::ThreadSP thread_sp = m_thread_wp.lock();
1351 frame_sp = thread_sp->GetFrameWithStackID(m_stack_id);
1353 ExecutionContextScope *exe_scope = m_map->GetBestExecutionContextScope();
1357 error.SetErrorToGenericError();
1358 error.SetErrorString("Couldn't dematerialize: invalid dematerializer");
1363 error.SetErrorToGenericError();
1364 error.SetErrorString("Couldn't dematerialize: target is gone");
1368 if (Log *log =lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS))
1370 log->Printf("Materializer::Dematerialize (frame_sp = %p, process_address = 0x%" PRIx64 ") about to dematerialize:", frame_sp.get(), m_process_address);
1371 for (EntityUP &entity_up : m_materializer->m_entities)
1372 entity_up->DumpToLog(*m_map, m_process_address, log);
1375 for (EntityUP &entity_up : m_materializer->m_entities)
1377 if (entity_up.get() == m_materializer->m_result_entity)
1379 static_cast<EntityResultVariable*>(m_materializer->m_result_entity)->Dematerialize (result_sp, frame_sp, *m_map, m_process_address, frame_top, frame_bottom, error);
1383 entity_up->Dematerialize (frame_sp, *m_map, m_process_address, frame_top, frame_bottom, error);
1386 if (!error.Success())
1395 Materializer::Dematerializer::Wipe ()
1400 for (EntityUP &entity_up : m_materializer->m_entities)
1402 entity_up->Wipe (*m_map, m_process_address);
1405 m_materializer = NULL;
1407 m_process_address = LLDB_INVALID_ADDRESS;