1 /**************************************************************************
2 * Copyright 2012 Intel corporation
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 **************************************************************************/
28 #include "trace_analyzer.hpp"
30 #define MAX(a, b) ((a) > (b) ? (a) : (b))
31 #define STRNCMP_LITERAL(var, literal) strncmp((var), (literal), sizeof (literal) -1)
33 /* Rendering often has no side effects, but it can in some cases,
34 * (such as when transform feedback is active, or when rendering
35 * targets a framebuffer object). */
37 TraceAnalyzer::renderingHasSideEffect(void)
39 return transformFeedbackActive || framebufferObjectActive;
42 /* Provide: Record that the given call affects the given resource
43 * as a side effect. */
45 TraceAnalyzer::provide(std::string resource, trace::CallNo call_no)
47 resources[resource].insert(call_no);
50 /* Like provide, but with a simply-formatted string, (appending an
51 * integer to the given string). */
53 TraceAnalyzer::providef(std::string resource,
55 trace::CallNo call_no)
58 ss << resource << resource_no;
59 provide(ss.str(), call_no);
62 /* Link: Establish a dependency between resource 'resource' and
63 * resource 'dependency'. This dependency is captured by name so
64 * that if the list of calls that provide 'dependency' grows
65 * before 'resource' is consumed, those calls will still be
68 TraceAnalyzer::link(std::string resource, std::string dependency)
70 dependencies[resource].insert(dependency);
73 /* Like link, but with a simply-formatted string, (appending an
74 * integer to the given string). */
76 TraceAnalyzer::linkf(std::string resource, std::string dependency, int dep_no)
80 ss << dependency << dep_no;
81 link(resource, ss.str());
84 /* Unlink: Remove dependency from 'resource' on 'dependency'. */
86 TraceAnalyzer::unlink(std::string resource, std::string dependency)
88 dependencies[resource].erase(dependency);
89 if (dependencies[resource].size() == 0) {
90 dependencies.erase(resource);
94 /* Like unlink, but with a simply-formated string, (appending an
95 * integer to the given string). */
97 TraceAnalyzer::unlinkf(std::string resource, std::string dependency, int dep_no)
100 std::stringstream ss;
101 ss << dependency << dep_no;
102 unlink(resource, ss.str());
105 /* Unlink all: Remove dependencies from 'resource' to all other
108 TraceAnalyzer::unlinkAll(std::string resource)
110 dependencies.erase(resource);
113 /* Resolve: Recursively compute all calls providing 'resource',
114 * (including linked dependencies of 'resource' on other
117 TraceAnalyzer::resolve(std::string resource)
119 std::set<std::string> *deps;
120 std::set<std::string>::iterator dep;
122 std::set<unsigned> *calls;
123 std::set<unsigned>::iterator call;
125 std::set<unsigned> result, deps_set;
127 /* Recursively chase dependencies. */
128 if (dependencies.count(resource)) {
129 deps = &dependencies[resource];
130 for (dep = deps->begin(); dep != deps->end(); dep++) {
131 deps_set = resolve(*dep);
132 for (call = deps_set.begin(); call != deps_set.end(); call++) {
133 result.insert(*call);
138 /* Also look for calls that directly provide 'resource' */
139 if (resources.count(resource)) {
140 calls = &resources[resource];
141 for (call = calls->begin(); call != calls->end(); call++) {
142 result.insert(*call);
149 /* Consume: Resolve all calls that provide the given resource, and
150 * add them to the required list. Then clear the call list for
151 * 'resource' along with any dependencies. */
153 TraceAnalyzer::consume(std::string resource)
156 std::set<unsigned> calls;
157 std::set<unsigned>::iterator call;
159 calls = resolve(resource);
161 dependencies.erase(resource);
162 resources.erase(resource);
164 for (call = calls.begin(); call != calls.end(); call++) {
165 required.insert(*call);
170 TraceAnalyzer::stateTrackPreCall(trace::Call *call)
173 const char *name = call->name();
175 if (strcmp(name, "glBegin") == 0) {
176 insideBeginEnd = true;
180 if (strcmp(name, "glBeginTransformFeedback") == 0) {
181 transformFeedbackActive = true;
185 if (strcmp(name, "glActiveTexture") == 0) {
186 activeTextureUnit = static_cast<GLenum>(call->arg(0).toSInt());
190 if (strcmp(name, "glBindTexture") == 0) {
194 target = static_cast<GLenum>(call->arg(0).toSInt());
195 texture = call->arg(1).toUInt();
198 texture_map.erase(target);
200 texture_map[target] = texture;
206 if (strcmp(name, "glUseProgram") == 0) {
207 activeProgram = call->arg(0).toUInt();
210 if (strcmp(name, "glBindFramebuffer") == 0) {
214 target = static_cast<GLenum>(call->arg(0).toSInt());
215 framebuffer = call->arg(1).toUInt();
217 if (target == GL_FRAMEBUFFER || target == GL_DRAW_FRAMEBUFFER) {
218 if (framebuffer == 0) {
219 framebufferObjectActive = false;
221 framebufferObjectActive = true;
227 if (strcmp(name, "glNewList") == 0) {
228 GLuint list = call->arg(0).toUInt();
230 insideNewEndList = list;
235 TraceAnalyzer::stateTrackPostCall(trace::Call *call)
238 const char *name = call->name();
240 if (strcmp(name, "glEnd") == 0) {
241 insideBeginEnd = false;
245 if (strcmp(name, "glEndTransformFeedback") == 0) {
246 transformFeedbackActive = false;
250 /* If this swapbuffers was included in the trace then it will
251 * have already consumed all framebuffer dependencies. If not,
252 * then clear them now so that they don't carry over into the
254 if (call->flags & trace::CALL_FLAG_SWAP_RENDERTARGET &&
255 call->flags & trace::CALL_FLAG_END_FRAME) {
256 dependencies.erase("framebuffer");
257 resources.erase("framebuffer");
261 if (strcmp(name, "glEndList") == 0) {
262 insideNewEndList = 0;
267 TraceAnalyzer::callHasNoSideEffects(trace::Call *call, const char *name)
269 /* If call is flagged as no side effects, then we are done here. */
270 if (call->flags & trace::CALL_FLAG_NO_SIDE_EFFECTS) {
274 /* Similarly, swap-buffers calls don't have interesting side effects. */
275 if (call->flags & trace::CALL_FLAG_SWAP_RENDERTARGET &&
276 call->flags & trace::CALL_FLAG_END_FRAME) {
280 /* Not known as a no-side-effect call. Return false for more analysis. */
285 TraceAnalyzer::recordTextureSideEffects(trace::Call *call, const char *name)
287 if (strcmp(name, "glGenTextures") == 0) {
288 const trace::Array *textures = dynamic_cast<const trace::Array *>(&call->arg(1));
293 for (i = 0; i < textures->size(); i++) {
294 texture = textures->values[i]->toUInt();
295 providef("texture-", texture, call->no);
301 /* FIXME: When we start tracking framebuffer objects as their own
302 * resources, we will want to link the FBO to the given texture
303 * resource, (and to this call). For now, just link render state
304 * to the texture, and force this call to be required. */
305 if (strcmp(name, "glFramebufferTexture2D") == 0) {
308 texture = call->arg(3).toUInt();
310 linkf("render-state", "texture-", texture);
312 provide("state", call->no);
315 if (strcmp(name, "glBindTexture") == 0) {
319 std::stringstream ss_target, ss_texture;
321 target = static_cast<GLenum>(call->arg(0).toSInt());
322 texture = call->arg(1).toUInt();
324 ss_target << "texture-unit-" << activeTextureUnit << "-target-" << target;
325 ss_texture << "texture-" << texture;
327 resources.erase(ss_target.str());
328 provide(ss_target.str(), call->no);
330 unlinkAll(ss_target.str());
331 link(ss_target.str(), ss_texture.str());
333 /* FIXME: This really shouldn't be necessary. The effect
334 * this provide() has is that all glBindTexture calls will
335 * be preserved in the output trace (never trimmed). Carl
336 * has a trace ("btr") where a glBindTexture call should
337 * not be necessary at all, (it's immediately followed
338 * with a glBindTexture to a different texture and no
339 * intervening texture-related calls), yet this 'provide'
340 * makes the difference between a trim_stress test failing
343 * More investigation is necessary, but for now, be
344 * conservative and don't trim. */
345 provide("state", call->no);
350 /* FIXME: Need to handle glMultiTexImage and friends. */
351 if (STRNCMP_LITERAL(name, "glTexImage") == 0 ||
352 STRNCMP_LITERAL(name, "glTexSubImage") == 0 ||
353 STRNCMP_LITERAL(name, "glCopyTexImage") == 0 ||
354 STRNCMP_LITERAL(name, "glCopyTexSubImage") == 0 ||
355 STRNCMP_LITERAL(name, "glCompressedTexImage") == 0 ||
356 STRNCMP_LITERAL(name, "glCompressedTexSubImage") == 0 ||
357 strcmp(name, "glInvalidateTexImage") == 0 ||
358 strcmp(name, "glInvalidateTexSubImage") == 0) {
360 std::set<unsigned> *calls;
361 std::set<unsigned>::iterator c;
362 std::stringstream ss_target, ss_texture;
364 GLenum target = static_cast<GLenum>(call->arg(0).toSInt());
366 ss_target << "texture-unit-" << activeTextureUnit << "-target-" << target;
367 ss_texture << "texture-" << texture_map[target];
369 /* The texture resource depends on this call and any calls
370 * providing the given texture target. */
371 provide(ss_texture.str(), call->no);
373 if (resources.count(ss_target.str())) {
374 calls = &resources[ss_target.str()];
375 for (c = calls->begin(); c != calls->end(); c++) {
376 provide(ss_texture.str(), *c);
383 if (strcmp(name, "glEnable") == 0) {
386 cap = static_cast<GLenum>(call->arg(0).toSInt());
388 if (cap == GL_TEXTURE_1D ||
389 cap == GL_TEXTURE_2D ||
390 cap == GL_TEXTURE_3D ||
391 cap == GL_TEXTURE_CUBE_MAP)
393 std::stringstream ss;
395 ss << "texture-unit-" << activeTextureUnit << "-target-" << cap;
397 link("render-state", ss.str());
400 provide("state", call->no);
404 if (strcmp(name, "glDisable") == 0) {
407 cap = static_cast<GLenum>(call->arg(0).toSInt());
409 if (cap == GL_TEXTURE_1D ||
410 cap == GL_TEXTURE_2D ||
411 cap == GL_TEXTURE_3D ||
412 cap == GL_TEXTURE_CUBE_MAP)
414 std::stringstream ss;
416 ss << "texture-unit-" << activeTextureUnit << "-target-" << cap;
418 unlink("render-state", ss.str());
421 provide("state", call->no);
425 /* No known texture-related side effects. Return false for more analysis. */
430 TraceAnalyzer::recordShaderSideEffects(trace::Call *call, const char *name)
432 if (strcmp(name, "glCreateShader") == 0 ||
433 strcmp(name, "glCreateShaderObjectARB") == 0) {
435 GLuint shader = call->ret->toUInt();
436 providef("shader-", shader, call->no);
440 if (strcmp(name, "glShaderSource") == 0 ||
441 strcmp(name, "glShaderSourceARB") == 0 ||
442 strcmp(name, "glCompileShader") == 0 ||
443 strcmp(name, "glCompileShaderARB") == 0 ||
444 strcmp(name, "glGetShaderiv") == 0 ||
445 strcmp(name, "glGetShaderInfoLog") == 0) {
447 GLuint shader = call->arg(0).toUInt();
448 providef("shader-", shader, call->no);
452 if (strcmp(name, "glCreateProgram") == 0 ||
453 strcmp(name, "glCreateProgramObjectARB") == 0) {
455 GLuint program = call->ret->toUInt();
456 providef("program-", program, call->no);
460 if (strcmp(name, "glAttachShader") == 0 ||
461 strcmp(name, "glAttachObjectARB") == 0) {
463 GLuint program, shader;
464 std::stringstream ss_program, ss_shader;
466 program = call->arg(0).toUInt();
467 shader = call->arg(1).toUInt();
469 ss_program << "program-" << program;
470 ss_shader << "shader-" << shader;
472 link(ss_program.str(), ss_shader.str());
473 provide(ss_program.str(), call->no);
478 if (strcmp(name, "glDetachShader") == 0 ||
479 strcmp(name, "glDetachObjectARB") == 0) {
481 GLuint program, shader;
482 std::stringstream ss_program, ss_shader;
484 program = call->arg(0).toUInt();
485 shader = call->arg(1).toUInt();
487 ss_program << "program-" << program;
488 ss_shader << "shader-" << shader;
490 unlink(ss_program.str(), ss_shader.str());
495 if (strcmp(name, "glUseProgram") == 0 ||
496 strcmp(name, "glUseProgramObjectARB") == 0) {
500 program = call->arg(0).toUInt();
502 unlinkAll("render-program-state");
505 unlink("render-state", "render-program-state");
506 provide("state", call->no);
508 std::stringstream ss;
510 ss << "program-" << program;
512 link("render-state", "render-program-state");
513 link("render-program-state", ss.str());
515 provide(ss.str(), call->no);
521 if (strcmp(name, "glGetUniformLocation") == 0 ||
522 strcmp(name, "glGetUniformLocationARB") == 0 ||
523 strcmp(name, "glGetFragDataLocation") == 0 ||
524 strcmp(name, "glGetFragDataLocationEXT") == 0 ||
525 strcmp(name, "glGetSubroutineUniformLocation") == 0 ||
526 strcmp(name, "glGetProgramResourceLocation") == 0 ||
527 strcmp(name, "glGetProgramResourceLocationIndex") == 0 ||
528 strcmp(name, "glGetVaryingLocationNV") == 0) {
530 GLuint program = call->arg(0).toUInt();
532 providef("program-", program, call->no);
537 /* For any call that accepts 'location' as its first argument,
538 * perform a lookup in our location->program map and add a
539 * dependence on the program we find there. */
540 if (call->sig->num_args > 0 &&
541 strcmp(call->sig->arg_names[0], "location") == 0) {
543 providef("program-", activeProgram, call->no);
545 /* We can't easily tell if this uniform is being used to
546 * associate a sampler in the shader with a texture
547 * unit. The conservative option is to assume that it is
548 * and create a link from the active program to any bound
549 * textures for the given unit number.
551 * FIXME: We should be doing the same thing for calls to
553 if (strcmp(name, "glUniform1i") == 0 ||
554 strcmp(name, "glUniform1iARB") == 0) {
556 GLint max_unit = MAX(GL_MAX_TEXTURE_COORDS, GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS);
558 GLint unit = call->arg(1).toSInt();
559 std::stringstream ss_program;
560 std::stringstream ss_texture;
562 if (unit < max_unit) {
564 ss_program << "program-" << activeProgram;
566 ss_texture << "texture-unit-" << GL_TEXTURE0 + unit << "-target-";
568 /* We don't know what target(s) might get bound to
569 * this texture unit, so conservatively link to
570 * all. Only bound textures will actually get inserted
571 * into the output call stream. */
572 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_1D);
573 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_2D);
574 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_3D);
575 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_CUBE_MAP);
582 /* FIXME: We cut a huge swath by assuming that any unhandled
583 * call that has a first argument named "program" should not
584 * be included in the trimmed output unless the program of
585 * that number is also included.
587 * This heuristic is correct for many cases, but we should
588 * actually carefully verify if this includes some calls
589 * inappropriately, or if it misses some.
591 if (strcmp(name, "glLinkProgram") == 0 ||
592 strcmp(name, "glLinkProgramARB") == 0 ||
593 (call->sig->num_args > 0 &&
594 (strcmp(call->sig->arg_names[0], "program") == 0 ||
595 strcmp(call->sig->arg_names[0], "programObj") == 0))) {
597 GLuint program = call->arg(0).toUInt();
598 providef("program-", program, call->no);
602 /* No known shader-related side effects. Return false for more analysis. */
607 TraceAnalyzer::recordDrawingSideEffects(trace::Call *call, const char *name)
609 /* Handle all rendering operations, (even though only glEnd is
610 * flagged as a rendering operation we treat everything from
611 * glBegin through glEnd as a rendering operation). */
612 if (call->flags & trace::CALL_FLAG_RENDER ||
615 std::set<unsigned> calls;
616 std::set<unsigned>::iterator c;
618 provide("framebuffer", call->no);
620 calls = resolve("render-state");
622 for (c = calls.begin(); c != calls.end(); c++) {
623 provide("framebuffer", *c);
626 /* In some cases, rendering has side effects beyond the
627 * framebuffer update. */
628 if (renderingHasSideEffect()) {
629 provide("state", call->no);
630 for (c = calls.begin(); c != calls.end(); c++) {
631 provide("state", *c);
638 /* No known drawing-related side effects. Return false for more analysis. */
643 TraceAnalyzer::recordSideEffects(trace::Call *call)
646 const char *name = call->name();
648 /* FIXME: If we encode the list of commands that are executed
649 * immediately (as opposed to those that are compiled into a
650 * display list) then we could generate a "display-list-X"
651 * resource just as we do for "texture-X" resources and only
652 * emit it in the trace if a glCallList(X) is emitted. For
653 * now, simply punt and include anything within glNewList and
654 * glEndList in the trim output. This guarantees that display
655 * lists will work, but does not trim out unused display
657 if (insideNewEndList != 0) {
658 provide("state", call->no);
660 /* Also, any texture bound inside a display list is
661 * conservatively considered required. */
662 if (strcmp(name, "glBindTexture") == 0) {
663 GLuint texture = call->arg(1).toUInt();
665 linkf("state", "texture-", texture);
671 if (trimFlags & TRIM_FLAG_NO_SIDE_EFFECTS) {
673 if (callHasNoSideEffects(call, name)) {
678 if (trimFlags & TRIM_FLAG_TEXTURES) {
680 if (recordTextureSideEffects(call, name)) {
685 if (trimFlags & TRIM_FLAG_SHADERS) {
687 if (recordShaderSideEffects(call, name)) {
692 if (trimFlags & TRIM_FLAG_DRAWING) {
694 if (recordDrawingSideEffects(call, name)) {
699 /* By default, assume this call affects the state somehow. */
700 resources["state"].insert(call->no);
704 TraceAnalyzer::requireDependencies(trace::Call *call)
707 /* Swap-buffers calls depend on framebuffer state. */
708 if (call->flags & trace::CALL_FLAG_SWAP_RENDERTARGET &&
709 call->flags & trace::CALL_FLAG_END_FRAME) {
710 consume("framebuffer");
713 /* By default, just assume this call depends on generic state. */
717 TraceAnalyzer::TraceAnalyzer(TrimFlags trimFlagsOpt = -1):
718 transformFeedbackActive(false),
719 framebufferObjectActive(false),
720 insideBeginEnd(false),
722 activeTextureUnit(GL_TEXTURE0),
723 trimFlags(trimFlagsOpt)
725 /* Nothing needed. */
728 TraceAnalyzer::~TraceAnalyzer()
730 /* Nothing needed. */
733 /* Analyze this call by tracking state and recording all the
734 * resources provided by this call as side effects.. */
736 TraceAnalyzer::analyze(trace::Call *call)
739 stateTrackPreCall(call);
741 recordSideEffects(call);
743 stateTrackPostCall(call);
746 /* Require this call and all of its dependencies to be included in
747 * the final trace. */
749 TraceAnalyzer::require(trace::Call *call)
752 /* First, find and insert all calls that this call depends on. */
753 requireDependencies(call);
755 /* Then insert this call itself. */
756 required.insert(call->no);
759 /* Return a set of all the required calls, (both those calls added
760 * explicitly with require() and those implicitly depended
763 TraceAnalyzer::get_required(void)