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 **************************************************************************/
28 #include <limits.h> // for CHAR_MAX
35 #include "os_string.hpp"
37 #include "trace_callset.hpp"
38 #include "trace_parser.hpp"
39 #include "trace_writer.hpp"
41 static const char *synopsis = "Create a new trace by trimming an existing trace.";
47 << "usage: apitrace trim [OPTIONS] TRACE_FILE...\n"
50 " -h, --help Show detailed help for trim options and exit\n"
51 " --calls=CALLSET Include specified calls in the trimmed output.\n"
52 " --deps Include additional calls to satisfy dependencies\n"
53 " --no-deps Do not include calls from dependency analysis\n"
54 " --prune Omit uninteresting calls from the trace output\n"
55 " --no-prune Do not prune uninteresting calls from the trace.\n"
56 " -x, --exact Include exactly the calls specified in --calls\n"
57 " Equivalent to both --no-deps and --no-prune\n"
58 " --thread=THREAD_ID Only retain calls from specified thread\n"
59 " -o, --output=TRACE_FILE Output trace file\n"
67 << "usage: apitrace trim [OPTIONS] TRACE_FILE...\n"
70 " -h, --help Show this help message and exit\n"
72 " --calls=CALLSET Include specified calls in the trimmed output.\n"
73 " Note that due to dependency analysis and pruning\n"
74 " of uninteresting calls the resulting trace may\n"
75 " include more and less calls than specified.\n"
76 " See --no-deps, --no-prune, and --exact to change\n"
79 " --deps Perform dependency analysis and include dependent\n"
80 " calls as needed, (even if those calls were not\n"
81 " explicitly requested with --calls). This is the\n"
82 " default behavior. See --no-deps and --exact.\n"
84 " --no-deps Do not perform dependency analysis. In this mode\n"
85 " the trimmed trace will never include calls from\n"
86 " outside the range specified in --calls.\n"
88 " --prune Omit calls that have no side effects, even if the\n"
89 " call is within the range specified by --calls.\n"
90 " This is the default behavior. See --no-prune\n"
92 " --no-prune Do not prune uninteresting calls from the trace.\n"
93 " In this mode the trimmed trace will never omit\n"
94 " any calls within the range specified in --calls.\n"
96 " -x, --exact Trim the trace to exactly the calls specified in\n"
97 " --calls. This option is equivalent to passing\n"
98 " both --no-deps and --no-prune.\n"
100 " --thread=THREAD_ID Only retain calls from specified thread\n"
102 " -o, --output=TRACE_FILE Output trace file\n"
108 CALLS_OPT = CHAR_MAX + 1,
117 shortOptions = "ho:x";
119 const static struct option
121 {"help", no_argument, 0, 'h'},
122 {"calls", required_argument, 0, CALLS_OPT},
123 {"deps", no_argument, 0, DEPS_OPT},
124 {"no-deps", no_argument, 0, NO_DEPS_OPT},
125 {"prune", no_argument, 0, PRUNE_OPT},
126 {"no-prune", no_argument, 0, NO_PRUNE_OPT},
127 {"exact", no_argument, 0, 'x'},
128 {"thread", required_argument, 0, THREAD_OPT},
129 {"output", required_argument, 0, 'o'},
133 struct stringCompare {
134 bool operator() (const char *a, const char *b) const {
135 return strcmp(a, b) < 0;
139 class TraceAnalyzer {
140 /* Map for tracking resource dependencies between calls. */
141 std::map<const char *, std::set<unsigned>, stringCompare > resources;
143 /* The final set of calls required. This consists of calls added
144 * explicitly with the require() method as well as all calls
145 * implicitly required by those through resource dependencies. */
146 std::set<unsigned> required;
152 /* Compute and record all the resources provided by this call. */
153 void analyze(trace::Call *call) {
154 resources["state"].insert(call->no);
157 /* Require this call and all of its dependencies to be included in
158 * the final trace. */
159 void require(trace::Call *call) {
160 std::set<unsigned> *dependencies;
161 std::set<unsigned>::iterator i;
163 /* First, find and insert all calls that this call depends on. */
164 dependencies = &resources["state"];
165 for (i = dependencies->begin(); i != dependencies->end(); i++) {
168 resources["state"].clear();
170 /* Then insert this call itself. */
171 required.insert(call->no);
174 /* Return a set of all the required calls, (both those calls added
175 * explicitly with require() and those implicitly depended
177 std::set<unsigned> *get_required(void) {
182 struct trim_options {
183 /* Calls to be included in trace. */
184 trace::CallSet calls;
186 /* Whether dependency analysis should be performed. */
187 bool dependency_analysis;
189 /* Whether uninteresting calls should be pruned.. */
190 bool prune_uninteresting;
192 /* Output filename */
195 /* Emit only calls from this thread (-1 == all threads) */
200 trim_trace(const char *filename, struct trim_options *options)
202 trace::ParseBookmark beginning;
204 TraceAnalyzer analyzer;
205 std::set<unsigned> *required;
207 if (!p.open(filename)) {
208 std::cerr << "error: failed to open " << filename << "\n";
212 /* Mark the beginning so we can return here for pass 2. */
213 p.getBookmark(beginning);
215 /* In pass 1, analyze which calls are needed. */
217 while ((call = p.parse_call())) {
218 /* If requested, ignore all calls not belonging to the specified thread. */
219 if (options->thread != -1 && call->thread_id != options->thread)
222 /* Also, prune if uninteresting (unless the user asked for no pruning. */
223 if (options->prune_uninteresting && call->flags & trace::CALL_FLAG_UNINTERESTING) {
227 /* If this call is included in the user-specified call
228 * set, then we don't need to perform any analysis on
229 * it. We know it must be included. */
230 if (options->calls.contains(*call)) {
231 analyzer.require(call);
233 if (options->dependency_analysis)
234 analyzer.analyze(call);
238 /* Prepare output file and writer for output. */
239 if (options->output.empty()) {
240 os::String base(filename);
241 base.trimExtension();
243 options->output = std::string(base.str()) + std::string("-trim.trace");
246 trace::Writer writer;
247 if (!writer.open(options->output.c_str())) {
248 std::cerr << "error: failed to create " << filename << "\n";
252 /* Reset bookmark for pass 2. */
253 p.setBookmark(beginning);
255 /* In pass 2, emit the calls that are required. */
256 required = analyzer.get_required();
258 while ((call = p.parse_call())) {
259 if (required->find(call->no) != required->end()) {
260 writer.writeCall(call);
265 std::cout << "Trimmed trace is available as " << options->output << "\n";
271 command(int argc, char *argv[])
273 struct trim_options options;
275 options.calls = trace::CallSet(trace::FREQUENCY_ALL);
276 options.dependency_analysis = true;
277 options.prune_uninteresting = true;
282 while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
288 options.calls = trace::CallSet(optarg);
291 options.dependency_analysis = true;
294 options.dependency_analysis = false;
297 options.prune_uninteresting = true;
300 options.prune_uninteresting = false;
303 options.dependency_analysis = false;
304 options.prune_uninteresting = false;
307 options.thread = atoi(optarg);
310 options.output = optarg;
313 std::cerr << "error: unexpected option `" << opt << "`\n";
319 if (optind >= argc) {
320 std::cerr << "error: apitrace trim requires a trace file as an argument.\n";
325 if (argc > optind + 1) {
326 std::cerr << "error: extraneous arguments:";
327 for (int i = optind + 1; i < argc; i++) {
328 std::cerr << " " << argv[i];
335 return trim_trace(argv[optind], &options);
338 const Command trim_command = {