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 "gmock/gmock.h"
  18    :  #include "gtest/gtest.h"
  19    :  #include "syzygy/bard/unittest_util.h"
  20    :  #include "syzygy/bard/backdrops/heap_backdrop.h"
  21    :  
  22    :  namespace bard {
  23    :  namespace events {
  24    :  
  25    :  namespace {
  26    :  
  27    :  using bard::backdrops::HeapBackdrop;
  28    :  using bard::events::HeapFreeEvent;
  29    :  using testing::Return;
  30    :  
  31    :  const HANDLE kLiveHeap = reinterpret_cast<HANDLE>(0x4197FC83);
  32    :  const HANDLE kTraceHeap = reinterpret_cast<HANDLE>(0xAB12CD34);
  33    :  const LPVOID kLiveAlloc = reinterpret_cast<LPVOID>(0x4820BC7A);
  34    :  const LPVOID kTraceAlloc = reinterpret_cast<LPVOID>(0xF1D97AE4);
  35    :  const DWORD kFlags = 1;
  36    :  
  37    :  class HeapFreeEventTest : public testing::Test {
  38    :   public:
  39  E :    MOCK_METHOD3(FakeCall, BOOL(HANDLE, DWORD, LPVOID));
  40    :  
  41  E :    void SetUp() override {
  42  E :      backdrop_.heap_map().AddMapping(kTraceHeap, kLiveHeap);
  43  E :      backdrop_.alloc_map().AddMapping(kTraceAlloc, kLiveAlloc);
  44    :  
  45    :      backdrop_.set_heap_free(
  46  E :          base::Bind(&HeapFreeEventTest::FakeCall, base::Unretained(this)));
  47  E :    }
  48    :  
  49    :   protected:
  50    :    HeapBackdrop backdrop_;
  51    :  };
  52    :  
  53    :  }  // namespace
  54    :  
  55  E :  TEST_F(HeapFreeEventTest, TestSuccessCall) {
  56  E :    HeapFreeEvent heap_free_event(kTraceHeap, kFlags, kTraceAlloc, true);
  57    :  
  58    :    EXPECT_CALL(*this, FakeCall(kLiveHeap, kFlags, kLiveAlloc))
  59  E :        .WillOnce(Return(true));
  60    :  
  61  E :    EXPECT_TRUE(heap_free_event.Play(reinterpret_cast<void*>(&backdrop_)));
  62    :  
  63    :    testing::CheckTraceLiveMapNotContain(backdrop_.alloc_map(),
  64    :                                         kTraceAlloc,
  65  E :                                         kLiveAlloc);
  66  E :  }
  67    :  
  68  E :  TEST_F(HeapFreeEventTest, TestFailCall) {
  69  E :    HeapFreeEvent heap_free_event(kTraceHeap, kFlags, kTraceAlloc, false);
  70    :  
  71    :    EXPECT_CALL(*this, FakeCall(kLiveHeap, kFlags, kLiveAlloc))
  72  E :        .WillOnce(Return(false));
  73    :  
  74  E :    EXPECT_TRUE(heap_free_event.Play(reinterpret_cast<void*>(&backdrop_)));
  75    :  
  76    :    testing::CheckTraceLiveMapContains(backdrop_.alloc_map(),
  77    :                                       kTraceAlloc,
  78  E :                                       kLiveAlloc);
  79  E :  }
  80    :  
  81  E :  TEST_F(HeapFreeEventTest, TestInconsistentReturn) {
  82  E :    HeapFreeEvent heap_free_event(kTraceHeap, kFlags, kTraceAlloc, false);
  83    :  
  84    :    EXPECT_CALL(*this, FakeCall(kLiveHeap, kFlags, kLiveAlloc))
  85  E :        .WillOnce(Return(true));
  86    :  
  87  E :    EXPECT_FALSE(heap_free_event.Play(reinterpret_cast<void*>(&backdrop_)));
  88    :  
  89    :    testing::CheckTraceLiveMapContains(backdrop_.alloc_map(),
  90    :                                       kTraceAlloc,
  91  E :                                       kLiveAlloc);
  92  E :  }
  93    :  
  94  E :  TEST_F(HeapFreeEventTest, Equals) {
  95  E :    HeapFreeEvent e1(kTraceHeap, kFlags, kTraceAlloc, true);
  96  E :    HeapFreeEvent e2(kTraceHeap, kFlags, kTraceAlloc, true);
  97  E :    HeapFreeEvent e3(kTraceHeap, kFlags + 1, kTraceAlloc, false);
  98  E :    EXPECT_TRUE(e1.Equals(&e1));
  99  E :    EXPECT_TRUE(e1.Equals(&e2));
 100  E :    EXPECT_FALSE(e1.Equals(&e3));
 101  E :    EXPECT_FALSE(e2.Equals(&e3));
 102  E :  }
 103    :  
 104  E :  TEST_F(HeapFreeEventTest, TestSerialization) {
 105  E :    HeapFreeEvent heap_free_event(kTraceHeap, kFlags, kTraceAlloc, true);
 106  E :    testing::TestEventSerialization(heap_free_event);
 107  E :  }
 108    :  
 109    :  }  // namespace events
 110    :  }  // namespace bard