blob: c1ae5b451f4bf8908a76ecaeb9e45ec2ced05e98 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * 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.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080077#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070078#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010079#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000080#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000081#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000083#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010084#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080085#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010086#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070087#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070088#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070089#include <private/android_filesystem_config.h>
90#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080091#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070092#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000093#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080094#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070095#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070096#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080097
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000098namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
99namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
100namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
101
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using ::std::literals::chrono_literals::operator""ms;
103using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800104using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800105
Felipe Leme47e9be22016-12-21 15:37:07 -0800106// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800107using android::defaultServiceManager;
108using android::Dumpsys;
109using android::INVALID_OPERATION;
110using android::IServiceManager;
111using android::OK;
112using android::sp;
113using android::status_t;
114using android::String16;
115using android::String8;
116using android::TIMED_OUT;
117using android::UNKNOWN_ERROR;
118using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000119using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000120using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121using android::os::dumpstate::CommandOptions;
122using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800123using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800124using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800125using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800126using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800127
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100128// Keep in sync with
129// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
130static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
131
132/* Most simple commands have 10 as timeout, so 5 is a good estimate */
133static const int32_t WEIGHT_FILE = 5;
134
135// TODO: temporary variables and functions used during C++ refactoring
136static Dumpstate& ds = Dumpstate::GetInstance();
137static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100138 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800139 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
140 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100141}
142
143// Reasonable value for max stats.
144static const int STATS_MAX_N_RUNS = 1000;
145static const long STATS_MAX_AVERAGE = 100000;
146
147CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
148
Nandana Duttd2f5f082019-01-18 17:13:52 +0000149typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
150
Colin Crossf45fa6b2012-03-26 12:38:26 -0700151/* read before root is shed */
152static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700153static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000154static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800155// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
156// it's often the case that they time out far too quickly for consent with such a hefty dialog for
157// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
158// roughly match full reports' durations.
159static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700160
Felipe Leme1d486fe2016-10-14 18:06:47 -0700161// TODO: variables and functions below should be part of dumpstate object
162
Felipe Leme635ca312016-01-05 14:23:02 -0800163static std::set<std::string> mount_points;
164void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800165
Todd Poynor2a83daa2013-11-22 15:44:22 -0800166#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700167#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700168#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169
Felipe Lemee82a27d2016-01-05 13:35:44 -0800170#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700171#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700172#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700173#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800174#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100175#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
176#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800177#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900178#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800179#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700180#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800181#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900182#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700183#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000184#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700185#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200186#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700187
Narayan Kamath8f788292017-05-25 13:20:39 +0100188// TODO(narayan): Since this information has to be kept in sync
189// with tombstoned, we should just put it in a common header.
190//
191// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100192static const std::string TOMBSTONE_DIR = "/data/tombstones/";
193static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
194static const std::string ANR_DIR = "/data/anr/";
195static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700196
Felipe Lemee844a9d2016-09-21 15:01:39 -0700197// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000198
Nandana Dutt5c390032019-03-12 10:52:56 +0000199#define RETURN_IF_USER_DENIED_CONSENT() \
200 if (ds.IsUserConsentDenied()) { \
201 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
202 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
203 }
204
205// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
206// if consent is found to be denied.
207#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
208 RETURN_IF_USER_DENIED_CONSENT(); \
209 func_ptr(__VA_ARGS__); \
210 RETURN_IF_USER_DENIED_CONSENT();
211
Rhed Jao5377d792020-07-16 17:37:39 +0800212// Runs func_ptr, and logs a duration report after it's finished.
213#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
214 { \
215 DurationReporter duration_reporter_in_macro(log_title); \
216 func_ptr(__VA_ARGS__); \
217 }
218
219// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
220// is output after a slow function is finished.
221#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
222 RETURN_IF_USER_DENIED_CONSENT(); \
223 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
224 RETURN_IF_USER_DENIED_CONSENT();
225
Chris Morinbc223142022-02-04 14:17:11 -0800226#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800227 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800228 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800229 RETURN_IF_USER_DENIED_CONSENT();
230
Sahana Raof35ed432019-07-12 10:47:52 +0100231static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
232
Rhed Jao5377d792020-07-16 17:37:39 +0800233// Names of parallel tasks, they are used for the DumpPool to identify the dump
234// task and the log title of the duration report.
235static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800236static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
237static const std::string DUMP_HALS_TASK = "DUMP HALS";
238static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800239static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800240
Nandana Dutt979388e2018-11-30 16:48:55 +0000241namespace android {
242namespace os {
243namespace {
244
245static int Open(std::string path, int flags, mode_t mode = 0) {
246 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
247 if (fd == -1) {
248 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
249 }
250 return fd;
251}
252
mhasank2d75c442020-06-11 15:05:25 -0700253static int OpenForWrite(std::string path) {
254 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
255 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
256}
Nandana Dutt979388e2018-11-30 16:48:55 +0000257
258static int OpenForRead(std::string path) {
259 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
260}
261
262bool CopyFile(int in_fd, int out_fd) {
263 char buf[4096];
264 ssize_t byte_count;
265 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
266 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
267 return false;
268 }
269 }
270 return (byte_count != -1);
271}
272
273static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000274 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000275
276 // Obtain a handle to the source file.
277 android::base::unique_fd in_fd(OpenForRead(input_file));
278 if (out_fd != -1 && in_fd.get() != -1) {
279 if (CopyFile(in_fd.get(), out_fd)) {
280 return true;
281 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000282 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000283 }
284 return false;
285}
286
Nandana Duttd2f5f082019-01-18 17:13:52 +0000287static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000288 if (file.empty()) {
289 return false;
290 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000291 if (unlink(file.c_str())) {
292 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000293 return false;
294 }
295 return true;
296}
Nandana Dutt979388e2018-11-30 16:48:55 +0000297
Nikita Ioffea325a572019-05-16 19:49:47 +0100298int64_t GetModuleMetadataVersion() {
299 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
300 if (binder == nullptr) {
301 MYLOGE("Failed to retrieve package_native service");
302 return 0L;
303 }
304 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
305 std::string package_name;
306 auto status = package_service->getModuleMetadataPackageName(&package_name);
307 if (!status.isOk()) {
308 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
309 return 0L;
310 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100311 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100312 int64_t version_code;
313 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
314 &version_code);
315 if (!status.isOk()) {
316 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
317 return 0L;
318 }
319 return version_code;
320}
321
mhasank2d75c442020-06-11 15:05:25 -0700322static bool PathExists(const std::string& path) {
323 struct stat sb;
324 return stat(path.c_str(), &sb) == 0;
325}
326
327static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
328 if (input_file == output_file) {
329 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
330 output_file.c_str());
331 return false;
332 }
333 else if (PathExists(output_file)) {
334 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
335 return false;
336 }
337
338 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
339 android::base::unique_fd out_fd(OpenForWrite(output_file));
340 return CopyFileToFd(input_file, out_fd.get());
341}
342
Nandana Dutt979388e2018-11-30 16:48:55 +0000343} // namespace
344} // namespace os
345} // namespace android
346
Felipe Leme678727a2016-09-21 17:22:11 -0700347static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800348 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800349 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
350 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
351}
352static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
353 int out_fd) {
354 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700355}
356static int DumpFile(const std::string& title, const std::string& path) {
357 return ds.DumpFile(title, path);
358}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800359
Felipe Lemee844a9d2016-09-21 15:01:39 -0700360// Relative directory (inside the zip) for all files copied as-is into the bugreport.
361static const std::string ZIP_ROOT_DIR = "FS";
362
Vishnu Naire97d6122018-01-18 13:58:56 -0800363static const std::string kProtoPath = "proto/";
364static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700365static const std::string kDumpstateBoardFiles[] = {
366 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700367 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700368};
369static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
370
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700371static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700372static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700373
Felipe Lemef0292972016-11-22 13:57:05 -0800374static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
375
Narayan Kamath8f788292017-05-25 13:20:39 +0100376/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100377 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800378 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800379 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100380 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700381static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800382 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100383 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100384
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700385 if (dump_dir == nullptr) {
386 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700387 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700388 }
389
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700390 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100391 struct dirent* entry = nullptr;
392 while ((entry = readdir(dump_dir.get()))) {
393 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100394 continue;
395 }
396
Narayan Kamathbd863722017-06-01 18:50:12 +0100397 const std::string base_name(entry->d_name);
398 if (base_name.find(file_prefix) != 0) {
399 continue;
400 }
401
402 const std::string abs_path = dir_path + base_name;
403 android::base::unique_fd fd(
404 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
405 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700406 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100407 break;
408 }
409
410 struct stat st = {};
411 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700412 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100413 continue;
414 }
415
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700416 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700417 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800418 if (!dump_data.empty()) {
419 std::sort(dump_data.begin(), dump_data.end(),
420 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
421 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100422
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700423 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100424}
425
Narayan Kamathbd863722017-06-01 18:50:12 +0100426static bool AddDumps(const std::vector<DumpData>::const_iterator start,
427 const std::vector<DumpData>::const_iterator end,
428 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100429 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100430 for (auto it = start; it != end; ++it) {
431 const std::string& name = it->name;
432 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100433 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100434
435 // Seek to the beginning of the file before dumping any data. A given
436 // DumpData entry might be dumped multiple times in the report.
437 //
438 // For example, the most recent ANR entry is dumped to the body of the
439 // main entry and it also shows up as a separate entry in the bugreport
440 // ZIP file.
441 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
442 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
443 strerror(errno));
444 }
445
Chris Morinc2cba7a2022-02-01 17:06:50 -0800446 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800447 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100448 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100449 }
450 } else {
451 dump_file_from_fd(type_name, name.c_str(), fd);
452 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100453 }
454
455 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700456}
457
Felipe Leme635ca312016-01-05 14:23:02 -0800458// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700459void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800460 char path[PATH_MAX];
461
462 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
463 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700464 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char linkname[PATH_MAX];
466 ssize_t r = readlink(path, linkname, PATH_MAX);
467 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800468 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800469 return;
470 }
471 linkname[r] = '\0';
472
473 if (mount_points.find(linkname) == mount_points.end()) {
474 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700475 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700476 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800477 mount_points.insert(linkname);
478 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800479 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800480 }
481 }
482}
483
484void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700485 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800486 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800487 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700488 for_each_pid(do_mountinfo, nullptr);
489 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800490}
491
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700492static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
493{
494 DIR *d;
495 struct dirent *de;
496 char path[PATH_MAX];
497
498 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700499 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700500 return;
501 }
502
503 while ((de = readdir(d))) {
504 if (de->d_type != DT_LNK) {
505 continue;
506 }
507 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700508 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700509 }
510
511 closedir(d);
512}
513
Mark Salyzyn326842f2015-04-30 09:49:41 -0700514static bool skip_not_stat(const char *path) {
515 static const char stat[] = "/stat";
516 size_t len = strlen(path);
517 if (path[len - 1] == '/') { /* Directory? */
518 return false;
519 }
520 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
521}
522
Felipe Leme4c2d6632016-09-28 14:32:00 -0700523static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800524 return false;
525}
526
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700527unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700528
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800529//
530// stat offsets
531// Name units description
532// ---- ----- -----------
533// read I/Os requests number of read I/Os processed
534#define __STAT_READ_IOS 0
535// read merges requests number of read I/Os merged with in-queue I/O
536#define __STAT_READ_MERGES 1
537// read sectors sectors number of sectors read
538#define __STAT_READ_SECTORS 2
539// read ticks milliseconds total wait time for read requests
540#define __STAT_READ_TICKS 3
541// write I/Os requests number of write I/Os processed
542#define __STAT_WRITE_IOS 4
543// write merges requests number of write I/Os merged with in-queue I/O
544#define __STAT_WRITE_MERGES 5
545// write sectors sectors number of sectors written
546#define __STAT_WRITE_SECTORS 6
547// write ticks milliseconds total wait time for write requests
548#define __STAT_WRITE_TICKS 7
549// in_flight requests number of I/Os currently in flight
550#define __STAT_IN_FLIGHT 8
551// io_ticks milliseconds total time this block device has been active
552#define __STAT_IO_TICKS 9
553// time_in_queue milliseconds total wait time for all requests
554#define __STAT_IN_QUEUE 10
555#define __STAT_NUMBER_FIELD 11
556//
557// read I/Os, write I/Os
558// =====================
559//
560// These values increment when an I/O request completes.
561//
562// read merges, write merges
563// =========================
564//
565// These values increment when an I/O request is merged with an
566// already-queued I/O request.
567//
568// read sectors, write sectors
569// ===========================
570//
571// These values count the number of sectors read from or written to this
572// block device. The "sectors" in question are the standard UNIX 512-byte
573// sectors, not any device- or filesystem-specific block size. The
574// counters are incremented when the I/O completes.
575#define SECTOR_SIZE 512
576//
577// read ticks, write ticks
578// =======================
579//
580// These values count the number of milliseconds that I/O requests have
581// waited on this block device. If there are multiple I/O requests waiting,
582// these values will increase at a rate greater than 1000/second; for
583// example, if 60 read requests wait for an average of 30 ms, the read_ticks
584// field will increase by 60*30 = 1800.
585//
586// in_flight
587// =========
588//
589// This value counts the number of I/O requests that have been issued to
590// the device driver but have not yet completed. It does not include I/O
591// requests that are in the queue but not yet issued to the device driver.
592//
593// io_ticks
594// ========
595//
596// This value counts the number of milliseconds during which the device has
597// had I/O requests queued.
598//
599// time_in_queue
600// =============
601//
602// This value counts the number of milliseconds that I/O requests have waited
603// on this block device. If there are multiple I/O requests waiting, this
604// value will increase as the product of the number of milliseconds times the
605// number of requests waiting (see "read ticks" above for an example).
606#define S_TO_MS 1000
607//
608
Mark Salyzyn326842f2015-04-30 09:49:41 -0700609static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800610 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700611 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700612 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700614 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615 getline(&buffer, &i, fp);
616 fclose(fp);
617 if (!buffer) {
618 return -errno;
619 }
620 i = strlen(buffer);
621 while ((i > 0) && (buffer[i - 1] == '\n')) {
622 buffer[--i] = '\0';
623 }
624 if (!*buffer) {
625 free(buffer);
626 return 0;
627 }
628 z = true;
629 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800630 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700631 if (fields[i] != 0) {
632 z = false;
633 }
634 }
635 if (z) { /* never accessed */
636 free(buffer);
637 return 0;
638 }
639
Wei Wang509bb5d2017-06-09 14:42:12 -0700640 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
641 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700642 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700643
644 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
645 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
646 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700647 free(buffer);
648
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800649 if (fields[__STAT_IO_TICKS]) {
650 unsigned long read_perf = 0;
651 unsigned long read_ios = 0;
652 if (fields[__STAT_READ_TICKS]) {
653 unsigned long long divisor = fields[__STAT_READ_TICKS]
654 * fields[__STAT_IO_TICKS];
655 read_perf = ((unsigned long long)SECTOR_SIZE
656 * fields[__STAT_READ_SECTORS]
657 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
658 / divisor;
659 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
660 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
661 / divisor;
662 }
663
664 unsigned long write_perf = 0;
665 unsigned long write_ios = 0;
666 if (fields[__STAT_WRITE_TICKS]) {
667 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
668 * fields[__STAT_IO_TICKS];
669 write_perf = ((unsigned long long)SECTOR_SIZE
670 * fields[__STAT_WRITE_SECTORS]
671 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
672 / divisor;
673 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
674 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
675 / divisor;
676 }
677
678 unsigned queue = (fields[__STAT_IN_QUEUE]
679 + (fields[__STAT_IO_TICKS] >> 1))
680 / fields[__STAT_IO_TICKS];
681
682 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700683 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800684 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700685 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800686 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800687 }
688
689 /* bugreport timeout factor adjustment */
690 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
691 worst_write_perf = write_perf;
692 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700693 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700694 return 0;
695}
696
Yao Chenbe3bbc12018-01-17 16:31:10 -0800697static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
698
Tom Cherryf4472f32020-08-05 09:31:17 -0700699// Returns the actual readable size of the given buffer or -1 on error.
700static long logcat_buffer_readable_size(const std::string& buffer) {
701 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
702 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
703 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
704
705 return android_logger_get_log_readable_size(logger);
706}
707
708// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800709static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
710 unsigned long timeout_ms = 0;
711 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700712 long readable_size = logcat_buffer_readable_size(buffer);
713 if (readable_size > 0) {
714 // Engineering margin is ten-fold our guess.
715 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
716 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800717 }
718 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700719}
720
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800721// Opens a socket and returns its file descriptor.
722static int open_socket(const char* service);
723
Nandana Duttd2f5f082019-01-18 17:13:52 +0000724Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
725}
726
727android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
728 std::lock_guard<std::mutex> lock(lock_);
729 result_ = APPROVED;
730 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800731
732 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
733 // consent is granted.
734 if (ds.options_->is_screenshot_copied) {
735 return android::binder::Status::ok();
736 }
737
738 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
739 !ds.do_early_screenshot_) {
740 return android::binder::Status::ok();
741 }
742
743 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
744 ds.options_->screenshot_fd.get());
745 ds.options_->is_screenshot_copied = copy_succeeded;
746 if (copy_succeeded) {
747 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
748 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000749 return android::binder::Status::ok();
750}
751
752android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
753 std::lock_guard<std::mutex> lock(lock_);
754 result_ = DENIED;
755 MYLOGW("User denied consent to share bugreport\n");
756 return android::binder::Status::ok();
757}
758
759UserConsentResult Dumpstate::ConsentCallback::getResult() {
760 std::lock_guard<std::mutex> lock(lock_);
761 return result_;
762}
763
764uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800765 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000766}
767
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700768void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200769 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700770 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700771
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700772 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
773 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700774 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
775 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
776 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200777 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700778 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700779
Felipe Lemed8b94e52016-12-08 10:21:44 -0800780 printf("========================================================\n");
781 printf("== dumpstate: %s\n", date);
782 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700783
Felipe Lemed8b94e52016-12-08 10:21:44 -0800784 printf("\n");
785 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800787 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
788 printf("Bootloader: %s\n", bootloader.c_str());
789 printf("Radio: %s\n", radio.c_str());
790 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100791 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
792 if (module_metadata_version != 0) {
793 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
794 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200795 printf("Android SDK version: %s\n", sdkversion.c_str());
796 printf("SDK extensions: ");
797 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
798 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700799
Felipe Lemed8b94e52016-12-08 10:21:44 -0800800 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800801 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800802 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800803 printf("Uptime: ");
804 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
805 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800806 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800807 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
808 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000809 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800810 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800811}
812
Felipe Leme24b66ee2016-06-16 10:55:26 -0700813// List of file extensions that can cause a zip file attachment to be rejected by some email
814// service providers.
815static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
816 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
817 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
818 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
819};
820
Vishnu Naire97d6122018-01-18 13:58:56 -0800821status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
822 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700823 std::string valid_name = entry_name;
824
825 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700826 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700827 if (idx != std::string::npos) {
828 std::string extension = entry_name.substr(idx);
829 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
830 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
831 valid_name = entry_name + ".renamed";
832 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
833 }
834 }
835
Felipe Leme6fe9db62016-02-12 09:04:16 -0800836 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
837 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000838 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
839 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700840 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700841 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700842 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700843 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800844 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800845 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000846 bool finished_entry = false;
847 auto finish_entry = [this, &finished_entry] {
848 if (!finished_entry) {
849 // This should only be called when we're going to return an earlier error,
850 // which would've been logged. This may imply the file is already corrupt
851 // and any further logging from FinishEntry is more likely to mislead than
852 // not.
853 this->zip_writer_->FinishEntry();
854 }
855 };
856 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800857 auto start = std::chrono::steady_clock::now();
858 auto end = start + timeout;
859 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800860
Felipe Leme770410d2016-01-26 17:07:14 -0800861 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800862 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800863 if (timeout.count() > 0) {
864 // lambda to recalculate the timeout.
865 auto time_left_ms = [end]() {
866 auto now = std::chrono::steady_clock::now();
867 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
868 return std::max(diff.count(), 0LL);
869 };
870
871 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
872 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000873 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
874 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800875 return -errno;
876 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000877 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800878 entry_name.c_str(), strerror(errno), timeout.count());
879 return TIMED_OUT;
880 }
881 }
882
Zach Riggle22200402016-08-18 01:01:24 -0400883 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800884 if (bytes_read == 0) {
885 break;
886 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800887 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800888 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800889 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700890 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800891 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700892 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800893 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800894 }
895 }
896
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700897 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000898 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700899 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700900 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800901 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800902 }
903
Vishnu Naire97d6122018-01-18 13:58:56 -0800904 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905}
906
Felipe Leme1d486fe2016-10-14 18:06:47 -0700907bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
908 android::base::unique_fd fd(
909 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700910 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800911 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800912 return false;
913 }
914
Vishnu Naire97d6122018-01-18 13:58:56 -0800915 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916}
917
918/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700919static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
Felipe Leme1d486fe2016-10-14 18:06:47 -0700923void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700924 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800925 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700926 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800927}
928
Felipe Leme1d486fe2016-10-14 18:06:47 -0700929bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800930 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000931 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
932 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700933 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700934 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700935 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800936 return false;
937 }
938
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700939 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700940 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700941 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700942 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800943 return false;
944 }
945
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700946 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700948 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800949 return false;
950 }
951
952 return true;
953}
954
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800955static void DoKmsg() {
956 struct stat st;
957 if (!stat(PSTORE_LAST_KMSG, &st)) {
958 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
959 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
960 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
961 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
962 } else {
963 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
964 DumpFile("LAST KMSG", "/proc/last_kmsg");
965 }
966}
967
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800968static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800969 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800970 RunCommand(
971 "KERNEL LOG",
972 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
973 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
974}
975
Nandana Duttdb379fa2019-10-09 16:54:41 +0100976static void DoSystemLogcat(time_t since) {
977 char since_str[80];
978 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
979
980 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
981 RunCommand("SYSTEM LOG",
982 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
983 since_str},
984 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
985}
986
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800987static void DoRadioLogcat() {
988 unsigned long timeout_ms = logcat_timeout({"radio"});
989 RunCommand(
990 "RADIO LOG",
991 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
992 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
993}
994
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800995static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800996 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800997 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
998 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -0800999 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001000 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001001 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1002 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001003 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001004 RunCommand(
1005 "EVENT LOG",
1006 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001007 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001008 timeout_ms = logcat_timeout({"stats"});
1009 RunCommand(
1010 "STATS LOG",
1011 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001012 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001013 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001014
1015 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1016
1017 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001018 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1019 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001020}
1021
Mike Ma5c267872019-08-21 11:31:34 -07001022static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001023 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1024 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1025 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1026 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1027 if (fd < 0) {
1028 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1029 return;
1030 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001031 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001032 bool empty = 0 == lseek(fd, 0, SEEK_END);
1033 if (!empty) {
1034 // Use a different name from "incident.proto"
1035 // /proto/incident.proto is reserved for incident service dump
1036 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001037 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1038 path);
1039 } else {
1040 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001041 }
Mike Ma5c267872019-08-21 11:31:34 -07001042}
1043
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001044static void MaybeAddSystemTraceToZip() {
1045 // This function copies into the .zip the system trace that was snapshotted
1046 // by the early call to MaybeSnapshotSystemTrace(), if any background
1047 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001048 if (!ds.has_system_trace_) {
1049 // No background trace was happening at the time dumpstate was invoked.
1050 return;
1051 }
1052 ds.AddZipEntry(
1053 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1054 SYSTEM_TRACE_SNAPSHOT);
1055 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1056}
1057
Sunny Goyal35949782019-11-19 15:54:36 -08001058static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001059 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1060 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1061 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1062 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1063 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1064 if (fd < 0) {
1065 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1066 return;
1067 }
1068 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001069 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001070 bool empty = 0 == lseek(fd, 0, SEEK_END);
1071 if (!empty) {
1072 ds.AddZipEntry("visible_windows.zip", path);
1073 } else {
1074 MYLOGW("Failed to dump visible windows\n");
1075 }
1076 unlink(path.c_str());
1077}
1078
Jayachandran Ca94c7172017-06-10 15:08:12 -07001079static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001080 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1081 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001082 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001083 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001084 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1085 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1086 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1087 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001088}
1089
David Andersond9ba4752018-12-11 18:26:59 -08001090static void DumpDynamicPartitionInfo() {
1091 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1092 return;
1093 }
1094
1095 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001096 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001097}
1098
Chris Morin5a50d482022-02-01 17:41:18 -08001099static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001100 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1101 anr_traces_dir.c_str());
1102
1103 // If we're here, dump_traces_path will always be a temporary file
1104 // (created with mkostemp or similar) that contains dumps taken earlier
1105 // on in the process.
1106 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001107 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1108 dump_traces_path);
1109 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001110
1111 const int ret = unlink(dump_traces_path);
1112 if (ret == -1) {
1113 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1114 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001115 }
1116 }
1117
Narayan Kamathbd863722017-06-01 18:50:12 +01001118 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001119 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001120 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001121 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001122 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001123
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001124 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001125 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001126 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001127 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001128 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1129 }
1130}
1131
1132static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001133 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001134
Chris Morin5a50d482022-02-01 17:41:18 -08001135 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001136
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001137 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1138
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001139 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001140 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001141 int i = 0;
1142 while (true) {
1143 const std::string slow_trace_path =
1144 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1145 if (stat(slow_trace_path.c_str(), &st)) {
1146 // No traces file at this index, done with the files.
1147 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001148 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001149 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1150 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001151 }
1152}
1153
Wei Wang509bb5d2017-06-09 14:42:12 -07001154static void DumpBlockStatFiles() {
1155 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001156
Wei Wang1dc1ef52017-06-12 11:28:37 -07001157 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1158
1159 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001160 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1161 return;
1162 }
1163
1164 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001165 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001166 if ((d->d_name[0] == '.')
1167 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1168 || (d->d_name[1] == '\0'))) {
1169 continue;
1170 }
1171 const std::string new_path =
1172 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1173 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1174 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1175 printf("\n");
1176 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001177 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001178}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001179
1180static void DumpPacketStats() {
1181 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001182}
1183
1184static void DumpIpAddrAndRules() {
1185 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1186 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1187 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1188 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1189 RunCommand("IP RULES", {"ip", "rule", "show"});
1190 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1191}
1192
Nandana Dutt5c390032019-03-12 10:52:56 +00001193static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1194 std::chrono::milliseconds timeout,
1195 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001196 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001197 sp<android::IServiceManager> sm = defaultServiceManager();
1198 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001199 Vector<String16> args;
1200 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001201 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1202 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001203 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001204 std::string path(title);
1205 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001206 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001207 if (PropertiesHelper::IsDryRun()) {
1208 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1209 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1210 } else {
1211 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1212 if (status == OK) {
1213 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1214 std::chrono::duration<double> elapsed_seconds;
1215 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1216 service == String16("meminfo")) {
1217 // Use a longer timeout for meminfo, since 30s is not always enough.
1218 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1219 /* as_proto = */ false, elapsed_seconds,
1220 bytes_written);
1221 } else {
1222 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1223 /* as_proto = */ false, elapsed_seconds,
1224 bytes_written);
1225 }
1226 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1227 bool dump_complete = (status == OK);
1228 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001229 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001230 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001231
1232 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1233 std::chrono::steady_clock::now() - start);
1234 if (elapsed_duration > timeout) {
1235 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1236 elapsed_duration.count());
1237 break;
1238 }
1239 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001240 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001241}
1242
Vishnu Nair64afc022018-02-01 15:29:34 -08001243static void RunDumpsysText(const std::string& title, int priority,
1244 std::chrono::milliseconds timeout,
1245 std::chrono::milliseconds service_timeout) {
1246 DurationReporter duration_reporter(title);
1247 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1248 fsync(STDOUT_FILENO);
1249 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1250}
1251
1252/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001253static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1254 std::chrono::milliseconds timeout,
1255 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001256 DurationReporter duration_reporter(title);
1257 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1258 fsync(STDOUT_FILENO);
1259 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1260 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001261
1262 RETURN_IF_USER_DENIED_CONSENT();
1263
1264 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1265 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001266}
1267
Nandana Dutt5c390032019-03-12 10:52:56 +00001268static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1269 std::chrono::milliseconds timeout,
1270 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001271 sp<android::IServiceManager> sm = defaultServiceManager();
1272 Dumpsys dumpsys(sm.get());
1273 Vector<String16> args;
1274 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1275 DurationReporter duration_reporter(title);
1276
1277 auto start = std::chrono::steady_clock::now();
1278 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1279 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001280 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001281 std::string path(kProtoPath);
1282 path.append(String8(service).c_str());
1283 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1284 path.append("_CRITICAL");
1285 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1286 path.append("_HIGH");
1287 }
1288 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001289 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001290 if (status == OK) {
1291 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1292 bool dumpTerminated = (status == OK);
1293 dumpsys.stopDumpThread(dumpTerminated);
1294 }
1295 ZipWriter::FileEntry file_entry;
1296 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001297
1298 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1299 std::chrono::steady_clock::now() - start);
1300 if (elapsed_duration > timeout) {
1301 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1302 elapsed_duration.count());
1303 break;
1304 }
1305 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001306 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001307}
1308
Nandana Dutta7db6342018-11-21 14:53:34 +00001309// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001310static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001311 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1312 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001313
1314 RETURN_IF_USER_DENIED_CONSENT();
1315
1316 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1317 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001318}
1319
1320// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001321static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001322 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1323 // high priority. Reduce timeout once they are able to dump in a shorter time or
1324 // moved to a parallel task.
1325 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1326 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001327
1328 RETURN_IF_USER_DENIED_CONSENT();
1329
1330 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1331 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001332}
1333
1334// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001335static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001336 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001337
1338 RETURN_IF_USER_DENIED_CONSENT();
1339
1340 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1341 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001342}
1343
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001344/*
1345 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1346 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1347 * if it's not running in the parallel task.
1348 */
1349static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001350 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001351 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1352 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001353
Steven Moreland44cd9482018-01-04 16:24:13 -08001354 using android::hidl::manager::V1_0::IServiceManager;
1355 using android::hardware::defaultServiceManager;
1356
1357 sp<IServiceManager> sm = defaultServiceManager();
1358 if (sm == nullptr) {
1359 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1360 return;
1361 }
1362
1363 auto ret = sm->list([&](const auto& interfaces) {
1364 for (const std::string& interface : interfaces) {
1365 std::string cleanName = interface;
1366 std::replace_if(cleanName.begin(),
1367 cleanName.end(),
1368 [](char c) {
1369 return !isalnum(c) &&
1370 std::string("@-_:.").find(c) == std::string::npos;
1371 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001372 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001373
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001374 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001375 {
1376 auto fd = android::base::unique_fd(
1377 TEMP_FAILURE_RETRY(open(path.c_str(),
1378 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1379 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1380 if (fd < 0) {
1381 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1382 continue;
1383 }
1384 RunCommandToFd(fd,
1385 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001386 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001387 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1388
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001389 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001390 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001391 if (!empty) {
1392 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1393 path);
1394 } else {
1395 unlink(path.c_str());
1396 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001397 }
1398 });
1399
1400 if (!ret.isOk()) {
1401 MYLOGE("Could not list hals from hwservicemanager.\n");
1402 }
1403}
1404
Devin Moore8df81bb2022-06-08 22:47:02 +00001405// Dump all of the files that make up the vendor interface.
1406// See the files listed in dumpFileList() for the latest list of files.
1407static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001408
1409 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1410 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001411 for (const auto vintfFile : vintfFiles) {
1412 struct stat st;
1413 if (stat(vintfFile.c_str(), &st) == 0) {
1414 if (S_ISDIR(st.st_mode)) {
1415 ds.AddDir(vintfFile, true /* recursive */);
1416 } else {
1417 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1418 vintfFile);
1419 }
1420 }
1421 }
1422}
1423
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001424static void DumpExternalFragmentationInfo() {
1425 struct stat st;
1426 if (stat("/proc/buddyinfo", &st) != 0) {
1427 MYLOGE("Unable to dump external fragmentation info\n");
1428 return;
1429 }
1430
1431 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1432 std::ifstream ifs("/proc/buddyinfo");
1433 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1434 for (std::string line; std::getline(ifs, line);) {
1435 std::smatch match_results;
1436 if (std::regex_match(line, match_results, unusable_index_regex)) {
1437 std::stringstream free_pages(std::string{match_results[3]});
1438 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1439 std::istream_iterator<int>());
1440
1441 int total_free_pages = 0;
1442 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1443 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1444 }
1445
1446 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1447 match_results[2].str().c_str());
1448
1449 int usable_free_pages = total_free_pages;
1450 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1451 auto unusable_index = (total_free_pages - usable_free_pages) /
1452 static_cast<double>(total_free_pages);
1453 printf(" %5.3f", unusable_index);
1454 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1455 }
1456
1457 printf("\n");
1458 }
1459 }
1460 printf("\n");
1461}
1462
mhasankd451a472020-05-26 18:02:39 -07001463static void DumpstateLimitedOnly() {
1464 // Trimmed-down version of dumpstate to only include a whitelisted
1465 // set of logs (system log, event log, and system server / system app
1466 // crashes, and networking logs). See b/136273873 and b/138459828
1467 // for context.
1468 DurationReporter duration_reporter("DUMPSTATE");
1469 unsigned long timeout_ms;
1470 // calculate timeout
1471 timeout_ms = logcat_timeout({"main", "system", "crash"});
1472 RunCommand("SYSTEM LOG",
1473 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1474 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1475 timeout_ms = logcat_timeout({"events"});
1476 RunCommand(
1477 "EVENT LOG",
1478 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1479 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1480
1481 printf("========================================================\n");
1482 printf("== Networking Service\n");
1483 printf("========================================================\n");
1484
1485 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1486 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001487 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1488 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001489
1490 printf("========================================================\n");
1491 printf("== Dropbox crashes\n");
1492 printf("========================================================\n");
1493
1494 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1495 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1496
1497 printf("========================================================\n");
1498 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1499 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1500 printf("========================================================\n");
1501 printf("== dumpstate: done (id %d)\n", ds.id_);
1502 printf("========================================================\n");
1503}
1504
Rhed Jaoe017f982020-07-21 17:58:41 +08001505/*
1506 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1507 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1508 * if it's not running in the parallel task.
1509 */
1510static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1511 dprintf(out_fd, "========================================================\n");
1512 dprintf(out_fd, "== Checkins\n");
1513 dprintf(out_fd, "========================================================\n");
1514
1515 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001516 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1517 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1518 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1519 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1520}
1521
1522/*
1523 * Runs dumpsys on activity service to dump all application activities, services
1524 * and providers in the device.
1525 *
1526 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1527 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1528 * if it's not running in the parallel task.
1529 */
1530static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1531 dprintf(out_fd, "========================================================\n");
1532 dprintf(out_fd, "== Running Application Activities\n");
1533 dprintf(out_fd, "========================================================\n");
1534
1535 // The following dumpsys internally collects output from running apps, so it can take a long
1536 // time. So let's extend the timeout.
1537
1538 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1539
1540 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1541
1542 dprintf(out_fd, "========================================================\n");
1543 dprintf(out_fd, "== Running Application Services (platform)\n");
1544 dprintf(out_fd, "========================================================\n");
1545
1546 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1547 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1548
1549 dprintf(out_fd, "========================================================\n");
1550 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1551 dprintf(out_fd, "========================================================\n");
1552
1553 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1554 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1555
1556 dprintf(out_fd, "========================================================\n");
1557 dprintf(out_fd, "== Running Application Providers (platform)\n");
1558 dprintf(out_fd, "========================================================\n");
1559
1560 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001561 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001562
1563 dprintf(out_fd, "========================================================\n");
1564 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1565 dprintf(out_fd, "========================================================\n");
1566
1567 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1568 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1569}
1570
Nandana Dutt5c390032019-03-12 10:52:56 +00001571// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1572// via the consent they are shown. Ignores other errors that occur while running various
1573// commands. The consent checking is currently done around long running tasks, which happen to
1574// be distributed fairly evenly throughout the function.
1575static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001576 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001577
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001578 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Chris Morinbc223142022-02-04 14:17:11 -08001579 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001580 if (ds.dump_pool_) {
1581 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1582 // drop root user. Restarts it with two threads for the parallel run.
1583 ds.dump_pool_->start(/* thread_counts = */2);
1584
Chris Morinbc223142022-02-04 14:17:11 -08001585 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1586 dump_incident_report = ds.dump_pool_->enqueueTask(
1587 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
1588 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1589 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1590 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001591 }
1592
Nandana Dutt5c390032019-03-12 10:52:56 +00001593 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1594 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1595 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001596 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001597 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001598 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001599 DumpFile("MEMORY INFO", "/proc/meminfo");
1600 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001601 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001602
Kevin Jeon947922b2022-09-21 00:29:18 +00001603 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1604 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001605
Sunny Goyal35949782019-11-19 15:54:36 -08001606 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1607
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001608 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1609 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1610 DumpFile("SLAB INFO", "/proc/slabinfo");
1611 DumpFile("ZONEINFO", "/proc/zoneinfo");
1612 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1613 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001614 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001615
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001616 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001617
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001618 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001619 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001620
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001621 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001622 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001623 } else {
1624 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1625 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001626
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001627 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001628 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001629 struct stat s;
1630 if (stat("/proc/modules", &s) != 0) {
1631 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1632 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001633 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001634 RunCommand("MODULES INFO",
1635 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1636 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1637 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001638 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001639
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001640 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001641 DoKernelLogcat();
1642 } else {
1643 do_dmesg();
1644 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001645
Devin Moore8df81bb2022-06-08 22:47:02 +00001646 DumpVintf();
1647
Felipe Lemef0292972016-11-22 13:57:05 -08001648 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001649
Jeff Brown1dc94e32014-09-11 14:15:27 -07001650 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001651 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001652
Jack Yu5a6b2e22020-08-14 18:13:35 +08001653 /* Dump Nfc NCI logs */
1654 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001655
Paul Chang0d2aad72020-02-13 20:04:03 +08001656 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001657 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001658 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001659 }
1660
Felipe Lemee184f662016-10-27 10:04:47 -07001661 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001662
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001663 MaybeAddSystemTraceToZip();
1664
Narayan Kamath8f788292017-05-25 13:20:39 +01001665 // NOTE: tombstones are always added as separate entries in the zip archive
1666 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001667 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001668 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001669 if (!tombstones_dumped) {
1670 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001671 }
1672
Jayachandran Ca94c7172017-06-10 15:08:12 -07001673 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001674
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001675 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001676
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001677 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001678
Jayachandran Ca94c7172017-06-10 15:08:12 -07001679 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001680
1681 dump_route_tables();
1682
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001683 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1684 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1685 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001686
Nandana Dutt5c390032019-03-12 10:52:56 +00001687 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001688
Chiachang Wang668ede42021-05-17 17:14:20 +08001689 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1690 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1691 // dump with priority parameters to dump high priority information.
1692 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1693 CommandOptions::WithTimeout(10).Build());
1694
Elliott Hughes23ccc622017-02-28 10:14:22 -08001695 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001696
Jin Qianf334d662017-10-10 14:41:37 -07001697 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001698
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001699 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001700
Colin Crossf45fa6b2012-03-26 12:38:26 -07001701 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001702 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1703 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1704
1705 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1706 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1707 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1708 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1709 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001711 /* Add window and surface trace files. */
1712 if (!PropertiesHelper::IsUserBuild()) {
1713 ds.AddDir(WMTRACE_DATA_DIR, false);
1714 }
1715
Yifan Hongd90cc652020-02-08 16:52:02 -08001716 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1717
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001718 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001719 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001720 } else {
1721 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1722 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001723
Steven Moreland7440ddb2016-12-15 16:13:39 -08001724 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001725 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1726 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001727 // su does not exist on user builds, so try running without it.
1728 // This way any implementations of vril-dump that do not require
1729 // root can run on user builds.
1730 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001731 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001732 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001733 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001734 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001735 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001736 }
1737
Felipe Lemed8b94e52016-12-08 10:21:44 -08001738 printf("========================================================\n");
1739 printf("== Android Framework Services\n");
1740 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001741
Nandana Dutt5c390032019-03-12 10:52:56 +00001742 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001743
Jack He91ff2fe2021-02-18 18:23:43 -08001744 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1745 ds.AddDir("/data/misc/bluetooth/logs", true);
1746
Rhed Jaoe017f982020-07-21 17:58:41 +08001747 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001748 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001749 } else {
1750 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1751 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001752
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001753 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001754
Adrian Roos8b397ab2017-04-04 16:35:44 -07001755 printf("========================================================\n");
1756 printf("== Dropbox crashes\n");
1757 printf("========================================================\n");
1758
1759 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1760 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1761
Felipe Lemed8b94e52016-12-08 10:21:44 -08001762 printf("========================================================\n");
1763 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1764 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1765 printf("========================================================\n");
1766 printf("== dumpstate: done (id %d)\n", ds.id_);
1767 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001768
1769 printf("========================================================\n");
1770 printf("== Obtaining statsd metadata\n");
1771 printf("========================================================\n");
1772 // This differs from the usual dumpsys stats, which is the stats report data.
1773 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001774
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001775 // Add linker configuration directory
1776 ds.AddDir(LINKERCONFIG_DIR, true);
1777
Li Li830179f2022-01-04 12:53:29 -08001778 /* Dump frozen cgroupfs */
1779 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001780
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001781 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001782 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001783 } else {
1784 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1785 DumpIncidentReport);
1786 }
Mike Ma5c267872019-08-21 11:31:34 -07001787
Nandana Dutt5c390032019-03-12 10:52:56 +00001788 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001789}
1790
Nandana Dutt5c390032019-03-12 10:52:56 +00001791/*
1792 * Dumps state for the default case; drops root after it's no longer necessary.
1793 *
1794 * Returns RunStatus::OK if everything went fine.
1795 * Returns RunStatus::ERROR if there was an error.
1796 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1797 * with the caller.
1798 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001799Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001800 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1801 // buffer.
1802 DoLogcat();
1803 // Capture timestamp after first logcat to use in next logcat
1804 time_t logcat_ts = time(nullptr);
1805
Nandana Dutt4be45d12018-09-26 15:04:23 +01001806 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001807 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001808 if (dump_pool_) {
1809 RETURN_IF_USER_DENIED_CONSENT();
1810 // One thread is enough since we only need to enqueue DumpTraces here.
1811 dump_pool_->start(/* thread_counts = */1);
1812
1813 // DumpTraces takes long time, post it to the another thread in the
1814 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001815 dump_traces = dump_pool_->enqueueTask(
1816 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001817 } else {
1818 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1819 &dump_traces_path);
1820 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001821
1822 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001823 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001824 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1825 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001826 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001827
1828 ds.AddDir(RECOVERY_DIR, true);
1829 ds.AddDir(RECOVERY_DATA_DIR, true);
1830 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1831 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1832 if (!PropertiesHelper::IsUserBuild()) {
1833 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1834 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001835 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001836 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001837 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001838 add_mountinfo();
1839 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001840 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001841 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001842
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001843 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001844 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1845
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001846 // Dump IPsec stats. No keys are exposed here.
1847 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1848
Nandana Dutt4be45d12018-09-26 15:04:23 +01001849 // Run ss as root so we can see socket marks.
1850 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1851
1852 // Run iotop as root to show top 100 IO threads
1853 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1854
Erick Reyese68df822019-02-11 14:46:36 -08001855 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001856 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1857 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001858
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001859 DumpFile("PSI cpu", "/proc/pressure/cpu");
1860 DumpFile("PSI memory", "/proc/pressure/memory");
1861 DumpFile("PSI io", "/proc/pressure/io");
1862
Mårten Kongstad60195a72022-09-20 14:14:20 +02001863 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1864 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1865
Rhed Jao5377d792020-07-16 17:37:39 +08001866 if (dump_pool_) {
1867 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001868 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001869
Chris Morinbc223142022-02-04 14:17:11 -08001870 // Current running thread in the pool is the root user also. Delete
1871 // the pool and make a new one later to ensure none of threads in the pool are root.
1872 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001873 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001874 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001875 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001876 }
1877
Nandana Dutt5c390032019-03-12 10:52:56 +00001878 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001879 Dumpstate::RunStatus status = dumpstate();
1880 // Capture logcat since the last time we did it.
1881 DoSystemLogcat(logcat_ts);
1882 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001883}
1884
Rhed Jaob5685b32020-08-14 17:19:17 +08001885// Common states for telephony and wifi which are needed to be collected before
1886// dumpstate drop the root user.
1887static void DumpstateRadioAsRoot() {
1888 DumpIpTablesAsRoot();
1889 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1890}
1891
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001892// This method collects common dumpsys for telephony and wifi. Typically, wifi
1893// reports are fine to include all information, but telephony reports on user
1894// builds need to strip some content (see DumpstateTelephonyOnly).
1895static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001896 // We need to be picky about some stuff for telephony reports on user builds.
1897 if (!include_sensitive_info) {
1898 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1899 DoRadioLogcat();
1900 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001901 // DumpHals takes long time, post it to the another thread in the pool,
1902 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001903 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001904 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001905 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001906 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001907 // Contains various system properties and process startup info.
1908 do_dmesg();
1909 // Logs other than the radio buffer may contain package/component names and potential PII.
1910 DoLogcat();
1911 // Too broad for connectivity problems.
1912 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001913 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1914 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001915 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001916 } else {
1917 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1918 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001919 }
1920
Jayachandran Ca94c7172017-06-10 15:08:12 -07001921 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001922 DumpIpAddrAndRules();
1923 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001924 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1925 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001926}
1927
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001928// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1929// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1930// for what can be included on user builds: all reported information MUST directly relate to
1931// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1932// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1933// names are not), and MUST NOT contain logs of user application traffic.
1934// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001935static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001936 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001937
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001938 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001939
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001940 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001941
Rhed Jaob5685b32020-08-14 17:19:17 +08001942 DumpstateRadioAsRoot();
1943 if (!DropRootUser()) {
1944 return;
1945 }
1946
1947 // Starts thread pool after the root user is dropped, and two additional threads
1948 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08001949 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08001950 if (ds.dump_pool_) {
1951 ds.dump_pool_->start(/*thread_counts =*/2);
1952
1953 // DumpstateBoard takes long time, post it to the another thread in the pool,
1954 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001955 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1956 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001957 }
1958
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001959 DumpstateRadioCommon(include_sensitive_info);
1960
1961 if (include_sensitive_info) {
1962 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1963 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1964 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1965 // way.
1966 RunCommand("SYSTEM PROPERTIES", {"getprop"});
1967 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07001968
1969 printf("========================================================\n");
1970 printf("== Android Framework Services\n");
1971 printf("========================================================\n");
1972
Vishnu Nair652cc802017-11-30 15:18:30 -08001973 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
1974 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07001975 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
1976 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001977 if (include_sensitive_info) {
1978 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
1979 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
1980 SEC_TO_MSEC(10));
1981 } else {
1982 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
1983 // running dumpsys activity service all-non-platform below. Due to the increased output, we
1984 // give a higher timeout as well.
1985 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
1986 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
1987 }
1988 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001989 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1990 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07001991 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08001992 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
1993 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001994 if (include_sensitive_info) {
1995 // Contains raw IP addresses, omit from reports on user builds.
1996 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
1997 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
1998 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
1999 SEC_TO_MSEC(10));
2000 // Contains package/component names, omit from reports on user builds.
2001 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2002 SEC_TO_MSEC(10));
2003 // Contains package names, but should be relatively simple to remove them (also contains
2004 // UIDs already), omit from reports on user builds.
2005 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2006 SEC_TO_MSEC(10));
2007 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002008
2009 printf("========================================================\n");
2010 printf("== Running Application Services\n");
2011 printf("========================================================\n");
2012
2013 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2014
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002015 if (include_sensitive_info) {
2016 printf("========================================================\n");
2017 printf("== Running Application Services (non-platform)\n");
2018 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002019
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002020 // Contains package/component names and potential PII, omit from reports on user builds.
2021 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2022 // carrier_config dumpsys instead.
2023 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2024 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002025
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002026 printf("========================================================\n");
2027 printf("== Checkins\n");
2028 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002029
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002030 // Contains package/component names, omit from reports on user builds.
2031 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2032 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002033
2034 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002035 printf("== dumpstate: done (id %d)\n", ds.id_);
2036 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002037
2038 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002039 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002040 } else {
2041 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2042 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002043}
2044
mukesh agrawal253dad42018-01-23 21:59:59 -08002045// This method collects dumpsys for wifi debugging only
2046static void DumpstateWifiOnly() {
2047 DurationReporter duration_reporter("DUMPSTATE");
2048
Rhed Jaob5685b32020-08-14 17:19:17 +08002049 DumpstateRadioAsRoot();
2050 if (!DropRootUser()) {
2051 return;
2052 }
2053
2054 // Starts thread pool after the root user is dropped. Only one additional
2055 // thread is needed for DumpHals in the DumpstateRadioCommon.
2056 if (ds.dump_pool_) {
2057 ds.dump_pool_->start(/*thread_counts =*/1);
2058 }
2059
mukesh agrawal253dad42018-01-23 21:59:59 -08002060 DumpstateRadioCommon();
2061
2062 printf("========================================================\n");
2063 printf("== Android Framework Services\n");
2064 printf("========================================================\n");
2065
2066 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2067 SEC_TO_MSEC(10));
2068 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2069 SEC_TO_MSEC(10));
2070
2071 printf("========================================================\n");
2072 printf("== dumpstate: done (id %d)\n", ds.id_);
2073 printf("========================================================\n");
2074}
2075
Nandana Duttcf419a72019-03-14 10:40:17 +00002076Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002077 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002078 const size_t buf_size = temp_file_pattern.length() + 1;
2079 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2080 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2081
2082 // Create a new, empty file to receive all trace dumps.
2083 //
2084 // TODO: This can be simplified once we remove support for the old style
2085 // dumps. We can have a file descriptor passed in to dump_traces instead
2086 // of creating a file, closing it and then reopening it again.
2087 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2088 if (fd < 0) {
2089 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002090 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002091 }
2092
2093 // Nobody should have access to this temporary file except dumpstate, but we
2094 // temporarily grant 'read' to 'others' here because this file is created
2095 // when tombstoned is still running as root, but dumped after dropping. This
2096 // can go away once support for old style dumping has.
2097 const int chmod_ret = fchmod(fd, 0666);
2098 if (chmod_ret < 0) {
2099 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002100 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002101 }
2102
2103 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2104 if (proc.get() == nullptr) {
2105 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002106 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002107 }
2108
2109 // Number of times process dumping has timed out. If we encounter too many
2110 // failures, we'll give up.
2111 int timeout_failures = 0;
2112 bool dalvik_found = false;
2113
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002114 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002115
2116 struct dirent* d;
2117 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002118 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002119 int pid = atoi(d->d_name);
2120 if (pid <= 0) {
2121 continue;
2122 }
2123
2124 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2125 std::string exe;
2126 if (!android::base::Readlink(link_name, &exe)) {
2127 continue;
2128 }
2129
2130 bool is_java_process;
2131 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2132 // Don't bother dumping backtraces for the zygote.
2133 if (IsZygote(pid)) {
2134 continue;
2135 }
2136
2137 dalvik_found = true;
2138 is_java_process = true;
2139 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2140 is_java_process = false;
2141 } else {
2142 // Probably a native process we don't care about, continue.
2143 continue;
2144 }
2145
2146 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2147 if (timeout_failures == 3) {
2148 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2149 break;
2150 }
2151
2152 const uint64_t start = Nanotime();
2153 const int ret = dump_backtrace_to_file_timeout(
2154 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2155 is_java_process ? 5 : 20, fd);
2156
2157 if (ret == -1) {
2158 // For consistency, the header and footer to this message match those
2159 // dumped by debuggerd in the success case.
2160 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2161 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2162 dprintf(fd, "---- end %d ----", pid);
2163 timeout_failures++;
2164 continue;
2165 }
2166
2167 // We've successfully dumped stack traces, reset the failure count
2168 // and write a summary of the elapsed time to the file and continue with the
2169 // next process.
2170 timeout_failures = 0;
2171
2172 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2173 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2174 }
2175
2176 if (!dalvik_found) {
2177 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2178 }
2179
Nandana Duttcf419a72019-03-14 10:40:17 +00002180 *path = file_name_buf.release();
2181 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002182}
2183
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002184static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2185 const Dumpstate::BugreportMode bugreport_mode) {
2186 switch (bugreport_mode) {
2187 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2188 return dumpstate_hal_hidl::DumpstateMode::FULL;
2189 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2190 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2191 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2192 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2193 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2194 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2195 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2196 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2197 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2198 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2199 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2200 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2201 }
2202 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2203}
2204
2205static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2206 const Dumpstate::BugreportMode bugreport_mode) {
2207 switch (bugreport_mode) {
2208 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2209 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2210 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2211 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2212 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2213 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2214 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2215 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2216 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2217 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2218 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2219 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2220 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2221 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2222 }
2223 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2224}
2225
2226static void DoDumpstateBoardHidl(
2227 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2228 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2229 const Dumpstate::BugreportMode bugreport_mode,
2230 const size_t timeout_sec) {
2231
2232 using ScopedNativeHandle =
2233 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2234 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2235 [](native_handle_t* handle) {
2236 // we don't close file handle's here
2237 // via native_handle_close(handle)
2238 // instead we let dumpstate_fds close the file handles when
2239 // dumpstate_fds gets destroyed
2240 native_handle_delete(handle);
2241 });
2242 if (handle == nullptr) {
2243 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2244 return;
2245 }
2246
2247 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2248 handle.get()->data[i] = dumpstate_fds[i].get();
2249 }
2250
2251 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2252 // implement just 1.0.
2253 const char* descriptor_to_kill;
2254 using DumpstateBoardTask = std::packaged_task<bool()>;
2255 DumpstateBoardTask dumpstate_board_task;
2256 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2257 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2258 if (dumpstate_hal != nullptr) {
2259 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2260
2261 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2262 GetDumpstateHalModeHidl(bugreport_mode);
2263
2264 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2265 dumpstate_board_task =
2266 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2267 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2268 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2269 SEC_TO_MSEC(timeout_sec));
2270 if (!status.isOk()) {
2271 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2272 return false;
2273 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2274 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2275 dumpstate_hal_hidl::toString(status).c_str());
2276 return false;
2277 }
2278 return true;
2279 });
2280 } else {
2281 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2282
2283 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2284 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2285 ::android::hardware::Return<void> status =
2286 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2287 if (!status.isOk()) {
2288 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2289 return false;
2290 }
2291 return true;
2292 });
2293 }
2294 auto result = dumpstate_board_task.get_future();
2295 std::thread(std::move(dumpstate_board_task)).detach();
2296
2297 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2298 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2299 if (!android::base::SetProperty(
2300 "ctl.interface_restart",
2301 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2302 MYLOGE("Couldn't restart dumpstate HAL\n");
2303 }
2304 }
2305 // Wait some time for init to kill dumpstate vendor HAL
2306 constexpr size_t killing_timeout_sec = 10;
2307 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2308 MYLOGE(
2309 "killing dumpstateBoard timed out after %zus, continue and "
2310 "there might be racing in content\n",
2311 killing_timeout_sec);
2312 }
2313}
2314
2315static void DoDumpstateBoardAidl(
2316 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2317 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2318 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2319 MYLOGI("Using IDumpstateDevice AIDL HAL");
2320
2321 const char* descriptor_to_kill;
2322 using DumpstateBoardTask = std::packaged_task<bool()>;
2323 DumpstateBoardTask dumpstate_board_task;
2324 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2325 GetDumpstateHalModeAidl(bugreport_mode);
2326
2327 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2328 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2329 timeout_sec]() -> bool {
2330 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2331
2332 if (!status.isOk()) {
2333 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2334 return false;
2335 }
2336 return true;
2337 });
2338 auto result = dumpstate_board_task.get_future();
2339 std::thread(std::move(dumpstate_board_task)).detach();
2340
2341 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2342 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2343 if (!android::base::SetProperty(
2344 "ctl.interface_restart",
2345 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2346 MYLOGE("Couldn't restart dumpstate HAL\n");
2347 }
2348 }
2349 // Wait some time for init to kill dumpstate vendor HAL
2350 constexpr size_t killing_timeout_sec = 10;
2351 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2352 MYLOGE(
2353 "killing dumpstateBoard timed out after %zus, continue and "
2354 "there might be racing in content\n",
2355 killing_timeout_sec);
2356 }
2357}
2358
2359static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2360 const std::string aidl_instance_name =
2361 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2362
2363 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2364 return nullptr;
2365 }
2366
2367 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2368
2369 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2370}
2371
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002372void Dumpstate::DumpstateBoard(int out_fd) {
2373 dprintf(out_fd, "========================================================\n");
2374 dprintf(out_fd, "== Board\n");
2375 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002376
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002377 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002378 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002379 * set to true and unmount it after invoking dumpstateBoard_* methods.
2380 * This is to enable debug builds to not have debugfs mounted during runtime.
2381 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002382 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002383 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002384 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002385 if (mount_debugfs) {
2386 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2387 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002388 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002389 }
2390
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002391 std::vector<std::string> paths;
2392 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002393 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002394 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2395 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002396 remover.emplace_back(android::base::make_scope_guard(
2397 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002398 }
Jie Song9fbfad02017-06-20 16:29:42 -07002399
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002400 // get dumpstate HAL AIDL implementation
2401 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2402 GetDumpstateBoardAidlService());
2403 if (dumpstate_hal_handle_aidl == nullptr) {
2404 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2405 }
2406
2407 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2408 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2409 if (dumpstate_hal_handle_aidl == nullptr) {
2410 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2411 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2412 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2413 }
2414 }
2415
2416 // if neither HIDL nor AIDL implementation found, then return
2417 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2418 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002419 return;
2420 }
2421
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002422 // this is used to hold the file descriptors and when this variable goes out of scope
2423 // the file descriptors are closed
2424 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002425
Nandana Dutt5c390032019-03-12 10:52:56 +00002426 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002427 for (size_t i = 0; i < paths.size(); i++) {
2428 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2429
2430 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2431 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2432 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2433 if (fd < 0) {
2434 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2435 return;
2436 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002437
2438 dumpstate_fds.emplace_back(fd.release());
2439 // we call fd.release() here to make sure "fd" does not get closed
2440 // after "fd" goes out of scope after this block.
2441 // "fd" will be closed when "dumpstate_fds" goes out of scope
2442 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002443 }
2444
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002445 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2446 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2447 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002448 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002449
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002450 if (dumpstate_hal_handle_aidl != nullptr) {
2451 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2452 timeout_sec);
2453 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2454 // run HIDL HAL only if AIDL HAL not found
2455 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2456 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002457 }
2458
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002459 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002460 auto keep_debugfs_mounted =
2461 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2462 if (keep_debugfs_mounted.empty())
2463 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002464 }
2465
Wei Wang587eac92018-04-05 12:17:20 -07002466 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2467 for (size_t i = 0; i < paths.size(); i++) {
2468 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002469 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2470 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002471 file_sizes[i] = -1;
2472 continue;
2473 }
2474 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002475 }
2476
2477 for (size_t i = 0; i < paths.size(); i++) {
2478 if (file_sizes[i] == -1) {
2479 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002480 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002481 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002482 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002483 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002484 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002485 remover[i].Disable();
2486 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2487 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002488 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002489}
2490
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002491static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002492 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002493 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2494 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002495 " -h: display this help message\n"
2496 " -b: play sound file instead of vibrate, at beginning of job\n"
2497 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002498 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002499 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002500 " -s: write zipped file to control socket (for init)\n"
2501 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002502 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002503 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002504 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002505 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002506 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002507 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002508}
2509
Wei Liuf87959e2016-08-26 14:51:42 -07002510static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002511 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002512}
2513
Felipe Leme1d486fe2016-10-14 18:06:47 -07002514bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002515 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2516 if (zip_entry_tasks_) {
2517 zip_entry_tasks_->run(/* do_cancel = */false);
2518 }
2519
Felipe Leme9a523ae2016-10-20 15:10:33 -07002520 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002521 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002522 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002523 // Final timestamp
2524 char date[80];
2525 time_t the_real_now_please_stand_up = time(nullptr);
2526 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002527 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002528 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002529
Felipe Leme9a523ae2016-10-20 15:10:33 -07002530 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002531 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002532 return false;
2533 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002534 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002535 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002536 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002537 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002538
Felipe Leme0f3fb202016-06-10 17:10:53 -07002539 // Add log file (which contains stderr output) to zip...
2540 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002541 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002542 MYLOGE("Failed to add dumpstate log to .zip file\n");
2543 return false;
2544 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002545 // TODO: Should truncate the existing file.
2546 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002547 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2548 return false;
2549 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002550 fprintf(stderr, "\n");
2551
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002552 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002553 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002554 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002555 return false;
2556 }
2557
Felipe Leme1d486fe2016-10-14 18:06:47 -07002558 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2559 ds.zip_file.reset(nullptr);
2560
Felipe Lemee9d2c542016-11-15 11:48:26 -08002561 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002562 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002563
Felipe Leme1e9edc62015-12-21 16:02:13 -08002564 return true;
2565}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002566
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002567static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2568 // clang-format off
2569 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2570 "--receiver-foreground", "--receiver-include-background", "-a", action};
2571 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002572
2573 am.insert(am.end(), args.begin(), args.end());
2574
Felipe Leme8d2410e2017-02-08 09:46:08 -08002575 RunCommand("", am,
2576 CommandOptions::WithTimeout(20)
2577 .Log("Sending broadcast: '%s'\n")
2578 .Always()
2579 .DropRoot()
2580 .RedirectStderr()
2581 .Build());
2582}
2583
Felipe Leme35b8cf12017-02-10 15:47:29 -08002584static void Vibrate(int duration_ms) {
2585 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002586 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2587 "oneshot", std::to_string(duration_ms)};
2588 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002589 CommandOptions::WithTimeout(10)
2590 .Log("Vibrate: '%s'\n")
2591 .Always()
2592 .Build());
2593 // clang-format on
2594}
2595
Nandana Dutt979388e2018-11-30 16:48:55 +00002596static void MaybeResolveSymlink(std::string* path) {
2597 std::string resolved_path;
2598 if (android::base::Readlink(*path, &resolved_path)) {
2599 *path = resolved_path;
2600 }
2601}
2602
Nandana Dutt4be45d12018-09-26 15:04:23 +01002603/*
2604 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002605 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002606 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002607static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002608 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2609
Nandana Dutt4be45d12018-09-26 15:04:23 +01002610 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2611 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002612 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002613 char date[80];
2614 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2615 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002616
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002617 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002618 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002619 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002620 ds.base_name_ += "-wifi";
2621 }
2622
Paul Chang0d2aad72020-02-13 20:04:03 +08002623 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002624 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002625 }
2626 ds.tmp_path_ = ds.GetPath(".tmp");
2627 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2628
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002629 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002630 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002631 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002632 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002633 "Bugreport dir: [%s] "
2634 "Base name: [%s] "
2635 "Suffix: [%s] "
2636 "Log path: [%s] "
2637 "Temporary path: [%s] "
2638 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002639 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2640 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002641
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002642 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2643 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2644 create_parent_dirs(ds.path_.c_str());
2645 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2646 if (ds.zip_file == nullptr) {
2647 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2648 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002649 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002650 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2651 ds.AddTextZipEntry("version.txt", ds.version_);
2652 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002653}
2654
2655/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002656 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002657 * printing zipped file status, etc.
2658 */
2659static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002660 bool do_text_file = !ds.FinishZipFile();
2661 if (do_text_file) {
2662 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002663 }
mhasank2d75c442020-06-11 15:05:25 -07002664
2665 std::string final_path = ds.path_;
2666 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002667 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002668 android::os::CopyFileToFile(ds.path_, final_path);
2669 }
2670
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002671 if (ds.options_->stream_to_socket) {
2672 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2673 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002674 if (do_text_file) {
2675 dprintf(ds.control_socket_fd_,
2676 "FAIL:could not create zip file, check %s "
2677 "for more details\n",
2678 ds.log_path_.c_str());
2679 } else {
mhasank2d75c442020-06-11 15:05:25 -07002680 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002681 }
2682 }
2683}
2684
Nandana Dutt4be45d12018-09-26 15:04:23 +01002685
Nandana Dutt58d72e22018-11-16 10:30:48 +00002686static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2687 switch (mode) {
2688 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2689 return "BUGREPORT_FULL";
2690 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2691 return "BUGREPORT_INTERACTIVE";
2692 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2693 return "BUGREPORT_REMOTE";
2694 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2695 return "BUGREPORT_WEAR";
2696 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2697 return "BUGREPORT_TELEPHONY";
2698 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2699 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002700 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2701 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002702 }
2703}
2704
Paul Changf59c2b72020-03-10 02:08:55 +08002705static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2706 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002707 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2708 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002709 options->bugreport_mode = mode;
2710 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002711 switch (mode) {
2712 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002713 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002714 break;
2715 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002716 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002717 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002718 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002719 break;
2720 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002721 options->do_vibrate = false;
2722 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002723 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002724 break;
2725 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002726 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002727 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002728 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002729 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002730 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002731 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002732 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002733 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002734 break;
2735 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002736 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002737 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002738 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002739 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2740 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002741 }
2742}
2743
Nandana Dutt58d72e22018-11-16 10:30:48 +00002744static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002745 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002746 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002747 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002748 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002749 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002750 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002751 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002752 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002753 options.do_progress_updates, options.bugreport_fd.get(),
2754 options.bugreport_mode_string.c_str(),
2755 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002756}
2757
Nandana Dutt54dbd672019-01-11 12:58:05 +00002758void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2759 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002760 const android::base::unique_fd& screenshot_fd_in,
2761 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002762 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002763 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2764 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002765
Paul Changf59c2b72020-03-10 02:08:55 +08002766 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002767}
2768
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002769Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2770 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002771 int c;
mhasankd451a472020-05-26 18:02:39 -07002772 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002773 switch (c) {
2774 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002775 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002776 case 's': stream_to_socket = true; break;
2777 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002778 case 'v': show_header_only = true; break;
2779 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002780 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002781 case 'P': do_progress_updates = true; break;
2782 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002783 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002784 case 'V':
2785 case 'd':
2786 case 'z':
2787 // compatibility no-op
2788 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002789 case 'w':
2790 // This was already processed
2791 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002792 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002793 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002794 break;
2795 default:
2796 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002797 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002798 break;
2799 // clang-format on
2800 }
2801 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002802
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002803 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002804 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002805 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002806 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002807 }
2808 }
2809
2810 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2811 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002812
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002813 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002814}
2815
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002817 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002818 return false;
2819 }
2820
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002821 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002822 return false;
2823 }
2824
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002825 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002826 return false;
2827 }
2828 return true;
2829}
2830
Nandana Dutt197661d2018-11-16 16:40:21 +00002831void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2832 options_ = std::move(options);
2833}
2834
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002835void Dumpstate::Initialize() {
2836 /* gets the sequential id */
2837 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2838 id_ = ++last_id;
2839 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2840}
2841
Nandana Duttd2f5f082019-01-18 17:13:52 +00002842Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2843 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002844 if (listener_ != nullptr) {
2845 switch (status) {
2846 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002847 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002848 break;
2849 case Dumpstate::RunStatus::HELP:
2850 break;
2851 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002852 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002853 break;
2854 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002855 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2856 break;
2857 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2858 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2859 break;
2860 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2861 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002862 break;
2863 }
2864 }
2865 return status;
2866}
2867
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002868void Dumpstate::Cancel() {
2869 CleanupTmpFiles();
2870 android::os::UnlinkAndLogOnError(log_path_);
2871 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2872 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2873 kDumpstateBoardFiles[i]);
2874 }
2875 tombstone_data_.clear();
2876 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002877
2878 // Instead of shutdown the pool, we delete temporary files directly since
2879 // shutdown blocking the call.
2880 if (dump_pool_) {
2881 dump_pool_->deleteTempFiles();
2882 }
2883 if (zip_entry_tasks_) {
2884 zip_entry_tasks_->run(/*do_cancel =*/ true);
2885 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002886}
2887
Nandana Dutt979388e2018-11-30 16:48:55 +00002888/*
2889 * Dumps relevant information to a bugreport based on the given options.
2890 *
2891 * The bugreport can be dumped to a file or streamed to a socket.
2892 *
2893 * How dumping to file works:
2894 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2895 * stderr is redirected a log file.
2896 *
2897 * The temporary bugreport is then populated via printfs, dumping contents of files and
2898 * output of commands to stdout.
2899 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002900 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002901 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002902 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002903 *
mhasank2d75c442020-06-11 15:05:25 -07002904 * Bugreports are first generated in a local directory and later copied to the caller's fd
2905 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002906 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002907Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2908 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002909 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002910 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002911 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002912 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002913 return RunStatus::INVALID_INPUT;
2914 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002915 /* set as high priority, and protect from OOM killer */
2916 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002917
Felipe Lemed071c682016-10-20 16:48:00 -07002918 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002919 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002920 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002921 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002922 } else {
2923 /* fallback to kernels <= 2.6.35 */
2924 oom_adj = fopen("/proc/self/oom_adj", "we");
2925 if (oom_adj) {
2926 fputs("-17", oom_adj);
2927 fclose(oom_adj);
2928 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002929 }
2930
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002931 if (version_ == VERSION_DEFAULT) {
2932 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002933 }
2934
Chris Morin5a50d482022-02-01 17:41:18 -08002935 if (version_ != VERSION_CURRENT) {
2936 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
2937 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002938 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002939 }
2940
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002941 if (options_->show_header_only) {
2942 PrintHeader();
2943 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002944 }
2945
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002946 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2947 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002948
Felipe Leme7447d7c2016-11-03 18:12:22 -07002949 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002950 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002951 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002952 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002953
Sahana Raof35ed432019-07-12 10:47:52 +01002954 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2955 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2956 } else {
2957 // Wake lock will be released automatically on process death
2958 MYLOGD("Wake lock acquired.\n");
2959 }
2960
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002961 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002962
Felipe Lemef0292972016-11-22 13:57:05 -08002963 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002964 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2965 }
2966
Nandana Dutt235c6672019-11-14 15:22:32 +00002967 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002968 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08002969
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002970 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08002971
Christopher Ferrised9354f2014-10-01 17:35:01 -07002972 // If we are going to use a socket, do it as early as possible
2973 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002974 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07002975 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002976 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00002977 if (control_socket_fd_ == -1) {
2978 return ERROR;
2979 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002980 if (options_->progress_updates_to_socket) {
2981 options_->do_progress_updates = 1;
2982 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07002983 }
2984
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002985 if (!PrepareToWriteToFile()) {
2986 return ERROR;
2987 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002988
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002989 // Interactive, wear & telephony modes are default to true.
2990 // and may enable from cli option or when using control socket
2991 if (options_->do_progress_updates) {
2992 // clang-format off
2993 std::vector<std::string> am_args = {
2994 "--receiver-permission", "android.permission.DUMP",
2995 };
2996 // clang-format on
2997 // Send STARTED broadcast for apps that listen to bugreport generation events
2998 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
2999 if (options_->progress_updates_to_socket) {
3000 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003001 }
3002 }
3003
Nick Kralevichf3599b32016-01-25 15:05:16 -08003004 /* read /proc/cmdline before dropping root */
3005 FILE *cmdline = fopen("/proc/cmdline", "re");
3006 if (cmdline) {
3007 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3008 fclose(cmdline);
3009 }
3010
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003011 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003012 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003013 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003014
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003015 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003016 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3017 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003018 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003019 }
3020 }
3021
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003022 int dup_stdout_fd;
3023 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003024 // Redirect stderr to log_path_ for debugging.
3025 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3026 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3027 return ERROR;
3028 }
3029 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3030 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3031 strerror(errno));
3032 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003033
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003034 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3035 // moved into zip file later, if zipping.
3036 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3037 // TODO: why not write to a file instead of stdout to overcome this problem?
3038 /* TODO: rather than generating a text file now and zipping it later,
3039 it would be more efficient to redirect stdout to the zip entry
3040 directly, but the libziparchive doesn't support that option yet. */
3041 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3042 return ERROR;
3043 }
3044 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3045 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3046 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003047 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003048
3049 // Don't buffer stdout
3050 setvbuf(stdout, nullptr, _IONBF, 0);
3051
Rhed Jao5377d792020-07-16 17:37:39 +08003052 // Enable the parallel run if the client requests to output to a file.
3053 EnableParallelRunIfNeeded();
3054 // Using scope guard to make sure the dump pool can be shut down correctly.
3055 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3056 ShutdownDumpPool();
3057 });
3058
Felipe Leme608385d2016-02-01 10:35:38 -08003059 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3060 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003061 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003062 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003063
Gavin Corkery6968f552020-11-22 18:09:05 +00003064 bool is_dumpstate_restricted = options_->telephony_only
3065 || options_->wifi_only
3066 || options_->limited_only;
3067 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003068 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003069 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003070 }
3071 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003072
3073 if (!is_dumpstate_restricted) {
3074 // Snapshot the system trace now (if running) to avoid that dumpstate's
3075 // own activity pushes out interesting data from the trace ring buffer.
3076 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3077 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003078
3079 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3080 // from WMTRACE_DATA_DIR.
3081 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003082 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003083 onUiIntensiveBugreportDumpsFinished(calling_uid);
3084 MaybeCheckUserConsent(calling_uid, calling_package);
3085 if (options_->telephony_only) {
3086 DumpstateTelephonyOnly(calling_package);
3087 } else if (options_->wifi_only) {
3088 DumpstateWifiOnly();
3089 } else if (options_->limited_only) {
3090 DumpstateLimitedOnly();
3091 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003092 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003093 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003094 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003095 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003096 HandleUserConsentDenied();
3097 }
3098 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003099 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003100 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003101
Felipe Leme55b42a62015-11-10 17:39:08 -08003102 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003103 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003104
Abhijeet Kaure370d682019-10-01 16:49:30 +01003105 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003106 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003107 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003108 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003109
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003110 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003111 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003112 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003113 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003114 if (status != Dumpstate::RunStatus::OK &&
3115 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3116 // Do an early return if there were errors. We make an exception for consent
3117 // timing out because it's possible the user got distracted. In this case the
3118 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003119 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003120 return status;
3121 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003122 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3123 MYLOGI(
3124 "Did not receive user consent yet."
3125 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003126 const String16 incidentcompanion("incidentcompanion");
3127 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3128 if (ics != nullptr) {
3129 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3130 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3131 consent_callback_.get());
3132 } else {
3133 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3134 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003135 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003136 }
3137
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003138 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003139 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003140 for (int i = 0; i < 3; i++) {
3141 Vibrate(75);
3142 usleep((75 + 50) * 1000);
3143 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003144 }
3145
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003146 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3147 progress_->GetInitialMax());
3148 progress_->Save();
3149 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003150
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003151 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003152
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003153 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003154 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003155 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003156 }
3157
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003158 tombstone_data_.clear();
3159 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003160
Nandana Duttd2f5f082019-01-18 17:13:52 +00003161 return (consent_callback_ != nullptr &&
3162 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3163 ? USER_CONSENT_TIMED_OUT
3164 : RunStatus::OK;
3165}
3166
Paul Chang0d2aad72020-02-13 20:04:03 +08003167void Dumpstate::MaybeTakeEarlyScreenshot() {
3168 if (!options_->do_screenshot || !do_early_screenshot_) {
3169 return;
3170 }
3171
3172 TakeScreenshot();
3173}
3174
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003175void Dumpstate::MaybeSnapshotSystemTrace() {
3176 // If a background system trace is happening and is marked as "suitable for
3177 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3178 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3179 // case that no trace is ongoing, this command is a no-op.
3180 // Note: this should not be enqueued as we need to freeze the trace before
3181 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3182 // the dumpstate's own activity which is irrelevant.
3183 int res = RunCommand(
3184 "SERIALIZE PERFETTO TRACE",
3185 {"perfetto", "--save-for-bugreport"},
3186 CommandOptions::WithTimeout(10)
3187 .DropRoot()
3188 .CloseAllFileDescriptorsOnExec()
3189 .Build());
3190 has_system_trace_ = res == 0;
3191 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3192 // file in the later stages.
3193}
3194
Yohei Yukawa95305b32021-03-09 07:54:27 -08003195void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003196 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3197 for (const auto& service : {"window", "input_method"}) {
3198 RunCommand(
3199 // Empty name because it's not intended to be classified as a bugreport section.
3200 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3201 "", {"cmd", service, "tracing", "save-for-bugreport"},
3202 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3203 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003204}
3205
Paul Changeb4b4642020-05-28 22:05:47 +08003206void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003207 if (calling_uid == AID_SHELL || !CalledByApi()) {
3208 return;
3209 }
3210 if (listener_ != nullptr) {
3211 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3212 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003213 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003214 }
3215}
3216
Jichao Lie89d9c12019-11-21 19:02:51 -08003217void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3218 if (calling_uid == AID_SHELL || !CalledByApi()) {
3219 // No need to get consent for shell triggered dumpstates, or not through
3220 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003221 return;
3222 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003223 consent_callback_ = new ConsentCallback();
3224 const String16 incidentcompanion("incidentcompanion");
3225 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003226 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003227 if (ics != nullptr) {
3228 MYLOGD("Checking user consent via incidentcompanion service\n");
3229 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003230 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003231 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003232 } else {
3233 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3234 }
3235}
3236
Nandana Dutt5c390032019-03-12 10:52:56 +00003237bool Dumpstate::IsUserConsentDenied() const {
3238 return ds.consent_callback_ != nullptr &&
3239 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3240}
3241
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003242bool Dumpstate::CalledByApi() const {
3243 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3244}
3245
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003246void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003247 android::os::UnlinkAndLogOnError(tmp_path_);
3248 android::os::UnlinkAndLogOnError(screenshot_path_);
3249 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003250 if (dump_traces_path != nullptr) {
3251 android::os::UnlinkAndLogOnError(dump_traces_path);
3252 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003253}
3254
Rhed Jao5377d792020-07-16 17:37:39 +08003255void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003256 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003257 return;
3258 }
3259 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003260 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003261}
3262
3263void Dumpstate::ShutdownDumpPool() {
3264 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003265 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003266 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003267 if (zip_entry_tasks_) {
3268 zip_entry_tasks_->run(/* do_cancel = */true);
3269 zip_entry_tasks_ = nullptr;
3270 }
3271}
3272
3273void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3274 const std::string& entry_path) {
3275 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3276 if (!task_cancelled) {
3277 AddZipEntry(entry_name, entry_path);
3278 }
3279 android::os::UnlinkAndLogOnError(entry_path);
3280 };
3281 if (zip_entry_tasks_) {
3282 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3283 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3284 } else {
3285 // Invokes AddZipEntryAndCleanup immediately
3286 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3287 }
Rhed Jao5377d792020-07-16 17:37:39 +08003288}
3289
Nandana Duttd2f5f082019-01-18 17:13:52 +00003290Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3291 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003292 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003293 return USER_CONSENT_DENIED;
3294}
3295
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003296Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003297 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003298 // user consent (unless the caller is Shell).
3299 UserConsentResult consent_result;
3300 if (calling_uid == AID_SHELL) {
3301 consent_result = UserConsentResult::APPROVED;
3302 } else {
3303 consent_result = consent_callback_->getResult();
3304 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003305 if (consent_result == UserConsentResult::UNAVAILABLE) {
3306 // User has not responded yet.
3307 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003308 // Telephony is a fast report type, particularly on user builds where information may be
3309 // more aggressively limited. To give the user time to read the consent dialog, increase the
3310 // timeout.
3311 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3312 : USER_CONSENT_TIMEOUT_MS;
3313 if (elapsed_ms < timeout_ms) {
3314 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003315 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3316 sleep(delay_seconds);
3317 }
3318 consent_result = consent_callback_->getResult();
3319 }
3320 if (consent_result == UserConsentResult::DENIED) {
3321 // User has explicitly denied sharing with the app. To be safe delete the
3322 // internal bugreport & tmp files.
3323 return HandleUserConsentDenied();
3324 }
3325 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003326 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3327 if (copy_succeeded) {
3328 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003329 if (options_->do_screenshot &&
3330 options_->screenshot_fd.get() != -1 &&
3331 !options_->is_screenshot_copied) {
3332 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3333 options_->screenshot_fd.get());
3334 options_->is_screenshot_copied = copy_succeeded;
3335 if (copy_succeeded) {
3336 android::os::UnlinkAndLogOnError(screenshot_path_);
3337 }
3338 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003339 }
3340 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3341 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3342 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3343 // Since we do not have user consent to share the bugreport it does not get
3344 // copied over to the calling app but remains in the internal directory from
3345 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003346 std::string final_path = GetPath(".zip");
3347 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3348 if (copy_succeeded) {
3349 android::os::UnlinkAndLogOnError(path_);
3350 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003351 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3352 }
3353 // Unknown result; must be a programming error.
3354 MYLOGE("Unknown user consent result:%d\n", consent_result);
3355 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003356}
3357
Nandana Duttf02564e2019-02-15 15:24:24 +00003358Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003359 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3360 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3361 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003362 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003363 // When directly running dumpstate binary, the output is not expected to be written
3364 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003365 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003366
3367 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003368 // an app; they are irrelevant here because bugreport is triggered via command line.
3369 // Update Last ID before calling Run().
3370 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003371 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003372 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003373 return status;
3374}
3375
3376/* Main entry point for dumpstate binary. */
3377int run_main(int argc, char* argv[]) {
3378 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003379
3380 switch (status) {
3381 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003382 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003383 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003384 ShowUsage();
3385 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003386 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003387 fprintf(stderr, "Invalid combination of args\n");
3388 ShowUsage();
3389 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003390 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003391 FALLTHROUGH_INTENDED;
3392 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3393 FALLTHROUGH_INTENDED;
3394 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003395 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003396 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003397}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003398
3399// TODO(111441001): Default DumpOptions to sensible values.
3400Dumpstate::Dumpstate(const std::string& version)
3401 : pid_(getpid()),
3402 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003403 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003404 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003405 now_(time(nullptr)),
3406 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003407}
3408
3409Dumpstate& Dumpstate::GetInstance() {
3410 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3411 return singleton_;
3412}
3413
Rhed Jao5377d792020-07-16 17:37:39 +08003414DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3415 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3416 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003417 if (!title_.empty()) {
3418 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003419 if (title_.find("SHOW MAP") == std::string::npos) {
3420 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3421 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003422 }
3423}
3424
3425DurationReporter::~DurationReporter() {
3426 if (!title_.empty()) {
3427 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003428 if (elapsed >= .5f || verbose_) {
3429 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003430 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003431 if (!logcat_only_) {
3432 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003433 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3434 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003435 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003436 if (title_.find("SHOW MAP") == std::string::npos) {
3437 ATRACE_ASYNC_END(title_.c_str(), 0);
3438 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003439 }
3440}
3441
3442const int32_t Progress::kDefaultMax = 5000;
3443
3444Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3445}
3446
3447Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3448 : Progress(initial_max, growth_factor, "") {
3449 progress_ = progress;
3450}
3451
3452Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3453 : initial_max_(initial_max),
3454 progress_(0),
3455 max_(initial_max),
3456 growth_factor_(growth_factor),
3457 n_runs_(0),
3458 average_max_(0),
3459 path_(path) {
3460 if (!path_.empty()) {
3461 Load();
3462 }
3463}
3464
3465void Progress::Load() {
3466 MYLOGD("Loading stats from %s\n", path_.c_str());
3467 std::string content;
3468 if (!android::base::ReadFileToString(path_, &content)) {
3469 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3470 return;
3471 }
3472 if (content.empty()) {
3473 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3474 return;
3475 }
3476 std::vector<std::string> lines = android::base::Split(content, "\n");
3477
3478 if (lines.size() < 1) {
3479 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3480 (int)lines.size(), max_);
3481 return;
3482 }
3483 char* ptr;
3484 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3485 average_max_ = strtol(ptr, nullptr, 10);
3486 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3487 average_max_ > STATS_MAX_AVERAGE) {
3488 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3489 initial_max_ = Progress::kDefaultMax;
3490 } else {
3491 initial_max_ = average_max_;
3492 }
3493 max_ = initial_max_;
3494
3495 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3496}
3497
3498void Progress::Save() {
3499 int32_t total = n_runs_ * average_max_ + progress_;
3500 int32_t runs = n_runs_ + 1;
3501 int32_t average = floor(((float)total) / runs);
3502 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3503 path_.c_str());
3504 if (path_.empty()) {
3505 return;
3506 }
3507
3508 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3509 if (!android::base::WriteStringToFile(content, path_)) {
3510 MYLOGE("Could not save stats on %s\n", path_.c_str());
3511 }
3512}
3513
3514int32_t Progress::Get() const {
3515 return progress_;
3516}
3517
3518bool Progress::Inc(int32_t delta_sec) {
3519 bool changed = false;
3520 if (delta_sec >= 0) {
3521 progress_ += delta_sec;
3522 if (progress_ > max_) {
3523 int32_t old_max = max_;
3524 max_ = floor((float)progress_ * growth_factor_);
3525 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3526 changed = true;
3527 }
3528 }
3529 return changed;
3530}
3531
3532int32_t Progress::GetMax() const {
3533 return max_;
3534}
3535
3536int32_t Progress::GetInitialMax() const {
3537 return initial_max_;
3538}
3539
3540void Progress::Dump(int fd, const std::string& prefix) const {
3541 const char* pr = prefix.c_str();
3542 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3543 dprintf(fd, "%smax: %d\n", pr, max_);
3544 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3545 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3546 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3547 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3548 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3549}
3550
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003551std::string Dumpstate::GetPath(const std::string& suffix) const {
3552 return GetPath(bugreport_internal_dir_, suffix);
3553}
3554
3555std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3556 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3557 name_.c_str(), suffix.c_str());
3558}
3559
3560void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3561 progress_ = std::move(progress);
3562}
3563
3564void for_each_userid(void (*func)(int), const char *header) {
3565 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3566 "for_each_userid(%s)", header);
3567 DurationReporter duration_reporter(title);
3568 if (PropertiesHelper::IsDryRun()) return;
3569
3570 DIR *d;
3571 struct dirent *de;
3572
3573 if (header) printf("\n------ %s ------\n", header);
3574 func(0);
3575
3576 if (!(d = opendir("/data/system/users"))) {
3577 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3578 return;
3579 }
3580
3581 while ((de = readdir(d))) {
3582 int userid;
3583 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3584 continue;
3585 }
3586 func(userid);
3587 }
3588
3589 closedir(d);
3590}
3591
3592static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3593 DIR *d;
3594 struct dirent *de;
3595
3596 if (!(d = opendir("/proc"))) {
3597 printf("Failed to open /proc (%s)\n", strerror(errno));
3598 return;
3599 }
3600
3601 if (header) printf("\n------ %s ------\n", header);
3602 while ((de = readdir(d))) {
3603 if (ds.IsUserConsentDenied()) {
3604 MYLOGE(
3605 "Returning early because user denied consent to share bugreport with calling app.");
3606 closedir(d);
3607 return;
3608 }
3609 int pid;
3610 int fd;
3611 char cmdpath[255];
3612 char cmdline[255];
3613
3614 if (!(pid = atoi(de->d_name))) {
3615 continue;
3616 }
3617
3618 memset(cmdline, 0, sizeof(cmdline));
3619
3620 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3621 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3622 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3623 close(fd);
3624 if (cmdline[0]) {
3625 helper(pid, cmdline, arg);
3626 continue;
3627 }
3628 }
3629
3630 // if no cmdline, a kernel thread has comm
3631 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3632 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3633 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3634 close(fd);
3635 if (cmdline[1]) {
3636 cmdline[0] = '[';
3637 size_t len = strcspn(cmdline, "\f\b\r\n");
3638 cmdline[len] = ']';
3639 cmdline[len+1] = '\0';
3640 }
3641 }
3642 if (!cmdline[0]) {
3643 strcpy(cmdline, "N/A");
3644 }
3645 helper(pid, cmdline, arg);
3646 }
3647
3648 closedir(d);
3649}
3650
3651static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3652 for_each_pid_func *func = (for_each_pid_func*) arg;
3653 func(pid, cmdline);
3654}
3655
3656void for_each_pid(for_each_pid_func func, const char *header) {
3657 std::string title = header == nullptr ? "for_each_pid"
3658 : android::base::StringPrintf("for_each_pid(%s)", header);
3659 DurationReporter duration_reporter(title);
3660 if (PropertiesHelper::IsDryRun()) return;
3661
3662 __for_each_pid(for_each_pid_helper, header, (void *) func);
3663}
3664
3665static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3666 DIR *d;
3667 struct dirent *de;
3668 char taskpath[255];
3669 for_each_tid_func *func = (for_each_tid_func *) arg;
3670
3671 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3672
3673 if (!(d = opendir(taskpath))) {
3674 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3675 return;
3676 }
3677
3678 func(pid, pid, cmdline);
3679
3680 while ((de = readdir(d))) {
3681 if (ds.IsUserConsentDenied()) {
3682 MYLOGE(
3683 "Returning early because user denied consent to share bugreport with calling app.");
3684 closedir(d);
3685 return;
3686 }
3687 int tid;
3688 int fd;
3689 char commpath[255];
3690 char comm[255];
3691
3692 if (!(tid = atoi(de->d_name))) {
3693 continue;
3694 }
3695
3696 if (tid == pid)
3697 continue;
3698
3699 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3700 memset(comm, 0, sizeof(comm));
3701 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3702 strcpy(comm, "N/A");
3703 } else {
3704 char *c;
3705 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3706 close(fd);
3707
3708 c = strrchr(comm, '\n');
3709 if (c) {
3710 *c = '\0';
3711 }
3712 }
3713 func(pid, tid, comm);
3714 }
3715
3716 closedir(d);
3717}
3718
3719void for_each_tid(for_each_tid_func func, const char *header) {
3720 std::string title = header == nullptr ? "for_each_tid"
3721 : android::base::StringPrintf("for_each_tid(%s)", header);
3722 DurationReporter duration_reporter(title);
3723
3724 if (PropertiesHelper::IsDryRun()) return;
3725
3726 __for_each_pid(for_each_tid_helper, header, (void *) func);
3727}
3728
3729void show_wchan(int pid, int tid, const char *name) {
3730 if (PropertiesHelper::IsDryRun()) return;
3731
3732 char path[255];
3733 char buffer[255];
3734 int fd, ret, save_errno;
3735 char name_buffer[255];
3736
3737 memset(buffer, 0, sizeof(buffer));
3738
3739 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3740 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3741 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3742 return;
3743 }
3744
3745 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3746 save_errno = errno;
3747 close(fd);
3748
3749 if (ret < 0) {
3750 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3751 return;
3752 }
3753
3754 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3755 pid == tid ? 0 : 3, "", name);
3756
3757 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3758
3759 return;
3760}
3761
3762// print time in centiseconds
3763static void snprcent(char *buffer, size_t len, size_t spc,
3764 unsigned long long time) {
3765 static long hz; // cache discovered hz
3766
3767 if (hz <= 0) {
3768 hz = sysconf(_SC_CLK_TCK);
3769 if (hz <= 0) {
3770 hz = 1000;
3771 }
3772 }
3773
3774 // convert to centiseconds
3775 time = (time * 100 + (hz / 2)) / hz;
3776
3777 char str[16];
3778
3779 snprintf(str, sizeof(str), " %llu.%02u",
3780 time / 100, (unsigned)(time % 100));
3781 size_t offset = strlen(buffer);
3782 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3783 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3784}
3785
3786// print permille as a percent
3787static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3788 char str[16];
3789
3790 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3791 size_t offset = strlen(buffer);
3792 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3793 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3794}
3795
3796void show_showtime(int pid, const char *name) {
3797 if (PropertiesHelper::IsDryRun()) return;
3798
3799 char path[255];
3800 char buffer[1023];
3801 int fd, ret, save_errno;
3802
3803 memset(buffer, 0, sizeof(buffer));
3804
3805 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3806 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3807 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3808 return;
3809 }
3810
3811 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3812 save_errno = errno;
3813 close(fd);
3814
3815 if (ret < 0) {
3816 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3817 return;
3818 }
3819
3820 // field 14 is utime
3821 // field 15 is stime
3822 // field 42 is iotime
3823 unsigned long long utime = 0, stime = 0, iotime = 0;
3824 if (sscanf(buffer,
3825 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3826 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3827 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3828 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3829 &utime, &stime, &iotime) != 3) {
3830 return;
3831 }
3832
3833 unsigned long long total = utime + stime;
3834 if (!total) {
3835 return;
3836 }
3837
3838 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3839 if (permille > 1000) {
3840 permille = 1000;
3841 }
3842
3843 // try to beautify and stabilize columns at <80 characters
3844 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3845 if ((name[0] != '[') || utime) {
3846 snprcent(buffer, sizeof(buffer), 57, utime);
3847 }
3848 snprcent(buffer, sizeof(buffer), 65, stime);
3849 if ((name[0] != '[') || iotime) {
3850 snprcent(buffer, sizeof(buffer), 73, iotime);
3851 }
3852 if (iotime) {
3853 snprdec(buffer, sizeof(buffer), 79, permille);
3854 }
3855 puts(buffer); // adds a trailing newline
3856
3857 return;
3858}
3859
3860void do_dmesg() {
3861 const char *title = "KERNEL LOG (dmesg)";
3862 DurationReporter duration_reporter(title);
3863 printf("------ %s ------\n", title);
3864
3865 if (PropertiesHelper::IsDryRun()) return;
3866
3867 /* Get size of kernel buffer */
3868 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3869 if (size <= 0) {
3870 printf("Unexpected klogctl return value: %d\n\n", size);
3871 return;
3872 }
3873 char *buf = (char *) malloc(size + 1);
3874 if (buf == nullptr) {
3875 printf("memory allocation failed\n\n");
3876 return;
3877 }
3878 int retval = klogctl(KLOG_READ_ALL, buf, size);
3879 if (retval < 0) {
3880 printf("klogctl failure\n\n");
3881 free(buf);
3882 return;
3883 }
3884 buf[retval] = '\0';
3885 printf("%s\n\n", buf);
3886 free(buf);
3887 return;
3888}
3889
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003890int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3891 DurationReporter duration_reporter(title);
3892
3893 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3894
3895 UpdateProgress(WEIGHT_FILE);
3896
3897 return status;
3898}
3899
3900int read_file_as_long(const char *path, long int *output) {
3901 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3902 if (fd < 0) {
3903 int err = errno;
3904 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3905 return -1;
3906 }
3907 char buffer[50];
3908 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3909 if (bytes_read == -1) {
3910 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3911 return -2;
3912 }
3913 if (bytes_read == 0) {
3914 MYLOGE("File %s is empty\n", path);
3915 return -3;
3916 }
3917 *output = atoi(buffer);
3918 return 0;
3919}
3920
3921/* calls skip to gate calling dump_from_fd recursively
3922 * in the specified directory. dump_from_fd defaults to
3923 * dump_file_from_fd above when set to NULL. skip defaults
3924 * to false when set to NULL. dump_from_fd will always be
3925 * called with title NULL.
3926 */
3927int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3928 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3929 DurationReporter duration_reporter(title);
3930 DIR *dirp;
3931 struct dirent *d;
3932 char *newpath = nullptr;
3933 const char *slash = "/";
3934 int retval = 0;
3935
3936 if (!title.empty()) {
3937 printf("------ %s (%s) ------\n", title.c_str(), dir);
3938 }
3939 if (PropertiesHelper::IsDryRun()) return 0;
3940
3941 if (dir[strlen(dir) - 1] == '/') {
3942 ++slash;
3943 }
3944 dirp = opendir(dir);
3945 if (dirp == nullptr) {
3946 retval = -errno;
3947 MYLOGE("%s: %s\n", dir, strerror(errno));
3948 return retval;
3949 }
3950
3951 if (!dump_from_fd) {
3952 dump_from_fd = dump_file_from_fd;
3953 }
3954 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3955 if ((d->d_name[0] == '.')
3956 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3957 || (d->d_name[1] == '\0'))) {
3958 continue;
3959 }
3960 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3961 (d->d_type == DT_DIR) ? "/" : "");
3962 if (!newpath) {
3963 retval = -errno;
3964 continue;
3965 }
3966 if (skip && (*skip)(newpath)) {
3967 continue;
3968 }
3969 if (d->d_type == DT_DIR) {
3970 int ret = dump_files("", newpath, skip, dump_from_fd);
3971 if (ret < 0) {
3972 retval = ret;
3973 }
3974 continue;
3975 }
3976 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
3977 if (fd.get() < 0) {
3978 retval = -1;
3979 printf("*** %s: %s\n", newpath, strerror(errno));
3980 continue;
3981 }
3982 (*dump_from_fd)(nullptr, newpath, fd.get());
3983 }
3984 closedir(dirp);
3985 if (!title.empty()) {
3986 printf("\n");
3987 }
3988 return retval;
3989}
3990
3991/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
3992 * it's possible to avoid issues where opening the file itself can get
3993 * stuck.
3994 */
3995int dump_file_from_fd(const char *title, const char *path, int fd) {
3996 if (PropertiesHelper::IsDryRun()) return 0;
3997
3998 int flags = fcntl(fd, F_GETFL);
3999 if (flags == -1) {
4000 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4001 return -1;
4002 } else if (!(flags & O_NONBLOCK)) {
4003 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4004 return -1;
4005 }
4006 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4007}
4008
4009int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004010 const CommandOptions& options, bool verbose_duration, int out_fd) {
4011 DurationReporter duration_reporter(title, false /* logcat_only */,
4012 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004013
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004014 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004015
4016 /* TODO: for now we're simplifying the progress calculation by using the
4017 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4018 * where its weight should be much higher proportionally to its timeout.
4019 * Ideally, it should use a options.EstimatedDuration() instead...*/
4020 UpdateProgress(options.Timeout());
4021
4022 return status;
4023}
4024
4025void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004026 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004027 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4028 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4029 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004030 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004031}
4032
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004033static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004034 int s = android_get_control_socket(service);
4035 if (s < 0) {
4036 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4037 return -1;
4038 }
4039 fcntl(s, F_SETFD, FD_CLOEXEC);
4040
4041 // Set backlog to 0 to make sure that queue size will be minimum.
4042 // In Linux, because the minimum queue will be 1, connect() will be blocked
4043 // if the other clients already called connect() and the connection request was not accepted.
4044 if (listen(s, 0) < 0) {
4045 MYLOGE("listen(control socket): %s\n", strerror(errno));
4046 return -1;
4047 }
4048
4049 struct sockaddr addr;
4050 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004051 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004052
4053 // Close socket just after accept(), to make sure that connect() by client will get error
4054 // when the socket is used by the other services.
4055 // There is still a race condition possibility between accept and close, but there is no way
4056 // to close-on-accept atomically.
4057 // See detail; b/123306389#comment25
4058 close(s);
4059
4060 if (fd < 0) {
4061 MYLOGE("accept(control socket): %s\n", strerror(errno));
4062 return -1;
4063 }
4064
4065 return fd;
4066}
4067
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004068// TODO: should call is_valid_output_file and/or be merged into it.
4069void create_parent_dirs(const char *path) {
4070 char *chp = const_cast<char *> (path);
4071
4072 /* skip initial slash */
4073 if (chp[0] == '/')
4074 chp++;
4075
4076 /* create leading directories, if necessary */
4077 struct stat dir_stat;
4078 while (chp && chp[0]) {
4079 chp = strchr(chp, '/');
4080 if (chp) {
4081 *chp = 0;
4082 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4083 MYLOGI("Creating directory %s\n", path);
4084 if (mkdir(path, 0770)) { /* drwxrwx--- */
4085 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4086 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4087 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4088 }
4089 }
4090 *chp++ = '/';
4091 }
4092 }
4093}
4094
4095bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4096 create_parent_dirs(path);
4097
4098 int fd = TEMP_FAILURE_RETRY(open(path,
4099 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4100 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4101 if (fd < 0) {
4102 MYLOGE("%s: %s\n", path, strerror(errno));
4103 return false;
4104 }
4105
4106 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4107 close(fd);
4108 return true;
4109}
4110
4111bool redirect_to_file(FILE* redirect, char* path) {
4112 return _redirect_to_file(redirect, path, O_TRUNC);
4113}
4114
4115bool redirect_to_existing_file(FILE* redirect, char* path) {
4116 return _redirect_to_file(redirect, path, O_APPEND);
4117}
4118
4119void dump_route_tables() {
4120 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4121 if (PropertiesHelper::IsDryRun()) return;
4122 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4123 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4124 FILE* fp = fopen(RT_TABLES_PATH, "re");
4125 if (!fp) {
4126 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4127 return;
4128 }
4129 char table[16];
4130 // Each line has an integer (the table number), a space, and a string (the table name). We only
4131 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4132 // Add a fixed max limit so this doesn't go awry.
4133 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4134 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4135 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4136 }
4137 fclose(fp);
4138}
4139
Li Li830179f2022-01-04 12:53:29 -08004140void dump_frozen_cgroupfs(const char *dir, int level,
4141 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4142 DIR *dirp;
4143 struct dirent *d;
4144 char *newpath = nullptr;
4145
4146 dirp = opendir(dir);
4147 if (dirp == nullptr) {
4148 MYLOGE("%s: %s\n", dir, strerror(errno));
4149 return;
4150 }
4151
4152 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4153 if ((d->d_name[0] == '.')
4154 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4155 || (d->d_name[1] == '\0'))) {
4156 continue;
4157 }
4158 if (d->d_type == DT_DIR) {
4159 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4160 if (!newpath) {
4161 continue;
4162 }
4163 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4164 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4165 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4166 char *freezer = nullptr;
4167 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4168 if (freezer) {
4169 FILE* fp = fopen(freezer, "r");
4170 if (fp != NULL) {
4171 int frozen;
4172 fscanf(fp, "%d", &frozen);
4173 if (frozen > 0) {
4174 dump_files("", newpath, skip_none, dump_from_fd);
4175 }
4176 fclose(fp);
4177 }
4178 free(freezer);
4179 }
4180 }
4181 }
4182 }
4183 closedir(dirp);
4184}
4185
4186void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004187 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4188 DurationReporter duration_reporter("FROZEN CGROUPFS");
4189 if (PropertiesHelper::IsDryRun()) return;
4190 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4191}
4192
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004193void Dumpstate::UpdateProgress(int32_t delta_sec) {
4194 if (progress_ == nullptr) {
4195 MYLOGE("UpdateProgress: progress_ not set\n");
4196 return;
4197 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004198 // This function updates progress related members of the dumpstate and reports
4199 // progress percentage to the bugreport client. Since it could be called by
4200 // different dump tasks at the same time if the parallel run is enabled, a
4201 // mutex lock is necessary here to synchronize the call.
4202 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004203
4204 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004205 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004206
4207 // ...but only notifiy listeners when necessary.
4208 if (!options_->do_progress_updates) return;
4209
4210 int progress = progress_->Get();
4211 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004212 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004213
Nandana Dutt402a8392019-06-14 14:25:13 +01004214 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004215 return;
4216 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004217 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004218
4219 if (control_socket_fd_ >= 0) {
4220 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4221 fsync(control_socket_fd_);
4222 }
4223
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004224 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004225 if (percent % 10 == 0) {
4226 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004227 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004228 } else {
4229 // stderr is ignored on normal invocations, but useful when calling
4230 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004231 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004232 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004233
4234 listener_->onProgress(percent);
4235 }
4236}
4237
4238void Dumpstate::TakeScreenshot(const std::string& path) {
4239 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4240 int status =
4241 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4242 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4243 if (status == 0) {
4244 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4245 } else {
4246 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4247 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004248 if (listener_ != nullptr) {
4249 // Show a visual indication to indicate screenshot is taken via
4250 // IDumpstateListener.onScreenshotTaken()
4251 listener_->onScreenshotTaken(status == 0);
4252 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004253}
4254
4255bool is_dir(const char* pathname) {
4256 struct stat info;
4257 if (stat(pathname, &info) == -1) {
4258 return false;
4259 }
4260 return S_ISDIR(info.st_mode);
4261}
4262
4263time_t get_mtime(int fd, time_t default_mtime) {
4264 struct stat info;
4265 if (fstat(fd, &info) == -1) {
4266 return default_mtime;
4267 }
4268 return info.st_mtime;
4269}