]> git.cworth.org Git - apitrace/blob - cli/trace_analyzer.cpp
9a4553edc1895418ea9b745ad4a9562a34dd986d
[apitrace] / cli / trace_analyzer.cpp
1 /**************************************************************************
2  * Copyright 2012 Intel corporation
3  *
4  * All Rights Reserved.
5  *
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:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
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
22  * THE SOFTWARE.
23  *
24  **************************************************************************/
25
26 #include <sstream>
27
28 #include "trace_analyzer.hpp"
29
30 #define MAX(a, b) ((a) > (b) ? (a) : (b))
31 #define STRNCMP_LITERAL(var, literal) strncmp((var), (literal), sizeof (literal) -1)
32
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). */
36 bool
37 TraceAnalyzer::renderingHasSideEffect(void)
38 {
39     return transformFeedbackActive || framebufferObjectActive;
40 }
41
42 /* Provide: Record that the given call affects the given resource
43  * as a side effect. */
44 void
45 TraceAnalyzer::provide(std::string resource, trace::CallNo call_no)
46 {
47     resources[resource].insert(call_no);
48 }
49
50 /* Like provide, but with a simply-formatted string, (appending an
51  * integer to the given string). */
52 void
53 TraceAnalyzer::providef(std::string resource,
54                         int resource_no,
55                         trace::CallNo call_no)
56 {
57     std::stringstream ss;
58     ss << resource << resource_no;
59     provide(ss.str(), call_no);
60 }
61
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
66  * captured. */
67 void
68 TraceAnalyzer::link(std::string resource, std::string dependency)
69 {
70     dependencies[resource].insert(dependency);
71 }
72
73 /* Like link, but with a simply-formatted string, (appending an
74  * integer to the given string). */
75 void
76 TraceAnalyzer::linkf(std::string resource, std::string dependency, int dep_no)
77 {
78
79     std::stringstream ss;
80     ss << dependency << dep_no;
81     link(resource, ss.str());
82 }
83
84 /* Unlink: Remove dependency from 'resource' on 'dependency'. */
85 void
86 TraceAnalyzer::unlink(std::string resource, std::string dependency)
87 {
88     dependencies[resource].erase(dependency);
89     if (dependencies[resource].size() == 0) {
90         dependencies.erase(resource);
91     }
92 }
93
94 /* Like unlink, but with a simply-formated string, (appending an
95  * integer to the given string). */
96 void
97 TraceAnalyzer::unlinkf(std::string resource, std::string dependency, int dep_no)
98 {
99
100     std::stringstream ss;
101     ss << dependency << dep_no;
102     unlink(resource, ss.str());
103 }
104
105 /* Unlink all: Remove dependencies from 'resource' to all other
106  * resources. */
107 void
108 TraceAnalyzer::unlinkAll(std::string resource)
109 {
110     dependencies.erase(resource);
111 }
112
113 /* Resolve: Recursively compute all calls providing 'resource',
114  * (including linked dependencies of 'resource' on other
115  * resources). */
116 std::set<unsigned>
117 TraceAnalyzer::resolve(std::string resource)
118 {
119     std::set<std::string> *deps;
120     std::set<std::string>::iterator dep;
121
122     std::set<unsigned> *calls;
123     std::set<unsigned>::iterator call;
124
125     std::set<unsigned> result, deps_set;
126
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);
134             }
135         }
136     }
137
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);
143         }
144     }
145
146     return result;
147 }
148
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. */
152 void
153 TraceAnalyzer::consume(std::string resource)
154 {
155
156     std::set<unsigned> calls;
157     std::set<unsigned>::iterator call;
158
159     calls = resolve(resource);
160
161     dependencies.erase(resource);
162     resources.erase(resource);
163
164     for (call = calls.begin(); call != calls.end(); call++) {
165         required.insert(*call);
166     }
167 }
168
169 void
170 TraceAnalyzer::stateTrackPreCall(trace::Call *call)
171 {
172
173     const char *name = call->name();
174
175     if (strcmp(name, "glBegin") == 0) {
176         insideBeginEnd = true;
177         return;
178     }
179
180     if (strcmp(name, "glBeginTransformFeedback") == 0) {
181         transformFeedbackActive = true;
182         return;
183     }
184
185     if (strcmp(name, "glActiveTexture") == 0) {
186         activeTextureUnit = static_cast<GLenum>(call->arg(0).toSInt());
187         return;
188     }
189
190     if (strcmp(name, "glBindTexture") == 0) {
191         GLenum target;
192         GLuint texture;
193
194         target = static_cast<GLenum>(call->arg(0).toSInt());
195         texture = call->arg(1).toUInt();
196
197         if (texture == 0) {
198             texture_map.erase(target);
199         } else {
200             texture_map[target] = texture;
201         }
202
203         return;
204     }
205
206     if (strcmp(name, "glUseProgram") == 0) {
207         activeProgram = call->arg(0).toUInt();
208     }
209
210     if (strcmp(name, "glBindFramebuffer") == 0) {
211         GLenum target;
212         GLuint framebuffer;
213
214         target = static_cast<GLenum>(call->arg(0).toSInt());
215         framebuffer = call->arg(1).toUInt();
216
217         if (target == GL_FRAMEBUFFER || target == GL_DRAW_FRAMEBUFFER) {
218             if (framebuffer == 0) {
219                 framebufferObjectActive = false;
220             } else {
221                 framebufferObjectActive = true;
222             }
223         }
224         return;
225     }
226
227     if (strcmp(name, "glNewList") == 0) {
228         GLuint list = call->arg(0).toUInt();
229
230         insideNewEndList = list;
231     }
232 }
233
234 void
235 TraceAnalyzer::stateTrackPostCall(trace::Call *call)
236 {
237
238     const char *name = call->name();
239
240     if (strcmp(name, "glEnd") == 0) {
241         insideBeginEnd = false;
242         return;
243     }
244
245     if (strcmp(name, "glEndTransformFeedback") == 0) {
246         transformFeedbackActive = false;
247         return;
248     }
249
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
253      * next frame. */
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");
258         return;
259     }
260
261     if (strcmp(name, "glEndList") == 0) {
262         insideNewEndList = 0;
263     }
264 }
265
266 void
267 TraceAnalyzer::recordSideEffects(trace::Call *call)
268 {
269
270     const char *name = call->name();
271
272     /* Handle display lists before any other processing. */
273
274     /* FIXME: If we encode the list of commands that are executed
275      * immediately (as opposed to those that are compiled into a
276      * display list) then we could generate a "display-list-X"
277      * resource just as we do for "texture-X" resources and only
278      * emit it in the trace if a glCallList(X) is emitted. For
279      * now, simply punt and include anything within glNewList and
280      * glEndList in the trim output. This guarantees that display
281      * lists will work, but does not trim out unused display
282      * lists. */
283     if (insideNewEndList != 0) {
284         provide("state", call->no);
285
286         /* Also, any texture bound inside a display list is
287          * conservatively considered required. */
288         if (strcmp(name, "glBindTexture") == 0) {
289             GLuint texture = call->arg(1).toUInt();
290
291             linkf("state", "texture-", texture);
292         }
293
294         return;
295     }
296
297     /* If call is flagged as no side effects, then we are done here. */
298     if (call->flags & trace::CALL_FLAG_NO_SIDE_EFFECTS) {
299         return;
300     }
301
302     /* Similarly, swap-buffers calls don't have interesting side effects. */
303     if (call->flags & trace::CALL_FLAG_SWAP_RENDERTARGET &&
304         call->flags & trace::CALL_FLAG_END_FRAME) {
305         return;
306     }
307
308     if (strcmp(name, "glGenTextures") == 0) {
309         const trace::Array *textures = dynamic_cast<const trace::Array *>(&call->arg(1));
310         size_t i;
311         GLuint texture;
312
313         if (textures) {
314             for (i = 0; i < textures->size(); i++) {
315                 texture = textures->values[i]->toUInt();
316                 providef("texture-", texture, call->no);
317             }
318         }
319         return;
320     }
321
322     /* FIXME: When we start tracking framebuffer objects as their own
323      * resources, we will want to link the FBO to the given texture
324      * resource, (and to this call). For now, just link render state
325      * to the texture, and force this call to be required. */
326     if (strcmp(name, "glFramebufferTexture2D") == 0) {
327         GLuint texture;
328
329         texture = call->arg(3).toUInt();
330
331         linkf("render-state", "texture-", texture);
332
333         required.insert(call->no);
334     }
335
336     if (strcmp(name, "glBindTexture") == 0) {
337         GLenum target;
338         GLuint texture;
339
340         std::stringstream ss_target, ss_texture;
341
342         target = static_cast<GLenum>(call->arg(0).toSInt());
343         texture = call->arg(1).toUInt();
344
345         ss_target << "texture-unit-" << activeTextureUnit << "-target-" << target;
346         ss_texture << "texture-" << texture;
347
348         resources.erase(ss_target.str());
349         provide(ss_target.str(), call->no);
350
351         unlinkAll(ss_target.str());
352         link(ss_target.str(), ss_texture.str());
353
354         /* FIXME: This really shouldn't be necessary. The effect
355          * this provide() has is that all glBindTexture calls will
356          * be preserved in the output trace (never trimmed). Carl
357          * has a trace ("btr") where a glBindTexture call should
358          * not be necessary at all, (it's immediately followed
359          * with a glBindTexture to a different texture and no
360          * intervening texture-related calls), yet this 'provide'
361          * makes the difference between a trim_stress test failing
362          * and passing.
363          *
364          * More investigation is necessary, but for now, be
365          * conservative and don't trim. */
366         provide("state", call->no);
367
368         return;
369     }
370
371     /* FIXME: Need to handle glMultTetImage and friends. */
372     if (STRNCMP_LITERAL(name, "glTexImage") == 0 ||
373         STRNCMP_LITERAL(name, "glTexSubImage") == 0 ||
374         STRNCMP_LITERAL(name, "glCopyTexImage") == 0 ||
375         STRNCMP_LITERAL(name, "glCopyTexSubImage") == 0 ||
376         STRNCMP_LITERAL(name, "glCompressedTexImage") == 0 ||
377         STRNCMP_LITERAL(name, "glCompressedTexSubImage") == 0 ||
378         strcmp(name, "glInvalidateTexImage") == 0 ||
379         strcmp(name, "glInvalidateTexSubImage") == 0) {
380
381         std::set<unsigned> *calls;
382         std::set<unsigned>::iterator c;
383         std::stringstream ss_target, ss_texture;
384
385         GLenum target = static_cast<GLenum>(call->arg(0).toSInt());
386
387         ss_target << "texture-unit-" << activeTextureUnit << "-target-" << target;
388         ss_texture << "texture-" << texture_map[target];
389
390         /* The texture resource depends on this call and any calls
391          * providing the given texture target. */
392         provide(ss_texture.str(), call->no);
393
394         if (resources.count(ss_target.str())) {
395             calls = &resources[ss_target.str()];
396             for (c = calls->begin(); c != calls->end(); c++) {
397                 provide(ss_texture.str(), *c);
398             }
399         }
400
401         return;
402     }
403
404     if (strcmp(name, "glEnable") == 0) {
405         GLenum cap;
406
407         cap = static_cast<GLenum>(call->arg(0).toSInt());
408
409         if (cap == GL_TEXTURE_1D ||
410             cap == GL_TEXTURE_2D ||
411             cap == GL_TEXTURE_3D ||
412             cap == GL_TEXTURE_CUBE_MAP)
413         {
414             std::stringstream ss;
415
416             ss << "texture-unit-" << activeTextureUnit << "-target-" << cap;
417
418             link("render-state", ss.str());
419         }
420
421         provide("state", call->no);
422         return;
423     }
424
425     if (strcmp(name, "glDisable") == 0) {
426         GLenum cap;
427
428         cap = static_cast<GLenum>(call->arg(0).toSInt());
429
430         if (cap == GL_TEXTURE_1D ||
431             cap == GL_TEXTURE_2D ||
432             cap == GL_TEXTURE_3D ||
433             cap == GL_TEXTURE_CUBE_MAP)
434         {
435             std::stringstream ss;
436
437             ss << "texture-unit-" << activeTextureUnit << "-target-" << cap;
438
439             unlink("render-state", ss.str());
440         }
441
442         provide("state", call->no);
443         return;
444     }
445
446     if (strcmp(name, "glCreateShader") == 0 ||
447         strcmp(name, "glCreateShaderObjectARB") == 0) {
448
449         GLuint shader = call->ret->toUInt();
450         providef("shader-", shader, call->no);
451         return;
452     }
453
454     if (strcmp(name, "glShaderSource") == 0 ||
455         strcmp(name, "glShaderSourceARB") == 0 ||
456         strcmp(name, "glCompileShader") == 0 ||
457         strcmp(name, "glCompileShaderARB") == 0 ||
458         strcmp(name, "glGetShaderiv") == 0 ||
459         strcmp(name, "glGetShaderInfoLog") == 0) {
460
461         GLuint shader = call->arg(0).toUInt();
462         providef("shader-", shader, call->no);
463         return;
464     }
465
466     if (strcmp(name, "glCreateProgram") == 0 ||
467         strcmp(name, "glCreateProgramObjectARB") == 0) {
468
469         GLuint program = call->ret->toUInt();
470         providef("program-", program, call->no);
471         return;
472     }
473
474     if (strcmp(name, "glAttachShader") == 0 ||
475         strcmp(name, "glAttachObjectARB") == 0) {
476
477         GLuint program, shader;
478         std::stringstream ss_program, ss_shader;
479
480         program = call->arg(0).toUInt();
481         shader = call->arg(1).toUInt();
482
483         ss_program << "program-" << program;
484         ss_shader << "shader-" << shader;
485
486         link(ss_program.str(), ss_shader.str());
487         provide(ss_program.str(), call->no);
488
489         return;
490     }
491
492     if (strcmp(name, "glDetachShader") == 0 ||
493         strcmp(name, "glDetachObjectARB") == 0) {
494
495         GLuint program, shader;
496         std::stringstream ss_program, ss_shader;
497
498         program = call->arg(0).toUInt();
499         shader = call->arg(1).toUInt();
500
501         ss_program << "program-" << program;
502         ss_shader << "shader-" << shader;
503
504         unlink(ss_program.str(), ss_shader.str());
505
506         return;
507     }
508
509     if (strcmp(name, "glUseProgram") == 0 ||
510         strcmp(name, "glUseProgramObjectARB") == 0) {
511
512         GLuint program;
513
514         program = call->arg(0).toUInt();
515
516         unlinkAll("render-program-state");
517
518         if (program == 0) {
519             unlink("render-state", "render-program-state");
520             provide("state", call->no);
521         } else {
522             std::stringstream ss;
523
524             ss << "program-" << program;
525
526             link("render-state", "render-program-state");
527             link("render-program-state", ss.str());
528
529             provide(ss.str(), call->no);
530         }
531
532         return;
533     }
534
535     if (strcmp(name, "glGetUniformLocation") == 0 ||
536         strcmp(name, "glGetUniformLocationARB") == 0 ||
537         strcmp(name, "glGetFragDataLocation") == 0 ||
538         strcmp(name, "glGetFragDataLocationEXT") == 0 ||
539         strcmp(name, "glGetSubroutineUniformLocation") == 0 ||
540         strcmp(name, "glGetProgramResourceLocation") == 0 ||
541         strcmp(name, "glGetProgramResourceLocationIndex") == 0 ||
542         strcmp(name, "glGetVaryingLocationNV") == 0) {
543
544         GLuint program = call->arg(0).toUInt();
545
546         providef("program-", program, call->no);
547
548         return;
549     }
550
551     /* For any call that accepts 'location' as its first argument,
552      * perform a lookup in our location->program map and add a
553      * dependence on the program we find there. */
554     if (call->sig->num_args > 0 &&
555         strcmp(call->sig->arg_names[0], "location") == 0) {
556
557         providef("program-", activeProgram, call->no);
558
559         /* We can't easily tell if this uniform is being used to
560          * associate a sampler in the shader with a texture
561          * unit. The conservative option is to assume that it is
562          * and create a link from the active program to any bound
563          * textures for the given unit number.
564          *
565          * FIXME: We should be doing the same thing for calls to
566          * glUniform1iv. */
567         if (strcmp(name, "glUniform1i") == 0 ||
568             strcmp(name, "glUniform1iARB") == 0) {
569
570             GLint max_unit = MAX(GL_MAX_TEXTURE_COORDS, GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS);
571
572             GLint unit = call->arg(1).toSInt();
573             std::stringstream ss_program;
574             std::stringstream ss_texture;
575
576             if (unit < max_unit) {
577
578                 ss_program << "program-" << activeProgram;
579
580                 ss_texture << "texture-unit-" << GL_TEXTURE0 + unit << "-target-";
581
582                 /* We don't know what target(s) might get bound to
583                  * this texture unit, so conservatively link to
584                  * all. Only bound textures will actually get inserted
585                  * into the output call stream. */
586                 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_1D);
587                 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_2D);
588                 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_3D);
589                 linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_CUBE_MAP);
590             }
591         }
592
593         return;
594     }
595
596     /* FIXME: We cut a huge swath by assuming that any unhandled
597      * call that has a first argument named "program" should not
598      * be included in the trimmed output unless the program of
599      * that number is also included.
600      *
601      * This heuristic is correct for many cases, but we should
602      * actually carefully verify if this includes some calls
603      * inappropriately, or if it misses some.
604      */
605     if (strcmp(name, "glLinkProgram") == 0 ||
606         strcmp(name, "glLinkProgramARB") == 0 ||
607         (call->sig->num_args > 0 &&
608          (strcmp(call->sig->arg_names[0], "program") == 0 ||
609           strcmp(call->sig->arg_names[0], "programObj") == 0))) {
610
611         GLuint program = call->arg(0).toUInt();
612         providef("program-", program, call->no);
613         return;
614     }
615
616     /* Handle all rendering operations, (even though only glEnd is
617      * flagged as a rendering operation we treat everything from
618      * glBegin through glEnd as a rendering operation). */
619     if (call->flags & trace::CALL_FLAG_RENDER ||
620         insideBeginEnd) {
621
622         std::set<unsigned> calls;
623         std::set<unsigned>::iterator c;
624
625         provide("framebuffer", call->no);
626
627         calls = resolve("render-state");
628
629         for (c = calls.begin(); c != calls.end(); c++) {
630             provide("framebuffer", *c);
631         }
632
633         /* In some cases, rendering has side effects beyond the
634          * framebuffer update. */
635         if (renderingHasSideEffect()) {
636             provide("state", call->no);
637             for (c = calls.begin(); c != calls.end(); c++) {
638                 provide("state", *c);
639             }
640         }
641
642         return;
643     }
644
645     /* By default, assume this call affects the state somehow. */
646     resources["state"].insert(call->no);
647 }
648
649 void
650 TraceAnalyzer::requireDependencies(trace::Call *call)
651 {
652
653     /* Swap-buffers calls depend on framebuffer state. */
654     if (call->flags & trace::CALL_FLAG_SWAP_RENDERTARGET &&
655         call->flags & trace::CALL_FLAG_END_FRAME) {
656         consume("framebuffer");
657     }
658
659     /* By default, just assume this call depends on generic state. */
660     consume("state");
661 }
662
663 TraceAnalyzer::TraceAnalyzer(): transformFeedbackActive(false),
664                                framebufferObjectActive(false),
665                                insideBeginEnd(false),
666                                insideNewEndList(0),
667                                activeTextureUnit(GL_TEXTURE0)
668 {
669     /* Nothing needed. */
670 }
671
672 TraceAnalyzer::~TraceAnalyzer()
673 {
674     /* Nothing needed. */
675 }
676
677 /* Analyze this call by tracking state and recording all the
678  * resources provided by this call as side effects.. */
679 void
680 TraceAnalyzer::analyze(trace::Call *call)
681 {
682
683     stateTrackPreCall(call);
684
685     recordSideEffects(call);
686
687     stateTrackPostCall(call);
688 }
689
690 /* Require this call and all of its dependencies to be included in
691  * the final trace. */
692 void
693 TraceAnalyzer::require(trace::Call *call)
694 {
695
696     /* First, find and insert all calls that this call depends on. */
697     requireDependencies(call);
698
699     /* Then insert this call itself. */
700     required.insert(call->no);
701 }
702
703 /* Return a set of all the required calls, (both those calls added
704  * explicitly with require() and those implicitly depended
705  * upon. */
706 std::set<unsigned>  *
707 TraceAnalyzer::get_required(void)
708 {
709     return &required;
710 }