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/trace/common/clock.h"
  19    :  
  20    :  namespace bard {
  21    :  namespace events {
  22    :  
  23    :  HeapFreeEvent::HeapFreeEvent(HANDLE trace_heap,
  24    :                               DWORD flags,
  25    :                               LPVOID trace_alloc,
  26    :                               BOOL trace_succeeded)
  27    :      : trace_heap_(trace_heap),
  28    :        flags_(flags),
  29    :        trace_alloc_(trace_alloc),
  30  E :        trace_succeeded_(trace_succeeded) {
  31  E :  }
  32    :  
  33    :  bool HeapFreeEvent::Save(const EventInterface* const event,
  34  E :                           core::OutArchive* out_archive) {
  35  E :    DCHECK_NE(static_cast<EventInterface*>(nullptr), event);
  36    :  
  37    :    const HeapFreeEvent* derived_event =
  38  E :        reinterpret_cast<const HeapFreeEvent*>(event);
  39    :  
  40    :    return out_archive->Save(
  41    :               reinterpret_cast<uintptr_t>(derived_event->trace_heap_)) &&
  42    :           out_archive->Save(derived_event->flags_) &&
  43    :           out_archive->Save(
  44    :               reinterpret_cast<uintptr_t>(derived_event->trace_alloc_)) &&
  45  E :           out_archive->Save(derived_event->trace_succeeded_);
  46  E :  }
  47    :  
  48    :  scoped_ptr<HeapFreeEvent> HeapFreeEvent::Load(
  49  E :      core::InArchive* in_archive) {
  50    :    uintptr_t trace_heap;
  51    :    DWORD flags;
  52    :    uintptr_t trace_alloc;
  53    :    BOOL trace_succeeded;
  54    :    if (in_archive->Load(&trace_heap) &&
  55    :        in_archive->Load(&flags) &&
  56    :        in_archive->Load(&trace_alloc) &&
  57  E :        in_archive->Load(&trace_succeeded)) {
  58    :      return scoped_ptr<HeapFreeEvent>(
  59    :          new HeapFreeEvent(reinterpret_cast<HANDLE>(trace_heap),
  60    :                            flags,
  61    :                            reinterpret_cast<LPVOID>(trace_alloc),
  62  E :                            trace_succeeded));
  63    :    }
  64  i :    return nullptr;
  65  E :  }
  66    :  
  67  E :  bool HeapFreeEvent::Play(void* backdrop) {
  68  E :    DCHECK_NE(static_cast<void*>(nullptr), backdrop);
  69    :  
  70    :    using bard::backdrops::HeapBackdrop;
  71  E :    HeapBackdrop* heap_backdrop = reinterpret_cast<HeapBackdrop*>(backdrop);
  72    :  
  73  E :    HANDLE live_heap = INVALID_HANDLE_VALUE;
  74  E :    LPVOID live_alloc = nullptr;
  75    :  
  76    :    if (!heap_backdrop->heap_map().GetLiveFromTrace(trace_heap_, &live_heap) ||
  77  E :        !heap_backdrop->alloc_map().GetLiveFromTrace(trace_alloc_, &live_alloc)) {
  78  i :      return false;
  79    :    }
  80    :  
  81  E :    uint64_t t0 = ::trace::common::GetTsc();
  82  E :    BOOL live_succeeded = heap_backdrop->HeapFree(live_heap, flags_, live_alloc);
  83  E :    uint64_t t1 = ::trace::common::GetTsc();
  84    :  
  85  E :    if (live_succeeded != trace_succeeded_) {
  86  E :      LOG(ERROR) << "HeapFree " << (live_succeeded ? "succeeded" : "failed")
  87    :                 << " when it was supposed to "
  88    :                 << (trace_succeeded_ ? "succeed" : "fail") << ".";
  89  E :      return false;
  90    :    }
  91    :  
  92    :    if (live_succeeded &&
  93  E :        !heap_backdrop->alloc_map().RemoveMapping(trace_alloc_, live_alloc)) {
  94  i :      return false;
  95    :    }
  96    :  
  97  E :    heap_backdrop->UpdateStats(type(), t1 - t0);
  98    :  
  99  E :    return true;
 100  E :  }
 101    :  
 102  E :  bool HeapFreeEvent::Equals(const EventInterface* rhs) const {
 103  E :    DCHECK_NE(static_cast<EventInterface*>(nullptr), rhs);
 104    :  
 105  E :    if (rhs->type() != kHeapFreeEvent)
 106  i :      return false;
 107    :  
 108  E :    const auto e = reinterpret_cast<const HeapFreeEvent*>(rhs);
 109    :    if (trace_heap_ != e->trace_heap_ || flags_ != e->flags_ ||
 110    :        trace_alloc_ != e->trace_alloc_ ||
 111  E :        trace_succeeded_ != e->trace_succeeded_) {
 112  E :      return false;
 113    :    }
 114    :  
 115  E :    return true;
 116  E :  }
 117    :  
 118    :  }  // namespace events
 119    :  }  // namespace bard