1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_UNITTEST_BASE_H_
6 #define GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_UNITTEST_BASE_H_
8 #include "gpu/command_buffer/common/gles2_cmd_format.h"
9 #include "gpu/command_buffer/common/gles2_cmd_utils.h"
10 #include "gpu/command_buffer/service/buffer_manager.h"
11 #include "gpu/command_buffer/service/cmd_buffer_engine.h"
12 #include "gpu/command_buffer/service/context_group.h"
13 #include "gpu/command_buffer/service/framebuffer_manager.h"
14 #include "gpu/command_buffer/service/gles2_cmd_decoder.h"
15 #include "gpu/command_buffer/service/gles2_cmd_decoder_mock.h"
16 #include "gpu/command_buffer/service/program_manager.h"
17 #include "gpu/command_buffer/service/query_manager.h"
18 #include "gpu/command_buffer/service/renderbuffer_manager.h"
19 #include "gpu/command_buffer/service/shader_manager.h"
20 #include "gpu/command_buffer/service/test_helper.h"
21 #include "gpu/command_buffer/service/texture_manager.h"
22 #include "gpu/command_buffer/service/vertex_array_manager.h"
23 #include "testing/gtest/include/gtest/gtest.h"
24 #include "ui/gl/gl_context_stub_with_extensions.h"
25 #include "ui/gl/gl_surface_stub.h"
26 #include "ui/gl/gl_mock.h"
37 class GLES2DecoderTestBase : public testing::Test {
39 GLES2DecoderTestBase();
40 virtual ~GLES2DecoderTestBase();
42 // Template to call glGenXXX functions.
44 void GenHelper(GLuint client_id) {
45 int8 buffer[sizeof(T) + sizeof(client_id)];
46 T& cmd = *reinterpret_cast<T*>(&buffer);
47 cmd.Init(1, &client_id);
48 EXPECT_EQ(error::kNoError,
49 ExecuteImmediateCmd(cmd, sizeof(client_id)));
52 // This template exists solely so we can specialize it for
54 template <typename T, int id>
55 void SpecializedSetup(bool valid) {
60 return reinterpret_cast<T*>(immediate_buffer_);
63 template <typename T, typename Command>
64 T GetImmediateDataAs(Command* cmd) {
65 return reinterpret_cast<T>(ImmediateDataAddress(cmd));
68 void ClearSharedMemory() {
69 engine_->ClearSharedMemory();
72 virtual void SetUp() OVERRIDE;
73 virtual void TearDown() OVERRIDE;
76 error::Error ExecuteCmd(const T& cmd) {
77 COMPILE_ASSERT(T::kArgFlags == cmd::kFixed, Cmd_kArgFlags_not_kFixed);
78 return decoder_->DoCommand(cmd.kCmdId,
79 ComputeNumEntries(sizeof(cmd)) - 1,
84 error::Error ExecuteImmediateCmd(const T& cmd, size_t data_size) {
85 COMPILE_ASSERT(T::kArgFlags == cmd::kAtLeastN, Cmd_kArgFlags_not_kAtLeastN);
86 return decoder_->DoCommand(cmd.kCmdId,
87 ComputeNumEntries(sizeof(cmd) + data_size) - 1,
92 T GetSharedMemoryAs() {
93 return reinterpret_cast<T>(shared_memory_address_);
97 T GetSharedMemoryAsWithOffset(uint32 offset) {
98 void* ptr = reinterpret_cast<int8*>(shared_memory_address_) + offset;
99 return reinterpret_cast<T>(ptr);
102 IdAllocatorInterface* GetIdAllocator(GLuint namespace_id) {
103 return group_->GetIdAllocator(namespace_id);
106 Buffer* GetBuffer(GLuint service_id) {
107 return group_->buffer_manager()->GetBuffer(service_id);
110 Framebuffer* GetFramebuffer(GLuint service_id) {
111 return group_->framebuffer_manager()->GetFramebuffer(service_id);
114 Renderbuffer* GetRenderbuffer(
116 return group_->renderbuffer_manager()->GetRenderbuffer(service_id);
119 TextureRef* GetTexture(GLuint client_id) {
120 return group_->texture_manager()->GetTexture(client_id);
123 Shader* GetShader(GLuint client_id) {
124 return group_->shader_manager()->GetShader(client_id);
127 Program* GetProgram(GLuint client_id) {
128 return group_->program_manager()->GetProgram(client_id);
131 QueryManager::Query* GetQueryInfo(GLuint client_id) {
132 return decoder_->GetQueryManager()->GetQuery(client_id);
135 // This name doesn't match the underlying function, but doing it this way
136 // prevents the need to special-case the unit test generation
137 VertexAttribManager* GetVertexArrayInfo(GLuint client_id) {
138 return decoder_->GetVertexArrayManager()->GetVertexAttribManager(client_id);
141 ProgramManager* program_manager() {
142 return group_->program_manager();
145 void DoCreateProgram(GLuint client_id, GLuint service_id);
146 void DoCreateShader(GLenum shader_type, GLuint client_id, GLuint service_id);
148 void SetBucketAsCString(uint32 bucket_id, const char* str);
150 void set_memory_tracker(MemoryTracker* memory_tracker) {
151 memory_tracker_ = memory_tracker;
157 std::string extensions;
158 std::string gl_version;
164 bool request_stencil;
165 bool bind_generates_resource;
166 bool lose_context_when_out_of_memory;
169 void InitDecoder(const InitState& init);
170 void InitDecoderWithCommandLine(const InitState& init,
171 const base::CommandLine* command_line);
175 const ContextGroup& group() const {
176 return *group_.get();
179 ::testing::StrictMock< ::gfx::MockGLInterface>* GetGLMock() const {
183 GLES2Decoder* GetDecoder() const {
184 return decoder_.get();
187 typedef TestHelper::AttribInfo AttribInfo;
188 typedef TestHelper::UniformInfo UniformInfo;
191 AttribInfo* attribs, size_t num_attribs,
192 UniformInfo* uniforms, size_t num_uniforms,
193 GLuint client_id, GLuint service_id,
194 GLuint vertex_shader_client_id, GLuint vertex_shader_service_id,
195 GLuint fragment_shader_client_id, GLuint fragment_shader_service_id);
197 void SetupInitCapabilitiesExpectations();
198 void SetupInitStateExpectations();
199 void ExpectEnableDisable(GLenum cap, bool enable);
201 // Setups up a shader for testing glUniform.
202 void SetupShaderForUniform(GLenum uniform_type);
203 void SetupDefaultProgram();
204 void SetupCubemapProgram();
205 void SetupSamplerExternalProgram();
208 // Note that the error is returned as GLint instead of GLenum.
209 // This is because there is a mismatch in the types of GLenum and
210 // the error values GL_NO_ERROR, GL_INVALID_ENUM, etc. GLenum is
211 // typedef'd as unsigned int while the error values are defined as
212 // integers. This is problematic for template functions such as
213 // EXPECT_EQ that expect both types to be the same.
216 void DoBindBuffer(GLenum target, GLuint client_id, GLuint service_id);
217 void DoBindFramebuffer(GLenum target, GLuint client_id, GLuint service_id);
218 void DoBindRenderbuffer(GLenum target, GLuint client_id, GLuint service_id);
219 void DoBindTexture(GLenum target, GLuint client_id, GLuint service_id);
220 void DoBindVertexArrayOES(GLuint client_id, GLuint service_id);
222 bool DoIsBuffer(GLuint client_id);
223 bool DoIsFramebuffer(GLuint client_id);
224 bool DoIsProgram(GLuint client_id);
225 bool DoIsRenderbuffer(GLuint client_id);
226 bool DoIsShader(GLuint client_id);
227 bool DoIsTexture(GLuint client_id);
229 void DoDeleteBuffer(GLuint client_id, GLuint service_id);
230 void DoDeleteFramebuffer(
231 GLuint client_id, GLuint service_id,
232 bool reset_draw, GLenum draw_target, GLuint draw_id,
233 bool reset_read, GLenum read_target, GLuint read_id);
234 void DoDeleteProgram(GLuint client_id, GLuint service_id);
235 void DoDeleteRenderbuffer(GLuint client_id, GLuint service_id);
236 void DoDeleteShader(GLuint client_id, GLuint service_id);
237 void DoDeleteTexture(GLuint client_id, GLuint service_id);
239 void DoCompressedTexImage2D(
240 GLenum target, GLint level, GLenum format,
241 GLsizei width, GLsizei height, GLint border,
242 GLsizei size, uint32 bucket_id);
244 GLenum target, GLint level, GLenum internal_format,
245 GLsizei width, GLsizei height, GLint border,
246 GLenum format, GLenum type,
247 uint32 shared_memory_id, uint32 shared_memory_offset);
248 void DoTexImage2DConvertInternalFormat(
249 GLenum target, GLint level, GLenum requested_internal_format,
250 GLsizei width, GLsizei height, GLint border,
251 GLenum format, GLenum type,
252 uint32 shared_memory_id, uint32 shared_memory_offset,
253 GLenum expected_internal_format);
254 void DoRenderbufferStorage(
255 GLenum target, GLenum internal_format, GLenum actual_format,
256 GLsizei width, GLsizei height, GLenum error);
257 void DoFramebufferRenderbuffer(
260 GLenum renderbuffer_target,
261 GLuint renderbuffer_client_id,
262 GLuint renderbuffer_service_id,
264 void DoFramebufferTexture2D(
265 GLenum target, GLenum attachment, GLenum tex_target,
266 GLuint texture_client_id, GLuint texture_service_id,
267 GLint level, GLenum error);
268 void DoVertexAttribPointer(
269 GLuint index, GLint size, GLenum type, GLsizei stride, GLuint offset);
270 void DoVertexAttribDivisorANGLE(GLuint index, GLuint divisor);
272 void DoEnableVertexAttribArray(GLint index);
274 void DoBufferData(GLenum target, GLsizei size);
276 void DoBufferSubData(
277 GLenum target, GLint offset, GLsizei size, const void* data);
279 void SetupVertexBuffer();
280 void SetupAllNeededVertexBuffers();
282 void SetupIndexBuffer();
284 void DeleteVertexBuffer();
286 void DeleteIndexBuffer();
288 void SetupClearTextureExpectations(
290 GLuint old_service_id,
294 GLenum internal_format,
300 void SetupExpectationsForRestoreClearState(
301 GLclampf restore_red,
302 GLclampf restore_green,
303 GLclampf restore_blue,
304 GLclampf restore_alpha,
305 GLuint restore_stencil,
306 GLclampf restore_depth,
307 bool restore_scissor_test);
309 void SetupExpectationsForFramebufferClearing(
312 GLclampf restore_red,
313 GLclampf restore_green,
314 GLclampf restore_blue,
315 GLclampf restore_alpha,
316 GLuint restore_stencil,
317 GLclampf restore_depth,
318 bool restore_scissor_test);
320 void SetupExpectationsForFramebufferClearingMulti(
321 GLuint read_framebuffer_service_id,
322 GLuint draw_framebuffer_service_id,
325 GLclampf restore_red,
326 GLclampf restore_green,
327 GLclampf restore_blue,
328 GLclampf restore_alpha,
329 GLuint restore_stencil,
330 GLclampf restore_depth,
331 bool restore_scissor_test);
333 void SetupExpectationsForApplyingDirtyState(
334 bool framebuffer_is_rgb,
335 bool framebuffer_has_depth,
336 bool framebuffer_has_stencil,
337 GLuint color_bits, // NOTE! bits are 0x1000, 0x0100, 0x0010, and 0x0001
340 GLuint front_stencil_mask,
341 GLuint back_stencil_mask,
342 bool stencil_enabled,
343 bool cull_face_enabled,
344 bool scissor_test_enabled,
347 void SetupExpectationsForApplyingDefaultDirtyState();
349 void AddExpectationsForSimulatedAttrib0WithError(
350 GLsizei num_vertices, GLuint buffer_id, GLenum error);
352 void AddExpectationsForSimulatedAttrib0(
353 GLsizei num_vertices, GLuint buffer_id);
355 void AddExpectationsForGenVertexArraysOES();
356 void AddExpectationsForDeleteVertexArraysOES();
357 void AddExpectationsForBindVertexArrayOES();
358 void AddExpectationsForRestoreAttribState(GLuint attrib);
360 GLvoid* BufferOffset(unsigned i) {
361 return static_cast<int8 *>(NULL)+(i);
364 template <typename Command, typename Result>
365 bool IsObjectHelper(GLuint client_id) {
366 Result* result = static_cast<Result*>(shared_memory_address_);
368 cmd.Init(client_id, kSharedMemoryId, kSharedMemoryOffset);
369 EXPECT_EQ(error::kNoError, ExecuteCmd(cmd));
370 bool isObject = static_cast<bool>(*result);
371 EXPECT_EQ(GL_NO_ERROR, GetGLError());
376 static const int kBackBufferWidth = 128;
377 static const int kBackBufferHeight = 64;
379 static const GLint kMaxTextureSize = 2048;
380 static const GLint kMaxCubeMapTextureSize = 256;
381 static const GLint kNumVertexAttribs = 16;
382 static const GLint kNumTextureUnits = 8;
383 static const GLint kMaxTextureImageUnits = 8;
384 static const GLint kMaxVertexTextureImageUnits = 2;
385 static const GLint kMaxFragmentUniformVectors = 16;
386 static const GLint kMaxVaryingVectors = 8;
387 static const GLint kMaxVertexUniformVectors = 128;
388 static const GLint kMaxViewportWidth = 8192;
389 static const GLint kMaxViewportHeight = 8192;
391 static const GLint kViewportX = 0;
392 static const GLint kViewportY = 0;
393 static const GLint kViewportWidth = kBackBufferWidth;
394 static const GLint kViewportHeight = kBackBufferHeight;
396 static const GLuint kServiceAttrib0BufferId = 801;
397 static const GLuint kServiceFixedAttribBufferId = 802;
399 static const GLuint kServiceBufferId = 301;
400 static const GLuint kServiceFramebufferId = 302;
401 static const GLuint kServiceRenderbufferId = 303;
402 static const GLuint kServiceTextureId = 304;
403 static const GLuint kServiceProgramId = 305;
404 static const GLuint kServiceShaderId = 306;
405 static const GLuint kServiceElementBufferId = 308;
406 static const GLuint kServiceQueryId = 309;
407 static const GLuint kServiceVertexArrayId = 310;
409 static const int32 kSharedMemoryId = 401;
410 static const size_t kSharedBufferSize = 2048;
411 static const uint32 kSharedMemoryOffset = 132;
412 static const int32 kInvalidSharedMemoryId = 402;
413 static const uint32 kInvalidSharedMemoryOffset = kSharedBufferSize + 1;
414 static const uint32 kInitialResult = 0xBDBDBDBDu;
415 static const uint8 kInitialMemoryValue = 0xBDu;
417 static const uint32 kNewClientId = 501;
418 static const uint32 kNewServiceId = 502;
419 static const uint32 kInvalidClientId = 601;
421 static const GLuint kServiceVertexShaderId = 321;
422 static const GLuint kServiceFragmentShaderId = 322;
424 static const GLuint kServiceCopyTextureChromiumShaderId = 701;
425 static const GLuint kServiceCopyTextureChromiumProgramId = 721;
427 static const GLuint kServiceCopyTextureChromiumTextureBufferId = 751;
428 static const GLuint kServiceCopyTextureChromiumVertexBufferId = 752;
429 static const GLuint kServiceCopyTextureChromiumFBOId = 753;
430 static const GLuint kServiceCopyTextureChromiumPositionAttrib = 761;
431 static const GLuint kServiceCopyTextureChromiumTexAttrib = 762;
432 static const GLuint kServiceCopyTextureChromiumSamplerLocation = 763;
434 static const GLsizei kNumVertices = 100;
435 static const GLsizei kNumIndices = 10;
436 static const int kValidIndexRangeStart = 1;
437 static const int kValidIndexRangeCount = 7;
438 static const int kInvalidIndexRangeStart = 0;
439 static const int kInvalidIndexRangeCount = 7;
440 static const int kOutOfRangeIndexRangeEnd = 10;
441 static const GLuint kMaxValidIndex = 7;
443 static const GLint kMaxAttribLength = 10;
444 static const char* kAttrib1Name;
445 static const char* kAttrib2Name;
446 static const char* kAttrib3Name;
447 static const GLint kAttrib1Size = 1;
448 static const GLint kAttrib2Size = 1;
449 static const GLint kAttrib3Size = 1;
450 static const GLint kAttrib1Location = 0;
451 static const GLint kAttrib2Location = 1;
452 static const GLint kAttrib3Location = 2;
453 static const GLenum kAttrib1Type = GL_FLOAT_VEC4;
454 static const GLenum kAttrib2Type = GL_FLOAT_VEC2;
455 static const GLenum kAttrib3Type = GL_FLOAT_VEC3;
456 static const GLint kInvalidAttribLocation = 30;
457 static const GLint kBadAttribIndex = kNumVertexAttribs;
459 static const GLint kMaxUniformLength = 12;
460 static const char* kUniform1Name;
461 static const char* kUniform2Name;
462 static const char* kUniform3Name;
463 static const GLint kUniform1Size = 1;
464 static const GLint kUniform2Size = 3;
465 static const GLint kUniform3Size = 2;
466 static const GLint kUniform1RealLocation = 3;
467 static const GLint kUniform2RealLocation = 10;
468 static const GLint kUniform2ElementRealLocation = 12;
469 static const GLint kUniform3RealLocation = 20;
470 static const GLint kUniform1FakeLocation = 0; // These are
471 static const GLint kUniform2FakeLocation = 1; // hardcoded
472 static const GLint kUniform2ElementFakeLocation = 0x10001; // to match
473 static const GLint kUniform3FakeLocation = 2; // ProgramManager.
474 static const GLint kUniform1DesiredLocation = -1;
475 static const GLint kUniform2DesiredLocation = -1;
476 static const GLint kUniform3DesiredLocation = -1;
477 static const GLenum kUniform1Type = GL_SAMPLER_2D;
478 static const GLenum kUniform2Type = GL_INT_VEC2;
479 static const GLenum kUniform3Type = GL_FLOAT_VEC3;
480 static const GLenum kUniformSamplerExternalType = GL_SAMPLER_EXTERNAL_OES;
481 static const GLenum kUniformCubemapType = GL_SAMPLER_CUBE;
482 static const GLint kInvalidUniformLocation = 30;
483 static const GLint kBadUniformIndex = 1000;
485 // Use StrictMock to make 100% sure we know how GL will be called.
486 scoped_ptr< ::testing::StrictMock< ::gfx::MockGLInterface> > gl_;
487 scoped_refptr<gfx::GLSurfaceStub> surface_;
488 scoped_refptr<gfx::GLContextStubWithExtensions> context_;
489 scoped_ptr<MockGLES2Decoder> mock_decoder_;
490 scoped_ptr<GLES2Decoder> decoder_;
491 MemoryTracker* memory_tracker_;
493 GLuint client_buffer_id_;
494 GLuint client_framebuffer_id_;
495 GLuint client_program_id_;
496 GLuint client_renderbuffer_id_;
497 GLuint client_shader_id_;
498 GLuint client_texture_id_;
499 GLuint client_element_buffer_id_;
500 GLuint client_vertex_shader_id_;
501 GLuint client_fragment_shader_id_;
502 GLuint client_query_id_;
503 GLuint client_vertexarray_id_;
505 uint32 shared_memory_id_;
506 uint32 shared_memory_offset_;
507 void* shared_memory_address_;
508 void* shared_memory_base_;
510 int8 immediate_buffer_[256];
513 class MockCommandBufferEngine : public CommandBufferEngine {
515 MockCommandBufferEngine();
517 virtual ~MockCommandBufferEngine();
519 virtual scoped_refptr<gpu::Buffer> GetSharedMemoryBuffer(int32 shm_id)
522 void ClearSharedMemory() {
523 memset(valid_buffer_->memory(), kInitialMemoryValue, kSharedBufferSize);
526 virtual void set_token(int32 token) OVERRIDE;
528 virtual bool SetGetBuffer(int32 /* transfer_buffer_id */) OVERRIDE;
530 // Overridden from CommandBufferEngine.
531 virtual bool SetGetOffset(int32 offset) OVERRIDE;
533 // Overridden from CommandBufferEngine.
534 virtual int32 GetGetOffset() OVERRIDE;
537 scoped_refptr<gpu::Buffer> valid_buffer_;
538 scoped_refptr<gpu::Buffer> invalid_buffer_;
541 void AddExpectationsForVertexAttribManager();
543 scoped_ptr< ::testing::StrictMock<MockCommandBufferEngine> > engine_;
544 scoped_refptr<ContextGroup> group_;
547 class GLES2DecoderWithShaderTestBase : public GLES2DecoderTestBase {
549 GLES2DecoderWithShaderTestBase()
550 : GLES2DecoderTestBase() {
554 virtual void SetUp() OVERRIDE;
555 virtual void TearDown() OVERRIDE;
562 #endif // GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_UNITTEST_BASE_H_