register_state_check.h 5.6 KB
Newer Older
1
/*
Yaowu Xu's avatar
Yaowu Xu committed
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
3
 *
Yaowu Xu's avatar
Yaowu Xu committed
4 5 6 7 8 9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10 11
 */

Yaowu Xu's avatar
Yaowu Xu committed
12 13
#ifndef TEST_REGISTER_STATE_CHECK_H_
#define TEST_REGISTER_STATE_CHECK_H_
14

15
#include "third_party/googletest/src/googletest/include/gtest/gtest.h"
Yaowu Xu's avatar
Yaowu Xu committed
16 17
#include "./aom_config.h"
#include "aom/aom_integer.h"
18 19 20 21 22 23 24 25 26 27 28 29 30

// ASM_REGISTER_STATE_CHECK(asm_function)
//   Minimally validates the environment pre & post function execution. This
//   variant should be used with assembly functions which are not expected to
//   fully restore the system state. See platform implementations of
//   RegisterStateCheck for details.
//
// API_REGISTER_STATE_CHECK(api_function)
//   Performs all the checks done by ASM_REGISTER_STATE_CHECK() and any
//   additional checks to ensure the environment is in a consistent state pre &
//   post function execution. This variant should be used with API functions.
//   See platform implementations of RegisterStateCheckXXX for details.
//
31 32

#if defined(_WIN64)
33

34
#undef NOMINMAX
35 36
#define NOMINMAX
#define WIN32_LEAN_AND_MEAN
37 38 39
#include <windows.h>
#include <winnt.h>

clang-format's avatar
clang-format committed
40
inline bool operator==(const M128A &lhs, const M128A &rhs) {
41 42 43
  return (lhs.Low == rhs.Low && lhs.High == rhs.High);
}

44
namespace libaom_test {
45 46 47 48 49 50 51

// Compares the state of xmm[6-15] at construction with their state at
// destruction. These registers should be preserved by the callee on
// Windows x64.
class RegisterStateCheck {
 public:
  RegisterStateCheck() { initialized_ = StoreRegisters(&pre_context_); }
52
  ~RegisterStateCheck() { Check(); }
53 54

 private:
clang-format's avatar
clang-format committed
55
  static bool StoreRegisters(CONTEXT *const context) {
56 57 58 59 60 61 62 63 64
    const HANDLE this_thread = GetCurrentThread();
    EXPECT_TRUE(this_thread != NULL);
    context->ContextFlags = CONTEXT_FLOATING_POINT;
    const bool context_saved = GetThreadContext(this_thread, context) == TRUE;
    EXPECT_TRUE(context_saved) << "GetLastError: " << GetLastError();
    return context_saved;
  }

  // Compares the register state. Returns true if the states match.
65 66
  void Check() const {
    ASSERT_TRUE(initialized_);
67
    CONTEXT post_context;
68
    ASSERT_TRUE(StoreRegisters(&post_context));
69

clang-format's avatar
clang-format committed
70 71
    const M128A *xmm_pre = &pre_context_.Xmm6;
    const M128A *xmm_post = &post_context.Xmm6;
72 73 74 75 76 77 78 79 80 81 82
    for (int i = 6; i <= 15; ++i) {
      EXPECT_EQ(*xmm_pre, *xmm_post) << "xmm" << i << " has been modified!";
      ++xmm_pre;
      ++xmm_post;
    }
  }

  bool initialized_;
  CONTEXT pre_context_;
};

clang-format's avatar
clang-format committed
83 84
#define ASM_REGISTER_STATE_CHECK(statement)    \
  do {                                         \
85
    libaom_test::RegisterStateCheck reg_check; \
clang-format's avatar
clang-format committed
86 87
    statement;                                 \
  } while (false)
88

89
}  // namespace libaom_test
90

Yaowu Xu's avatar
Yaowu Xu committed
91 92
#elif defined(CONFIG_SHARED) && defined(HAVE_NEON_ASM) && !CONFIG_SHARED && \
    HAVE_NEON_ASM && CONFIG_AV1
