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 #include "gpu/command_buffer/service/test_helper.h"
10 #include "base/strings/string_number_conversions.h"
11 #include "base/strings/string_tokenizer.h"
12 #include "gpu/command_buffer/common/types.h"
13 #include "gpu/command_buffer/service/buffer_manager.h"
14 #include "gpu/command_buffer/service/error_state_mock.h"
15 #include "gpu/command_buffer/service/gl_utils.h"
16 #include "gpu/command_buffer/service/gpu_switches.h"
17 #include "gpu/command_buffer/service/program_manager.h"
18 #include "gpu/command_buffer/service/texture_manager.h"
19 #include "testing/gtest/include/gtest/gtest.h"
20 #include "ui/gl/gl_mock.h"
23 using ::testing::DoAll;
24 using ::testing::InSequence;
25 using ::testing::MatcherCast;
26 using ::testing::Pointee;
27 using ::testing::Return;
28 using ::testing::SetArrayArgument;
29 using ::testing::SetArgumentPointee;
30 using ::testing::StrEq;
31 using ::testing::StrictMock;
36 // GCC requires these declarations, but MSVC requires they not be present
38 const GLuint TestHelper::kServiceBlackTexture2dId;
39 const GLuint TestHelper::kServiceDefaultTexture2dId;
40 const GLuint TestHelper::kServiceBlackTextureCubemapId;
41 const GLuint TestHelper::kServiceDefaultTextureCubemapId;
42 const GLuint TestHelper::kServiceBlackExternalTextureId;
43 const GLuint TestHelper::kServiceDefaultExternalTextureId;
44 const GLuint TestHelper::kServiceBlackRectangleTextureId;
45 const GLuint TestHelper::kServiceDefaultRectangleTextureId;
47 const GLint TestHelper::kMaxSamples;
48 const GLint TestHelper::kMaxRenderbufferSize;
49 const GLint TestHelper::kMaxTextureSize;
50 const GLint TestHelper::kMaxCubeMapTextureSize;
51 const GLint TestHelper::kNumVertexAttribs;
52 const GLint TestHelper::kNumTextureUnits;
53 const GLint TestHelper::kMaxTextureImageUnits;
54 const GLint TestHelper::kMaxVertexTextureImageUnits;
55 const GLint TestHelper::kMaxFragmentUniformVectors;
56 const GLint TestHelper::kMaxFragmentUniformComponents;
57 const GLint TestHelper::kMaxVaryingVectors;
58 const GLint TestHelper::kMaxVaryingFloats;
59 const GLint TestHelper::kMaxVertexUniformVectors;
60 const GLint TestHelper::kMaxVertexUniformComponents;
63 void TestHelper::SetupTextureInitializationExpectations(
64 ::gfx::MockGLInterface* gl, GLenum target) {
67 bool needs_initialization = (target != GL_TEXTURE_EXTERNAL_OES);
68 bool needs_faces = (target == GL_TEXTURE_CUBE_MAP);
70 static GLuint texture_2d_ids[] = {
71 kServiceBlackTexture2dId,
72 kServiceDefaultTexture2dId };
73 static GLuint texture_cube_map_ids[] = {
74 kServiceBlackTextureCubemapId,
75 kServiceDefaultTextureCubemapId };
76 static GLuint texture_external_oes_ids[] = {
77 kServiceBlackExternalTextureId,
78 kServiceDefaultExternalTextureId };
79 static GLuint texture_rectangle_arb_ids[] = {
80 kServiceBlackRectangleTextureId,
81 kServiceDefaultRectangleTextureId };
83 const GLuint* texture_ids = NULL;
86 texture_ids = &texture_2d_ids[0];
88 case GL_TEXTURE_CUBE_MAP:
89 texture_ids = &texture_cube_map_ids[0];
91 case GL_TEXTURE_EXTERNAL_OES:
92 texture_ids = &texture_external_oes_ids[0];
94 case GL_TEXTURE_RECTANGLE_ARB:
95 texture_ids = &texture_rectangle_arb_ids[0];
103 EXPECT_CALL(*gl, GenTextures(array_size, _))
104 .WillOnce(SetArrayArgument<1>(texture_ids,
105 texture_ids + array_size))
106 .RetiresOnSaturation();
107 for (int ii = 0; ii < array_size; ++ii) {
108 EXPECT_CALL(*gl, BindTexture(target, texture_ids[ii]))
110 .RetiresOnSaturation();
111 if (needs_initialization) {
113 static GLenum faces[] = {
114 GL_TEXTURE_CUBE_MAP_POSITIVE_X,
115 GL_TEXTURE_CUBE_MAP_NEGATIVE_X,
116 GL_TEXTURE_CUBE_MAP_POSITIVE_Y,
117 GL_TEXTURE_CUBE_MAP_NEGATIVE_Y,
118 GL_TEXTURE_CUBE_MAP_POSITIVE_Z,
119 GL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
121 for (size_t ii = 0; ii < arraysize(faces); ++ii) {
122 EXPECT_CALL(*gl, TexImage2D(faces[ii], 0, GL_RGBA, 1, 1, 0, GL_RGBA,
123 GL_UNSIGNED_BYTE, _))
125 .RetiresOnSaturation();
128 EXPECT_CALL(*gl, TexImage2D(target, 0, GL_RGBA, 1, 1, 0, GL_RGBA,
129 GL_UNSIGNED_BYTE, _))
131 .RetiresOnSaturation();
135 EXPECT_CALL(*gl, BindTexture(target, 0))
137 .RetiresOnSaturation();
140 void TestHelper::SetupTextureManagerInitExpectations(
141 ::gfx::MockGLInterface* gl,
142 const char* extensions) {
145 SetupTextureInitializationExpectations(gl, GL_TEXTURE_2D);
146 SetupTextureInitializationExpectations(gl, GL_TEXTURE_CUBE_MAP);
148 bool ext_image_external = false;
149 bool arb_texture_rectangle = false;
150 base::CStringTokenizer t(extensions, extensions + strlen(extensions), " ");
151 while (t.GetNext()) {
152 if (t.token() == "GL_OES_EGL_image_external") {
153 ext_image_external = true;
156 if (t.token() == "GL_ARB_texture_rectangle") {
157 arb_texture_rectangle = true;
162 if (ext_image_external) {
163 SetupTextureInitializationExpectations(gl, GL_TEXTURE_EXTERNAL_OES);
165 if (arb_texture_rectangle) {
166 SetupTextureInitializationExpectations(gl, GL_TEXTURE_RECTANGLE_ARB);
170 void TestHelper::SetupTextureDestructionExpectations(
171 ::gfx::MockGLInterface* gl, GLenum target) {
172 GLuint texture_id = 0;
175 texture_id = kServiceDefaultTexture2dId;
177 case GL_TEXTURE_CUBE_MAP:
178 texture_id = kServiceDefaultTextureCubemapId;
180 case GL_TEXTURE_EXTERNAL_OES:
181 texture_id = kServiceDefaultExternalTextureId;
183 case GL_TEXTURE_RECTANGLE_ARB:
184 texture_id = kServiceDefaultRectangleTextureId;
190 EXPECT_CALL(*gl, DeleteTextures(1, Pointee(texture_id)))
192 .RetiresOnSaturation();
195 void TestHelper::SetupTextureManagerDestructionExpectations(
196 ::gfx::MockGLInterface* gl,
197 const char* extensions) {
198 SetupTextureDestructionExpectations(gl, GL_TEXTURE_2D);
199 SetupTextureDestructionExpectations(gl, GL_TEXTURE_CUBE_MAP);
201 bool ext_image_external = false;
202 bool arb_texture_rectangle = false;
203 base::CStringTokenizer t(extensions, extensions + strlen(extensions), " ");
204 while (t.GetNext()) {
205 if (t.token() == "GL_OES_EGL_image_external") {
206 ext_image_external = true;
209 if (t.token() == "GL_ARB_texture_rectangle") {
210 arb_texture_rectangle = true;
215 if (ext_image_external) {
216 SetupTextureDestructionExpectations(gl, GL_TEXTURE_EXTERNAL_OES);
218 if (arb_texture_rectangle) {
219 SetupTextureDestructionExpectations(gl, GL_TEXTURE_RECTANGLE_ARB);
222 EXPECT_CALL(*gl, DeleteTextures(4, _))
224 .RetiresOnSaturation();
227 void TestHelper::SetupContextGroupInitExpectations(
228 ::gfx::MockGLInterface* gl,
229 const DisallowedFeatures& disallowed_features,
230 const char* extensions) {
233 SetupFeatureInfoInitExpectations(gl, extensions);
235 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_RENDERBUFFER_SIZE, _))
236 .WillOnce(SetArgumentPointee<1>(kMaxRenderbufferSize))
237 .RetiresOnSaturation();
238 if (strstr(extensions, "GL_EXT_framebuffer_multisample")) {
239 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_SAMPLES, _))
240 .WillOnce(SetArgumentPointee<1>(kMaxSamples))
241 .RetiresOnSaturation();
243 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_VERTEX_ATTRIBS, _))
244 .WillOnce(SetArgumentPointee<1>(kNumVertexAttribs))
245 .RetiresOnSaturation();
246 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, _))
247 .WillOnce(SetArgumentPointee<1>(kNumTextureUnits))
248 .RetiresOnSaturation();
249 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_TEXTURE_SIZE, _))
250 .WillOnce(SetArgumentPointee<1>(kMaxTextureSize))
251 .RetiresOnSaturation();
252 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_CUBE_MAP_TEXTURE_SIZE, _))
253 .WillOnce(SetArgumentPointee<1>(kMaxCubeMapTextureSize))
254 .RetiresOnSaturation();
255 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_TEXTURE_IMAGE_UNITS, _))
256 .WillOnce(SetArgumentPointee<1>(kMaxTextureImageUnits))
257 .RetiresOnSaturation();
258 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_VERTEX_TEXTURE_IMAGE_UNITS, _))
259 .WillOnce(SetArgumentPointee<1>(kMaxVertexTextureImageUnits))
260 .RetiresOnSaturation();
261 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_FRAGMENT_UNIFORM_COMPONENTS, _))
262 .WillOnce(SetArgumentPointee<1>(kMaxFragmentUniformComponents))
263 .RetiresOnSaturation();
264 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_VARYING_FLOATS, _))
265 .WillOnce(SetArgumentPointee<1>(kMaxVaryingFloats))
266 .RetiresOnSaturation();
267 EXPECT_CALL(*gl, GetIntegerv(GL_MAX_VERTEX_UNIFORM_COMPONENTS, _))
268 .WillOnce(SetArgumentPointee<1>(kMaxVertexUniformComponents))
269 .RetiresOnSaturation();
271 SetupTextureManagerInitExpectations(gl, extensions);
274 void TestHelper::SetupFeatureInfoInitExpectations(
275 ::gfx::MockGLInterface* gl, const char* extensions) {
276 SetupFeatureInfoInitExpectationsWithGLVersion(gl, extensions, "");
279 void TestHelper::SetupFeatureInfoInitExpectationsWithGLVersion(
280 ::gfx::MockGLInterface* gl,
281 const char* extensions,
282 const char* version) {
285 EXPECT_CALL(*gl, GetString(GL_EXTENSIONS))
286 .WillOnce(Return(reinterpret_cast<const uint8*>(extensions)))
287 .RetiresOnSaturation();
288 EXPECT_CALL(*gl, GetString(GL_VERSION))
289 .WillOnce(Return(reinterpret_cast<const uint8*>(version)))
290 .RetiresOnSaturation();
293 void TestHelper::SetupExpectationsForClearingUniforms(
294 ::gfx::MockGLInterface* gl, UniformInfo* uniforms, size_t num_uniforms) {
295 for (size_t ii = 0; ii < num_uniforms; ++ii) {
296 const UniformInfo& info = uniforms[ii];
299 EXPECT_CALL(*gl, Uniform1fv(info.real_location, info.size, _))
301 .RetiresOnSaturation();
304 EXPECT_CALL(*gl, Uniform2fv(info.real_location, info.size, _))
306 .RetiresOnSaturation();
309 EXPECT_CALL(*gl, Uniform3fv(info.real_location, info.size, _))
311 .RetiresOnSaturation();
314 EXPECT_CALL(*gl, Uniform4fv(info.real_location, info.size, _))
316 .RetiresOnSaturation();
321 case GL_SAMPLER_CUBE:
322 case GL_SAMPLER_EXTERNAL_OES:
323 case GL_SAMPLER_3D_OES:
324 case GL_SAMPLER_2D_RECT_ARB:
325 EXPECT_CALL(*gl, Uniform1iv(info.real_location, info.size, _))
327 .RetiresOnSaturation();
331 EXPECT_CALL(*gl, Uniform2iv(info.real_location, info.size, _))
333 .RetiresOnSaturation();
337 EXPECT_CALL(*gl, Uniform3iv(info.real_location, info.size, _))
339 .RetiresOnSaturation();
343 EXPECT_CALL(*gl, Uniform4iv(info.real_location, info.size, _))
345 .RetiresOnSaturation();
348 EXPECT_CALL(*gl, UniformMatrix2fv(
349 info.real_location, info.size, false, _))
351 .RetiresOnSaturation();
354 EXPECT_CALL(*gl, UniformMatrix3fv(
355 info.real_location, info.size, false, _))
357 .RetiresOnSaturation();
360 EXPECT_CALL(*gl, UniformMatrix4fv(
361 info.real_location, info.size, false, _))
363 .RetiresOnSaturation();
372 void TestHelper::SetupProgramSuccessExpectations(
373 ::gfx::MockGLInterface* gl,
374 AttribInfo* attribs, size_t num_attribs,
375 UniformInfo* uniforms, size_t num_uniforms,
378 GetProgramiv(service_id, GL_LINK_STATUS, _))
379 .WillOnce(SetArgumentPointee<2>(1))
380 .RetiresOnSaturation();
382 GetProgramiv(service_id, GL_INFO_LOG_LENGTH, _))
383 .WillOnce(SetArgumentPointee<2>(0))
384 .RetiresOnSaturation();
386 GetProgramiv(service_id, GL_ACTIVE_ATTRIBUTES, _))
387 .WillOnce(SetArgumentPointee<2>(num_attribs))
388 .RetiresOnSaturation();
389 size_t max_attrib_len = 0;
390 for (size_t ii = 0; ii < num_attribs; ++ii) {
391 size_t len = strlen(attribs[ii].name) + 1;
392 max_attrib_len = std::max(max_attrib_len, len);
395 GetProgramiv(service_id, GL_ACTIVE_ATTRIBUTE_MAX_LENGTH, _))
396 .WillOnce(SetArgumentPointee<2>(max_attrib_len))
397 .RetiresOnSaturation();
399 for (size_t ii = 0; ii < num_attribs; ++ii) {
400 const AttribInfo& info = attribs[ii];
402 GetActiveAttrib(service_id, ii,
403 max_attrib_len, _, _, _, _))
405 SetArgumentPointee<3>(strlen(info.name)),
406 SetArgumentPointee<4>(info.size),
407 SetArgumentPointee<5>(info.type),
408 SetArrayArgument<6>(info.name,
409 info.name + strlen(info.name) + 1)))
410 .RetiresOnSaturation();
411 if (!ProgramManager::IsInvalidPrefix(info.name, strlen(info.name))) {
412 EXPECT_CALL(*gl, GetAttribLocation(service_id, StrEq(info.name)))
413 .WillOnce(Return(info.location))
414 .RetiresOnSaturation();
418 GetProgramiv(service_id, GL_ACTIVE_UNIFORMS, _))
419 .WillOnce(SetArgumentPointee<2>(num_uniforms))
420 .RetiresOnSaturation();
422 size_t max_uniform_len = 0;
423 for (size_t ii = 0; ii < num_uniforms; ++ii) {
424 size_t len = strlen(uniforms[ii].name) + 1;
425 max_uniform_len = std::max(max_uniform_len, len);
428 GetProgramiv(service_id, GL_ACTIVE_UNIFORM_MAX_LENGTH, _))
429 .WillOnce(SetArgumentPointee<2>(max_uniform_len))
430 .RetiresOnSaturation();
431 for (size_t ii = 0; ii < num_uniforms; ++ii) {
432 const UniformInfo& info = uniforms[ii];
434 GetActiveUniform(service_id, ii,
435 max_uniform_len, _, _, _, _))
437 SetArgumentPointee<3>(strlen(info.name)),
438 SetArgumentPointee<4>(info.size),
439 SetArgumentPointee<5>(info.type),
440 SetArrayArgument<6>(info.name,
441 info.name + strlen(info.name) + 1)))
442 .RetiresOnSaturation();
445 for (int pass = 0; pass < 2; ++pass) {
446 for (size_t ii = 0; ii < num_uniforms; ++ii) {
447 const UniformInfo& info = uniforms[ii];
448 if (ProgramManager::IsInvalidPrefix(info.name, strlen(info.name))) {
452 EXPECT_CALL(*gl, GetUniformLocation(service_id, StrEq(info.name)))
453 .WillOnce(Return(info.real_location))
454 .RetiresOnSaturation();
456 if ((pass == 0 && info.desired_location >= 0) ||
457 (pass == 1 && info.desired_location < 0)) {
459 std::string base_name = info.name;
460 size_t array_pos = base_name.rfind("[0]");
461 if (base_name.size() > 3 && array_pos == base_name.size() - 3) {
462 base_name = base_name.substr(0, base_name.size() - 3);
464 for (GLsizei jj = 1; jj < info.size; ++jj) {
465 std::string element_name(
466 std::string(base_name) + "[" + base::IntToString(jj) + "]");
467 EXPECT_CALL(*gl, GetUniformLocation(
468 service_id, StrEq(element_name)))
469 .WillOnce(Return(info.real_location + jj * 2))
470 .RetiresOnSaturation();
478 void TestHelper::SetupShader(
479 ::gfx::MockGLInterface* gl,
480 AttribInfo* attribs, size_t num_attribs,
481 UniformInfo* uniforms, size_t num_uniforms,
486 LinkProgram(service_id))
488 .RetiresOnSaturation();
490 SetupProgramSuccessExpectations(
491 gl, attribs, num_attribs, uniforms, num_uniforms, service_id);
494 void TestHelper::DoBufferData(
495 ::gfx::MockGLInterface* gl, MockErrorState* error_state,
496 BufferManager* manager, Buffer* buffer, GLsizeiptr size, GLenum usage,
497 const GLvoid* data, GLenum error) {
498 EXPECT_CALL(*error_state, CopyRealGLErrorsToWrapper(_, _, _))
500 .RetiresOnSaturation();
501 if (manager->IsUsageClientSideArray(usage)) {
502 EXPECT_CALL(*gl, BufferData(
503 buffer->target(), 0, _, usage))
505 .RetiresOnSaturation();
507 EXPECT_CALL(*gl, BufferData(
508 buffer->target(), size, _, usage))
510 .RetiresOnSaturation();
512 EXPECT_CALL(*error_state, PeekGLError(_, _, _))
513 .WillOnce(Return(error))
514 .RetiresOnSaturation();
515 manager->DoBufferData(error_state, buffer, size, usage, data);
518 void TestHelper::SetTexParameterWithExpectations(
519 ::gfx::MockGLInterface* gl, MockErrorState* error_state,
520 TextureManager* manager, TextureRef* texture_ref,
521 GLenum pname, GLint value, GLenum error) {
522 if (error == GL_NO_ERROR) {
523 if (pname != GL_TEXTURE_POOL_CHROMIUM) {
524 EXPECT_CALL(*gl, TexParameteri(texture_ref->texture()->target(),
527 .RetiresOnSaturation();
529 } else if (error == GL_INVALID_ENUM) {
530 EXPECT_CALL(*error_state, SetGLErrorInvalidEnum(_, _, _, value, _))
532 .RetiresOnSaturation();
534 EXPECT_CALL(*error_state, SetGLErrorInvalidParam(_, _, error, _, _, _))
536 .RetiresOnSaturation();
538 manager->SetParameter("", error_state, texture_ref, pname, value);
541 ScopedGLImplementationSetter::ScopedGLImplementationSetter(
542 gfx::GLImplementation implementation)
543 : old_implementation_(gfx::GetGLImplementation()) {
544 gfx::SetGLImplementation(implementation);
547 ScopedGLImplementationSetter::~ScopedGLImplementationSetter() {
548 gfx::SetGLImplementation(old_implementation_);