1 /**************************************************************************
3 * Copyright 2011 Jose Fonseca
4 * Copyright 2010 VMware, Inc.
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
32 #include <unistd.h> // for isatty()
36 #include "cli_pager.hpp"
38 #include "trace_parser.hpp"
39 #include "trace_dump.hpp"
40 #include "trace_callset.hpp"
44 COLOR_OPTION_NEVER = 0,
45 COLOR_OPTION_ALWAYS = 1,
46 COLOR_OPTION_AUTO = -1
49 static ColorOption color = COLOR_OPTION_AUTO;
51 static bool verbose = false;
53 static trace::CallSet calls(trace::FREQUENCY_ALL);
55 static const char *synopsis = "Dump given trace(s) to standard output.";
61 << "usage: apitrace dump [OPTIONS] TRACE_FILE...\n"
64 " -h, --help show this help message and exit\n"
65 " -v, --verbose verbose output\n"
66 " --calls=CALLSET only dump specified calls\n"
68 " --colour[=WHEN] colored syntax highlighting\n"
69 " WHEN is 'auto', 'always', or 'never'\n"
70 " --thread-ids=[=BOOL] dump thread ids [default: no]\n"
71 " --call-nos[=BOOL] dump call numbers[default: yes]\n"
72 " --arg-names[=BOOL] dump argument names [default: yes]\n"
78 CALLS_OPT = CHAR_MAX + 1,
88 const static struct option
90 {"help", no_argument, 0, 'h'},
91 {"verbose", no_argument, 0, 'v'},
92 {"calls", required_argument, 0, CALLS_OPT},
93 {"colour", optional_argument, 0, COLOR_OPT},
94 {"color", optional_argument, 0, COLOR_OPT},
95 {"thread-ids", optional_argument, 0, THREAD_IDS_OPT},
96 {"call-nos", optional_argument, 0, CALL_NOS_OPT},
97 {"arg-names", optional_argument, 0, ARG_NAMES_OPT},
102 boolOption(const char *option, bool default_ = true) {
106 if (strcmp(option, "0") == 0 ||
107 strcmp(option, "no") == 0 ||
108 strcmp(option, "false") == 0) {
111 if (strcmp(option, "0") == 0 ||
112 strcmp(option, "yes") == 0 ||
113 strcmp(option, "true") == 0) {
116 std::cerr << "error: unexpected bool " << option << "\n";
121 command(int argc, char *argv[])
123 trace::DumpFlags dumpFlags = 0;
124 bool dumpThreadIds = false;
127 while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
136 calls = trace::CallSet(optarg);
140 !strcmp(optarg, "always")) {
141 color = COLOR_OPTION_ALWAYS;
142 } else if (!strcmp(optarg, "auto")) {
143 color = COLOR_OPTION_AUTO;
144 } else if (!strcmp(optarg, "never")) {
145 color = COLOR_OPTION_NEVER;
147 std::cerr << "error: unknown color argument " << optarg << "\n";
152 dumpThreadIds = boolOption(optarg);
155 if (boolOption(optarg)) {
156 dumpFlags &= ~trace::DUMP_FLAG_NO_CALL_NO;
158 dumpFlags |= trace::DUMP_FLAG_NO_CALL_NO;
162 if (boolOption(optarg)) {
163 dumpFlags &= ~trace::DUMP_FLAG_NO_ARG_NAMES;
165 dumpFlags |= trace::DUMP_FLAG_NO_ARG_NAMES;
169 std::cerr << "error: unexpected option `" << opt << "`\n";
175 if (color == COLOR_OPTION_AUTO) {
177 color = COLOR_OPTION_ALWAYS;
179 color = isatty(1) ? COLOR_OPTION_ALWAYS : COLOR_OPTION_NEVER;
184 if (color == COLOR_OPTION_NEVER) {
185 dumpFlags |= trace::DUMP_FLAG_NO_COLOR;
188 for (int i = optind; i < argc; ++i) {
191 if (!p.open(argv[i])) {
192 std::cerr << "error: failed to open " << argv[i] << "\n";
197 while ((call = p.parse_call())) {
198 if (calls.contains(*call)) {
200 !(call->flags & trace::CALL_FLAG_VERBOSE)) {
202 std::cout << std::hex << call->thread_id << std::dec << " ";
204 trace::dump(*call, std::cout, dumpFlags);
214 const Command dump_command = {