blob: 32277499a6e0f2675929ce434186d9a274518883 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
Felipe Leme343175a2016-08-02 18:57:37 -07002 * Copyright (C) 2009 The Android Open Source Project
Colin Crossf45fa6b2012-03-26 12:38:26 -07003 *
Felipe Leme343175a2016-08-02 18:57:37 -07004 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
Colin Crossf45fa6b2012-03-26 12:38:26 -070015 */
16
Josh Gao4b8f6f92016-02-29 16:20:34 -080017#include <algorithm>
18#include <chrono>
Kevin Rocard430e0792017-08-14 20:40:24 -070019#include <iomanip>
Josh Gao4b8f6f92016-02-29 16:20:34 -080020#include <thread>
21
22#include <android-base/file.h>
mukesh agrawal2f1eb1c2016-06-08 18:16:36 -070023#include <android-base/stringprintf.h>
Josh Gao4b8f6f92016-02-29 16:20:34 -080024#include <android-base/unique_fd.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <binder/Parcel.h>
26#include <binder/ProcessState.h>
Mathias Agopian002e1e52013-05-06 20:20:50 -070027#include <binder/TextOutput.h>
Josh Gao4b8f6f92016-02-29 16:20:34 -080028#include <utils/Log.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <utils/Vector.h>
30
Josh Gao4b8f6f92016-02-29 16:20:34 -080031#include <fcntl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070032#include <getopt.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070033#include <stdio.h>
Josh Gao4b8f6f92016-02-29 16:20:34 -080034#include <stdlib.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <string.h>
Josh Gao4b8f6f92016-02-29 16:20:34 -080036#include <sys/poll.h>
37#include <sys/socket.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070038#include <sys/time.h>
Josh Gao4b8f6f92016-02-29 16:20:34 -080039#include <sys/types.h>
40#include <unistd.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070041
Felipe Leme343175a2016-08-02 18:57:37 -070042#include "dumpsys.h"
43
Colin Crossf45fa6b2012-03-26 12:38:26 -070044using namespace android;
mukesh agrawal2f1eb1c2016-06-08 18:16:36 -070045using android::base::StringPrintf;
Josh Gao4b8f6f92016-02-29 16:20:34 -080046using android::base::unique_fd;
47using android::base::WriteFully;
Colin Crossf45fa6b2012-03-26 12:38:26 -070048
Steven Moreland2c3cd832017-02-13 23:44:17 +000049static int sort_func(const String16* lhs, const String16* rhs)
50{
Colin Crossf45fa6b2012-03-26 12:38:26 -070051 return lhs->compare(*rhs);
52}
53
Felipe Lemebbfd2b82016-02-03 11:16:27 -080054static void usage() {
55 fprintf(stderr,
56 "usage: dumpsys\n"
57 " To dump all services.\n"
58 "or:\n"
Steven Moreland2c3cd832017-02-13 23:44:17 +000059 " dumpsys [-t TIMEOUT] [--help | -l | --skip SERVICES | SERVICE [ARGS]]\n"
Felipe Lemebbfd2b82016-02-03 11:16:27 -080060 " --help: shows this help\n"
61 " -l: only list services, do not dump them\n"
Thierry Strudel8b78b752016-03-22 10:25:44 -070062 " -t TIMEOUT: TIMEOUT to use in seconds instead of default 10 seconds\n"
Felipe Leme859aef62016-02-03 12:17:10 -080063 " --skip SERVICES: dumps all services but SERVICES (comma-separated list)\n"
64 " SERVICE [ARGS]: dumps only service SERVICE, optionally passing ARGS to it\n");
65}
66
Felipe Leme343175a2016-08-02 18:57:37 -070067static bool IsSkipped(const Vector<String16>& skipped, const String16& service) {
Felipe Leme859aef62016-02-03 12:17:10 -080068 for (const auto& candidate : skipped) {
69 if (candidate == service) {
70 return true;
71 }
72 }
73 return false;
Felipe Lemebbfd2b82016-02-03 11:16:27 -080074}
75
Felipe Leme343175a2016-08-02 18:57:37 -070076int Dumpsys::main(int argc, char* const argv[]) {
Colin Crossf45fa6b2012-03-26 12:38:26 -070077 Vector<String16> services;
78 Vector<String16> args;
Felipe Leme859aef62016-02-03 12:17:10 -080079 Vector<String16> skippedServices;
keunyoungcaad5552013-06-13 15:08:51 -070080 bool showListOnly = false;
Thierry Strudel8b78b752016-03-22 10:25:44 -070081 bool skipServices = false;
82 int timeoutArg = 10;
83 static struct option longOptions[] = {
84 {"skip", no_argument, 0, 0 },
85 {"help", no_argument, 0, 0 },
86 { 0, 0, 0, 0 }
87 };
88
Felipe Leme343175a2016-08-02 18:57:37 -070089 // Must reset optind, otherwise subsequent calls will fail (wouldn't happen on main.cpp, but
90 // happens on test cases).
91 optind = 1;
Thierry Strudel8b78b752016-03-22 10:25:44 -070092 while (1) {
93 int c;
94 int optionIndex = 0;
95
96 c = getopt_long(argc, argv, "+t:l", longOptions, &optionIndex);
97
98 if (c == -1) {
99 break;
Felipe Lemebbfd2b82016-02-03 11:16:27 -0800100 }
Thierry Strudel8b78b752016-03-22 10:25:44 -0700101
102 switch (c) {
103 case 0:
104 if (!strcmp(longOptions[optionIndex].name, "skip")) {
105 skipServices = true;
106 } else if (!strcmp(longOptions[optionIndex].name, "help")) {
107 usage();
108 return 0;
109 }
110 break;
111
112 case 't':
113 {
114 char *endptr;
115 timeoutArg = strtol(optarg, &endptr, 10);
116 if (*endptr != '\0' || timeoutArg <= 0) {
117 fprintf(stderr, "Error: invalid timeout number: '%s'\n", optarg);
118 return -1;
119 }
120 }
121 break;
122
123 case 'l':
Felipe Lemebbfd2b82016-02-03 11:16:27 -0800124 showListOnly = true;
Thierry Strudel8b78b752016-03-22 10:25:44 -0700125 break;
126
127 default:
128 fprintf(stderr, "\n");
129 usage();
130 return -1;
Felipe Lemebbfd2b82016-02-03 11:16:27 -0800131 }
keunyoungcaad5552013-06-13 15:08:51 -0700132 }
Thierry Strudel8b78b752016-03-22 10:25:44 -0700133
134 for (int i = optind; i < argc; i++) {
135 if (skipServices) {
136 skippedServices.add(String16(argv[i]));
137 } else {
138 if (i == optind) {
139 services.add(String16(argv[i]));
140 } else {
141 args.add(String16(argv[i]));
Felipe Leme859aef62016-02-03 12:17:10 -0800142 }
143 }
144 }
Thierry Strudel8b78b752016-03-22 10:25:44 -0700145
146 if ((skipServices && skippedServices.empty()) ||
Steven Moreland2c3cd832017-02-13 23:44:17 +0000147 (showListOnly && (!services.empty() || !skippedServices.empty()))) {
Thierry Strudel8b78b752016-03-22 10:25:44 -0700148 usage();
149 return -1;
150 }
151
Thierry Strudel159a8322016-03-23 11:22:34 -0700152 if (services.empty() || showListOnly) {
Felipe Leme859aef62016-02-03 12:17:10 -0800153 // gets all services
Felipe Leme343175a2016-08-02 18:57:37 -0700154 services = sm_->listServices();
Colin Crossf45fa6b2012-03-26 12:38:26 -0700155 services.sort(sort_func);
156 args.add(String16("-a"));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700157 }
158
159 const size_t N = services.size();
160
161 if (N > 1) {
162 // first print a list of the current services
163 aout << "Currently running services:" << endl;
Felipe Lemebbfd2b82016-02-03 11:16:27 -0800164
Colin Crossf45fa6b2012-03-26 12:38:26 -0700165 for (size_t i=0; i<N; i++) {
Felipe Leme343175a2016-08-02 18:57:37 -0700166 sp<IBinder> service = sm_->checkService(services[i]);
167
168 if (service != nullptr) {
Felipe Leme859aef62016-02-03 12:17:10 -0800169 bool skipped = IsSkipped(skippedServices, services[i]);
170 aout << " " << services[i] << (skipped ? " (skipped)" : "") << endl;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700171 }
172 }
173 }
174
keunyoungcaad5552013-06-13 15:08:51 -0700175 if (showListOnly) {
176 return 0;
177 }
178
Josh Gao4b8f6f92016-02-29 16:20:34 -0800179 for (size_t i = 0; i < N; i++) {
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700180 const String16& service_name = std::move(services[i]);
Josh Gao4b8f6f92016-02-29 16:20:34 -0800181 if (IsSkipped(skippedServices, service_name)) continue;
Felipe Leme859aef62016-02-03 12:17:10 -0800182
Felipe Leme343175a2016-08-02 18:57:37 -0700183 sp<IBinder> service = sm_->checkService(service_name);
184 if (service != nullptr) {
Josh Gao4b8f6f92016-02-29 16:20:34 -0800185 int sfd[2];
186
Josh Gao49f0a0c2016-03-04 13:12:29 -0800187 if (pipe(sfd) != 0) {
188 aerr << "Failed to create pipe to dump service info for " << service_name
Josh Gao4b8f6f92016-02-29 16:20:34 -0800189 << ": " << strerror(errno) << endl;
190 continue;
191 }
192
193 unique_fd local_end(sfd[0]);
194 unique_fd remote_end(sfd[1]);
195 sfd[0] = sfd[1] = -1;
196
Colin Crossf45fa6b2012-03-26 12:38:26 -0700197 if (N > 1) {
198 aout << "------------------------------------------------------------"
199 "-------------------" << endl;
Josh Gao4b8f6f92016-02-29 16:20:34 -0800200 aout << "DUMP OF SERVICE " << service_name << ":" << endl;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700201 }
Josh Gao4b8f6f92016-02-29 16:20:34 -0800202
203 // dump blocks until completion, so spawn a thread..
204 std::thread dump_thread([=, remote_end { std::move(remote_end) }]() mutable {
205 int err = service->dump(remote_end.get(), args);
206
207 // It'd be nice to be able to close the remote end of the socketpair before the dump
208 // call returns, to terminate our reads if the other end closes their copy of the
209 // file descriptor, but then hangs for some reason. There doesn't seem to be a good
210 // way to do this, though.
Josh Gao9656be12016-09-19 12:44:50 -0700211 remote_end.reset();
Josh Gao4b8f6f92016-02-29 16:20:34 -0800212
213 if (err != 0) {
214 aerr << "Error dumping service info: (" << strerror(err) << ") " << service_name
215 << endl;
216 }
217 });
218
Thierry Strudel8b78b752016-03-22 10:25:44 -0700219 auto timeout = std::chrono::seconds(timeoutArg);
mukesh agrawal2f1eb1c2016-06-08 18:16:36 -0700220 auto start = std::chrono::steady_clock::now();
221 auto end = start + timeout;
Josh Gao4b8f6f92016-02-29 16:20:34 -0800222
223 struct pollfd pfd = {
224 .fd = local_end.get(),
225 .events = POLLIN
226 };
227
228 bool timed_out = false;
229 bool error = false;
230 while (true) {
231 // Wrap this in a lambda so that TEMP_FAILURE_RETRY recalculates the timeout.
232 auto time_left_ms = [end]() {
233 auto now = std::chrono::steady_clock::now();
234 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
235 return std::max(diff.count(), 0ll);
236 };
237
238 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
239 if (rc < 0) {
240 aerr << "Error in poll while dumping service " << service_name << " : "
241 << strerror(errno) << endl;
242 error = true;
243 break;
244 } else if (rc == 0) {
245 timed_out = true;
246 break;
247 }
248
249 char buf[4096];
250 rc = TEMP_FAILURE_RETRY(read(local_end.get(), buf, sizeof(buf)));
251 if (rc < 0) {
252 aerr << "Failed to read while dumping service " << service_name << ": "
253 << strerror(errno) << endl;
254 error = true;
255 break;
256 } else if (rc == 0) {
257 // EOF.
258 break;
259 }
260
261 if (!WriteFully(STDOUT_FILENO, buf, rc)) {
262 aerr << "Failed to write while dumping service " << service_name << ": "
263 << strerror(errno) << endl;
264 error = true;
265 break;
266 }
267 }
268
269 if (timed_out) {
Felipe Leme343175a2016-08-02 18:57:37 -0700270 aout << endl
271 << "*** SERVICE '" << service_name << "' DUMP TIMEOUT (" << timeoutArg
272 << "s) EXPIRED ***" << endl
273 << endl;
Josh Gao4b8f6f92016-02-29 16:20:34 -0800274 }
275
276 if (timed_out || error) {
277 dump_thread.detach();
278 } else {
279 dump_thread.join();
Colin Crossf45fa6b2012-03-26 12:38:26 -0700280 }
mukesh agrawal2f1eb1c2016-06-08 18:16:36 -0700281
282 if (N > 1) {
283 std::chrono::duration<double> elapsed_seconds =
284 std::chrono::steady_clock::now() - start;
mukesh agrawalbca287d2016-07-27 12:01:49 -0700285 aout << StringPrintf("--------- %.3fs ", elapsed_seconds.count()).c_str()
Kevin Rocard430e0792017-08-14 20:40:24 -0700286 << "was the duration of dumpsys " << service_name;
287
288 using std::chrono::system_clock;
289 const auto finish = system_clock::to_time_t(system_clock::now());
290 std::tm finish_tm;
291 localtime_r(&finish, &finish_tm);
292 aout << ", ending at: " << std::put_time(&finish_tm, "%Y-%m-%d %H:%M:%S")
293 << endl;
mukesh agrawal2f1eb1c2016-06-08 18:16:36 -0700294 }
Colin Crossf45fa6b2012-03-26 12:38:26 -0700295 } else {
Josh Gao4b8f6f92016-02-29 16:20:34 -0800296 aerr << "Can't find service: " << service_name << endl;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700297 }
298 }
299
300 return 0;
301}