blob: 9f8a7a2516af3493c03346d2424ba723027705ed [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <GLES2/gl2.h>
#include <map>
#include <queue>
#include <set>
#include <string>
#include <vector>
#include "base/memory/scoped_ptr.h"
#include "gles2_impl_export.h"
#include "gpu/command_buffer/client/buffer_tracker.h"
#include "gpu/command_buffer/client/client_context_state.h"
#include "gpu/command_buffer/client/gles2_cmd_helper.h"
#include "gpu/command_buffer/client/gles2_interface.h"
#include "gpu/command_buffer/client/gpu_memory_buffer_tracker.h"
#include "gpu/command_buffer/client/mapped_memory.h"
#include "gpu/command_buffer/client/query_tracker.h"
#include "gpu/command_buffer/client/ref_counted.h"
#include "gpu/command_buffer/client/ring_buffer.h"
#include "gpu/command_buffer/client/share_group.h"
#include "gpu/command_buffer/common/compiler_specific.h"
#include "gpu/command_buffer/common/debug_marker_manager.h"
#include "gpu/command_buffer/common/gles2_cmd_utils.h"
#if !defined(NDEBUG) && !defined(__native_client__) && !defined(GLES2_CONFORMANCE_TESTS) // NOLINT
// TODO(gman): Replace with macros that work with inline optmization.
#define GPU_CLIENT_LOG(args)
#include "base/logging.h"
#define GPU_CLIENT_SINGLE_THREAD_CHECK() SingleThreadChecker checker(this);
#define GPU_CLIENT_LOG(args) DLOG_IF(INFO, debug_) << args;
#define GPU_CLIENT_LOG_CODE_BLOCK(code) code
#define GPU_CLIENT_LOG(args)
#if defined(GPU_CLIENT_DEBUG)
// Set to 1 to have the client fail when a GL error is generated.
// This helps find bugs in the renderer since the debugger stops on the error.
# if 0
# endif
// Check that destination pointers point to initialized memory.
// When the context is lost, calling GL function has no effect so if destination
// pointers point to initialized memory it can often lead to crash bugs. eg.
// GLsizei len;
// glGetShaderSource(shader, max_size, &len, buffer);
// std::string src(buffer, buffer + len); // len can be uninitialized here!!!
// Because this check is not official GL this check happens only on Chrome code,
// not Pepper.
// If it was up to us we'd just always write to the destination but the OpenGL
// spec defines the behavior of OpenGL functions, not us. :-(
#if defined(__native_client__) || defined(GLES2_CONFORMANCE_TESTS)
#elif defined(GPU_DCHECK)
#elif defined(DCHECK)
(ptr[0] == static_cast<type>(0) || ptr[0] == static_cast<type>(-1)));
(ptr[0] == static_cast<type>(0) || ptr[0] == static_cast<type>(-1)));
struct GLUniformDefinitionCHROMIUM;
namespace gpu {
class GpuControl;
class ScopedTransferBufferPtr;
class TransferBufferInterface;
namespace gles2 {
class ImageFactory;
class VertexArrayObjectManager;
// This class emulates GLES2 over command buffers. It can be used by a client
// program so that the program does not need deal with shared memory and command
// buffer management. See gl2_lib.h. Note that there is a performance gain to
// be had by changing your code to use command buffers directly by using the
// GLES2CmdHelper but that entails changing your code to use and deal with
// shared memory and synchronization issues.
class GLES2_IMPL_EXPORT GLES2Implementation : public GLES2Interface {
enum MappedMemoryLimit {
kNoLimit = MappedMemoryManager::kNoLimit,
class ErrorMessageCallback {
virtual ~ErrorMessageCallback() { }
virtual void OnErrorMessage(const char* msg, int id) = 0;
// Stores GL state that never changes.
struct GLES2_IMPL_EXPORT GLStaticState {
struct GLES2_IMPL_EXPORT IntState {
GLint max_combined_texture_image_units;
GLint max_cube_map_texture_size;
GLint max_fragment_uniform_vectors;
GLint max_renderbuffer_size;
GLint max_texture_image_units;
GLint max_texture_size;
GLint max_varying_vectors;
GLint max_vertex_attribs;
GLint max_vertex_texture_image_units;
GLint max_vertex_uniform_vectors;
GLint num_compressed_texture_formats;
GLint num_shader_binary_formats;
IntState int_state;
typedef std::pair<GLenum,GLenum> ShaderPrecisionKey;
typedef std::map<ShaderPrecisionKey,
ShaderPrecisionMap shader_precisions;
// The maxiumum result size from simple GL get commands.
static const size_t kMaxSizeOfSimpleResult = 16 * sizeof(uint32); // NOLINT.
// used for testing only. If more things are reseved add them here.
static const unsigned int kStartingOffset = kMaxSizeOfSimpleResult;
// Size in bytes to issue async flush for transfer buffer.
static const unsigned int kSizeToFlush = 256 * 1024;
// The bucket used for results. Public for testing only.
static const uint32 kResultBucketId = 1;
// Alignment of allocations.
static const unsigned int kAlignment = 4;
// GL names for the buffers used to emulate client side buffers.
static const GLuint kClientSideArrayId = 0xFEDCBA98u;
static const GLuint kClientSideElementArrayId = 0xFEDCBA99u;
// Number of swap buffers allowed before waiting.
static const size_t kMaxSwapBuffers = 2;
GLES2CmdHelper* helper,
ShareGroup* share_group,
TransferBufferInterface* transfer_buffer,
bool bind_generates_resource,
GpuControl* gpu_control);
virtual ~GLES2Implementation();
bool Initialize(
unsigned int starting_transfer_buffer_size,
unsigned int min_transfer_buffer_size,
unsigned int max_transfer_buffer_size,
unsigned int mapped_memory_limit);
// The GLES2CmdHelper being used by this GLES2Implementation. You can use
// this to issue cmds at a lower level for certain kinds of optimization.
GLES2CmdHelper* helper() const;
// Gets client side generated errors.
GLenum GetClientSideGLError();
// Include the auto-generated part of this class. We split this because
// it means we can easily edit the non-auto generated parts right here in
// this file instead of having to edit some template or the code generator.
#include "gpu/command_buffer/client/gles2_implementation_autogen.h"
virtual void DisableVertexAttribArray(GLuint index) OVERRIDE;
virtual void EnableVertexAttribArray(GLuint index) OVERRIDE;
virtual void GetVertexAttribfv(
GLuint index, GLenum pname, GLfloat* params) OVERRIDE;
virtual void GetVertexAttribiv(
GLuint index, GLenum pname, GLint* params) OVERRIDE;
void GetProgramInfoCHROMIUMHelper(GLuint program, std::vector<int8>* result);
GLint GetAttribLocationHelper(GLuint program, const char* name);
GLint GetUniformLocationHelper(GLuint program, const char* name);
bool GetActiveAttribHelper(
GLuint program, GLuint index, GLsizei bufsize, GLsizei* length,
GLint* size, GLenum* type, char* name);
bool GetActiveUniformHelper(
GLuint program, GLuint index, GLsizei bufsize, GLsizei* length,
GLint* size, GLenum* type, char* name);
void FreeUnusedSharedMemory();
void FreeEverything();
void SetErrorMessageCallback(ErrorMessageCallback* callback) {
error_message_callback_ = callback;
ShareGroup* share_group() const {
return share_group_.get();
friend class GLES2ImplementationTest;
friend class VertexArrayObjectManager;
// Used to track whether an extension is available
enum ExtensionStatus {
// Base class for mapped resources.
struct MappedResource {
MappedResource(GLenum _access, int _shm_id, void* mem, unsigned int offset)
: access(_access),
shm_offset(offset) {
// access mode. Currently only GL_WRITE_ONLY is valid
GLenum access;
// Shared memory ID for buffer.
int shm_id;
// Address of shared memory
void* shm_memory;
// Offset of shared memory
unsigned int shm_offset;
// Used to track mapped textures.
struct MappedTexture : public MappedResource {
GLenum access,
int shm_id,
void* shm_mem,
unsigned int shm_offset,
GLenum _target,
GLint _level,
GLint _xoffset,
GLint _yoffset,
GLsizei _width,
GLsizei _height,
GLenum _format,
GLenum _type)
: MappedResource(access, shm_id, shm_mem, shm_offset),
type(_type) {
// These match the arguments to TexSubImage2D.
GLenum target;
GLint level;
GLint xoffset;
GLint yoffset;
GLsizei width;
GLsizei height;
GLenum format;
GLenum type;
// Used to track mapped buffers.
struct MappedBuffer : public MappedResource {
GLenum access,
int shm_id,
void* shm_mem,
unsigned int shm_offset,
GLenum _target,
GLintptr _offset,
GLsizeiptr _size)
: MappedResource(access, shm_id, shm_mem, shm_offset),
size(_size) {
// These match the arguments to BufferSubData.
GLenum target;
GLintptr offset;
GLsizeiptr size;
struct TextureUnit {
: bound_texture_2d(0),
bound_texture_cube_map(0) {
// texture currently bound to this unit's GL_TEXTURE_2D with glBindTexture
GLuint bound_texture_2d;
// texture currently bound to this unit's GL_TEXTURE_CUBE_MAP with
// glBindTexture
GLuint bound_texture_cube_map;
// Checks for single threaded access.
class SingleThreadChecker {
SingleThreadChecker(GLES2Implementation* gles2_implementation);
GLES2Implementation* gles2_implementation_;
// Gets the value of the result.
template <typename T>
T GetResultAs() {
return static_cast<T>(GetResultBuffer());
void* GetResultBuffer();
int32 GetResultShmId();
uint32 GetResultShmOffset();
bool QueryAndCacheStaticState();
// Helpers used to batch synchronous GetIntergerv calls with other
// synchronous calls.
struct GetMultipleIntegervState {
GetMultipleIntegervState(const GLenum* pnames, GLuint pnames_count,
GLint* results, GLsizeiptr results_size)
: pnames(pnames),
{ }
// inputs
const GLenum* pnames;
GLuint pnames_count;
// outputs
GLint* results;
GLsizeiptr results_size;
// transfer buffer
int num_results;
int transfer_buffer_size_needed;
void* buffer;
void* results_buffer;
bool GetMultipleIntegervSetup(
GetMultipleIntegervState* state);
void GetMultipleIntegervRequest(
GetMultipleIntegervState* state);
void GetMultipleIntegervOnCompleted(
GetMultipleIntegervState* state);
// Helpers used to batch synchronous GetShaderPrecision calls with other
// synchronous calls.
struct GetAllShaderPrecisionFormatsState {
const GLenum (*precision_params)[2],
int precision_params_count)
: precision_params(precision_params),
{ }
const GLenum (*precision_params)[2];
int precision_params_count;
int transfer_buffer_size_needed;
void* results_buffer;
void GetAllShaderPrecisionFormatsSetup(
GetAllShaderPrecisionFormatsState* state);
void GetAllShaderPrecisionFormatsRequest(
GetAllShaderPrecisionFormatsState* state);
void GetAllShaderPrecisionFormatsOnCompleted(
GetAllShaderPrecisionFormatsState* state);
// Lazily determines if GL_ANGLE_pack_reverse_row_order is available
bool IsAnglePackReverseRowOrderAvailable();
bool IsChromiumFramebufferMultisampleAvailable();
bool IsExtensionAvailableHelper(
const char* extension, ExtensionStatus* status);
// Gets the GLError through our wrapper.
GLenum GetGLError();
// Sets our wrapper for the GLError.
void SetGLError(GLenum error, const char* function_name, const char* msg);
void SetGLErrorInvalidEnum(
const char* function_name, GLenum value, const char* label);
// Returns the last error and clears it. Useful for debugging.
const std::string& GetLastError() {
return last_error_;
// Waits for all commands to execute.
void WaitForCmd();
// TODO(gman): These bucket functions really seem like they belong in
// CommandBufferHelper (or maybe BucketHelper?). Unfortunately they need
// a transfer buffer to function which is currently managed by this class.
// Gets the contents of a bucket.
bool GetBucketContents(uint32 bucket_id, std::vector<int8>* data);
// Sets the contents of a bucket.
void SetBucketContents(uint32 bucket_id, const void* data, size_t size);
// Sets the contents of a bucket as a string.
void SetBucketAsCString(uint32 bucket_id, const char* str);
// Gets the contents of a bucket as a string. Returns false if there is no
// string available which is a separate case from the empty string.
bool GetBucketAsString(uint32 bucket_id, std::string* str);
// Sets the contents of a bucket as a string.
void SetBucketAsString(uint32 bucket_id, const std::string& str);
// Returns true if id is reserved.
bool IsBufferReservedId(GLuint id);
bool IsFramebufferReservedId(GLuint id) { return false; }
bool IsRenderbufferReservedId(GLuint id) { return false; }
bool IsTextureReservedId(GLuint id) { return false; }
bool IsVertexArrayReservedId(GLuint id) { return false; }
bool BindBufferHelper(GLenum target, GLuint texture);
bool BindFramebufferHelper(GLenum target, GLuint texture);
bool BindRenderbufferHelper(GLenum target, GLuint texture);
bool BindTextureHelper(GLenum target, GLuint texture);
bool BindVertexArrayHelper(GLuint array);
void GenBuffersHelper(GLsizei n, const GLuint* buffers);
void GenFramebuffersHelper(GLsizei n, const GLuint* framebuffers);
void GenRenderbuffersHelper(GLsizei n, const GLuint* renderbuffers);
void GenTexturesHelper(GLsizei n, const GLuint* textures);
void GenVertexArraysOESHelper(GLsizei n, const GLuint* arrays);
void GenQueriesEXTHelper(GLsizei n, const GLuint* queries);
void DeleteBuffersHelper(GLsizei n, const GLuint* buffers);
void DeleteFramebuffersHelper(GLsizei n, const GLuint* framebuffers);
void DeleteRenderbuffersHelper(GLsizei n, const GLuint* renderbuffers);
void DeleteTexturesHelper(GLsizei n, const GLuint* textures);
bool DeleteProgramHelper(GLuint program);
bool DeleteShaderHelper(GLuint shader);
void DeleteQueriesEXTHelper(GLsizei n, const GLuint* queries);
void DeleteVertexArraysOESHelper(GLsizei n, const GLuint* arrays);
void DeleteBuffersStub(GLsizei n, const GLuint* buffers);
void DeleteFramebuffersStub(GLsizei n, const GLuint* framebuffers);
void DeleteRenderbuffersStub(GLsizei n, const GLuint* renderbuffers);
void DeleteTexturesStub(GLsizei n, const GLuint* textures);
void DeleteProgramStub(GLsizei n, const GLuint* programs);
void DeleteShaderStub(GLsizei n, const GLuint* shaders);
// TODO(gman): Remove this as queries are not shared.
void DeleteQueriesStub(GLsizei n, const GLuint* queries);
void DeleteVertexArraysOESStub(GLsizei n, const GLuint* arrays);
void BufferDataHelper(
GLenum target, GLsizeiptr size, const void* data, GLenum usage);
void BufferSubDataHelper(
GLenum target, GLintptr offset, GLsizeiptr size, const void* data);
void BufferSubDataHelperImpl(
GLenum target, GLintptr offset, GLsizeiptr size, const void* data,
ScopedTransferBufferPtr* buffer);
GLuint CreateImageCHROMIUMHelper(
GLsizei width, GLsizei height, GLenum internalformat);
void DestroyImageCHROMIUMHelper(GLuint image_id);
void* MapImageCHROMIUMHelper(GLuint image_id, GLenum access);
void UnmapImageCHROMIUMHelper(GLuint image_id);
void GetImageParameterivCHROMIUMHelper(
GLuint image_id, GLenum pname, GLint* params);
// Helper for GetVertexAttrib
bool GetVertexAttribHelper(GLuint index, GLenum pname, uint32* param);
GLuint GetMaxValueInBufferCHROMIUMHelper(
GLuint buffer_id, GLsizei count, GLenum type, GLuint offset);
void RestoreElementAndArrayBuffers(bool restore);
void RestoreArrayBuffer(bool restrore);
// The pixels pointer should already account for unpack skip rows and skip
// pixels.
void TexSubImage2DImpl(
GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width,
GLsizei height, GLenum format, GLenum type, uint32 unpadded_row_size,
const void* pixels, uint32 pixels_padded_row_size, GLboolean internal,
ScopedTransferBufferPtr* buffer, uint32 buffer_padded_row_size);
// Helpers for query functions.
bool GetHelper(GLenum pname, GLint* params);
bool GetBooleanvHelper(GLenum pname, GLboolean* params);
bool GetBufferParameterivHelper(GLenum target, GLenum pname, GLint* params);
bool GetFloatvHelper(GLenum pname, GLfloat* params);
bool GetFramebufferAttachmentParameterivHelper(
GLenum target, GLenum attachment, GLenum pname, GLint* params);
bool GetIntegervHelper(GLenum pname, GLint* params);
bool GetProgramivHelper(GLuint program, GLenum pname, GLint* params);
bool GetRenderbufferParameterivHelper(
GLenum target, GLenum pname, GLint* params);
bool GetShaderivHelper(GLuint shader, GLenum pname, GLint* params);
bool GetTexParameterfvHelper(GLenum target, GLenum pname, GLfloat* params);
bool GetTexParameterivHelper(GLenum target, GLenum pname, GLint* params);
const GLubyte* GetStringHelper(GLenum name);
bool IsExtensionAvailable(const char* ext);
// Caches certain capabilties state. Return true if cached.
bool SetCapabilityState(GLenum cap, bool enabled);
IdHandlerInterface* GetIdHandler(int id_namespace) const;
void FinishHelper();
// Asserts that the context is lost.
// NOTE: This is an expensive call and should only be called
// for error checking.
bool MustBeContextLost();
bool GetBoundPixelTransferBuffer(
GLenum target, const char* function_name, GLuint* buffer_id);
BufferTracker::Buffer* GetBoundPixelUnpackTransferBufferIfValid(
GLuint buffer_id,
const char* function_name, GLuint offset, GLsizei size);
const std::string& GetLogPrefix() const;
void CheckGLError();
void FailGLError(GLenum error);
void CheckGLError() { }
void FailGLError(GLenum /* error */) { }
GLES2Util util_;
GLES2CmdHelper* helper_;
TransferBufferInterface* transfer_buffer_;
std::string last_error_;
DebugMarkerManager debug_marker_manager_;
std::string this_in_hex_;
std::queue<int32> swap_buffers_tokens_;
std::queue<int32> rate_limit_tokens_;
ExtensionStatus angle_pack_reverse_row_order_status_;
ExtensionStatus chromium_framebuffer_multisample_;
GLStaticState static_state_;
ClientContextState state_;
// pack alignment as last set by glPixelStorei
GLint pack_alignment_;
// unpack alignment as last set by glPixelStorei
GLint unpack_alignment_;
// unpack yflip as last set by glPixelstorei
bool unpack_flip_y_;
// unpack row length as last set by glPixelStorei
GLint unpack_row_length_;
// unpack skip rows as last set by glPixelStorei
GLint unpack_skip_rows_;
// unpack skip pixels as last set by glPixelStorei
GLint unpack_skip_pixels_;
// pack reverse row order as last set by glPixelstorei
bool pack_reverse_row_order_;
scoped_ptr<TextureUnit[]> texture_units_;
// 0 to gl_state_.max_combined_texture_image_units.
GLuint active_texture_unit_;
GLuint bound_framebuffer_;
GLuint bound_read_framebuffer_;
GLuint bound_renderbuffer_;
// The program in use by glUseProgram
GLuint current_program_;
// The currently bound array buffer.
GLuint bound_array_buffer_id_;
// The currently bound pixel transfer buffers.
GLuint bound_pixel_pack_transfer_buffer_id_;
GLuint bound_pixel_unpack_transfer_buffer_id_;
// Client side management for vertex array objects. Needed to correctly
// track client side arrays.
scoped_ptr<VertexArrayObjectManager> vertex_array_object_manager_;
GLuint reserved_ids_[2];
// Current GL error bits.
uint32 error_bits_;
// Whether or not to print debugging info.
bool debug_;
// Used to check for single threaded access.
int use_count_;
// Map of GLenum to Strings for glGetString. We need to cache these because
// the pointer passed back to the client has to remain valid for eternity.
typedef std::map<uint32, std::set<std::string> > GLStringMap;
GLStringMap gl_strings_;
// Similar cache for glGetRequestableExtensionsCHROMIUM. We don't
// have an enum for this so handle it separately.
std::set<std::string> requestable_extensions_set_;
typedef std::map<const void*, MappedBuffer> MappedBufferMap;
MappedBufferMap mapped_buffers_;
typedef std::map<const void*, MappedTexture> MappedTextureMap;
MappedTextureMap mapped_textures_;
scoped_ptr<MappedMemoryManager> mapped_memory_;
scoped_refptr<ShareGroup> share_group_;
scoped_ptr<QueryTracker> query_tracker_;
QueryTracker::Query* current_query_;
scoped_ptr<BufferTracker> buffer_tracker_;
scoped_ptr<GpuMemoryBufferTracker> gpu_memory_buffer_tracker_;
ErrorMessageCallback* error_message_callback_;
scoped_ptr<std::string> current_trace_name_;
GpuControl* gpu_control_;
inline bool GLES2Implementation::GetBufferParameterivHelper(
GLenum /* target */, GLenum /* pname */, GLint* /* params */) {
return false;
inline bool GLES2Implementation::GetFramebufferAttachmentParameterivHelper(
GLenum /* target */,
GLenum /* attachment */,
GLenum /* pname */,
GLint* /* params */) {
return false;
inline bool GLES2Implementation::GetRenderbufferParameterivHelper(
GLenum /* target */, GLenum /* pname */, GLint* /* params */) {
return false;
inline bool GLES2Implementation::GetShaderivHelper(
GLuint /* shader */, GLenum /* pname */, GLint* /* params */) {
return false;
inline bool GLES2Implementation::GetTexParameterfvHelper(
GLenum /* target */, GLenum /* pname */, GLfloat* /* params */) {
return false;
inline bool GLES2Implementation::GetTexParameterivHelper(
GLenum /* target */, GLenum /* pname */, GLint* /* params */) {
return false;
} // namespace gles2
} // namespace gpu