xref: /freebsd/contrib/llvm-project/lldb/source/Expression/IRMemoryMap.cpp (revision 700637cbb5e582861067a11aaca4d053546871d2)
1 //===-- IRMemoryMap.cpp ---------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Expression/IRMemoryMap.h"
10 #include "lldb/Target/MemoryRegionInfo.h"
11 #include "lldb/Target/Process.h"
12 #include "lldb/Target/Target.h"
13 #include "lldb/Utility/DataBufferHeap.h"
14 #include "lldb/Utility/DataExtractor.h"
15 #include "lldb/Utility/LLDBAssert.h"
16 #include "lldb/Utility/LLDBLog.h"
17 #include "lldb/Utility/Log.h"
18 #include "lldb/Utility/Scalar.h"
19 #include "lldb/Utility/Status.h"
20 
21 using namespace lldb_private;
22 
IRMemoryMap(lldb::TargetSP target_sp)23 IRMemoryMap::IRMemoryMap(lldb::TargetSP target_sp) : m_target_wp(target_sp) {
24   if (target_sp)
25     m_process_wp = target_sp->GetProcessSP();
26 }
27 
~IRMemoryMap()28 IRMemoryMap::~IRMemoryMap() {
29   lldb::ProcessSP process_sp = m_process_wp.lock();
30 
31   if (process_sp) {
32     AllocationMap::iterator iter;
33 
34     Status err;
35 
36     while ((iter = m_allocations.begin()) != m_allocations.end()) {
37       err.Clear();
38       if (iter->second.m_leak)
39         m_allocations.erase(iter);
40       else
41         Free(iter->first, err);
42     }
43   }
44 }
45 
FindSpace(size_t size)46 lldb::addr_t IRMemoryMap::FindSpace(size_t size) {
47   // The FindSpace algorithm's job is to find a region of memory that the
48   // underlying process is unlikely to be using.
49   //
50   // The memory returned by this function will never be written to.  The only
51   // point is that it should not shadow process memory if possible, so that
52   // expressions processing real values from the process do not use the wrong
53   // data.
54   //
55   // If the process can in fact allocate memory (CanJIT() lets us know this)
56   // then this can be accomplished just be allocating memory in the inferior.
57   // Then no guessing is required.
58 
59   lldb::TargetSP target_sp = m_target_wp.lock();
60   lldb::ProcessSP process_sp = m_process_wp.lock();
61 
62   const bool process_is_alive = process_sp && process_sp->IsAlive();
63 
64   lldb::addr_t ret = LLDB_INVALID_ADDRESS;
65   if (size == 0)
66     return ret;
67 
68   if (process_is_alive && process_sp->CanJIT()) {
69     Status alloc_error;
70 
71     ret = process_sp->AllocateMemory(size, lldb::ePermissionsReadable |
72                                                lldb::ePermissionsWritable,
73                                      alloc_error);
74 
75     if (!alloc_error.Success())
76       return LLDB_INVALID_ADDRESS;
77     else
78       return ret;
79   }
80 
81   // At this point we know that we need to hunt.
82   //
83   // First, go to the end of the existing allocations we've made if there are
84   // any allocations.  Otherwise start at the beginning of memory.
85 
86   if (m_allocations.empty()) {
87     ret = 0;
88   } else {
89     auto back = m_allocations.rbegin();
90     lldb::addr_t addr = back->first;
91     size_t alloc_size = back->second.m_size;
92     ret = llvm::alignTo(addr + alloc_size, 4096);
93   }
94 
95   uint64_t end_of_memory;
96   switch (GetAddressByteSize()) {
97   case 2:
98     end_of_memory = 0xffffull;
99     break;
100   case 4:
101     end_of_memory = 0xffffffffull;
102     break;
103   case 8:
104     end_of_memory = 0xffffffffffffffffull;
105     break;
106   default:
107     lldbassert(false && "Invalid address size.");
108     return LLDB_INVALID_ADDRESS;
109   }
110 
111   // Now, if it's possible to use the GetMemoryRegionInfo API to detect mapped
112   // regions, walk forward through memory until a region is found that has
113   // adequate space for our allocation.
114   if (process_is_alive) {
115     MemoryRegionInfo region_info;
116     Status err = process_sp->GetMemoryRegionInfo(ret, region_info);
117     if (err.Success()) {
118       while (true) {
119         if (region_info.GetRange().GetRangeBase() == 0 &&
120             region_info.GetRange().GetRangeEnd() < end_of_memory) {
121           // Don't use a region that starts at address 0,
122           // it can make it harder to debug null dereference crashes
123           // in the inferior.
124           ret = region_info.GetRange().GetRangeEnd();
125         } else if (region_info.GetReadable() !=
126                        MemoryRegionInfo::OptionalBool::eNo ||
127                    region_info.GetWritable() !=
128                        MemoryRegionInfo::OptionalBool::eNo ||
129                    region_info.GetExecutable() !=
130                        MemoryRegionInfo::OptionalBool::eNo) {
131           if (region_info.GetRange().GetRangeEnd() - 1 >= end_of_memory) {
132             ret = LLDB_INVALID_ADDRESS;
133             break;
134           } else {
135             ret = region_info.GetRange().GetRangeEnd();
136           }
137         } else if (ret + size < region_info.GetRange().GetRangeEnd()) {
138           return ret;
139         } else {
140           // ret stays the same.  We just need to walk a bit further.
141         }
142 
143         err = process_sp->GetMemoryRegionInfo(
144             region_info.GetRange().GetRangeEnd(), region_info);
145         if (err.Fail()) {
146           lldbassert(0 && "GetMemoryRegionInfo() succeeded, then failed");
147           ret = LLDB_INVALID_ADDRESS;
148           break;
149         }
150       }
151     }
152   }
153 
154   // We've tried our algorithm, and it didn't work.  Now we have to reset back
155   // to the end of the allocations we've already reported, or use a 'sensible'
156   // default if this is our first allocation.
157   if (m_allocations.empty()) {
158     uint64_t alloc_address = target_sp->GetExprAllocAddress();
159     if (alloc_address > 0) {
160       if (alloc_address >= end_of_memory) {
161         lldbassert(0 && "The allocation address for expression evaluation must "
162                         "be within process address space");
163         return LLDB_INVALID_ADDRESS;
164       }
165       ret = alloc_address;
166     } else {
167       uint32_t address_byte_size = GetAddressByteSize();
168       if (address_byte_size != UINT32_MAX) {
169         switch (address_byte_size) {
170         case 2:
171           ret = 0x8000ull;
172           break;
173         case 4:
174           ret = 0xee000000ull;
175           break;
176         case 8:
177           ret = 0xdead0fff00000000ull;
178           break;
179         default:
180           lldbassert(false && "Invalid address size.");
181           return LLDB_INVALID_ADDRESS;
182         }
183       }
184     }
185   } else {
186     auto back = m_allocations.rbegin();
187     lldb::addr_t addr = back->first;
188     size_t alloc_size = back->second.m_size;
189     uint64_t align = target_sp->GetExprAllocAlign();
190     if (align == 0)
191       align = 4096;
192     ret = llvm::alignTo(addr + alloc_size, align);
193   }
194 
195   return ret;
196 }
197 
198 IRMemoryMap::AllocationMap::iterator
FindAllocation(lldb::addr_t addr,size_t size)199 IRMemoryMap::FindAllocation(lldb::addr_t addr, size_t size) {
200   if (addr == LLDB_INVALID_ADDRESS)
201     return m_allocations.end();
202 
203   AllocationMap::iterator iter = m_allocations.lower_bound(addr);
204 
205   if (iter == m_allocations.end() || iter->first > addr) {
206     if (iter == m_allocations.begin())
207       return m_allocations.end();
208     iter--;
209   }
210 
211   if (iter->first <= addr && iter->first + iter->second.m_size >= addr + size)
212     return iter;
213 
214   return m_allocations.end();
215 }
216 
IntersectsAllocation(lldb::addr_t addr,size_t size) const217 bool IRMemoryMap::IntersectsAllocation(lldb::addr_t addr, size_t size) const {
218   if (addr == LLDB_INVALID_ADDRESS)
219     return false;
220 
221   AllocationMap::const_iterator iter = m_allocations.lower_bound(addr);
222 
223   // Since we only know that the returned interval begins at a location greater
224   // than or equal to where the given interval begins, it's possible that the
225   // given interval intersects either the returned interval or the previous
226   // interval.  Thus, we need to check both. Note that we only need to check
227   // these two intervals.  Since all intervals are disjoint it is not possible
228   // that an adjacent interval does not intersect, but a non-adjacent interval
229   // does intersect.
230   if (iter != m_allocations.end()) {
231     if (AllocationsIntersect(addr, size, iter->second.m_process_start,
232                              iter->second.m_size))
233       return true;
234   }
235 
236   if (iter != m_allocations.begin()) {
237     --iter;
238     if (AllocationsIntersect(addr, size, iter->second.m_process_start,
239                              iter->second.m_size))
240       return true;
241   }
242 
243   return false;
244 }
245 
AllocationsIntersect(lldb::addr_t addr1,size_t size1,lldb::addr_t addr2,size_t size2)246 bool IRMemoryMap::AllocationsIntersect(lldb::addr_t addr1, size_t size1,
247                                        lldb::addr_t addr2, size_t size2) {
248   // Given two half open intervals [A, B) and [X, Y), the only 6 permutations
249   // that satisfy A<B and X<Y are the following:
250   // A B X Y
251   // A X B Y  (intersects)
252   // A X Y B  (intersects)
253   // X A B Y  (intersects)
254   // X A Y B  (intersects)
255   // X Y A B
256   // The first is B <= X, and the last is Y <= A. So the condition is !(B <= X
257   // || Y <= A)), or (X < B && A < Y)
258   return (addr2 < (addr1 + size1)) && (addr1 < (addr2 + size2));
259 }
260 
GetByteOrder()261 lldb::ByteOrder IRMemoryMap::GetByteOrder() {
262   lldb::ProcessSP process_sp = m_process_wp.lock();
263 
264   if (process_sp)
265     return process_sp->GetByteOrder();
266 
267   lldb::TargetSP target_sp = m_target_wp.lock();
268 
269   if (target_sp)
270     return target_sp->GetArchitecture().GetByteOrder();
271 
272   return lldb::eByteOrderInvalid;
273 }
274 
GetAddressByteSize()275 uint32_t IRMemoryMap::GetAddressByteSize() {
276   lldb::ProcessSP process_sp = m_process_wp.lock();
277 
278   if (process_sp)
279     return process_sp->GetAddressByteSize();
280 
281   lldb::TargetSP target_sp = m_target_wp.lock();
282 
283   if (target_sp)
284     return target_sp->GetArchitecture().GetAddressByteSize();
285 
286   return UINT32_MAX;
287 }
288 
GetBestExecutionContextScope() const289 ExecutionContextScope *IRMemoryMap::GetBestExecutionContextScope() const {
290   lldb::ProcessSP process_sp = m_process_wp.lock();
291 
292   if (process_sp)
293     return process_sp.get();
294 
295   lldb::TargetSP target_sp = m_target_wp.lock();
296 
297   if (target_sp)
298     return target_sp.get();
299 
300   return nullptr;
301 }
302 
Allocation(lldb::addr_t process_alloc,lldb::addr_t process_start,size_t size,uint32_t permissions,uint8_t alignment,AllocationPolicy policy)303 IRMemoryMap::Allocation::Allocation(lldb::addr_t process_alloc,
304                                     lldb::addr_t process_start, size_t size,
305                                     uint32_t permissions, uint8_t alignment,
306                                     AllocationPolicy policy)
307     : m_process_alloc(process_alloc), m_process_start(process_start),
308       m_size(size), m_policy(policy), m_leak(false), m_permissions(permissions),
309       m_alignment(alignment) {
310   switch (policy) {
311   default:
312     llvm_unreachable("Invalid AllocationPolicy");
313   case eAllocationPolicyHostOnly:
314   case eAllocationPolicyMirror:
315     m_data.SetByteSize(size);
316     break;
317   case eAllocationPolicyProcessOnly:
318     break;
319   }
320 }
321 
322 llvm::Expected<lldb::addr_t>
Malloc(size_t size,uint8_t alignment,uint32_t permissions,AllocationPolicy policy,bool zero_memory,AllocationPolicy * used_policy)323 IRMemoryMap::Malloc(size_t size, uint8_t alignment, uint32_t permissions,
324                     AllocationPolicy policy, bool zero_memory,
325                     AllocationPolicy *used_policy) {
326   lldb_private::Log *log(GetLog(LLDBLog::Expressions));
327 
328   lldb::ProcessSP process_sp;
329   lldb::addr_t allocation_address = LLDB_INVALID_ADDRESS;
330   lldb::addr_t aligned_address = LLDB_INVALID_ADDRESS;
331 
332   size_t allocation_size;
333 
334   if (size == 0) {
335     // FIXME: Malloc(0) should either return an invalid address or assert, in
336     // order to cut down on unnecessary allocations.
337     allocation_size = alignment;
338   } else {
339     // Round up the requested size to an aligned value.
340     allocation_size = llvm::alignTo(size, alignment);
341 
342     // The process page cache does not see the requested alignment. We can't
343     // assume its result will be any more than 1-byte aligned. To work around
344     // this, request `alignment - 1` additional bytes.
345     allocation_size += alignment - 1;
346   }
347 
348   switch (policy) {
349   default:
350     return llvm::createStringError(
351         llvm::inconvertibleErrorCode(),
352         "Couldn't malloc: invalid allocation policy");
353   case eAllocationPolicyHostOnly:
354     allocation_address = FindSpace(allocation_size);
355     if (allocation_address == LLDB_INVALID_ADDRESS)
356       return llvm::createStringError(llvm::inconvertibleErrorCode(),
357                                      "Couldn't malloc: address space is full");
358     break;
359   case eAllocationPolicyMirror:
360     process_sp = m_process_wp.lock();
361     LLDB_LOGF(log,
362               "IRMemoryMap::%s process_sp=0x%" PRIxPTR
363               ", process_sp->CanJIT()=%s, process_sp->IsAlive()=%s",
364               __FUNCTION__, reinterpret_cast<uintptr_t>(process_sp.get()),
365               process_sp && process_sp->CanJIT() ? "true" : "false",
366               process_sp && process_sp->IsAlive() ? "true" : "false");
367     if (process_sp && process_sp->CanJIT() && process_sp->IsAlive()) {
368       Status error;
369       if (!zero_memory)
370         allocation_address =
371             process_sp->AllocateMemory(allocation_size, permissions, error);
372       else
373         allocation_address =
374             process_sp->CallocateMemory(allocation_size, permissions, error);
375 
376       if (!error.Success())
377         return error.takeError();
378     } else {
379       LLDB_LOGF(log,
380                 "IRMemoryMap::%s switching to eAllocationPolicyHostOnly "
381                 "due to failed condition (see previous expr log message)",
382                 __FUNCTION__);
383       policy = eAllocationPolicyHostOnly;
384       allocation_address = FindSpace(allocation_size);
385       if (allocation_address == LLDB_INVALID_ADDRESS)
386         return llvm::createStringError(
387             llvm::inconvertibleErrorCode(),
388             "Couldn't malloc: address space is full");
389     }
390     break;
391   case eAllocationPolicyProcessOnly:
392     process_sp = m_process_wp.lock();
393     if (process_sp) {
394       if (process_sp->CanJIT() && process_sp->IsAlive()) {
395         Status error;
396         if (!zero_memory)
397           allocation_address =
398               process_sp->AllocateMemory(allocation_size, permissions, error);
399         else
400           allocation_address =
401               process_sp->CallocateMemory(allocation_size, permissions, error);
402 
403         if (!error.Success())
404           return error.takeError();
405       } else {
406         return llvm::createStringError(
407             llvm::inconvertibleErrorCode(),
408             "Couldn't malloc: process doesn't support allocating memory");
409       }
410     } else {
411       return llvm::createStringError(llvm::inconvertibleErrorCode(),
412                                      "Couldn't malloc: process doesn't exist, "
413                                      "and this memory must be in the process");
414     }
415     break;
416   }
417 
418   lldb::addr_t mask = alignment - 1;
419   aligned_address = (allocation_address + mask) & (~mask);
420 
421   m_allocations.emplace(
422       std::piecewise_construct, std::forward_as_tuple(aligned_address),
423       std::forward_as_tuple(allocation_address, aligned_address,
424                             allocation_size, permissions, alignment, policy));
425 
426   if (zero_memory) {
427     Status write_error;
428     std::vector<uint8_t> zero_buf(size, 0);
429     WriteMemory(aligned_address, zero_buf.data(), size, write_error);
430   }
431 
432   if (log) {
433     const char *policy_string;
434 
435     switch (policy) {
436     default:
437       policy_string = "<invalid policy>";
438       break;
439     case eAllocationPolicyHostOnly:
440       policy_string = "eAllocationPolicyHostOnly";
441       break;
442     case eAllocationPolicyProcessOnly:
443       policy_string = "eAllocationPolicyProcessOnly";
444       break;
445     case eAllocationPolicyMirror:
446       policy_string = "eAllocationPolicyMirror";
447       break;
448     }
449 
450     LLDB_LOGF(log,
451               "IRMemoryMap::Malloc (%" PRIu64 ", 0x%" PRIx64 ", 0x%" PRIx64
452               ", %s) -> 0x%" PRIx64,
453               (uint64_t)allocation_size, (uint64_t)alignment,
454               (uint64_t)permissions, policy_string, aligned_address);
455   }
456 
457   if (used_policy)
458     *used_policy = policy;
459 
460   return aligned_address;
461 }
462 
Leak(lldb::addr_t process_address,Status & error)463 void IRMemoryMap::Leak(lldb::addr_t process_address, Status &error) {
464   error.Clear();
465 
466   AllocationMap::iterator iter = m_allocations.find(process_address);
467 
468   if (iter == m_allocations.end()) {
469     error = Status::FromErrorString("Couldn't leak: allocation doesn't exist");
470     return;
471   }
472 
473   Allocation &allocation = iter->second;
474 
475   allocation.m_leak = true;
476 }
477 
Free(lldb::addr_t process_address,Status & error)478 void IRMemoryMap::Free(lldb::addr_t process_address, Status &error) {
479   error.Clear();
480 
481   AllocationMap::iterator iter = m_allocations.find(process_address);
482 
483   if (iter == m_allocations.end()) {
484     error = Status::FromErrorString("Couldn't free: allocation doesn't exist");
485     return;
486   }
487 
488   Allocation &allocation = iter->second;
489 
490   switch (allocation.m_policy) {
491   default:
492   case eAllocationPolicyHostOnly: {
493     lldb::ProcessSP process_sp = m_process_wp.lock();
494     if (process_sp) {
495       if (process_sp->CanJIT() && process_sp->IsAlive())
496         process_sp->DeallocateMemory(
497             allocation.m_process_alloc); // FindSpace allocated this for real
498     }
499 
500     break;
501   }
502   case eAllocationPolicyMirror:
503   case eAllocationPolicyProcessOnly: {
504     lldb::ProcessSP process_sp = m_process_wp.lock();
505     if (process_sp)
506       process_sp->DeallocateMemory(allocation.m_process_alloc);
507   }
508   }
509 
510   if (lldb_private::Log *log = GetLog(LLDBLog::Expressions)) {
511     LLDB_LOGF(log,
512               "IRMemoryMap::Free (0x%" PRIx64 ") freed [0x%" PRIx64
513               "..0x%" PRIx64 ")",
514               (uint64_t)process_address, iter->second.m_process_start,
515               iter->second.m_process_start + iter->second.m_size);
516   }
517 
518   m_allocations.erase(iter);
519 }
520 
GetAllocSize(lldb::addr_t address,size_t & size)521 bool IRMemoryMap::GetAllocSize(lldb::addr_t address, size_t &size) {
522   AllocationMap::iterator iter = FindAllocation(address, size);
523   if (iter == m_allocations.end())
524     return false;
525 
526   Allocation &al = iter->second;
527 
528   if (address > (al.m_process_start + al.m_size)) {
529     size = 0;
530     return false;
531   }
532 
533   if (address > al.m_process_start) {
534     int dif = address - al.m_process_start;
535     size = al.m_size - dif;
536     return true;
537   }
538 
539   size = al.m_size;
540   return true;
541 }
542 
WriteMemory(lldb::addr_t process_address,const uint8_t * bytes,size_t size,Status & error)543 void IRMemoryMap::WriteMemory(lldb::addr_t process_address,
544                               const uint8_t *bytes, size_t size,
545                               Status &error) {
546   error.Clear();
547 
548   AllocationMap::iterator iter = FindAllocation(process_address, size);
549 
550   if (iter == m_allocations.end()) {
551     lldb::ProcessSP process_sp = m_process_wp.lock();
552 
553     if (process_sp) {
554       process_sp->WriteMemory(process_address, bytes, size, error);
555       return;
556     }
557 
558     error = Status::FromErrorString(
559         "Couldn't write: no allocation contains the target "
560         "range and the process doesn't exist");
561     return;
562   }
563 
564   Allocation &allocation = iter->second;
565 
566   uint64_t offset = process_address - allocation.m_process_start;
567 
568   lldb::ProcessSP process_sp;
569 
570   switch (allocation.m_policy) {
571   default:
572     error =
573         Status::FromErrorString("Couldn't write: invalid allocation policy");
574     return;
575   case eAllocationPolicyHostOnly:
576     if (!allocation.m_data.GetByteSize()) {
577       error = Status::FromErrorString("Couldn't write: data buffer is empty");
578       return;
579     }
580     ::memcpy(allocation.m_data.GetBytes() + offset, bytes, size);
581     break;
582   case eAllocationPolicyMirror:
583     if (!allocation.m_data.GetByteSize()) {
584       error = Status::FromErrorString("Couldn't write: data buffer is empty");
585       return;
586     }
587     ::memcpy(allocation.m_data.GetBytes() + offset, bytes, size);
588     process_sp = m_process_wp.lock();
589     if (process_sp) {
590       process_sp->WriteMemory(process_address, bytes, size, error);
591       if (!error.Success())
592         return;
593     }
594     break;
595   case eAllocationPolicyProcessOnly:
596     process_sp = m_process_wp.lock();
597     if (process_sp) {
598       process_sp->WriteMemory(process_address, bytes, size, error);
599       if (!error.Success())
600         return;
601     }
602     break;
603   }
604 
605   if (lldb_private::Log *log = GetLog(LLDBLog::Expressions)) {
606     LLDB_LOGF(log,
607               "IRMemoryMap::WriteMemory (0x%" PRIx64 ", 0x%" PRIxPTR
608               ", 0x%" PRId64 ") went to [0x%" PRIx64 "..0x%" PRIx64 ")",
609               (uint64_t)process_address, reinterpret_cast<uintptr_t>(bytes), (uint64_t)size,
610               (uint64_t)allocation.m_process_start,
611               (uint64_t)allocation.m_process_start +
612                   (uint64_t)allocation.m_size);
613   }
614 }
615 
WriteScalarToMemory(lldb::addr_t process_address,Scalar & scalar,size_t size,Status & error)616 void IRMemoryMap::WriteScalarToMemory(lldb::addr_t process_address,
617                                       Scalar &scalar, size_t size,
618                                       Status &error) {
619   error.Clear();
620 
621   if (size == UINT32_MAX)
622     size = scalar.GetByteSize();
623 
624   if (size > 0) {
625     uint8_t buf[32];
626     const size_t mem_size =
627         scalar.GetAsMemoryData(buf, size, GetByteOrder(), error);
628     if (mem_size > 0) {
629       return WriteMemory(process_address, buf, mem_size, error);
630     } else {
631       error = Status::FromErrorString(
632           "Couldn't write scalar: failed to get scalar as memory data");
633     }
634   } else {
635     error = Status::FromErrorString("Couldn't write scalar: its size was zero");
636   }
637 }
638 
WritePointerToMemory(lldb::addr_t process_address,lldb::addr_t address,Status & error)639 void IRMemoryMap::WritePointerToMemory(lldb::addr_t process_address,
640                                        lldb::addr_t address, Status &error) {
641   error.Clear();
642 
643   Scalar scalar(address);
644 
645   WriteScalarToMemory(process_address, scalar, GetAddressByteSize(), error);
646 }
647 
ReadMemory(uint8_t * bytes,lldb::addr_t process_address,size_t size,Status & error)648 void IRMemoryMap::ReadMemory(uint8_t *bytes, lldb::addr_t process_address,
649                              size_t size, Status &error) {
650   error.Clear();
651 
652   AllocationMap::iterator iter = FindAllocation(process_address, size);
653 
654   if (iter == m_allocations.end()) {
655     lldb::ProcessSP process_sp = m_process_wp.lock();
656 
657     if (process_sp) {
658       process_sp->ReadMemory(process_address, bytes, size, error);
659       return;
660     }
661 
662     lldb::TargetSP target_sp = m_target_wp.lock();
663 
664     if (target_sp) {
665       Address absolute_address(process_address);
666       target_sp->ReadMemory(absolute_address, bytes, size, error, true);
667       return;
668     }
669 
670     error = Status::FromErrorString(
671         "Couldn't read: no allocation contains the target "
672         "range, and neither the process nor the target exist");
673     return;
674   }
675 
676   Allocation &allocation = iter->second;
677 
678   uint64_t offset = process_address - allocation.m_process_start;
679 
680   if (offset > allocation.m_size) {
681     error =
682         Status::FromErrorString("Couldn't read: data is not in the allocation");
683     return;
684   }
685 
686   lldb::ProcessSP process_sp;
687 
688   switch (allocation.m_policy) {
689   default:
690     error = Status::FromErrorString("Couldn't read: invalid allocation policy");
691     return;
692   case eAllocationPolicyHostOnly:
693     if (!allocation.m_data.GetByteSize()) {
694       error = Status::FromErrorString("Couldn't read: data buffer is empty");
695       return;
696     }
697     if (allocation.m_data.GetByteSize() < offset + size) {
698       error =
699           Status::FromErrorString("Couldn't read: not enough underlying data");
700       return;
701     }
702 
703     ::memcpy(bytes, allocation.m_data.GetBytes() + offset, size);
704     break;
705   case eAllocationPolicyMirror:
706     process_sp = m_process_wp.lock();
707     if (process_sp) {
708       process_sp->ReadMemory(process_address, bytes, size, error);
709       if (!error.Success())
710         return;
711     } else {
712       if (!allocation.m_data.GetByteSize()) {
713         error = Status::FromErrorString("Couldn't read: data buffer is empty");
714         return;
715       }
716       ::memcpy(bytes, allocation.m_data.GetBytes() + offset, size);
717     }
718     break;
719   case eAllocationPolicyProcessOnly:
720     process_sp = m_process_wp.lock();
721     if (process_sp) {
722       process_sp->ReadMemory(process_address, bytes, size, error);
723       if (!error.Success())
724         return;
725     }
726     break;
727   }
728 
729   if (lldb_private::Log *log = GetLog(LLDBLog::Expressions)) {
730     LLDB_LOGF(log,
731               "IRMemoryMap::ReadMemory (0x%" PRIx64 ", 0x%" PRIxPTR
732               ", 0x%" PRId64 ") came from [0x%" PRIx64 "..0x%" PRIx64 ")",
733               (uint64_t)process_address, reinterpret_cast<uintptr_t>(bytes), (uint64_t)size,
734               (uint64_t)allocation.m_process_start,
735               (uint64_t)allocation.m_process_start +
736                   (uint64_t)allocation.m_size);
737   }
738 }
739 
ReadScalarFromMemory(Scalar & scalar,lldb::addr_t process_address,size_t size,Status & error)740 void IRMemoryMap::ReadScalarFromMemory(Scalar &scalar,
741                                        lldb::addr_t process_address,
742                                        size_t size, Status &error) {
743   error.Clear();
744 
745   if (size > 0) {
746     DataBufferHeap buf(size, 0);
747     ReadMemory(buf.GetBytes(), process_address, size, error);
748 
749     if (!error.Success())
750       return;
751 
752     DataExtractor extractor(buf.GetBytes(), buf.GetByteSize(), GetByteOrder(),
753                             GetAddressByteSize());
754 
755     lldb::offset_t offset = 0;
756 
757     switch (size) {
758     default:
759       error = Status::FromErrorStringWithFormat(
760           "Couldn't read scalar: unsupported size %" PRIu64, (uint64_t)size);
761       return;
762     case 1:
763       scalar = extractor.GetU8(&offset);
764       break;
765     case 2:
766       scalar = extractor.GetU16(&offset);
767       break;
768     case 4:
769       scalar = extractor.GetU32(&offset);
770       break;
771     case 8:
772       scalar = extractor.GetU64(&offset);
773       break;
774     }
775   } else {
776     error = Status::FromErrorString("Couldn't read scalar: its size was zero");
777   }
778 }
779 
ReadPointerFromMemory(lldb::addr_t * address,lldb::addr_t process_address,Status & error)780 void IRMemoryMap::ReadPointerFromMemory(lldb::addr_t *address,
781                                         lldb::addr_t process_address,
782                                         Status &error) {
783   error.Clear();
784 
785   Scalar pointer_scalar;
786   ReadScalarFromMemory(pointer_scalar, process_address, GetAddressByteSize(),
787                        error);
788 
789   if (!error.Success())
790     return;
791 
792   *address = pointer_scalar.ULongLong();
793 }
794 
GetMemoryData(DataExtractor & extractor,lldb::addr_t process_address,size_t size,Status & error)795 void IRMemoryMap::GetMemoryData(DataExtractor &extractor,
796                                 lldb::addr_t process_address, size_t size,
797                                 Status &error) {
798   error.Clear();
799 
800   if (size > 0) {
801     AllocationMap::iterator iter = FindAllocation(process_address, size);
802 
803     if (iter == m_allocations.end()) {
804       error = Status::FromErrorStringWithFormat(
805           "Couldn't find an allocation containing [0x%" PRIx64 "..0x%" PRIx64
806           ")",
807           process_address, process_address + size);
808       return;
809     }
810 
811     Allocation &allocation = iter->second;
812 
813     switch (allocation.m_policy) {
814     default:
815       error = Status::FromErrorString(
816           "Couldn't get memory data: invalid allocation policy");
817       return;
818     case eAllocationPolicyProcessOnly:
819       error = Status::FromErrorString(
820           "Couldn't get memory data: memory is only in the target");
821       return;
822     case eAllocationPolicyMirror: {
823       lldb::ProcessSP process_sp = m_process_wp.lock();
824 
825       if (!allocation.m_data.GetByteSize()) {
826         error = Status::FromErrorString(
827             "Couldn't get memory data: data buffer is empty");
828         return;
829       }
830       if (process_sp) {
831         process_sp->ReadMemory(allocation.m_process_start,
832                                allocation.m_data.GetBytes(),
833                                allocation.m_data.GetByteSize(), error);
834         if (!error.Success())
835           return;
836         uint64_t offset = process_address - allocation.m_process_start;
837         extractor = DataExtractor(allocation.m_data.GetBytes() + offset, size,
838                                   GetByteOrder(), GetAddressByteSize());
839         return;
840       }
841     } break;
842     case eAllocationPolicyHostOnly:
843       if (!allocation.m_data.GetByteSize()) {
844         error = Status::FromErrorString(
845             "Couldn't get memory data: data buffer is empty");
846         return;
847       }
848       uint64_t offset = process_address - allocation.m_process_start;
849       extractor = DataExtractor(allocation.m_data.GetBytes() + offset, size,
850                                 GetByteOrder(), GetAddressByteSize());
851       return;
852     }
853   } else {
854     error =
855         Status::FromErrorString("Couldn't get memory data: its size was zero");
856     return;
857   }
858 }
859