blob: d674c83da17f0e93e27495f8bc0164b65682275e [file] [log] [blame]
José Fonseca7e329022010-11-19 17:05:18 +00001/**************************************************************************
2 *
José Fonseca946da142011-12-11 14:32:50 +00003 * Copyright 2011 Jose Fonseca
José Fonseca7e329022010-11-19 17:05:18 +00004 * Copyright 2010 VMware, Inc.
5 * All Rights Reserved.
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
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
23 * THE SOFTWARE.
24 *
25 **************************************************************************/
26
José Fonseca946da142011-12-11 14:32:50 +000027
José Fonseca71913ee2011-10-30 13:35:33 +000028#include <string.h>
José Fonseca689b6b22012-01-28 13:54:52 +000029#include <limits.h> // for CHAR_MAX
30#include <getopt.h>
Martin Olssonbdd92812012-03-26 10:40:45 +020031#ifndef _WIN32
32#include <unistd.h> // for isatty()
33#endif
José Fonseca71913ee2011-10-30 13:35:33 +000034
José Fonseca5cc28b02011-10-30 13:38:25 +000035#include "cli.hpp"
José Fonsecab122f502011-12-10 18:07:25 +000036#include "cli_pager.hpp"
José Fonseca822d20a2011-08-20 13:49:40 +010037
José Fonseca7e329022010-11-19 17:05:18 +000038#include "trace_parser.hpp"
José Fonseca946da142011-12-11 14:32:50 +000039#include "trace_dump.hpp"
José Fonseca225193d2012-01-26 19:08:32 +000040#include "trace_callset.hpp"
Carl Wortha7e7b272012-08-12 16:48:10 -070041#include "trace_option.hpp"
José Fonseca946da142011-12-11 14:32:50 +000042
José Fonseca7e329022010-11-19 17:05:18 +000043
Carl Worthe525e6f2011-10-20 15:22:09 -070044enum ColorOption {
45 COLOR_OPTION_NEVER = 0,
46 COLOR_OPTION_ALWAYS = 1,
47 COLOR_OPTION_AUTO = -1
48};
49
50static ColorOption color = COLOR_OPTION_AUTO;
José Fonseca822d20a2011-08-20 13:49:40 +010051
José Fonseca340f5692011-11-30 07:04:44 +000052static bool verbose = false;
53
José Fonseca225193d2012-01-26 19:08:32 +000054static trace::CallSet calls(trace::FREQUENCY_ALL);
55
José Fonseca3c167fe2011-10-30 14:21:03 +000056static const char *synopsis = "Dump given trace(s) to standard output.";
57
58static void
59usage(void)
Carl Worthbd5e1642011-10-21 20:40:56 -070060{
José Fonseca3c167fe2011-10-30 14:21:03 +000061 std::cout
José Fonseca689b6b22012-01-28 13:54:52 +000062 << "usage: apitrace dump [OPTIONS] TRACE_FILE...\n"
José Fonseca3c167fe2011-10-30 14:21:03 +000063 << synopsis << "\n"
José Fonseca646a00d2011-10-30 14:07:20 +000064 "\n"
José Fonseca689b6b22012-01-28 13:54:52 +000065 " -h, --help show this help message and exit\n"
66 " -v, --verbose verbose output\n"
67 " --calls=CALLSET only dump specified calls\n"
68 " --color[=WHEN]\n"
69 " --colour[=WHEN] colored syntax highlighting\n"
70 " WHEN is 'auto', 'always', or 'never'\n"
José Fonseca689b6b22012-01-28 13:54:52 +000071 " --thread-ids=[=BOOL] dump thread ids [default: no]\n"
José Fonseca0a478812012-03-16 15:40:04 +000072 " --call-nos[=BOOL] dump call numbers[default: yes]\n"
73 " --arg-names[=BOOL] dump argument names [default: yes]\n"
José Fonseca689b6b22012-01-28 13:54:52 +000074 "\n"
José Fonseca946da142011-12-11 14:32:50 +000075 ;
José Fonseca822d20a2011-08-20 13:49:40 +010076}
77
José Fonseca689b6b22012-01-28 13:54:52 +000078enum {
José Fonseca8a4baf82014-05-15 23:04:58 +010079 CALLS_OPT = CHAR_MAX + 1,
80 COLOR_OPT,
José Fonseca689b6b22012-01-28 13:54:52 +000081 THREAD_IDS_OPT,
José Fonseca0a478812012-03-16 15:40:04 +000082 CALL_NOS_OPT,
83 ARG_NAMES_OPT,
José Fonseca689b6b22012-01-28 13:54:52 +000084};
85
86const static char *
87shortOptions = "hv";
88
89const static struct option
90longOptions[] = {
91 {"help", no_argument, 0, 'h'},
92 {"verbose", no_argument, 0, 'v'},
93 {"calls", required_argument, 0, CALLS_OPT},
94 {"colour", optional_argument, 0, COLOR_OPT},
95 {"color", optional_argument, 0, COLOR_OPT},
José Fonseca689b6b22012-01-28 13:54:52 +000096 {"thread-ids", optional_argument, 0, THREAD_IDS_OPT},
José Fonseca0a478812012-03-16 15:40:04 +000097 {"call-nos", optional_argument, 0, CALL_NOS_OPT},
98 {"arg-names", optional_argument, 0, ARG_NAMES_OPT},
José Fonseca689b6b22012-01-28 13:54:52 +000099 {0, 0, 0, 0}
100};
101
José Fonseca3c167fe2011-10-30 14:21:03 +0000102static int
José Fonsecaffba5972011-10-30 14:29:28 +0000103command(int argc, char *argv[])
José Fonseca7e329022010-11-19 17:05:18 +0000104{
José Fonseca946da142011-12-11 14:32:50 +0000105 trace::DumpFlags dumpFlags = 0;
José Fonseca689b6b22012-01-28 13:54:52 +0000106
José Fonseca689b6b22012-01-28 13:54:52 +0000107 int opt;
108 while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
109 switch (opt) {
110 case 'h':
José Fonseca3c167fe2011-10-30 14:21:03 +0000111 usage();
José Fonseca646a00d2011-10-30 14:07:20 +0000112 return 0;
José Fonseca689b6b22012-01-28 13:54:52 +0000113 case 'v':
José Fonseca340f5692011-11-30 07:04:44 +0000114 verbose = true;
José Fonseca689b6b22012-01-28 13:54:52 +0000115 break;
116 case CALLS_OPT:
Lawrence L Love5ab982d2013-12-05 11:31:16 -0800117 calls.merge(optarg);
José Fonseca689b6b22012-01-28 13:54:52 +0000118 break;
119 case COLOR_OPT:
120 if (!optarg ||
121 !strcmp(optarg, "always")) {
122 color = COLOR_OPTION_ALWAYS;
123 } else if (!strcmp(optarg, "auto")) {
124 color = COLOR_OPTION_AUTO;
125 } else if (!strcmp(optarg, "never")) {
126 color = COLOR_OPTION_NEVER;
127 } else {
128 std::cerr << "error: unknown color argument " << optarg << "\n";
129 return 1;
130 }
131 break;
José Fonseca0a478812012-03-16 15:40:04 +0000132 case THREAD_IDS_OPT:
José Fonseca8a4baf82014-05-15 23:04:58 +0100133 if (trace::boolOption(optarg)) {
134 dumpFlags |= trace::DUMP_FLAG_THREAD_IDS;
135 } else {
136 dumpFlags &= ~trace::DUMP_FLAG_THREAD_IDS;
137 }
José Fonseca0a478812012-03-16 15:40:04 +0000138 break;
139 case CALL_NOS_OPT:
Carl Wortha7e7b272012-08-12 16:48:10 -0700140 if (trace::boolOption(optarg)) {
José Fonseca0a478812012-03-16 15:40:04 +0000141 dumpFlags &= ~trace::DUMP_FLAG_NO_CALL_NO;
142 } else {
143 dumpFlags |= trace::DUMP_FLAG_NO_CALL_NO;
144 }
145 break;
José Fonseca689b6b22012-01-28 13:54:52 +0000146 case ARG_NAMES_OPT:
Carl Wortha7e7b272012-08-12 16:48:10 -0700147 if (trace::boolOption(optarg)) {
José Fonseca689b6b22012-01-28 13:54:52 +0000148 dumpFlags &= ~trace::DUMP_FLAG_NO_ARG_NAMES;
149 } else {
150 dumpFlags |= trace::DUMP_FLAG_NO_ARG_NAMES;
151 }
152 break;
José Fonseca689b6b22012-01-28 13:54:52 +0000153 default:
José Fonseca4ce88b82013-10-11 17:24:47 -0700154 std::cerr << "error: unexpected option `" << (char)opt << "`\n";
José Fonseca3c167fe2011-10-30 14:21:03 +0000155 usage();
José Fonseca822d20a2011-08-20 13:49:40 +0100156 return 1;
157 }
158 }
159
Carl Worthe525e6f2011-10-20 15:22:09 -0700160 if (color == COLOR_OPTION_AUTO) {
161#ifdef _WIN32
162 color = COLOR_OPTION_ALWAYS;
163#else
José Fonseca685c5152013-06-09 11:00:20 +0100164 color = isatty(STDOUT_FILENO) ? COLOR_OPTION_ALWAYS : COLOR_OPTION_NEVER;
José Fonsecab122f502011-12-10 18:07:25 +0000165 pipepager();
Carl Worthe525e6f2011-10-20 15:22:09 -0700166#endif
167 }
168
José Fonseca946da142011-12-11 14:32:50 +0000169 if (color == COLOR_OPTION_NEVER) {
170 dumpFlags |= trace::DUMP_FLAG_NO_COLOR;
171 }
172
José Fonseca689b6b22012-01-28 13:54:52 +0000173 for (int i = optind; i < argc; ++i) {
José Fonsecab4a3d142011-10-27 07:43:19 +0100174 trace::Parser p;
José Fonseca610ed332011-06-04 22:55:42 +0100175
176 if (!p.open(argv[i])) {
José Fonseca610ed332011-06-04 22:55:42 +0100177 return 1;
178 }
179
José Fonsecab4a3d142011-10-27 07:43:19 +0100180 trace::Call *call;
José Fonseca610ed332011-06-04 22:55:42 +0100181 while ((call = p.parse_call())) {
José Fonseca225193d2012-01-26 19:08:32 +0000182 if (calls.contains(*call)) {
183 if (verbose ||
184 !(call->flags & trace::CALL_FLAG_VERBOSE)) {
José Fonseca225193d2012-01-26 19:08:32 +0000185 trace::dump(*call, std::cout, dumpFlags);
José Fonseca0af96702011-12-22 21:35:10 +0000186 }
José Fonseca340f5692011-11-30 07:04:44 +0000187 }
José Fonseca610ed332011-06-04 22:55:42 +0100188 delete call;
José Fonseca19828972010-11-29 20:34:32 +0000189 }
190 }
José Fonseca822d20a2011-08-20 13:49:40 +0100191
José Fonseca19828972010-11-29 20:34:32 +0000192 return 0;
José Fonseca7e329022010-11-19 17:05:18 +0000193}
José Fonseca3c167fe2011-10-30 14:21:03 +0000194
Carl Worth68f7c982011-11-01 13:47:26 -0700195const Command dump_command = {
José Fonseca3c167fe2011-10-30 14:21:03 +0000196 "dump",
197 synopsis,
198 usage,
199 command
200};