blob: ee1c63a3ff717b87f9704e858a26907e691676c2 [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"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700173#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700174#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800175#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100176#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
177#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800178#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900179#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800180#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700181#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800182#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900183#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700184#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000185#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700186#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200187#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700188
Narayan Kamath8f788292017-05-25 13:20:39 +0100189// TODO(narayan): Since this information has to be kept in sync
190// with tombstoned, we should just put it in a common header.
191//
192// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100193static const std::string TOMBSTONE_DIR = "/data/tombstones/";
194static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
195static const std::string ANR_DIR = "/data/anr/";
196static const std::string ANR_FILE_PREFIX = "anr_";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700197
Felipe Lemee844a9d2016-09-21 15:01:39 -0700198// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000199
Nandana Dutt5c390032019-03-12 10:52:56 +0000200#define RETURN_IF_USER_DENIED_CONSENT() \
201 if (ds.IsUserConsentDenied()) { \
202 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
203 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
204 }
205
206// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
207// if consent is found to be denied.
208#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
209 RETURN_IF_USER_DENIED_CONSENT(); \
210 func_ptr(__VA_ARGS__); \
211 RETURN_IF_USER_DENIED_CONSENT();
212
Rhed Jao5377d792020-07-16 17:37:39 +0800213// Runs func_ptr, and logs a duration report after it's finished.
214#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
215 { \
216 DurationReporter duration_reporter_in_macro(log_title); \
217 func_ptr(__VA_ARGS__); \
218 }
219
220// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
221// is output after a slow function is finished.
222#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
223 RETURN_IF_USER_DENIED_CONSENT(); \
224 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
225 RETURN_IF_USER_DENIED_CONSENT();
226
Chris Morinbc223142022-02-04 14:17:11 -0800227#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800228 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800229 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800230 RETURN_IF_USER_DENIED_CONSENT();
231
Sahana Raof35ed432019-07-12 10:47:52 +0100232static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
233
Rhed Jao5377d792020-07-16 17:37:39 +0800234// Names of parallel tasks, they are used for the DumpPool to identify the dump
235// task and the log title of the duration report.
236static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800237static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800238static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800239static const std::string DUMP_HALS_TASK = "DUMP HALS";
240static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800241static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800242
Nandana Dutt979388e2018-11-30 16:48:55 +0000243namespace android {
244namespace os {
245namespace {
246
247static int Open(std::string path, int flags, mode_t mode = 0) {
248 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
249 if (fd == -1) {
250 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
251 }
252 return fd;
253}
254
mhasank2d75c442020-06-11 15:05:25 -0700255static int OpenForWrite(std::string path) {
256 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
257 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
258}
Nandana Dutt979388e2018-11-30 16:48:55 +0000259
260static int OpenForRead(std::string path) {
261 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
262}
263
264bool CopyFile(int in_fd, int out_fd) {
265 char buf[4096];
266 ssize_t byte_count;
267 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
268 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
269 return false;
270 }
271 }
272 return (byte_count != -1);
273}
274
275static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000276 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000277
278 // Obtain a handle to the source file.
279 android::base::unique_fd in_fd(OpenForRead(input_file));
280 if (out_fd != -1 && in_fd.get() != -1) {
281 if (CopyFile(in_fd.get(), out_fd)) {
282 return true;
283 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000284 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000285 }
286 return false;
287}
288
Nandana Duttd2f5f082019-01-18 17:13:52 +0000289static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000290 if (file.empty()) {
291 return false;
292 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000293 if (unlink(file.c_str())) {
294 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000295 return false;
296 }
297 return true;
298}
Nandana Dutt979388e2018-11-30 16:48:55 +0000299
Nikita Ioffea325a572019-05-16 19:49:47 +0100300int64_t GetModuleMetadataVersion() {
301 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
302 if (binder == nullptr) {
303 MYLOGE("Failed to retrieve package_native service");
304 return 0L;
305 }
306 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
307 std::string package_name;
308 auto status = package_service->getModuleMetadataPackageName(&package_name);
309 if (!status.isOk()) {
310 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
311 return 0L;
312 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100313 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100314 int64_t version_code;
315 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
316 &version_code);
317 if (!status.isOk()) {
318 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
319 return 0L;
320 }
321 return version_code;
322}
323
mhasank2d75c442020-06-11 15:05:25 -0700324static bool PathExists(const std::string& path) {
325 struct stat sb;
326 return stat(path.c_str(), &sb) == 0;
327}
328
329static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
330 if (input_file == output_file) {
331 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
332 output_file.c_str());
333 return false;
334 }
335 else if (PathExists(output_file)) {
336 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
337 return false;
338 }
339
340 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
341 android::base::unique_fd out_fd(OpenForWrite(output_file));
342 return CopyFileToFd(input_file, out_fd.get());
343}
344
Nandana Dutt979388e2018-11-30 16:48:55 +0000345} // namespace
346} // namespace os
347} // namespace android
348
Felipe Leme678727a2016-09-21 17:22:11 -0700349static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800350 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800351 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
352 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
353}
354static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
355 int out_fd) {
356 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700357}
358static int DumpFile(const std::string& title, const std::string& path) {
359 return ds.DumpFile(title, path);
360}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800361
Felipe Lemee844a9d2016-09-21 15:01:39 -0700362// Relative directory (inside the zip) for all files copied as-is into the bugreport.
363static const std::string ZIP_ROOT_DIR = "FS";
364
Vishnu Naire97d6122018-01-18 13:58:56 -0800365static const std::string kProtoPath = "proto/";
366static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700367static const std::string kDumpstateBoardFiles[] = {
368 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700369 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700370};
371static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
372
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700373static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700374static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700375
Felipe Lemef0292972016-11-22 13:57:05 -0800376static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
377
Narayan Kamath8f788292017-05-25 13:20:39 +0100378/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100379 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800380 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800381 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100382 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700383static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800384 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100385 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100386
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700387 if (dump_dir == nullptr) {
388 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700389 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700390 }
391
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700392 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100393 struct dirent* entry = nullptr;
394 while ((entry = readdir(dump_dir.get()))) {
395 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100396 continue;
397 }
398
Narayan Kamathbd863722017-06-01 18:50:12 +0100399 const std::string base_name(entry->d_name);
400 if (base_name.find(file_prefix) != 0) {
401 continue;
402 }
403
404 const std::string abs_path = dir_path + base_name;
405 android::base::unique_fd fd(
406 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
407 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700408 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100409 break;
410 }
411
412 struct stat st = {};
413 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700414 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100415 continue;
416 }
417
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700418 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700419 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800420 if (!dump_data.empty()) {
421 std::sort(dump_data.begin(), dump_data.end(),
422 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
423 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100424
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700425 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100426}
427
Narayan Kamathbd863722017-06-01 18:50:12 +0100428static bool AddDumps(const std::vector<DumpData>::const_iterator start,
429 const std::vector<DumpData>::const_iterator end,
430 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100431 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100432 for (auto it = start; it != end; ++it) {
433 const std::string& name = it->name;
434 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100435 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100436
437 // Seek to the beginning of the file before dumping any data. A given
438 // DumpData entry might be dumped multiple times in the report.
439 //
440 // For example, the most recent ANR entry is dumped to the body of the
441 // main entry and it also shows up as a separate entry in the bugreport
442 // ZIP file.
443 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
444 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
445 strerror(errno));
446 }
447
Chris Morinc2cba7a2022-02-01 17:06:50 -0800448 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800449 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100450 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100451 }
452 } else {
453 dump_file_from_fd(type_name, name.c_str(), fd);
454 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100455 }
456
457 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700458}
459
Felipe Leme635ca312016-01-05 14:23:02 -0800460// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700461void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800462 char path[PATH_MAX];
463
464 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
465 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700466 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800467 char linkname[PATH_MAX];
468 ssize_t r = readlink(path, linkname, PATH_MAX);
469 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800470 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800471 return;
472 }
473 linkname[r] = '\0';
474
475 if (mount_points.find(linkname) == mount_points.end()) {
476 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700477 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700478 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800479 mount_points.insert(linkname);
480 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800481 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800482 }
483 }
484}
485
486void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700487 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800488 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800489 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700490 for_each_pid(do_mountinfo, nullptr);
491 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800492}
493
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700494static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
495{
496 DIR *d;
497 struct dirent *de;
498 char path[PATH_MAX];
499
500 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700501 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700502 return;
503 }
504
505 while ((de = readdir(d))) {
506 if (de->d_type != DT_LNK) {
507 continue;
508 }
509 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700510 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700511 }
512
513 closedir(d);
514}
515
Mark Salyzyn326842f2015-04-30 09:49:41 -0700516static bool skip_not_stat(const char *path) {
517 static const char stat[] = "/stat";
518 size_t len = strlen(path);
519 if (path[len - 1] == '/') { /* Directory? */
520 return false;
521 }
522 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
523}
524
Felipe Leme4c2d6632016-09-28 14:32:00 -0700525static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800526 return false;
527}
528
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700529unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700530
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800531//
532// stat offsets
533// Name units description
534// ---- ----- -----------
535// read I/Os requests number of read I/Os processed
536#define __STAT_READ_IOS 0
537// read merges requests number of read I/Os merged with in-queue I/O
538#define __STAT_READ_MERGES 1
539// read sectors sectors number of sectors read
540#define __STAT_READ_SECTORS 2
541// read ticks milliseconds total wait time for read requests
542#define __STAT_READ_TICKS 3
543// write I/Os requests number of write I/Os processed
544#define __STAT_WRITE_IOS 4
545// write merges requests number of write I/Os merged with in-queue I/O
546#define __STAT_WRITE_MERGES 5
547// write sectors sectors number of sectors written
548#define __STAT_WRITE_SECTORS 6
549// write ticks milliseconds total wait time for write requests
550#define __STAT_WRITE_TICKS 7
551// in_flight requests number of I/Os currently in flight
552#define __STAT_IN_FLIGHT 8
553// io_ticks milliseconds total time this block device has been active
554#define __STAT_IO_TICKS 9
555// time_in_queue milliseconds total wait time for all requests
556#define __STAT_IN_QUEUE 10
557#define __STAT_NUMBER_FIELD 11
558//
559// read I/Os, write I/Os
560// =====================
561//
562// These values increment when an I/O request completes.
563//
564// read merges, write merges
565// =========================
566//
567// These values increment when an I/O request is merged with an
568// already-queued I/O request.
569//
570// read sectors, write sectors
571// ===========================
572//
573// These values count the number of sectors read from or written to this
574// block device. The "sectors" in question are the standard UNIX 512-byte
575// sectors, not any device- or filesystem-specific block size. The
576// counters are incremented when the I/O completes.
577#define SECTOR_SIZE 512
578//
579// read ticks, write ticks
580// =======================
581//
582// These values count the number of milliseconds that I/O requests have
583// waited on this block device. If there are multiple I/O requests waiting,
584// these values will increase at a rate greater than 1000/second; for
585// example, if 60 read requests wait for an average of 30 ms, the read_ticks
586// field will increase by 60*30 = 1800.
587//
588// in_flight
589// =========
590//
591// This value counts the number of I/O requests that have been issued to
592// the device driver but have not yet completed. It does not include I/O
593// requests that are in the queue but not yet issued to the device driver.
594//
595// io_ticks
596// ========
597//
598// This value counts the number of milliseconds during which the device has
599// had I/O requests queued.
600//
601// time_in_queue
602// =============
603//
604// This value counts the number of milliseconds that I/O requests have waited
605// on this block device. If there are multiple I/O requests waiting, this
606// value will increase as the product of the number of milliseconds times the
607// number of requests waiting (see "read ticks" above for an example).
608#define S_TO_MS 1000
609//
610
Mark Salyzyn326842f2015-04-30 09:49:41 -0700611static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800612 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700614 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700616 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700617 getline(&buffer, &i, fp);
618 fclose(fp);
619 if (!buffer) {
620 return -errno;
621 }
622 i = strlen(buffer);
623 while ((i > 0) && (buffer[i - 1] == '\n')) {
624 buffer[--i] = '\0';
625 }
626 if (!*buffer) {
627 free(buffer);
628 return 0;
629 }
630 z = true;
631 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800632 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700633 if (fields[i] != 0) {
634 z = false;
635 }
636 }
637 if (z) { /* never accessed */
638 free(buffer);
639 return 0;
640 }
641
Wei Wang509bb5d2017-06-09 14:42:12 -0700642 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
643 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700644 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700645
646 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
647 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
648 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700649 free(buffer);
650
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800651 if (fields[__STAT_IO_TICKS]) {
652 unsigned long read_perf = 0;
653 unsigned long read_ios = 0;
654 if (fields[__STAT_READ_TICKS]) {
655 unsigned long long divisor = fields[__STAT_READ_TICKS]
656 * fields[__STAT_IO_TICKS];
657 read_perf = ((unsigned long long)SECTOR_SIZE
658 * fields[__STAT_READ_SECTORS]
659 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
660 / divisor;
661 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
662 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
663 / divisor;
664 }
665
666 unsigned long write_perf = 0;
667 unsigned long write_ios = 0;
668 if (fields[__STAT_WRITE_TICKS]) {
669 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
670 * fields[__STAT_IO_TICKS];
671 write_perf = ((unsigned long long)SECTOR_SIZE
672 * fields[__STAT_WRITE_SECTORS]
673 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
674 / divisor;
675 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 }
679
680 unsigned queue = (fields[__STAT_IN_QUEUE]
681 + (fields[__STAT_IO_TICKS] >> 1))
682 / fields[__STAT_IO_TICKS];
683
684 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700685 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 -0800686 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700687 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 -0800688 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800689 }
690
691 /* bugreport timeout factor adjustment */
692 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
693 worst_write_perf = write_perf;
694 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700695 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700696 return 0;
697}
698
Yao Chenbe3bbc12018-01-17 16:31:10 -0800699static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
700
Tom Cherryf4472f32020-08-05 09:31:17 -0700701// Returns the actual readable size of the given buffer or -1 on error.
702static long logcat_buffer_readable_size(const std::string& buffer) {
703 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
704 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
705 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
706
707 return android_logger_get_log_readable_size(logger);
708}
709
710// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
712 unsigned long timeout_ms = 0;
713 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700714 long readable_size = logcat_buffer_readable_size(buffer);
715 if (readable_size > 0) {
716 // Engineering margin is ten-fold our guess.
717 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
718 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800719 }
720 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700721}
722
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800723// Opens a socket and returns its file descriptor.
724static int open_socket(const char* service);
725
Nandana Duttd2f5f082019-01-18 17:13:52 +0000726Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
727}
728
729android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
730 std::lock_guard<std::mutex> lock(lock_);
731 result_ = APPROVED;
732 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800733
734 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
735 // consent is granted.
736 if (ds.options_->is_screenshot_copied) {
737 return android::binder::Status::ok();
738 }
739
740 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
741 !ds.do_early_screenshot_) {
742 return android::binder::Status::ok();
743 }
744
745 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
746 ds.options_->screenshot_fd.get());
747 ds.options_->is_screenshot_copied = copy_succeeded;
748 if (copy_succeeded) {
749 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
750 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000751 return android::binder::Status::ok();
752}
753
754android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
755 std::lock_guard<std::mutex> lock(lock_);
756 result_ = DENIED;
757 MYLOGW("User denied consent to share bugreport\n");
758 return android::binder::Status::ok();
759}
760
761UserConsentResult Dumpstate::ConsentCallback::getResult() {
762 std::lock_guard<std::mutex> lock(lock_);
763 return result_;
764}
765
766uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800767 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000768}
769
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700770void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200771 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700772 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700773
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700774 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
775 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700776 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
777 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
778 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200779 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700780 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700781
Felipe Lemed8b94e52016-12-08 10:21:44 -0800782 printf("========================================================\n");
783 printf("== dumpstate: %s\n", date);
784 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Lemed8b94e52016-12-08 10:21:44 -0800786 printf("\n");
787 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800789 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
790 printf("Bootloader: %s\n", bootloader.c_str());
791 printf("Radio: %s\n", radio.c_str());
792 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100793 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
794 if (module_metadata_version != 0) {
795 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
796 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200797 printf("Android SDK version: %s\n", sdkversion.c_str());
798 printf("SDK extensions: ");
799 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
800 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700801
Felipe Lemed8b94e52016-12-08 10:21:44 -0800802 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800803 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800804 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800805 printf("Uptime: ");
806 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
807 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800808 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800809 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
810 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000811 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800812 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800813}
814
Felipe Leme24b66ee2016-06-16 10:55:26 -0700815// List of file extensions that can cause a zip file attachment to be rejected by some email
816// service providers.
817static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
818 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
819 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
820 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
821};
822
Vishnu Naire97d6122018-01-18 13:58:56 -0800823status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
824 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700825 std::string valid_name = entry_name;
826
827 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700828 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700829 if (idx != std::string::npos) {
830 std::string extension = entry_name.substr(idx);
831 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
832 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
833 valid_name = entry_name + ".renamed";
834 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
835 }
836 }
837
Felipe Leme6fe9db62016-02-12 09:04:16 -0800838 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
839 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000840 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
841 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700842 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700843 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700844 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700845 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800846 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800847 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000848 bool finished_entry = false;
849 auto finish_entry = [this, &finished_entry] {
850 if (!finished_entry) {
851 // This should only be called when we're going to return an earlier error,
852 // which would've been logged. This may imply the file is already corrupt
853 // and any further logging from FinishEntry is more likely to mislead than
854 // not.
855 this->zip_writer_->FinishEntry();
856 }
857 };
858 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800859 auto start = std::chrono::steady_clock::now();
860 auto end = start + timeout;
861 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800862
Felipe Leme770410d2016-01-26 17:07:14 -0800863 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800864 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800865 if (timeout.count() > 0) {
866 // lambda to recalculate the timeout.
867 auto time_left_ms = [end]() {
868 auto now = std::chrono::steady_clock::now();
869 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
870 return std::max(diff.count(), 0LL);
871 };
872
873 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
874 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000875 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
876 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800877 return -errno;
878 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000879 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800880 entry_name.c_str(), strerror(errno), timeout.count());
881 return TIMED_OUT;
882 }
883 }
884
Zach Riggle22200402016-08-18 01:01:24 -0400885 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800886 if (bytes_read == 0) {
887 break;
888 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800889 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800890 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800891 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700892 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800893 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700894 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800895 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800896 }
897 }
898
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700899 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000900 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700901 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700902 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800903 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800904 }
905
Vishnu Naire97d6122018-01-18 13:58:56 -0800906 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907}
908
Felipe Leme1d486fe2016-10-14 18:06:47 -0700909bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
910 android::base::unique_fd fd(
911 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700912 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800913 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800914 return false;
915 }
916
Vishnu Naire97d6122018-01-18 13:58:56 -0800917 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800918}
919
920/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700921static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800922 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800923}
924
Felipe Leme1d486fe2016-10-14 18:06:47 -0700925void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700926 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800927 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700928 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800929}
930
Felipe Leme1d486fe2016-10-14 18:06:47 -0700931bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800932 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000933 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
934 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700935 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700936 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700937 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800938 return false;
939 }
940
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700941 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700942 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700943 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700944 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800945 return false;
946 }
947
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700948 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700950 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800951 return false;
952 }
953
954 return true;
955}
956
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800957static void DoKmsg() {
958 struct stat st;
959 if (!stat(PSTORE_LAST_KMSG, &st)) {
960 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
961 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
962 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
963 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
964 } else {
965 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
966 DumpFile("LAST KMSG", "/proc/last_kmsg");
967 }
968}
969
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800970static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800971 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800972 RunCommand(
973 "KERNEL LOG",
974 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
975 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
976}
977
Nandana Duttdb379fa2019-10-09 16:54:41 +0100978static void DoSystemLogcat(time_t since) {
979 char since_str[80];
980 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
981
982 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
983 RunCommand("SYSTEM LOG",
984 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
985 since_str},
986 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
987}
988
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800989static void DoRadioLogcat() {
990 unsigned long timeout_ms = logcat_timeout({"radio"});
991 RunCommand(
992 "RADIO LOG",
993 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
994 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
995}
996
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800997static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -0800998 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800999 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1000 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001001 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001002 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001003 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1004 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001005 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001006 RunCommand(
1007 "EVENT LOG",
1008 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001009 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001010 timeout_ms = logcat_timeout({"stats"});
1011 RunCommand(
1012 "STATS LOG",
1013 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001014 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001015 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001016
1017 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1018
1019 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001020 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1021 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001022}
1023
Mike Ma5c267872019-08-21 11:31:34 -07001024static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001025 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1026 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1027 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1028 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1029 if (fd < 0) {
1030 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1031 return;
1032 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001033 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001034 bool empty = 0 == lseek(fd, 0, SEEK_END);
1035 if (!empty) {
1036 // Use a different name from "incident.proto"
1037 // /proto/incident.proto is reserved for incident service dump
1038 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001039 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1040 path);
1041 } else {
1042 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001043 }
Mike Ma5c267872019-08-21 11:31:34 -07001044}
1045
Aaron Huanga99452a2022-04-27 18:51:16 +08001046static void DumpNetstatsProto() {
1047 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1048 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1049 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1050 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1051 if (fd < 0) {
1052 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1053 return;
1054 }
1055 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1056 CommandOptions::WithTimeout(120).Build());
1057 bool empty = 0 == lseek(fd, 0, SEEK_END);
1058 if (!empty) {
1059 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1060 path);
1061 } else {
1062 unlink(path.c_str());
1063 }
1064}
1065
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001066static void MaybeAddSystemTraceToZip() {
1067 // This function copies into the .zip the system trace that was snapshotted
1068 // by the early call to MaybeSnapshotSystemTrace(), if any background
1069 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001070 if (!ds.has_system_trace_) {
1071 // No background trace was happening at the time dumpstate was invoked.
1072 return;
1073 }
1074 ds.AddZipEntry(
1075 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1076 SYSTEM_TRACE_SNAPSHOT);
1077 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1078}
1079
Sunny Goyal35949782019-11-19 15:54:36 -08001080static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001081 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1082 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1083 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1084 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1085 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1086 if (fd < 0) {
1087 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1088 return;
1089 }
1090 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001091 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001092 bool empty = 0 == lseek(fd, 0, SEEK_END);
1093 if (!empty) {
1094 ds.AddZipEntry("visible_windows.zip", path);
1095 } else {
1096 MYLOGW("Failed to dump visible windows\n");
1097 }
1098 unlink(path.c_str());
1099}
1100
Jayachandran Ca94c7172017-06-10 15:08:12 -07001101static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001102 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1103 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001104 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001105 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001106 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1107 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1108 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1109 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001110}
1111
David Andersond9ba4752018-12-11 18:26:59 -08001112static void DumpDynamicPartitionInfo() {
1113 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1114 return;
1115 }
1116
1117 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001118 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001119}
1120
Chris Morin5a50d482022-02-01 17:41:18 -08001121static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001122 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1123 anr_traces_dir.c_str());
1124
1125 // If we're here, dump_traces_path will always be a temporary file
1126 // (created with mkostemp or similar) that contains dumps taken earlier
1127 // on in the process.
1128 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001129 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1130 dump_traces_path);
1131 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001132
1133 const int ret = unlink(dump_traces_path);
1134 if (ret == -1) {
1135 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1136 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001137 }
1138 }
1139
Narayan Kamathbd863722017-06-01 18:50:12 +01001140 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001141 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001142 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001143 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001144 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001145
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001146 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001147 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001148 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001149 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001150 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1151 }
1152}
1153
1154static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001155 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001156
Chris Morin5a50d482022-02-01 17:41:18 -08001157 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001158
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001159 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1160
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001161 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001162 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001163 int i = 0;
1164 while (true) {
1165 const std::string slow_trace_path =
1166 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1167 if (stat(slow_trace_path.c_str(), &st)) {
1168 // No traces file at this index, done with the files.
1169 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001170 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001171 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1172 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001173 }
1174}
1175
Wei Wang509bb5d2017-06-09 14:42:12 -07001176static void DumpBlockStatFiles() {
1177 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001178
Wei Wang1dc1ef52017-06-12 11:28:37 -07001179 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1180
1181 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001182 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1183 return;
1184 }
1185
1186 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001187 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001188 if ((d->d_name[0] == '.')
1189 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1190 || (d->d_name[1] == '\0'))) {
1191 continue;
1192 }
1193 const std::string new_path =
1194 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1195 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1196 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1197 printf("\n");
1198 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001199 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001200}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001201
1202static void DumpPacketStats() {
1203 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001204}
1205
1206static void DumpIpAddrAndRules() {
1207 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1208 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1209 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1210 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1211 RunCommand("IP RULES", {"ip", "rule", "show"});
1212 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1213}
1214
Nandana Dutt5c390032019-03-12 10:52:56 +00001215static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1216 std::chrono::milliseconds timeout,
1217 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001218 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001219 sp<android::IServiceManager> sm = defaultServiceManager();
1220 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001221 Vector<String16> args;
1222 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001223 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1224 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001225 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001226 std::string path(title);
1227 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001228 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001229 if (PropertiesHelper::IsDryRun()) {
1230 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1231 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1232 } else {
1233 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1234 if (status == OK) {
1235 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1236 std::chrono::duration<double> elapsed_seconds;
1237 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1238 service == String16("meminfo")) {
1239 // Use a longer timeout for meminfo, since 30s is not always enough.
1240 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1241 /* as_proto = */ false, elapsed_seconds,
1242 bytes_written);
1243 } else {
1244 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1245 /* as_proto = */ false, elapsed_seconds,
1246 bytes_written);
1247 }
1248 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1249 bool dump_complete = (status == OK);
1250 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001251 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001252 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001253
1254 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1255 std::chrono::steady_clock::now() - start);
1256 if (elapsed_duration > timeout) {
1257 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1258 elapsed_duration.count());
1259 break;
1260 }
1261 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001262 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001263}
1264
Vishnu Nair64afc022018-02-01 15:29:34 -08001265static void RunDumpsysText(const std::string& title, int priority,
1266 std::chrono::milliseconds timeout,
1267 std::chrono::milliseconds service_timeout) {
1268 DurationReporter duration_reporter(title);
1269 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1270 fsync(STDOUT_FILENO);
1271 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1272}
1273
1274/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001275static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1276 std::chrono::milliseconds timeout,
1277 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001278 DurationReporter duration_reporter(title);
1279 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1280 fsync(STDOUT_FILENO);
1281 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1282 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001283
1284 RETURN_IF_USER_DENIED_CONSENT();
1285
1286 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1287 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001288}
1289
Nandana Dutt5c390032019-03-12 10:52:56 +00001290static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1291 std::chrono::milliseconds timeout,
1292 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001293 sp<android::IServiceManager> sm = defaultServiceManager();
1294 Dumpsys dumpsys(sm.get());
1295 Vector<String16> args;
1296 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1297 DurationReporter duration_reporter(title);
1298
1299 auto start = std::chrono::steady_clock::now();
1300 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1301 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001302 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001303 std::string path(kProtoPath);
1304 path.append(String8(service).c_str());
1305 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1306 path.append("_CRITICAL");
1307 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1308 path.append("_HIGH");
1309 }
1310 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001311 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001312 if (status == OK) {
1313 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1314 bool dumpTerminated = (status == OK);
1315 dumpsys.stopDumpThread(dumpTerminated);
1316 }
1317 ZipWriter::FileEntry file_entry;
1318 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001319
1320 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1321 std::chrono::steady_clock::now() - start);
1322 if (elapsed_duration > timeout) {
1323 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1324 elapsed_duration.count());
1325 break;
1326 }
1327 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001328 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001329}
1330
Nandana Dutta7db6342018-11-21 14:53:34 +00001331// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001332static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001333 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1334 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001335
1336 RETURN_IF_USER_DENIED_CONSENT();
1337
1338 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1339 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001340}
1341
1342// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001343static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001344 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1345 // high priority. Reduce timeout once they are able to dump in a shorter time or
1346 // moved to a parallel task.
1347 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1348 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001349
1350 RETURN_IF_USER_DENIED_CONSENT();
1351
1352 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1353 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001354}
1355
1356// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001357static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001358 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001359
1360 RETURN_IF_USER_DENIED_CONSENT();
1361
1362 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1363 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001364}
1365
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001366/*
1367 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1368 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1369 * if it's not running in the parallel task.
1370 */
1371static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001372 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001373 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1374 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001375
Steven Moreland44cd9482018-01-04 16:24:13 -08001376 using android::hidl::manager::V1_0::IServiceManager;
1377 using android::hardware::defaultServiceManager;
1378
1379 sp<IServiceManager> sm = defaultServiceManager();
1380 if (sm == nullptr) {
1381 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1382 return;
1383 }
1384
1385 auto ret = sm->list([&](const auto& interfaces) {
1386 for (const std::string& interface : interfaces) {
1387 std::string cleanName = interface;
1388 std::replace_if(cleanName.begin(),
1389 cleanName.end(),
1390 [](char c) {
1391 return !isalnum(c) &&
1392 std::string("@-_:.").find(c) == std::string::npos;
1393 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001394 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001395
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001396 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001397 {
1398 auto fd = android::base::unique_fd(
1399 TEMP_FAILURE_RETRY(open(path.c_str(),
1400 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1401 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1402 if (fd < 0) {
1403 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1404 continue;
1405 }
1406 RunCommandToFd(fd,
1407 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001408 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001409 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1410
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001411 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001412 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001413 if (!empty) {
1414 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1415 path);
1416 } else {
1417 unlink(path.c_str());
1418 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001419 }
1420 });
1421
1422 if (!ret.isOk()) {
1423 MYLOGE("Could not list hals from hwservicemanager.\n");
1424 }
1425}
1426
Devin Moore8df81bb2022-06-08 22:47:02 +00001427// Dump all of the files that make up the vendor interface.
1428// See the files listed in dumpFileList() for the latest list of files.
1429static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001430
1431 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1432 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001433 for (const auto vintfFile : vintfFiles) {
1434 struct stat st;
1435 if (stat(vintfFile.c_str(), &st) == 0) {
1436 if (S_ISDIR(st.st_mode)) {
1437 ds.AddDir(vintfFile, true /* recursive */);
1438 } else {
1439 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1440 vintfFile);
1441 }
1442 }
1443 }
1444}
1445
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001446static void DumpExternalFragmentationInfo() {
1447 struct stat st;
1448 if (stat("/proc/buddyinfo", &st) != 0) {
1449 MYLOGE("Unable to dump external fragmentation info\n");
1450 return;
1451 }
1452
1453 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1454 std::ifstream ifs("/proc/buddyinfo");
1455 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1456 for (std::string line; std::getline(ifs, line);) {
1457 std::smatch match_results;
1458 if (std::regex_match(line, match_results, unusable_index_regex)) {
1459 std::stringstream free_pages(std::string{match_results[3]});
1460 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1461 std::istream_iterator<int>());
1462
1463 int total_free_pages = 0;
1464 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1465 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1466 }
1467
1468 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1469 match_results[2].str().c_str());
1470
1471 int usable_free_pages = total_free_pages;
1472 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1473 auto unusable_index = (total_free_pages - usable_free_pages) /
1474 static_cast<double>(total_free_pages);
1475 printf(" %5.3f", unusable_index);
1476 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1477 }
1478
1479 printf("\n");
1480 }
1481 }
1482 printf("\n");
1483}
1484
mhasankd451a472020-05-26 18:02:39 -07001485static void DumpstateLimitedOnly() {
1486 // Trimmed-down version of dumpstate to only include a whitelisted
1487 // set of logs (system log, event log, and system server / system app
1488 // crashes, and networking logs). See b/136273873 and b/138459828
1489 // for context.
1490 DurationReporter duration_reporter("DUMPSTATE");
1491 unsigned long timeout_ms;
1492 // calculate timeout
1493 timeout_ms = logcat_timeout({"main", "system", "crash"});
1494 RunCommand("SYSTEM LOG",
1495 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1496 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1497 timeout_ms = logcat_timeout({"events"});
1498 RunCommand(
1499 "EVENT LOG",
1500 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1501 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1502
1503 printf("========================================================\n");
1504 printf("== Networking Service\n");
1505 printf("========================================================\n");
1506
1507 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1508 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001509 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1510 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001511
1512 printf("========================================================\n");
1513 printf("== Dropbox crashes\n");
1514 printf("========================================================\n");
1515
1516 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1517 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1518
1519 printf("========================================================\n");
1520 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1521 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1522 printf("========================================================\n");
1523 printf("== dumpstate: done (id %d)\n", ds.id_);
1524 printf("========================================================\n");
1525}
1526
Rhed Jaoe017f982020-07-21 17:58:41 +08001527/*
1528 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1529 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1530 * if it's not running in the parallel task.
1531 */
1532static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1533 dprintf(out_fd, "========================================================\n");
1534 dprintf(out_fd, "== Checkins\n");
1535 dprintf(out_fd, "========================================================\n");
1536
1537 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001538 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1539 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1540 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1541 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1542}
1543
1544/*
1545 * Runs dumpsys on activity service to dump all application activities, services
1546 * and providers in the device.
1547 *
1548 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1549 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1550 * if it's not running in the parallel task.
1551 */
1552static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1553 dprintf(out_fd, "========================================================\n");
1554 dprintf(out_fd, "== Running Application Activities\n");
1555 dprintf(out_fd, "========================================================\n");
1556
1557 // The following dumpsys internally collects output from running apps, so it can take a long
1558 // time. So let's extend the timeout.
1559
1560 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1561
1562 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1563
1564 dprintf(out_fd, "========================================================\n");
1565 dprintf(out_fd, "== Running Application Services (platform)\n");
1566 dprintf(out_fd, "========================================================\n");
1567
1568 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1569 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1570
1571 dprintf(out_fd, "========================================================\n");
1572 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1573 dprintf(out_fd, "========================================================\n");
1574
1575 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1576 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1577
1578 dprintf(out_fd, "========================================================\n");
1579 dprintf(out_fd, "== Running Application Providers (platform)\n");
1580 dprintf(out_fd, "========================================================\n");
1581
1582 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001583 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001584
1585 dprintf(out_fd, "========================================================\n");
1586 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1587 dprintf(out_fd, "========================================================\n");
1588
1589 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1590 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1591}
1592
Nandana Dutt5c390032019-03-12 10:52:56 +00001593// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1594// via the consent they are shown. Ignores other errors that occur while running various
1595// commands. The consent checking is currently done around long running tasks, which happen to
1596// be distributed fairly evenly throughout the function.
1597static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001598 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001599
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001600 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001601 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1602 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001603 if (ds.dump_pool_) {
1604 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1605 // drop root user. Restarts it with two threads for the parallel run.
1606 ds.dump_pool_->start(/* thread_counts = */2);
1607
Chris Morinbc223142022-02-04 14:17:11 -08001608 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1609 dump_incident_report = ds.dump_pool_->enqueueTask(
1610 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001611 dump_netstats_report = ds.dump_pool_->enqueueTask(
1612 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001613 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1614 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1615 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001616 }
1617
Nandana Dutt5c390032019-03-12 10:52:56 +00001618 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1619 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1620 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001621 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001622 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001623 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001624 DumpFile("MEMORY INFO", "/proc/meminfo");
1625 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001626 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001627
Kevin Jeon947922b2022-09-21 00:29:18 +00001628 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1629 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001630
Sunny Goyal35949782019-11-19 15:54:36 -08001631 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1632
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001633 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1634 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1635 DumpFile("SLAB INFO", "/proc/slabinfo");
1636 DumpFile("ZONEINFO", "/proc/zoneinfo");
1637 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1638 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001639 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001640
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001641 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001642
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001643 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001644 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001645
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001646 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001647 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001648 } else {
1649 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1650 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001651
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001652 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001653 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001654 struct stat s;
1655 if (stat("/proc/modules", &s) != 0) {
1656 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1657 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001658 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001659 RunCommand("MODULES INFO",
1660 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1661 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1662 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001663 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001664
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001665 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001666 DoKernelLogcat();
1667 } else {
1668 do_dmesg();
1669 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001670
Devin Moore8df81bb2022-06-08 22:47:02 +00001671 DumpVintf();
1672
Felipe Lemef0292972016-11-22 13:57:05 -08001673 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001674
Jeff Brown1dc94e32014-09-11 14:15:27 -07001675 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001676 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001677
Jack Yu5a6b2e22020-08-14 18:13:35 +08001678 /* Dump Nfc NCI logs */
1679 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001680
Paul Chang0d2aad72020-02-13 20:04:03 +08001681 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001682 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001683 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001684 }
1685
Felipe Lemee184f662016-10-27 10:04:47 -07001686 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001687
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001688 MaybeAddSystemTraceToZip();
1689
Narayan Kamath8f788292017-05-25 13:20:39 +01001690 // NOTE: tombstones are always added as separate entries in the zip archive
1691 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001692 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001693 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001694 if (!tombstones_dumped) {
1695 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001696 }
1697
Jayachandran Ca94c7172017-06-10 15:08:12 -07001698 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001699
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001700 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001701
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001702 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001703
Jayachandran Ca94c7172017-06-10 15:08:12 -07001704 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001705
1706 dump_route_tables();
1707
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001708 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1709 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1710 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001711
Nandana Dutt5c390032019-03-12 10:52:56 +00001712 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001713
Chiachang Wang668ede42021-05-17 17:14:20 +08001714 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1715 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1716 // dump with priority parameters to dump high priority information.
1717 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1718 CommandOptions::WithTimeout(10).Build());
1719
Elliott Hughes23ccc622017-02-28 10:14:22 -08001720 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001721
Jin Qianf334d662017-10-10 14:41:37 -07001722 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001723
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001724 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001725
Colin Crossf45fa6b2012-03-26 12:38:26 -07001726 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001727 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1728 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1729
1730 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1731 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1732 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1733 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1734 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001735
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001736 /* Add window and surface trace files. */
1737 if (!PropertiesHelper::IsUserBuild()) {
1738 ds.AddDir(WMTRACE_DATA_DIR, false);
1739 }
1740
Yifan Hongd90cc652020-02-08 16:52:02 -08001741 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1742
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001743 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001744 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001745 } else {
1746 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1747 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001748
Steven Moreland7440ddb2016-12-15 16:13:39 -08001749 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001750 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1751 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001752 // su does not exist on user builds, so try running without it.
1753 // This way any implementations of vril-dump that do not require
1754 // root can run on user builds.
1755 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001756 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001757 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001758 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001759 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001760 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001761 }
1762
Felipe Lemed8b94e52016-12-08 10:21:44 -08001763 printf("========================================================\n");
1764 printf("== Android Framework Services\n");
1765 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001766
Nandana Dutt5c390032019-03-12 10:52:56 +00001767 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001768
Jack He91ff2fe2021-02-18 18:23:43 -08001769 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1770 ds.AddDir("/data/misc/bluetooth/logs", true);
1771
Rhed Jaoe017f982020-07-21 17:58:41 +08001772 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001773 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001774 } else {
1775 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1776 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001777
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001778 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001779
Adrian Roos8b397ab2017-04-04 16:35:44 -07001780 printf("========================================================\n");
1781 printf("== Dropbox crashes\n");
1782 printf("========================================================\n");
1783
1784 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1785 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1786
Felipe Lemed8b94e52016-12-08 10:21:44 -08001787 printf("========================================================\n");
1788 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1789 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1790 printf("========================================================\n");
1791 printf("== dumpstate: done (id %d)\n", ds.id_);
1792 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001793
1794 printf("========================================================\n");
1795 printf("== Obtaining statsd metadata\n");
1796 printf("========================================================\n");
1797 // This differs from the usual dumpsys stats, which is the stats report data.
1798 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001799
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001800 // Add linker configuration directory
1801 ds.AddDir(LINKERCONFIG_DIR, true);
1802
Li Li830179f2022-01-04 12:53:29 -08001803 /* Dump frozen cgroupfs */
1804 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001805
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001806 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001807 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1808 } else {
1809 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1810 DumpNetstatsProto);
1811 }
1812
1813 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001814 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001815 } else {
1816 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1817 DumpIncidentReport);
1818 }
Mike Ma5c267872019-08-21 11:31:34 -07001819
Nandana Dutt5c390032019-03-12 10:52:56 +00001820 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001821}
1822
Nandana Dutt5c390032019-03-12 10:52:56 +00001823/*
1824 * Dumps state for the default case; drops root after it's no longer necessary.
1825 *
1826 * Returns RunStatus::OK if everything went fine.
1827 * Returns RunStatus::ERROR if there was an error.
1828 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1829 * with the caller.
1830 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001831Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001832 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1833 // buffer.
1834 DoLogcat();
1835 // Capture timestamp after first logcat to use in next logcat
1836 time_t logcat_ts = time(nullptr);
1837
Nandana Dutt4be45d12018-09-26 15:04:23 +01001838 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001839 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001840 if (dump_pool_) {
1841 RETURN_IF_USER_DENIED_CONSENT();
1842 // One thread is enough since we only need to enqueue DumpTraces here.
1843 dump_pool_->start(/* thread_counts = */1);
1844
1845 // DumpTraces takes long time, post it to the another thread in the
1846 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001847 dump_traces = dump_pool_->enqueueTask(
1848 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001849 } else {
1850 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1851 &dump_traces_path);
1852 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001853
1854 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001855 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001856 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1857 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001858 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001859
1860 ds.AddDir(RECOVERY_DIR, true);
1861 ds.AddDir(RECOVERY_DATA_DIR, true);
1862 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001863 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001864 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1865 if (!PropertiesHelper::IsUserBuild()) {
1866 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1867 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001868 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001869 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001870 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001871 add_mountinfo();
1872 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001873 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001874 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001875
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001876 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001877 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1878
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001879 // Dump IPsec stats. No keys are exposed here.
1880 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1881
Nandana Dutt4be45d12018-09-26 15:04:23 +01001882 // Run ss as root so we can see socket marks.
1883 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1884
1885 // Run iotop as root to show top 100 IO threads
1886 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1887
Erick Reyese68df822019-02-11 14:46:36 -08001888 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001889 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1890 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001891
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001892 DumpFile("PSI cpu", "/proc/pressure/cpu");
1893 DumpFile("PSI memory", "/proc/pressure/memory");
1894 DumpFile("PSI io", "/proc/pressure/io");
1895
Mårten Kongstad60195a72022-09-20 14:14:20 +02001896 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1897 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1898
Rhed Jao5377d792020-07-16 17:37:39 +08001899 if (dump_pool_) {
1900 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001901 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001902
Chris Morinbc223142022-02-04 14:17:11 -08001903 // Current running thread in the pool is the root user also. Delete
1904 // the pool and make a new one later to ensure none of threads in the pool are root.
1905 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001906 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001907 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001908 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001909 }
1910
Nandana Dutt5c390032019-03-12 10:52:56 +00001911 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001912 Dumpstate::RunStatus status = dumpstate();
1913 // Capture logcat since the last time we did it.
1914 DoSystemLogcat(logcat_ts);
1915 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001916}
1917
Rhed Jaob5685b32020-08-14 17:19:17 +08001918// Common states for telephony and wifi which are needed to be collected before
1919// dumpstate drop the root user.
1920static void DumpstateRadioAsRoot() {
1921 DumpIpTablesAsRoot();
1922 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1923}
1924
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001925// This method collects common dumpsys for telephony and wifi. Typically, wifi
1926// reports are fine to include all information, but telephony reports on user
1927// builds need to strip some content (see DumpstateTelephonyOnly).
1928static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001929 // We need to be picky about some stuff for telephony reports on user builds.
1930 if (!include_sensitive_info) {
1931 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1932 DoRadioLogcat();
1933 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001934 // DumpHals takes long time, post it to the another thread in the pool,
1935 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001936 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001937 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001938 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001939 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001940 // Contains various system properties and process startup info.
1941 do_dmesg();
1942 // Logs other than the radio buffer may contain package/component names and potential PII.
1943 DoLogcat();
1944 // Too broad for connectivity problems.
1945 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001946 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1947 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001948 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001949 } else {
1950 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1951 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001952 }
1953
Jayachandran Ca94c7172017-06-10 15:08:12 -07001954 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001955 DumpIpAddrAndRules();
1956 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001957 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1958 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001959}
1960
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001961// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1962// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1963// for what can be included on user builds: all reported information MUST directly relate to
1964// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1965// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1966// names are not), and MUST NOT contain logs of user application traffic.
1967// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001968static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001969 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001970
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001971 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001972
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001973 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001974
Rhed Jaob5685b32020-08-14 17:19:17 +08001975 DumpstateRadioAsRoot();
1976 if (!DropRootUser()) {
1977 return;
1978 }
1979
1980 // Starts thread pool after the root user is dropped, and two additional threads
1981 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08001982 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08001983 if (ds.dump_pool_) {
1984 ds.dump_pool_->start(/*thread_counts =*/2);
1985
1986 // DumpstateBoard takes long time, post it to the another thread in the pool,
1987 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001988 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1989 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001990 }
1991
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001992 DumpstateRadioCommon(include_sensitive_info);
1993
1994 if (include_sensitive_info) {
1995 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
1996 // really cherrypick all of the connectivity-related ones. Apps generally have no business
1997 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
1998 // way.
1999 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2000 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002001
2002 printf("========================================================\n");
2003 printf("== Android Framework Services\n");
2004 printf("========================================================\n");
2005
Vishnu Nair652cc802017-11-30 15:18:30 -08002006 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2007 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002008 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2009 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002010 if (include_sensitive_info) {
2011 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2012 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2013 SEC_TO_MSEC(10));
2014 } else {
2015 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2016 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2017 // give a higher timeout as well.
2018 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2019 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2020 }
2021 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002022 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2023 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002024 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002025 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2026 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002027 if (include_sensitive_info) {
2028 // Contains raw IP addresses, omit from reports on user builds.
2029 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2030 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2031 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2032 SEC_TO_MSEC(10));
2033 // Contains package/component names, omit from reports on user builds.
2034 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2035 SEC_TO_MSEC(10));
2036 // Contains package names, but should be relatively simple to remove them (also contains
2037 // UIDs already), omit from reports on user builds.
2038 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2039 SEC_TO_MSEC(10));
2040 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002041
2042 printf("========================================================\n");
2043 printf("== Running Application Services\n");
2044 printf("========================================================\n");
2045
2046 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2047
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002048 if (include_sensitive_info) {
2049 printf("========================================================\n");
2050 printf("== Running Application Services (non-platform)\n");
2051 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002052
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002053 // Contains package/component names and potential PII, omit from reports on user builds.
2054 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2055 // carrier_config dumpsys instead.
2056 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2057 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002058
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002059 printf("========================================================\n");
2060 printf("== Checkins\n");
2061 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002062
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002063 // Contains package/component names, omit from reports on user builds.
2064 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2065 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002066
2067 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002068 printf("== dumpstate: done (id %d)\n", ds.id_);
2069 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002070
2071 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002072 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002073 } else {
2074 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2075 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002076}
2077
mukesh agrawal253dad42018-01-23 21:59:59 -08002078// This method collects dumpsys for wifi debugging only
2079static void DumpstateWifiOnly() {
2080 DurationReporter duration_reporter("DUMPSTATE");
2081
Rhed Jaob5685b32020-08-14 17:19:17 +08002082 DumpstateRadioAsRoot();
2083 if (!DropRootUser()) {
2084 return;
2085 }
2086
2087 // Starts thread pool after the root user is dropped. Only one additional
2088 // thread is needed for DumpHals in the DumpstateRadioCommon.
2089 if (ds.dump_pool_) {
2090 ds.dump_pool_->start(/*thread_counts =*/1);
2091 }
2092
mukesh agrawal253dad42018-01-23 21:59:59 -08002093 DumpstateRadioCommon();
2094
2095 printf("========================================================\n");
2096 printf("== Android Framework Services\n");
2097 printf("========================================================\n");
2098
2099 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2100 SEC_TO_MSEC(10));
2101 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2102 SEC_TO_MSEC(10));
2103
2104 printf("========================================================\n");
2105 printf("== dumpstate: done (id %d)\n", ds.id_);
2106 printf("========================================================\n");
2107}
2108
Nandana Duttcf419a72019-03-14 10:40:17 +00002109Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002110 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002111 const size_t buf_size = temp_file_pattern.length() + 1;
2112 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2113 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2114
2115 // Create a new, empty file to receive all trace dumps.
2116 //
2117 // TODO: This can be simplified once we remove support for the old style
2118 // dumps. We can have a file descriptor passed in to dump_traces instead
2119 // of creating a file, closing it and then reopening it again.
2120 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2121 if (fd < 0) {
2122 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002123 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002124 }
2125
2126 // Nobody should have access to this temporary file except dumpstate, but we
2127 // temporarily grant 'read' to 'others' here because this file is created
2128 // when tombstoned is still running as root, but dumped after dropping. This
2129 // can go away once support for old style dumping has.
2130 const int chmod_ret = fchmod(fd, 0666);
2131 if (chmod_ret < 0) {
2132 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002133 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002134 }
2135
2136 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2137 if (proc.get() == nullptr) {
2138 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002139 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002140 }
2141
2142 // Number of times process dumping has timed out. If we encounter too many
2143 // failures, we'll give up.
2144 int timeout_failures = 0;
2145 bool dalvik_found = false;
2146
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002147 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002148
2149 struct dirent* d;
2150 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002151 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002152 int pid = atoi(d->d_name);
2153 if (pid <= 0) {
2154 continue;
2155 }
2156
2157 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2158 std::string exe;
2159 if (!android::base::Readlink(link_name, &exe)) {
2160 continue;
2161 }
2162
2163 bool is_java_process;
2164 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2165 // Don't bother dumping backtraces for the zygote.
2166 if (IsZygote(pid)) {
2167 continue;
2168 }
2169
2170 dalvik_found = true;
2171 is_java_process = true;
2172 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2173 is_java_process = false;
2174 } else {
2175 // Probably a native process we don't care about, continue.
2176 continue;
2177 }
2178
2179 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2180 if (timeout_failures == 3) {
2181 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2182 break;
2183 }
2184
2185 const uint64_t start = Nanotime();
2186 const int ret = dump_backtrace_to_file_timeout(
2187 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2188 is_java_process ? 5 : 20, fd);
2189
2190 if (ret == -1) {
2191 // For consistency, the header and footer to this message match those
2192 // dumped by debuggerd in the success case.
2193 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2194 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2195 dprintf(fd, "---- end %d ----", pid);
2196 timeout_failures++;
2197 continue;
2198 }
2199
2200 // We've successfully dumped stack traces, reset the failure count
2201 // and write a summary of the elapsed time to the file and continue with the
2202 // next process.
2203 timeout_failures = 0;
2204
2205 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2206 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2207 }
2208
2209 if (!dalvik_found) {
2210 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2211 }
2212
Nandana Duttcf419a72019-03-14 10:40:17 +00002213 *path = file_name_buf.release();
2214 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002215}
2216
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002217static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2218 const Dumpstate::BugreportMode bugreport_mode) {
2219 switch (bugreport_mode) {
2220 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2221 return dumpstate_hal_hidl::DumpstateMode::FULL;
2222 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2223 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2224 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2225 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2226 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2227 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2228 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2229 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2230 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2231 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2232 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2233 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2234 }
2235 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2236}
2237
2238static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2239 const Dumpstate::BugreportMode bugreport_mode) {
2240 switch (bugreport_mode) {
2241 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2242 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2243 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2244 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2245 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2246 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2247 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2248 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2249 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2250 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2251 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2252 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2253 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2254 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2255 }
2256 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2257}
2258
2259static void DoDumpstateBoardHidl(
2260 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2261 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2262 const Dumpstate::BugreportMode bugreport_mode,
2263 const size_t timeout_sec) {
2264
2265 using ScopedNativeHandle =
2266 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2267 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2268 [](native_handle_t* handle) {
2269 // we don't close file handle's here
2270 // via native_handle_close(handle)
2271 // instead we let dumpstate_fds close the file handles when
2272 // dumpstate_fds gets destroyed
2273 native_handle_delete(handle);
2274 });
2275 if (handle == nullptr) {
2276 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2277 return;
2278 }
2279
2280 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2281 handle.get()->data[i] = dumpstate_fds[i].get();
2282 }
2283
2284 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2285 // implement just 1.0.
2286 const char* descriptor_to_kill;
2287 using DumpstateBoardTask = std::packaged_task<bool()>;
2288 DumpstateBoardTask dumpstate_board_task;
2289 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2290 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2291 if (dumpstate_hal != nullptr) {
2292 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2293
2294 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2295 GetDumpstateHalModeHidl(bugreport_mode);
2296
2297 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2298 dumpstate_board_task =
2299 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2300 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2301 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2302 SEC_TO_MSEC(timeout_sec));
2303 if (!status.isOk()) {
2304 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2305 return false;
2306 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2307 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2308 dumpstate_hal_hidl::toString(status).c_str());
2309 return false;
2310 }
2311 return true;
2312 });
2313 } else {
2314 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2315
2316 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2317 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2318 ::android::hardware::Return<void> status =
2319 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2320 if (!status.isOk()) {
2321 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2322 return false;
2323 }
2324 return true;
2325 });
2326 }
2327 auto result = dumpstate_board_task.get_future();
2328 std::thread(std::move(dumpstate_board_task)).detach();
2329
2330 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2331 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2332 if (!android::base::SetProperty(
2333 "ctl.interface_restart",
2334 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2335 MYLOGE("Couldn't restart dumpstate HAL\n");
2336 }
2337 }
2338 // Wait some time for init to kill dumpstate vendor HAL
2339 constexpr size_t killing_timeout_sec = 10;
2340 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2341 MYLOGE(
2342 "killing dumpstateBoard timed out after %zus, continue and "
2343 "there might be racing in content\n",
2344 killing_timeout_sec);
2345 }
2346}
2347
2348static void DoDumpstateBoardAidl(
2349 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2350 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2351 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2352 MYLOGI("Using IDumpstateDevice AIDL HAL");
2353
2354 const char* descriptor_to_kill;
2355 using DumpstateBoardTask = std::packaged_task<bool()>;
2356 DumpstateBoardTask dumpstate_board_task;
2357 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2358 GetDumpstateHalModeAidl(bugreport_mode);
2359
2360 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2361 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2362 timeout_sec]() -> bool {
2363 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2364
2365 if (!status.isOk()) {
2366 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2367 return false;
2368 }
2369 return true;
2370 });
2371 auto result = dumpstate_board_task.get_future();
2372 std::thread(std::move(dumpstate_board_task)).detach();
2373
2374 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2375 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2376 if (!android::base::SetProperty(
2377 "ctl.interface_restart",
2378 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2379 MYLOGE("Couldn't restart dumpstate HAL\n");
2380 }
2381 }
2382 // Wait some time for init to kill dumpstate vendor HAL
2383 constexpr size_t killing_timeout_sec = 10;
2384 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2385 MYLOGE(
2386 "killing dumpstateBoard timed out after %zus, continue and "
2387 "there might be racing in content\n",
2388 killing_timeout_sec);
2389 }
2390}
2391
2392static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2393 const std::string aidl_instance_name =
2394 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2395
2396 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2397 return nullptr;
2398 }
2399
2400 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2401
2402 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2403}
2404
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002405void Dumpstate::DumpstateBoard(int out_fd) {
2406 dprintf(out_fd, "========================================================\n");
2407 dprintf(out_fd, "== Board\n");
2408 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002409
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002410 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002411 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002412 * set to true and unmount it after invoking dumpstateBoard_* methods.
2413 * This is to enable debug builds to not have debugfs mounted during runtime.
2414 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002415 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002416 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002417 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002418 if (mount_debugfs) {
2419 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2420 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002421 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002422 }
2423
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002424 std::vector<std::string> paths;
2425 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002426 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002427 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2428 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002429 remover.emplace_back(android::base::make_scope_guard(
2430 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002431 }
Jie Song9fbfad02017-06-20 16:29:42 -07002432
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002433 // get dumpstate HAL AIDL implementation
2434 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2435 GetDumpstateBoardAidlService());
2436 if (dumpstate_hal_handle_aidl == nullptr) {
2437 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2438 }
2439
2440 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2441 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2442 if (dumpstate_hal_handle_aidl == nullptr) {
2443 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2444 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2445 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2446 }
2447 }
2448
2449 // if neither HIDL nor AIDL implementation found, then return
2450 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2451 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002452 return;
2453 }
2454
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002455 // this is used to hold the file descriptors and when this variable goes out of scope
2456 // the file descriptors are closed
2457 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002458
Nandana Dutt5c390032019-03-12 10:52:56 +00002459 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002460 for (size_t i = 0; i < paths.size(); i++) {
2461 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2462
2463 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2464 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2465 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2466 if (fd < 0) {
2467 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2468 return;
2469 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002470
2471 dumpstate_fds.emplace_back(fd.release());
2472 // we call fd.release() here to make sure "fd" does not get closed
2473 // after "fd" goes out of scope after this block.
2474 // "fd" will be closed when "dumpstate_fds" goes out of scope
2475 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002476 }
2477
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002478 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2479 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2480 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002481 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002482
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002483 if (dumpstate_hal_handle_aidl != nullptr) {
2484 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2485 timeout_sec);
2486 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2487 // run HIDL HAL only if AIDL HAL not found
2488 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2489 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002490 }
2491
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002492 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002493 auto keep_debugfs_mounted =
2494 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2495 if (keep_debugfs_mounted.empty())
2496 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002497 }
2498
Wei Wang587eac92018-04-05 12:17:20 -07002499 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2500 for (size_t i = 0; i < paths.size(); i++) {
2501 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002502 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2503 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002504 file_sizes[i] = -1;
2505 continue;
2506 }
2507 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002508 }
2509
2510 for (size_t i = 0; i < paths.size(); i++) {
2511 if (file_sizes[i] == -1) {
2512 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002513 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002514 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002515 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002516 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002517 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002518 remover[i].Disable();
2519 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2520 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002521 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002522}
2523
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002524static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002525 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002526 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2527 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002528 " -h: display this help message\n"
2529 " -b: play sound file instead of vibrate, at beginning of job\n"
2530 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002531 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002532 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002533 " -s: write zipped file to control socket (for init)\n"
2534 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002535 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002536 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002537 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002538 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002539 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002540 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002541}
2542
Wei Liuf87959e2016-08-26 14:51:42 -07002543static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002544 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002545}
2546
Felipe Leme1d486fe2016-10-14 18:06:47 -07002547bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002548 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2549 if (zip_entry_tasks_) {
2550 zip_entry_tasks_->run(/* do_cancel = */false);
2551 }
2552
Felipe Leme9a523ae2016-10-20 15:10:33 -07002553 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002554 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002555 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002556 // Final timestamp
2557 char date[80];
2558 time_t the_real_now_please_stand_up = time(nullptr);
2559 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002560 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002561 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002562
Felipe Leme9a523ae2016-10-20 15:10:33 -07002563 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002564 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002565 return false;
2566 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002567 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002568 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002569 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002570 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002571
Felipe Leme0f3fb202016-06-10 17:10:53 -07002572 // Add log file (which contains stderr output) to zip...
2573 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002574 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002575 MYLOGE("Failed to add dumpstate log to .zip file\n");
2576 return false;
2577 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002578 // TODO: Should truncate the existing file.
2579 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002580 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2581 return false;
2582 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002583 fprintf(stderr, "\n");
2584
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002585 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002586 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002587 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002588 return false;
2589 }
2590
Felipe Leme1d486fe2016-10-14 18:06:47 -07002591 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2592 ds.zip_file.reset(nullptr);
2593
Felipe Lemee9d2c542016-11-15 11:48:26 -08002594 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002595 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002596
Felipe Leme1e9edc62015-12-21 16:02:13 -08002597 return true;
2598}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002599
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002600static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2601 // clang-format off
2602 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2603 "--receiver-foreground", "--receiver-include-background", "-a", action};
2604 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002605
2606 am.insert(am.end(), args.begin(), args.end());
2607
Felipe Leme8d2410e2017-02-08 09:46:08 -08002608 RunCommand("", am,
2609 CommandOptions::WithTimeout(20)
2610 .Log("Sending broadcast: '%s'\n")
2611 .Always()
2612 .DropRoot()
2613 .RedirectStderr()
2614 .Build());
2615}
2616
Felipe Leme35b8cf12017-02-10 15:47:29 -08002617static void Vibrate(int duration_ms) {
2618 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002619 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2620 "oneshot", std::to_string(duration_ms)};
2621 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002622 CommandOptions::WithTimeout(10)
2623 .Log("Vibrate: '%s'\n")
2624 .Always()
2625 .Build());
2626 // clang-format on
2627}
2628
Nandana Dutt979388e2018-11-30 16:48:55 +00002629static void MaybeResolveSymlink(std::string* path) {
2630 std::string resolved_path;
2631 if (android::base::Readlink(*path, &resolved_path)) {
2632 *path = resolved_path;
2633 }
2634}
2635
Nandana Dutt4be45d12018-09-26 15:04:23 +01002636/*
2637 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002638 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002639 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002640static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002641 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2642
Nandana Dutt4be45d12018-09-26 15:04:23 +01002643 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2644 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002645 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002646 char date[80];
2647 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2648 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002649
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002650 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002651 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002652 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002653 ds.base_name_ += "-wifi";
2654 }
2655
Paul Chang0d2aad72020-02-13 20:04:03 +08002656 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002657 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002658 }
2659 ds.tmp_path_ = ds.GetPath(".tmp");
2660 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2661
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002662 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002663 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002664 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002665 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002666 "Bugreport dir: [%s] "
2667 "Base name: [%s] "
2668 "Suffix: [%s] "
2669 "Log path: [%s] "
2670 "Temporary path: [%s] "
2671 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002672 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2673 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002674
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002675 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2676 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2677 create_parent_dirs(ds.path_.c_str());
2678 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2679 if (ds.zip_file == nullptr) {
2680 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2681 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002682 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002683 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2684 ds.AddTextZipEntry("version.txt", ds.version_);
2685 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002686}
2687
2688/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002689 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002690 * printing zipped file status, etc.
2691 */
2692static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002693 bool do_text_file = !ds.FinishZipFile();
2694 if (do_text_file) {
2695 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002696 }
mhasank2d75c442020-06-11 15:05:25 -07002697
2698 std::string final_path = ds.path_;
2699 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002700 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002701 android::os::CopyFileToFile(ds.path_, final_path);
2702 }
2703
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002704 if (ds.options_->stream_to_socket) {
2705 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2706 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002707 if (do_text_file) {
2708 dprintf(ds.control_socket_fd_,
2709 "FAIL:could not create zip file, check %s "
2710 "for more details\n",
2711 ds.log_path_.c_str());
2712 } else {
mhasank2d75c442020-06-11 15:05:25 -07002713 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002714 }
2715 }
2716}
2717
Nandana Dutt4be45d12018-09-26 15:04:23 +01002718
Nandana Dutt58d72e22018-11-16 10:30:48 +00002719static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2720 switch (mode) {
2721 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2722 return "BUGREPORT_FULL";
2723 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2724 return "BUGREPORT_INTERACTIVE";
2725 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2726 return "BUGREPORT_REMOTE";
2727 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2728 return "BUGREPORT_WEAR";
2729 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2730 return "BUGREPORT_TELEPHONY";
2731 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2732 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002733 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2734 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002735 }
2736}
2737
Paul Changf59c2b72020-03-10 02:08:55 +08002738static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2739 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002740 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2741 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002742 options->bugreport_mode = mode;
2743 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002744 switch (mode) {
2745 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002746 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002747 break;
2748 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002749 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002750 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002751 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002752 break;
2753 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002754 options->do_vibrate = false;
2755 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002756 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002757 break;
2758 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002759 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002760 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002761 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002762 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002763 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002764 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002765 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002766 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002767 break;
2768 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002769 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002770 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002771 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002772 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2773 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002774 }
2775}
2776
Nandana Dutt58d72e22018-11-16 10:30:48 +00002777static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002778 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002779 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002780 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002781 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002782 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002783 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002784 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002785 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002786 options.do_progress_updates, options.bugreport_fd.get(),
2787 options.bugreport_mode_string.c_str(),
2788 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002789}
2790
Nandana Dutt54dbd672019-01-11 12:58:05 +00002791void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2792 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002793 const android::base::unique_fd& screenshot_fd_in,
2794 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002795 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002796 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2797 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002798
Paul Changf59c2b72020-03-10 02:08:55 +08002799 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002800}
2801
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002802Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2803 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002804 int c;
mhasankd451a472020-05-26 18:02:39 -07002805 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002806 switch (c) {
2807 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002808 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002809 case 's': stream_to_socket = true; break;
2810 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002811 case 'v': show_header_only = true; break;
2812 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002813 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002814 case 'P': do_progress_updates = true; break;
2815 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002816 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002817 case 'V':
2818 case 'd':
2819 case 'z':
2820 // compatibility no-op
2821 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002822 case 'w':
2823 // This was already processed
2824 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002825 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002826 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002827 break;
2828 default:
2829 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002830 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002831 break;
2832 // clang-format on
2833 }
2834 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002835
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002836 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002837 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002838 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002839 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002840 }
2841 }
2842
2843 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2844 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002845
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002846 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002847}
2848
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002849bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002850 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002851 return false;
2852 }
2853
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002854 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002855 return false;
2856 }
2857
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002858 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002859 return false;
2860 }
2861 return true;
2862}
2863
Nandana Dutt197661d2018-11-16 16:40:21 +00002864void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2865 options_ = std::move(options);
2866}
2867
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002868void Dumpstate::Initialize() {
2869 /* gets the sequential id */
2870 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2871 id_ = ++last_id;
2872 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2873}
2874
Nandana Duttd2f5f082019-01-18 17:13:52 +00002875Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2876 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002877 if (listener_ != nullptr) {
2878 switch (status) {
2879 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002880 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002881 break;
2882 case Dumpstate::RunStatus::HELP:
2883 break;
2884 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002885 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002886 break;
2887 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002888 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2889 break;
2890 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2891 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2892 break;
2893 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2894 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002895 break;
2896 }
2897 }
2898 return status;
2899}
2900
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002901void Dumpstate::Cancel() {
2902 CleanupTmpFiles();
2903 android::os::UnlinkAndLogOnError(log_path_);
2904 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2905 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2906 kDumpstateBoardFiles[i]);
2907 }
2908 tombstone_data_.clear();
2909 anr_data_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002910
2911 // Instead of shutdown the pool, we delete temporary files directly since
2912 // shutdown blocking the call.
2913 if (dump_pool_) {
2914 dump_pool_->deleteTempFiles();
2915 }
2916 if (zip_entry_tasks_) {
2917 zip_entry_tasks_->run(/*do_cancel =*/ true);
2918 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002919}
2920
Nandana Dutt979388e2018-11-30 16:48:55 +00002921/*
2922 * Dumps relevant information to a bugreport based on the given options.
2923 *
2924 * The bugreport can be dumped to a file or streamed to a socket.
2925 *
2926 * How dumping to file works:
2927 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2928 * stderr is redirected a log file.
2929 *
2930 * The temporary bugreport is then populated via printfs, dumping contents of files and
2931 * output of commands to stdout.
2932 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002933 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002934 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002935 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002936 *
mhasank2d75c442020-06-11 15:05:25 -07002937 * Bugreports are first generated in a local directory and later copied to the caller's fd
2938 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002939 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002940Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2941 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002942 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002943 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002944 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002945 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002946 return RunStatus::INVALID_INPUT;
2947 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002948 /* set as high priority, and protect from OOM killer */
2949 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002950
Felipe Lemed071c682016-10-20 16:48:00 -07002951 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002952 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002953 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002954 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002955 } else {
2956 /* fallback to kernels <= 2.6.35 */
2957 oom_adj = fopen("/proc/self/oom_adj", "we");
2958 if (oom_adj) {
2959 fputs("-17", oom_adj);
2960 fclose(oom_adj);
2961 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002962 }
2963
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002964 if (version_ == VERSION_DEFAULT) {
2965 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002966 }
2967
Chris Morin5a50d482022-02-01 17:41:18 -08002968 if (version_ != VERSION_CURRENT) {
2969 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
2970 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002971 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002972 }
2973
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002974 if (options_->show_header_only) {
2975 PrintHeader();
2976 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002977 }
2978
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002979 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2980 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002981
Felipe Leme7447d7c2016-11-03 18:12:22 -07002982 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002983 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002984 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002985 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002986
Sahana Raof35ed432019-07-12 10:47:52 +01002987 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
2988 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
2989 } else {
2990 // Wake lock will be released automatically on process death
2991 MYLOGD("Wake lock acquired.\n");
2992 }
2993
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08002994 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07002995
Felipe Lemef0292972016-11-22 13:57:05 -08002996 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07002997 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
2998 }
2999
Nandana Dutt235c6672019-11-14 15:22:32 +00003000 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003001 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003002
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003003 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003004
Christopher Ferrised9354f2014-10-01 17:35:01 -07003005 // If we are going to use a socket, do it as early as possible
3006 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003007 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003008 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003009 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003010 if (control_socket_fd_ == -1) {
3011 return ERROR;
3012 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003013 if (options_->progress_updates_to_socket) {
3014 options_->do_progress_updates = 1;
3015 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003016 }
3017
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003018 if (!PrepareToWriteToFile()) {
3019 return ERROR;
3020 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003021
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003022 // Interactive, wear & telephony modes are default to true.
3023 // and may enable from cli option or when using control socket
3024 if (options_->do_progress_updates) {
3025 // clang-format off
3026 std::vector<std::string> am_args = {
3027 "--receiver-permission", "android.permission.DUMP",
3028 };
3029 // clang-format on
3030 // Send STARTED broadcast for apps that listen to bugreport generation events
3031 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3032 if (options_->progress_updates_to_socket) {
3033 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003034 }
3035 }
3036
Nick Kralevichf3599b32016-01-25 15:05:16 -08003037 /* read /proc/cmdline before dropping root */
3038 FILE *cmdline = fopen("/proc/cmdline", "re");
3039 if (cmdline) {
3040 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3041 fclose(cmdline);
3042 }
3043
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003044 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003045 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003046 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003047
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003048 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003049 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3050 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003051 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003052 }
3053 }
3054
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003055 int dup_stdout_fd;
3056 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003057 // Redirect stderr to log_path_ for debugging.
3058 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3059 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3060 return ERROR;
3061 }
3062 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3063 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3064 strerror(errno));
3065 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003066
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003067 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3068 // moved into zip file later, if zipping.
3069 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3070 // TODO: why not write to a file instead of stdout to overcome this problem?
3071 /* TODO: rather than generating a text file now and zipping it later,
3072 it would be more efficient to redirect stdout to the zip entry
3073 directly, but the libziparchive doesn't support that option yet. */
3074 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3075 return ERROR;
3076 }
3077 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3078 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3079 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003080 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003081
3082 // Don't buffer stdout
3083 setvbuf(stdout, nullptr, _IONBF, 0);
3084
Rhed Jao5377d792020-07-16 17:37:39 +08003085 // Enable the parallel run if the client requests to output to a file.
3086 EnableParallelRunIfNeeded();
3087 // Using scope guard to make sure the dump pool can be shut down correctly.
3088 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3089 ShutdownDumpPool();
3090 });
3091
Felipe Leme608385d2016-02-01 10:35:38 -08003092 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3093 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003094 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003095 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003096
Gavin Corkery6968f552020-11-22 18:09:05 +00003097 bool is_dumpstate_restricted = options_->telephony_only
3098 || options_->wifi_only
3099 || options_->limited_only;
3100 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003101 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003102 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003103 }
3104 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003105
3106 if (!is_dumpstate_restricted) {
3107 // Snapshot the system trace now (if running) to avoid that dumpstate's
3108 // own activity pushes out interesting data from the trace ring buffer.
3109 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3110 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003111
3112 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3113 // from WMTRACE_DATA_DIR.
3114 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003115 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003116 onUiIntensiveBugreportDumpsFinished(calling_uid);
3117 MaybeCheckUserConsent(calling_uid, calling_package);
3118 if (options_->telephony_only) {
3119 DumpstateTelephonyOnly(calling_package);
3120 } else if (options_->wifi_only) {
3121 DumpstateWifiOnly();
3122 } else if (options_->limited_only) {
3123 DumpstateLimitedOnly();
3124 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003125 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003126 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003127 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003128 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003129 HandleUserConsentDenied();
3130 }
3131 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003132 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003133 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003134
Felipe Leme55b42a62015-11-10 17:39:08 -08003135 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003136 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003137
Abhijeet Kaure370d682019-10-01 16:49:30 +01003138 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003139 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003140 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003141 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003142
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003143 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003144 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003145 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003146 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003147 if (status != Dumpstate::RunStatus::OK &&
3148 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3149 // Do an early return if there were errors. We make an exception for consent
3150 // timing out because it's possible the user got distracted. In this case the
3151 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003152 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003153 return status;
3154 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003155 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3156 MYLOGI(
3157 "Did not receive user consent yet."
3158 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003159 const String16 incidentcompanion("incidentcompanion");
3160 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3161 if (ics != nullptr) {
3162 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3163 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3164 consent_callback_.get());
3165 } else {
3166 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3167 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003168 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003169 }
3170
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003171 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003172 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003173 for (int i = 0; i < 3; i++) {
3174 Vibrate(75);
3175 usleep((75 + 50) * 1000);
3176 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003177 }
3178
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003179 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3180 progress_->GetInitialMax());
3181 progress_->Save();
3182 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003183
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003184 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003185
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003186 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003187 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003188 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003189 }
3190
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003191 tombstone_data_.clear();
3192 anr_data_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003193
Nandana Duttd2f5f082019-01-18 17:13:52 +00003194 return (consent_callback_ != nullptr &&
3195 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3196 ? USER_CONSENT_TIMED_OUT
3197 : RunStatus::OK;
3198}
3199
Paul Chang0d2aad72020-02-13 20:04:03 +08003200void Dumpstate::MaybeTakeEarlyScreenshot() {
3201 if (!options_->do_screenshot || !do_early_screenshot_) {
3202 return;
3203 }
3204
3205 TakeScreenshot();
3206}
3207
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003208void Dumpstate::MaybeSnapshotSystemTrace() {
3209 // If a background system trace is happening and is marked as "suitable for
3210 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3211 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3212 // case that no trace is ongoing, this command is a no-op.
3213 // Note: this should not be enqueued as we need to freeze the trace before
3214 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3215 // the dumpstate's own activity which is irrelevant.
3216 int res = RunCommand(
3217 "SERIALIZE PERFETTO TRACE",
3218 {"perfetto", "--save-for-bugreport"},
3219 CommandOptions::WithTimeout(10)
3220 .DropRoot()
3221 .CloseAllFileDescriptorsOnExec()
3222 .Build());
3223 has_system_trace_ = res == 0;
3224 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3225 // file in the later stages.
3226}
3227
Yohei Yukawa95305b32021-03-09 07:54:27 -08003228void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003229 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3230 for (const auto& service : {"window", "input_method"}) {
3231 RunCommand(
3232 // Empty name because it's not intended to be classified as a bugreport section.
3233 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3234 "", {"cmd", service, "tracing", "save-for-bugreport"},
3235 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3236 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003237}
3238
Paul Changeb4b4642020-05-28 22:05:47 +08003239void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003240 if (calling_uid == AID_SHELL || !CalledByApi()) {
3241 return;
3242 }
3243 if (listener_ != nullptr) {
3244 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3245 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003246 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003247 }
3248}
3249
Jichao Lie89d9c12019-11-21 19:02:51 -08003250void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3251 if (calling_uid == AID_SHELL || !CalledByApi()) {
3252 // No need to get consent for shell triggered dumpstates, or not through
3253 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003254 return;
3255 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003256 consent_callback_ = new ConsentCallback();
3257 const String16 incidentcompanion("incidentcompanion");
3258 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003259 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003260 if (ics != nullptr) {
3261 MYLOGD("Checking user consent via incidentcompanion service\n");
3262 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003263 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003264 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003265 } else {
3266 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3267 }
3268}
3269
Nandana Dutt5c390032019-03-12 10:52:56 +00003270bool Dumpstate::IsUserConsentDenied() const {
3271 return ds.consent_callback_ != nullptr &&
3272 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3273}
3274
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003275bool Dumpstate::CalledByApi() const {
3276 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3277}
3278
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003279void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003280 android::os::UnlinkAndLogOnError(tmp_path_);
3281 android::os::UnlinkAndLogOnError(screenshot_path_);
3282 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003283 if (dump_traces_path != nullptr) {
3284 android::os::UnlinkAndLogOnError(dump_traces_path);
3285 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003286}
3287
Rhed Jao5377d792020-07-16 17:37:39 +08003288void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003289 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003290 return;
3291 }
3292 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003293 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003294}
3295
3296void Dumpstate::ShutdownDumpPool() {
3297 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003298 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003299 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003300 if (zip_entry_tasks_) {
3301 zip_entry_tasks_->run(/* do_cancel = */true);
3302 zip_entry_tasks_ = nullptr;
3303 }
3304}
3305
3306void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3307 const std::string& entry_path) {
3308 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3309 if (!task_cancelled) {
3310 AddZipEntry(entry_name, entry_path);
3311 }
3312 android::os::UnlinkAndLogOnError(entry_path);
3313 };
3314 if (zip_entry_tasks_) {
3315 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3316 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3317 } else {
3318 // Invokes AddZipEntryAndCleanup immediately
3319 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3320 }
Rhed Jao5377d792020-07-16 17:37:39 +08003321}
3322
Nandana Duttd2f5f082019-01-18 17:13:52 +00003323Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3324 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003325 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003326 return USER_CONSENT_DENIED;
3327}
3328
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003329Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003330 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003331 // user consent (unless the caller is Shell).
3332 UserConsentResult consent_result;
3333 if (calling_uid == AID_SHELL) {
3334 consent_result = UserConsentResult::APPROVED;
3335 } else {
3336 consent_result = consent_callback_->getResult();
3337 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003338 if (consent_result == UserConsentResult::UNAVAILABLE) {
3339 // User has not responded yet.
3340 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003341 // Telephony is a fast report type, particularly on user builds where information may be
3342 // more aggressively limited. To give the user time to read the consent dialog, increase the
3343 // timeout.
3344 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3345 : USER_CONSENT_TIMEOUT_MS;
3346 if (elapsed_ms < timeout_ms) {
3347 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003348 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3349 sleep(delay_seconds);
3350 }
3351 consent_result = consent_callback_->getResult();
3352 }
3353 if (consent_result == UserConsentResult::DENIED) {
3354 // User has explicitly denied sharing with the app. To be safe delete the
3355 // internal bugreport & tmp files.
3356 return HandleUserConsentDenied();
3357 }
3358 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003359 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3360 if (copy_succeeded) {
3361 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003362 if (options_->do_screenshot &&
3363 options_->screenshot_fd.get() != -1 &&
3364 !options_->is_screenshot_copied) {
3365 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3366 options_->screenshot_fd.get());
3367 options_->is_screenshot_copied = copy_succeeded;
3368 if (copy_succeeded) {
3369 android::os::UnlinkAndLogOnError(screenshot_path_);
3370 }
3371 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003372 }
3373 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3374 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3375 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3376 // Since we do not have user consent to share the bugreport it does not get
3377 // copied over to the calling app but remains in the internal directory from
3378 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003379 std::string final_path = GetPath(".zip");
3380 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3381 if (copy_succeeded) {
3382 android::os::UnlinkAndLogOnError(path_);
3383 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003384 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3385 }
3386 // Unknown result; must be a programming error.
3387 MYLOGE("Unknown user consent result:%d\n", consent_result);
3388 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003389}
3390
Nandana Duttf02564e2019-02-15 15:24:24 +00003391Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003392 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3393 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3394 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003395 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003396 // When directly running dumpstate binary, the output is not expected to be written
3397 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003398 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003399
3400 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003401 // an app; they are irrelevant here because bugreport is triggered via command line.
3402 // Update Last ID before calling Run().
3403 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003404 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003405 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003406 return status;
3407}
3408
3409/* Main entry point for dumpstate binary. */
3410int run_main(int argc, char* argv[]) {
3411 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003412
3413 switch (status) {
3414 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003415 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003416 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003417 ShowUsage();
3418 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003419 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003420 fprintf(stderr, "Invalid combination of args\n");
3421 ShowUsage();
3422 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003423 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003424 FALLTHROUGH_INTENDED;
3425 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3426 FALLTHROUGH_INTENDED;
3427 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003428 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003429 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003430}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003431
3432// TODO(111441001): Default DumpOptions to sensible values.
3433Dumpstate::Dumpstate(const std::string& version)
3434 : pid_(getpid()),
3435 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003436 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003437 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003438 now_(time(nullptr)),
3439 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003440}
3441
3442Dumpstate& Dumpstate::GetInstance() {
3443 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3444 return singleton_;
3445}
3446
Rhed Jao5377d792020-07-16 17:37:39 +08003447DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3448 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3449 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003450 if (!title_.empty()) {
3451 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003452 if (title_.find("SHOW MAP") == std::string::npos) {
3453 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3454 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003455 }
3456}
3457
3458DurationReporter::~DurationReporter() {
3459 if (!title_.empty()) {
3460 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003461 if (elapsed >= .5f || verbose_) {
3462 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003463 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003464 if (!logcat_only_) {
3465 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003466 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3467 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003468 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003469 if (title_.find("SHOW MAP") == std::string::npos) {
3470 ATRACE_ASYNC_END(title_.c_str(), 0);
3471 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003472 }
3473}
3474
3475const int32_t Progress::kDefaultMax = 5000;
3476
3477Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3478}
3479
3480Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3481 : Progress(initial_max, growth_factor, "") {
3482 progress_ = progress;
3483}
3484
3485Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3486 : initial_max_(initial_max),
3487 progress_(0),
3488 max_(initial_max),
3489 growth_factor_(growth_factor),
3490 n_runs_(0),
3491 average_max_(0),
3492 path_(path) {
3493 if (!path_.empty()) {
3494 Load();
3495 }
3496}
3497
3498void Progress::Load() {
3499 MYLOGD("Loading stats from %s\n", path_.c_str());
3500 std::string content;
3501 if (!android::base::ReadFileToString(path_, &content)) {
3502 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3503 return;
3504 }
3505 if (content.empty()) {
3506 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3507 return;
3508 }
3509 std::vector<std::string> lines = android::base::Split(content, "\n");
3510
3511 if (lines.size() < 1) {
3512 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3513 (int)lines.size(), max_);
3514 return;
3515 }
3516 char* ptr;
3517 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3518 average_max_ = strtol(ptr, nullptr, 10);
3519 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3520 average_max_ > STATS_MAX_AVERAGE) {
3521 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3522 initial_max_ = Progress::kDefaultMax;
3523 } else {
3524 initial_max_ = average_max_;
3525 }
3526 max_ = initial_max_;
3527
3528 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3529}
3530
3531void Progress::Save() {
3532 int32_t total = n_runs_ * average_max_ + progress_;
3533 int32_t runs = n_runs_ + 1;
3534 int32_t average = floor(((float)total) / runs);
3535 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3536 path_.c_str());
3537 if (path_.empty()) {
3538 return;
3539 }
3540
3541 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3542 if (!android::base::WriteStringToFile(content, path_)) {
3543 MYLOGE("Could not save stats on %s\n", path_.c_str());
3544 }
3545}
3546
3547int32_t Progress::Get() const {
3548 return progress_;
3549}
3550
3551bool Progress::Inc(int32_t delta_sec) {
3552 bool changed = false;
3553 if (delta_sec >= 0) {
3554 progress_ += delta_sec;
3555 if (progress_ > max_) {
3556 int32_t old_max = max_;
3557 max_ = floor((float)progress_ * growth_factor_);
3558 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3559 changed = true;
3560 }
3561 }
3562 return changed;
3563}
3564
3565int32_t Progress::GetMax() const {
3566 return max_;
3567}
3568
3569int32_t Progress::GetInitialMax() const {
3570 return initial_max_;
3571}
3572
3573void Progress::Dump(int fd, const std::string& prefix) const {
3574 const char* pr = prefix.c_str();
3575 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3576 dprintf(fd, "%smax: %d\n", pr, max_);
3577 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3578 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3579 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3580 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3581 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3582}
3583
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003584std::string Dumpstate::GetPath(const std::string& suffix) const {
3585 return GetPath(bugreport_internal_dir_, suffix);
3586}
3587
3588std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3589 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3590 name_.c_str(), suffix.c_str());
3591}
3592
3593void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3594 progress_ = std::move(progress);
3595}
3596
3597void for_each_userid(void (*func)(int), const char *header) {
3598 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3599 "for_each_userid(%s)", header);
3600 DurationReporter duration_reporter(title);
3601 if (PropertiesHelper::IsDryRun()) return;
3602
3603 DIR *d;
3604 struct dirent *de;
3605
3606 if (header) printf("\n------ %s ------\n", header);
3607 func(0);
3608
3609 if (!(d = opendir("/data/system/users"))) {
3610 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3611 return;
3612 }
3613
3614 while ((de = readdir(d))) {
3615 int userid;
3616 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3617 continue;
3618 }
3619 func(userid);
3620 }
3621
3622 closedir(d);
3623}
3624
3625static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3626 DIR *d;
3627 struct dirent *de;
3628
3629 if (!(d = opendir("/proc"))) {
3630 printf("Failed to open /proc (%s)\n", strerror(errno));
3631 return;
3632 }
3633
3634 if (header) printf("\n------ %s ------\n", header);
3635 while ((de = readdir(d))) {
3636 if (ds.IsUserConsentDenied()) {
3637 MYLOGE(
3638 "Returning early because user denied consent to share bugreport with calling app.");
3639 closedir(d);
3640 return;
3641 }
3642 int pid;
3643 int fd;
3644 char cmdpath[255];
3645 char cmdline[255];
3646
3647 if (!(pid = atoi(de->d_name))) {
3648 continue;
3649 }
3650
3651 memset(cmdline, 0, sizeof(cmdline));
3652
3653 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3654 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3655 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3656 close(fd);
3657 if (cmdline[0]) {
3658 helper(pid, cmdline, arg);
3659 continue;
3660 }
3661 }
3662
3663 // if no cmdline, a kernel thread has comm
3664 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3665 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3666 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3667 close(fd);
3668 if (cmdline[1]) {
3669 cmdline[0] = '[';
3670 size_t len = strcspn(cmdline, "\f\b\r\n");
3671 cmdline[len] = ']';
3672 cmdline[len+1] = '\0';
3673 }
3674 }
3675 if (!cmdline[0]) {
3676 strcpy(cmdline, "N/A");
3677 }
3678 helper(pid, cmdline, arg);
3679 }
3680
3681 closedir(d);
3682}
3683
3684static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3685 for_each_pid_func *func = (for_each_pid_func*) arg;
3686 func(pid, cmdline);
3687}
3688
3689void for_each_pid(for_each_pid_func func, const char *header) {
3690 std::string title = header == nullptr ? "for_each_pid"
3691 : android::base::StringPrintf("for_each_pid(%s)", header);
3692 DurationReporter duration_reporter(title);
3693 if (PropertiesHelper::IsDryRun()) return;
3694
3695 __for_each_pid(for_each_pid_helper, header, (void *) func);
3696}
3697
3698static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3699 DIR *d;
3700 struct dirent *de;
3701 char taskpath[255];
3702 for_each_tid_func *func = (for_each_tid_func *) arg;
3703
3704 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3705
3706 if (!(d = opendir(taskpath))) {
3707 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3708 return;
3709 }
3710
3711 func(pid, pid, cmdline);
3712
3713 while ((de = readdir(d))) {
3714 if (ds.IsUserConsentDenied()) {
3715 MYLOGE(
3716 "Returning early because user denied consent to share bugreport with calling app.");
3717 closedir(d);
3718 return;
3719 }
3720 int tid;
3721 int fd;
3722 char commpath[255];
3723 char comm[255];
3724
3725 if (!(tid = atoi(de->d_name))) {
3726 continue;
3727 }
3728
3729 if (tid == pid)
3730 continue;
3731
3732 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3733 memset(comm, 0, sizeof(comm));
3734 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3735 strcpy(comm, "N/A");
3736 } else {
3737 char *c;
3738 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3739 close(fd);
3740
3741 c = strrchr(comm, '\n');
3742 if (c) {
3743 *c = '\0';
3744 }
3745 }
3746 func(pid, tid, comm);
3747 }
3748
3749 closedir(d);
3750}
3751
3752void for_each_tid(for_each_tid_func func, const char *header) {
3753 std::string title = header == nullptr ? "for_each_tid"
3754 : android::base::StringPrintf("for_each_tid(%s)", header);
3755 DurationReporter duration_reporter(title);
3756
3757 if (PropertiesHelper::IsDryRun()) return;
3758
3759 __for_each_pid(for_each_tid_helper, header, (void *) func);
3760}
3761
3762void show_wchan(int pid, int tid, const char *name) {
3763 if (PropertiesHelper::IsDryRun()) return;
3764
3765 char path[255];
3766 char buffer[255];
3767 int fd, ret, save_errno;
3768 char name_buffer[255];
3769
3770 memset(buffer, 0, sizeof(buffer));
3771
3772 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3773 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3774 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3775 return;
3776 }
3777
3778 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3779 save_errno = errno;
3780 close(fd);
3781
3782 if (ret < 0) {
3783 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3784 return;
3785 }
3786
3787 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3788 pid == tid ? 0 : 3, "", name);
3789
3790 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3791
3792 return;
3793}
3794
3795// print time in centiseconds
3796static void snprcent(char *buffer, size_t len, size_t spc,
3797 unsigned long long time) {
3798 static long hz; // cache discovered hz
3799
3800 if (hz <= 0) {
3801 hz = sysconf(_SC_CLK_TCK);
3802 if (hz <= 0) {
3803 hz = 1000;
3804 }
3805 }
3806
3807 // convert to centiseconds
3808 time = (time * 100 + (hz / 2)) / hz;
3809
3810 char str[16];
3811
3812 snprintf(str, sizeof(str), " %llu.%02u",
3813 time / 100, (unsigned)(time % 100));
3814 size_t offset = strlen(buffer);
3815 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3816 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3817}
3818
3819// print permille as a percent
3820static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3821 char str[16];
3822
3823 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3824 size_t offset = strlen(buffer);
3825 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3826 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3827}
3828
3829void show_showtime(int pid, const char *name) {
3830 if (PropertiesHelper::IsDryRun()) return;
3831
3832 char path[255];
3833 char buffer[1023];
3834 int fd, ret, save_errno;
3835
3836 memset(buffer, 0, sizeof(buffer));
3837
3838 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3839 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3840 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3841 return;
3842 }
3843
3844 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3845 save_errno = errno;
3846 close(fd);
3847
3848 if (ret < 0) {
3849 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3850 return;
3851 }
3852
3853 // field 14 is utime
3854 // field 15 is stime
3855 // field 42 is iotime
3856 unsigned long long utime = 0, stime = 0, iotime = 0;
3857 if (sscanf(buffer,
3858 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3859 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3860 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3861 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3862 &utime, &stime, &iotime) != 3) {
3863 return;
3864 }
3865
3866 unsigned long long total = utime + stime;
3867 if (!total) {
3868 return;
3869 }
3870
3871 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3872 if (permille > 1000) {
3873 permille = 1000;
3874 }
3875
3876 // try to beautify and stabilize columns at <80 characters
3877 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3878 if ((name[0] != '[') || utime) {
3879 snprcent(buffer, sizeof(buffer), 57, utime);
3880 }
3881 snprcent(buffer, sizeof(buffer), 65, stime);
3882 if ((name[0] != '[') || iotime) {
3883 snprcent(buffer, sizeof(buffer), 73, iotime);
3884 }
3885 if (iotime) {
3886 snprdec(buffer, sizeof(buffer), 79, permille);
3887 }
3888 puts(buffer); // adds a trailing newline
3889
3890 return;
3891}
3892
3893void do_dmesg() {
3894 const char *title = "KERNEL LOG (dmesg)";
3895 DurationReporter duration_reporter(title);
3896 printf("------ %s ------\n", title);
3897
3898 if (PropertiesHelper::IsDryRun()) return;
3899
3900 /* Get size of kernel buffer */
3901 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3902 if (size <= 0) {
3903 printf("Unexpected klogctl return value: %d\n\n", size);
3904 return;
3905 }
3906 char *buf = (char *) malloc(size + 1);
3907 if (buf == nullptr) {
3908 printf("memory allocation failed\n\n");
3909 return;
3910 }
3911 int retval = klogctl(KLOG_READ_ALL, buf, size);
3912 if (retval < 0) {
3913 printf("klogctl failure\n\n");
3914 free(buf);
3915 return;
3916 }
3917 buf[retval] = '\0';
3918 printf("%s\n\n", buf);
3919 free(buf);
3920 return;
3921}
3922
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003923int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3924 DurationReporter duration_reporter(title);
3925
3926 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3927
3928 UpdateProgress(WEIGHT_FILE);
3929
3930 return status;
3931}
3932
3933int read_file_as_long(const char *path, long int *output) {
3934 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3935 if (fd < 0) {
3936 int err = errno;
3937 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3938 return -1;
3939 }
3940 char buffer[50];
3941 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3942 if (bytes_read == -1) {
3943 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3944 return -2;
3945 }
3946 if (bytes_read == 0) {
3947 MYLOGE("File %s is empty\n", path);
3948 return -3;
3949 }
3950 *output = atoi(buffer);
3951 return 0;
3952}
3953
3954/* calls skip to gate calling dump_from_fd recursively
3955 * in the specified directory. dump_from_fd defaults to
3956 * dump_file_from_fd above when set to NULL. skip defaults
3957 * to false when set to NULL. dump_from_fd will always be
3958 * called with title NULL.
3959 */
3960int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3961 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3962 DurationReporter duration_reporter(title);
3963 DIR *dirp;
3964 struct dirent *d;
3965 char *newpath = nullptr;
3966 const char *slash = "/";
3967 int retval = 0;
3968
3969 if (!title.empty()) {
3970 printf("------ %s (%s) ------\n", title.c_str(), dir);
3971 }
3972 if (PropertiesHelper::IsDryRun()) return 0;
3973
3974 if (dir[strlen(dir) - 1] == '/') {
3975 ++slash;
3976 }
3977 dirp = opendir(dir);
3978 if (dirp == nullptr) {
3979 retval = -errno;
3980 MYLOGE("%s: %s\n", dir, strerror(errno));
3981 return retval;
3982 }
3983
3984 if (!dump_from_fd) {
3985 dump_from_fd = dump_file_from_fd;
3986 }
3987 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
3988 if ((d->d_name[0] == '.')
3989 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
3990 || (d->d_name[1] == '\0'))) {
3991 continue;
3992 }
3993 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
3994 (d->d_type == DT_DIR) ? "/" : "");
3995 if (!newpath) {
3996 retval = -errno;
3997 continue;
3998 }
3999 if (skip && (*skip)(newpath)) {
4000 continue;
4001 }
4002 if (d->d_type == DT_DIR) {
4003 int ret = dump_files("", newpath, skip, dump_from_fd);
4004 if (ret < 0) {
4005 retval = ret;
4006 }
4007 continue;
4008 }
4009 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4010 if (fd.get() < 0) {
4011 retval = -1;
4012 printf("*** %s: %s\n", newpath, strerror(errno));
4013 continue;
4014 }
4015 (*dump_from_fd)(nullptr, newpath, fd.get());
4016 }
4017 closedir(dirp);
4018 if (!title.empty()) {
4019 printf("\n");
4020 }
4021 return retval;
4022}
4023
4024/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4025 * it's possible to avoid issues where opening the file itself can get
4026 * stuck.
4027 */
4028int dump_file_from_fd(const char *title, const char *path, int fd) {
4029 if (PropertiesHelper::IsDryRun()) return 0;
4030
4031 int flags = fcntl(fd, F_GETFL);
4032 if (flags == -1) {
4033 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4034 return -1;
4035 } else if (!(flags & O_NONBLOCK)) {
4036 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4037 return -1;
4038 }
4039 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4040}
4041
4042int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004043 const CommandOptions& options, bool verbose_duration, int out_fd) {
4044 DurationReporter duration_reporter(title, false /* logcat_only */,
4045 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004046
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004047 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004048
4049 /* TODO: for now we're simplifying the progress calculation by using the
4050 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4051 * where its weight should be much higher proportionally to its timeout.
4052 * Ideally, it should use a options.EstimatedDuration() instead...*/
4053 UpdateProgress(options.Timeout());
4054
4055 return status;
4056}
4057
4058void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004059 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004060 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4061 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4062 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004063 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004064}
4065
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004066static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004067 int s = android_get_control_socket(service);
4068 if (s < 0) {
4069 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4070 return -1;
4071 }
4072 fcntl(s, F_SETFD, FD_CLOEXEC);
4073
4074 // Set backlog to 0 to make sure that queue size will be minimum.
4075 // In Linux, because the minimum queue will be 1, connect() will be blocked
4076 // if the other clients already called connect() and the connection request was not accepted.
4077 if (listen(s, 0) < 0) {
4078 MYLOGE("listen(control socket): %s\n", strerror(errno));
4079 return -1;
4080 }
4081
4082 struct sockaddr addr;
4083 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004084 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004085
4086 // Close socket just after accept(), to make sure that connect() by client will get error
4087 // when the socket is used by the other services.
4088 // There is still a race condition possibility between accept and close, but there is no way
4089 // to close-on-accept atomically.
4090 // See detail; b/123306389#comment25
4091 close(s);
4092
4093 if (fd < 0) {
4094 MYLOGE("accept(control socket): %s\n", strerror(errno));
4095 return -1;
4096 }
4097
4098 return fd;
4099}
4100
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004101// TODO: should call is_valid_output_file and/or be merged into it.
4102void create_parent_dirs(const char *path) {
4103 char *chp = const_cast<char *> (path);
4104
4105 /* skip initial slash */
4106 if (chp[0] == '/')
4107 chp++;
4108
4109 /* create leading directories, if necessary */
4110 struct stat dir_stat;
4111 while (chp && chp[0]) {
4112 chp = strchr(chp, '/');
4113 if (chp) {
4114 *chp = 0;
4115 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4116 MYLOGI("Creating directory %s\n", path);
4117 if (mkdir(path, 0770)) { /* drwxrwx--- */
4118 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4119 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4120 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4121 }
4122 }
4123 *chp++ = '/';
4124 }
4125 }
4126}
4127
4128bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4129 create_parent_dirs(path);
4130
4131 int fd = TEMP_FAILURE_RETRY(open(path,
4132 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4133 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4134 if (fd < 0) {
4135 MYLOGE("%s: %s\n", path, strerror(errno));
4136 return false;
4137 }
4138
4139 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4140 close(fd);
4141 return true;
4142}
4143
4144bool redirect_to_file(FILE* redirect, char* path) {
4145 return _redirect_to_file(redirect, path, O_TRUNC);
4146}
4147
4148bool redirect_to_existing_file(FILE* redirect, char* path) {
4149 return _redirect_to_file(redirect, path, O_APPEND);
4150}
4151
4152void dump_route_tables() {
4153 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4154 if (PropertiesHelper::IsDryRun()) return;
4155 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4156 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4157 FILE* fp = fopen(RT_TABLES_PATH, "re");
4158 if (!fp) {
4159 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4160 return;
4161 }
4162 char table[16];
4163 // Each line has an integer (the table number), a space, and a string (the table name). We only
4164 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4165 // Add a fixed max limit so this doesn't go awry.
4166 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4167 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4168 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4169 }
4170 fclose(fp);
4171}
4172
Li Li830179f2022-01-04 12:53:29 -08004173void dump_frozen_cgroupfs(const char *dir, int level,
4174 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4175 DIR *dirp;
4176 struct dirent *d;
4177 char *newpath = nullptr;
4178
4179 dirp = opendir(dir);
4180 if (dirp == nullptr) {
4181 MYLOGE("%s: %s\n", dir, strerror(errno));
4182 return;
4183 }
4184
4185 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4186 if ((d->d_name[0] == '.')
4187 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4188 || (d->d_name[1] == '\0'))) {
4189 continue;
4190 }
4191 if (d->d_type == DT_DIR) {
4192 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4193 if (!newpath) {
4194 continue;
4195 }
4196 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4197 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4198 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4199 char *freezer = nullptr;
4200 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4201 if (freezer) {
4202 FILE* fp = fopen(freezer, "r");
4203 if (fp != NULL) {
4204 int frozen;
4205 fscanf(fp, "%d", &frozen);
4206 if (frozen > 0) {
4207 dump_files("", newpath, skip_none, dump_from_fd);
4208 }
4209 fclose(fp);
4210 }
4211 free(freezer);
4212 }
4213 }
4214 }
4215 }
4216 closedir(dirp);
4217}
4218
4219void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004220 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4221 DurationReporter duration_reporter("FROZEN CGROUPFS");
4222 if (PropertiesHelper::IsDryRun()) return;
4223 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4224}
4225
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004226void Dumpstate::UpdateProgress(int32_t delta_sec) {
4227 if (progress_ == nullptr) {
4228 MYLOGE("UpdateProgress: progress_ not set\n");
4229 return;
4230 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004231 // This function updates progress related members of the dumpstate and reports
4232 // progress percentage to the bugreport client. Since it could be called by
4233 // different dump tasks at the same time if the parallel run is enabled, a
4234 // mutex lock is necessary here to synchronize the call.
4235 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004236
4237 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004238 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004239
4240 // ...but only notifiy listeners when necessary.
4241 if (!options_->do_progress_updates) return;
4242
4243 int progress = progress_->Get();
4244 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004245 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004246
Nandana Dutt402a8392019-06-14 14:25:13 +01004247 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004248 return;
4249 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004250 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004251
4252 if (control_socket_fd_ >= 0) {
4253 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4254 fsync(control_socket_fd_);
4255 }
4256
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004257 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004258 if (percent % 10 == 0) {
4259 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004260 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004261 } else {
4262 // stderr is ignored on normal invocations, but useful when calling
4263 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004264 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004265 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004266
4267 listener_->onProgress(percent);
4268 }
4269}
4270
4271void Dumpstate::TakeScreenshot(const std::string& path) {
4272 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4273 int status =
4274 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4275 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4276 if (status == 0) {
4277 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4278 } else {
4279 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4280 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004281 if (listener_ != nullptr) {
4282 // Show a visual indication to indicate screenshot is taken via
4283 // IDumpstateListener.onScreenshotTaken()
4284 listener_->onScreenshotTaken(status == 0);
4285 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004286}
4287
4288bool is_dir(const char* pathname) {
4289 struct stat info;
4290 if (stat(pathname, &info) == -1) {
4291 return false;
4292 }
4293 return S_ISDIR(info.st_mode);
4294}
4295
4296time_t get_mtime(int fd, time_t default_mtime) {
4297 struct stat info;
4298 if (fstat(fd, &info) == -1) {
4299 return default_mtime;
4300 }
4301 return info.st_mtime;
4302}