#include "trace_parser.hpp"
#include "trace_writer.hpp"
+#define MAX(a, b) ((a) > (b) ? (a) : (b))
#define STRNCMP_LITERAL(var, literal) strncmp((var), (literal), sizeof (literal) -1)
static const char *synopsis = "Create a new trace by trimming an existing trace.";
"\n"
" -h, --help Show detailed help for trim options and exit\n"
" --calls=CALLSET Include specified calls in the trimmed output.\n"
+ " --frames=FRAMESET Include specified frames in the trimmed output.\n"
" --deps Include additional calls to satisfy dependencies\n"
" --no-deps Do not include calls from dependency analysis\n"
" --prune Omit uninteresting calls from the trace output\n"
" --no-prune Do not prune uninteresting calls from the trace.\n"
- " -x, --exact Include exactly the calls specified in --calls\n"
+ " -x, --exact Trim exactly to calls specified in --calls/--frames\n"
" Equivalent to both --no-deps and --no-prune\n"
+ " --print-callset Print the final set of calls included in output\n"
" --thread=THREAD_ID Only retain calls from specified thread\n"
" -o, --output=TRACE_FILE Output trace file\n"
;
" -h, --help Show this help message and exit\n"
"\n"
" --calls=CALLSET Include specified calls in the trimmed output.\n"
+ " --frames=FRAMESET Include specified frames in the trimmed output.\n"
" Note that due to dependency analysis and pruning\n"
" of uninteresting calls the resulting trace may\n"
" include more and less calls than specified.\n"
"\n"
" --deps Perform dependency analysis and include dependent\n"
" calls as needed, (even if those calls were not\n"
- " explicitly requested with --calls). This is the\n"
- " default behavior. See --no-deps and --exact.\n"
+ " explicitly requested with --calls or --frames).\n"
+ " This is the default behavior. See --no-deps and\n"
+ " --exact to change the behavior.\n"
"\n"
" --no-deps Do not perform dependency analysis. In this mode\n"
" the trimmed trace will never include calls from\n"
- " outside the range specified in --calls.\n"
+ " outside what is specified in --calls or --frames.\n"
"\n"
- " --prune Omit calls that have no side effects, even if the\n"
- " call is within the range specified by --calls.\n"
- " This is the default behavior. See --no-prune\n"
+ " --prune Omit calls with no side effects, even if the call\n"
+ " is within the range specified by --calls/--frames.\n"
+ " This is the default behavior. See --no-prune.\n"
"\n"
" --no-prune Do not prune uninteresting calls from the trace.\n"
" In this mode the trimmed trace will never omit\n"
- " any calls within the range specified in --calls.\n"
+ " any calls within the user-specified range.\n"
"\n"
" -x, --exact Trim the trace to exactly the calls specified in\n"
- " --calls. This option is equivalent to passing\n"
- " both --no-deps and --no-prune.\n"
+ " --calls and --frames. This option is equivalent\n"
+ " to passing both --no-deps and --no-prune.\n"
+ "\n"
+ " --print-callset Print to stdout the final set of calls included\n"
+ " in the trim output. This can be useful for\n"
+ " debugging trim operations by using a modified\n"
+ " callset on the command-line along with --exact.\n"
+ " Use --calls=@<file> to read callset from a file.\n"
"\n"
" --thread=THREAD_ID Only retain calls from specified thread\n"
"\n"
enum {
CALLS_OPT = CHAR_MAX + 1,
+ FRAMES_OPT,
DEPS_OPT,
NO_DEPS_OPT,
PRUNE_OPT,
NO_PRUNE_OPT,
THREAD_OPT,
+ PRINT_CALLSET_OPT,
};
const static char *
longOptions[] = {
{"help", no_argument, 0, 'h'},
{"calls", required_argument, 0, CALLS_OPT},
+ {"frames", required_argument, 0, FRAMES_OPT},
{"deps", no_argument, 0, DEPS_OPT},
{"no-deps", no_argument, 0, NO_DEPS_OPT},
{"prune", no_argument, 0, PRUNE_OPT},
{"exact", no_argument, 0, 'x'},
{"thread", required_argument, 0, THREAD_OPT},
{"output", required_argument, 0, 'o'},
+ {"print-callset", no_argument, 0, PRINT_CALLSET_OPT},
{0, 0, 0, 0}
};
/* Maps for tracking OpenGL state. */
std::map<GLenum, unsigned> texture_map;
- std::map<GLint, GLuint> location_program_map;
/* The final set of calls required. This consists of calls added
* explicitly with the require() method as well as all calls
bool transformFeedbackActive;
bool framebufferObjectActive;
bool insideBeginEnd;
+ GLuint insideNewEndList;
+ GLuint activeProgram;
+ GLenum activeTextureUnit;
/* Rendering often has no side effects, but it can in some cases,
* (such as when transform feedback is active, or when rendering
resources[resource].insert(call_no);
}
+ /* Like provide, but with a simply-formatted string, (appending an
+ * integer to the given string). */
+ void providef(std::string resource, int resource_no, trace::CallNo call_no) {
+ std::stringstream ss;
+ ss << resource << resource_no;
+ provide(ss.str(), call_no);
+ }
+
/* Link: Establish a dependency between resource 'resource' and
* resource 'dependency'. This dependency is captured by name so
* that if the list of calls that provide 'dependency' grows
dependencies[resource].insert(dependency);
}
+ /* Like link, but with a simply-formatted string, (appending an
+ * integer to the given string). */
+ void linkf(std::string resource, std::string dependency, int dep_no) {
+
+ std::stringstream ss;
+ ss << dependency << dep_no;
+ link(resource, ss.str());
+ }
+
/* Unlink: Remove dependency from 'resource' on 'dependency'. */
void unlink(std::string resource, std::string dependency) {
dependencies[resource].erase(dependency);
}
}
+ /* Like unlink, but with a simply-formated string, (appending an
+ * integer to the given string). */
+ void unlinkf(std::string resource, std::string dependency, int dep_no) {
+
+ std::stringstream ss;
+ ss << dependency << dep_no;
+ unlink(resource, ss.str());
+ }
+
/* Unlink all: Remove dependencies from 'resource' to all other
* resources. */
void unlinkAll(std::string resource) {
return;
}
+ if (strcmp(name, "glActiveTexture") == 0) {
+ activeTextureUnit = static_cast<GLenum>(call->arg(0).toSInt());
+ return;
+ }
+
if (strcmp(name, "glBindTexture") == 0) {
GLenum target;
GLuint texture;
return;
}
+ if (strcmp(name, "glUseProgram") == 0) {
+ activeProgram = call->arg(0).toUInt();
+ }
+
if (strcmp(name, "glBindFramebuffer") == 0) {
GLenum target;
GLuint framebuffer;
}
return;
}
+
+ if (strcmp(name, "glNewList") == 0) {
+ GLuint list = call->arg(0).toUInt();
+
+ insideNewEndList = list;
+ }
}
void stateTrackPostCall(trace::Call *call) {
resources.erase("framebuffer");
return;
}
+
+ if (strcmp(name, "glEndList") == 0) {
+ insideNewEndList = 0;
+ }
}
void recordSideEffects(trace::Call *call) {
const char *name = call->name();
+ /* Handle display lists before any other processing. */
+
+ /* FIXME: If we encode the list of commands that are executed
+ * immediately (as opposed to those that are compiled into a
+ * display list) then we could generate a "display-list-X"
+ * resource just as we do for "texture-X" resources and only
+ * emit it in the trace if a glCallList(X) is emitted. For
+ * now, simply punt and include anything within glNewList and
+ * glEndList in the trim output. This guarantees that display
+ * lists will work, but does not trim out unused display
+ * lists. */
+ if (insideNewEndList != 0) {
+ provide("state", call->no);
+ return;
+ }
+
/* If call is flagged as no side effects, then we are done here. */
if (call->flags & trace::CALL_FLAG_NO_SIDE_EFFECTS) {
return;
if (textures) {
for (i = 0; i < textures->size(); i++) {
- std::stringstream ss;
-
texture = textures->values[i]->toUInt();
- ss << "texture-" << texture;
-
- provide(ss.str(), call->no);
+ providef("texture-", texture, call->no);
}
}
return;
target = static_cast<GLenum>(call->arg(0).toSInt());
texture = call->arg(1).toUInt();
- ss_target << "texture-target-" << target;
+ ss_target << "texture-unit-" << activeTextureUnit << "-target-" << target;
ss_texture << "texture-" << texture;
resources.erase(ss_target.str());
GLenum target = static_cast<GLenum>(call->arg(0).toSInt());
- ss_target << "texture-target-" << target;
+ ss_target << "texture-unit-" << activeTextureUnit << "-target-" << target;
ss_texture << "texture-" << texture_map[target];
/* The texture resource depends on this call and any calls
{
std::stringstream ss;
- ss << "texture-target-" << cap;
+ ss << "texture-unit-" << activeTextureUnit << "-target-" << cap;
link("render-state", ss.str());
}
provide("state", call->no);
-
return;
}
{
std::stringstream ss;
- ss << "texture-target-" << cap;
+ ss << "texture-unit-" << activeTextureUnit << "-target-" << cap;
unlink("render-state", ss.str());
}
provide("state", call->no);
-
return;
}
if (strcmp(name, "glCreateShader") == 0 ||
strcmp(name, "glCreateShaderObjectARB") == 0) {
- GLuint shader;
- std::stringstream ss;
-
- shader = call->ret->toUInt();
-
- ss << "shader-" << shader;
-
- provide(ss.str(), call->no);
-
+ GLuint shader = call->ret->toUInt();
+ providef("shader-", shader, call->no);
return;
}
strcmp(name, "glGetShaderiv") == 0 ||
strcmp(name, "glGetShaderInfoLog") == 0) {
- GLuint shader;
- std::stringstream ss;
-
- shader = call->arg(0).toUInt();
-
- ss << "shader-" << shader;
-
- provide(ss.str(), call->no);
-
+ GLuint shader = call->arg(0).toUInt();
+ providef("shader-", shader, call->no);
return;
}
if (strcmp(name, "glCreateProgram") == 0 ||
strcmp(name, "glCreateProgramObjectARB") == 0) {
- GLuint program;
- std::stringstream ss;
-
- program = call->ret->toUInt();
-
- ss << "program-" << program;
-
- provide(ss.str(), call->no);
-
+ GLuint program = call->ret->toUInt();
+ providef("program-", program, call->no);
return;
}
strcmp(name, "glGetProgramResourceLocationIndex") == 0 ||
strcmp(name, "glGetVaryingLocationNV") == 0) {
- GLuint program;
- GLint location;
- std::stringstream ss;
-
- program = call->arg(0).toUInt();
- location = call->ret->toSInt();
-
- location_program_map[location] = program;
+ GLuint program = call->arg(0).toUInt();
- ss << "program-" << program;
-
- provide(ss.str(), call->no);
+ providef("program-", program, call->no);
return;
}
if (call->sig->num_args > 0 &&
strcmp(call->sig->arg_names[0], "location") == 0) {
- GLuint program;
- GLint location;
- std::stringstream ss;
+ providef("program-", activeProgram, call->no);
+
+ /* We can't easily tell if this uniform is being used to
+ * associate a sampler in the shader with a texture
+ * unit. The conservative option is to assume that it is
+ * and create a link from the active program to any bound
+ * textures for the given unit number.
+ *
+ * FIXME: We should be doing the same thing for calls to
+ * glUniform1iv. */
+ if (strcmp(name, "glUniform1i") == 0 ||
+ strcmp(name, "glUniform1iARB") == 0) {
- location = call->arg(0).toSInt();
+ GLint max_unit = MAX(GL_MAX_TEXTURE_COORDS, GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS);
- program = location_program_map[location];
+ GLint unit = call->arg(1).toSInt();
+ std::stringstream ss_program;
+ std::stringstream ss_texture;
- ss << "program-" << program;
+ if (unit < max_unit) {
- provide(ss.str(), call->no);
+ ss_program << "program-" << activeProgram;
+
+ ss_texture << "texture-unit-" << GL_TEXTURE0 + unit << "-target-";
+
+ /* We don't know what target(s) might get bound to
+ * this texture unit, so conservatively link to
+ * all. Only bound textures will actually get inserted
+ * into the output call stream. */
+ linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_1D);
+ linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_2D);
+ linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_3D);
+ linkf(ss_program.str(), ss_texture.str(), GL_TEXTURE_CUBE_MAP);
+ }
+ }
return;
}
(strcmp(call->sig->arg_names[0], "program") == 0 ||
strcmp(call->sig->arg_names[0], "programObj") == 0))) {
- GLuint program;
- std::stringstream ss;
-
- program = call->arg(0).toUInt();
-
- ss << "program-" << program;
-
- provide(ss.str(), call->no);
-
+ GLuint program = call->arg(0).toUInt();
+ providef("program-", program, call->no);
return;
}
public:
TraceAnalyzer(): transformFeedbackActive(false),
framebufferObjectActive(false),
- insideBeginEnd(false)
+ insideBeginEnd(false),
+ insideNewEndList(0),
+ activeTextureUnit(GL_TEXTURE0)
{}
~TraceAnalyzer() {}
/* Calls to be included in trace. */
trace::CallSet calls;
+ /* Frames to be included in trace. */
+ trace::CallSet frames;
+
/* Whether dependency analysis should be performed. */
bool dependency_analysis;
/* Emit only calls from this thread (-1 == all threads) */
int thread;
+
+ /* Print resulting callset */
+ int print_callset;
};
static int
trace::Parser p;
TraceAnalyzer analyzer;
std::set<unsigned> *required;
+ unsigned frame;
+ int call_range_first, call_range_last;
if (!p.open(filename)) {
std::cerr << "error: failed to open " << filename << "\n";
p.getBookmark(beginning);
/* In pass 1, analyze which calls are needed. */
+ frame = 0;
trace::Call *call;
while ((call = p.parse_call())) {
- /* There's no use doing any work past the last call requested
- * by the user. */
- if (call->no > options->calls.getLast()) {
+ /* There's no use doing any work past the last call or frame
+ * requested by the user. */
+ if (call->no > options->calls.getLast() ||
+ frame > options->frames.getLast()) {
+
delete call;
break;
}
/* If requested, ignore all calls not belonging to the specified thread. */
if (options->thread != -1 && call->thread_id != options->thread) {
- delete call;
- continue;
+ goto NEXT;
}
/* Also, prune if uninteresting (unless the user asked for no pruning. */
if (options->prune_uninteresting && call->flags & trace::CALL_FLAG_UNINTERESTING) {
- delete call;
- continue;
+ goto NEXT;
}
/* If this call is included in the user-specified call set,
* then require it (and all dependencies) in the trimmed
* output. */
- if (options->calls.contains(*call)) {
+ if (options->calls.contains(*call) ||
+ options->frames.contains(frame, call->flags)) {
+
analyzer.require(call);
}
analyzer.analyze(call);
}
+ NEXT:
+ if (call->flags & trace::CALL_FLAG_END_FRAME)
+ frame++;
+
delete call;
}
/* In pass 2, emit the calls that are required. */
required = analyzer.get_required();
+ frame = 0;
+ call_range_first = -1;
+ call_range_last = -1;
while ((call = p.parse_call())) {
- /* There's no use doing any work past the last call requested
- * by the user. */
- if (call->no > options->calls.getLast())
+ /* There's no use doing any work past the last call or frame
+ * requested by the user. */
+ if (call->no > options->calls.getLast() ||
+ frame > options->frames.getLast()) {
+
break;
+ }
if (required->find(call->no) != required->end()) {
writer.writeCall(call);
+
+ if (options->print_callset) {
+ if (call_range_first < 0) {
+ call_range_first = call->no;
+ printf ("%d", call_range_first);
+ } else if (call->no != call_range_last + 1) {
+ if (call_range_last != call_range_first)
+ printf ("-%d", call_range_last);
+ call_range_first = call->no;
+ printf (",%d", call_range_first);
+ }
+ call_range_last = call->no;
+ }
}
+
+ if (call->flags & trace::CALL_FLAG_END_FRAME) {
+ frame++;
+ }
+
delete call;
}
+ if (options->print_callset) {
+ if (call_range_last != call_range_first)
+ printf ("-%d\n", call_range_last);
+ }
+
std::cout << "Trimmed trace is available as " << options->output << "\n";
return 0;
{
struct trim_options options;
- options.calls = trace::CallSet(trace::FREQUENCY_ALL);
+ options.calls = trace::CallSet(trace::FREQUENCY_NONE);
+ options.frames = trace::CallSet(trace::FREQUENCY_NONE);
options.dependency_analysis = true;
options.prune_uninteresting = true;
options.output = "";
options.thread = -1;
+ options.print_callset = 0;
int opt;
while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
case CALLS_OPT:
options.calls = trace::CallSet(optarg);
break;
+ case FRAMES_OPT:
+ options.frames = trace::CallSet(optarg);
+ break;
case DEPS_OPT:
options.dependency_analysis = true;
break;
case 'o':
options.output = optarg;
break;
+ case PRINT_CALLSET_OPT:
+ options.print_callset = 1;
+ break;
default:
std::cerr << "error: unexpected option `" << opt << "`\n";
usage();
}
}
+ /* If neither of --calls nor --frames was set, default to the
+ * entire set of calls. */
+ if (options.calls.empty() && options.frames.empty()) {
+ options.calls = trace::CallSet(trace::FREQUENCY_ALL);
+ }
+
if (optind >= argc) {
std::cerr << "error: apitrace trim requires a trace file as an argument.\n";
usage();
projects / apitrace / blobdiff