src/third_party/angle/src/libANGLE/renderer/d3d/d3d11/MappedSubresourceVerifier11.cpp

//
// Copyright 2019 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//

// MappedSubresourceVerifier11.cpp: Implements the
// rx::MappedSubresourceVerifier11 class, a simple wrapper to D3D11 Texture2D
// mapped memory so that ASAN and MSAN can catch memory errors done with a
// pointer to the mapped texture memory.

#include "libANGLE/renderer/d3d/d3d11/MappedSubresourceVerifier11.h"

#include "libANGLE/renderer/d3d/d3d11/formatutils11.h"

namespace rx
{

#if defined(ADDRESS_SANITIZER) || defined(MEMORY_SANITIZER) || defined(ANGLE_ENABLE_ASSERTS)

namespace
{

#    if defined(ADDRESS_SANITIZER) || defined(MEMORY_SANITIZER)
constexpr bool kUseWrap = true;
#    else
constexpr bool kUseWrap = false;
#    endif

size_t getPitchCount(const D3D11_TEXTURE2D_DESC &desc)
{
    const d3d11::DXGIFormatSize &dxgiFormatInfo = d3d11::GetDXGIFormatSizeInfo(desc.Format);
    ASSERT(desc.Height % dxgiFormatInfo.blockHeight == 0);
    return desc.Height / dxgiFormatInfo.blockHeight;
}

}  // namespace

MappedSubresourceVerifier11::MappedSubresourceVerifier11() = default;

MappedSubresourceVerifier11::~MappedSubresourceVerifier11()
{
    ASSERT(!mOrigData);
    ASSERT(!mWrapData.size());
}

void MappedSubresourceVerifier11::setDesc(const D3D11_TEXTURE2D_DESC &desc)
{
    ASSERT(desc.CPUAccessFlags & (D3D11_CPU_ACCESS_READ | D3D11_CPU_ACCESS_WRITE));
    ASSERT(desc.Width);
    ASSERT(desc.Height);
    ASSERT(!mOrigData);
    ASSERT(!mWrapData.size());
    ASSERT(!mPitchType);
    ASSERT(!mPitchCount);
    mPitchType  = &D3D11_MAPPED_SUBRESOURCE::RowPitch;
    mPitchCount = getPitchCount(desc);
}

void MappedSubresourceVerifier11::setDesc(const D3D11_TEXTURE3D_DESC &desc)
{
    ASSERT(desc.CPUAccessFlags & (D3D11_CPU_ACCESS_READ | D3D11_CPU_ACCESS_WRITE));
    ASSERT(desc.Width);
    ASSERT(desc.Height);
    ASSERT(desc.Depth);
    ASSERT(!mOrigData);
    ASSERT(!mWrapData.size());
    ASSERT(!mPitchType);
    ASSERT(!mPitchCount);
    mPitchType  = &D3D11_MAPPED_SUBRESOURCE::DepthPitch;
    mPitchCount = desc.Depth;
}

void MappedSubresourceVerifier11::reset()
{
    ASSERT(!mOrigData);
    ASSERT(!mWrapData.size());
    mPitchType  = nullptr;
    mPitchCount = 0;
}

bool MappedSubresourceVerifier11::wrap(D3D11_MAP mapType, D3D11_MAPPED_SUBRESOURCE *map)
{
    ASSERT(map && map->pData);
    ASSERT(mapType == D3D11_MAP_READ || mapType == D3D11_MAP_WRITE ||
           mapType == D3D11_MAP_READ_WRITE);
    ASSERT(mPitchCount);

    if (kUseWrap)
    {
        if (!mWrapData.resize(mPitchCount * map->*mPitchType))
            return false;
    }

    mOrigData = reinterpret_cast<uint8_t *>(map->pData);

    if (kUseWrap)
    {
        std::copy(mOrigData, mOrigData + mWrapData.size(), mWrapData.data());
        map->pData = mWrapData.data();
    }
    return true;
}

void MappedSubresourceVerifier11::unwrap()
{
    ASSERT(mPitchCount);
    ASSERT(mOrigData);
    if (kUseWrap)
    {
        std::copy(mWrapData.data(), mWrapData.data() + mWrapData.size(), mOrigData);
        mWrapData = angle::MemoryBuffer();
    }
    mOrigData = nullptr;
}

#endif

}  // namespace rx