1 /**************************************************************************
3 * Copyright 2010 VMware, Inc.
4 * Copyright 2011 Intel corporation
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 **************************************************************************/
29 #include <limits.h> // for CHAR_MAX
36 #include "os_string.hpp"
38 #include "trace_analyzer.hpp"
39 #include "trace_callset.hpp"
40 #include "trace_parser.hpp"
41 #include "trace_writer.hpp"
43 static const char *synopsis = "Create a new trace by trimming an existing trace.";
49 << "usage: apitrace trim [OPTIONS] TRACE_FILE...\n"
52 " -h, --help Show detailed help for trim options and exit\n"
53 " --calls=CALLSET Include specified calls in the trimmed output.\n"
54 " --frames=FRAMESET Include specified frames in the trimmed output.\n"
55 " --deps Include additional calls to satisfy dependencies\n"
56 " --no-deps Do not include any more calls than requestd\n"
57 " --prune Omit calls without side effects from the output\n"
58 " --no-prune Do not omit any requested calls\n"
59 " -a, --auto Trim automatically to calls specified in --calls/--frames\n"
60 " Equivalent to both --deps and --prune\n"
61 " --exact Trim to exactly the calls specified in --calls/--frames\n"
62 " Equivalent to both --no-deps and --no-prune\n"
63 " --print-callset Print the final set of calls included in output\n"
64 " --trim-spec=SPEC Only performing trimming as described in SPEC\n"
65 " --thread=THREAD_ID Only retain calls from specified thread\n"
66 " -o, --output=TRACE_FILE Output trace file\n"
74 << "usage: apitrace trim [OPTIONS] TRACE_FILE...\n"
77 " -h, --help Show this help message and exit\n"
79 " --calls=CALLSET Include specified calls in the trimmed output.\n"
80 " --frames=FRAMESET Include specified frames in the trimmed output.\n"
82 " --deps Perform dependency analysis and include dependent\n"
83 " calls as needed, (even if those calls were not\n"
84 " explicitly requested with --calls or --frames).\n"
85 " (On by default. See --no-deps or --exact)\n"
86 " --no-deps Do not perform dependency analysis. Output will\n"
87 " not include any additional calls beyond those\n"
88 " explicitly requested with --calls or --frames).\n"
90 " --prune Omit calls with no side effects, even if the call\n"
91 " is within the range specified by --calls/--frames.\n"
92 " (On by default. See --no-prune or --exact)\n"
94 " --no-prune Never omit any calls from the range specified\n"
95 " --calls/--frames.\n"
97 " -a, --auto Use dependency analysis and pruning\n"
98 " of uninteresting calls the resulting trace may\n"
99 " include more and less calls than specified.\n"
100 " This option is equivalent\n"
101 " to passing both --deps and --prune and is on by\n"
102 " default (see --no-deps, --no-prune and --exact)\n"
104 " --exact Trim output to exact the calls or frames\n"
105 " specified with --calls or --frames.\n"
106 " This option is equivalent\n"
107 " to passing both --no-deps and --no-prune.\n"
109 " --print-callset Print to stdout the final set of calls included\n"
110 " in the trim output. This can be useful for\n"
111 " tweaking the trimmed callset from --auto on the\n"
113 " Use --calls=@FILE to read callset from a file.\n"
114 " --trim-spec=SPEC Specifies which classes of calls will be trimmed.\n"
115 " This option only has an effect if dependency\n"
116 " analysis is enabled. The argument is a comma-\n"
117 " separated list of names from the following:\n"
119 " no-side-effects Calls with no side effects\n"
120 " textures Calls to setup unused textures\n"
121 " shaders Calls to setup unused shaders\n"
122 " drawing Calls that draw\n"
124 " The default trim specification includes all of\n"
125 " the above, (as much as possible will be trimmed).\n"
127 " --thread=THREAD_ID Only retain calls from specified thread\n"
129 " -o, --output=TRACE_FILE Output trace file\n"
135 CALLS_OPT = CHAR_MAX + 1,
148 shortOptions = "aho:x";
150 const static struct option
152 {"help", no_argument, 0, 'h'},
153 {"calls", required_argument, 0, CALLS_OPT},
154 {"frames", required_argument, 0, FRAMES_OPT},
155 {"deps", no_argument, 0, DEPS_OPT},
156 {"no-deps", no_argument, 0, NO_DEPS_OPT},
157 {"prune", no_argument, 0, PRUNE_OPT},
158 {"no-prune", no_argument, 0, NO_PRUNE_OPT},
159 {"auto", no_argument, 0, 'a'},
160 {"exact", no_argument, 0, EXACT_OPT},
161 {"thread", required_argument, 0, THREAD_OPT},
162 {"output", required_argument, 0, 'o'},
163 {"print-callset", no_argument, 0, PRINT_CALLSET_OPT},
164 {"trim-spec", required_argument, 0, TRIM_SPEC_OPT},
168 struct stringCompare {
169 bool operator() (const char *a, const char *b) const {
170 return strcmp(a, b) < 0;
174 struct trim_options {
175 /* Calls to be included in trace. */
176 trace::CallSet calls;
178 /* Frames to be included in trace. */
179 trace::CallSet frames;
181 /* Whether dependency analysis should be performed. */
182 bool dependency_analysis;
184 /* Whether uninteresting calls should be pruned.. */
185 bool prune_uninteresting;
187 /* Output filename */
190 /* Emit only calls from this thread (-1 == all threads) */
193 /* Print resulting callset */
196 /* What kind of trimming to perform. */
197 TrimFlags trim_flags;
201 trim_trace(const char *filename, struct trim_options *options)
203 trace::ParseBookmark beginning;
205 TraceAnalyzer analyzer(options->trim_flags);
206 std::set<unsigned> *required;
208 int call_range_first, call_range_last;
210 if (!p.open(filename)) {
211 std::cerr << "error: failed to open " << filename << "\n";
215 /* Mark the beginning so we can return here for pass 2. */
216 p.getBookmark(beginning);
218 /* In pass 1, analyze which calls are needed. */
221 while ((call = p.parse_call())) {
223 /* There's no use doing any work past the last call and frame
224 * requested by the user. */
225 if ((options->calls.empty() || call->no > options->calls.getLast()) &&
226 (options->frames.empty() || frame > options->frames.getLast())) {
232 /* If requested, ignore all calls not belonging to the specified thread. */
233 if (options->thread != -1 && call->thread_id != options->thread) {
237 /* Also, prune if no side effects (unless the user asked for no pruning. */
238 if (options->prune_uninteresting && call->flags & trace::CALL_FLAG_NO_SIDE_EFFECTS) {
242 /* If this call is included in the user-specified call set,
243 * then require it (and all dependencies) in the trimmed
245 if (options->calls.contains(*call) ||
246 options->frames.contains(frame, call->flags)) {
248 analyzer.require(call);
251 /* Regardless of whether we include this call or not, we do
252 * some dependency tracking (unless disabled by the user). We
253 * do this even for calls we have included in the output so
254 * that any state updates get performed. */
255 if (options->dependency_analysis) {
256 analyzer.analyze(call);
260 if (call->flags & trace::CALL_FLAG_END_FRAME)
266 /* Prepare output file and writer for output. */
267 if (options->output.empty()) {
268 os::String base(filename);
269 base.trimExtension();
271 options->output = std::string(base.str()) + std::string("-trim.trace");
274 trace::Writer writer;
275 if (!writer.open(options->output.c_str())) {
276 std::cerr << "error: failed to create " << filename << "\n";
280 /* Reset bookmark for pass 2. */
281 p.setBookmark(beginning);
283 /* In pass 2, emit the calls that are required. */
284 required = analyzer.get_required();
287 call_range_first = -1;
288 call_range_last = -1;
289 while ((call = p.parse_call())) {
291 /* There's no use doing any work past the last call and frame
292 * requested by the user. */
293 if ((options->calls.empty() || call->no > options->calls.getLast()) &&
294 (options->frames.empty() || frame > options->frames.getLast())) {
299 if (required->find(call->no) != required->end()) {
300 writer.writeCall(call);
302 if (options->print_callset) {
303 if (call_range_first < 0) {
304 call_range_first = call->no;
305 printf ("%d", call_range_first);
306 } else if (call->no != call_range_last + 1) {
307 if (call_range_last != call_range_first)
308 printf ("-%d", call_range_last);
309 call_range_first = call->no;
310 printf (",%d", call_range_first);
312 call_range_last = call->no;
316 if (call->flags & trace::CALL_FLAG_END_FRAME) {
323 if (options->print_callset) {
324 if (call_range_last != call_range_first)
325 printf ("-%d\n", call_range_last);
328 std::cerr << "Trimmed trace is available as " << options->output << "\n";
334 parse_trim_spec(const char *trim_spec, TrimFlags *flags)
336 std::string spec(trim_spec), word;
337 size_t start = 0, comma = 0;
340 while (start < spec.size()) {
341 comma = spec.find(',', start);
343 if (comma == std::string::npos)
344 word = std::string(spec, start);
346 word = std::string(spec, start, comma - start);
348 if (strcmp(word.c_str(), "no-side-effects") == 0)
349 *flags |= TRIM_FLAG_NO_SIDE_EFFECTS;
350 else if (strcmp(word.c_str(), "textures") == 0)
351 *flags |= TRIM_FLAG_TEXTURES;
352 else if (strcmp(word.c_str(), "shaders") == 0)
353 *flags |= TRIM_FLAG_SHADERS;
354 else if (strcmp(word.c_str(), "drawing") == 0)
355 *flags |= TRIM_FLAG_DRAWING;
360 if (comma == std::string::npos)
370 command(int argc, char *argv[])
372 struct trim_options options;
374 options.calls = trace::CallSet(trace::FREQUENCY_NONE);
375 options.frames = trace::CallSet(trace::FREQUENCY_NONE);
376 options.dependency_analysis = true;
377 options.prune_uninteresting = true;
380 options.print_callset = 0;
381 options.trim_flags = -1;
384 while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
390 options.calls = trace::CallSet(optarg);
393 options.frames = trace::CallSet(optarg);
396 options.dependency_analysis = true;
399 options.dependency_analysis = false;
402 options.prune_uninteresting = true;
405 options.prune_uninteresting = false;
408 options.dependency_analysis = true;
409 options.prune_uninteresting = true;
412 options.dependency_analysis = false;
413 options.prune_uninteresting = false;
416 options.thread = atoi(optarg);
419 options.output = optarg;
421 case PRINT_CALLSET_OPT:
422 options.print_callset = 1;
425 if (parse_trim_spec(optarg, &options.trim_flags)) {
426 std::cerr << "error: illegal value for trim-spec: " << optarg << "\n";
427 std::cerr << "See \"apitrace help trim\" for help.\n";
432 std::cerr << "error: unexpected option `" << opt << "`\n";
438 /* If neither of --calls nor --frames was set, default to the
439 * entire set of calls. */
440 if (options.calls.empty() && options.frames.empty()) {
441 options.calls = trace::CallSet(trace::FREQUENCY_ALL);
444 if (optind >= argc) {
445 std::cerr << "error: apitrace trim requires a trace file as an argument.\n";
450 if (argc > optind + 1) {
451 std::cerr << "error: extraneous arguments:";
452 for (int i = optind + 1; i < argc; i++) {
453 std::cerr << " " << argv[i];
460 if (options.dependency_analysis) {
462 "Note: The dependency analysis in \"apitrace trim\" is still experimental.\n"
463 " We hope that it will be useful, but it may lead to incorrect results.\n"
464 " If you find a trace that misbehaves while trimming, please share that\n"
465 " by sending email to apitrace@lists.freedesktop.org, cworth@cworth.org\n";
468 return trim_trace(argv[optind], &options);
471 const Command trim_command = {