gecko-dev/dom/canvas/WebGLBuffer.cpp

416 строки
12 KiB
C++

/* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "WebGLBuffer.h"
#include "GLContext.h"
#include "mozilla/dom/WebGLRenderingContextBinding.h"
#include "WebGLContext.h"
namespace mozilla {
WebGLBuffer::WebGLBuffer(WebGLContext* webgl, GLuint buf)
: WebGLRefCountedObject(webgl)
, mGLName(buf)
, mContent(Kind::Undefined)
, mUsage(LOCAL_GL_STATIC_DRAW)
, mByteLength(0)
, mTFBindCount(0)
, mNonTFBindCount(0)
{
mContext->mBuffers.insertBack(this);
}
WebGLBuffer::~WebGLBuffer()
{
DeleteOnce();
}
void
WebGLBuffer::SetContentAfterBind(GLenum target)
{
if (mContent != Kind::Undefined)
return;
switch (target) {
case LOCAL_GL_ELEMENT_ARRAY_BUFFER:
mContent = Kind::ElementArray;
break;
case LOCAL_GL_ARRAY_BUFFER:
case LOCAL_GL_PIXEL_PACK_BUFFER:
case LOCAL_GL_PIXEL_UNPACK_BUFFER:
case LOCAL_GL_UNIFORM_BUFFER:
case LOCAL_GL_TRANSFORM_FEEDBACK_BUFFER:
case LOCAL_GL_COPY_READ_BUFFER:
case LOCAL_GL_COPY_WRITE_BUFFER:
mContent = Kind::OtherData;
break;
default:
MOZ_CRASH("GFX: invalid target");
}
}
void
WebGLBuffer::Delete()
{
mContext->MakeContextCurrent();
mContext->gl->fDeleteBuffers(1, &mGLName);
mByteLength = 0;
mIndexCache = nullptr;
mIndexRanges.clear();
LinkedListElement<WebGLBuffer>::remove(); // remove from mContext->mBuffers
}
////////////////////////////////////////
static bool
ValidateBufferUsageEnum(WebGLContext* webgl, const char* funcName, GLenum usage)
{
switch (usage) {
case LOCAL_GL_STREAM_DRAW:
case LOCAL_GL_STATIC_DRAW:
case LOCAL_GL_DYNAMIC_DRAW:
return true;
case LOCAL_GL_DYNAMIC_COPY:
case LOCAL_GL_DYNAMIC_READ:
case LOCAL_GL_STATIC_COPY:
case LOCAL_GL_STATIC_READ:
case LOCAL_GL_STREAM_COPY:
case LOCAL_GL_STREAM_READ:
if (MOZ_LIKELY(webgl->IsWebGL2()))
return true;
break;
default:
break;
}
webgl->ErrorInvalidEnum("%s: Invalid `usage`: 0x%04x", funcName, usage);
return false;
}
void
WebGLBuffer::BufferData(GLenum target, size_t size, const void* data, GLenum usage)
{
const char funcName[] = "bufferData";
// Careful: data.Length() could conceivably be any uint32_t, but GLsizeiptr
// is like intptr_t.
if (!CheckedInt<GLsizeiptr>(size).isValid())
return mContext->ErrorOutOfMemory("%s: bad size", funcName);
if (!ValidateBufferUsageEnum(mContext, funcName, usage))
return;
#ifdef XP_MACOSX
// bug 790879
if (mContext->gl->WorkAroundDriverBugs() &&
size > INT32_MAX)
{
mContext->ErrorOutOfMemory("%s: Allocation size too large.", funcName);
return;
}
#endif
const void* uploadData = data;
UniqueBuffer newIndexCache;
if (target == LOCAL_GL_ELEMENT_ARRAY_BUFFER &&
mContext->mNeedsIndexValidation)
{
newIndexCache = malloc(size);
if (!newIndexCache) {
mContext->ErrorOutOfMemory("%s: Failed to alloc index cache.", funcName);
return;
}
memcpy(newIndexCache.get(), data, size);
uploadData = newIndexCache.get();
}
const auto& gl = mContext->gl;
gl->MakeCurrent();
const ScopedLazyBind lazyBind(gl, target, this);
const bool sizeChanges = (size != ByteLength());
if (sizeChanges) {
mContext->InvalidateBufferFetching();
gl::GLContext::LocalErrorScope errorScope(*gl);
gl->fBufferData(target, size, uploadData, usage);
const auto error = errorScope.GetError();
if (error) {
MOZ_ASSERT(error == LOCAL_GL_OUT_OF_MEMORY);
mContext->ErrorOutOfMemory("%s: Error from driver: 0x%04x", funcName, error);
return;
}
} else {
gl->fBufferData(target, size, uploadData, usage);
}
mUsage = usage;
mByteLength = size;
mIndexCache = Move(newIndexCache);
if (mIndexCache) {
if (mIndexRanges.size()) {
mContext->GeneratePerfWarning("[%p] Invalidating %u ranges.", this,
uint32_t(mIndexRanges.size()));
mIndexRanges.clear();
}
}
}
void
WebGLBuffer::BufferSubData(GLenum target, size_t dstByteOffset, size_t dataLen,
const void* data) const
{
const char funcName[] = "bufferSubData";
if (!ValidateRange(funcName, dstByteOffset, dataLen))
return;
if (!CheckedInt<GLintptr>(dataLen).isValid())
return mContext->ErrorOutOfMemory("%s: Size too large.", funcName);
////
const void* uploadData = data;
if (mIndexCache) {
const auto cachedDataBegin = (uint8_t*)mIndexCache.get() + dstByteOffset;
memcpy(cachedDataBegin, data, dataLen);
uploadData = cachedDataBegin;
InvalidateCacheRange(dstByteOffset, dataLen);
}
////
const auto& gl = mContext->gl;
gl->MakeCurrent();
const ScopedLazyBind lazyBind(gl, target, this);
gl->fBufferSubData(target, dstByteOffset, dataLen, uploadData);
}
bool
WebGLBuffer::ValidateRange(const char* funcName, size_t byteOffset, size_t byteLen) const
{
auto availLength = mByteLength;
if (byteOffset > availLength) {
mContext->ErrorInvalidValue("%s: Offset passes the end of the buffer.", funcName);
return false;
}
availLength -= byteOffset;
if (byteLen > availLength) {
mContext->ErrorInvalidValue("%s: Offset+size passes the end of the buffer.",
funcName);
return false;
}
return true;
}
////////////////////////////////////////
static uint8_t
IndexByteSizeByType(GLenum type)
{
switch (type) {
case LOCAL_GL_UNSIGNED_BYTE: return 1;
case LOCAL_GL_UNSIGNED_SHORT: return 2;
case LOCAL_GL_UNSIGNED_INT: return 4;
default:
MOZ_CRASH();
}
}
void
WebGLBuffer::InvalidateCacheRange(size_t byteOffset, size_t byteLength) const
{
MOZ_ASSERT(mIndexCache);
std::vector<IndexRange> invalids;
const size_t updateBegin = byteOffset;
const size_t updateEnd = updateBegin + byteLength;
for (const auto& cur : mIndexRanges) {
const auto& range = cur.first;
const auto& indexByteSize = IndexByteSizeByType(range.type);
const size_t rangeBegin = range.first * indexByteSize;
const size_t rangeEnd = rangeBegin + range.count*indexByteSize;
if (rangeBegin >= updateEnd || rangeEnd <= updateBegin)
continue;
invalids.push_back(range);
}
if (invalids.size()) {
mContext->GeneratePerfWarning("[%p] Invalidating %u/%u ranges.", this,
uint32_t(invalids.size()),
uint32_t(mIndexRanges.size()));
for (const auto& cur : invalids) {
mIndexRanges.erase(cur);
}
}
}
size_t
WebGLBuffer::SizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const
{
size_t size = mallocSizeOf(this);
if (mIndexCache) {
size += mByteLength;
}
return size;
}
template<typename T>
static size_t
MaxForRange(const void* data, size_t first, size_t count, const uint32_t ignoredVal)
{
const T ignoredTVal(ignoredVal);
T ret = 0;
auto itr = (const T*)data + first;
const auto end = itr + count;
for (; itr != end; ++itr) {
const auto& val = *itr;
if (val <= ret)
continue;
if (val == ignoredTVal)
continue;
ret = val;
}
return size_t(ret);
}
const uint32_t kMaxIndexRanges = 256;
bool
WebGLBuffer::ValidateIndexedFetch(GLenum type, uint32_t numFetchable, size_t first,
size_t count) const
{
if (!mIndexCache)
return true;
if (!count)
return true;
const IndexRange range = { type, first, count };
auto res = mIndexRanges.insert({ range, size_t(0) });
if (mIndexRanges.size() > kMaxIndexRanges) {
mContext->GeneratePerfWarning("[%p] Clearing mIndexRanges after exceeding %u.",
this, kMaxIndexRanges);
mIndexRanges.clear();
res = mIndexRanges.insert({ range, size_t(0) });
}
const auto& itr = res.first;
const auto& didInsert = res.second;
auto& maxFetchIndex = itr->second;
if (didInsert) {
const auto& data = mIndexCache.get();
const uint32_t ignoreVal = (mContext->IsWebGL2() ? UINT32_MAX : 0);
switch (type) {
case LOCAL_GL_UNSIGNED_BYTE:
maxFetchIndex = MaxForRange<uint8_t>(data, first, count, ignoreVal);
break;
case LOCAL_GL_UNSIGNED_SHORT:
maxFetchIndex = MaxForRange<uint16_t>(data, first, count, ignoreVal);
break;
case LOCAL_GL_UNSIGNED_INT:
maxFetchIndex = MaxForRange<uint32_t>(data, first, count, ignoreVal);
break;
default:
MOZ_CRASH();
}
mContext->GeneratePerfWarning("[%p] New range #%u: (0x%04x, %u, %u): %u", this,
uint32_t(mIndexRanges.size()), type,
uint32_t(first), uint32_t(count),
uint32_t(maxFetchIndex));
}
return maxFetchIndex < numFetchable;
}
////
bool
WebGLBuffer::ValidateCanBindToTarget(const char* funcName, GLenum target)
{
/* https://www.khronos.org/registry/webgl/specs/latest/2.0/#5.1
*
* In the WebGL 2 API, buffers have their WebGL buffer type
* initially set to undefined. Calling bindBuffer, bindBufferRange
* or bindBufferBase with the target argument set to any buffer
* binding point except COPY_READ_BUFFER or COPY_WRITE_BUFFER will
* then set the WebGL buffer type of the buffer being bound
* according to the table above.
*
* Any call to one of these functions which attempts to bind a
* WebGLBuffer that has the element array WebGL buffer type to a
* binding point that falls under other data, or bind a
* WebGLBuffer which has the other data WebGL buffer type to
* ELEMENT_ARRAY_BUFFER will generate an INVALID_OPERATION error,
* and the state of the binding point will remain untouched.
*/
if (mContent == WebGLBuffer::Kind::Undefined)
return true;
switch (target) {
case LOCAL_GL_COPY_READ_BUFFER:
case LOCAL_GL_COPY_WRITE_BUFFER:
return true;
case LOCAL_GL_ELEMENT_ARRAY_BUFFER:
if (mContent == WebGLBuffer::Kind::ElementArray)
return true;
break;
case LOCAL_GL_ARRAY_BUFFER:
case LOCAL_GL_PIXEL_PACK_BUFFER:
case LOCAL_GL_PIXEL_UNPACK_BUFFER:
case LOCAL_GL_TRANSFORM_FEEDBACK_BUFFER:
case LOCAL_GL_UNIFORM_BUFFER:
if (mContent == WebGLBuffer::Kind::OtherData)
return true;
break;
default:
MOZ_CRASH();
}
const auto dataType = (mContent == WebGLBuffer::Kind::OtherData) ? "other"
: "element";
mContext->ErrorInvalidOperation("%s: Buffer already contains %s data.", funcName,
dataType);
return false;
}
JSObject*
WebGLBuffer::WrapObject(JSContext* cx, JS::Handle<JSObject*> givenProto)
{
return dom::WebGLBufferBinding::Wrap(cx, this, givenProto);
}
NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE_0(WebGLBuffer)
NS_IMPL_CYCLE_COLLECTION_ROOT_NATIVE(WebGLBuffer, AddRef)
NS_IMPL_CYCLE_COLLECTION_UNROOT_NATIVE(WebGLBuffer, Release)
} // namespace mozilla