static void
usage(void)
+{
+ std::cout
+ << "usage: apitrace trim [OPTIONS] TRACE_FILE...\n"
+ << synopsis << "\n"
+ "\n"
+ " -h, --help Show detailed help for trim options and exit\n"
+ " --calls=CALLSET Include specified calls 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"
+ " Equivalent to both --no-deps and --no-prune\n"
+ " --thread=THREAD_ID Only retain calls from specified thread\n"
+ " -o, --output=TRACE_FILE Output trace file\n"
+ ;
+}
+
+static void
+help()
{
std::cout
<< "usage: apitrace trim [OPTIONS] TRACE_FILE...\n"
<< synopsis << "\n"
"\n"
" -h, --help Show this help message and exit\n"
- " --calls=CALLSET Include specified calls in the trimmed output\n"
+ "\n"
+ " --calls=CALLSET Include specified calls 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"
+ " See --no-deps, --no-prune, and --exact to change\n"
+ " this behavior.\n"
+ "\n"
" --deps Perform dependency analysis and include dependent\n"
- " calls as needed. This is the default behavior.\n"
- " --no-deps Do not perform dependency analysis. Include only\n"
- " those calls explicitly listed in --calls\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"
+ "\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"
+ "\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"
+ "\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"
+ "\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"
+ "\n"
" --thread=THREAD_ID Only retain calls from specified thread\n"
+ "\n"
" -o, --output=TRACE_FILE Output trace file\n"
"\n"
;
CALLS_OPT = CHAR_MAX + 1,
DEPS_OPT,
NO_DEPS_OPT,
+ PRUNE_OPT,
+ NO_PRUNE_OPT,
THREAD_OPT,
};
const static char *
-shortOptions = "ho:";
+shortOptions = "ho:x";
const static struct option
longOptions[] = {
{"calls", required_argument, 0, CALLS_OPT},
{"deps", no_argument, 0, DEPS_OPT},
{"no-deps", no_argument, 0, NO_DEPS_OPT},
+ {"prune", no_argument, 0, PRUNE_OPT},
+ {"no-prune", no_argument, 0, NO_PRUNE_OPT},
+ {"exact", no_argument, 0, 'x'},
{"thread", required_argument, 0, THREAD_OPT},
{"output", required_argument, 0, 'o'},
{0, 0, 0, 0}
/* Compute and record all the resources provided by this call. */
void analyze(trace::Call *call) {
+ /* If there are no side effects, this call provides nothing. */
+ if (call->flags & trace::CALL_FLAG_NO_SIDE_EFFECTS) {
+ return;
+ }
+
+ /* Similarly, calls that swap buffers don't have other side effects. */
+ if (call->flags & trace::CALL_FLAG_SWAP_RENDERTARGET &&
+ call->flags & trace::CALL_FLAG_END_FRAME) {
+ return;
+ }
+
+ /* By default, assume this call affects the state somehow. */
resources["state"].insert(call->no);
}
/* Whether dependency analysis should be performed. */
bool dependency_analysis;
+ /* Whether uninteresting calls should be pruned.. */
+ bool prune_uninteresting;
+
/* Output filename */
std::string output;
/* In pass 1, analyze which calls are needed. */
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())
+ break;
+
/* If requested, ignore all calls not belonging to the specified thread. */
if (options->thread != -1 && call->thread_id != options->thread)
continue;
+ /* Also, prune if uninteresting (unless the user asked for no pruning. */
+ if (options->prune_uninteresting && call->flags & trace::CALL_FLAG_UNINTERESTING) {
+ continue;
+ }
+
/* If this call is included in the user-specified call
* set, then we don't need to perform any analysis on
* it. We know it must be included. */
required = analyzer.get_required();
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())
+ break;
+
if (required->find(call->no) != required->end()) {
writer.writeCall(call);
}
options.calls = trace::CallSet(trace::FREQUENCY_ALL);
options.dependency_analysis = true;
+ options.prune_uninteresting = true;
options.output = "";
options.thread = -1;
while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
switch (opt) {
case 'h':
- usage();
+ help();
return 0;
case CALLS_OPT:
options.calls = trace::CallSet(optarg);
case NO_DEPS_OPT:
options.dependency_analysis = false;
break;
+ case PRUNE_OPT:
+ options.prune_uninteresting = true;
+ break;
+ case NO_PRUNE_OPT:
+ options.prune_uninteresting = false;
+ break;
+ case 'x':
+ options.dependency_analysis = false;
+ options.prune_uninteresting = false;
+ break;
case THREAD_OPT:
options.thread = atoi(optarg);
break;
return 1;
}
+ if (argc > optind + 1) {
+ std::cerr << "error: extraneous arguments:";
+ for (int i = optind + 1; i < argc; i++) {
+ std::cerr << " " << argv[i];
+ }
+ std::cerr << "\n";
+ usage();
+ return 1;
+ }
+
return trim_trace(argv[optind], &options);
}
const Command trim_command = {
"trim",
synopsis,
- usage,
+ help,
command
};