1    :  // Copyright 2015 Google Inc. All Rights Reserved.
   2    :  //
   3    :  // Licensed under the Apache License, Version 2.0 (the "License");
   4    :  // you may not use this file except in compliance with the License.
   5    :  // You may obtain a copy of the License at
   6    :  //
   7    :  //     http://www.apache.org/licenses/LICENSE-2.0
   8    :  //
   9    :  // Unless required by applicable law or agreed to in writing, software
  10    :  // distributed under the License is distributed on an "AS IS" BASIS,
  11    :  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    :  // See the License for the specific language governing permissions and
  13    :  // limitations under the License.
  14    :  
  15    :  #include "syzygy/bard/events/heap_free_event.h"
  16    :  
  17    :  #include "syzygy/bard/backdrops/heap_backdrop.h"
  18    :  #include "syzygy/bard/events/play_util.h"
  19    :  
  20    :  namespace bard {
  21    :  namespace events {
  22    :  
  23    :  HeapFreeEvent::HeapFreeEvent(uint32_t stack_trace_id,
  24    :                               HANDLE trace_heap,
  25    :                               DWORD flags,
  26    :                               LPVOID trace_alloc,
  27    :                               BOOL trace_succeeded)
  28  E :      : stack_trace_id_(stack_trace_id),
  29  E :        trace_heap_(trace_heap),
  30  E :        flags_(flags),
  31  E :        trace_alloc_(trace_alloc),
  32  E :        trace_succeeded_(trace_succeeded) {
  33  E :  }
  34    :  
  35    :  bool HeapFreeEvent::Save(const EventInterface* const event,
  36  E :                           core::OutArchive* out_archive) {
  37  E :    DCHECK_NE(static_cast<EventInterface*>(nullptr), event);
  38    :  
  39    :    const HeapFreeEvent* derived_event =
  40  E :        reinterpret_cast<const HeapFreeEvent*>(event);
  41    :  
  42  E :    return out_archive->Save(derived_event->stack_trace_id_) &&
  43    :           out_archive->Save(
  44    :               reinterpret_cast<uintptr_t>(derived_event->trace_heap_)) &&
  45    :           out_archive->Save(derived_event->flags_) &&
  46    :           out_archive->Save(
  47    :               reinterpret_cast<uintptr_t>(derived_event->trace_alloc_)) &&
  48    :           out_archive->Save(derived_event->trace_succeeded_);
  49  E :  }
  50    :  
  51    :  std::unique_ptr<HeapFreeEvent> HeapFreeEvent::Load(
  52  E :      core::InArchive* in_archive) {
  53  E :    uint32_t stack_trace_id = 0;
  54  E :    uintptr_t trace_heap = 0;
  55  E :    DWORD flags = 0;
  56  E :    uintptr_t trace_alloc = 0;
  57  E :    BOOL trace_succeeded = 0;
  58    :    if (in_archive->Load(&stack_trace_id) && in_archive->Load(&trace_heap) &&
  59  E :        in_archive->Load(&flags) && in_archive->Load(&trace_alloc) &&
  60    :        in_archive->Load(&trace_succeeded)) {
  61  E :      return std::unique_ptr<HeapFreeEvent>(new HeapFreeEvent(
  62    :          stack_trace_id, reinterpret_cast<HANDLE>(trace_heap), flags,
  63    :          reinterpret_cast<LPVOID>(trace_alloc), trace_succeeded));
  64    :    }
  65  i :    return nullptr;
  66  E :  }
  67    :  
  68  E :  bool HeapFreeEvent::Play(void* backdrop) {
  69  E :    DCHECK_NE(static_cast<void*>(nullptr), backdrop);
  70    :  
  71    :    using bard::backdrops::HeapBackdrop;
  72  E :    HeapBackdrop* heap_backdrop = reinterpret_cast<HeapBackdrop*>(backdrop);
  73    :  
  74  E :    HANDLE live_heap = INVALID_HANDLE_VALUE;
  75  E :    LPVOID live_alloc = nullptr;
  76    :  
  77  E :    if (!heap_backdrop->heap_map().GetLiveFromTrace(trace_heap_, &live_heap) ||
  78    :        !heap_backdrop->alloc_map().GetLiveFromTrace(trace_alloc_, &live_alloc)) {
  79  i :      return false;
  80    :    }
  81    :  
  82  E :    uint64_t timing = 0;
  83    :    BOOL live_succeeded =
  84  E :        InvokeOnBackdrop(stack_trace_id_, &timing, heap_backdrop,
  85    :                         &HeapBackdrop::HeapFree, live_heap, flags_, live_alloc);
  86    :  
  87  E :    if (live_succeeded != trace_succeeded_) {
  88  E :      LOG(ERROR) << "HeapFree " << (live_succeeded ? "succeeded" : "failed")
  89    :                 << " when it was supposed to "
  90    :                 << (trace_succeeded_ ? "succeed" : "fail") << ".";
  91  E :      return false;
  92    :    }
  93    :  
  94  E :    if (live_succeeded &&
  95    :        !heap_backdrop->alloc_map().RemoveMapping(trace_alloc_, live_alloc)) {
  96  i :      return false;
  97    :    }
  98    :  
  99  E :    heap_backdrop->UpdateStats(type(), timing);
 100    :  
 101  E :    return true;
 102  E :  }
 103    :  
 104  E :  bool HeapFreeEvent::Equals(const EventInterface* rhs) const {
 105  E :    DCHECK_NE(static_cast<EventInterface*>(nullptr), rhs);
 106    :  
 107  E :    if (rhs->type() != kHeapFreeEvent)
 108  i :      return false;
 109    :  
 110  E :    const auto e = reinterpret_cast<const HeapFreeEvent*>(rhs);
 111    :    if (stack_trace_id_ != e->stack_trace_id_ || trace_heap_ != e->trace_heap_ ||
 112  E :        flags_ != e->flags_ || trace_alloc_ != e->trace_alloc_ ||
 113    :        trace_succeeded_ != e->trace_succeeded_) {
 114  E :      return false;
 115    :    }
 116    :  
 117  E :    return true;
 118  E :  }
 119    :  
 120    :  }  // namespace events
 121    :  }  // namespace bard