gles2_cmd_decoder_unittest_base.h revision 010d83a9304c5a91596085d917d248abff47903a 
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.
4
5#ifndef GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_UNITTEST_BASE_H_
6#define GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_UNITTEST_BASE_H_
7
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"
27
28namespace base {
29class CommandLine;
30}
31
32namespace gpu {
33namespace gles2 {
34
35class MemoryTracker;
36
37class GLES2DecoderTestBase : public ::testing::TestWithParam<bool> {
38 public:
39  GLES2DecoderTestBase();
40  virtual ~GLES2DecoderTestBase();
41
42  // Template to call glGenXXX functions.
43  template <typename T>
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)));
50  }
51
52  // This template exists solely so we can specialize it for
53  // certain commands.
54  template <typename T, int id>
55  void SpecializedSetup(bool valid) {
56  }
57
58  template <typename T>
59  T* GetImmediateAs() {
60    return reinterpret_cast<T*>(immediate_buffer_);
61  }
62
63  template <typename T, typename Command>
64  T GetImmediateDataAs(Command* cmd) {
65    return reinterpret_cast<T>(ImmediateDataAddress(cmd));
66  }
67
68  void ClearSharedMemory() {
69    engine_->ClearSharedMemory();
70  }
71
72  virtual void SetUp() OVERRIDE;
73  virtual void TearDown() OVERRIDE;
74
75  template <typename T>
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,
80                               &cmd);
81  }
82
83  template <typename T>
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,
88                               &cmd);
89  }
90
91  template <typename T>
92  T GetSharedMemoryAs() {
93    return reinterpret_cast<T>(shared_memory_address_);
94  }
95
96  template <typename T>
97  T GetSharedMemoryAsWithOffset(uint32 offset) {
98    void* ptr = reinterpret_cast<int8*>(shared_memory_address_) + offset;
99    return reinterpret_cast<T>(ptr);
100  }
101
102  IdAllocatorInterface* GetIdAllocator(GLuint namespace_id) {
103    return group_->GetIdAllocator(namespace_id);
104  }
105
106  Buffer* GetBuffer(GLuint service_id) {
107    return group_->buffer_manager()->GetBuffer(service_id);
108  }
109
110  Framebuffer* GetFramebuffer(GLuint service_id) {
111    return group_->framebuffer_manager()->GetFramebuffer(service_id);
112  }
113
114  Renderbuffer* GetRenderbuffer(
115      GLuint service_id) {
116    return group_->renderbuffer_manager()->GetRenderbuffer(service_id);
117  }
118
119  TextureRef* GetTexture(GLuint client_id) {
120    return group_->texture_manager()->GetTexture(client_id);
121  }
122
123  Shader* GetShader(GLuint client_id) {
124    return group_->shader_manager()->GetShader(client_id);
125  }
126
127  Program* GetProgram(GLuint client_id) {
128    return group_->program_manager()->GetProgram(client_id);
129  }
130
131  QueryManager::Query* GetQueryInfo(GLuint client_id) {
132    return decoder_->GetQueryManager()->GetQuery(client_id);
133  }
134
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);
139  }
140
141  ProgramManager* program_manager() {
142    return group_->program_manager();
143  }
144
145  void DoCreateProgram(GLuint client_id, GLuint service_id);
146  void DoCreateShader(GLenum shader_type, GLuint client_id, GLuint service_id);
147
148  void SetBucketAsCString(uint32 bucket_id, const char* str);
149
150  void set_memory_tracker(MemoryTracker* memory_tracker) {
151    memory_tracker_ = memory_tracker;
152  }
153
154  struct InitState {
155    InitState();
156
157    std::string extensions;
158    std::string gl_version;
159    bool has_alpha;
160    bool has_depth;
161    bool has_stencil;
162    bool request_alpha;
163    bool request_depth;
164    bool request_stencil;
165    bool bind_generates_resource;
166    bool lose_context_when_out_of_memory;
167  };
168
169  void InitDecoder(const InitState& init);
170  void InitDecoderWithCommandLine(const InitState& init,
171                                  const base::CommandLine* command_line);
172
173  void ResetDecoder();
174
175  const ContextGroup& group() const {
176    return *group_.get();
177  }
178
179  ::testing::StrictMock< ::gfx::MockGLInterface>* GetGLMock() const {
180    return gl_.get();
181  }
182
183  GLES2Decoder* GetDecoder() const {
184    return decoder_.get();
185  }
186
187  typedef TestHelper::AttribInfo AttribInfo;
188  typedef TestHelper::UniformInfo UniformInfo;
189
190  void SetupShader(
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);
196
197  void SetupInitCapabilitiesExpectations();
198  void SetupInitStateExpectations();
199  void ExpectEnableDisable(GLenum cap, bool enable);
200
201  // Setups up a shader for testing glUniform.
202  void SetupShaderForUniform(GLenum uniform_type);
203  void SetupDefaultProgram();
204  void SetupCubemapProgram();
205  void SetupSamplerExternalProgram();
206  void SetupTexture();
207
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.
214  GLint GetGLError();
215
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);
221
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);
228
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);
238
239  void DoCompressedTexImage2D(
240      GLenum target, GLint level, GLenum format,
241      GLsizei width, GLsizei height, GLint border,
242      GLsizei size, uint32 bucket_id);
243  void DoTexImage2D(
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(
258      GLenum target,
259      GLenum attachment,
260      GLenum renderbuffer_target,
261      GLuint renderbuffer_client_id,
262      GLuint renderbuffer_service_id,
263      GLenum error);
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);
271
272  void DoEnableDisable(GLenum cap, bool enable);
273
274  void DoEnableVertexAttribArray(GLint index);
275
276  void DoBufferData(GLenum target, GLsizei size);
277
278  void DoBufferSubData(
279      GLenum target, GLint offset, GLsizei size, const void* data);
280
281  void SetupVertexBuffer();
282  void SetupAllNeededVertexBuffers();
283
284  void SetupIndexBuffer();
285
286  void DeleteVertexBuffer();
287
288  void DeleteIndexBuffer();
289
290  void SetupClearTextureExpectations(
291      GLuint service_id,
292      GLuint old_service_id,
293      GLenum bind_target,
294      GLenum target,
295      GLint level,
296      GLenum internal_format,
297      GLenum format,
298      GLenum type,
299      GLsizei width,
300      GLsizei height);
301
302  void SetupExpectationsForRestoreClearState(
303      GLclampf restore_red,
304      GLclampf restore_green,
305      GLclampf restore_blue,
306      GLclampf restore_alpha,
307      GLuint restore_stencil,
308      GLclampf restore_depth,
309      bool restore_scissor_test);
310
311  void SetupExpectationsForFramebufferClearing(
312      GLenum target,
313      GLuint clear_bits,
314      GLclampf restore_red,
315      GLclampf restore_green,
316      GLclampf restore_blue,
317      GLclampf restore_alpha,
318      GLuint restore_stencil,
319      GLclampf restore_depth,
320      bool restore_scissor_test);
321
322  void SetupExpectationsForFramebufferClearingMulti(
323      GLuint read_framebuffer_service_id,
324      GLuint draw_framebuffer_service_id,
325      GLenum target,
326      GLuint clear_bits,
327      GLclampf restore_red,
328      GLclampf restore_green,
329      GLclampf restore_blue,
330      GLclampf restore_alpha,
331      GLuint restore_stencil,
332      GLclampf restore_depth,
333      bool restore_scissor_test);
334
335  void SetupExpectationsForDepthMask(bool mask);
336  void SetupExpectationsForEnableDisable(GLenum cap, bool enable);
337  void SetupExpectationsForColorMask(bool red,
338                                     bool green,
339                                     bool blue,
340                                     bool alpha);
341
342  void SetupExpectationsForApplyingDirtyState(
343      bool framebuffer_is_rgb,
344      bool framebuffer_has_depth,
345      bool framebuffer_has_stencil,
346      GLuint color_bits,  // NOTE! bits are 0x1000, 0x0100, 0x0010, and 0x0001
347      bool depth_mask,
348      bool depth_enabled,
349      GLuint front_stencil_mask,
350      GLuint back_stencil_mask,
351      bool stencil_enabled);
352
353  void SetupExpectationsForApplyingDefaultDirtyState();
354
355  void AddExpectationsForSimulatedAttrib0WithError(
356      GLsizei num_vertices, GLuint buffer_id, GLenum error);
357
358  void AddExpectationsForSimulatedAttrib0(
359      GLsizei num_vertices, GLuint buffer_id);
360
361  void AddExpectationsForGenVertexArraysOES();
362  void AddExpectationsForDeleteVertexArraysOES();
363  void AddExpectationsForDeleteBoundVertexArraysOES();
364  void AddExpectationsForBindVertexArrayOES();
365  void AddExpectationsForRestoreAttribState(GLuint attrib);
366
367  GLvoid* BufferOffset(unsigned i) {
368    return static_cast<int8 *>(NULL)+(i);
369  }
370
371  template <typename Command, typename Result>
372  bool IsObjectHelper(GLuint client_id) {
373    Result* result = static_cast<Result*>(shared_memory_address_);
374    Command cmd;
375    cmd.Init(client_id, kSharedMemoryId, kSharedMemoryOffset);
376    EXPECT_EQ(error::kNoError, ExecuteCmd(cmd));
377    bool isObject = static_cast<bool>(*result);
378    EXPECT_EQ(GL_NO_ERROR, GetGLError());
379    return isObject;
380  }
381
382 protected:
383  static const int kBackBufferWidth = 128;
384  static const int kBackBufferHeight = 64;
385
386  static const GLint kMaxTextureSize = 2048;
387  static const GLint kMaxCubeMapTextureSize = 256;
388  static const GLint kNumVertexAttribs = 16;
389  static const GLint kNumTextureUnits = 8;
390  static const GLint kMaxTextureImageUnits = 8;
391  static const GLint kMaxVertexTextureImageUnits = 2;
392  static const GLint kMaxFragmentUniformVectors = 16;
393  static const GLint kMaxVaryingVectors = 8;
394  static const GLint kMaxVertexUniformVectors = 128;
395  static const GLint kMaxViewportWidth = 8192;
396  static const GLint kMaxViewportHeight = 8192;
397
398  static const GLint kViewportX = 0;
399  static const GLint kViewportY = 0;
400  static const GLint kViewportWidth = kBackBufferWidth;
401  static const GLint kViewportHeight = kBackBufferHeight;
402
403  static const GLuint kServiceAttrib0BufferId = 801;
404  static const GLuint kServiceFixedAttribBufferId = 802;
405
406  static const GLuint kServiceBufferId = 301;
407  static const GLuint kServiceFramebufferId = 302;
408  static const GLuint kServiceRenderbufferId = 303;
409  static const GLuint kServiceTextureId = 304;
410  static const GLuint kServiceProgramId = 305;
411  static const GLuint kServiceShaderId = 306;
412  static const GLuint kServiceElementBufferId = 308;
413  static const GLuint kServiceQueryId = 309;
414  static const GLuint kServiceVertexArrayId = 310;
415
416  static const int32 kSharedMemoryId = 401;
417  static const size_t kSharedBufferSize = 2048;
418  static const uint32 kSharedMemoryOffset = 132;
419  static const int32 kInvalidSharedMemoryId = 402;
420  static const uint32 kInvalidSharedMemoryOffset = kSharedBufferSize + 1;
421  static const uint32 kInitialResult = 0xBDBDBDBDu;
422  static const uint8 kInitialMemoryValue = 0xBDu;
423
424  static const uint32 kNewClientId = 501;
425  static const uint32 kNewServiceId = 502;
426  static const uint32 kInvalidClientId = 601;
427
428  static const GLuint kServiceVertexShaderId = 321;
429  static const GLuint kServiceFragmentShaderId = 322;
430
431  static const GLuint kServiceCopyTextureChromiumShaderId = 701;
432  static const GLuint kServiceCopyTextureChromiumProgramId = 721;
433
434  static const GLuint kServiceCopyTextureChromiumTextureBufferId = 751;
435  static const GLuint kServiceCopyTextureChromiumVertexBufferId = 752;
436  static const GLuint kServiceCopyTextureChromiumFBOId = 753;
437  static const GLuint kServiceCopyTextureChromiumPositionAttrib = 761;
438  static const GLuint kServiceCopyTextureChromiumTexAttrib = 762;
439  static const GLuint kServiceCopyTextureChromiumSamplerLocation = 763;
440
441  static const GLsizei kNumVertices = 100;
442  static const GLsizei kNumIndices = 10;
443  static const int kValidIndexRangeStart = 1;
444  static const int kValidIndexRangeCount = 7;
445  static const int kInvalidIndexRangeStart = 0;
446  static const int kInvalidIndexRangeCount = 7;
447  static const int kOutOfRangeIndexRangeEnd = 10;
448  static const GLuint kMaxValidIndex = 7;
449
450  static const GLint kMaxAttribLength = 10;
451  static const char* kAttrib1Name;
452  static const char* kAttrib2Name;
453  static const char* kAttrib3Name;
454  static const GLint kAttrib1Size = 1;
455  static const GLint kAttrib2Size = 1;
456  static const GLint kAttrib3Size = 1;
457  static const GLint kAttrib1Location = 0;
458  static const GLint kAttrib2Location = 1;
459  static const GLint kAttrib3Location = 2;
460  static const GLenum kAttrib1Type = GL_FLOAT_VEC4;
461  static const GLenum kAttrib2Type = GL_FLOAT_VEC2;
462  static const GLenum kAttrib3Type = GL_FLOAT_VEC3;
463  static const GLint kInvalidAttribLocation = 30;
464  static const GLint kBadAttribIndex = kNumVertexAttribs;
465
466  static const GLint kMaxUniformLength = 12;
467  static const char* kUniform1Name;
468  static const char* kUniform2Name;
469  static const char* kUniform3Name;
470  static const GLint kUniform1Size = 1;
471  static const GLint kUniform2Size = 3;
472  static const GLint kUniform3Size = 2;
473  static const GLint kUniform1RealLocation = 3;
474  static const GLint kUniform2RealLocation = 10;
475  static const GLint kUniform2ElementRealLocation = 12;
476  static const GLint kUniform3RealLocation = 20;
477  static const GLint kUniform1FakeLocation = 0;               // These are
478  static const GLint kUniform2FakeLocation = 1;               // hardcoded
479  static const GLint kUniform2ElementFakeLocation = 0x10001;  // to match
480  static const GLint kUniform3FakeLocation = 2;               // ProgramManager.
481  static const GLint kUniform1DesiredLocation = -1;
482  static const GLint kUniform2DesiredLocation = -1;
483  static const GLint kUniform3DesiredLocation = -1;
484  static const GLenum kUniform1Type = GL_SAMPLER_2D;
485  static const GLenum kUniform2Type = GL_INT_VEC2;
486  static const GLenum kUniform3Type = GL_FLOAT_VEC3;
487  static const GLenum kUniformSamplerExternalType = GL_SAMPLER_EXTERNAL_OES;
488  static const GLenum kUniformCubemapType = GL_SAMPLER_CUBE;
489  static const GLint kInvalidUniformLocation = 30;
490  static const GLint kBadUniformIndex = 1000;
491
492  // Use StrictMock to make 100% sure we know how GL will be called.
493  scoped_ptr< ::testing::StrictMock< ::gfx::MockGLInterface> > gl_;
494  scoped_refptr<gfx::GLSurfaceStub> surface_;
495  scoped_refptr<gfx::GLContextStubWithExtensions> context_;
496  scoped_ptr<MockGLES2Decoder> mock_decoder_;
497  scoped_ptr<GLES2Decoder> decoder_;
498  MemoryTracker* memory_tracker_;
499
500  GLuint client_buffer_id_;
501  GLuint client_framebuffer_id_;
502  GLuint client_program_id_;
503  GLuint client_renderbuffer_id_;
504  GLuint client_shader_id_;
505  GLuint client_texture_id_;
506  GLuint client_element_buffer_id_;
507  GLuint client_vertex_shader_id_;
508  GLuint client_fragment_shader_id_;
509  GLuint client_query_id_;
510  GLuint client_vertexarray_id_;
511
512  uint32 shared_memory_id_;
513  uint32 shared_memory_offset_;
514  void* shared_memory_address_;
515  void* shared_memory_base_;
516
517  int8 immediate_buffer_[256];
518
519  const bool ignore_cached_state_for_test_;
520  bool cached_color_mask_red_;
521  bool cached_color_mask_green_;
522  bool cached_color_mask_blue_;
523  bool cached_color_mask_alpha_;
524  bool cached_depth_mask_;
525  uint32 cached_stencil_front_mask_;
526  uint32 cached_stencil_back_mask_;
527
528  struct EnableFlags {
529    EnableFlags();
530    bool cached_blend;
531    bool cached_cull_face;
532    bool cached_depth_test;
533    bool cached_dither;
534    bool cached_polygon_offset_fill;
535    bool cached_sample_alpha_to_coverage;
536    bool cached_sample_coverage;
537    bool cached_scissor_test;
538    bool cached_stencil_test;
539  };
540
541  EnableFlags enable_flags_;
542
543 private:
544  class MockCommandBufferEngine : public CommandBufferEngine {
545   public:
546    MockCommandBufferEngine();
547
548    virtual ~MockCommandBufferEngine();
549
550    virtual scoped_refptr<gpu::Buffer> GetSharedMemoryBuffer(int32 shm_id)
551        OVERRIDE;
552
553    void ClearSharedMemory() {
554      memset(valid_buffer_->memory(), kInitialMemoryValue, kSharedBufferSize);
555    }
556
557    virtual void set_token(int32 token) OVERRIDE;
558
559    virtual bool SetGetBuffer(int32 /* transfer_buffer_id */) OVERRIDE;
560
561    // Overridden from CommandBufferEngine.
562    virtual bool SetGetOffset(int32 offset) OVERRIDE;
563
564    // Overridden from CommandBufferEngine.
565    virtual int32 GetGetOffset() OVERRIDE;
566
567   private:
568    scoped_refptr<gpu::Buffer> valid_buffer_;
569    scoped_refptr<gpu::Buffer> invalid_buffer_;
570  };
571
572  void AddExpectationsForVertexAttribManager();
573
574  scoped_ptr< ::testing::StrictMock<MockCommandBufferEngine> > engine_;
575  scoped_refptr<ContextGroup> group_;
576};
577
578class GLES2DecoderWithShaderTestBase : public GLES2DecoderTestBase {
579 public:
580  GLES2DecoderWithShaderTestBase()
581      : GLES2DecoderTestBase() {
582  }
583
584 protected:
585  virtual void SetUp() OVERRIDE;
586  virtual void TearDown() OVERRIDE;
587
588};
589
590}  // namespace gles2
591}  // namespace gpu
592
593#endif  // GPU_COMMAND_BUFFER_SERVICE_GLES2_CMD_DECODER_UNITTEST_BASE_H_
594