blob: 60c207775a230035c7dbe9a86c22439cc9995065 [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";
Aaron Huang24d215d2022-04-27 18:51:16 +0800237static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800238static const std::string DUMP_HALS_TASK = "DUMP HALS";
239static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800240static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800241
Nandana Dutt979388e2018-11-30 16:48:55 +0000242namespace android {
243namespace os {
244namespace {
245
246static int Open(std::string path, int flags, mode_t mode = 0) {
247 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
248 if (fd == -1) {
249 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
250 }
251 return fd;
252}
253
mhasank2d75c442020-06-11 15:05:25 -0700254static int OpenForWrite(std::string path) {
255 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
256 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
257}
Nandana Dutt979388e2018-11-30 16:48:55 +0000258
259static int OpenForRead(std::string path) {
260 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
261}
262
263bool CopyFile(int in_fd, int out_fd) {
264 char buf[4096];
265 ssize_t byte_count;
266 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
267 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
268 return false;
269 }
270 }
271 return (byte_count != -1);
272}
273
274static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000275 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000276
277 // Obtain a handle to the source file.
278 android::base::unique_fd in_fd(OpenForRead(input_file));
279 if (out_fd != -1 && in_fd.get() != -1) {
280 if (CopyFile(in_fd.get(), out_fd)) {
281 return true;
282 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000283 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000284 }
285 return false;
286}
287
Nandana Duttd2f5f082019-01-18 17:13:52 +0000288static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000289 if (file.empty()) {
290 return false;
291 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000292 if (unlink(file.c_str())) {
293 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000294 return false;
295 }
296 return true;
297}
Nandana Dutt979388e2018-11-30 16:48:55 +0000298
Nikita Ioffea325a572019-05-16 19:49:47 +0100299int64_t GetModuleMetadataVersion() {
300 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
301 if (binder == nullptr) {
302 MYLOGE("Failed to retrieve package_native service");
303 return 0L;
304 }
305 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
306 std::string package_name;
307 auto status = package_service->getModuleMetadataPackageName(&package_name);
308 if (!status.isOk()) {
309 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
310 return 0L;
311 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100312 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100313 int64_t version_code;
314 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
315 &version_code);
316 if (!status.isOk()) {
317 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
318 return 0L;
319 }
320 return version_code;
321}
322
mhasank2d75c442020-06-11 15:05:25 -0700323static bool PathExists(const std::string& path) {
324 struct stat sb;
325 return stat(path.c_str(), &sb) == 0;
326}
327
328static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
329 if (input_file == output_file) {
330 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
331 output_file.c_str());
332 return false;
333 }
334 else if (PathExists(output_file)) {
335 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
336 return false;
337 }
338
339 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
340 android::base::unique_fd out_fd(OpenForWrite(output_file));
341 return CopyFileToFd(input_file, out_fd.get());
342}
343
Nandana Dutt979388e2018-11-30 16:48:55 +0000344} // namespace
345} // namespace os
346} // namespace android
347
Felipe Leme678727a2016-09-21 17:22:11 -0700348static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800349 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800350 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
351 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
352}
353static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
354 int out_fd) {
355 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700356}
357static int DumpFile(const std::string& title, const std::string& path) {
358 return ds.DumpFile(title, path);
359}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800360
Felipe Lemee844a9d2016-09-21 15:01:39 -0700361// Relative directory (inside the zip) for all files copied as-is into the bugreport.
362static const std::string ZIP_ROOT_DIR = "FS";
363
Vishnu Naire97d6122018-01-18 13:58:56 -0800364static const std::string kProtoPath = "proto/";
365static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700366static const std::string kDumpstateBoardFiles[] = {
367 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700368 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700369};
370static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
371
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700372static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700373static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700374
Felipe Lemef0292972016-11-22 13:57:05 -0800375static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
376
Narayan Kamath8f788292017-05-25 13:20:39 +0100377/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100378 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800379 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800380 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100381 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700382static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800383 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100384 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100385
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700386 if (dump_dir == nullptr) {
387 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700388 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700389 }
390
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700391 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100392 struct dirent* entry = nullptr;
393 while ((entry = readdir(dump_dir.get()))) {
394 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100395 continue;
396 }
397
Narayan Kamathbd863722017-06-01 18:50:12 +0100398 const std::string base_name(entry->d_name);
399 if (base_name.find(file_prefix) != 0) {
400 continue;
401 }
402
403 const std::string abs_path = dir_path + base_name;
404 android::base::unique_fd fd(
405 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
406 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700407 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100408 break;
409 }
410
411 struct stat st = {};
412 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700413 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100414 continue;
415 }
416
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700417 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700418 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800419 if (!dump_data.empty()) {
420 std::sort(dump_data.begin(), dump_data.end(),
421 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
422 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100423
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700424 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100425}
426
Narayan Kamathbd863722017-06-01 18:50:12 +0100427static bool AddDumps(const std::vector<DumpData>::const_iterator start,
428 const std::vector<DumpData>::const_iterator end,
429 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100430 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100431 for (auto it = start; it != end; ++it) {
432 const std::string& name = it->name;
433 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100435
436 // Seek to the beginning of the file before dumping any data. A given
437 // DumpData entry might be dumped multiple times in the report.
438 //
439 // For example, the most recent ANR entry is dumped to the body of the
440 // main entry and it also shows up as a separate entry in the bugreport
441 // ZIP file.
442 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
443 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
444 strerror(errno));
445 }
446
Chris Morinc2cba7a2022-02-01 17:06:50 -0800447 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800448 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100449 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100450 }
451 } else {
452 dump_file_from_fd(type_name, name.c_str(), fd);
453 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455
456 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700457}
458
Felipe Leme635ca312016-01-05 14:23:02 -0800459// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700460void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800461 char path[PATH_MAX];
462
463 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
464 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700465 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800466 char linkname[PATH_MAX];
467 ssize_t r = readlink(path, linkname, PATH_MAX);
468 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800469 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800470 return;
471 }
472 linkname[r] = '\0';
473
474 if (mount_points.find(linkname) == mount_points.end()) {
475 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700476 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700477 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800478 mount_points.insert(linkname);
479 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800480 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800481 }
482 }
483}
484
485void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700486 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800487 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800488 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700489 for_each_pid(do_mountinfo, nullptr);
490 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800491}
492
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700493static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
494{
495 DIR *d;
496 struct dirent *de;
497 char path[PATH_MAX];
498
499 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700500 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700501 return;
502 }
503
504 while ((de = readdir(d))) {
505 if (de->d_type != DT_LNK) {
506 continue;
507 }
508 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700509 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700510 }
511
512 closedir(d);
513}
514
Mark Salyzyn326842f2015-04-30 09:49:41 -0700515static bool skip_not_stat(const char *path) {
516 static const char stat[] = "/stat";
517 size_t len = strlen(path);
518 if (path[len - 1] == '/') { /* Directory? */
519 return false;
520 }
521 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
522}
523
Felipe Leme4c2d6632016-09-28 14:32:00 -0700524static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800525 return false;
526}
527
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700528unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700529
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800530//
531// stat offsets
532// Name units description
533// ---- ----- -----------
534// read I/Os requests number of read I/Os processed
535#define __STAT_READ_IOS 0
536// read merges requests number of read I/Os merged with in-queue I/O
537#define __STAT_READ_MERGES 1
538// read sectors sectors number of sectors read
539#define __STAT_READ_SECTORS 2
540// read ticks milliseconds total wait time for read requests
541#define __STAT_READ_TICKS 3
542// write I/Os requests number of write I/Os processed
543#define __STAT_WRITE_IOS 4
544// write merges requests number of write I/Os merged with in-queue I/O
545#define __STAT_WRITE_MERGES 5
546// write sectors sectors number of sectors written
547#define __STAT_WRITE_SECTORS 6
548// write ticks milliseconds total wait time for write requests
549#define __STAT_WRITE_TICKS 7
550// in_flight requests number of I/Os currently in flight
551#define __STAT_IN_FLIGHT 8
552// io_ticks milliseconds total time this block device has been active
553#define __STAT_IO_TICKS 9
554// time_in_queue milliseconds total wait time for all requests
555#define __STAT_IN_QUEUE 10
556#define __STAT_NUMBER_FIELD 11
557//
558// read I/Os, write I/Os
559// =====================
560//
561// These values increment when an I/O request completes.
562//
563// read merges, write merges
564// =========================
565//
566// These values increment when an I/O request is merged with an
567// already-queued I/O request.
568//
569// read sectors, write sectors
570// ===========================
571//
572// These values count the number of sectors read from or written to this
573// block device. The "sectors" in question are the standard UNIX 512-byte
574// sectors, not any device- or filesystem-specific block size. The
575// counters are incremented when the I/O completes.
576#define SECTOR_SIZE 512
577//
578// read ticks, write ticks
579// =======================
580//
581// These values count the number of milliseconds that I/O requests have
582// waited on this block device. If there are multiple I/O requests waiting,
583// these values will increase at a rate greater than 1000/second; for
584// example, if 60 read requests wait for an average of 30 ms, the read_ticks
585// field will increase by 60*30 = 1800.
586//
587// in_flight
588// =========
589//
590// This value counts the number of I/O requests that have been issued to
591// the device driver but have not yet completed. It does not include I/O
592// requests that are in the queue but not yet issued to the device driver.
593//
594// io_ticks
595// ========
596//
597// This value counts the number of milliseconds during which the device has
598// had I/O requests queued.
599//
600// time_in_queue
601// =============
602//
603// This value counts the number of milliseconds that I/O requests have waited
604// on this block device. If there are multiple I/O requests waiting, this
605// value will increase as the product of the number of milliseconds times the
606// number of requests waiting (see "read ticks" above for an example).
607#define S_TO_MS 1000
608//
609
Mark Salyzyn326842f2015-04-30 09:49:41 -0700610static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800611 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700612 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700613 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700615 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700616 getline(&buffer, &i, fp);
617 fclose(fp);
618 if (!buffer) {
619 return -errno;
620 }
621 i = strlen(buffer);
622 while ((i > 0) && (buffer[i - 1] == '\n')) {
623 buffer[--i] = '\0';
624 }
625 if (!*buffer) {
626 free(buffer);
627 return 0;
628 }
629 z = true;
630 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800631 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700632 if (fields[i] != 0) {
633 z = false;
634 }
635 }
636 if (z) { /* never accessed */
637 free(buffer);
638 return 0;
639 }
640
Wei Wang509bb5d2017-06-09 14:42:12 -0700641 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
642 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700643 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700644
645 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
646 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
647 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700648 free(buffer);
649
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800650 if (fields[__STAT_IO_TICKS]) {
651 unsigned long read_perf = 0;
652 unsigned long read_ios = 0;
653 if (fields[__STAT_READ_TICKS]) {
654 unsigned long long divisor = fields[__STAT_READ_TICKS]
655 * fields[__STAT_IO_TICKS];
656 read_perf = ((unsigned long long)SECTOR_SIZE
657 * fields[__STAT_READ_SECTORS]
658 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
659 / divisor;
660 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
661 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
662 / divisor;
663 }
664
665 unsigned long write_perf = 0;
666 unsigned long write_ios = 0;
667 if (fields[__STAT_WRITE_TICKS]) {
668 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
669 * fields[__STAT_IO_TICKS];
670 write_perf = ((unsigned long long)SECTOR_SIZE
671 * fields[__STAT_WRITE_SECTORS]
672 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
673 / divisor;
674 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
675 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
676 / divisor;
677 }
678
679 unsigned queue = (fields[__STAT_IN_QUEUE]
680 + (fields[__STAT_IO_TICKS] >> 1))
681 / fields[__STAT_IO_TICKS];
682
683 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700684 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 -0800685 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700686 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 -0800687 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800688 }
689
690 /* bugreport timeout factor adjustment */
691 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
692 worst_write_perf = write_perf;
693 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700694 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700695 return 0;
696}
697
Yao Chenbe3bbc12018-01-17 16:31:10 -0800698static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
699
Tom Cherryf4472f32020-08-05 09:31:17 -0700700// Returns the actual readable size of the given buffer or -1 on error.
701static long logcat_buffer_readable_size(const std::string& buffer) {
702 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
703 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
704 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
705
706 return android_logger_get_log_readable_size(logger);
707}
708
709// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800710static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
711 unsigned long timeout_ms = 0;
712 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700713 long readable_size = logcat_buffer_readable_size(buffer);
714 if (readable_size > 0) {
715 // Engineering margin is ten-fold our guess.
716 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
717 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800718 }
719 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700720}
721
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800722// Opens a socket and returns its file descriptor.
723static int open_socket(const char* service);
724
Nandana Duttd2f5f082019-01-18 17:13:52 +0000725Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
726}
727
728android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
729 std::lock_guard<std::mutex> lock(lock_);
730 result_ = APPROVED;
731 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800732
733 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
734 // consent is granted.
735 if (ds.options_->is_screenshot_copied) {
736 return android::binder::Status::ok();
737 }
738
739 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
740 !ds.do_early_screenshot_) {
741 return android::binder::Status::ok();
742 }
743
744 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
745 ds.options_->screenshot_fd.get());
746 ds.options_->is_screenshot_copied = copy_succeeded;
747 if (copy_succeeded) {
748 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
749 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000750 return android::binder::Status::ok();
751}
752
753android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
754 std::lock_guard<std::mutex> lock(lock_);
755 result_ = DENIED;
756 MYLOGW("User denied consent to share bugreport\n");
757 return android::binder::Status::ok();
758}
759
760UserConsentResult Dumpstate::ConsentCallback::getResult() {
761 std::lock_guard<std::mutex> lock(lock_);
762 return result_;
763}
764
765uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800766 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000767}
768
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700769void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200770 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700771 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700772
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700773 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
774 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700775 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
776 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
777 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200778 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700779 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700780
Felipe Lemed8b94e52016-12-08 10:21:44 -0800781 printf("========================================================\n");
782 printf("== dumpstate: %s\n", date);
783 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700784
Felipe Lemed8b94e52016-12-08 10:21:44 -0800785 printf("\n");
786 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700787 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800788 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
789 printf("Bootloader: %s\n", bootloader.c_str());
790 printf("Radio: %s\n", radio.c_str());
791 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100792 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
793 if (module_metadata_version != 0) {
794 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
795 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200796 printf("Android SDK version: %s\n", sdkversion.c_str());
797 printf("SDK extensions: ");
798 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
799 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700800
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800802 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800803 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800804 printf("Uptime: ");
805 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
806 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800807 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800808 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
809 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000810 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800811 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800812}
813
Felipe Leme24b66ee2016-06-16 10:55:26 -0700814// List of file extensions that can cause a zip file attachment to be rejected by some email
815// service providers.
816static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
817 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
818 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
819 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
820};
821
Vishnu Naire97d6122018-01-18 13:58:56 -0800822status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
823 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700824 std::string valid_name = entry_name;
825
826 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700827 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700828 if (idx != std::string::npos) {
829 std::string extension = entry_name.substr(idx);
830 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
831 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
832 valid_name = entry_name + ".renamed";
833 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
834 }
835 }
836
Felipe Leme6fe9db62016-02-12 09:04:16 -0800837 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
838 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000839 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
840 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700841 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700842 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700843 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700844 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800845 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800846 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000847 bool finished_entry = false;
848 auto finish_entry = [this, &finished_entry] {
849 if (!finished_entry) {
850 // This should only be called when we're going to return an earlier error,
851 // which would've been logged. This may imply the file is already corrupt
852 // and any further logging from FinishEntry is more likely to mislead than
853 // not.
854 this->zip_writer_->FinishEntry();
855 }
856 };
857 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800858 auto start = std::chrono::steady_clock::now();
859 auto end = start + timeout;
860 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800861
Felipe Leme770410d2016-01-26 17:07:14 -0800862 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800863 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800864 if (timeout.count() > 0) {
865 // lambda to recalculate the timeout.
866 auto time_left_ms = [end]() {
867 auto now = std::chrono::steady_clock::now();
868 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
869 return std::max(diff.count(), 0LL);
870 };
871
872 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
873 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000874 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
875 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800876 return -errno;
877 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000878 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 entry_name.c_str(), strerror(errno), timeout.count());
880 return TIMED_OUT;
881 }
882 }
883
Zach Riggle22200402016-08-18 01:01:24 -0400884 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800885 if (bytes_read == 0) {
886 break;
887 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800888 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800889 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800890 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700891 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800892 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700893 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800895 }
896 }
897
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700898 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000899 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700900 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700901 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800902 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 }
904
Vishnu Naire97d6122018-01-18 13:58:56 -0800905 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800906}
907
Felipe Leme1d486fe2016-10-14 18:06:47 -0700908bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
909 android::base::unique_fd fd(
910 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700911 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800912 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800913 return false;
914 }
915
Vishnu Naire97d6122018-01-18 13:58:56 -0800916 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800917}
918
919/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700920static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800921 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800922}
923
Felipe Leme1d486fe2016-10-14 18:06:47 -0700924void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700925 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800926 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700927 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928}
929
Felipe Leme1d486fe2016-10-14 18:06:47 -0700930bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800931 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000932 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
933 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700934 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700935 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700936 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800937 return false;
938 }
939
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700940 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700941 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700942 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700943 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800944 return false;
945 }
946
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700947 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700948 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700949 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800950 return false;
951 }
952
953 return true;
954}
955
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800956static void DoKmsg() {
957 struct stat st;
958 if (!stat(PSTORE_LAST_KMSG, &st)) {
959 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
960 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
961 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
962 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
963 } else {
964 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
965 DumpFile("LAST KMSG", "/proc/last_kmsg");
966 }
967}
968
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800969static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800970 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800971 RunCommand(
972 "KERNEL LOG",
973 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
974 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
975}
976
Nandana Duttdb379fa2019-10-09 16:54:41 +0100977static void DoSystemLogcat(time_t since) {
978 char since_str[80];
979 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
980
981 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
982 RunCommand("SYSTEM LOG",
983 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
984 since_str},
985 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
986}
987
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800988static void DoRadioLogcat() {
989 unsigned long timeout_ms = logcat_timeout({"radio"});
990 RunCommand(
991 "RADIO LOG",
992 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
993 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
994}
995
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800996static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800997 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800998 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
999 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001000 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001001 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001002 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1003 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001004 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001005 RunCommand(
1006 "EVENT LOG",
1007 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001008 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001009 timeout_ms = logcat_timeout({"stats"});
1010 RunCommand(
1011 "STATS LOG",
1012 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001013 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001014 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001015
1016 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1017
1018 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001019 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1020 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001021}
1022
Mike Ma5c267872019-08-21 11:31:34 -07001023static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001024 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1025 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1026 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1027 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1028 if (fd < 0) {
1029 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1030 return;
1031 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001032 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001033 bool empty = 0 == lseek(fd, 0, SEEK_END);
1034 if (!empty) {
1035 // Use a different name from "incident.proto"
1036 // /proto/incident.proto is reserved for incident service dump
1037 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001038 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1039 path);
1040 } else {
1041 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001042 }
Mike Ma5c267872019-08-21 11:31:34 -07001043}
1044
Aaron Huang24d215d2022-04-27 18:51:16 +08001045static void DumpNetstatsProto() {
1046 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1047 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1048 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1049 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1050 if (fd < 0) {
1051 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1052 return;
1053 }
1054 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001055 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001056 bool empty = 0 == lseek(fd, 0, SEEK_END);
1057 if (!empty) {
1058 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1059 path);
1060 } else {
1061 unlink(path.c_str());
1062 }
1063}
1064
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001065static void MaybeAddSystemTraceToZip() {
1066 // This function copies into the .zip the system trace that was snapshotted
1067 // by the early call to MaybeSnapshotSystemTrace(), if any background
1068 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001069 if (!ds.has_system_trace_) {
1070 // No background trace was happening at the time dumpstate was invoked.
1071 return;
1072 }
1073 ds.AddZipEntry(
1074 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1075 SYSTEM_TRACE_SNAPSHOT);
1076 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1077}
1078
Sunny Goyal35949782019-11-19 15:54:36 -08001079static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001080 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1081 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1082 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1083 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1084 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1085 if (fd < 0) {
1086 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1087 return;
1088 }
1089 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001090 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001091 bool empty = 0 == lseek(fd, 0, SEEK_END);
1092 if (!empty) {
1093 ds.AddZipEntry("visible_windows.zip", path);
1094 } else {
1095 MYLOGW("Failed to dump visible windows\n");
1096 }
1097 unlink(path.c_str());
1098}
1099
Jayachandran Ca94c7172017-06-10 15:08:12 -07001100static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001101 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1102 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001103 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001104 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001105 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1106 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1107 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1108 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001109}
1110
David Andersond9ba4752018-12-11 18:26:59 -08001111static void DumpDynamicPartitionInfo() {
1112 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1113 return;
1114 }
1115
1116 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001117 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001118}
1119
Chris Morin5a50d482022-02-01 17:41:18 -08001120static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001121 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1122 anr_traces_dir.c_str());
1123
1124 // If we're here, dump_traces_path will always be a temporary file
1125 // (created with mkostemp or similar) that contains dumps taken earlier
1126 // on in the process.
1127 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001128 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1129 dump_traces_path);
1130 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001131
1132 const int ret = unlink(dump_traces_path);
1133 if (ret == -1) {
1134 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1135 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001136 }
1137 }
1138
Narayan Kamathbd863722017-06-01 18:50:12 +01001139 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001140 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001141 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001142 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001143 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001144
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001145 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001146 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001147 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001148 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001149 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1150 }
1151}
1152
1153static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001154 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001155
Chris Morin5a50d482022-02-01 17:41:18 -08001156 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001157
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001158 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1159
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001160 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001161 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001162 int i = 0;
1163 while (true) {
1164 const std::string slow_trace_path =
1165 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1166 if (stat(slow_trace_path.c_str(), &st)) {
1167 // No traces file at this index, done with the files.
1168 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001169 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001170 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1171 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001172 }
1173}
1174
Wei Wang509bb5d2017-06-09 14:42:12 -07001175static void DumpBlockStatFiles() {
1176 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001177
Wei Wang1dc1ef52017-06-12 11:28:37 -07001178 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1179
1180 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001181 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1182 return;
1183 }
1184
1185 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001186 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001187 if ((d->d_name[0] == '.')
1188 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1189 || (d->d_name[1] == '\0'))) {
1190 continue;
1191 }
1192 const std::string new_path =
1193 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1194 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1195 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1196 printf("\n");
1197 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001198 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001199}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001200
1201static void DumpPacketStats() {
1202 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001203}
1204
1205static void DumpIpAddrAndRules() {
1206 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1207 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1208 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1209 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1210 RunCommand("IP RULES", {"ip", "rule", "show"});
1211 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1212}
1213
Nandana Dutt5c390032019-03-12 10:52:56 +00001214static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1215 std::chrono::milliseconds timeout,
1216 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001217 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001218 sp<android::IServiceManager> sm = defaultServiceManager();
1219 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001220 Vector<String16> args;
1221 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001222 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1223 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001224 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001225 std::string path(title);
1226 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001227 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001228 if (PropertiesHelper::IsDryRun()) {
1229 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1230 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1231 } else {
1232 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1233 if (status == OK) {
1234 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1235 std::chrono::duration<double> elapsed_seconds;
1236 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1237 service == String16("meminfo")) {
1238 // Use a longer timeout for meminfo, since 30s is not always enough.
1239 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1240 /* as_proto = */ false, elapsed_seconds,
1241 bytes_written);
1242 } else {
1243 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1244 /* as_proto = */ false, elapsed_seconds,
1245 bytes_written);
1246 }
1247 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1248 bool dump_complete = (status == OK);
1249 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001250 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001251 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001252
1253 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1254 std::chrono::steady_clock::now() - start);
1255 if (elapsed_duration > timeout) {
1256 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1257 elapsed_duration.count());
1258 break;
1259 }
1260 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001261 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001262}
1263
Vishnu Nair64afc022018-02-01 15:29:34 -08001264static void RunDumpsysText(const std::string& title, int priority,
1265 std::chrono::milliseconds timeout,
1266 std::chrono::milliseconds service_timeout) {
1267 DurationReporter duration_reporter(title);
1268 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1269 fsync(STDOUT_FILENO);
1270 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1271}
1272
1273/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001274static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1275 std::chrono::milliseconds timeout,
1276 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001277 DurationReporter duration_reporter(title);
1278 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1279 fsync(STDOUT_FILENO);
1280 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1281 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001282
1283 RETURN_IF_USER_DENIED_CONSENT();
1284
1285 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1286 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001287}
1288
Nandana Dutt5c390032019-03-12 10:52:56 +00001289static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1290 std::chrono::milliseconds timeout,
1291 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001292 sp<android::IServiceManager> sm = defaultServiceManager();
1293 Dumpsys dumpsys(sm.get());
1294 Vector<String16> args;
1295 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1296 DurationReporter duration_reporter(title);
1297
1298 auto start = std::chrono::steady_clock::now();
1299 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1300 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001301 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001302 std::string path(kProtoPath);
1303 path.append(String8(service).c_str());
1304 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1305 path.append("_CRITICAL");
1306 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1307 path.append("_HIGH");
1308 }
1309 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001310 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001311 if (status == OK) {
1312 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1313 bool dumpTerminated = (status == OK);
1314 dumpsys.stopDumpThread(dumpTerminated);
1315 }
1316 ZipWriter::FileEntry file_entry;
1317 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001318
1319 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1320 std::chrono::steady_clock::now() - start);
1321 if (elapsed_duration > timeout) {
1322 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1323 elapsed_duration.count());
1324 break;
1325 }
1326 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001327 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001328}
1329
Nandana Dutta7db6342018-11-21 14:53:34 +00001330// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001331static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001332 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1333 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001334
1335 RETURN_IF_USER_DENIED_CONSENT();
1336
1337 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1338 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001339}
1340
1341// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001342static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001343 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1344 // high priority. Reduce timeout once they are able to dump in a shorter time or
1345 // moved to a parallel task.
1346 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1347 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001348
1349 RETURN_IF_USER_DENIED_CONSENT();
1350
1351 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1352 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001353}
1354
1355// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001356static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001357 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001358
1359 RETURN_IF_USER_DENIED_CONSENT();
1360
1361 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1362 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001363}
1364
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001365/*
1366 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1367 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1368 * if it's not running in the parallel task.
1369 */
1370static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001371 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001372 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1373 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001374
Steven Moreland44cd9482018-01-04 16:24:13 -08001375 using android::hidl::manager::V1_0::IServiceManager;
1376 using android::hardware::defaultServiceManager;
1377
1378 sp<IServiceManager> sm = defaultServiceManager();
1379 if (sm == nullptr) {
1380 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1381 return;
1382 }
1383
1384 auto ret = sm->list([&](const auto& interfaces) {
1385 for (const std::string& interface : interfaces) {
1386 std::string cleanName = interface;
1387 std::replace_if(cleanName.begin(),
1388 cleanName.end(),
1389 [](char c) {
1390 return !isalnum(c) &&
1391 std::string("@-_:.").find(c) == std::string::npos;
1392 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001393 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001394
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001395 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001396 {
1397 auto fd = android::base::unique_fd(
1398 TEMP_FAILURE_RETRY(open(path.c_str(),
1399 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1400 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1401 if (fd < 0) {
1402 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1403 continue;
1404 }
1405 RunCommandToFd(fd,
1406 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001407 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001408 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1409
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001410 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001411 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001412 if (!empty) {
1413 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1414 path);
1415 } else {
1416 unlink(path.c_str());
1417 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001418 }
1419 });
1420
1421 if (!ret.isOk()) {
1422 MYLOGE("Could not list hals from hwservicemanager.\n");
1423 }
1424}
1425
Devin Moore8df81bb2022-06-08 22:47:02 +00001426// Dump all of the files that make up the vendor interface.
1427// See the files listed in dumpFileList() for the latest list of files.
1428static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001429
1430 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1431 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001432 for (const auto vintfFile : vintfFiles) {
1433 struct stat st;
1434 if (stat(vintfFile.c_str(), &st) == 0) {
1435 if (S_ISDIR(st.st_mode)) {
1436 ds.AddDir(vintfFile, true /* recursive */);
1437 } else {
1438 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1439 vintfFile);
1440 }
1441 }
1442 }
1443}
1444
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001445static void DumpExternalFragmentationInfo() {
1446 struct stat st;
1447 if (stat("/proc/buddyinfo", &st) != 0) {
1448 MYLOGE("Unable to dump external fragmentation info\n");
1449 return;
1450 }
1451
1452 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1453 std::ifstream ifs("/proc/buddyinfo");
1454 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1455 for (std::string line; std::getline(ifs, line);) {
1456 std::smatch match_results;
1457 if (std::regex_match(line, match_results, unusable_index_regex)) {
1458 std::stringstream free_pages(std::string{match_results[3]});
1459 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1460 std::istream_iterator<int>());
1461
1462 int total_free_pages = 0;
1463 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1464 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1465 }
1466
1467 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1468 match_results[2].str().c_str());
1469
1470 int usable_free_pages = total_free_pages;
1471 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1472 auto unusable_index = (total_free_pages - usable_free_pages) /
1473 static_cast<double>(total_free_pages);
1474 printf(" %5.3f", unusable_index);
1475 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1476 }
1477
1478 printf("\n");
1479 }
1480 }
1481 printf("\n");
1482}
1483
mhasankd451a472020-05-26 18:02:39 -07001484static void DumpstateLimitedOnly() {
1485 // Trimmed-down version of dumpstate to only include a whitelisted
1486 // set of logs (system log, event log, and system server / system app
1487 // crashes, and networking logs). See b/136273873 and b/138459828
1488 // for context.
1489 DurationReporter duration_reporter("DUMPSTATE");
1490 unsigned long timeout_ms;
1491 // calculate timeout
1492 timeout_ms = logcat_timeout({"main", "system", "crash"});
1493 RunCommand("SYSTEM LOG",
1494 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1495 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1496 timeout_ms = logcat_timeout({"events"});
1497 RunCommand(
1498 "EVENT LOG",
1499 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1500 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1501
1502 printf("========================================================\n");
1503 printf("== Networking Service\n");
1504 printf("========================================================\n");
1505
1506 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1507 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001508 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1509 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001510
1511 printf("========================================================\n");
1512 printf("== Dropbox crashes\n");
1513 printf("========================================================\n");
1514
1515 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1516 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1517
1518 printf("========================================================\n");
1519 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1520 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1521 printf("========================================================\n");
1522 printf("== dumpstate: done (id %d)\n", ds.id_);
1523 printf("========================================================\n");
1524}
1525
Rhed Jaoe017f982020-07-21 17:58:41 +08001526/*
1527 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1528 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1529 * if it's not running in the parallel task.
1530 */
1531static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1532 dprintf(out_fd, "========================================================\n");
1533 dprintf(out_fd, "== Checkins\n");
1534 dprintf(out_fd, "========================================================\n");
1535
1536 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001537 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1538 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1539 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1540 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1541}
1542
1543/*
1544 * Runs dumpsys on activity service to dump all application activities, services
1545 * and providers in the device.
1546 *
1547 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1548 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1549 * if it's not running in the parallel task.
1550 */
1551static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1552 dprintf(out_fd, "========================================================\n");
1553 dprintf(out_fd, "== Running Application Activities\n");
1554 dprintf(out_fd, "========================================================\n");
1555
1556 // The following dumpsys internally collects output from running apps, so it can take a long
1557 // time. So let's extend the timeout.
1558
1559 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1560
1561 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1562
1563 dprintf(out_fd, "========================================================\n");
1564 dprintf(out_fd, "== Running Application Services (platform)\n");
1565 dprintf(out_fd, "========================================================\n");
1566
1567 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1568 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1569
1570 dprintf(out_fd, "========================================================\n");
1571 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1572 dprintf(out_fd, "========================================================\n");
1573
1574 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1575 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1576
1577 dprintf(out_fd, "========================================================\n");
1578 dprintf(out_fd, "== Running Application Providers (platform)\n");
1579 dprintf(out_fd, "========================================================\n");
1580
1581 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001582 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001583
1584 dprintf(out_fd, "========================================================\n");
1585 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1586 dprintf(out_fd, "========================================================\n");
1587
1588 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1589 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1590}
1591
Nandana Dutt5c390032019-03-12 10:52:56 +00001592// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1593// via the consent they are shown. Ignores other errors that occur while running various
1594// commands. The consent checking is currently done around long running tasks, which happen to
1595// be distributed fairly evenly throughout the function.
1596static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001597 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001598
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001599 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001600 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1601 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001602 if (ds.dump_pool_) {
1603 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1604 // drop root user. Restarts it with two threads for the parallel run.
1605 ds.dump_pool_->start(/* thread_counts = */2);
1606
Chris Morinbc223142022-02-04 14:17:11 -08001607 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1608 dump_incident_report = ds.dump_pool_->enqueueTask(
1609 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001610 dump_netstats_report = ds.dump_pool_->enqueueTask(
1611 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001612 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1613 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1614 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001615 }
1616
Nandana Dutt5c390032019-03-12 10:52:56 +00001617 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1618 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1619 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001620 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001621 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001622 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001623 DumpFile("MEMORY INFO", "/proc/meminfo");
1624 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001625 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001626
1627 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "PROCRANK", {"procrank"}, AS_ROOT_20);
1628
Sunny Goyal35949782019-11-19 15:54:36 -08001629 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1630
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001631 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1632 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1633 DumpFile("SLAB INFO", "/proc/slabinfo");
1634 DumpFile("ZONEINFO", "/proc/zoneinfo");
1635 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1636 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001637 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001638
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001639 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001640
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001641 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001642 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001643
1644 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "LIBRANK", {"librank"},
1645 CommandOptions::AS_ROOT);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001646
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001647 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001648 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001649 } else {
1650 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1651 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001652
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001653 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001654 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001655 struct stat s;
1656 if (stat("/proc/modules", &s) != 0) {
1657 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1658 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001659 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001660 RunCommand("MODULES INFO",
1661 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1662 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1663 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001664 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001665
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001666 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001667 DoKernelLogcat();
1668 } else {
1669 do_dmesg();
1670 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001671
Devin Moore8df81bb2022-06-08 22:47:02 +00001672 DumpVintf();
1673
Felipe Lemef0292972016-11-22 13:57:05 -08001674 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001675
1676 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(for_each_pid, do_showmap, "SMAPS OF ALL PROCESSES");
1677
Jeff Brown1dc94e32014-09-11 14:15:27 -07001678 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001679 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001680
Jack Yu5a6b2e22020-08-14 18:13:35 +08001681 /* Dump Nfc NCI logs */
1682 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001683
Paul Chang0d2aad72020-02-13 20:04:03 +08001684 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001685 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001686 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001687 }
1688
Felipe Lemee184f662016-10-27 10:04:47 -07001689 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001690
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001691 MaybeAddSystemTraceToZip();
1692
Narayan Kamath8f788292017-05-25 13:20:39 +01001693 // NOTE: tombstones are always added as separate entries in the zip archive
1694 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001695 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001696 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001697 if (!tombstones_dumped) {
1698 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001699 }
1700
Jayachandran Ca94c7172017-06-10 15:08:12 -07001701 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001702
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001703 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001704
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001705 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001706
Jayachandran Ca94c7172017-06-10 15:08:12 -07001707 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001708
1709 dump_route_tables();
1710
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001711 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1712 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1713 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001714
Nandana Dutt5c390032019-03-12 10:52:56 +00001715 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001716
Chiachang Wang668ede42021-05-17 17:14:20 +08001717 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1718 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1719 // dump with priority parameters to dump high priority information.
1720 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1721 CommandOptions::WithTimeout(10).Build());
1722
Elliott Hughes23ccc622017-02-28 10:14:22 -08001723 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001724
Jin Qianf334d662017-10-10 14:41:37 -07001725 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001726
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001727 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001728
Colin Crossf45fa6b2012-03-26 12:38:26 -07001729 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001730 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1731 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1732
1733 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1734 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1735 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1736 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1737 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001738
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001739 /* Add window and surface trace files. */
1740 if (!PropertiesHelper::IsUserBuild()) {
1741 ds.AddDir(WMTRACE_DATA_DIR, false);
1742 }
1743
Yifan Hongd90cc652020-02-08 16:52:02 -08001744 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1745
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001746 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001747 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001748 } else {
1749 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1750 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001751
Steven Moreland7440ddb2016-12-15 16:13:39 -08001752 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001753 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1754 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001755 // su does not exist on user builds, so try running without it.
1756 // This way any implementations of vril-dump that do not require
1757 // root can run on user builds.
1758 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001759 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001760 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001761 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001762 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001763 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001764 }
1765
Felipe Lemed8b94e52016-12-08 10:21:44 -08001766 printf("========================================================\n");
1767 printf("== Android Framework Services\n");
1768 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001769
Nandana Dutt5c390032019-03-12 10:52:56 +00001770 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001771
Jack He91ff2fe2021-02-18 18:23:43 -08001772 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1773 ds.AddDir("/data/misc/bluetooth/logs", true);
1774
Rhed Jaoe017f982020-07-21 17:58:41 +08001775 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001776 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001777 } else {
1778 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1779 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001780
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001781 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001782
Adrian Roos8b397ab2017-04-04 16:35:44 -07001783 printf("========================================================\n");
1784 printf("== Dropbox crashes\n");
1785 printf("========================================================\n");
1786
1787 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1788 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1789
Felipe Lemed8b94e52016-12-08 10:21:44 -08001790 printf("========================================================\n");
1791 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1792 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1793 printf("========================================================\n");
1794 printf("== dumpstate: done (id %d)\n", ds.id_);
1795 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001796
1797 printf("========================================================\n");
1798 printf("== Obtaining statsd metadata\n");
1799 printf("========================================================\n");
1800 // This differs from the usual dumpsys stats, which is the stats report data.
1801 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001802
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001803 // Add linker configuration directory
1804 ds.AddDir(LINKERCONFIG_DIR, true);
1805
Li Li830179f2022-01-04 12:53:29 -08001806 /* Dump frozen cgroupfs */
1807 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001808
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001809 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001810 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1811 } else {
1812 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1813 DumpNetstatsProto);
1814 }
1815
1816 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001817 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001818 } else {
1819 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1820 DumpIncidentReport);
1821 }
Mike Ma5c267872019-08-21 11:31:34 -07001822
Nandana Dutt5c390032019-03-12 10:52:56 +00001823 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001824}
1825
Nandana Dutt5c390032019-03-12 10:52:56 +00001826/*
1827 * Dumps state for the default case; drops root after it's no longer necessary.
1828 *
1829 * Returns RunStatus::OK if everything went fine.
1830 * Returns RunStatus::ERROR if there was an error.
1831 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1832 * with the caller.
1833 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001834Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001835 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1836 // buffer.
1837 DoLogcat();
1838 // Capture timestamp after first logcat to use in next logcat
1839 time_t logcat_ts = time(nullptr);
1840
Nandana Dutt4be45d12018-09-26 15:04:23 +01001841 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001842 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001843 if (dump_pool_) {
1844 RETURN_IF_USER_DENIED_CONSENT();
1845 // One thread is enough since we only need to enqueue DumpTraces here.
1846 dump_pool_->start(/* thread_counts = */1);
1847
1848 // DumpTraces takes long time, post it to the another thread in the
1849 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001850 dump_traces = dump_pool_->enqueueTask(
1851 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001852 } else {
1853 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1854 &dump_traces_path);
1855 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001856
1857 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001858 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001859 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1860 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001861 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001862
1863 ds.AddDir(RECOVERY_DIR, true);
1864 ds.AddDir(RECOVERY_DATA_DIR, true);
1865 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
1866 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1867 if (!PropertiesHelper::IsUserBuild()) {
1868 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1869 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001870 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001871 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001872 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001873 add_mountinfo();
1874 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001875 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001876 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001877
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001878 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001879 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1880
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001881 // Dump IPsec stats. No keys are exposed here.
1882 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1883
Nandana Dutt4be45d12018-09-26 15:04:23 +01001884 // Run ss as root so we can see socket marks.
1885 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1886
1887 // Run iotop as root to show top 100 IO threads
1888 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1889
Erick Reyese68df822019-02-11 14:46:36 -08001890 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001891 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1892 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001893
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001894 DumpFile("PSI cpu", "/proc/pressure/cpu");
1895 DumpFile("PSI memory", "/proc/pressure/memory");
1896 DumpFile("PSI io", "/proc/pressure/io");
1897
Mårten Kongstad60195a72022-09-20 14:14:20 +02001898 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1899 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1900
Rhed Jao5377d792020-07-16 17:37:39 +08001901 if (dump_pool_) {
1902 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001903 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001904
Chris Morinbc223142022-02-04 14:17:11 -08001905 // Current running thread in the pool is the root user also. Delete
1906 // the pool and make a new one later to ensure none of threads in the pool are root.
1907 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001908 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001909 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001910 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001911 }
1912
Nandana Dutt5c390032019-03-12 10:52:56 +00001913 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001914 Dumpstate::RunStatus status = dumpstate();
1915 // Capture logcat since the last time we did it.
1916 DoSystemLogcat(logcat_ts);
1917 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001918}
1919
Rhed Jaob5685b32020-08-14 17:19:17 +08001920// Common states for telephony and wifi which are needed to be collected before
1921// dumpstate drop the root user.
1922static void DumpstateRadioAsRoot() {
1923 DumpIpTablesAsRoot();
1924 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1925}
1926
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001927// This method collects common dumpsys for telephony and wifi. Typically, wifi
1928// reports are fine to include all information, but telephony reports on user
1929// builds need to strip some content (see DumpstateTelephonyOnly).
1930static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001931 // We need to be picky about some stuff for telephony reports on user builds.
1932 if (!include_sensitive_info) {
1933 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1934 DoRadioLogcat();
1935 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001936 // DumpHals takes long time, post it to the another thread in the pool,
1937 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001938 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001939 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001940 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001941 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001942 // Contains various system properties and process startup info.
1943 do_dmesg();
1944 // Logs other than the radio buffer may contain package/component names and potential PII.
1945 DoLogcat();
1946 // Too broad for connectivity problems.
1947 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001948 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1949 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001950 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001951 } else {
1952 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1953 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001954 }
1955
Jayachandran Ca94c7172017-06-10 15:08:12 -07001956 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001957 DumpIpAddrAndRules();
1958 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001959 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1960 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001961}
1962
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001963// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1964// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1965// for what can be included on user builds: all reported information MUST directly relate to
1966// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1967// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1968// names are not), and MUST NOT contain logs of user application traffic.
1969// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001970static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001971 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001972
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001973 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001974
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001975 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001976
Rhed Jaob5685b32020-08-14 17:19:17 +08001977 DumpstateRadioAsRoot();
1978 if (!DropRootUser()) {
1979 return;
1980 }
1981
1982 // Starts thread pool after the root user is dropped, and two additional threads
1983 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08001984 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08001985 if (ds.dump_pool_) {
1986 ds.dump_pool_->start(/*thread_counts =*/2);
1987
1988 // DumpstateBoard takes long time, post it to the another thread in the pool,
1989 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001990 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1991 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001992 }
1993
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001994 DumpstateRadioCommon(include_sensitive_info);
1995
1996 if (include_sensitive_info) {
1997 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1998 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1999 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2000 // way.
2001 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2002 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002003
2004 printf("========================================================\n");
2005 printf("== Android Framework Services\n");
2006 printf("========================================================\n");
2007
Vishnu Nair652cc802017-11-30 15:18:30 -08002008 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2009 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002010 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2011 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002012 if (include_sensitive_info) {
2013 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2014 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2015 SEC_TO_MSEC(10));
2016 } else {
2017 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2018 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2019 // give a higher timeout as well.
2020 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2021 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2022 }
2023 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002024 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2025 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002026 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002027 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2028 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002029 if (include_sensitive_info) {
2030 // Contains raw IP addresses, omit from reports on user builds.
2031 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2032 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2033 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2034 SEC_TO_MSEC(10));
2035 // Contains package/component names, omit from reports on user builds.
2036 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2037 SEC_TO_MSEC(10));
2038 // Contains package names, but should be relatively simple to remove them (also contains
2039 // UIDs already), omit from reports on user builds.
2040 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2041 SEC_TO_MSEC(10));
2042 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002043
2044 printf("========================================================\n");
2045 printf("== Running Application Services\n");
2046 printf("========================================================\n");
2047
2048 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2049
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002050 if (include_sensitive_info) {
2051 printf("========================================================\n");
2052 printf("== Running Application Services (non-platform)\n");
2053 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002054
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002055 // Contains package/component names and potential PII, omit from reports on user builds.
2056 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2057 // carrier_config dumpsys instead.
2058 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2059 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002060
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002061 printf("========================================================\n");
2062 printf("== Checkins\n");
2063 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002064
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002065 // Contains package/component names, omit from reports on user builds.
2066 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2067 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002068
2069 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002070 printf("== dumpstate: done (id %d)\n", ds.id_);
2071 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002072
2073 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002074 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002075 } else {
2076 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2077 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002078}
2079
mukesh agrawal253dad42018-01-23 21:59:59 -08002080// This method collects dumpsys for wifi debugging only
2081static void DumpstateWifiOnly() {
2082 DurationReporter duration_reporter("DUMPSTATE");
2083
Rhed Jaob5685b32020-08-14 17:19:17 +08002084 DumpstateRadioAsRoot();
2085 if (!DropRootUser()) {
2086 return;
2087 }
2088
2089 // Starts thread pool after the root user is dropped. Only one additional
2090 // thread is needed for DumpHals in the DumpstateRadioCommon.
2091 if (ds.dump_pool_) {
2092 ds.dump_pool_->start(/*thread_counts =*/1);
2093 }
2094
mukesh agrawal253dad42018-01-23 21:59:59 -08002095 DumpstateRadioCommon();
2096
2097 printf("========================================================\n");
2098 printf("== Android Framework Services\n");
2099 printf("========================================================\n");
2100
2101 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2102 SEC_TO_MSEC(10));
2103 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2104 SEC_TO_MSEC(10));
2105
2106 printf("========================================================\n");
2107 printf("== dumpstate: done (id %d)\n", ds.id_);
2108 printf("========================================================\n");
2109}
2110
Nandana Duttcf419a72019-03-14 10:40:17 +00002111Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002112 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002113 const size_t buf_size = temp_file_pattern.length() + 1;
2114 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2115 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2116
2117 // Create a new, empty file to receive all trace dumps.
2118 //
2119 // TODO: This can be simplified once we remove support for the old style
2120 // dumps. We can have a file descriptor passed in to dump_traces instead
2121 // of creating a file, closing it and then reopening it again.
2122 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2123 if (fd < 0) {
2124 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002125 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002126 }
2127
2128 // Nobody should have access to this temporary file except dumpstate, but we
2129 // temporarily grant 'read' to 'others' here because this file is created
2130 // when tombstoned is still running as root, but dumped after dropping. This
2131 // can go away once support for old style dumping has.
2132 const int chmod_ret = fchmod(fd, 0666);
2133 if (chmod_ret < 0) {
2134 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002135 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002136 }
2137
2138 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2139 if (proc.get() == nullptr) {
2140 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002141 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002142 }
2143
2144 // Number of times process dumping has timed out. If we encounter too many
2145 // failures, we'll give up.
2146 int timeout_failures = 0;
2147 bool dalvik_found = false;
2148
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002149 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002150
2151 struct dirent* d;
2152 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002153 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002154 int pid = atoi(d->d_name);
2155 if (pid <= 0) {
2156 continue;
2157 }
2158
2159 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2160 std::string exe;
2161 if (!android::base::Readlink(link_name, &exe)) {
2162 continue;
2163 }
2164
2165 bool is_java_process;
2166 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2167 // Don't bother dumping backtraces for the zygote.
2168 if (IsZygote(pid)) {
2169 continue;
2170 }
2171
2172 dalvik_found = true;
2173 is_java_process = true;
2174 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2175 is_java_process = false;
2176 } else {
2177 // Probably a native process we don't care about, continue.
2178 continue;
2179 }
2180
2181 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2182 if (timeout_failures == 3) {
2183 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2184 break;
2185 }
2186
2187 const uint64_t start = Nanotime();
2188 const int ret = dump_backtrace_to_file_timeout(
2189 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2190 is_java_process ? 5 : 20, fd);
2191
2192 if (ret == -1) {
2193 // For consistency, the header and footer to this message match those
2194 // dumped by debuggerd in the success case.
2195 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2196 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2197 dprintf(fd, "---- end %d ----", pid);
2198 timeout_failures++;
2199 continue;
2200 }
2201
2202 // We've successfully dumped stack traces, reset the failure count
2203 // and write a summary of the elapsed time to the file and continue with the
2204 // next process.
2205 timeout_failures = 0;
2206
2207 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2208 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2209 }
2210
2211 if (!dalvik_found) {
2212 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2213 }
2214
Nandana Duttcf419a72019-03-14 10:40:17 +00002215 *path = file_name_buf.release();
2216 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002217}
2218
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002219static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2220 const Dumpstate::BugreportMode bugreport_mode) {
2221 switch (bugreport_mode) {
2222 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2223 return dumpstate_hal_hidl::DumpstateMode::FULL;
2224 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2225 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2226 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2227 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2228 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2229 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2230 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2231 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2232 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2233 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2234 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2235 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2236 }
2237 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2238}
2239
2240static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2241 const Dumpstate::BugreportMode bugreport_mode) {
2242 switch (bugreport_mode) {
2243 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2244 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2245 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2246 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2247 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2248 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2249 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2250 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2251 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2252 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2253 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2254 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2255 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2256 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2257 }
2258 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2259}
2260
2261static void DoDumpstateBoardHidl(
2262 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2263 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2264 const Dumpstate::BugreportMode bugreport_mode,
2265 const size_t timeout_sec) {
2266
2267 using ScopedNativeHandle =
2268 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2269 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2270 [](native_handle_t* handle) {
2271 // we don't close file handle's here
2272 // via native_handle_close(handle)
2273 // instead we let dumpstate_fds close the file handles when
2274 // dumpstate_fds gets destroyed
2275 native_handle_delete(handle);
2276 });
2277 if (handle == nullptr) {
2278 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2279 return;
2280 }
2281
2282 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2283 handle.get()->data[i] = dumpstate_fds[i].get();
2284 }
2285
2286 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2287 // implement just 1.0.
2288 const char* descriptor_to_kill;
2289 using DumpstateBoardTask = std::packaged_task<bool()>;
2290 DumpstateBoardTask dumpstate_board_task;
2291 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2292 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2293 if (dumpstate_hal != nullptr) {
2294 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2295
2296 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2297 GetDumpstateHalModeHidl(bugreport_mode);
2298
2299 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2300 dumpstate_board_task =
2301 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2302 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2303 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2304 SEC_TO_MSEC(timeout_sec));
2305 if (!status.isOk()) {
2306 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2307 return false;
2308 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2309 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2310 dumpstate_hal_hidl::toString(status).c_str());
2311 return false;
2312 }
2313 return true;
2314 });
2315 } else {
2316 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2317
2318 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2319 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2320 ::android::hardware::Return<void> status =
2321 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2322 if (!status.isOk()) {
2323 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2324 return false;
2325 }
2326 return true;
2327 });
2328 }
2329 auto result = dumpstate_board_task.get_future();
2330 std::thread(std::move(dumpstate_board_task)).detach();
2331
2332 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2333 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2334 if (!android::base::SetProperty(
2335 "ctl.interface_restart",
2336 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2337 MYLOGE("Couldn't restart dumpstate HAL\n");
2338 }
2339 }
2340 // Wait some time for init to kill dumpstate vendor HAL
2341 constexpr size_t killing_timeout_sec = 10;
2342 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2343 MYLOGE(
2344 "killing dumpstateBoard timed out after %zus, continue and "
2345 "there might be racing in content\n",
2346 killing_timeout_sec);
2347 }
2348}
2349
2350static void DoDumpstateBoardAidl(
2351 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2352 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2353 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2354 MYLOGI("Using IDumpstateDevice AIDL HAL");
2355
2356 const char* descriptor_to_kill;
2357 using DumpstateBoardTask = std::packaged_task<bool()>;
2358 DumpstateBoardTask dumpstate_board_task;
2359 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2360 GetDumpstateHalModeAidl(bugreport_mode);
2361
2362 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2363 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2364 timeout_sec]() -> bool {
2365 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2366
2367 if (!status.isOk()) {
2368 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2369 return false;
2370 }
2371 return true;
2372 });
2373 auto result = dumpstate_board_task.get_future();
2374 std::thread(std::move(dumpstate_board_task)).detach();
2375
2376 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2377 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2378 if (!android::base::SetProperty(
2379 "ctl.interface_restart",
2380 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2381 MYLOGE("Couldn't restart dumpstate HAL\n");
2382 }
2383 }
2384 // Wait some time for init to kill dumpstate vendor HAL
2385 constexpr size_t killing_timeout_sec = 10;
2386 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2387 MYLOGE(
2388 "killing dumpstateBoard timed out after %zus, continue and "
2389 "there might be racing in content\n",
2390 killing_timeout_sec);
2391 }
2392}
2393
2394static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2395 const std::string aidl_instance_name =
2396 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2397
2398 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2399 return nullptr;
2400 }
2401
2402 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2403
2404 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2405}
2406
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002407void Dumpstate::DumpstateBoard(int out_fd) {
2408 dprintf(out_fd, "========================================================\n");
2409 dprintf(out_fd, "== Board\n");
2410 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002411
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002412 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002413 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002414 * set to true and unmount it after invoking dumpstateBoard_* methods.
2415 * This is to enable debug builds to not have debugfs mounted during runtime.
2416 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002417 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002418 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002419 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002420 if (mount_debugfs) {
2421 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2422 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002423 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002424 }
2425
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002426 std::vector<std::string> paths;
2427 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002428 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002429 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2430 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002431 remover.emplace_back(android::base::make_scope_guard(
2432 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002433 }
Jie Song9fbfad02017-06-20 16:29:42 -07002434
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002435 // get dumpstate HAL AIDL implementation
2436 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2437 GetDumpstateBoardAidlService());
2438 if (dumpstate_hal_handle_aidl == nullptr) {
2439 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2440 }
2441
2442 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2443 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2444 if (dumpstate_hal_handle_aidl == nullptr) {
2445 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2446 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2447 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2448 }
2449 }
2450
2451 // if neither HIDL nor AIDL implementation found, then return
2452 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2453 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002454 return;
2455 }
2456
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002457 // this is used to hold the file descriptors and when this variable goes out of scope
2458 // the file descriptors are closed
2459 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002460
Nandana Dutt5c390032019-03-12 10:52:56 +00002461 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002462 for (size_t i = 0; i < paths.size(); i++) {
2463 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2464
2465 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2466 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2467 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2468 if (fd < 0) {
2469 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2470 return;
2471 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002472
2473 dumpstate_fds.emplace_back(fd.release());
2474 // we call fd.release() here to make sure "fd" does not get closed
2475 // after "fd" goes out of scope after this block.
2476 // "fd" will be closed when "dumpstate_fds" goes out of scope
2477 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002478 }
2479
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002480 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2481 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2482 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002483 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002484
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002485 if (dumpstate_hal_handle_aidl != nullptr) {
2486 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2487 timeout_sec);
2488 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2489 // run HIDL HAL only if AIDL HAL not found
2490 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2491 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002492 }
2493
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002494 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002495 auto keep_debugfs_mounted =
2496 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2497 if (keep_debugfs_mounted.empty())
2498 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002499 }
2500
Wei Wang587eac92018-04-05 12:17:20 -07002501 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2502 for (size_t i = 0; i < paths.size(); i++) {
2503 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002504 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2505 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002506 file_sizes[i] = -1;
2507 continue;
2508 }
2509 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002510 }
2511
2512 for (size_t i = 0; i < paths.size(); i++) {
2513 if (file_sizes[i] == -1) {
2514 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002515 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002516 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002517 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002518 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002519 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002520 remover[i].Disable();
2521 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2522 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002523 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002524}
2525
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002526static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002527 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002528 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2529 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002530 " -h: display this help message\n"
2531 " -b: play sound file instead of vibrate, at beginning of job\n"
2532 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002533 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002534 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002535 " -s: write zipped file to control socket (for init)\n"
2536 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002537 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002538 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002539 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002540 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002541 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002542 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002543}
2544
Wei Liuf87959e2016-08-26 14:51:42 -07002545static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002546 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002547}
2548
Felipe Leme1d486fe2016-10-14 18:06:47 -07002549bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002550 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2551 if (zip_entry_tasks_) {
2552 zip_entry_tasks_->run(/* do_cancel = */false);
2553 }
2554
Felipe Leme9a523ae2016-10-20 15:10:33 -07002555 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002556 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002557 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002558 // Final timestamp
2559 char date[80];
2560 time_t the_real_now_please_stand_up = time(nullptr);
2561 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002562 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002563 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002564
Felipe Leme9a523ae2016-10-20 15:10:33 -07002565 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002566 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002567 return false;
2568 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002569 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002570 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002571 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002572 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002573
Felipe Leme0f3fb202016-06-10 17:10:53 -07002574 // Add log file (which contains stderr output) to zip...
2575 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002576 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002577 MYLOGE("Failed to add dumpstate log to .zip file\n");
2578 return false;
2579 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002580 // TODO: Should truncate the existing file.
2581 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002582 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2583 return false;
2584 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002585 fprintf(stderr, "\n");
2586
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002587 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002588 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002589 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002590 return false;
2591 }
2592
Felipe Leme1d486fe2016-10-14 18:06:47 -07002593 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2594 ds.zip_file.reset(nullptr);
2595
Felipe Lemee9d2c542016-11-15 11:48:26 -08002596 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002597 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002598
Felipe Leme1e9edc62015-12-21 16:02:13 -08002599 return true;
2600}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002601
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002602static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2603 // clang-format off
2604 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2605 "--receiver-foreground", "--receiver-include-background", "-a", action};
2606 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002607
2608 am.insert(am.end(), args.begin(), args.end());
2609
Felipe Leme8d2410e2017-02-08 09:46:08 -08002610 RunCommand("", am,
2611 CommandOptions::WithTimeout(20)
2612 .Log("Sending broadcast: '%s'\n")
2613 .Always()
2614 .DropRoot()
2615 .RedirectStderr()
2616 .Build());
2617}
2618
Felipe Leme35b8cf12017-02-10 15:47:29 -08002619static void Vibrate(int duration_ms) {
2620 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002621 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2622 "oneshot", std::to_string(duration_ms)};
2623 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002624 CommandOptions::WithTimeout(10)
2625 .Log("Vibrate: '%s'\n")
2626 .Always()
2627 .Build());
2628 // clang-format on
2629}
2630
Nandana Dutt979388e2018-11-30 16:48:55 +00002631static void MaybeResolveSymlink(std::string* path) {
2632 std::string resolved_path;
2633 if (android::base::Readlink(*path, &resolved_path)) {
2634 *path = resolved_path;
2635 }
2636}
2637
Nandana Dutt4be45d12018-09-26 15:04:23 +01002638/*
2639 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002640 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002641 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002642static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002643 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2644
Nandana Dutt4be45d12018-09-26 15:04:23 +01002645 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2646 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002647 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002648 char date[80];
2649 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2650 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002651
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002652 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002653 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002654 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002655 ds.base_name_ += "-wifi";
2656 }
2657
Paul Chang0d2aad72020-02-13 20:04:03 +08002658 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002659 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002660 }
2661 ds.tmp_path_ = ds.GetPath(".tmp");
2662 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2663
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002664 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002665 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002666 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002667 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002668 "Bugreport dir: [%s] "
2669 "Base name: [%s] "
2670 "Suffix: [%s] "
2671 "Log path: [%s] "
2672 "Temporary path: [%s] "
2673 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002674 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2675 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002676
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002677 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2678 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2679 create_parent_dirs(ds.path_.c_str());
2680 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2681 if (ds.zip_file == nullptr) {
2682 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2683 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002684 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002685 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2686 ds.AddTextZipEntry("version.txt", ds.version_);
2687 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002688}
2689
2690/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002691 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002692 * printing zipped file status, etc.
2693 */
2694static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002695 bool do_text_file = !ds.FinishZipFile();
2696 if (do_text_file) {
2697 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002698 }
mhasank2d75c442020-06-11 15:05:25 -07002699
2700 std::string final_path = ds.path_;
2701 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002702 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002703 android::os::CopyFileToFile(ds.path_, final_path);
2704 }
2705
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002706 if (ds.options_->stream_to_socket) {
2707 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2708 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002709 if (do_text_file) {
2710 dprintf(ds.control_socket_fd_,
2711 "FAIL:could not create zip file, check %s "
2712 "for more details\n",
2713 ds.log_path_.c_str());
2714 } else {
mhasank2d75c442020-06-11 15:05:25 -07002715 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002716 }
2717 }
2718}
2719
Nandana Dutt4be45d12018-09-26 15:04:23 +01002720
Nandana Dutt58d72e22018-11-16 10:30:48 +00002721static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2722 switch (mode) {
2723 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2724 return "BUGREPORT_FULL";
2725 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2726 return "BUGREPORT_INTERACTIVE";
2727 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2728 return "BUGREPORT_REMOTE";
2729 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2730 return "BUGREPORT_WEAR";
2731 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2732 return "BUGREPORT_TELEPHONY";
2733 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2734 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002735 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2736 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002737 }
2738}
2739
Paul Changf59c2b72020-03-10 02:08:55 +08002740static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2741 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002742 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2743 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002744 options->bugreport_mode = mode;
2745 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002746 switch (mode) {
2747 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002748 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002749 break;
2750 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002751 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002752 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002753 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002754 break;
2755 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002756 options->do_vibrate = false;
2757 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002758 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002759 break;
2760 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002761 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002762 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002763 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002764 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002765 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002766 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002767 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002768 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002769 break;
2770 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002771 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002772 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002773 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002774 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2775 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002776 }
2777}
2778
Nandana Dutt58d72e22018-11-16 10:30:48 +00002779static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002780 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002781 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002782 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002783 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002784 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002785 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002786 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002787 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002788 options.do_progress_updates, options.bugreport_fd.get(),
2789 options.bugreport_mode_string.c_str(),
2790 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002791}
2792
Nandana Dutt54dbd672019-01-11 12:58:05 +00002793void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2794 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002795 const android::base::unique_fd& screenshot_fd_in,
2796 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002797 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002798 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2799 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002800
Paul Changf59c2b72020-03-10 02:08:55 +08002801 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002802}
2803
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002804Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2805 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002806 int c;
mhasankd451a472020-05-26 18:02:39 -07002807 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002808 switch (c) {
2809 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002810 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002811 case 's': stream_to_socket = true; break;
2812 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002813 case 'v': show_header_only = true; break;
2814 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002815 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 case 'P': do_progress_updates = true; break;
2817 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002818 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002819 case 'V':
2820 case 'd':
2821 case 'z':
2822 // compatibility no-op
2823 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002824 case 'w':
2825 // This was already processed
2826 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002827 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002828 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002829 break;
2830 default:
2831 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002832 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002833 break;
2834 // clang-format on
2835 }
2836 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002837
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002838 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002839 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002840 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002841 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002842 }
2843 }
2844
2845 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2846 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002847
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002848 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002849}
2850
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002851bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002852 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002853 return false;
2854 }
2855
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002856 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002857 return false;
2858 }
2859
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002860 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002861 return false;
2862 }
2863 return true;
2864}
2865
Nandana Dutt197661d2018-11-16 16:40:21 +00002866void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2867 options_ = std::move(options);
2868}
2869
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002870void Dumpstate::Initialize() {
2871 /* gets the sequential id */
2872 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2873 id_ = ++last_id;
2874 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2875}
2876
Nandana Duttd2f5f082019-01-18 17:13:52 +00002877Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2878 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002879 if (listener_ != nullptr) {
2880 switch (status) {
2881 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002882 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002883 break;
2884 case Dumpstate::RunStatus::HELP:
2885 break;
2886 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002887 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002888 break;
2889 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002890 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2891 break;
2892 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2893 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2894 break;
2895 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2896 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002897 break;
2898 }
2899 }
2900 return status;
2901}
2902
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002903void Dumpstate::Cancel() {
2904 CleanupTmpFiles();
2905 android::os::UnlinkAndLogOnError(log_path_);
2906 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2907 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2908 kDumpstateBoardFiles[i]);
2909 }
2910 tombstone_data_.clear();
2911 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002912
2913 // Instead of shutdown the pool, we delete temporary files directly since
2914 // shutdown blocking the call.
2915 if (dump_pool_) {
2916 dump_pool_->deleteTempFiles();
2917 }
2918 if (zip_entry_tasks_) {
2919 zip_entry_tasks_->run(/*do_cancel =*/ true);
2920 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002921}
2922
Nandana Dutt979388e2018-11-30 16:48:55 +00002923/*
2924 * Dumps relevant information to a bugreport based on the given options.
2925 *
2926 * The bugreport can be dumped to a file or streamed to a socket.
2927 *
2928 * How dumping to file works:
2929 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2930 * stderr is redirected a log file.
2931 *
2932 * The temporary bugreport is then populated via printfs, dumping contents of files and
2933 * output of commands to stdout.
2934 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002935 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002936 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002937 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002938 *
mhasank2d75c442020-06-11 15:05:25 -07002939 * Bugreports are first generated in a local directory and later copied to the caller's fd
2940 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002941 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002942Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2943 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002944 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002945 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002946 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002947 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002948 return RunStatus::INVALID_INPUT;
2949 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002950 /* set as high priority, and protect from OOM killer */
2951 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002952
Felipe Lemed071c682016-10-20 16:48:00 -07002953 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002954 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002955 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002956 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002957 } else {
2958 /* fallback to kernels <= 2.6.35 */
2959 oom_adj = fopen("/proc/self/oom_adj", "we");
2960 if (oom_adj) {
2961 fputs("-17", oom_adj);
2962 fclose(oom_adj);
2963 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002964 }
2965
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002966 if (version_ == VERSION_DEFAULT) {
2967 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002968 }
2969
Chris Morin5a50d482022-02-01 17:41:18 -08002970 if (version_ != VERSION_CURRENT) {
2971 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
2972 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002973 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002974 }
2975
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002976 if (options_->show_header_only) {
2977 PrintHeader();
2978 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002979 }
2980
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002981 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2982 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002983
Felipe Leme7447d7c2016-11-03 18:12:22 -07002984 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002985 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002986 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002987 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002988
Sahana Raof35ed432019-07-12 10:47:52 +01002989 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2990 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2991 } else {
2992 // Wake lock will be released automatically on process death
2993 MYLOGD("Wake lock acquired.\n");
2994 }
2995
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002996 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002997
Felipe Lemef0292972016-11-22 13:57:05 -08002998 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002999 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3000 }
3001
Nandana Dutt235c6672019-11-14 15:22:32 +00003002 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003003 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003004
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003005 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003006
Christopher Ferrised9354f2014-10-01 17:35:01 -07003007 // If we are going to use a socket, do it as early as possible
3008 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003009 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003010 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003011 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003012 if (control_socket_fd_ == -1) {
3013 return ERROR;
3014 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003015 if (options_->progress_updates_to_socket) {
3016 options_->do_progress_updates = 1;
3017 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003018 }
3019
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003020 if (!PrepareToWriteToFile()) {
3021 return ERROR;
3022 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003023
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003024 // Interactive, wear & telephony modes are default to true.
3025 // and may enable from cli option or when using control socket
3026 if (options_->do_progress_updates) {
3027 // clang-format off
3028 std::vector<std::string> am_args = {
3029 "--receiver-permission", "android.permission.DUMP",
3030 };
3031 // clang-format on
3032 // Send STARTED broadcast for apps that listen to bugreport generation events
3033 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3034 if (options_->progress_updates_to_socket) {
3035 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003036 }
3037 }
3038
Nick Kralevichf3599b32016-01-25 15:05:16 -08003039 /* read /proc/cmdline before dropping root */
3040 FILE *cmdline = fopen("/proc/cmdline", "re");
3041 if (cmdline) {
3042 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3043 fclose(cmdline);
3044 }
3045
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003046 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003047 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003048 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003049
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003050 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003051 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3052 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003053 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003054 }
3055 }
3056
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003057 int dup_stdout_fd;
3058 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003059 // Redirect stderr to log_path_ for debugging.
3060 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3061 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3062 return ERROR;
3063 }
3064 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3065 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3066 strerror(errno));
3067 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003068
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003069 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3070 // moved into zip file later, if zipping.
3071 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3072 // TODO: why not write to a file instead of stdout to overcome this problem?
3073 /* TODO: rather than generating a text file now and zipping it later,
3074 it would be more efficient to redirect stdout to the zip entry
3075 directly, but the libziparchive doesn't support that option yet. */
3076 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3077 return ERROR;
3078 }
3079 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3080 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3081 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003082 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003083
3084 // Don't buffer stdout
3085 setvbuf(stdout, nullptr, _IONBF, 0);
3086
Rhed Jao5377d792020-07-16 17:37:39 +08003087 // Enable the parallel run if the client requests to output to a file.
3088 EnableParallelRunIfNeeded();
3089 // Using scope guard to make sure the dump pool can be shut down correctly.
3090 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3091 ShutdownDumpPool();
3092 });
3093
Felipe Leme608385d2016-02-01 10:35:38 -08003094 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3095 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003096 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003097 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003098
Gavin Corkery6968f552020-11-22 18:09:05 +00003099 bool is_dumpstate_restricted = options_->telephony_only
3100 || options_->wifi_only
3101 || options_->limited_only;
3102 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003103 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003104 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003105 }
3106 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003107
3108 if (!is_dumpstate_restricted) {
3109 // Snapshot the system trace now (if running) to avoid that dumpstate's
3110 // own activity pushes out interesting data from the trace ring buffer.
3111 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3112 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003113
3114 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3115 // from WMTRACE_DATA_DIR.
3116 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003117 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003118 onUiIntensiveBugreportDumpsFinished(calling_uid);
3119 MaybeCheckUserConsent(calling_uid, calling_package);
3120 if (options_->telephony_only) {
3121 DumpstateTelephonyOnly(calling_package);
3122 } else if (options_->wifi_only) {
3123 DumpstateWifiOnly();
3124 } else if (options_->limited_only) {
3125 DumpstateLimitedOnly();
3126 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003127 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003128 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003129 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003130 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003131 HandleUserConsentDenied();
3132 }
3133 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003134 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003135 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003136
Felipe Leme55b42a62015-11-10 17:39:08 -08003137 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003138 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003139
Abhijeet Kaure370d682019-10-01 16:49:30 +01003140 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003141 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003142 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003143 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003144
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003145 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003146 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003147 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003148 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003149 if (status != Dumpstate::RunStatus::OK &&
3150 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3151 // Do an early return if there were errors. We make an exception for consent
3152 // timing out because it's possible the user got distracted. In this case the
3153 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003154 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003155 return status;
3156 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003157 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3158 MYLOGI(
3159 "Did not receive user consent yet."
3160 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003161 const String16 incidentcompanion("incidentcompanion");
3162 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3163 if (ics != nullptr) {
3164 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3165 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3166 consent_callback_.get());
3167 } else {
3168 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3169 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003170 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003171 }
3172
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003173 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003174 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003175 for (int i = 0; i < 3; i++) {
3176 Vibrate(75);
3177 usleep((75 + 50) * 1000);
3178 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003179 }
3180
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003181 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3182 progress_->GetInitialMax());
3183 progress_->Save();
3184 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003185
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003186 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003187
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003188 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003189 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003190 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003191 }
3192
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003193 tombstone_data_.clear();
3194 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003195
Nandana Duttd2f5f082019-01-18 17:13:52 +00003196 return (consent_callback_ != nullptr &&
3197 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3198 ? USER_CONSENT_TIMED_OUT
3199 : RunStatus::OK;
3200}
3201
Paul Chang0d2aad72020-02-13 20:04:03 +08003202void Dumpstate::MaybeTakeEarlyScreenshot() {
3203 if (!options_->do_screenshot || !do_early_screenshot_) {
3204 return;
3205 }
3206
3207 TakeScreenshot();
3208}
3209
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003210void Dumpstate::MaybeSnapshotSystemTrace() {
3211 // If a background system trace is happening and is marked as "suitable for
3212 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3213 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3214 // case that no trace is ongoing, this command is a no-op.
3215 // Note: this should not be enqueued as we need to freeze the trace before
3216 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3217 // the dumpstate's own activity which is irrelevant.
3218 int res = RunCommand(
3219 "SERIALIZE PERFETTO TRACE",
3220 {"perfetto", "--save-for-bugreport"},
3221 CommandOptions::WithTimeout(10)
3222 .DropRoot()
3223 .CloseAllFileDescriptorsOnExec()
3224 .Build());
3225 has_system_trace_ = res == 0;
3226 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3227 // file in the later stages.
3228}
3229
Yohei Yukawa95305b32021-03-09 07:54:27 -08003230void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003231 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3232 for (const auto& service : {"window", "input_method"}) {
3233 RunCommand(
3234 // Empty name because it's not intended to be classified as a bugreport section.
3235 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3236 "", {"cmd", service, "tracing", "save-for-bugreport"},
3237 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3238 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003239}
3240
Paul Changeb4b4642020-05-28 22:05:47 +08003241void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003242 if (calling_uid == AID_SHELL || !CalledByApi()) {
3243 return;
3244 }
3245 if (listener_ != nullptr) {
3246 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3247 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003248 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003249 }
3250}
3251
Jichao Lie89d9c12019-11-21 19:02:51 -08003252void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3253 if (calling_uid == AID_SHELL || !CalledByApi()) {
3254 // No need to get consent for shell triggered dumpstates, or not through
3255 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003256 return;
3257 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003258 consent_callback_ = new ConsentCallback();
3259 const String16 incidentcompanion("incidentcompanion");
3260 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003261 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003262 if (ics != nullptr) {
3263 MYLOGD("Checking user consent via incidentcompanion service\n");
3264 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003265 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003266 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003267 } else {
3268 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3269 }
3270}
3271
Nandana Dutt5c390032019-03-12 10:52:56 +00003272bool Dumpstate::IsUserConsentDenied() const {
3273 return ds.consent_callback_ != nullptr &&
3274 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3275}
3276
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003277bool Dumpstate::CalledByApi() const {
3278 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3279}
3280
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003281void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003282 android::os::UnlinkAndLogOnError(tmp_path_);
3283 android::os::UnlinkAndLogOnError(screenshot_path_);
3284 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003285 if (dump_traces_path != nullptr) {
3286 android::os::UnlinkAndLogOnError(dump_traces_path);
3287 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003288}
3289
Rhed Jao5377d792020-07-16 17:37:39 +08003290void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003291 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003292 return;
3293 }
3294 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003295 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003296}
3297
3298void Dumpstate::ShutdownDumpPool() {
3299 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003300 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003301 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003302 if (zip_entry_tasks_) {
3303 zip_entry_tasks_->run(/* do_cancel = */true);
3304 zip_entry_tasks_ = nullptr;
3305 }
3306}
3307
3308void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3309 const std::string& entry_path) {
3310 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3311 if (!task_cancelled) {
3312 AddZipEntry(entry_name, entry_path);
3313 }
3314 android::os::UnlinkAndLogOnError(entry_path);
3315 };
3316 if (zip_entry_tasks_) {
3317 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3318 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3319 } else {
3320 // Invokes AddZipEntryAndCleanup immediately
3321 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3322 }
Rhed Jao5377d792020-07-16 17:37:39 +08003323}
3324
Nandana Duttd2f5f082019-01-18 17:13:52 +00003325Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3326 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003327 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003328 return USER_CONSENT_DENIED;
3329}
3330
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003331Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003332 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003333 // user consent (unless the caller is Shell).
3334 UserConsentResult consent_result;
3335 if (calling_uid == AID_SHELL) {
3336 consent_result = UserConsentResult::APPROVED;
3337 } else {
3338 consent_result = consent_callback_->getResult();
3339 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003340 if (consent_result == UserConsentResult::UNAVAILABLE) {
3341 // User has not responded yet.
3342 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003343 // Telephony is a fast report type, particularly on user builds where information may be
3344 // more aggressively limited. To give the user time to read the consent dialog, increase the
3345 // timeout.
3346 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3347 : USER_CONSENT_TIMEOUT_MS;
3348 if (elapsed_ms < timeout_ms) {
3349 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003350 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3351 sleep(delay_seconds);
3352 }
3353 consent_result = consent_callback_->getResult();
3354 }
3355 if (consent_result == UserConsentResult::DENIED) {
3356 // User has explicitly denied sharing with the app. To be safe delete the
3357 // internal bugreport & tmp files.
3358 return HandleUserConsentDenied();
3359 }
3360 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003361 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3362 if (copy_succeeded) {
3363 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003364 if (options_->do_screenshot &&
3365 options_->screenshot_fd.get() != -1 &&
3366 !options_->is_screenshot_copied) {
3367 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3368 options_->screenshot_fd.get());
3369 options_->is_screenshot_copied = copy_succeeded;
3370 if (copy_succeeded) {
3371 android::os::UnlinkAndLogOnError(screenshot_path_);
3372 }
3373 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003374 }
3375 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3376 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3377 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3378 // Since we do not have user consent to share the bugreport it does not get
3379 // copied over to the calling app but remains in the internal directory from
3380 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003381 std::string final_path = GetPath(".zip");
3382 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3383 if (copy_succeeded) {
3384 android::os::UnlinkAndLogOnError(path_);
3385 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003386 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3387 }
3388 // Unknown result; must be a programming error.
3389 MYLOGE("Unknown user consent result:%d\n", consent_result);
3390 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003391}
3392
Nandana Duttf02564e2019-02-15 15:24:24 +00003393Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003394 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3395 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3396 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003397 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003398 // When directly running dumpstate binary, the output is not expected to be written
3399 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003400 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003401
3402 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003403 // an app; they are irrelevant here because bugreport is triggered via command line.
3404 // Update Last ID before calling Run().
3405 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003406 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003407 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003408 return status;
3409}
3410
3411/* Main entry point for dumpstate binary. */
3412int run_main(int argc, char* argv[]) {
3413 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003414
3415 switch (status) {
3416 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003417 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003418 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003419 ShowUsage();
3420 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003421 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003422 fprintf(stderr, "Invalid combination of args\n");
3423 ShowUsage();
3424 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003425 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003426 FALLTHROUGH_INTENDED;
3427 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3428 FALLTHROUGH_INTENDED;
3429 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003430 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003431 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003432}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003433
3434// TODO(111441001): Default DumpOptions to sensible values.
3435Dumpstate::Dumpstate(const std::string& version)
3436 : pid_(getpid()),
3437 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003438 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003439 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003440 now_(time(nullptr)),
3441 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003442}
3443
3444Dumpstate& Dumpstate::GetInstance() {
3445 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3446 return singleton_;
3447}
3448
Rhed Jao5377d792020-07-16 17:37:39 +08003449DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3450 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3451 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003452 if (!title_.empty()) {
3453 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003454 if (title_.find("SHOW MAP") == std::string::npos) {
3455 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3456 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003457 }
3458}
3459
3460DurationReporter::~DurationReporter() {
3461 if (!title_.empty()) {
3462 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003463 if (elapsed >= .5f || verbose_) {
3464 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003465 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003466 if (!logcat_only_) {
3467 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003468 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3469 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003470 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003471 if (title_.find("SHOW MAP") == std::string::npos) {
3472 ATRACE_ASYNC_END(title_.c_str(), 0);
3473 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003474 }
3475}
3476
3477const int32_t Progress::kDefaultMax = 5000;
3478
3479Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3480}
3481
3482Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3483 : Progress(initial_max, growth_factor, "") {
3484 progress_ = progress;
3485}
3486
3487Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3488 : initial_max_(initial_max),
3489 progress_(0),
3490 max_(initial_max),
3491 growth_factor_(growth_factor),
3492 n_runs_(0),
3493 average_max_(0),
3494 path_(path) {
3495 if (!path_.empty()) {
3496 Load();
3497 }
3498}
3499
3500void Progress::Load() {
3501 MYLOGD("Loading stats from %s\n", path_.c_str());
3502 std::string content;
3503 if (!android::base::ReadFileToString(path_, &content)) {
3504 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3505 return;
3506 }
3507 if (content.empty()) {
3508 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3509 return;
3510 }
3511 std::vector<std::string> lines = android::base::Split(content, "\n");
3512
3513 if (lines.size() < 1) {
3514 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3515 (int)lines.size(), max_);
3516 return;
3517 }
3518 char* ptr;
3519 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3520 average_max_ = strtol(ptr, nullptr, 10);
3521 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3522 average_max_ > STATS_MAX_AVERAGE) {
3523 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3524 initial_max_ = Progress::kDefaultMax;
3525 } else {
3526 initial_max_ = average_max_;
3527 }
3528 max_ = initial_max_;
3529
3530 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3531}
3532
3533void Progress::Save() {
3534 int32_t total = n_runs_ * average_max_ + progress_;
3535 int32_t runs = n_runs_ + 1;
3536 int32_t average = floor(((float)total) / runs);
3537 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3538 path_.c_str());
3539 if (path_.empty()) {
3540 return;
3541 }
3542
3543 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3544 if (!android::base::WriteStringToFile(content, path_)) {
3545 MYLOGE("Could not save stats on %s\n", path_.c_str());
3546 }
3547}
3548
3549int32_t Progress::Get() const {
3550 return progress_;
3551}
3552
3553bool Progress::Inc(int32_t delta_sec) {
3554 bool changed = false;
3555 if (delta_sec >= 0) {
3556 progress_ += delta_sec;
3557 if (progress_ > max_) {
3558 int32_t old_max = max_;
3559 max_ = floor((float)progress_ * growth_factor_);
3560 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3561 changed = true;
3562 }
3563 }
3564 return changed;
3565}
3566
3567int32_t Progress::GetMax() const {
3568 return max_;
3569}
3570
3571int32_t Progress::GetInitialMax() const {
3572 return initial_max_;
3573}
3574
3575void Progress::Dump(int fd, const std::string& prefix) const {
3576 const char* pr = prefix.c_str();
3577 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3578 dprintf(fd, "%smax: %d\n", pr, max_);
3579 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3580 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3581 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3582 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3583 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3584}
3585
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003586std::string Dumpstate::GetPath(const std::string& suffix) const {
3587 return GetPath(bugreport_internal_dir_, suffix);
3588}
3589
3590std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3591 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3592 name_.c_str(), suffix.c_str());
3593}
3594
3595void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3596 progress_ = std::move(progress);
3597}
3598
3599void for_each_userid(void (*func)(int), const char *header) {
3600 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3601 "for_each_userid(%s)", header);
3602 DurationReporter duration_reporter(title);
3603 if (PropertiesHelper::IsDryRun()) return;
3604
3605 DIR *d;
3606 struct dirent *de;
3607
3608 if (header) printf("\n------ %s ------\n", header);
3609 func(0);
3610
3611 if (!(d = opendir("/data/system/users"))) {
3612 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3613 return;
3614 }
3615
3616 while ((de = readdir(d))) {
3617 int userid;
3618 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3619 continue;
3620 }
3621 func(userid);
3622 }
3623
3624 closedir(d);
3625}
3626
3627static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3628 DIR *d;
3629 struct dirent *de;
3630
3631 if (!(d = opendir("/proc"))) {
3632 printf("Failed to open /proc (%s)\n", strerror(errno));
3633 return;
3634 }
3635
3636 if (header) printf("\n------ %s ------\n", header);
3637 while ((de = readdir(d))) {
3638 if (ds.IsUserConsentDenied()) {
3639 MYLOGE(
3640 "Returning early because user denied consent to share bugreport with calling app.");
3641 closedir(d);
3642 return;
3643 }
3644 int pid;
3645 int fd;
3646 char cmdpath[255];
3647 char cmdline[255];
3648
3649 if (!(pid = atoi(de->d_name))) {
3650 continue;
3651 }
3652
3653 memset(cmdline, 0, sizeof(cmdline));
3654
3655 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3656 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3657 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3658 close(fd);
3659 if (cmdline[0]) {
3660 helper(pid, cmdline, arg);
3661 continue;
3662 }
3663 }
3664
3665 // if no cmdline, a kernel thread has comm
3666 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3667 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3668 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3669 close(fd);
3670 if (cmdline[1]) {
3671 cmdline[0] = '[';
3672 size_t len = strcspn(cmdline, "\f\b\r\n");
3673 cmdline[len] = ']';
3674 cmdline[len+1] = '\0';
3675 }
3676 }
3677 if (!cmdline[0]) {
3678 strcpy(cmdline, "N/A");
3679 }
3680 helper(pid, cmdline, arg);
3681 }
3682
3683 closedir(d);
3684}
3685
3686static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3687 for_each_pid_func *func = (for_each_pid_func*) arg;
3688 func(pid, cmdline);
3689}
3690
3691void for_each_pid(for_each_pid_func func, const char *header) {
3692 std::string title = header == nullptr ? "for_each_pid"
3693 : android::base::StringPrintf("for_each_pid(%s)", header);
3694 DurationReporter duration_reporter(title);
3695 if (PropertiesHelper::IsDryRun()) return;
3696
3697 __for_each_pid(for_each_pid_helper, header, (void *) func);
3698}
3699
3700static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3701 DIR *d;
3702 struct dirent *de;
3703 char taskpath[255];
3704 for_each_tid_func *func = (for_each_tid_func *) arg;
3705
3706 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3707
3708 if (!(d = opendir(taskpath))) {
3709 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3710 return;
3711 }
3712
3713 func(pid, pid, cmdline);
3714
3715 while ((de = readdir(d))) {
3716 if (ds.IsUserConsentDenied()) {
3717 MYLOGE(
3718 "Returning early because user denied consent to share bugreport with calling app.");
3719 closedir(d);
3720 return;
3721 }
3722 int tid;
3723 int fd;
3724 char commpath[255];
3725 char comm[255];
3726
3727 if (!(tid = atoi(de->d_name))) {
3728 continue;
3729 }
3730
3731 if (tid == pid)
3732 continue;
3733
3734 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3735 memset(comm, 0, sizeof(comm));
3736 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3737 strcpy(comm, "N/A");
3738 } else {
3739 char *c;
3740 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3741 close(fd);
3742
3743 c = strrchr(comm, '\n');
3744 if (c) {
3745 *c = '\0';
3746 }
3747 }
3748 func(pid, tid, comm);
3749 }
3750
3751 closedir(d);
3752}
3753
3754void for_each_tid(for_each_tid_func func, const char *header) {
3755 std::string title = header == nullptr ? "for_each_tid"
3756 : android::base::StringPrintf("for_each_tid(%s)", header);
3757 DurationReporter duration_reporter(title);
3758
3759 if (PropertiesHelper::IsDryRun()) return;
3760
3761 __for_each_pid(for_each_tid_helper, header, (void *) func);
3762}
3763
3764void show_wchan(int pid, int tid, const char *name) {
3765 if (PropertiesHelper::IsDryRun()) return;
3766
3767 char path[255];
3768 char buffer[255];
3769 int fd, ret, save_errno;
3770 char name_buffer[255];
3771
3772 memset(buffer, 0, sizeof(buffer));
3773
3774 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3775 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3776 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3777 return;
3778 }
3779
3780 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3781 save_errno = errno;
3782 close(fd);
3783
3784 if (ret < 0) {
3785 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3786 return;
3787 }
3788
3789 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3790 pid == tid ? 0 : 3, "", name);
3791
3792 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3793
3794 return;
3795}
3796
3797// print time in centiseconds
3798static void snprcent(char *buffer, size_t len, size_t spc,
3799 unsigned long long time) {
3800 static long hz; // cache discovered hz
3801
3802 if (hz <= 0) {
3803 hz = sysconf(_SC_CLK_TCK);
3804 if (hz <= 0) {
3805 hz = 1000;
3806 }
3807 }
3808
3809 // convert to centiseconds
3810 time = (time * 100 + (hz / 2)) / hz;
3811
3812 char str[16];
3813
3814 snprintf(str, sizeof(str), " %llu.%02u",
3815 time / 100, (unsigned)(time % 100));
3816 size_t offset = strlen(buffer);
3817 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3818 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3819}
3820
3821// print permille as a percent
3822static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3823 char str[16];
3824
3825 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3826 size_t offset = strlen(buffer);
3827 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3828 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3829}
3830
3831void show_showtime(int pid, const char *name) {
3832 if (PropertiesHelper::IsDryRun()) return;
3833
3834 char path[255];
3835 char buffer[1023];
3836 int fd, ret, save_errno;
3837
3838 memset(buffer, 0, sizeof(buffer));
3839
3840 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3841 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3842 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3843 return;
3844 }
3845
3846 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3847 save_errno = errno;
3848 close(fd);
3849
3850 if (ret < 0) {
3851 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3852 return;
3853 }
3854
3855 // field 14 is utime
3856 // field 15 is stime
3857 // field 42 is iotime
3858 unsigned long long utime = 0, stime = 0, iotime = 0;
3859 if (sscanf(buffer,
3860 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3861 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3862 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3863 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3864 &utime, &stime, &iotime) != 3) {
3865 return;
3866 }
3867
3868 unsigned long long total = utime + stime;
3869 if (!total) {
3870 return;
3871 }
3872
3873 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3874 if (permille > 1000) {
3875 permille = 1000;
3876 }
3877
3878 // try to beautify and stabilize columns at <80 characters
3879 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3880 if ((name[0] != '[') || utime) {
3881 snprcent(buffer, sizeof(buffer), 57, utime);
3882 }
3883 snprcent(buffer, sizeof(buffer), 65, stime);
3884 if ((name[0] != '[') || iotime) {
3885 snprcent(buffer, sizeof(buffer), 73, iotime);
3886 }
3887 if (iotime) {
3888 snprdec(buffer, sizeof(buffer), 79, permille);
3889 }
3890 puts(buffer); // adds a trailing newline
3891
3892 return;
3893}
3894
3895void do_dmesg() {
3896 const char *title = "KERNEL LOG (dmesg)";
3897 DurationReporter duration_reporter(title);
3898 printf("------ %s ------\n", title);
3899
3900 if (PropertiesHelper::IsDryRun()) return;
3901
3902 /* Get size of kernel buffer */
3903 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3904 if (size <= 0) {
3905 printf("Unexpected klogctl return value: %d\n\n", size);
3906 return;
3907 }
3908 char *buf = (char *) malloc(size + 1);
3909 if (buf == nullptr) {
3910 printf("memory allocation failed\n\n");
3911 return;
3912 }
3913 int retval = klogctl(KLOG_READ_ALL, buf, size);
3914 if (retval < 0) {
3915 printf("klogctl failure\n\n");
3916 free(buf);
3917 return;
3918 }
3919 buf[retval] = '\0';
3920 printf("%s\n\n", buf);
3921 free(buf);
3922 return;
3923}
3924
3925void do_showmap(int pid, const char *name) {
3926 char title[255];
3927 char arg[255];
3928
3929 snprintf(title, sizeof(title), "SHOW MAP %d (%s)", pid, name);
3930 snprintf(arg, sizeof(arg), "%d", pid);
3931 RunCommand(title, {"showmap", "-q", arg}, CommandOptions::AS_ROOT);
3932}
3933
3934int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3935 DurationReporter duration_reporter(title);
3936
3937 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3938
3939 UpdateProgress(WEIGHT_FILE);
3940
3941 return status;
3942}
3943
3944int read_file_as_long(const char *path, long int *output) {
3945 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3946 if (fd < 0) {
3947 int err = errno;
3948 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3949 return -1;
3950 }
3951 char buffer[50];
3952 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3953 if (bytes_read == -1) {
3954 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3955 return -2;
3956 }
3957 if (bytes_read == 0) {
3958 MYLOGE("File %s is empty\n", path);
3959 return -3;
3960 }
3961 *output = atoi(buffer);
3962 return 0;
3963}
3964
3965/* calls skip to gate calling dump_from_fd recursively
3966 * in the specified directory. dump_from_fd defaults to
3967 * dump_file_from_fd above when set to NULL. skip defaults
3968 * to false when set to NULL. dump_from_fd will always be
3969 * called with title NULL.
3970 */
3971int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3972 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3973 DurationReporter duration_reporter(title);
3974 DIR *dirp;
3975 struct dirent *d;
3976 char *newpath = nullptr;
3977 const char *slash = "/";
3978 int retval = 0;
3979
3980 if (!title.empty()) {
3981 printf("------ %s (%s) ------\n", title.c_str(), dir);
3982 }
3983 if (PropertiesHelper::IsDryRun()) return 0;
3984
3985 if (dir[strlen(dir) - 1] == '/') {
3986 ++slash;
3987 }
3988 dirp = opendir(dir);
3989 if (dirp == nullptr) {
3990 retval = -errno;
3991 MYLOGE("%s: %s\n", dir, strerror(errno));
3992 return retval;
3993 }
3994
3995 if (!dump_from_fd) {
3996 dump_from_fd = dump_file_from_fd;
3997 }
3998 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3999 if ((d->d_name[0] == '.')
4000 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4001 || (d->d_name[1] == '\0'))) {
4002 continue;
4003 }
4004 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4005 (d->d_type == DT_DIR) ? "/" : "");
4006 if (!newpath) {
4007 retval = -errno;
4008 continue;
4009 }
4010 if (skip && (*skip)(newpath)) {
4011 continue;
4012 }
4013 if (d->d_type == DT_DIR) {
4014 int ret = dump_files("", newpath, skip, dump_from_fd);
4015 if (ret < 0) {
4016 retval = ret;
4017 }
4018 continue;
4019 }
4020 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4021 if (fd.get() < 0) {
4022 retval = -1;
4023 printf("*** %s: %s\n", newpath, strerror(errno));
4024 continue;
4025 }
4026 (*dump_from_fd)(nullptr, newpath, fd.get());
4027 }
4028 closedir(dirp);
4029 if (!title.empty()) {
4030 printf("\n");
4031 }
4032 return retval;
4033}
4034
4035/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4036 * it's possible to avoid issues where opening the file itself can get
4037 * stuck.
4038 */
4039int dump_file_from_fd(const char *title, const char *path, int fd) {
4040 if (PropertiesHelper::IsDryRun()) return 0;
4041
4042 int flags = fcntl(fd, F_GETFL);
4043 if (flags == -1) {
4044 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4045 return -1;
4046 } else if (!(flags & O_NONBLOCK)) {
4047 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4048 return -1;
4049 }
4050 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4051}
4052
4053int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004054 const CommandOptions& options, bool verbose_duration, int out_fd) {
4055 DurationReporter duration_reporter(title, false /* logcat_only */,
4056 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004057
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004058 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004059
4060 /* TODO: for now we're simplifying the progress calculation by using the
4061 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4062 * where its weight should be much higher proportionally to its timeout.
4063 * Ideally, it should use a options.EstimatedDuration() instead...*/
4064 UpdateProgress(options.Timeout());
4065
4066 return status;
4067}
4068
4069void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004070 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004071 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4072 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4073 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004074 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004075}
4076
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004077static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004078 int s = android_get_control_socket(service);
4079 if (s < 0) {
4080 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4081 return -1;
4082 }
4083 fcntl(s, F_SETFD, FD_CLOEXEC);
4084
4085 // Set backlog to 0 to make sure that queue size will be minimum.
4086 // In Linux, because the minimum queue will be 1, connect() will be blocked
4087 // if the other clients already called connect() and the connection request was not accepted.
4088 if (listen(s, 0) < 0) {
4089 MYLOGE("listen(control socket): %s\n", strerror(errno));
4090 return -1;
4091 }
4092
4093 struct sockaddr addr;
4094 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004095 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004096
4097 // Close socket just after accept(), to make sure that connect() by client will get error
4098 // when the socket is used by the other services.
4099 // There is still a race condition possibility between accept and close, but there is no way
4100 // to close-on-accept atomically.
4101 // See detail; b/123306389#comment25
4102 close(s);
4103
4104 if (fd < 0) {
4105 MYLOGE("accept(control socket): %s\n", strerror(errno));
4106 return -1;
4107 }
4108
4109 return fd;
4110}
4111
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004112// TODO: should call is_valid_output_file and/or be merged into it.
4113void create_parent_dirs(const char *path) {
4114 char *chp = const_cast<char *> (path);
4115
4116 /* skip initial slash */
4117 if (chp[0] == '/')
4118 chp++;
4119
4120 /* create leading directories, if necessary */
4121 struct stat dir_stat;
4122 while (chp && chp[0]) {
4123 chp = strchr(chp, '/');
4124 if (chp) {
4125 *chp = 0;
4126 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4127 MYLOGI("Creating directory %s\n", path);
4128 if (mkdir(path, 0770)) { /* drwxrwx--- */
4129 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4130 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4131 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4132 }
4133 }
4134 *chp++ = '/';
4135 }
4136 }
4137}
4138
4139bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4140 create_parent_dirs(path);
4141
4142 int fd = TEMP_FAILURE_RETRY(open(path,
4143 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4144 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4145 if (fd < 0) {
4146 MYLOGE("%s: %s\n", path, strerror(errno));
4147 return false;
4148 }
4149
4150 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4151 close(fd);
4152 return true;
4153}
4154
4155bool redirect_to_file(FILE* redirect, char* path) {
4156 return _redirect_to_file(redirect, path, O_TRUNC);
4157}
4158
4159bool redirect_to_existing_file(FILE* redirect, char* path) {
4160 return _redirect_to_file(redirect, path, O_APPEND);
4161}
4162
4163void dump_route_tables() {
4164 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4165 if (PropertiesHelper::IsDryRun()) return;
4166 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4167 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4168 FILE* fp = fopen(RT_TABLES_PATH, "re");
4169 if (!fp) {
4170 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4171 return;
4172 }
4173 char table[16];
4174 // Each line has an integer (the table number), a space, and a string (the table name). We only
4175 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4176 // Add a fixed max limit so this doesn't go awry.
4177 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4178 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4179 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4180 }
4181 fclose(fp);
4182}
4183
Li Li830179f2022-01-04 12:53:29 -08004184void dump_frozen_cgroupfs(const char *dir, int level,
4185 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4186 DIR *dirp;
4187 struct dirent *d;
4188 char *newpath = nullptr;
4189
4190 dirp = opendir(dir);
4191 if (dirp == nullptr) {
4192 MYLOGE("%s: %s\n", dir, strerror(errno));
4193 return;
4194 }
4195
4196 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4197 if ((d->d_name[0] == '.')
4198 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4199 || (d->d_name[1] == '\0'))) {
4200 continue;
4201 }
4202 if (d->d_type == DT_DIR) {
4203 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4204 if (!newpath) {
4205 continue;
4206 }
4207 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4208 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4209 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4210 char *freezer = nullptr;
4211 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4212 if (freezer) {
4213 FILE* fp = fopen(freezer, "r");
4214 if (fp != NULL) {
4215 int frozen;
4216 fscanf(fp, "%d", &frozen);
4217 if (frozen > 0) {
4218 dump_files("", newpath, skip_none, dump_from_fd);
4219 }
4220 fclose(fp);
4221 }
4222 free(freezer);
4223 }
4224 }
4225 }
4226 }
4227 closedir(dirp);
4228}
4229
4230void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004231 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4232 DurationReporter duration_reporter("FROZEN CGROUPFS");
4233 if (PropertiesHelper::IsDryRun()) return;
4234 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4235}
4236
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004237void Dumpstate::UpdateProgress(int32_t delta_sec) {
4238 if (progress_ == nullptr) {
4239 MYLOGE("UpdateProgress: progress_ not set\n");
4240 return;
4241 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004242 // This function updates progress related members of the dumpstate and reports
4243 // progress percentage to the bugreport client. Since it could be called by
4244 // different dump tasks at the same time if the parallel run is enabled, a
4245 // mutex lock is necessary here to synchronize the call.
4246 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004247
4248 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004249 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004250
4251 // ...but only notifiy listeners when necessary.
4252 if (!options_->do_progress_updates) return;
4253
4254 int progress = progress_->Get();
4255 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004256 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004257
Nandana Dutt402a8392019-06-14 14:25:13 +01004258 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004259 return;
4260 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004261 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004262
4263 if (control_socket_fd_ >= 0) {
4264 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4265 fsync(control_socket_fd_);
4266 }
4267
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004268 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004269 if (percent % 10 == 0) {
4270 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004271 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004272 } else {
4273 // stderr is ignored on normal invocations, but useful when calling
4274 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004275 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004276 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004277
4278 listener_->onProgress(percent);
4279 }
4280}
4281
4282void Dumpstate::TakeScreenshot(const std::string& path) {
4283 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4284 int status =
4285 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4286 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4287 if (status == 0) {
4288 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4289 } else {
4290 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4291 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004292 if (listener_ != nullptr) {
4293 // Show a visual indication to indicate screenshot is taken via
4294 // IDumpstateListener.onScreenshotTaken()
4295 listener_->onScreenshotTaken(status == 0);
4296 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004297}
4298
4299bool is_dir(const char* pathname) {
4300 struct stat info;
4301 if (stat(pathname, &info) == -1) {
4302 return false;
4303 }
4304 return S_ISDIR(info.st_mode);
4305}
4306
4307time_t get_mtime(int fd, time_t default_mtime) {
4308 struct stat info;
4309 if (fstat(fd, &info) == -1) {
4310 return default_mtime;
4311 }
4312 return info.st_mtime;
4313}