93 94 95

extern "C" {
// Save the d8-d15 registers into store.
Yaowu Xu's avatar
Yaowu Xu committed
96
void aom_push_neon(int64_t *store);
97 98
}

99
namespace libaom_test {
100 101 102 103 104 105 106

// Compares the state of d8-d15 at construction with their state at
// destruction. These registers should be preserved by the callee on
// arm platform.
class RegisterStateCheck {
 public:
  RegisterStateCheck() { initialized_ = StoreRegisters(pre_store_); }
107
  ~RegisterStateCheck() { Check(); }
108 109 110

 private:
  static bool StoreRegisters(int64_t store[8]) {
Yaowu Xu's avatar
Yaowu Xu committed
111
    aom_push_neon(store);
112 113 114 115
    return true;
  }

  // Compares the register state. Returns true if the states match.
116 117
  void Check() const {
    ASSERT_TRUE(initialized_);
118
    int64_t post_store[8];
Yaowu Xu's avatar
Yaowu Xu committed
119
    aom_push_neon(post_store);
120
    for (int i = 0; i < 8; ++i) {
clang-format's avatar
clang-format committed
121 122
      EXPECT_EQ(pre_store_[i], post_store[i])
          << "d" << i + 8 << " has been modified";
123 124 125 126 127 128 129
    }
  }

  bool initialized_;
  int64_t pre_store_[8];
};

clang-format's avatar
clang-format committed
130 131
#define ASM_REGISTER_STATE_CHECK(statement)    \
  do {                                         \
132
    libaom_test::RegisterStateCheck reg_check; \
clang-format's avatar
clang-format committed
133 134
    statement;                                 \
  } while (false)
135

136
}  // namespace libaom_test
137 138

#else
139

140
namespace libaom_test {
141 142

class RegisterStateCheck {};
143
#define ASM_REGISTER_STATE_CHECK(statement) statement
144

145
}  // namespace libaom_test
146 147 148

#endif  // _WIN64

149 150 151
#if ARCH_X86 || ARCH_X86_64
#if defined(__GNUC__)

152
namespace libaom_test {
153 154 155 156 157 158 159

// Checks the FPU tag word pre/post execution to ensure emms has been called.
class RegisterStateCheckMMX {
 public:
  RegisterStateCheckMMX() {
    __asm__ volatile("fstenv %0" : "=rm"(pre_fpu_env_));
  }
160
  ~RegisterStateCheckMMX() { Check(); }
161 162 163 164

 private:
  // Checks the FPU tag word pre/post execution, returning false if not cleared
  // to 0xffff.
165
  void Check() const {
166 167 168 169 170 171 172 173 174 175 176 177
    EXPECT_EQ(0xffff, pre_fpu_env_[4])
        << "FPU was in an inconsistent state prior to call";

    uint16_t post_fpu_env[14];
    __asm__ volatile("fstenv %0" : "=rm"(post_fpu_env));
    EXPECT_EQ(0xffff, post_fpu_env[4])
        << "FPU was left in an inconsistent state after call";
  }

  uint16_t pre_fpu_env_[14];
};

clang-format's avatar
clang-format committed
178 179
#define API_REGISTER_STATE_CHECK(statement)       \
  do {                                            \
180
    libaom_test::RegisterStateCheckMMX reg_check; \
clang-format's avatar
clang-format committed
181 182
    ASM_REGISTER_STATE_CHECK(statement);          \
  } while (false)
183

184
}  // namespace libaom_test
185 186 187 188 189 190 191 192

#endif  // __GNUC__
#endif  // ARCH_X86 || ARCH_X86_64

#ifndef API_REGISTER_STATE_CHECK
#define API_REGISTER_STATE_CHECK ASM_REGISTER_STATE_CHECK
#endif

Yaowu Xu's avatar
Yaowu Xu committed
193
#endif  // TEST_REGISTER_STATE_CHECK_H_