blob: 12de33f2dbb380b298e7dbce7b87d6c4a1443dcc [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_";
Woody Lin20767a92022-11-29 15:50:24 +0800197static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
198static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700199
Felipe Lemee844a9d2016-09-21 15:01:39 -0700200// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000201
Nandana Dutt5c390032019-03-12 10:52:56 +0000202#define RETURN_IF_USER_DENIED_CONSENT() \
203 if (ds.IsUserConsentDenied()) { \
204 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
205 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
206 }
207
208// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
209// if consent is found to be denied.
210#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
211 RETURN_IF_USER_DENIED_CONSENT(); \
212 func_ptr(__VA_ARGS__); \
213 RETURN_IF_USER_DENIED_CONSENT();
214
Rhed Jao5377d792020-07-16 17:37:39 +0800215// Runs func_ptr, and logs a duration report after it's finished.
216#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
217 { \
218 DurationReporter duration_reporter_in_macro(log_title); \
219 func_ptr(__VA_ARGS__); \
220 }
221
222// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
223// is output after a slow function is finished.
224#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
225 RETURN_IF_USER_DENIED_CONSENT(); \
226 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
227 RETURN_IF_USER_DENIED_CONSENT();
228
Chris Morinbc223142022-02-04 14:17:11 -0800229#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800230 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800231 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800232 RETURN_IF_USER_DENIED_CONSENT();
233
Sahana Raof35ed432019-07-12 10:47:52 +0100234static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
235
Rhed Jao5377d792020-07-16 17:37:39 +0800236// Names of parallel tasks, they are used for the DumpPool to identify the dump
237// task and the log title of the duration report.
238static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800239static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800240static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800241static const std::string DUMP_HALS_TASK = "DUMP HALS";
242static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800243static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800244
Nandana Dutt979388e2018-11-30 16:48:55 +0000245namespace android {
246namespace os {
247namespace {
248
249static int Open(std::string path, int flags, mode_t mode = 0) {
250 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
251 if (fd == -1) {
252 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
253 }
254 return fd;
255}
256
mhasank2d75c442020-06-11 15:05:25 -0700257static int OpenForWrite(std::string path) {
258 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
259 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
260}
Nandana Dutt979388e2018-11-30 16:48:55 +0000261
262static int OpenForRead(std::string path) {
263 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
264}
265
266bool CopyFile(int in_fd, int out_fd) {
267 char buf[4096];
268 ssize_t byte_count;
269 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
270 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
271 return false;
272 }
273 }
274 return (byte_count != -1);
275}
276
277static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000278 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000279
280 // Obtain a handle to the source file.
281 android::base::unique_fd in_fd(OpenForRead(input_file));
282 if (out_fd != -1 && in_fd.get() != -1) {
283 if (CopyFile(in_fd.get(), out_fd)) {
284 return true;
285 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000286 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000287 }
288 return false;
289}
290
Nandana Duttd2f5f082019-01-18 17:13:52 +0000291static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000292 if (file.empty()) {
293 return false;
294 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000295 if (unlink(file.c_str())) {
296 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000297 return false;
298 }
299 return true;
300}
Nandana Dutt979388e2018-11-30 16:48:55 +0000301
Nikita Ioffea325a572019-05-16 19:49:47 +0100302int64_t GetModuleMetadataVersion() {
303 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
304 if (binder == nullptr) {
305 MYLOGE("Failed to retrieve package_native service");
306 return 0L;
307 }
308 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
309 std::string package_name;
310 auto status = package_service->getModuleMetadataPackageName(&package_name);
311 if (!status.isOk()) {
312 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
313 return 0L;
314 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100315 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100316 int64_t version_code;
317 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
318 &version_code);
319 if (!status.isOk()) {
320 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
321 return 0L;
322 }
323 return version_code;
324}
325
mhasank2d75c442020-06-11 15:05:25 -0700326static bool PathExists(const std::string& path) {
327 struct stat sb;
328 return stat(path.c_str(), &sb) == 0;
329}
330
331static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
332 if (input_file == output_file) {
333 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
334 output_file.c_str());
335 return false;
336 }
337 else if (PathExists(output_file)) {
338 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
339 return false;
340 }
341
342 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
343 android::base::unique_fd out_fd(OpenForWrite(output_file));
344 return CopyFileToFd(input_file, out_fd.get());
345}
346
Nandana Dutt979388e2018-11-30 16:48:55 +0000347} // namespace
348} // namespace os
349} // namespace android
350
Felipe Leme678727a2016-09-21 17:22:11 -0700351static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800352 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800353 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
354 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
355}
356static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
357 int out_fd) {
358 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700359}
360static int DumpFile(const std::string& title, const std::string& path) {
361 return ds.DumpFile(title, path);
362}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800363
Felipe Lemee844a9d2016-09-21 15:01:39 -0700364// Relative directory (inside the zip) for all files copied as-is into the bugreport.
365static const std::string ZIP_ROOT_DIR = "FS";
366
Vishnu Naire97d6122018-01-18 13:58:56 -0800367static const std::string kProtoPath = "proto/";
368static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700369static const std::string kDumpstateBoardFiles[] = {
370 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700371 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700372};
373static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
374
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700375static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700376static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700377
Felipe Lemef0292972016-11-22 13:57:05 -0800378static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
379
Narayan Kamath8f788292017-05-25 13:20:39 +0100380/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100381 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800382 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800383 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100384 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700385static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800386 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100387 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100388
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700389 if (dump_dir == nullptr) {
390 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700391 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700392 }
393
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700394 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100395 struct dirent* entry = nullptr;
396 while ((entry = readdir(dump_dir.get()))) {
397 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100398 continue;
399 }
400
Narayan Kamathbd863722017-06-01 18:50:12 +0100401 const std::string base_name(entry->d_name);
402 if (base_name.find(file_prefix) != 0) {
403 continue;
404 }
405
406 const std::string abs_path = dir_path + base_name;
407 android::base::unique_fd fd(
408 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
409 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700410 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100411 break;
412 }
413
414 struct stat st = {};
415 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700416 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100417 continue;
418 }
419
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700420 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700421 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800422 if (!dump_data.empty()) {
423 std::sort(dump_data.begin(), dump_data.end(),
424 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
425 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100426
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700427 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100428}
429
Narayan Kamathbd863722017-06-01 18:50:12 +0100430static bool AddDumps(const std::vector<DumpData>::const_iterator start,
431 const std::vector<DumpData>::const_iterator end,
432 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100433 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100434 for (auto it = start; it != end; ++it) {
435 const std::string& name = it->name;
436 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100437 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100438
439 // Seek to the beginning of the file before dumping any data. A given
440 // DumpData entry might be dumped multiple times in the report.
441 //
442 // For example, the most recent ANR entry is dumped to the body of the
443 // main entry and it also shows up as a separate entry in the bugreport
444 // ZIP file.
445 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
446 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
447 strerror(errno));
448 }
449
Chris Morinc2cba7a2022-02-01 17:06:50 -0800450 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800451 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100452 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100453 }
454 } else {
455 dump_file_from_fd(type_name, name.c_str(), fd);
456 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100457 }
458
459 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700460}
461
Felipe Leme635ca312016-01-05 14:23:02 -0800462// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700463void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800464 char path[PATH_MAX];
465
466 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
467 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700468 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800469 char linkname[PATH_MAX];
470 ssize_t r = readlink(path, linkname, PATH_MAX);
471 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800472 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800473 return;
474 }
475 linkname[r] = '\0';
476
477 if (mount_points.find(linkname) == mount_points.end()) {
478 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700479 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700480 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800481 mount_points.insert(linkname);
482 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800483 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800484 }
485 }
486}
487
488void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700489 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800490 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800491 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700492 for_each_pid(do_mountinfo, nullptr);
493 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800494}
495
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700496static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
497{
498 DIR *d;
499 struct dirent *de;
500 char path[PATH_MAX];
501
502 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700503 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700504 return;
505 }
506
507 while ((de = readdir(d))) {
508 if (de->d_type != DT_LNK) {
509 continue;
510 }
511 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700512 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700513 }
514
515 closedir(d);
516}
517
Mark Salyzyn326842f2015-04-30 09:49:41 -0700518static bool skip_not_stat(const char *path) {
519 static const char stat[] = "/stat";
520 size_t len = strlen(path);
521 if (path[len - 1] == '/') { /* Directory? */
522 return false;
523 }
524 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
525}
526
Felipe Leme4c2d6632016-09-28 14:32:00 -0700527static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800528 return false;
529}
530
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700531unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700532
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800533//
534// stat offsets
535// Name units description
536// ---- ----- -----------
537// read I/Os requests number of read I/Os processed
538#define __STAT_READ_IOS 0
539// read merges requests number of read I/Os merged with in-queue I/O
540#define __STAT_READ_MERGES 1
541// read sectors sectors number of sectors read
542#define __STAT_READ_SECTORS 2
543// read ticks milliseconds total wait time for read requests
544#define __STAT_READ_TICKS 3
545// write I/Os requests number of write I/Os processed
546#define __STAT_WRITE_IOS 4
547// write merges requests number of write I/Os merged with in-queue I/O
548#define __STAT_WRITE_MERGES 5
549// write sectors sectors number of sectors written
550#define __STAT_WRITE_SECTORS 6
551// write ticks milliseconds total wait time for write requests
552#define __STAT_WRITE_TICKS 7
553// in_flight requests number of I/Os currently in flight
554#define __STAT_IN_FLIGHT 8
555// io_ticks milliseconds total time this block device has been active
556#define __STAT_IO_TICKS 9
557// time_in_queue milliseconds total wait time for all requests
558#define __STAT_IN_QUEUE 10
559#define __STAT_NUMBER_FIELD 11
560//
561// read I/Os, write I/Os
562// =====================
563//
564// These values increment when an I/O request completes.
565//
566// read merges, write merges
567// =========================
568//
569// These values increment when an I/O request is merged with an
570// already-queued I/O request.
571//
572// read sectors, write sectors
573// ===========================
574//
575// These values count the number of sectors read from or written to this
576// block device. The "sectors" in question are the standard UNIX 512-byte
577// sectors, not any device- or filesystem-specific block size. The
578// counters are incremented when the I/O completes.
579#define SECTOR_SIZE 512
580//
581// read ticks, write ticks
582// =======================
583//
584// These values count the number of milliseconds that I/O requests have
585// waited on this block device. If there are multiple I/O requests waiting,
586// these values will increase at a rate greater than 1000/second; for
587// example, if 60 read requests wait for an average of 30 ms, the read_ticks
588// field will increase by 60*30 = 1800.
589//
590// in_flight
591// =========
592//
593// This value counts the number of I/O requests that have been issued to
594// the device driver but have not yet completed. It does not include I/O
595// requests that are in the queue but not yet issued to the device driver.
596//
597// io_ticks
598// ========
599//
600// This value counts the number of milliseconds during which the device has
601// had I/O requests queued.
602//
603// time_in_queue
604// =============
605//
606// This value counts the number of milliseconds that I/O requests have waited
607// on this block device. If there are multiple I/O requests waiting, this
608// value will increase as the product of the number of milliseconds times the
609// number of requests waiting (see "read ticks" above for an example).
610#define S_TO_MS 1000
611//
612
Mark Salyzyn326842f2015-04-30 09:49:41 -0700613static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800614 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700615 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700616 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700617 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700618 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700619 getline(&buffer, &i, fp);
620 fclose(fp);
621 if (!buffer) {
622 return -errno;
623 }
624 i = strlen(buffer);
625 while ((i > 0) && (buffer[i - 1] == '\n')) {
626 buffer[--i] = '\0';
627 }
628 if (!*buffer) {
629 free(buffer);
630 return 0;
631 }
632 z = true;
633 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800634 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700635 if (fields[i] != 0) {
636 z = false;
637 }
638 }
639 if (z) { /* never accessed */
640 free(buffer);
641 return 0;
642 }
643
Wei Wang509bb5d2017-06-09 14:42:12 -0700644 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
645 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700646 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700647
648 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
649 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
650 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700651 free(buffer);
652
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800653 if (fields[__STAT_IO_TICKS]) {
654 unsigned long read_perf = 0;
655 unsigned long read_ios = 0;
656 if (fields[__STAT_READ_TICKS]) {
657 unsigned long long divisor = fields[__STAT_READ_TICKS]
658 * fields[__STAT_IO_TICKS];
659 read_perf = ((unsigned long long)SECTOR_SIZE
660 * fields[__STAT_READ_SECTORS]
661 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
662 / divisor;
663 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
664 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
665 / divisor;
666 }
667
668 unsigned long write_perf = 0;
669 unsigned long write_ios = 0;
670 if (fields[__STAT_WRITE_TICKS]) {
671 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
672 * fields[__STAT_IO_TICKS];
673 write_perf = ((unsigned long long)SECTOR_SIZE
674 * fields[__STAT_WRITE_SECTORS]
675 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
676 / divisor;
677 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
678 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
679 / divisor;
680 }
681
682 unsigned queue = (fields[__STAT_IN_QUEUE]
683 + (fields[__STAT_IO_TICKS] >> 1))
684 / fields[__STAT_IO_TICKS];
685
686 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700687 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 -0800688 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700689 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 -0800690 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800691 }
692
693 /* bugreport timeout factor adjustment */
694 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
695 worst_write_perf = write_perf;
696 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700697 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700698 return 0;
699}
700
Yao Chenbe3bbc12018-01-17 16:31:10 -0800701static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
702
Tom Cherryf4472f32020-08-05 09:31:17 -0700703// Returns the actual readable size of the given buffer or -1 on error.
704static long logcat_buffer_readable_size(const std::string& buffer) {
705 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
706 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
707 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
708
709 return android_logger_get_log_readable_size(logger);
710}
711
712// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800713static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
714 unsigned long timeout_ms = 0;
715 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700716 long readable_size = logcat_buffer_readable_size(buffer);
717 if (readable_size > 0) {
718 // Engineering margin is ten-fold our guess.
719 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
720 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800721 }
722 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700723}
724
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800725// Opens a socket and returns its file descriptor.
726static int open_socket(const char* service);
727
Nandana Duttd2f5f082019-01-18 17:13:52 +0000728Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
729}
730
731android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
732 std::lock_guard<std::mutex> lock(lock_);
733 result_ = APPROVED;
734 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800735
736 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
737 // consent is granted.
738 if (ds.options_->is_screenshot_copied) {
739 return android::binder::Status::ok();
740 }
741
742 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
743 !ds.do_early_screenshot_) {
744 return android::binder::Status::ok();
745 }
746
747 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
748 ds.options_->screenshot_fd.get());
749 ds.options_->is_screenshot_copied = copy_succeeded;
750 if (copy_succeeded) {
751 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
752 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000753 return android::binder::Status::ok();
754}
755
756android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
757 std::lock_guard<std::mutex> lock(lock_);
758 result_ = DENIED;
759 MYLOGW("User denied consent to share bugreport\n");
760 return android::binder::Status::ok();
761}
762
763UserConsentResult Dumpstate::ConsentCallback::getResult() {
764 std::lock_guard<std::mutex> lock(lock_);
765 return result_;
766}
767
768uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800769 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000770}
771
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700772void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200773 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700774 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700775
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700776 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
777 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700778 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
779 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
780 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200781 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700782 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700783
Felipe Lemed8b94e52016-12-08 10:21:44 -0800784 printf("========================================================\n");
785 printf("== dumpstate: %s\n", date);
786 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700787
Felipe Lemed8b94e52016-12-08 10:21:44 -0800788 printf("\n");
789 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700790 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800791 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
792 printf("Bootloader: %s\n", bootloader.c_str());
793 printf("Radio: %s\n", radio.c_str());
794 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100795 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
796 if (module_metadata_version != 0) {
797 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
798 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200799 printf("Android SDK version: %s\n", sdkversion.c_str());
800 printf("SDK extensions: ");
801 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
802 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700803
Felipe Lemed8b94e52016-12-08 10:21:44 -0800804 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800805 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800806 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800807 printf("Uptime: ");
808 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
809 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800810 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800811 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
812 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000813 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800814 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800815}
816
Felipe Leme24b66ee2016-06-16 10:55:26 -0700817// List of file extensions that can cause a zip file attachment to be rejected by some email
818// service providers.
819static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
820 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
821 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
822 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
823};
824
Vishnu Naire97d6122018-01-18 13:58:56 -0800825status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
826 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700827 std::string valid_name = entry_name;
828
829 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700830 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700831 if (idx != std::string::npos) {
832 std::string extension = entry_name.substr(idx);
833 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
834 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
835 valid_name = entry_name + ".renamed";
836 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
837 }
838 }
839
Felipe Leme6fe9db62016-02-12 09:04:16 -0800840 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
841 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000842 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
843 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700844 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700845 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700846 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700847 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800848 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800849 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000850 bool finished_entry = false;
851 auto finish_entry = [this, &finished_entry] {
852 if (!finished_entry) {
853 // This should only be called when we're going to return an earlier error,
854 // which would've been logged. This may imply the file is already corrupt
855 // and any further logging from FinishEntry is more likely to mislead than
856 // not.
857 this->zip_writer_->FinishEntry();
858 }
859 };
860 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800861 auto start = std::chrono::steady_clock::now();
862 auto end = start + timeout;
863 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800864
Felipe Leme770410d2016-01-26 17:07:14 -0800865 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800866 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800867 if (timeout.count() > 0) {
868 // lambda to recalculate the timeout.
869 auto time_left_ms = [end]() {
870 auto now = std::chrono::steady_clock::now();
871 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
872 return std::max(diff.count(), 0LL);
873 };
874
875 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
876 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000877 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
878 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 return -errno;
880 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000881 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800882 entry_name.c_str(), strerror(errno), timeout.count());
883 return TIMED_OUT;
884 }
885 }
886
Zach Riggle22200402016-08-18 01:01:24 -0400887 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 if (bytes_read == 0) {
889 break;
890 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800891 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800893 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700894 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800895 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700896 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800897 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800898 }
899 }
900
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700901 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000902 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700903 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700904 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800905 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800906 }
907
Vishnu Naire97d6122018-01-18 13:58:56 -0800908 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800909}
910
Felipe Leme1d486fe2016-10-14 18:06:47 -0700911bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
912 android::base::unique_fd fd(
913 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700914 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800915 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916 return false;
917 }
918
Vishnu Naire97d6122018-01-18 13:58:56 -0800919 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800920}
921
922/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700923static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800924 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800925}
926
Felipe Leme1d486fe2016-10-14 18:06:47 -0700927void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700928 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800929 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700930 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800931}
932
Felipe Leme1d486fe2016-10-14 18:06:47 -0700933bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800934 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000935 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
936 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700937 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700938 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700939 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800940 return false;
941 }
942
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700943 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700944 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700945 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700946 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800947 return false;
948 }
949
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700950 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700951 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700952 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800953 return false;
954 }
955
956 return true;
957}
958
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800959static void DoKmsg() {
960 struct stat st;
961 if (!stat(PSTORE_LAST_KMSG, &st)) {
962 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
963 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
964 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
965 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
966 } else {
967 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
968 DumpFile("LAST KMSG", "/proc/last_kmsg");
969 }
970}
971
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800972static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800973 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800974 RunCommand(
975 "KERNEL LOG",
976 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
977 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
978}
979
Nandana Duttdb379fa2019-10-09 16:54:41 +0100980static void DoSystemLogcat(time_t since) {
981 char since_str[80];
982 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
983
984 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
985 RunCommand("SYSTEM LOG",
986 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
987 since_str},
988 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
989}
990
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800991static void DoRadioLogcat() {
992 unsigned long timeout_ms = logcat_timeout({"radio"});
993 RunCommand(
994 "RADIO LOG",
995 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
996 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
997}
998
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800999static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001000 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001001 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1002 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001003 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001004 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001005 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1006 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001007 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001008 RunCommand(
1009 "EVENT LOG",
1010 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001011 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001012 timeout_ms = logcat_timeout({"stats"});
1013 RunCommand(
1014 "STATS LOG",
1015 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001016 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001017 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001018
1019 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1020
1021 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001022 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1023 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001024}
1025
Mike Ma5c267872019-08-21 11:31:34 -07001026static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001027 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1028 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1029 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1030 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1031 if (fd < 0) {
1032 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1033 return;
1034 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001035 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001036 bool empty = 0 == lseek(fd, 0, SEEK_END);
1037 if (!empty) {
1038 // Use a different name from "incident.proto"
1039 // /proto/incident.proto is reserved for incident service dump
1040 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001041 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1042 path);
1043 } else {
1044 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001045 }
Mike Ma5c267872019-08-21 11:31:34 -07001046}
1047
Aaron Huanga99452a2022-04-27 18:51:16 +08001048static void DumpNetstatsProto() {
1049 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1050 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1051 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1052 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1053 if (fd < 0) {
1054 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1055 return;
1056 }
1057 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1058 CommandOptions::WithTimeout(120).Build());
1059 bool empty = 0 == lseek(fd, 0, SEEK_END);
1060 if (!empty) {
1061 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1062 path);
1063 } else {
1064 unlink(path.c_str());
1065 }
1066}
1067
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001068static void MaybeAddSystemTraceToZip() {
1069 // This function copies into the .zip the system trace that was snapshotted
1070 // by the early call to MaybeSnapshotSystemTrace(), if any background
1071 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001072 if (!ds.has_system_trace_) {
1073 // No background trace was happening at the time dumpstate was invoked.
1074 return;
1075 }
1076 ds.AddZipEntry(
1077 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1078 SYSTEM_TRACE_SNAPSHOT);
1079 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1080}
1081
Sunny Goyal35949782019-11-19 15:54:36 -08001082static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001083 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1084 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1085 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1086 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1087 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1088 if (fd < 0) {
1089 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1090 return;
1091 }
1092 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001093 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001094 bool empty = 0 == lseek(fd, 0, SEEK_END);
1095 if (!empty) {
1096 ds.AddZipEntry("visible_windows.zip", path);
1097 } else {
1098 MYLOGW("Failed to dump visible windows\n");
1099 }
1100 unlink(path.c_str());
1101}
1102
Jayachandran Ca94c7172017-06-10 15:08:12 -07001103static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001104 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1105 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001106 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001107 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001108 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1109 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1110 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1111 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001112}
1113
Woody Lin20767a92022-11-29 15:50:24 +08001114static void DumpShutdownCheckpoints() {
1115 const bool shutdown_checkpoints_dumped = AddDumps(
1116 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1117 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1118 if (!shutdown_checkpoints_dumped) {
1119 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1120 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1121 }
1122}
1123
David Andersond9ba4752018-12-11 18:26:59 -08001124static void DumpDynamicPartitionInfo() {
1125 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1126 return;
1127 }
1128
1129 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001130 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001131}
1132
Chris Morin5a50d482022-02-01 17:41:18 -08001133static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001134 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1135 anr_traces_dir.c_str());
1136
1137 // If we're here, dump_traces_path will always be a temporary file
1138 // (created with mkostemp or similar) that contains dumps taken earlier
1139 // on in the process.
1140 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001141 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1142 dump_traces_path);
1143 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001144
1145 const int ret = unlink(dump_traces_path);
1146 if (ret == -1) {
1147 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1148 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001149 }
1150 }
1151
Narayan Kamathbd863722017-06-01 18:50:12 +01001152 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001153 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001154 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001155 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001156 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001157
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001158 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001159 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001160 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001161 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001162 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1163 }
1164}
1165
1166static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001167 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001168
Chris Morin5a50d482022-02-01 17:41:18 -08001169 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001170
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001171 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1172
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001173 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001174 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001175 int i = 0;
1176 while (true) {
1177 const std::string slow_trace_path =
1178 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1179 if (stat(slow_trace_path.c_str(), &st)) {
1180 // No traces file at this index, done with the files.
1181 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001182 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001183 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1184 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001185 }
1186}
1187
Wei Wang509bb5d2017-06-09 14:42:12 -07001188static void DumpBlockStatFiles() {
1189 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001190
Wei Wang1dc1ef52017-06-12 11:28:37 -07001191 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1192
1193 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001194 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1195 return;
1196 }
1197
1198 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001199 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001200 if ((d->d_name[0] == '.')
1201 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1202 || (d->d_name[1] == '\0'))) {
1203 continue;
1204 }
1205 const std::string new_path =
1206 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1207 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1208 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1209 printf("\n");
1210 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001211 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001212}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001213
1214static void DumpPacketStats() {
1215 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001216}
1217
1218static void DumpIpAddrAndRules() {
1219 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1220 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1221 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1222 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1223 RunCommand("IP RULES", {"ip", "rule", "show"});
1224 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1225}
1226
Nandana Dutt5c390032019-03-12 10:52:56 +00001227static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1228 std::chrono::milliseconds timeout,
1229 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001230 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001231 sp<android::IServiceManager> sm = defaultServiceManager();
1232 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001233 Vector<String16> args;
1234 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001235 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1236 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001237 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001238 std::string path(title);
1239 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001240 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001241 if (PropertiesHelper::IsDryRun()) {
1242 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1243 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1244 } else {
1245 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1246 if (status == OK) {
1247 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1248 std::chrono::duration<double> elapsed_seconds;
1249 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1250 service == String16("meminfo")) {
1251 // Use a longer timeout for meminfo, since 30s is not always enough.
1252 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1253 /* as_proto = */ false, elapsed_seconds,
1254 bytes_written);
1255 } else {
1256 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1257 /* as_proto = */ false, elapsed_seconds,
1258 bytes_written);
1259 }
1260 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1261 bool dump_complete = (status == OK);
1262 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001263 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001264 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001265
1266 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1267 std::chrono::steady_clock::now() - start);
1268 if (elapsed_duration > timeout) {
1269 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1270 elapsed_duration.count());
1271 break;
1272 }
1273 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001274 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001275}
1276
Vishnu Nair64afc022018-02-01 15:29:34 -08001277static void RunDumpsysText(const std::string& title, int priority,
1278 std::chrono::milliseconds timeout,
1279 std::chrono::milliseconds service_timeout) {
1280 DurationReporter duration_reporter(title);
1281 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1282 fsync(STDOUT_FILENO);
1283 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1284}
1285
1286/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001287static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1288 std::chrono::milliseconds timeout,
1289 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001290 DurationReporter duration_reporter(title);
1291 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1292 fsync(STDOUT_FILENO);
1293 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1294 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001295
1296 RETURN_IF_USER_DENIED_CONSENT();
1297
1298 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1299 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001300}
1301
Nandana Dutt5c390032019-03-12 10:52:56 +00001302static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1303 std::chrono::milliseconds timeout,
1304 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001305 sp<android::IServiceManager> sm = defaultServiceManager();
1306 Dumpsys dumpsys(sm.get());
1307 Vector<String16> args;
1308 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1309 DurationReporter duration_reporter(title);
1310
1311 auto start = std::chrono::steady_clock::now();
1312 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1313 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001314 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001315 std::string path(kProtoPath);
1316 path.append(String8(service).c_str());
1317 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1318 path.append("_CRITICAL");
1319 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1320 path.append("_HIGH");
1321 }
1322 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001323 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001324 if (status == OK) {
1325 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1326 bool dumpTerminated = (status == OK);
1327 dumpsys.stopDumpThread(dumpTerminated);
1328 }
1329 ZipWriter::FileEntry file_entry;
1330 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001331
1332 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1333 std::chrono::steady_clock::now() - start);
1334 if (elapsed_duration > timeout) {
1335 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1336 elapsed_duration.count());
1337 break;
1338 }
1339 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001340 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001341}
1342
Nandana Dutta7db6342018-11-21 14:53:34 +00001343// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001344static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001345 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1346 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001347
1348 RETURN_IF_USER_DENIED_CONSENT();
1349
1350 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1351 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001352}
1353
1354// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001355static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001356 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1357 // high priority. Reduce timeout once they are able to dump in a shorter time or
1358 // moved to a parallel task.
1359 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1360 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001361
1362 RETURN_IF_USER_DENIED_CONSENT();
1363
1364 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1365 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001366}
1367
1368// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001369static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001370 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001371
1372 RETURN_IF_USER_DENIED_CONSENT();
1373
1374 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1375 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001376}
1377
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001378/*
1379 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1380 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1381 * if it's not running in the parallel task.
1382 */
1383static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001384 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001385 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1386 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001387
Steven Moreland44cd9482018-01-04 16:24:13 -08001388 using android::hidl::manager::V1_0::IServiceManager;
1389 using android::hardware::defaultServiceManager;
1390
1391 sp<IServiceManager> sm = defaultServiceManager();
1392 if (sm == nullptr) {
1393 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1394 return;
1395 }
1396
1397 auto ret = sm->list([&](const auto& interfaces) {
1398 for (const std::string& interface : interfaces) {
1399 std::string cleanName = interface;
1400 std::replace_if(cleanName.begin(),
1401 cleanName.end(),
1402 [](char c) {
1403 return !isalnum(c) &&
1404 std::string("@-_:.").find(c) == std::string::npos;
1405 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001406 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001407
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001408 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001409 {
1410 auto fd = android::base::unique_fd(
1411 TEMP_FAILURE_RETRY(open(path.c_str(),
1412 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1413 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1414 if (fd < 0) {
1415 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1416 continue;
1417 }
1418 RunCommandToFd(fd,
1419 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001420 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001421 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1422
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001423 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001424 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001425 if (!empty) {
1426 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1427 path);
1428 } else {
1429 unlink(path.c_str());
1430 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001431 }
1432 });
1433
1434 if (!ret.isOk()) {
1435 MYLOGE("Could not list hals from hwservicemanager.\n");
1436 }
1437}
1438
Devin Moore8df81bb2022-06-08 22:47:02 +00001439// Dump all of the files that make up the vendor interface.
1440// See the files listed in dumpFileList() for the latest list of files.
1441static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001442
1443 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1444 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001445 for (const auto vintfFile : vintfFiles) {
1446 struct stat st;
1447 if (stat(vintfFile.c_str(), &st) == 0) {
1448 if (S_ISDIR(st.st_mode)) {
1449 ds.AddDir(vintfFile, true /* recursive */);
1450 } else {
1451 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1452 vintfFile);
1453 }
1454 }
1455 }
1456}
1457
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001458static void DumpExternalFragmentationInfo() {
1459 struct stat st;
1460 if (stat("/proc/buddyinfo", &st) != 0) {
1461 MYLOGE("Unable to dump external fragmentation info\n");
1462 return;
1463 }
1464
1465 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1466 std::ifstream ifs("/proc/buddyinfo");
1467 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1468 for (std::string line; std::getline(ifs, line);) {
1469 std::smatch match_results;
1470 if (std::regex_match(line, match_results, unusable_index_regex)) {
1471 std::stringstream free_pages(std::string{match_results[3]});
1472 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1473 std::istream_iterator<int>());
1474
1475 int total_free_pages = 0;
1476 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1477 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1478 }
1479
1480 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1481 match_results[2].str().c_str());
1482
1483 int usable_free_pages = total_free_pages;
1484 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1485 auto unusable_index = (total_free_pages - usable_free_pages) /
1486 static_cast<double>(total_free_pages);
1487 printf(" %5.3f", unusable_index);
1488 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1489 }
1490
1491 printf("\n");
1492 }
1493 }
1494 printf("\n");
1495}
1496
mhasankd451a472020-05-26 18:02:39 -07001497static void DumpstateLimitedOnly() {
1498 // Trimmed-down version of dumpstate to only include a whitelisted
1499 // set of logs (system log, event log, and system server / system app
1500 // crashes, and networking logs). See b/136273873 and b/138459828
1501 // for context.
1502 DurationReporter duration_reporter("DUMPSTATE");
1503 unsigned long timeout_ms;
1504 // calculate timeout
1505 timeout_ms = logcat_timeout({"main", "system", "crash"});
1506 RunCommand("SYSTEM LOG",
1507 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1508 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1509 timeout_ms = logcat_timeout({"events"});
1510 RunCommand(
1511 "EVENT LOG",
1512 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1513 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1514
1515 printf("========================================================\n");
1516 printf("== Networking Service\n");
1517 printf("========================================================\n");
1518
1519 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1520 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001521 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1522 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001523
1524 printf("========================================================\n");
1525 printf("== Dropbox crashes\n");
1526 printf("========================================================\n");
1527
1528 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1529 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1530
1531 printf("========================================================\n");
1532 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1533 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1534 printf("========================================================\n");
1535 printf("== dumpstate: done (id %d)\n", ds.id_);
1536 printf("========================================================\n");
1537}
1538
Rhed Jaoe017f982020-07-21 17:58:41 +08001539/*
1540 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1541 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1542 * if it's not running in the parallel task.
1543 */
1544static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1545 dprintf(out_fd, "========================================================\n");
1546 dprintf(out_fd, "== Checkins\n");
1547 dprintf(out_fd, "========================================================\n");
1548
1549 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001550 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1551 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1552 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1553 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1554}
1555
1556/*
1557 * Runs dumpsys on activity service to dump all application activities, services
1558 * and providers in the device.
1559 *
1560 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1561 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1562 * if it's not running in the parallel task.
1563 */
1564static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1565 dprintf(out_fd, "========================================================\n");
1566 dprintf(out_fd, "== Running Application Activities\n");
1567 dprintf(out_fd, "========================================================\n");
1568
1569 // The following dumpsys internally collects output from running apps, so it can take a long
1570 // time. So let's extend the timeout.
1571
1572 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1573
1574 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1575
1576 dprintf(out_fd, "========================================================\n");
1577 dprintf(out_fd, "== Running Application Services (platform)\n");
1578 dprintf(out_fd, "========================================================\n");
1579
1580 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1581 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1582
1583 dprintf(out_fd, "========================================================\n");
1584 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1585 dprintf(out_fd, "========================================================\n");
1586
1587 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1588 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1589
1590 dprintf(out_fd, "========================================================\n");
1591 dprintf(out_fd, "== Running Application Providers (platform)\n");
1592 dprintf(out_fd, "========================================================\n");
1593
1594 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001595 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001596
1597 dprintf(out_fd, "========================================================\n");
1598 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1599 dprintf(out_fd, "========================================================\n");
1600
1601 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1602 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1603}
1604
Nandana Dutt5c390032019-03-12 10:52:56 +00001605// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1606// via the consent they are shown. Ignores other errors that occur while running various
1607// commands. The consent checking is currently done around long running tasks, which happen to
1608// be distributed fairly evenly throughout the function.
1609static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001610 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001611
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001612 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001613 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1614 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001615 if (ds.dump_pool_) {
1616 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1617 // drop root user. Restarts it with two threads for the parallel run.
1618 ds.dump_pool_->start(/* thread_counts = */2);
1619
Chris Morinbc223142022-02-04 14:17:11 -08001620 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1621 dump_incident_report = ds.dump_pool_->enqueueTask(
1622 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001623 dump_netstats_report = ds.dump_pool_->enqueueTask(
1624 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001625 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1626 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1627 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001628 }
1629
Nandana Dutt5c390032019-03-12 10:52:56 +00001630 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1631 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1632 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001633 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001634 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001635 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001636 DumpFile("MEMORY INFO", "/proc/meminfo");
1637 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001638 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001639
Kevin Jeon947922b2022-09-21 00:29:18 +00001640 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1641 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001642
Sunny Goyal35949782019-11-19 15:54:36 -08001643 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1644
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001645 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1646 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1647 DumpFile("SLAB INFO", "/proc/slabinfo");
1648 DumpFile("ZONEINFO", "/proc/zoneinfo");
1649 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1650 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001651 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001652
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001653 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001654
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001655 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001656 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001657
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001658 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001659 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001660 } else {
1661 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1662 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001663
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001664 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001665 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001666 struct stat s;
1667 if (stat("/proc/modules", &s) != 0) {
1668 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1669 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001670 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001671 RunCommand("MODULES INFO",
1672 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1673 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1674 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001675 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001676
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001677 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001678 DoKernelLogcat();
1679 } else {
1680 do_dmesg();
1681 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001682
Devin Moore8df81bb2022-06-08 22:47:02 +00001683 DumpVintf();
1684
Felipe Lemef0292972016-11-22 13:57:05 -08001685 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001686
Jeff Brown1dc94e32014-09-11 14:15:27 -07001687 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001688 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001689
Jack Yu5a6b2e22020-08-14 18:13:35 +08001690 /* Dump Nfc NCI logs */
1691 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001692
Paul Chang0d2aad72020-02-13 20:04:03 +08001693 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001694 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001695 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001696 }
1697
Felipe Lemee184f662016-10-27 10:04:47 -07001698 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001699
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001700 MaybeAddSystemTraceToZip();
1701
Narayan Kamath8f788292017-05-25 13:20:39 +01001702 // NOTE: tombstones are always added as separate entries in the zip archive
1703 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001704 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001705 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001706 if (!tombstones_dumped) {
1707 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001708 }
1709
Jayachandran Ca94c7172017-06-10 15:08:12 -07001710 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001711
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001712 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001713
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001714 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001715
Woody Lin20767a92022-11-29 15:50:24 +08001716 DumpShutdownCheckpoints();
1717
Jayachandran Ca94c7172017-06-10 15:08:12 -07001718 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001719
1720 dump_route_tables();
1721
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001722 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1723 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1724 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001725
Nandana Dutt5c390032019-03-12 10:52:56 +00001726 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001727
Chiachang Wang668ede42021-05-17 17:14:20 +08001728 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1729 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1730 // dump with priority parameters to dump high priority information.
1731 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1732 CommandOptions::WithTimeout(10).Build());
1733
Elliott Hughes23ccc622017-02-28 10:14:22 -08001734 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001735
Jin Qianf334d662017-10-10 14:41:37 -07001736 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001737
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001738 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001739
Colin Crossf45fa6b2012-03-26 12:38:26 -07001740 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001741 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1742 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1743
1744 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1745 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1746 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1747 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1748 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001749
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001750 /* Add window and surface trace files. */
1751 if (!PropertiesHelper::IsUserBuild()) {
1752 ds.AddDir(WMTRACE_DATA_DIR, false);
1753 }
1754
Yifan Hongd90cc652020-02-08 16:52:02 -08001755 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1756
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001757 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001758 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001759 } else {
1760 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1761 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001762
Steven Moreland7440ddb2016-12-15 16:13:39 -08001763 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001764 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1765 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001766 // su does not exist on user builds, so try running without it.
1767 // This way any implementations of vril-dump that do not require
1768 // root can run on user builds.
1769 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001770 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001771 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001772 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001773 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001774 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001775 }
1776
Felipe Lemed8b94e52016-12-08 10:21:44 -08001777 printf("========================================================\n");
1778 printf("== Android Framework Services\n");
1779 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001780
Nandana Dutt5c390032019-03-12 10:52:56 +00001781 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001782
Jack He91ff2fe2021-02-18 18:23:43 -08001783 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1784 ds.AddDir("/data/misc/bluetooth/logs", true);
1785
Rhed Jaoe017f982020-07-21 17:58:41 +08001786 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001787 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001788 } else {
1789 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1790 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001791
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001792 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001793
Adrian Roos8b397ab2017-04-04 16:35:44 -07001794 printf("========================================================\n");
1795 printf("== Dropbox crashes\n");
1796 printf("========================================================\n");
1797
1798 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1799 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1800
Felipe Lemed8b94e52016-12-08 10:21:44 -08001801 printf("========================================================\n");
1802 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1803 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1804 printf("========================================================\n");
1805 printf("== dumpstate: done (id %d)\n", ds.id_);
1806 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001807
1808 printf("========================================================\n");
1809 printf("== Obtaining statsd metadata\n");
1810 printf("========================================================\n");
1811 // This differs from the usual dumpsys stats, which is the stats report data.
1812 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001813
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001814 // Add linker configuration directory
1815 ds.AddDir(LINKERCONFIG_DIR, true);
1816
Li Li830179f2022-01-04 12:53:29 -08001817 /* Dump frozen cgroupfs */
1818 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001819
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001820 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001821 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1822 } else {
1823 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1824 DumpNetstatsProto);
1825 }
1826
1827 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001828 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001829 } else {
1830 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1831 DumpIncidentReport);
1832 }
Mike Ma5c267872019-08-21 11:31:34 -07001833
Nandana Dutt5c390032019-03-12 10:52:56 +00001834 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001835}
1836
Nandana Dutt5c390032019-03-12 10:52:56 +00001837/*
1838 * Dumps state for the default case; drops root after it's no longer necessary.
1839 *
1840 * Returns RunStatus::OK if everything went fine.
1841 * Returns RunStatus::ERROR if there was an error.
1842 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1843 * with the caller.
1844 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001845Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001846 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1847 // buffer.
1848 DoLogcat();
1849 // Capture timestamp after first logcat to use in next logcat
1850 time_t logcat_ts = time(nullptr);
1851
Nandana Dutt4be45d12018-09-26 15:04:23 +01001852 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001853 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001854 if (dump_pool_) {
1855 RETURN_IF_USER_DENIED_CONSENT();
1856 // One thread is enough since we only need to enqueue DumpTraces here.
1857 dump_pool_->start(/* thread_counts = */1);
1858
1859 // DumpTraces takes long time, post it to the another thread in the
1860 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001861 dump_traces = dump_pool_->enqueueTask(
1862 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001863 } else {
1864 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1865 &dump_traces_path);
1866 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001867
1868 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001869 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001870 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1871 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001872 ds.shutdown_checkpoints_ = GetDumpFds(
1873 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001874 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001875
1876 ds.AddDir(RECOVERY_DIR, true);
1877 ds.AddDir(RECOVERY_DATA_DIR, true);
1878 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001879 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001880 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1881 if (!PropertiesHelper::IsUserBuild()) {
1882 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1883 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001884 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001885 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001886 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001887 add_mountinfo();
1888 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001889 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001890 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001891
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001892 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001893 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1894
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001895 // Dump IPsec stats. No keys are exposed here.
1896 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1897
Nandana Dutt4be45d12018-09-26 15:04:23 +01001898 // Run ss as root so we can see socket marks.
1899 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1900
1901 // Run iotop as root to show top 100 IO threads
1902 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1903
Erick Reyese68df822019-02-11 14:46:36 -08001904 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001905 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1906 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001907
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001908 DumpFile("PSI cpu", "/proc/pressure/cpu");
1909 DumpFile("PSI memory", "/proc/pressure/memory");
1910 DumpFile("PSI io", "/proc/pressure/io");
1911
Mårten Kongstad60195a72022-09-20 14:14:20 +02001912 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1913 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1914
Rhed Jao5377d792020-07-16 17:37:39 +08001915 if (dump_pool_) {
1916 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001917 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001918
Chris Morinbc223142022-02-04 14:17:11 -08001919 // Current running thread in the pool is the root user also. Delete
1920 // the pool and make a new one later to ensure none of threads in the pool are root.
1921 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001922 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001923 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001924 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001925 }
1926
Nandana Dutt5c390032019-03-12 10:52:56 +00001927 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001928 Dumpstate::RunStatus status = dumpstate();
1929 // Capture logcat since the last time we did it.
1930 DoSystemLogcat(logcat_ts);
1931 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001932}
1933
Rhed Jaob5685b32020-08-14 17:19:17 +08001934// Common states for telephony and wifi which are needed to be collected before
1935// dumpstate drop the root user.
1936static void DumpstateRadioAsRoot() {
1937 DumpIpTablesAsRoot();
1938 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1939}
1940
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001941// This method collects common dumpsys for telephony and wifi. Typically, wifi
1942// reports are fine to include all information, but telephony reports on user
1943// builds need to strip some content (see DumpstateTelephonyOnly).
1944static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001945 // We need to be picky about some stuff for telephony reports on user builds.
1946 if (!include_sensitive_info) {
1947 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1948 DoRadioLogcat();
1949 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001950 // DumpHals takes long time, post it to the another thread in the pool,
1951 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001952 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001953 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001954 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001955 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001956 // Contains various system properties and process startup info.
1957 do_dmesg();
1958 // Logs other than the radio buffer may contain package/component names and potential PII.
1959 DoLogcat();
1960 // Too broad for connectivity problems.
1961 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001962 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1963 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001964 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001965 } else {
1966 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1967 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001968 }
1969
Jayachandran Ca94c7172017-06-10 15:08:12 -07001970 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001971 DumpIpAddrAndRules();
1972 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001973 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1974 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001975}
1976
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001977// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1978// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1979// for what can be included on user builds: all reported information MUST directly relate to
1980// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1981// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1982// names are not), and MUST NOT contain logs of user application traffic.
1983// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001984static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001985 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001986
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001987 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001988
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001989 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001990
Rhed Jaob5685b32020-08-14 17:19:17 +08001991 DumpstateRadioAsRoot();
1992 if (!DropRootUser()) {
1993 return;
1994 }
1995
1996 // Starts thread pool after the root user is dropped, and two additional threads
1997 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08001998 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08001999 if (ds.dump_pool_) {
2000 ds.dump_pool_->start(/*thread_counts =*/2);
2001
2002 // DumpstateBoard takes long time, post it to the another thread in the pool,
2003 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002004 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2005 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002006 }
2007
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002008 DumpstateRadioCommon(include_sensitive_info);
2009
2010 if (include_sensitive_info) {
2011 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2012 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2013 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2014 // way.
2015 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2016 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002017
2018 printf("========================================================\n");
2019 printf("== Android Framework Services\n");
2020 printf("========================================================\n");
2021
Vishnu Nair652cc802017-11-30 15:18:30 -08002022 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2023 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002024 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2025 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002026 if (include_sensitive_info) {
2027 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2028 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2029 SEC_TO_MSEC(10));
2030 } else {
2031 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2032 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2033 // give a higher timeout as well.
2034 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2035 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2036 }
2037 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002038 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2039 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002040 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002041 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2042 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002043 if (include_sensitive_info) {
2044 // Contains raw IP addresses, omit from reports on user builds.
2045 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2046 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2047 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2048 SEC_TO_MSEC(10));
2049 // Contains package/component names, omit from reports on user builds.
2050 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2051 SEC_TO_MSEC(10));
2052 // Contains package names, but should be relatively simple to remove them (also contains
2053 // UIDs already), omit from reports on user builds.
2054 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2055 SEC_TO_MSEC(10));
2056 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002057
2058 printf("========================================================\n");
2059 printf("== Running Application Services\n");
2060 printf("========================================================\n");
2061
2062 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2063
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002064 if (include_sensitive_info) {
2065 printf("========================================================\n");
2066 printf("== Running Application Services (non-platform)\n");
2067 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002068
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002069 // Contains package/component names and potential PII, omit from reports on user builds.
2070 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2071 // carrier_config dumpsys instead.
2072 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2073 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002074
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002075 printf("========================================================\n");
2076 printf("== Checkins\n");
2077 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002078
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002079 // Contains package/component names, omit from reports on user builds.
2080 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2081 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002082
2083 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002084 printf("== dumpstate: done (id %d)\n", ds.id_);
2085 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002086
2087 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002088 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002089 } else {
2090 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2091 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002092}
2093
mukesh agrawal253dad42018-01-23 21:59:59 -08002094// This method collects dumpsys for wifi debugging only
2095static void DumpstateWifiOnly() {
2096 DurationReporter duration_reporter("DUMPSTATE");
2097
Rhed Jaob5685b32020-08-14 17:19:17 +08002098 DumpstateRadioAsRoot();
2099 if (!DropRootUser()) {
2100 return;
2101 }
2102
2103 // Starts thread pool after the root user is dropped. Only one additional
2104 // thread is needed for DumpHals in the DumpstateRadioCommon.
2105 if (ds.dump_pool_) {
2106 ds.dump_pool_->start(/*thread_counts =*/1);
2107 }
2108
mukesh agrawal253dad42018-01-23 21:59:59 -08002109 DumpstateRadioCommon();
2110
2111 printf("========================================================\n");
2112 printf("== Android Framework Services\n");
2113 printf("========================================================\n");
2114
2115 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2116 SEC_TO_MSEC(10));
2117 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2118 SEC_TO_MSEC(10));
2119
2120 printf("========================================================\n");
2121 printf("== dumpstate: done (id %d)\n", ds.id_);
2122 printf("========================================================\n");
2123}
2124
Nandana Duttcf419a72019-03-14 10:40:17 +00002125Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002126 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002127 const size_t buf_size = temp_file_pattern.length() + 1;
2128 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2129 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2130
2131 // Create a new, empty file to receive all trace dumps.
2132 //
2133 // TODO: This can be simplified once we remove support for the old style
2134 // dumps. We can have a file descriptor passed in to dump_traces instead
2135 // of creating a file, closing it and then reopening it again.
2136 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2137 if (fd < 0) {
2138 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002139 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002140 }
2141
2142 // Nobody should have access to this temporary file except dumpstate, but we
2143 // temporarily grant 'read' to 'others' here because this file is created
2144 // when tombstoned is still running as root, but dumped after dropping. This
2145 // can go away once support for old style dumping has.
2146 const int chmod_ret = fchmod(fd, 0666);
2147 if (chmod_ret < 0) {
2148 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002149 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002150 }
2151
2152 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2153 if (proc.get() == nullptr) {
2154 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002155 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002156 }
2157
2158 // Number of times process dumping has timed out. If we encounter too many
2159 // failures, we'll give up.
2160 int timeout_failures = 0;
2161 bool dalvik_found = false;
2162
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002163 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002164
2165 struct dirent* d;
2166 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002167 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002168 int pid = atoi(d->d_name);
2169 if (pid <= 0) {
2170 continue;
2171 }
2172
2173 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2174 std::string exe;
2175 if (!android::base::Readlink(link_name, &exe)) {
2176 continue;
2177 }
2178
2179 bool is_java_process;
2180 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2181 // Don't bother dumping backtraces for the zygote.
2182 if (IsZygote(pid)) {
2183 continue;
2184 }
2185
2186 dalvik_found = true;
2187 is_java_process = true;
2188 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2189 is_java_process = false;
2190 } else {
2191 // Probably a native process we don't care about, continue.
2192 continue;
2193 }
2194
2195 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2196 if (timeout_failures == 3) {
2197 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2198 break;
2199 }
2200
2201 const uint64_t start = Nanotime();
2202 const int ret = dump_backtrace_to_file_timeout(
2203 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2204 is_java_process ? 5 : 20, fd);
2205
2206 if (ret == -1) {
2207 // For consistency, the header and footer to this message match those
2208 // dumped by debuggerd in the success case.
2209 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2210 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2211 dprintf(fd, "---- end %d ----", pid);
2212 timeout_failures++;
2213 continue;
2214 }
2215
2216 // We've successfully dumped stack traces, reset the failure count
2217 // and write a summary of the elapsed time to the file and continue with the
2218 // next process.
2219 timeout_failures = 0;
2220
2221 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2222 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2223 }
2224
2225 if (!dalvik_found) {
2226 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2227 }
2228
Nandana Duttcf419a72019-03-14 10:40:17 +00002229 *path = file_name_buf.release();
2230 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002231}
2232
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002233static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2234 const Dumpstate::BugreportMode bugreport_mode) {
2235 switch (bugreport_mode) {
2236 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2237 return dumpstate_hal_hidl::DumpstateMode::FULL;
2238 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2239 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2240 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2241 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2242 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2243 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2244 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2245 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2246 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2247 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2248 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2249 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2250 }
2251 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2252}
2253
2254static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2255 const Dumpstate::BugreportMode bugreport_mode) {
2256 switch (bugreport_mode) {
2257 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2258 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2259 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2260 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2261 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2262 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2263 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2264 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2265 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2266 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2267 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2268 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2269 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2270 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2271 }
2272 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2273}
2274
2275static void DoDumpstateBoardHidl(
2276 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2277 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2278 const Dumpstate::BugreportMode bugreport_mode,
2279 const size_t timeout_sec) {
2280
2281 using ScopedNativeHandle =
2282 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2283 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2284 [](native_handle_t* handle) {
2285 // we don't close file handle's here
2286 // via native_handle_close(handle)
2287 // instead we let dumpstate_fds close the file handles when
2288 // dumpstate_fds gets destroyed
2289 native_handle_delete(handle);
2290 });
2291 if (handle == nullptr) {
2292 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2293 return;
2294 }
2295
2296 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2297 handle.get()->data[i] = dumpstate_fds[i].get();
2298 }
2299
2300 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2301 // implement just 1.0.
2302 const char* descriptor_to_kill;
2303 using DumpstateBoardTask = std::packaged_task<bool()>;
2304 DumpstateBoardTask dumpstate_board_task;
2305 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2306 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2307 if (dumpstate_hal != nullptr) {
2308 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2309
2310 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2311 GetDumpstateHalModeHidl(bugreport_mode);
2312
2313 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2314 dumpstate_board_task =
2315 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2316 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2317 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2318 SEC_TO_MSEC(timeout_sec));
2319 if (!status.isOk()) {
2320 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2321 return false;
2322 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2323 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2324 dumpstate_hal_hidl::toString(status).c_str());
2325 return false;
2326 }
2327 return true;
2328 });
2329 } else {
2330 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2331
2332 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2333 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2334 ::android::hardware::Return<void> status =
2335 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2336 if (!status.isOk()) {
2337 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2338 return false;
2339 }
2340 return true;
2341 });
2342 }
2343 auto result = dumpstate_board_task.get_future();
2344 std::thread(std::move(dumpstate_board_task)).detach();
2345
2346 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2347 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2348 if (!android::base::SetProperty(
2349 "ctl.interface_restart",
2350 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2351 MYLOGE("Couldn't restart dumpstate HAL\n");
2352 }
2353 }
2354 // Wait some time for init to kill dumpstate vendor HAL
2355 constexpr size_t killing_timeout_sec = 10;
2356 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2357 MYLOGE(
2358 "killing dumpstateBoard timed out after %zus, continue and "
2359 "there might be racing in content\n",
2360 killing_timeout_sec);
2361 }
2362}
2363
2364static void DoDumpstateBoardAidl(
2365 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2366 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2367 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2368 MYLOGI("Using IDumpstateDevice AIDL HAL");
2369
2370 const char* descriptor_to_kill;
2371 using DumpstateBoardTask = std::packaged_task<bool()>;
2372 DumpstateBoardTask dumpstate_board_task;
2373 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2374 GetDumpstateHalModeAidl(bugreport_mode);
2375
2376 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2377 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2378 timeout_sec]() -> bool {
2379 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2380
2381 if (!status.isOk()) {
2382 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2383 return false;
2384 }
2385 return true;
2386 });
2387 auto result = dumpstate_board_task.get_future();
2388 std::thread(std::move(dumpstate_board_task)).detach();
2389
2390 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2391 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2392 if (!android::base::SetProperty(
2393 "ctl.interface_restart",
2394 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2395 MYLOGE("Couldn't restart dumpstate HAL\n");
2396 }
2397 }
2398 // Wait some time for init to kill dumpstate vendor HAL
2399 constexpr size_t killing_timeout_sec = 10;
2400 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2401 MYLOGE(
2402 "killing dumpstateBoard timed out after %zus, continue and "
2403 "there might be racing in content\n",
2404 killing_timeout_sec);
2405 }
2406}
2407
2408static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2409 const std::string aidl_instance_name =
2410 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2411
2412 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2413 return nullptr;
2414 }
2415
2416 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2417
2418 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2419}
2420
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002421void Dumpstate::DumpstateBoard(int out_fd) {
2422 dprintf(out_fd, "========================================================\n");
2423 dprintf(out_fd, "== Board\n");
2424 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002425
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002426 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002427 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002428 * set to true and unmount it after invoking dumpstateBoard_* methods.
2429 * This is to enable debug builds to not have debugfs mounted during runtime.
2430 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002431 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002432 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002433 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002434 if (mount_debugfs) {
2435 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2436 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002437 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002438 }
2439
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002440 std::vector<std::string> paths;
2441 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002442 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002443 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2444 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002445 remover.emplace_back(android::base::make_scope_guard(
2446 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002447 }
Jie Song9fbfad02017-06-20 16:29:42 -07002448
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002449 // get dumpstate HAL AIDL implementation
2450 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2451 GetDumpstateBoardAidlService());
2452 if (dumpstate_hal_handle_aidl == nullptr) {
2453 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2454 }
2455
2456 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2457 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2458 if (dumpstate_hal_handle_aidl == nullptr) {
2459 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2460 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2461 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2462 }
2463 }
2464
2465 // if neither HIDL nor AIDL implementation found, then return
2466 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2467 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002468 return;
2469 }
2470
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002471 // this is used to hold the file descriptors and when this variable goes out of scope
2472 // the file descriptors are closed
2473 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002474
Nandana Dutt5c390032019-03-12 10:52:56 +00002475 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002476 for (size_t i = 0; i < paths.size(); i++) {
2477 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2478
2479 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2480 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2481 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2482 if (fd < 0) {
2483 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2484 return;
2485 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002486
2487 dumpstate_fds.emplace_back(fd.release());
2488 // we call fd.release() here to make sure "fd" does not get closed
2489 // after "fd" goes out of scope after this block.
2490 // "fd" will be closed when "dumpstate_fds" goes out of scope
2491 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002492 }
2493
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002494 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2495 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2496 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002497 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002498
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002499 if (dumpstate_hal_handle_aidl != nullptr) {
2500 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2501 timeout_sec);
2502 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2503 // run HIDL HAL only if AIDL HAL not found
2504 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2505 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002506 }
2507
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002508 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002509 auto keep_debugfs_mounted =
2510 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2511 if (keep_debugfs_mounted.empty())
2512 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002513 }
2514
Wei Wang587eac92018-04-05 12:17:20 -07002515 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2516 for (size_t i = 0; i < paths.size(); i++) {
2517 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002518 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2519 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002520 file_sizes[i] = -1;
2521 continue;
2522 }
2523 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002524 }
2525
2526 for (size_t i = 0; i < paths.size(); i++) {
2527 if (file_sizes[i] == -1) {
2528 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002529 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002530 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002531 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002532 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002533 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002534 remover[i].Disable();
2535 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2536 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002537 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002538}
2539
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002540static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002541 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002542 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2543 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002544 " -h: display this help message\n"
2545 " -b: play sound file instead of vibrate, at beginning of job\n"
2546 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002547 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002548 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002549 " -s: write zipped file to control socket (for init)\n"
2550 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002551 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002552 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002553 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002554 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002555 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002556 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002557}
2558
Wei Liuf87959e2016-08-26 14:51:42 -07002559static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002560 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002561}
2562
Felipe Leme1d486fe2016-10-14 18:06:47 -07002563bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002564 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2565 if (zip_entry_tasks_) {
2566 zip_entry_tasks_->run(/* do_cancel = */false);
2567 }
2568
Felipe Leme9a523ae2016-10-20 15:10:33 -07002569 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002570 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002571 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002572 // Final timestamp
2573 char date[80];
2574 time_t the_real_now_please_stand_up = time(nullptr);
2575 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002576 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002577 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002578
Felipe Leme9a523ae2016-10-20 15:10:33 -07002579 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002580 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002581 return false;
2582 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002583 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002584 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002585 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002586 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002587
Felipe Leme0f3fb202016-06-10 17:10:53 -07002588 // Add log file (which contains stderr output) to zip...
2589 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002590 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002591 MYLOGE("Failed to add dumpstate log to .zip file\n");
2592 return false;
2593 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002594 // TODO: Should truncate the existing file.
2595 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002596 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2597 return false;
2598 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002599 fprintf(stderr, "\n");
2600
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002601 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002602 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002603 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002604 return false;
2605 }
2606
Felipe Leme1d486fe2016-10-14 18:06:47 -07002607 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2608 ds.zip_file.reset(nullptr);
2609
Felipe Lemee9d2c542016-11-15 11:48:26 -08002610 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002611 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002612
Felipe Leme1e9edc62015-12-21 16:02:13 -08002613 return true;
2614}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002615
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002616static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2617 // clang-format off
2618 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2619 "--receiver-foreground", "--receiver-include-background", "-a", action};
2620 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002621
2622 am.insert(am.end(), args.begin(), args.end());
2623
Felipe Leme8d2410e2017-02-08 09:46:08 -08002624 RunCommand("", am,
2625 CommandOptions::WithTimeout(20)
2626 .Log("Sending broadcast: '%s'\n")
2627 .Always()
2628 .DropRoot()
2629 .RedirectStderr()
2630 .Build());
2631}
2632
Felipe Leme35b8cf12017-02-10 15:47:29 -08002633static void Vibrate(int duration_ms) {
2634 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002635 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2636 "oneshot", std::to_string(duration_ms)};
2637 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002638 CommandOptions::WithTimeout(10)
2639 .Log("Vibrate: '%s'\n")
2640 .Always()
2641 .Build());
2642 // clang-format on
2643}
2644
Nandana Dutt979388e2018-11-30 16:48:55 +00002645static void MaybeResolveSymlink(std::string* path) {
2646 std::string resolved_path;
2647 if (android::base::Readlink(*path, &resolved_path)) {
2648 *path = resolved_path;
2649 }
2650}
2651
Nandana Dutt4be45d12018-09-26 15:04:23 +01002652/*
2653 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002654 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002655 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002656static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002657 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2658
Nandana Dutt4be45d12018-09-26 15:04:23 +01002659 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2660 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002661 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002662 char date[80];
2663 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2664 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002665
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002666 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002667 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002668 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002669 ds.base_name_ += "-wifi";
2670 }
2671
Paul Chang0d2aad72020-02-13 20:04:03 +08002672 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002673 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002674 }
2675 ds.tmp_path_ = ds.GetPath(".tmp");
2676 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2677
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002678 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002679 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002680 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002681 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002682 "Bugreport dir: [%s] "
2683 "Base name: [%s] "
2684 "Suffix: [%s] "
2685 "Log path: [%s] "
2686 "Temporary path: [%s] "
2687 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002688 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2689 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002690
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002691 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2692 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2693 create_parent_dirs(ds.path_.c_str());
2694 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2695 if (ds.zip_file == nullptr) {
2696 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2697 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002698 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002699 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2700 ds.AddTextZipEntry("version.txt", ds.version_);
2701 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002702}
2703
2704/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002705 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002706 * printing zipped file status, etc.
2707 */
2708static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002709 bool do_text_file = !ds.FinishZipFile();
2710 if (do_text_file) {
2711 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002712 }
mhasank2d75c442020-06-11 15:05:25 -07002713
2714 std::string final_path = ds.path_;
2715 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002716 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002717 android::os::CopyFileToFile(ds.path_, final_path);
2718 }
2719
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002720 if (ds.options_->stream_to_socket) {
2721 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2722 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002723 if (do_text_file) {
2724 dprintf(ds.control_socket_fd_,
2725 "FAIL:could not create zip file, check %s "
2726 "for more details\n",
2727 ds.log_path_.c_str());
2728 } else {
mhasank2d75c442020-06-11 15:05:25 -07002729 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002730 }
2731 }
2732}
2733
Nandana Dutt4be45d12018-09-26 15:04:23 +01002734
Nandana Dutt58d72e22018-11-16 10:30:48 +00002735static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2736 switch (mode) {
2737 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2738 return "BUGREPORT_FULL";
2739 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2740 return "BUGREPORT_INTERACTIVE";
2741 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2742 return "BUGREPORT_REMOTE";
2743 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2744 return "BUGREPORT_WEAR";
2745 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2746 return "BUGREPORT_TELEPHONY";
2747 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2748 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002749 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2750 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002751 }
2752}
2753
Paul Changf59c2b72020-03-10 02:08:55 +08002754static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2755 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002756 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2757 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002758 options->bugreport_mode = mode;
2759 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002760 switch (mode) {
2761 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002762 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002763 break;
2764 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002765 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002766 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002767 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002768 break;
2769 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002770 options->do_vibrate = false;
2771 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002772 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002773 break;
2774 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002775 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002776 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002777 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002778 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002779 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002780 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002781 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002782 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002783 break;
2784 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002785 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002786 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002787 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002788 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2789 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002790 }
2791}
2792
Nandana Dutt58d72e22018-11-16 10:30:48 +00002793static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002794 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002795 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002796 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002797 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002798 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002799 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002800 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002801 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002802 options.do_progress_updates, options.bugreport_fd.get(),
2803 options.bugreport_mode_string.c_str(),
2804 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002805}
2806
Nandana Dutt54dbd672019-01-11 12:58:05 +00002807void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2808 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002809 const android::base::unique_fd& screenshot_fd_in,
2810 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002811 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002812 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2813 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002814
Paul Changf59c2b72020-03-10 02:08:55 +08002815 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002816}
2817
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002818Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2819 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002820 int c;
mhasankd451a472020-05-26 18:02:39 -07002821 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002822 switch (c) {
2823 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002824 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002825 case 's': stream_to_socket = true; break;
2826 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002827 case 'v': show_header_only = true; break;
2828 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002829 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002830 case 'P': do_progress_updates = true; break;
2831 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002832 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002833 case 'V':
2834 case 'd':
2835 case 'z':
2836 // compatibility no-op
2837 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002838 case 'w':
2839 // This was already processed
2840 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002841 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002842 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002843 break;
2844 default:
2845 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002846 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002847 break;
2848 // clang-format on
2849 }
2850 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002851
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002852 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002853 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002854 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002855 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002856 }
2857 }
2858
2859 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2860 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002861
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002862 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002863}
2864
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002865bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002866 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002867 return false;
2868 }
2869
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002870 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002871 return false;
2872 }
2873
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002874 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002875 return false;
2876 }
2877 return true;
2878}
2879
Nandana Dutt197661d2018-11-16 16:40:21 +00002880void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2881 options_ = std::move(options);
2882}
2883
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002884void Dumpstate::Initialize() {
2885 /* gets the sequential id */
2886 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2887 id_ = ++last_id;
2888 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2889}
2890
Nandana Duttd2f5f082019-01-18 17:13:52 +00002891Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2892 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002893 if (listener_ != nullptr) {
2894 switch (status) {
2895 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002896 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002897 break;
2898 case Dumpstate::RunStatus::HELP:
2899 break;
2900 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002901 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002902 break;
2903 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002904 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2905 break;
2906 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2907 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2908 break;
2909 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2910 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002911 break;
2912 }
2913 }
2914 return status;
2915}
2916
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002917void Dumpstate::Cancel() {
2918 CleanupTmpFiles();
2919 android::os::UnlinkAndLogOnError(log_path_);
2920 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2921 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2922 kDumpstateBoardFiles[i]);
2923 }
2924 tombstone_data_.clear();
2925 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002926 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002927
2928 // Instead of shutdown the pool, we delete temporary files directly since
2929 // shutdown blocking the call.
2930 if (dump_pool_) {
2931 dump_pool_->deleteTempFiles();
2932 }
2933 if (zip_entry_tasks_) {
2934 zip_entry_tasks_->run(/*do_cancel =*/ true);
2935 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002936}
2937
Nandana Dutt979388e2018-11-30 16:48:55 +00002938/*
2939 * Dumps relevant information to a bugreport based on the given options.
2940 *
2941 * The bugreport can be dumped to a file or streamed to a socket.
2942 *
2943 * How dumping to file works:
2944 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2945 * stderr is redirected a log file.
2946 *
2947 * The temporary bugreport is then populated via printfs, dumping contents of files and
2948 * output of commands to stdout.
2949 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002950 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002951 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002952 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002953 *
mhasank2d75c442020-06-11 15:05:25 -07002954 * Bugreports are first generated in a local directory and later copied to the caller's fd
2955 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002956 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002957Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2958 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002959 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002960 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002961 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002962 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002963 return RunStatus::INVALID_INPUT;
2964 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002965 /* set as high priority, and protect from OOM killer */
2966 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002967
Felipe Lemed071c682016-10-20 16:48:00 -07002968 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002969 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002970 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002971 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002972 } else {
2973 /* fallback to kernels <= 2.6.35 */
2974 oom_adj = fopen("/proc/self/oom_adj", "we");
2975 if (oom_adj) {
2976 fputs("-17", oom_adj);
2977 fclose(oom_adj);
2978 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002979 }
2980
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002981 if (version_ == VERSION_DEFAULT) {
2982 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002983 }
2984
Chris Morin5a50d482022-02-01 17:41:18 -08002985 if (version_ != VERSION_CURRENT) {
2986 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
2987 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002988 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07002989 }
2990
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002991 if (options_->show_header_only) {
2992 PrintHeader();
2993 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07002994 }
2995
Abhijeet Kaur3172b532019-10-15 15:07:03 +01002996 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
2997 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00002998
Felipe Leme7447d7c2016-11-03 18:12:22 -07002999 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003000 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003001 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003002 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003003
Sahana Raof35ed432019-07-12 10:47:52 +01003004 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3005 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3006 } else {
3007 // Wake lock will be released automatically on process death
3008 MYLOGD("Wake lock acquired.\n");
3009 }
3010
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003011 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003012
Felipe Lemef0292972016-11-22 13:57:05 -08003013 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003014 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3015 }
3016
Nandana Dutt235c6672019-11-14 15:22:32 +00003017 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003018 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003019
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003020 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003021
Christopher Ferrised9354f2014-10-01 17:35:01 -07003022 // If we are going to use a socket, do it as early as possible
3023 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003024 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003025 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003026 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003027 if (control_socket_fd_ == -1) {
3028 return ERROR;
3029 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003030 if (options_->progress_updates_to_socket) {
3031 options_->do_progress_updates = 1;
3032 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003033 }
3034
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003035 if (!PrepareToWriteToFile()) {
3036 return ERROR;
3037 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003038
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003039 // Interactive, wear & telephony modes are default to true.
3040 // and may enable from cli option or when using control socket
3041 if (options_->do_progress_updates) {
3042 // clang-format off
3043 std::vector<std::string> am_args = {
3044 "--receiver-permission", "android.permission.DUMP",
3045 };
3046 // clang-format on
3047 // Send STARTED broadcast for apps that listen to bugreport generation events
3048 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3049 if (options_->progress_updates_to_socket) {
3050 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003051 }
3052 }
3053
Nick Kralevichf3599b32016-01-25 15:05:16 -08003054 /* read /proc/cmdline before dropping root */
3055 FILE *cmdline = fopen("/proc/cmdline", "re");
3056 if (cmdline) {
3057 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3058 fclose(cmdline);
3059 }
3060
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003061 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003062 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003063 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003064
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003065 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003066 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3067 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003068 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003069 }
3070 }
3071
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003072 int dup_stdout_fd;
3073 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003074 // Redirect stderr to log_path_ for debugging.
3075 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3076 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3077 return ERROR;
3078 }
3079 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3080 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3081 strerror(errno));
3082 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003083
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003084 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3085 // moved into zip file later, if zipping.
3086 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3087 // TODO: why not write to a file instead of stdout to overcome this problem?
3088 /* TODO: rather than generating a text file now and zipping it later,
3089 it would be more efficient to redirect stdout to the zip entry
3090 directly, but the libziparchive doesn't support that option yet. */
3091 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3092 return ERROR;
3093 }
3094 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3095 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3096 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003097 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003098
3099 // Don't buffer stdout
3100 setvbuf(stdout, nullptr, _IONBF, 0);
3101
Rhed Jao5377d792020-07-16 17:37:39 +08003102 // Enable the parallel run if the client requests to output to a file.
3103 EnableParallelRunIfNeeded();
3104 // Using scope guard to make sure the dump pool can be shut down correctly.
3105 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3106 ShutdownDumpPool();
3107 });
3108
Felipe Leme608385d2016-02-01 10:35:38 -08003109 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3110 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003111 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003112 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003113
Gavin Corkery6968f552020-11-22 18:09:05 +00003114 bool is_dumpstate_restricted = options_->telephony_only
3115 || options_->wifi_only
3116 || options_->limited_only;
3117 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003118 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003119 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003120 }
3121 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003122
3123 if (!is_dumpstate_restricted) {
3124 // Snapshot the system trace now (if running) to avoid that dumpstate's
3125 // own activity pushes out interesting data from the trace ring buffer.
3126 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3127 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003128
3129 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3130 // from WMTRACE_DATA_DIR.
3131 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003132 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003133 onUiIntensiveBugreportDumpsFinished(calling_uid);
3134 MaybeCheckUserConsent(calling_uid, calling_package);
3135 if (options_->telephony_only) {
3136 DumpstateTelephonyOnly(calling_package);
3137 } else if (options_->wifi_only) {
3138 DumpstateWifiOnly();
3139 } else if (options_->limited_only) {
3140 DumpstateLimitedOnly();
3141 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003142 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003143 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003144 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003145 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003146 HandleUserConsentDenied();
3147 }
3148 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003149 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003150 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003151
Felipe Leme55b42a62015-11-10 17:39:08 -08003152 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003153 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003154
Abhijeet Kaure370d682019-10-01 16:49:30 +01003155 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003156 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003157 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003158 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003159
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003160 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003161 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003162 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003163 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003164 if (status != Dumpstate::RunStatus::OK &&
3165 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3166 // Do an early return if there were errors. We make an exception for consent
3167 // timing out because it's possible the user got distracted. In this case the
3168 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003169 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003170 return status;
3171 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003172 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3173 MYLOGI(
3174 "Did not receive user consent yet."
3175 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003176 const String16 incidentcompanion("incidentcompanion");
3177 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3178 if (ics != nullptr) {
3179 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3180 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3181 consent_callback_.get());
3182 } else {
3183 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3184 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003185 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003186 }
3187
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003188 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003189 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003190 for (int i = 0; i < 3; i++) {
3191 Vibrate(75);
3192 usleep((75 + 50) * 1000);
3193 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003194 }
3195
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003196 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3197 progress_->GetInitialMax());
3198 progress_->Save();
3199 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003200
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003201 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003202
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003203 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003204 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003205 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003206 }
3207
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003208 tombstone_data_.clear();
3209 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003210 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003211
Nandana Duttd2f5f082019-01-18 17:13:52 +00003212 return (consent_callback_ != nullptr &&
3213 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3214 ? USER_CONSENT_TIMED_OUT
3215 : RunStatus::OK;
3216}
3217
Paul Chang0d2aad72020-02-13 20:04:03 +08003218void Dumpstate::MaybeTakeEarlyScreenshot() {
3219 if (!options_->do_screenshot || !do_early_screenshot_) {
3220 return;
3221 }
3222
3223 TakeScreenshot();
3224}
3225
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003226void Dumpstate::MaybeSnapshotSystemTrace() {
3227 // If a background system trace is happening and is marked as "suitable for
3228 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3229 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3230 // case that no trace is ongoing, this command is a no-op.
3231 // Note: this should not be enqueued as we need to freeze the trace before
3232 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3233 // the dumpstate's own activity which is irrelevant.
3234 int res = RunCommand(
3235 "SERIALIZE PERFETTO TRACE",
3236 {"perfetto", "--save-for-bugreport"},
3237 CommandOptions::WithTimeout(10)
3238 .DropRoot()
3239 .CloseAllFileDescriptorsOnExec()
3240 .Build());
3241 has_system_trace_ = res == 0;
3242 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3243 // file in the later stages.
3244}
3245
Yohei Yukawa95305b32021-03-09 07:54:27 -08003246void Dumpstate::MaybeSnapshotWinTrace() {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003247 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3248 for (const auto& service : {"window", "input_method"}) {
3249 RunCommand(
3250 // Empty name because it's not intended to be classified as a bugreport section.
3251 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3252 "", {"cmd", service, "tracing", "save-for-bugreport"},
3253 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3254 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003255}
3256
Paul Changeb4b4642020-05-28 22:05:47 +08003257void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003258 if (calling_uid == AID_SHELL || !CalledByApi()) {
3259 return;
3260 }
3261 if (listener_ != nullptr) {
3262 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3263 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003264 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003265 }
3266}
3267
Jichao Lie89d9c12019-11-21 19:02:51 -08003268void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3269 if (calling_uid == AID_SHELL || !CalledByApi()) {
3270 // No need to get consent for shell triggered dumpstates, or not through
3271 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003272 return;
3273 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003274 consent_callback_ = new ConsentCallback();
3275 const String16 incidentcompanion("incidentcompanion");
3276 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003277 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003278 if (ics != nullptr) {
3279 MYLOGD("Checking user consent via incidentcompanion service\n");
3280 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003281 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003282 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003283 } else {
3284 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3285 }
3286}
3287
Nandana Dutt5c390032019-03-12 10:52:56 +00003288bool Dumpstate::IsUserConsentDenied() const {
3289 return ds.consent_callback_ != nullptr &&
3290 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3291}
3292
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003293bool Dumpstate::CalledByApi() const {
3294 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3295}
3296
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003297void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003298 android::os::UnlinkAndLogOnError(tmp_path_);
3299 android::os::UnlinkAndLogOnError(screenshot_path_);
3300 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003301 if (dump_traces_path != nullptr) {
3302 android::os::UnlinkAndLogOnError(dump_traces_path);
3303 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003304}
3305
Rhed Jao5377d792020-07-16 17:37:39 +08003306void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003307 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003308 return;
3309 }
3310 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003311 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003312}
3313
3314void Dumpstate::ShutdownDumpPool() {
3315 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003316 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003317 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003318 if (zip_entry_tasks_) {
3319 zip_entry_tasks_->run(/* do_cancel = */true);
3320 zip_entry_tasks_ = nullptr;
3321 }
3322}
3323
3324void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3325 const std::string& entry_path) {
3326 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3327 if (!task_cancelled) {
3328 AddZipEntry(entry_name, entry_path);
3329 }
3330 android::os::UnlinkAndLogOnError(entry_path);
3331 };
3332 if (zip_entry_tasks_) {
3333 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3334 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3335 } else {
3336 // Invokes AddZipEntryAndCleanup immediately
3337 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3338 }
Rhed Jao5377d792020-07-16 17:37:39 +08003339}
3340
Nandana Duttd2f5f082019-01-18 17:13:52 +00003341Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3342 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003343 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003344 return USER_CONSENT_DENIED;
3345}
3346
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003347Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003348 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003349 // user consent (unless the caller is Shell).
3350 UserConsentResult consent_result;
3351 if (calling_uid == AID_SHELL) {
3352 consent_result = UserConsentResult::APPROVED;
3353 } else {
3354 consent_result = consent_callback_->getResult();
3355 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003356 if (consent_result == UserConsentResult::UNAVAILABLE) {
3357 // User has not responded yet.
3358 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003359 // Telephony is a fast report type, particularly on user builds where information may be
3360 // more aggressively limited. To give the user time to read the consent dialog, increase the
3361 // timeout.
3362 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3363 : USER_CONSENT_TIMEOUT_MS;
3364 if (elapsed_ms < timeout_ms) {
3365 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003366 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3367 sleep(delay_seconds);
3368 }
3369 consent_result = consent_callback_->getResult();
3370 }
3371 if (consent_result == UserConsentResult::DENIED) {
3372 // User has explicitly denied sharing with the app. To be safe delete the
3373 // internal bugreport & tmp files.
3374 return HandleUserConsentDenied();
3375 }
3376 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003377 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3378 if (copy_succeeded) {
3379 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003380 if (options_->do_screenshot &&
3381 options_->screenshot_fd.get() != -1 &&
3382 !options_->is_screenshot_copied) {
3383 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3384 options_->screenshot_fd.get());
3385 options_->is_screenshot_copied = copy_succeeded;
3386 if (copy_succeeded) {
3387 android::os::UnlinkAndLogOnError(screenshot_path_);
3388 }
3389 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003390 }
3391 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3392 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3393 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3394 // Since we do not have user consent to share the bugreport it does not get
3395 // copied over to the calling app but remains in the internal directory from
3396 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003397 std::string final_path = GetPath(".zip");
3398 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3399 if (copy_succeeded) {
3400 android::os::UnlinkAndLogOnError(path_);
3401 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003402 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3403 }
3404 // Unknown result; must be a programming error.
3405 MYLOGE("Unknown user consent result:%d\n", consent_result);
3406 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003407}
3408
Nandana Duttf02564e2019-02-15 15:24:24 +00003409Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003410 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3411 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3412 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003413 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003414 // When directly running dumpstate binary, the output is not expected to be written
3415 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003416 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003417
3418 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003419 // an app; they are irrelevant here because bugreport is triggered via command line.
3420 // Update Last ID before calling Run().
3421 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003422 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003423 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003424 return status;
3425}
3426
3427/* Main entry point for dumpstate binary. */
3428int run_main(int argc, char* argv[]) {
3429 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003430
3431 switch (status) {
3432 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003433 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003434 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003435 ShowUsage();
3436 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003437 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003438 fprintf(stderr, "Invalid combination of args\n");
3439 ShowUsage();
3440 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003441 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003442 FALLTHROUGH_INTENDED;
3443 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3444 FALLTHROUGH_INTENDED;
3445 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003446 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003447 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003448}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003449
3450// TODO(111441001): Default DumpOptions to sensible values.
3451Dumpstate::Dumpstate(const std::string& version)
3452 : pid_(getpid()),
3453 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003454 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003455 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003456 now_(time(nullptr)),
3457 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003458}
3459
3460Dumpstate& Dumpstate::GetInstance() {
3461 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3462 return singleton_;
3463}
3464
Rhed Jao5377d792020-07-16 17:37:39 +08003465DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3466 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3467 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003468 if (!title_.empty()) {
3469 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003470 if (title_.find("SHOW MAP") == std::string::npos) {
3471 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3472 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003473 }
3474}
3475
3476DurationReporter::~DurationReporter() {
3477 if (!title_.empty()) {
3478 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003479 if (elapsed >= .5f || verbose_) {
3480 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003481 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003482 if (!logcat_only_) {
3483 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003484 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3485 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003486 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003487 if (title_.find("SHOW MAP") == std::string::npos) {
3488 ATRACE_ASYNC_END(title_.c_str(), 0);
3489 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003490 }
3491}
3492
3493const int32_t Progress::kDefaultMax = 5000;
3494
3495Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3496}
3497
3498Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3499 : Progress(initial_max, growth_factor, "") {
3500 progress_ = progress;
3501}
3502
3503Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3504 : initial_max_(initial_max),
3505 progress_(0),
3506 max_(initial_max),
3507 growth_factor_(growth_factor),
3508 n_runs_(0),
3509 average_max_(0),
3510 path_(path) {
3511 if (!path_.empty()) {
3512 Load();
3513 }
3514}
3515
3516void Progress::Load() {
3517 MYLOGD("Loading stats from %s\n", path_.c_str());
3518 std::string content;
3519 if (!android::base::ReadFileToString(path_, &content)) {
3520 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3521 return;
3522 }
3523 if (content.empty()) {
3524 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3525 return;
3526 }
3527 std::vector<std::string> lines = android::base::Split(content, "\n");
3528
3529 if (lines.size() < 1) {
3530 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3531 (int)lines.size(), max_);
3532 return;
3533 }
3534 char* ptr;
3535 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3536 average_max_ = strtol(ptr, nullptr, 10);
3537 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3538 average_max_ > STATS_MAX_AVERAGE) {
3539 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3540 initial_max_ = Progress::kDefaultMax;
3541 } else {
3542 initial_max_ = average_max_;
3543 }
3544 max_ = initial_max_;
3545
3546 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3547}
3548
3549void Progress::Save() {
3550 int32_t total = n_runs_ * average_max_ + progress_;
3551 int32_t runs = n_runs_ + 1;
3552 int32_t average = floor(((float)total) / runs);
3553 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3554 path_.c_str());
3555 if (path_.empty()) {
3556 return;
3557 }
3558
3559 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3560 if (!android::base::WriteStringToFile(content, path_)) {
3561 MYLOGE("Could not save stats on %s\n", path_.c_str());
3562 }
3563}
3564
3565int32_t Progress::Get() const {
3566 return progress_;
3567}
3568
3569bool Progress::Inc(int32_t delta_sec) {
3570 bool changed = false;
3571 if (delta_sec >= 0) {
3572 progress_ += delta_sec;
3573 if (progress_ > max_) {
3574 int32_t old_max = max_;
3575 max_ = floor((float)progress_ * growth_factor_);
3576 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3577 changed = true;
3578 }
3579 }
3580 return changed;
3581}
3582
3583int32_t Progress::GetMax() const {
3584 return max_;
3585}
3586
3587int32_t Progress::GetInitialMax() const {
3588 return initial_max_;
3589}
3590
3591void Progress::Dump(int fd, const std::string& prefix) const {
3592 const char* pr = prefix.c_str();
3593 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3594 dprintf(fd, "%smax: %d\n", pr, max_);
3595 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3596 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3597 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3598 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3599 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3600}
3601
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003602std::string Dumpstate::GetPath(const std::string& suffix) const {
3603 return GetPath(bugreport_internal_dir_, suffix);
3604}
3605
3606std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3607 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3608 name_.c_str(), suffix.c_str());
3609}
3610
3611void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3612 progress_ = std::move(progress);
3613}
3614
3615void for_each_userid(void (*func)(int), const char *header) {
3616 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3617 "for_each_userid(%s)", header);
3618 DurationReporter duration_reporter(title);
3619 if (PropertiesHelper::IsDryRun()) return;
3620
3621 DIR *d;
3622 struct dirent *de;
3623
3624 if (header) printf("\n------ %s ------\n", header);
3625 func(0);
3626
3627 if (!(d = opendir("/data/system/users"))) {
3628 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3629 return;
3630 }
3631
3632 while ((de = readdir(d))) {
3633 int userid;
3634 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3635 continue;
3636 }
3637 func(userid);
3638 }
3639
3640 closedir(d);
3641}
3642
3643static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3644 DIR *d;
3645 struct dirent *de;
3646
3647 if (!(d = opendir("/proc"))) {
3648 printf("Failed to open /proc (%s)\n", strerror(errno));
3649 return;
3650 }
3651
3652 if (header) printf("\n------ %s ------\n", header);
3653 while ((de = readdir(d))) {
3654 if (ds.IsUserConsentDenied()) {
3655 MYLOGE(
3656 "Returning early because user denied consent to share bugreport with calling app.");
3657 closedir(d);
3658 return;
3659 }
3660 int pid;
3661 int fd;
3662 char cmdpath[255];
3663 char cmdline[255];
3664
3665 if (!(pid = atoi(de->d_name))) {
3666 continue;
3667 }
3668
3669 memset(cmdline, 0, sizeof(cmdline));
3670
3671 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3672 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3673 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3674 close(fd);
3675 if (cmdline[0]) {
3676 helper(pid, cmdline, arg);
3677 continue;
3678 }
3679 }
3680
3681 // if no cmdline, a kernel thread has comm
3682 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3683 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3684 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3685 close(fd);
3686 if (cmdline[1]) {
3687 cmdline[0] = '[';
3688 size_t len = strcspn(cmdline, "\f\b\r\n");
3689 cmdline[len] = ']';
3690 cmdline[len+1] = '\0';
3691 }
3692 }
3693 if (!cmdline[0]) {
3694 strcpy(cmdline, "N/A");
3695 }
3696 helper(pid, cmdline, arg);
3697 }
3698
3699 closedir(d);
3700}
3701
3702static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3703 for_each_pid_func *func = (for_each_pid_func*) arg;
3704 func(pid, cmdline);
3705}
3706
3707void for_each_pid(for_each_pid_func func, const char *header) {
3708 std::string title = header == nullptr ? "for_each_pid"
3709 : android::base::StringPrintf("for_each_pid(%s)", header);
3710 DurationReporter duration_reporter(title);
3711 if (PropertiesHelper::IsDryRun()) return;
3712
3713 __for_each_pid(for_each_pid_helper, header, (void *) func);
3714}
3715
3716static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3717 DIR *d;
3718 struct dirent *de;
3719 char taskpath[255];
3720 for_each_tid_func *func = (for_each_tid_func *) arg;
3721
3722 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3723
3724 if (!(d = opendir(taskpath))) {
3725 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3726 return;
3727 }
3728
3729 func(pid, pid, cmdline);
3730
3731 while ((de = readdir(d))) {
3732 if (ds.IsUserConsentDenied()) {
3733 MYLOGE(
3734 "Returning early because user denied consent to share bugreport with calling app.");
3735 closedir(d);
3736 return;
3737 }
3738 int tid;
3739 int fd;
3740 char commpath[255];
3741 char comm[255];
3742
3743 if (!(tid = atoi(de->d_name))) {
3744 continue;
3745 }
3746
3747 if (tid == pid)
3748 continue;
3749
3750 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3751 memset(comm, 0, sizeof(comm));
3752 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3753 strcpy(comm, "N/A");
3754 } else {
3755 char *c;
3756 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3757 close(fd);
3758
3759 c = strrchr(comm, '\n');
3760 if (c) {
3761 *c = '\0';
3762 }
3763 }
3764 func(pid, tid, comm);
3765 }
3766
3767 closedir(d);
3768}
3769
3770void for_each_tid(for_each_tid_func func, const char *header) {
3771 std::string title = header == nullptr ? "for_each_tid"
3772 : android::base::StringPrintf("for_each_tid(%s)", header);
3773 DurationReporter duration_reporter(title);
3774
3775 if (PropertiesHelper::IsDryRun()) return;
3776
3777 __for_each_pid(for_each_tid_helper, header, (void *) func);
3778}
3779
3780void show_wchan(int pid, int tid, const char *name) {
3781 if (PropertiesHelper::IsDryRun()) return;
3782
3783 char path[255];
3784 char buffer[255];
3785 int fd, ret, save_errno;
3786 char name_buffer[255];
3787
3788 memset(buffer, 0, sizeof(buffer));
3789
3790 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3791 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3792 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3793 return;
3794 }
3795
3796 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3797 save_errno = errno;
3798 close(fd);
3799
3800 if (ret < 0) {
3801 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3802 return;
3803 }
3804
3805 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3806 pid == tid ? 0 : 3, "", name);
3807
3808 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3809
3810 return;
3811}
3812
3813// print time in centiseconds
3814static void snprcent(char *buffer, size_t len, size_t spc,
3815 unsigned long long time) {
3816 static long hz; // cache discovered hz
3817
3818 if (hz <= 0) {
3819 hz = sysconf(_SC_CLK_TCK);
3820 if (hz <= 0) {
3821 hz = 1000;
3822 }
3823 }
3824
3825 // convert to centiseconds
3826 time = (time * 100 + (hz / 2)) / hz;
3827
3828 char str[16];
3829
3830 snprintf(str, sizeof(str), " %llu.%02u",
3831 time / 100, (unsigned)(time % 100));
3832 size_t offset = strlen(buffer);
3833 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3834 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3835}
3836
3837// print permille as a percent
3838static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3839 char str[16];
3840
3841 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3842 size_t offset = strlen(buffer);
3843 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3844 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3845}
3846
3847void show_showtime(int pid, const char *name) {
3848 if (PropertiesHelper::IsDryRun()) return;
3849
3850 char path[255];
3851 char buffer[1023];
3852 int fd, ret, save_errno;
3853
3854 memset(buffer, 0, sizeof(buffer));
3855
3856 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3857 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3858 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3859 return;
3860 }
3861
3862 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3863 save_errno = errno;
3864 close(fd);
3865
3866 if (ret < 0) {
3867 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3868 return;
3869 }
3870
3871 // field 14 is utime
3872 // field 15 is stime
3873 // field 42 is iotime
3874 unsigned long long utime = 0, stime = 0, iotime = 0;
3875 if (sscanf(buffer,
3876 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3877 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3878 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3879 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3880 &utime, &stime, &iotime) != 3) {
3881 return;
3882 }
3883
3884 unsigned long long total = utime + stime;
3885 if (!total) {
3886 return;
3887 }
3888
3889 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3890 if (permille > 1000) {
3891 permille = 1000;
3892 }
3893
3894 // try to beautify and stabilize columns at <80 characters
3895 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3896 if ((name[0] != '[') || utime) {
3897 snprcent(buffer, sizeof(buffer), 57, utime);
3898 }
3899 snprcent(buffer, sizeof(buffer), 65, stime);
3900 if ((name[0] != '[') || iotime) {
3901 snprcent(buffer, sizeof(buffer), 73, iotime);
3902 }
3903 if (iotime) {
3904 snprdec(buffer, sizeof(buffer), 79, permille);
3905 }
3906 puts(buffer); // adds a trailing newline
3907
3908 return;
3909}
3910
3911void do_dmesg() {
3912 const char *title = "KERNEL LOG (dmesg)";
3913 DurationReporter duration_reporter(title);
3914 printf("------ %s ------\n", title);
3915
3916 if (PropertiesHelper::IsDryRun()) return;
3917
3918 /* Get size of kernel buffer */
3919 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3920 if (size <= 0) {
3921 printf("Unexpected klogctl return value: %d\n\n", size);
3922 return;
3923 }
3924 char *buf = (char *) malloc(size + 1);
3925 if (buf == nullptr) {
3926 printf("memory allocation failed\n\n");
3927 return;
3928 }
3929 int retval = klogctl(KLOG_READ_ALL, buf, size);
3930 if (retval < 0) {
3931 printf("klogctl failure\n\n");
3932 free(buf);
3933 return;
3934 }
3935 buf[retval] = '\0';
3936 printf("%s\n\n", buf);
3937 free(buf);
3938 return;
3939}
3940
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003941int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3942 DurationReporter duration_reporter(title);
3943
3944 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3945
3946 UpdateProgress(WEIGHT_FILE);
3947
3948 return status;
3949}
3950
3951int read_file_as_long(const char *path, long int *output) {
3952 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3953 if (fd < 0) {
3954 int err = errno;
3955 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3956 return -1;
3957 }
3958 char buffer[50];
3959 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3960 if (bytes_read == -1) {
3961 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3962 return -2;
3963 }
3964 if (bytes_read == 0) {
3965 MYLOGE("File %s is empty\n", path);
3966 return -3;
3967 }
3968 *output = atoi(buffer);
3969 return 0;
3970}
3971
3972/* calls skip to gate calling dump_from_fd recursively
3973 * in the specified directory. dump_from_fd defaults to
3974 * dump_file_from_fd above when set to NULL. skip defaults
3975 * to false when set to NULL. dump_from_fd will always be
3976 * called with title NULL.
3977 */
3978int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
3979 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
3980 DurationReporter duration_reporter(title);
3981 DIR *dirp;
3982 struct dirent *d;
3983 char *newpath = nullptr;
3984 const char *slash = "/";
3985 int retval = 0;
3986
3987 if (!title.empty()) {
3988 printf("------ %s (%s) ------\n", title.c_str(), dir);
3989 }
3990 if (PropertiesHelper::IsDryRun()) return 0;
3991
3992 if (dir[strlen(dir) - 1] == '/') {
3993 ++slash;
3994 }
3995 dirp = opendir(dir);
3996 if (dirp == nullptr) {
3997 retval = -errno;
3998 MYLOGE("%s: %s\n", dir, strerror(errno));
3999 return retval;
4000 }
4001
4002 if (!dump_from_fd) {
4003 dump_from_fd = dump_file_from_fd;
4004 }
4005 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4006 if ((d->d_name[0] == '.')
4007 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4008 || (d->d_name[1] == '\0'))) {
4009 continue;
4010 }
4011 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4012 (d->d_type == DT_DIR) ? "/" : "");
4013 if (!newpath) {
4014 retval = -errno;
4015 continue;
4016 }
4017 if (skip && (*skip)(newpath)) {
4018 continue;
4019 }
4020 if (d->d_type == DT_DIR) {
4021 int ret = dump_files("", newpath, skip, dump_from_fd);
4022 if (ret < 0) {
4023 retval = ret;
4024 }
4025 continue;
4026 }
4027 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4028 if (fd.get() < 0) {
4029 retval = -1;
4030 printf("*** %s: %s\n", newpath, strerror(errno));
4031 continue;
4032 }
4033 (*dump_from_fd)(nullptr, newpath, fd.get());
4034 }
4035 closedir(dirp);
4036 if (!title.empty()) {
4037 printf("\n");
4038 }
4039 return retval;
4040}
4041
4042/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4043 * it's possible to avoid issues where opening the file itself can get
4044 * stuck.
4045 */
4046int dump_file_from_fd(const char *title, const char *path, int fd) {
4047 if (PropertiesHelper::IsDryRun()) return 0;
4048
4049 int flags = fcntl(fd, F_GETFL);
4050 if (flags == -1) {
4051 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4052 return -1;
4053 } else if (!(flags & O_NONBLOCK)) {
4054 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4055 return -1;
4056 }
4057 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4058}
4059
4060int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004061 const CommandOptions& options, bool verbose_duration, int out_fd) {
4062 DurationReporter duration_reporter(title, false /* logcat_only */,
4063 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004064
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004065 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004066
4067 /* TODO: for now we're simplifying the progress calculation by using the
4068 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4069 * where its weight should be much higher proportionally to its timeout.
4070 * Ideally, it should use a options.EstimatedDuration() instead...*/
4071 UpdateProgress(options.Timeout());
4072
4073 return status;
4074}
4075
4076void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004077 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004078 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4079 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4080 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004081 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004082}
4083
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004084static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004085 int s = android_get_control_socket(service);
4086 if (s < 0) {
4087 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4088 return -1;
4089 }
4090 fcntl(s, F_SETFD, FD_CLOEXEC);
4091
4092 // Set backlog to 0 to make sure that queue size will be minimum.
4093 // In Linux, because the minimum queue will be 1, connect() will be blocked
4094 // if the other clients already called connect() and the connection request was not accepted.
4095 if (listen(s, 0) < 0) {
4096 MYLOGE("listen(control socket): %s\n", strerror(errno));
4097 return -1;
4098 }
4099
4100 struct sockaddr addr;
4101 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004102 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004103
4104 // Close socket just after accept(), to make sure that connect() by client will get error
4105 // when the socket is used by the other services.
4106 // There is still a race condition possibility between accept and close, but there is no way
4107 // to close-on-accept atomically.
4108 // See detail; b/123306389#comment25
4109 close(s);
4110
4111 if (fd < 0) {
4112 MYLOGE("accept(control socket): %s\n", strerror(errno));
4113 return -1;
4114 }
4115
4116 return fd;
4117}
4118
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004119// TODO: should call is_valid_output_file and/or be merged into it.
4120void create_parent_dirs(const char *path) {
4121 char *chp = const_cast<char *> (path);
4122
4123 /* skip initial slash */
4124 if (chp[0] == '/')
4125 chp++;
4126
4127 /* create leading directories, if necessary */
4128 struct stat dir_stat;
4129 while (chp && chp[0]) {
4130 chp = strchr(chp, '/');
4131 if (chp) {
4132 *chp = 0;
4133 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4134 MYLOGI("Creating directory %s\n", path);
4135 if (mkdir(path, 0770)) { /* drwxrwx--- */
4136 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4137 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4138 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4139 }
4140 }
4141 *chp++ = '/';
4142 }
4143 }
4144}
4145
4146bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4147 create_parent_dirs(path);
4148
4149 int fd = TEMP_FAILURE_RETRY(open(path,
4150 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4151 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4152 if (fd < 0) {
4153 MYLOGE("%s: %s\n", path, strerror(errno));
4154 return false;
4155 }
4156
4157 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4158 close(fd);
4159 return true;
4160}
4161
4162bool redirect_to_file(FILE* redirect, char* path) {
4163 return _redirect_to_file(redirect, path, O_TRUNC);
4164}
4165
4166bool redirect_to_existing_file(FILE* redirect, char* path) {
4167 return _redirect_to_file(redirect, path, O_APPEND);
4168}
4169
4170void dump_route_tables() {
4171 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4172 if (PropertiesHelper::IsDryRun()) return;
4173 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4174 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4175 FILE* fp = fopen(RT_TABLES_PATH, "re");
4176 if (!fp) {
4177 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4178 return;
4179 }
4180 char table[16];
4181 // Each line has an integer (the table number), a space, and a string (the table name). We only
4182 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4183 // Add a fixed max limit so this doesn't go awry.
4184 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4185 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4186 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4187 }
4188 fclose(fp);
4189}
4190
Li Li830179f2022-01-04 12:53:29 -08004191void dump_frozen_cgroupfs(const char *dir, int level,
4192 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4193 DIR *dirp;
4194 struct dirent *d;
4195 char *newpath = nullptr;
4196
4197 dirp = opendir(dir);
4198 if (dirp == nullptr) {
4199 MYLOGE("%s: %s\n", dir, strerror(errno));
4200 return;
4201 }
4202
4203 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4204 if ((d->d_name[0] == '.')
4205 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4206 || (d->d_name[1] == '\0'))) {
4207 continue;
4208 }
4209 if (d->d_type == DT_DIR) {
4210 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4211 if (!newpath) {
4212 continue;
4213 }
4214 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4215 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4216 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4217 char *freezer = nullptr;
4218 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4219 if (freezer) {
4220 FILE* fp = fopen(freezer, "r");
4221 if (fp != NULL) {
4222 int frozen;
4223 fscanf(fp, "%d", &frozen);
4224 if (frozen > 0) {
4225 dump_files("", newpath, skip_none, dump_from_fd);
4226 }
4227 fclose(fp);
4228 }
4229 free(freezer);
4230 }
4231 }
4232 }
4233 }
4234 closedir(dirp);
4235}
4236
4237void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004238 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4239 DurationReporter duration_reporter("FROZEN CGROUPFS");
4240 if (PropertiesHelper::IsDryRun()) return;
4241 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4242}
4243
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004244void Dumpstate::UpdateProgress(int32_t delta_sec) {
4245 if (progress_ == nullptr) {
4246 MYLOGE("UpdateProgress: progress_ not set\n");
4247 return;
4248 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004249 // This function updates progress related members of the dumpstate and reports
4250 // progress percentage to the bugreport client. Since it could be called by
4251 // different dump tasks at the same time if the parallel run is enabled, a
4252 // mutex lock is necessary here to synchronize the call.
4253 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004254
4255 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004256 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004257
4258 // ...but only notifiy listeners when necessary.
4259 if (!options_->do_progress_updates) return;
4260
4261 int progress = progress_->Get();
4262 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004263 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004264
Nandana Dutt402a8392019-06-14 14:25:13 +01004265 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004266 return;
4267 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004268 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004269
4270 if (control_socket_fd_ >= 0) {
4271 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4272 fsync(control_socket_fd_);
4273 }
4274
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004275 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004276 if (percent % 10 == 0) {
4277 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004278 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004279 } else {
4280 // stderr is ignored on normal invocations, but useful when calling
4281 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004282 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004283 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004284
4285 listener_->onProgress(percent);
4286 }
4287}
4288
4289void Dumpstate::TakeScreenshot(const std::string& path) {
4290 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4291 int status =
4292 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4293 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4294 if (status == 0) {
4295 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4296 } else {
4297 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4298 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004299 if (listener_ != nullptr) {
4300 // Show a visual indication to indicate screenshot is taken via
4301 // IDumpstateListener.onScreenshotTaken()
4302 listener_->onScreenshotTaken(status == 0);
4303 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004304}
4305
4306bool is_dir(const char* pathname) {
4307 struct stat info;
4308 if (stat(pathname, &info) == -1) {
4309 return false;
4310 }
4311 return S_ISDIR(info.st_mode);
4312}
4313
4314time_t get_mtime(int fd, time_t default_mtime) {
4315 struct stat info;
4316 if (fstat(fd, &info) == -1) {
4317 return default_mtime;
4318 }
4319 return info.st_mtime;
4320}