blob: 0e4299292805b3760212efa1be36f612a4db24a4 [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"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700188#define DROPBOX_DIR "/data/system/dropbox"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700189
Narayan Kamath8f788292017-05-25 13:20:39 +0100190// TODO(narayan): Since this information has to be kept in sync
191// with tombstoned, we should just put it in a common header.
192//
193// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100194static const std::string TOMBSTONE_DIR = "/data/tombstones/";
195static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
196static const std::string ANR_DIR = "/data/anr/";
197static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800198static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
199static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000202
Nandana Dutt5c390032019-03-12 10:52:56 +0000203#define RETURN_IF_USER_DENIED_CONSENT() \
204 if (ds.IsUserConsentDenied()) { \
205 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
206 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
207 }
208
209// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
210// if consent is found to be denied.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 func_ptr(__VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao5377d792020-07-16 17:37:39 +0800216// Runs func_ptr, and logs a duration report after it's finished.
217#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
218 { \
219 DurationReporter duration_reporter_in_macro(log_title); \
220 func_ptr(__VA_ARGS__); \
221 }
222
223// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
224// is output after a slow function is finished.
225#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
226 RETURN_IF_USER_DENIED_CONSENT(); \
227 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
228 RETURN_IF_USER_DENIED_CONSENT();
229
Chris Morinbc223142022-02-04 14:17:11 -0800230#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800231 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800232 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800233 RETURN_IF_USER_DENIED_CONSENT();
234
Sahana Raof35ed432019-07-12 10:47:52 +0100235static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
236
Rhed Jao5377d792020-07-16 17:37:39 +0800237// Names of parallel tasks, they are used for the DumpPool to identify the dump
238// task and the log title of the duration report.
239static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800240static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800241static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800242static const std::string DUMP_HALS_TASK = "DUMP HALS";
243static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800244static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800245
Nandana Dutt979388e2018-11-30 16:48:55 +0000246namespace android {
247namespace os {
248namespace {
249
250static int Open(std::string path, int flags, mode_t mode = 0) {
251 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
252 if (fd == -1) {
253 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
254 }
255 return fd;
256}
257
mhasank2d75c442020-06-11 15:05:25 -0700258static int OpenForWrite(std::string path) {
259 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
260 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
261}
Nandana Dutt979388e2018-11-30 16:48:55 +0000262
263static int OpenForRead(std::string path) {
264 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
265}
266
267bool CopyFile(int in_fd, int out_fd) {
268 char buf[4096];
269 ssize_t byte_count;
270 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
271 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
272 return false;
273 }
274 }
275 return (byte_count != -1);
276}
277
278static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000279 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000280
281 // Obtain a handle to the source file.
282 android::base::unique_fd in_fd(OpenForRead(input_file));
283 if (out_fd != -1 && in_fd.get() != -1) {
284 if (CopyFile(in_fd.get(), out_fd)) {
285 return true;
286 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000287 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000288 }
289 return false;
290}
291
Nandana Duttd2f5f082019-01-18 17:13:52 +0000292static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000293 if (file.empty()) {
294 return false;
295 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000296 if (unlink(file.c_str())) {
297 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000298 return false;
299 }
300 return true;
301}
Nandana Dutt979388e2018-11-30 16:48:55 +0000302
Nikita Ioffea325a572019-05-16 19:49:47 +0100303int64_t GetModuleMetadataVersion() {
304 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
305 if (binder == nullptr) {
306 MYLOGE("Failed to retrieve package_native service");
307 return 0L;
308 }
309 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
310 std::string package_name;
311 auto status = package_service->getModuleMetadataPackageName(&package_name);
312 if (!status.isOk()) {
313 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
314 return 0L;
315 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100316 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100317 int64_t version_code;
318 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
319 &version_code);
320 if (!status.isOk()) {
321 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
322 return 0L;
323 }
324 return version_code;
325}
326
mhasank2d75c442020-06-11 15:05:25 -0700327static bool PathExists(const std::string& path) {
328 struct stat sb;
329 return stat(path.c_str(), &sb) == 0;
330}
331
332static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
333 if (input_file == output_file) {
334 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
335 output_file.c_str());
336 return false;
337 }
338 else if (PathExists(output_file)) {
339 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
340 return false;
341 }
342
343 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
344 android::base::unique_fd out_fd(OpenForWrite(output_file));
345 return CopyFileToFd(input_file, out_fd.get());
346}
347
Nandana Dutt979388e2018-11-30 16:48:55 +0000348} // namespace
349} // namespace os
350} // namespace android
351
Felipe Leme678727a2016-09-21 17:22:11 -0700352static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800353 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800354 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
355 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
356}
357static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
358 int out_fd) {
359 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700360}
361static int DumpFile(const std::string& title, const std::string& path) {
362 return ds.DumpFile(title, path);
363}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800364
Felipe Lemee844a9d2016-09-21 15:01:39 -0700365// Relative directory (inside the zip) for all files copied as-is into the bugreport.
366static const std::string ZIP_ROOT_DIR = "FS";
367
Vishnu Naire97d6122018-01-18 13:58:56 -0800368static const std::string kProtoPath = "proto/";
369static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700370static const std::string kDumpstateBoardFiles[] = {
371 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700372 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700373};
374static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
375
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700376static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700377static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700378
Felipe Lemef0292972016-11-22 13:57:05 -0800379static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
380
Narayan Kamath8f788292017-05-25 13:20:39 +0100381/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100382 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800383 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800384 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100385 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800387 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100388 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100389
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700390 if (dump_dir == nullptr) {
391 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700392 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700393 }
394
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700395 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 struct dirent* entry = nullptr;
397 while ((entry = readdir(dump_dir.get()))) {
398 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100399 continue;
400 }
401
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 const std::string base_name(entry->d_name);
403 if (base_name.find(file_prefix) != 0) {
404 continue;
405 }
406
407 const std::string abs_path = dir_path + base_name;
408 android::base::unique_fd fd(
409 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
410 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700411 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 break;
413 }
414
415 struct stat st = {};
416 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700417 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100418 continue;
419 }
420
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700421 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700422 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800423 if (!dump_data.empty()) {
424 std::sort(dump_data.begin(), dump_data.end(),
425 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
426 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100429}
430
Narayan Kamathbd863722017-06-01 18:50:12 +0100431static bool AddDumps(const std::vector<DumpData>::const_iterator start,
432 const std::vector<DumpData>::const_iterator end,
433 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100435 for (auto it = start; it != end; ++it) {
436 const std::string& name = it->name;
437 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100438 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100439
440 // Seek to the beginning of the file before dumping any data. A given
441 // DumpData entry might be dumped multiple times in the report.
442 //
443 // For example, the most recent ANR entry is dumped to the body of the
444 // main entry and it also shows up as a separate entry in the bugreport
445 // ZIP file.
446 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
447 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
448 strerror(errno));
449 }
450
Chris Morinc2cba7a2022-02-01 17:06:50 -0800451 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800452 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100453 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455 } else {
456 dump_file_from_fd(type_name, name.c_str(), fd);
457 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100458 }
459
460 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700461}
462
Felipe Leme635ca312016-01-05 14:23:02 -0800463// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700464void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char path[PATH_MAX];
466
467 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
468 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700469 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800470 char linkname[PATH_MAX];
471 ssize_t r = readlink(path, linkname, PATH_MAX);
472 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800473 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800474 return;
475 }
476 linkname[r] = '\0';
477
478 if (mount_points.find(linkname) == mount_points.end()) {
479 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700480 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700481 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800482 mount_points.insert(linkname);
483 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800484 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800485 }
486 }
487}
488
489void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700490 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800491 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800492 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700493 for_each_pid(do_mountinfo, nullptr);
494 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800495}
496
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700497static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
498{
499 DIR *d;
500 struct dirent *de;
501 char path[PATH_MAX];
502
503 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700504 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700505 return;
506 }
507
508 while ((de = readdir(d))) {
509 if (de->d_type != DT_LNK) {
510 continue;
511 }
512 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700513 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700514 }
515
516 closedir(d);
517}
518
Mark Salyzyn326842f2015-04-30 09:49:41 -0700519static bool skip_not_stat(const char *path) {
520 static const char stat[] = "/stat";
521 size_t len = strlen(path);
522 if (path[len - 1] == '/') { /* Directory? */
523 return false;
524 }
525 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
526}
527
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700528static bool skip_wtf_strictmode(const char *path) {
529 if (strstr(path, "_wtf")) {
530 return true;
531 } else if (strstr(path, "_strictmode")) {
532 return true;
533 }
534 return false;
535}
536
Felipe Leme4c2d6632016-09-28 14:32:00 -0700537static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800538 return false;
539}
540
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700541unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800543//
544// stat offsets
545// Name units description
546// ---- ----- -----------
547// read I/Os requests number of read I/Os processed
548#define __STAT_READ_IOS 0
549// read merges requests number of read I/Os merged with in-queue I/O
550#define __STAT_READ_MERGES 1
551// read sectors sectors number of sectors read
552#define __STAT_READ_SECTORS 2
553// read ticks milliseconds total wait time for read requests
554#define __STAT_READ_TICKS 3
555// write I/Os requests number of write I/Os processed
556#define __STAT_WRITE_IOS 4
557// write merges requests number of write I/Os merged with in-queue I/O
558#define __STAT_WRITE_MERGES 5
559// write sectors sectors number of sectors written
560#define __STAT_WRITE_SECTORS 6
561// write ticks milliseconds total wait time for write requests
562#define __STAT_WRITE_TICKS 7
563// in_flight requests number of I/Os currently in flight
564#define __STAT_IN_FLIGHT 8
565// io_ticks milliseconds total time this block device has been active
566#define __STAT_IO_TICKS 9
567// time_in_queue milliseconds total wait time for all requests
568#define __STAT_IN_QUEUE 10
569#define __STAT_NUMBER_FIELD 11
570//
571// read I/Os, write I/Os
572// =====================
573//
574// These values increment when an I/O request completes.
575//
576// read merges, write merges
577// =========================
578//
579// These values increment when an I/O request is merged with an
580// already-queued I/O request.
581//
582// read sectors, write sectors
583// ===========================
584//
585// These values count the number of sectors read from or written to this
586// block device. The "sectors" in question are the standard UNIX 512-byte
587// sectors, not any device- or filesystem-specific block size. The
588// counters are incremented when the I/O completes.
589#define SECTOR_SIZE 512
590//
591// read ticks, write ticks
592// =======================
593//
594// These values count the number of milliseconds that I/O requests have
595// waited on this block device. If there are multiple I/O requests waiting,
596// these values will increase at a rate greater than 1000/second; for
597// example, if 60 read requests wait for an average of 30 ms, the read_ticks
598// field will increase by 60*30 = 1800.
599//
600// in_flight
601// =========
602//
603// This value counts the number of I/O requests that have been issued to
604// the device driver but have not yet completed. It does not include I/O
605// requests that are in the queue but not yet issued to the device driver.
606//
607// io_ticks
608// ========
609//
610// This value counts the number of milliseconds during which the device has
611// had I/O requests queued.
612//
613// time_in_queue
614// =============
615//
616// This value counts the number of milliseconds that I/O requests have waited
617// on this block device. If there are multiple I/O requests waiting, this
618// value will increase as the product of the number of milliseconds times the
619// number of requests waiting (see "read ticks" above for an example).
620#define S_TO_MS 1000
621//
622
Mark Salyzyn326842f2015-04-30 09:49:41 -0700623static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800624 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700626 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700628 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 getline(&buffer, &i, fp);
630 fclose(fp);
631 if (!buffer) {
632 return -errno;
633 }
634 i = strlen(buffer);
635 while ((i > 0) && (buffer[i - 1] == '\n')) {
636 buffer[--i] = '\0';
637 }
638 if (!*buffer) {
639 free(buffer);
640 return 0;
641 }
642 z = true;
643 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800644 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700645 if (fields[i] != 0) {
646 z = false;
647 }
648 }
649 if (z) { /* never accessed */
650 free(buffer);
651 return 0;
652 }
653
Wei Wang509bb5d2017-06-09 14:42:12 -0700654 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
655 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700656 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700657
658 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
659 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
660 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700661 free(buffer);
662
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800663 if (fields[__STAT_IO_TICKS]) {
664 unsigned long read_perf = 0;
665 unsigned long read_ios = 0;
666 if (fields[__STAT_READ_TICKS]) {
667 unsigned long long divisor = fields[__STAT_READ_TICKS]
668 * fields[__STAT_IO_TICKS];
669 read_perf = ((unsigned long long)SECTOR_SIZE
670 * fields[__STAT_READ_SECTORS]
671 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
672 / divisor;
673 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
674 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
675 / divisor;
676 }
677
678 unsigned long write_perf = 0;
679 unsigned long write_ios = 0;
680 if (fields[__STAT_WRITE_TICKS]) {
681 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
682 * fields[__STAT_IO_TICKS];
683 write_perf = ((unsigned long long)SECTOR_SIZE
684 * fields[__STAT_WRITE_SECTORS]
685 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
686 / divisor;
687 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
688 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
689 / divisor;
690 }
691
692 unsigned queue = (fields[__STAT_IN_QUEUE]
693 + (fields[__STAT_IO_TICKS] >> 1))
694 / fields[__STAT_IO_TICKS];
695
696 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700697 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 -0800698 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700699 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 -0800700 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800701 }
702
703 /* bugreport timeout factor adjustment */
704 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
705 worst_write_perf = write_perf;
706 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700707 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700708 return 0;
709}
710
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
712
Tom Cherryf4472f32020-08-05 09:31:17 -0700713// Returns the actual readable size of the given buffer or -1 on error.
714static long logcat_buffer_readable_size(const std::string& buffer) {
715 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
716 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
717 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
718
719 return android_logger_get_log_readable_size(logger);
720}
721
722// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800723static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
724 unsigned long timeout_ms = 0;
725 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700726 long readable_size = logcat_buffer_readable_size(buffer);
727 if (readable_size > 0) {
728 // Engineering margin is ten-fold our guess.
729 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
730 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800731 }
732 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700733}
734
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800735// Opens a socket and returns its file descriptor.
736static int open_socket(const char* service);
737
Nandana Duttd2f5f082019-01-18 17:13:52 +0000738Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
739}
740
741android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
742 std::lock_guard<std::mutex> lock(lock_);
743 result_ = APPROVED;
744 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800745
746 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
747 // consent is granted.
748 if (ds.options_->is_screenshot_copied) {
749 return android::binder::Status::ok();
750 }
751
752 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
753 !ds.do_early_screenshot_) {
754 return android::binder::Status::ok();
755 }
756
757 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
758 ds.options_->screenshot_fd.get());
759 ds.options_->is_screenshot_copied = copy_succeeded;
760 if (copy_succeeded) {
761 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
762 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000763 return android::binder::Status::ok();
764}
765
766android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
767 std::lock_guard<std::mutex> lock(lock_);
768 result_ = DENIED;
769 MYLOGW("User denied consent to share bugreport\n");
770 return android::binder::Status::ok();
771}
772
773UserConsentResult Dumpstate::ConsentCallback::getResult() {
774 std::lock_guard<std::mutex> lock(lock_);
775 return result_;
776}
777
778uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800779 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000780}
781
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700782void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200783 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700784 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
787 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
789 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
790 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200791 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700792 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700793
Felipe Lemed8b94e52016-12-08 10:21:44 -0800794 printf("========================================================\n");
795 printf("== dumpstate: %s\n", date);
796 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700797
Felipe Lemed8b94e52016-12-08 10:21:44 -0800798 printf("\n");
799 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700800 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
802 printf("Bootloader: %s\n", bootloader.c_str());
803 printf("Radio: %s\n", radio.c_str());
804 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100805 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
806 if (module_metadata_version != 0) {
807 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
808 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200809 printf("Android SDK version: %s\n", sdkversion.c_str());
810 printf("SDK extensions: ");
811 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
812 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700813
Felipe Lemed8b94e52016-12-08 10:21:44 -0800814 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800815 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000817 printf("Bootconfig: ");
818 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800819 printf("Uptime: ");
820 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
821 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800822 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800823 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
824 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000825 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800826 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800827}
828
Felipe Leme24b66ee2016-06-16 10:55:26 -0700829// List of file extensions that can cause a zip file attachment to be rejected by some email
830// service providers.
831static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
832 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
833 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
834 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
835};
836
Vishnu Naire97d6122018-01-18 13:58:56 -0800837status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
838 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700839 std::string valid_name = entry_name;
840
841 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700842 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700843 if (idx != std::string::npos) {
844 std::string extension = entry_name.substr(idx);
845 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
846 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
847 valid_name = entry_name + ".renamed";
848 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
849 }
850 }
851
Felipe Leme6fe9db62016-02-12 09:04:16 -0800852 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
853 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000854 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
855 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700856 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700857 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700858 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700859 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800860 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800861 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000862 bool finished_entry = false;
863 auto finish_entry = [this, &finished_entry] {
864 if (!finished_entry) {
865 // This should only be called when we're going to return an earlier error,
866 // which would've been logged. This may imply the file is already corrupt
867 // and any further logging from FinishEntry is more likely to mislead than
868 // not.
869 this->zip_writer_->FinishEntry();
870 }
871 };
872 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800873 auto start = std::chrono::steady_clock::now();
874 auto end = start + timeout;
875 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800876
Felipe Leme770410d2016-01-26 17:07:14 -0800877 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800878 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 if (timeout.count() > 0) {
880 // lambda to recalculate the timeout.
881 auto time_left_ms = [end]() {
882 auto now = std::chrono::steady_clock::now();
883 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
884 return std::max(diff.count(), 0LL);
885 };
886
887 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
888 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000889 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
890 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800891 return -errno;
892 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000893 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 entry_name.c_str(), strerror(errno), timeout.count());
895 return TIMED_OUT;
896 }
897 }
898
Zach Riggle22200402016-08-18 01:01:24 -0400899 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800900 if (bytes_read == 0) {
901 break;
902 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800903 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800904 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700906 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700908 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800909 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910 }
911 }
912
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700913 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000914 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700915 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700916 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800917 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800918 }
919
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
Felipe Leme1d486fe2016-10-14 18:06:47 -0700923bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
924 android::base::unique_fd fd(
925 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700926 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800927 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928 return false;
929 }
930
Vishnu Naire97d6122018-01-18 13:58:56 -0800931 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800932}
933
934/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700935static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800936 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800937}
938
Felipe Leme1d486fe2016-10-14 18:06:47 -0700939void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700940 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800941 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700942 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800943}
944
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800946 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000947 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
948 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700950 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700951 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800952 return false;
953 }
954
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700955 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700956 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700957 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700958 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800959 return false;
960 }
961
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700962 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700963 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700964 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800965 return false;
966 }
967
968 return true;
969}
970
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800971static void DoKmsg() {
972 struct stat st;
973 if (!stat(PSTORE_LAST_KMSG, &st)) {
974 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
975 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
976 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
977 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
978 } else {
979 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
980 DumpFile("LAST KMSG", "/proc/last_kmsg");
981 }
982}
983
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800984static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800985 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800986 RunCommand(
987 "KERNEL LOG",
988 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
989 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
990}
991
Nandana Duttdb379fa2019-10-09 16:54:41 +0100992static void DoSystemLogcat(time_t since) {
993 char since_str[80];
994 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
995
996 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
997 RunCommand("SYSTEM LOG",
998 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
999 since_str},
1000 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1001}
1002
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001003static void DoRadioLogcat() {
1004 unsigned long timeout_ms = logcat_timeout({"radio"});
1005 RunCommand(
1006 "RADIO LOG",
1007 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1008 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1009}
1010
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001011static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001012 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001013 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1014 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001015 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001016 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001017 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1018 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001019 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001020 RunCommand(
1021 "EVENT LOG",
1022 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001023 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001024 timeout_ms = logcat_timeout({"stats"});
1025 RunCommand(
1026 "STATS LOG",
1027 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001028 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001029 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001030
1031 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1032
1033 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001034 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1035 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001036}
1037
Mike Ma5c267872019-08-21 11:31:34 -07001038static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001039 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1040 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1041 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1042 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1043 if (fd < 0) {
1044 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1045 return;
1046 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001047 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001048 bool empty = 0 == lseek(fd, 0, SEEK_END);
1049 if (!empty) {
1050 // Use a different name from "incident.proto"
1051 // /proto/incident.proto is reserved for incident service dump
1052 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001053 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1054 path);
1055 } else {
1056 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001057 }
Mike Ma5c267872019-08-21 11:31:34 -07001058}
1059
Aaron Huanga99452a2022-04-27 18:51:16 +08001060static void DumpNetstatsProto() {
1061 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1062 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1063 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1064 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1065 if (fd < 0) {
1066 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1067 return;
1068 }
1069 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1070 CommandOptions::WithTimeout(120).Build());
1071 bool empty = 0 == lseek(fd, 0, SEEK_END);
1072 if (!empty) {
1073 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1074 path);
1075 } else {
1076 unlink(path.c_str());
1077 }
1078}
1079
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001080static void MaybeAddSystemTraceToZip() {
1081 // This function copies into the .zip the system trace that was snapshotted
1082 // by the early call to MaybeSnapshotSystemTrace(), if any background
1083 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001084 if (!ds.has_system_trace_) {
1085 // No background trace was happening at the time dumpstate was invoked.
1086 return;
1087 }
1088 ds.AddZipEntry(
1089 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1090 SYSTEM_TRACE_SNAPSHOT);
1091 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1092}
1093
Sunny Goyal35949782019-11-19 15:54:36 -08001094static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001095 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1096 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1097 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1098 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1099 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1100 if (fd < 0) {
1101 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1102 return;
1103 }
1104 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001105 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001106 bool empty = 0 == lseek(fd, 0, SEEK_END);
1107 if (!empty) {
1108 ds.AddZipEntry("visible_windows.zip", path);
1109 } else {
1110 MYLOGW("Failed to dump visible windows\n");
1111 }
1112 unlink(path.c_str());
1113}
1114
Jayachandran Ca94c7172017-06-10 15:08:12 -07001115static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001116 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1117 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001118 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001119 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001120 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1121 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1122 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1123 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001124}
1125
Woody Lin20767a92022-11-29 15:50:24 +08001126static void DumpShutdownCheckpoints() {
1127 const bool shutdown_checkpoints_dumped = AddDumps(
1128 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1129 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1130 if (!shutdown_checkpoints_dumped) {
1131 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1132 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1133 }
1134}
1135
David Andersond9ba4752018-12-11 18:26:59 -08001136static void DumpDynamicPartitionInfo() {
1137 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1138 return;
1139 }
1140
1141 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001142 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001143}
1144
Chris Morin5a50d482022-02-01 17:41:18 -08001145static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001146 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1147 anr_traces_dir.c_str());
1148
1149 // If we're here, dump_traces_path will always be a temporary file
1150 // (created with mkostemp or similar) that contains dumps taken earlier
1151 // on in the process.
1152 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001153 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1154 dump_traces_path);
1155 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001156
1157 const int ret = unlink(dump_traces_path);
1158 if (ret == -1) {
1159 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1160 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001161 }
1162 }
1163
Narayan Kamathbd863722017-06-01 18:50:12 +01001164 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001165 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001166 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001167 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001168 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001169
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001170 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001171 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001172 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001173 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001174 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1175 }
1176}
1177
1178static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001179 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001180
Chris Morin5a50d482022-02-01 17:41:18 -08001181 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001182
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001183 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1184
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001185 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001186 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001187 int i = 0;
1188 while (true) {
1189 const std::string slow_trace_path =
1190 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1191 if (stat(slow_trace_path.c_str(), &st)) {
1192 // No traces file at this index, done with the files.
1193 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001194 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001195 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1196 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001197 }
1198}
1199
Wei Wang509bb5d2017-06-09 14:42:12 -07001200static void DumpBlockStatFiles() {
1201 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001202
Wei Wang1dc1ef52017-06-12 11:28:37 -07001203 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1204
1205 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001206 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1207 return;
1208 }
1209
1210 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001211 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001212 if ((d->d_name[0] == '.')
1213 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1214 || (d->d_name[1] == '\0'))) {
1215 continue;
1216 }
1217 const std::string new_path =
1218 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1219 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1220 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1221 printf("\n");
1222 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001223 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001224}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001225
1226static void DumpPacketStats() {
1227 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001228}
1229
1230static void DumpIpAddrAndRules() {
1231 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1232 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1233 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1234 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1235 RunCommand("IP RULES", {"ip", "rule", "show"});
1236 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1237}
1238
Nandana Dutt5c390032019-03-12 10:52:56 +00001239static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1240 std::chrono::milliseconds timeout,
1241 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001242 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001243 sp<android::IServiceManager> sm = defaultServiceManager();
1244 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 Vector<String16> args;
1246 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001247 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1248 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001249 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001250 std::string path(title);
1251 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001252 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001253 if (PropertiesHelper::IsDryRun()) {
1254 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1255 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1256 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001257 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1258 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001259 service, args);
1260 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001261 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1262 std::chrono::duration<double> elapsed_seconds;
1263 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1264 service == String16("meminfo")) {
1265 // Use a longer timeout for meminfo, since 30s is not always enough.
1266 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1267 /* as_proto = */ false, elapsed_seconds,
1268 bytes_written);
1269 } else {
1270 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1271 /* as_proto = */ false, elapsed_seconds,
1272 bytes_written);
1273 }
1274 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1275 bool dump_complete = (status == OK);
1276 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001277 } else {
1278 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1279 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001280 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001281 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001282
1283 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1284 std::chrono::steady_clock::now() - start);
1285 if (elapsed_duration > timeout) {
1286 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1287 elapsed_duration.count());
1288 break;
1289 }
1290 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001291 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001292}
1293
Vishnu Nair64afc022018-02-01 15:29:34 -08001294static void RunDumpsysText(const std::string& title, int priority,
1295 std::chrono::milliseconds timeout,
1296 std::chrono::milliseconds service_timeout) {
1297 DurationReporter duration_reporter(title);
1298 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1299 fsync(STDOUT_FILENO);
1300 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1301}
1302
1303/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001304static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1305 std::chrono::milliseconds timeout,
1306 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001307 DurationReporter duration_reporter(title);
1308 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1309 fsync(STDOUT_FILENO);
1310 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1311 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001312
1313 RETURN_IF_USER_DENIED_CONSENT();
1314
1315 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1316 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001317}
1318
Nandana Dutt5c390032019-03-12 10:52:56 +00001319static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1320 std::chrono::milliseconds timeout,
1321 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001322 sp<android::IServiceManager> sm = defaultServiceManager();
1323 Dumpsys dumpsys(sm.get());
1324 Vector<String16> args;
1325 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1326 DurationReporter duration_reporter(title);
1327
1328 auto start = std::chrono::steady_clock::now();
1329 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1330 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001331 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001332 std::string path(kProtoPath);
1333 path.append(String8(service).c_str());
1334 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1335 path.append("_CRITICAL");
1336 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1337 path.append("_HIGH");
1338 }
1339 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001340 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001341 if (status == OK) {
1342 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1343 bool dumpTerminated = (status == OK);
1344 dumpsys.stopDumpThread(dumpTerminated);
1345 }
1346 ZipWriter::FileEntry file_entry;
1347 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001348
1349 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1350 std::chrono::steady_clock::now() - start);
1351 if (elapsed_duration > timeout) {
1352 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1353 elapsed_duration.count());
1354 break;
1355 }
1356 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001357 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001358}
1359
Nandana Dutta7db6342018-11-21 14:53:34 +00001360// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001361static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001362 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1363 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001364
1365 RETURN_IF_USER_DENIED_CONSENT();
1366
1367 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1368 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001369}
1370
1371// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001372static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001373 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1374 // high priority. Reduce timeout once they are able to dump in a shorter time or
1375 // moved to a parallel task.
1376 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1377 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001378
1379 RETURN_IF_USER_DENIED_CONSENT();
1380
1381 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1382 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001383}
1384
1385// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001386static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001387 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001388
1389 RETURN_IF_USER_DENIED_CONSENT();
1390
1391 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1392 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001393}
1394
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001395/*
1396 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1397 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1398 * if it's not running in the parallel task.
1399 */
1400static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001401 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001402 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1403 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001404
Steven Moreland44cd9482018-01-04 16:24:13 -08001405 using android::hidl::manager::V1_0::IServiceManager;
1406 using android::hardware::defaultServiceManager;
1407
1408 sp<IServiceManager> sm = defaultServiceManager();
1409 if (sm == nullptr) {
1410 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1411 return;
1412 }
1413
1414 auto ret = sm->list([&](const auto& interfaces) {
1415 for (const std::string& interface : interfaces) {
1416 std::string cleanName = interface;
1417 std::replace_if(cleanName.begin(),
1418 cleanName.end(),
1419 [](char c) {
1420 return !isalnum(c) &&
1421 std::string("@-_:.").find(c) == std::string::npos;
1422 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001423 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001424
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001425 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001426 {
1427 auto fd = android::base::unique_fd(
1428 TEMP_FAILURE_RETRY(open(path.c_str(),
1429 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1430 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1431 if (fd < 0) {
1432 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1433 continue;
1434 }
1435 RunCommandToFd(fd,
1436 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001437 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001438 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1439
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001440 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001441 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001442 if (!empty) {
1443 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1444 path);
1445 } else {
1446 unlink(path.c_str());
1447 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001448 }
1449 });
1450
1451 if (!ret.isOk()) {
1452 MYLOGE("Could not list hals from hwservicemanager.\n");
1453 }
1454}
1455
Devin Moore8df81bb2022-06-08 22:47:02 +00001456// Dump all of the files that make up the vendor interface.
1457// See the files listed in dumpFileList() for the latest list of files.
1458static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001459
1460 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1461 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001462 for (const auto vintfFile : vintfFiles) {
1463 struct stat st;
1464 if (stat(vintfFile.c_str(), &st) == 0) {
1465 if (S_ISDIR(st.st_mode)) {
1466 ds.AddDir(vintfFile, true /* recursive */);
1467 } else {
1468 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1469 vintfFile);
1470 }
1471 }
1472 }
1473}
1474
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001475static void DumpExternalFragmentationInfo() {
1476 struct stat st;
1477 if (stat("/proc/buddyinfo", &st) != 0) {
1478 MYLOGE("Unable to dump external fragmentation info\n");
1479 return;
1480 }
1481
1482 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1483 std::ifstream ifs("/proc/buddyinfo");
1484 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1485 for (std::string line; std::getline(ifs, line);) {
1486 std::smatch match_results;
1487 if (std::regex_match(line, match_results, unusable_index_regex)) {
1488 std::stringstream free_pages(std::string{match_results[3]});
1489 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1490 std::istream_iterator<int>());
1491
1492 int total_free_pages = 0;
1493 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1494 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1495 }
1496
1497 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1498 match_results[2].str().c_str());
1499
1500 int usable_free_pages = total_free_pages;
1501 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1502 auto unusable_index = (total_free_pages - usable_free_pages) /
1503 static_cast<double>(total_free_pages);
1504 printf(" %5.3f", unusable_index);
1505 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1506 }
1507
1508 printf("\n");
1509 }
1510 }
1511 printf("\n");
1512}
1513
mhasankd451a472020-05-26 18:02:39 -07001514static void DumpstateLimitedOnly() {
1515 // Trimmed-down version of dumpstate to only include a whitelisted
1516 // set of logs (system log, event log, and system server / system app
1517 // crashes, and networking logs). See b/136273873 and b/138459828
1518 // for context.
1519 DurationReporter duration_reporter("DUMPSTATE");
1520 unsigned long timeout_ms;
1521 // calculate timeout
1522 timeout_ms = logcat_timeout({"main", "system", "crash"});
1523 RunCommand("SYSTEM LOG",
1524 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1525 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1526 timeout_ms = logcat_timeout({"events"});
1527 RunCommand(
1528 "EVENT LOG",
1529 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1530 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1531
1532 printf("========================================================\n");
1533 printf("== Networking Service\n");
1534 printf("========================================================\n");
1535
1536 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1537 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001538 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1539 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001540
1541 printf("========================================================\n");
1542 printf("== Dropbox crashes\n");
1543 printf("========================================================\n");
1544
1545 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1546 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1547
1548 printf("========================================================\n");
1549 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1550 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1551 printf("========================================================\n");
1552 printf("== dumpstate: done (id %d)\n", ds.id_);
1553 printf("========================================================\n");
1554}
1555
Rhed Jaoe017f982020-07-21 17:58:41 +08001556/*
1557 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1558 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1559 * if it's not running in the parallel task.
1560 */
1561static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1562 dprintf(out_fd, "========================================================\n");
1563 dprintf(out_fd, "== Checkins\n");
1564 dprintf(out_fd, "========================================================\n");
1565
1566 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001567 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1568 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1569 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1570 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1571}
1572
1573/*
1574 * Runs dumpsys on activity service to dump all application activities, services
1575 * and providers in the device.
1576 *
1577 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1578 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1579 * if it's not running in the parallel task.
1580 */
1581static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1582 dprintf(out_fd, "========================================================\n");
1583 dprintf(out_fd, "== Running Application Activities\n");
1584 dprintf(out_fd, "========================================================\n");
1585
1586 // The following dumpsys internally collects output from running apps, so it can take a long
1587 // time. So let's extend the timeout.
1588
1589 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1590
1591 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1592
1593 dprintf(out_fd, "========================================================\n");
1594 dprintf(out_fd, "== Running Application Services (platform)\n");
1595 dprintf(out_fd, "========================================================\n");
1596
1597 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1598 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1599
1600 dprintf(out_fd, "========================================================\n");
1601 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1602 dprintf(out_fd, "========================================================\n");
1603
1604 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1605 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1606
1607 dprintf(out_fd, "========================================================\n");
1608 dprintf(out_fd, "== Running Application Providers (platform)\n");
1609 dprintf(out_fd, "========================================================\n");
1610
1611 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001612 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001613
1614 dprintf(out_fd, "========================================================\n");
1615 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1616 dprintf(out_fd, "========================================================\n");
1617
1618 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1619 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1620}
1621
Nandana Dutt5c390032019-03-12 10:52:56 +00001622// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1623// via the consent they are shown. Ignores other errors that occur while running various
1624// commands. The consent checking is currently done around long running tasks, which happen to
1625// be distributed fairly evenly throughout the function.
1626static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001627 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001628
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001629 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001630 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1631 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001632 if (ds.dump_pool_) {
1633 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1634 // drop root user. Restarts it with two threads for the parallel run.
1635 ds.dump_pool_->start(/* thread_counts = */2);
1636
Chris Morinbc223142022-02-04 14:17:11 -08001637 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1638 dump_incident_report = ds.dump_pool_->enqueueTask(
1639 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001640 dump_netstats_report = ds.dump_pool_->enqueueTask(
1641 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001642 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1643 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1644 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001645 }
1646
Nandana Dutt5c390032019-03-12 10:52:56 +00001647 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1648 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1649 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001650 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001651 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001652 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001653 DumpFile("MEMORY INFO", "/proc/meminfo");
1654 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001655 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001656
Kevin Jeon947922b2022-09-21 00:29:18 +00001657 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1658 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001659
Sunny Goyal35949782019-11-19 15:54:36 -08001660 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1661
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001662 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1663 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1664 DumpFile("SLAB INFO", "/proc/slabinfo");
1665 DumpFile("ZONEINFO", "/proc/zoneinfo");
1666 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1667 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001668 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001669
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001670 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001671
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001672 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001673 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001674
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001675 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001676 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001677 } else {
1678 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1679 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001680
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001681 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001682 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001683 struct stat s;
1684 if (stat("/proc/modules", &s) != 0) {
1685 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1686 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001687 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001688 RunCommand("MODULES INFO",
1689 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1690 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1691 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001692 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001693
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001694 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001695 DoKernelLogcat();
1696 } else {
1697 do_dmesg();
1698 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001699
Devin Moore8df81bb2022-06-08 22:47:02 +00001700 DumpVintf();
1701
Felipe Lemef0292972016-11-22 13:57:05 -08001702 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001703
Jeff Brown1dc94e32014-09-11 14:15:27 -07001704 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001705 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001706
Jack Yu5a6b2e22020-08-14 18:13:35 +08001707 /* Dump Nfc NCI logs */
1708 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001709
Paul Chang0d2aad72020-02-13 20:04:03 +08001710 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001711 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001712 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001713 }
1714
Felipe Lemee184f662016-10-27 10:04:47 -07001715 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001716
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001717 MaybeAddSystemTraceToZip();
1718
Narayan Kamath8f788292017-05-25 13:20:39 +01001719 // NOTE: tombstones are always added as separate entries in the zip archive
1720 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001721 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001722 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001723 if (!tombstones_dumped) {
1724 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001725 }
1726
Jayachandran Ca94c7172017-06-10 15:08:12 -07001727 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001728
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001729 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001730
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001731 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001732
Woody Lin20767a92022-11-29 15:50:24 +08001733 DumpShutdownCheckpoints();
1734
Jayachandran Ca94c7172017-06-10 15:08:12 -07001735 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001736
1737 dump_route_tables();
1738
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001739 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1740 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1741 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001742
Nandana Dutt5c390032019-03-12 10:52:56 +00001743 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001744
Chiachang Wang668ede42021-05-17 17:14:20 +08001745 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1746 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1747 // dump with priority parameters to dump high priority information.
1748 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1749 CommandOptions::WithTimeout(10).Build());
1750
Elliott Hughes23ccc622017-02-28 10:14:22 -08001751 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001752
Jin Qianf334d662017-10-10 14:41:37 -07001753 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001754
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001755 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001756
Colin Crossf45fa6b2012-03-26 12:38:26 -07001757 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001758 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1759 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1760
1761 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1762 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1763 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1764 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1765 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001766
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001767 /* Add window and surface trace files. */
1768 if (!PropertiesHelper::IsUserBuild()) {
1769 ds.AddDir(WMTRACE_DATA_DIR, false);
1770 }
1771
Yifan Hongd90cc652020-02-08 16:52:02 -08001772 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1773
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001774 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001775 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001776 } else {
1777 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1778 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001779
Steven Moreland7440ddb2016-12-15 16:13:39 -08001780 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001781 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1782 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001783 // su does not exist on user builds, so try running without it.
1784 // This way any implementations of vril-dump that do not require
1785 // root can run on user builds.
1786 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001787 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001788 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001789 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001790 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001791 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001792 }
1793
Felipe Lemed8b94e52016-12-08 10:21:44 -08001794 printf("========================================================\n");
1795 printf("== Android Framework Services\n");
1796 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001797
Nandana Dutt5c390032019-03-12 10:52:56 +00001798 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001799
Jack He91ff2fe2021-02-18 18:23:43 -08001800 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1801 ds.AddDir("/data/misc/bluetooth/logs", true);
1802
Rhed Jaoe017f982020-07-21 17:58:41 +08001803 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001804 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001805 } else {
1806 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1807 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001808
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001809 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001810
Adrian Roos8b397ab2017-04-04 16:35:44 -07001811 printf("========================================================\n");
1812 printf("== Dropbox crashes\n");
1813 printf("========================================================\n");
1814
1815 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1816 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1817
Felipe Lemed8b94e52016-12-08 10:21:44 -08001818 printf("========================================================\n");
1819 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1820 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1821 printf("========================================================\n");
1822 printf("== dumpstate: done (id %d)\n", ds.id_);
1823 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001824
1825 printf("========================================================\n");
1826 printf("== Obtaining statsd metadata\n");
1827 printf("========================================================\n");
1828 // This differs from the usual dumpsys stats, which is the stats report data.
1829 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001830
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001831 // Add linker configuration directory
1832 ds.AddDir(LINKERCONFIG_DIR, true);
1833
Li Li830179f2022-01-04 12:53:29 -08001834 /* Dump frozen cgroupfs */
1835 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001836
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001837 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001838 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1839 } else {
1840 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1841 DumpNetstatsProto);
1842 }
1843
1844 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001845 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001846 } else {
1847 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1848 DumpIncidentReport);
1849 }
Mike Ma5c267872019-08-21 11:31:34 -07001850
Nandana Dutt5c390032019-03-12 10:52:56 +00001851 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001852}
1853
Nandana Dutt5c390032019-03-12 10:52:56 +00001854/*
1855 * Dumps state for the default case; drops root after it's no longer necessary.
1856 *
1857 * Returns RunStatus::OK if everything went fine.
1858 * Returns RunStatus::ERROR if there was an error.
1859 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1860 * with the caller.
1861 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001862Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001863 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1864 // buffer.
1865 DoLogcat();
1866 // Capture timestamp after first logcat to use in next logcat
1867 time_t logcat_ts = time(nullptr);
1868
Nandana Dutt4be45d12018-09-26 15:04:23 +01001869 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001870 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001871 if (dump_pool_) {
1872 RETURN_IF_USER_DENIED_CONSENT();
1873 // One thread is enough since we only need to enqueue DumpTraces here.
1874 dump_pool_->start(/* thread_counts = */1);
1875
1876 // DumpTraces takes long time, post it to the another thread in the
1877 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001878 dump_traces = dump_pool_->enqueueTask(
1879 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001880 } else {
1881 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1882 &dump_traces_path);
1883 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001884
1885 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001886 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001887 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1888 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001889 ds.shutdown_checkpoints_ = GetDumpFds(
1890 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001891 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001892
1893 ds.AddDir(RECOVERY_DIR, true);
1894 ds.AddDir(RECOVERY_DATA_DIR, true);
1895 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001896 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001897 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1898 if (!PropertiesHelper::IsUserBuild()) {
1899 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1900 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001901 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001902 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001903 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001904 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001905 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1906 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1907 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001908 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001909 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001910 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001911 if (!PropertiesHelper::IsUserBuild()) {
1912 // Include dropbox entry files inside ZIP, but exclude
1913 // noisy WTF and StrictMode entries
1914 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1915 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001916
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001917 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001918 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1919
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001920 // Dump IPsec stats. No keys are exposed here.
1921 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1922
Nandana Dutt4be45d12018-09-26 15:04:23 +01001923 // Run ss as root so we can see socket marks.
1924 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1925
1926 // Run iotop as root to show top 100 IO threads
1927 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1928
Erick Reyese68df822019-02-11 14:46:36 -08001929 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001930 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1931 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001932
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001933 DumpFile("PSI cpu", "/proc/pressure/cpu");
1934 DumpFile("PSI memory", "/proc/pressure/memory");
1935 DumpFile("PSI io", "/proc/pressure/io");
1936
Mårten Kongstad60195a72022-09-20 14:14:20 +02001937 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1938 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1939
Rhed Jao5377d792020-07-16 17:37:39 +08001940 if (dump_pool_) {
1941 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001942 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001943
Chris Morinbc223142022-02-04 14:17:11 -08001944 // Current running thread in the pool is the root user also. Delete
1945 // the pool and make a new one later to ensure none of threads in the pool are root.
1946 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001947 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001948 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001949 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001950 }
1951
Nandana Dutt5c390032019-03-12 10:52:56 +00001952 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001953 Dumpstate::RunStatus status = dumpstate();
1954 // Capture logcat since the last time we did it.
1955 DoSystemLogcat(logcat_ts);
1956 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001957}
1958
Rhed Jaob5685b32020-08-14 17:19:17 +08001959// Common states for telephony and wifi which are needed to be collected before
1960// dumpstate drop the root user.
1961static void DumpstateRadioAsRoot() {
1962 DumpIpTablesAsRoot();
1963 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1964}
1965
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001966// This method collects common dumpsys for telephony and wifi. Typically, wifi
1967// reports are fine to include all information, but telephony reports on user
1968// builds need to strip some content (see DumpstateTelephonyOnly).
1969static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001970 // We need to be picky about some stuff for telephony reports on user builds.
1971 if (!include_sensitive_info) {
1972 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1973 DoRadioLogcat();
1974 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001975 // DumpHals takes long time, post it to the another thread in the pool,
1976 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001977 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001978 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001979 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001980 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001981 // Contains various system properties and process startup info.
1982 do_dmesg();
1983 // Logs other than the radio buffer may contain package/component names and potential PII.
1984 DoLogcat();
1985 // Too broad for connectivity problems.
1986 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001987 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1988 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001989 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001990 } else {
1991 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1992 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001993 }
1994
Jayachandran Ca94c7172017-06-10 15:08:12 -07001995 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001996 DumpIpAddrAndRules();
1997 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001998 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1999 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002000}
2001
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002002// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2003// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2004// for what can be included on user builds: all reported information MUST directly relate to
2005// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2006// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2007// names are not), and MUST NOT contain logs of user application traffic.
2008// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002009static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002010 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002011
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002012 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002013
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002014 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002015
Rhed Jaob5685b32020-08-14 17:19:17 +08002016 DumpstateRadioAsRoot();
2017 if (!DropRootUser()) {
2018 return;
2019 }
2020
2021 // Starts thread pool after the root user is dropped, and two additional threads
2022 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002023 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002024 if (ds.dump_pool_) {
2025 ds.dump_pool_->start(/*thread_counts =*/2);
2026
2027 // DumpstateBoard takes long time, post it to the another thread in the pool,
2028 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002029 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2030 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002031 }
2032
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002033 DumpstateRadioCommon(include_sensitive_info);
2034
2035 if (include_sensitive_info) {
2036 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2037 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2038 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2039 // way.
2040 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2041 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002042
2043 printf("========================================================\n");
2044 printf("== Android Framework Services\n");
2045 printf("========================================================\n");
2046
Vishnu Nair652cc802017-11-30 15:18:30 -08002047 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2048 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002049 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2050 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002051 if (include_sensitive_info) {
2052 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2053 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2054 SEC_TO_MSEC(10));
2055 } else {
2056 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2057 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2058 // give a higher timeout as well.
2059 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2060 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2061 }
2062 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002063 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2064 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002065 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002066 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2067 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002068 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2069 SEC_TO_MSEC(10));
Grant Menke9bf3b2b2023-02-24 13:11:07 -08002070 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2071 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002072 if (include_sensitive_info) {
2073 // Contains raw IP addresses, omit from reports on user builds.
2074 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2075 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2076 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2077 SEC_TO_MSEC(10));
2078 // Contains package/component names, omit from reports on user builds.
2079 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2080 SEC_TO_MSEC(10));
2081 // Contains package names, but should be relatively simple to remove them (also contains
2082 // UIDs already), omit from reports on user builds.
2083 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2084 SEC_TO_MSEC(10));
2085 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002086
2087 printf("========================================================\n");
2088 printf("== Running Application Services\n");
2089 printf("========================================================\n");
2090
2091 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2092
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002093 if (include_sensitive_info) {
2094 printf("========================================================\n");
2095 printf("== Running Application Services (non-platform)\n");
2096 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002097
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002098 // Contains package/component names and potential PII, omit from reports on user builds.
2099 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2100 // carrier_config dumpsys instead.
2101 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2102 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002103
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002104 printf("========================================================\n");
2105 printf("== Checkins\n");
2106 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002107
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002108 // Contains package/component names, omit from reports on user builds.
2109 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2110 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002111
2112 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002113 printf("== dumpstate: done (id %d)\n", ds.id_);
2114 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002115
2116 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002117 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002118 } else {
2119 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2120 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002121}
2122
mukesh agrawal253dad42018-01-23 21:59:59 -08002123// This method collects dumpsys for wifi debugging only
2124static void DumpstateWifiOnly() {
2125 DurationReporter duration_reporter("DUMPSTATE");
2126
Rhed Jaob5685b32020-08-14 17:19:17 +08002127 DumpstateRadioAsRoot();
2128 if (!DropRootUser()) {
2129 return;
2130 }
2131
2132 // Starts thread pool after the root user is dropped. Only one additional
2133 // thread is needed for DumpHals in the DumpstateRadioCommon.
2134 if (ds.dump_pool_) {
2135 ds.dump_pool_->start(/*thread_counts =*/1);
2136 }
2137
mukesh agrawal253dad42018-01-23 21:59:59 -08002138 DumpstateRadioCommon();
2139
2140 printf("========================================================\n");
2141 printf("== Android Framework Services\n");
2142 printf("========================================================\n");
2143
2144 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2145 SEC_TO_MSEC(10));
2146 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2147 SEC_TO_MSEC(10));
2148
2149 printf("========================================================\n");
2150 printf("== dumpstate: done (id %d)\n", ds.id_);
2151 printf("========================================================\n");
2152}
2153
Nandana Duttcf419a72019-03-14 10:40:17 +00002154Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002155 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002156 const size_t buf_size = temp_file_pattern.length() + 1;
2157 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2158 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2159
2160 // Create a new, empty file to receive all trace dumps.
2161 //
2162 // TODO: This can be simplified once we remove support for the old style
2163 // dumps. We can have a file descriptor passed in to dump_traces instead
2164 // of creating a file, closing it and then reopening it again.
2165 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2166 if (fd < 0) {
2167 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002168 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002169 }
2170
2171 // Nobody should have access to this temporary file except dumpstate, but we
2172 // temporarily grant 'read' to 'others' here because this file is created
2173 // when tombstoned is still running as root, but dumped after dropping. This
2174 // can go away once support for old style dumping has.
2175 const int chmod_ret = fchmod(fd, 0666);
2176 if (chmod_ret < 0) {
2177 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002178 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002179 }
2180
2181 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2182 if (proc.get() == nullptr) {
2183 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002184 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002185 }
2186
2187 // Number of times process dumping has timed out. If we encounter too many
2188 // failures, we'll give up.
2189 int timeout_failures = 0;
2190 bool dalvik_found = false;
2191
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002192 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002193
2194 struct dirent* d;
2195 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002196 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002197 int pid = atoi(d->d_name);
2198 if (pid <= 0) {
2199 continue;
2200 }
2201
2202 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2203 std::string exe;
2204 if (!android::base::Readlink(link_name, &exe)) {
2205 continue;
2206 }
2207
2208 bool is_java_process;
2209 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2210 // Don't bother dumping backtraces for the zygote.
2211 if (IsZygote(pid)) {
2212 continue;
2213 }
2214
2215 dalvik_found = true;
2216 is_java_process = true;
2217 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2218 is_java_process = false;
2219 } else {
2220 // Probably a native process we don't care about, continue.
2221 continue;
2222 }
2223
2224 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2225 if (timeout_failures == 3) {
2226 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2227 break;
2228 }
2229
2230 const uint64_t start = Nanotime();
2231 const int ret = dump_backtrace_to_file_timeout(
2232 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2233 is_java_process ? 5 : 20, fd);
2234
2235 if (ret == -1) {
2236 // For consistency, the header and footer to this message match those
2237 // dumped by debuggerd in the success case.
2238 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2239 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2240 dprintf(fd, "---- end %d ----", pid);
2241 timeout_failures++;
2242 continue;
2243 }
2244
2245 // We've successfully dumped stack traces, reset the failure count
2246 // and write a summary of the elapsed time to the file and continue with the
2247 // next process.
2248 timeout_failures = 0;
2249
2250 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2251 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2252 }
2253
2254 if (!dalvik_found) {
2255 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2256 }
2257
Nandana Duttcf419a72019-03-14 10:40:17 +00002258 *path = file_name_buf.release();
2259 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002260}
2261
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002262static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2263 const Dumpstate::BugreportMode bugreport_mode) {
2264 switch (bugreport_mode) {
2265 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2266 return dumpstate_hal_hidl::DumpstateMode::FULL;
2267 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2268 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2269 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2270 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2271 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2272 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2273 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2274 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2275 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2276 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2277 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2278 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2279 }
2280 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2281}
2282
2283static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2284 const Dumpstate::BugreportMode bugreport_mode) {
2285 switch (bugreport_mode) {
2286 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2287 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2288 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2289 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2290 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2291 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2292 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2293 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2294 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2295 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2296 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2297 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2298 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2299 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2300 }
2301 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2302}
2303
2304static void DoDumpstateBoardHidl(
2305 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2306 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2307 const Dumpstate::BugreportMode bugreport_mode,
2308 const size_t timeout_sec) {
2309
2310 using ScopedNativeHandle =
2311 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2312 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2313 [](native_handle_t* handle) {
2314 // we don't close file handle's here
2315 // via native_handle_close(handle)
2316 // instead we let dumpstate_fds close the file handles when
2317 // dumpstate_fds gets destroyed
2318 native_handle_delete(handle);
2319 });
2320 if (handle == nullptr) {
2321 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2322 return;
2323 }
2324
2325 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2326 handle.get()->data[i] = dumpstate_fds[i].get();
2327 }
2328
2329 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2330 // implement just 1.0.
2331 const char* descriptor_to_kill;
2332 using DumpstateBoardTask = std::packaged_task<bool()>;
2333 DumpstateBoardTask dumpstate_board_task;
2334 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2335 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2336 if (dumpstate_hal != nullptr) {
2337 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2338
2339 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2340 GetDumpstateHalModeHidl(bugreport_mode);
2341
2342 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2343 dumpstate_board_task =
2344 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2345 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2346 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2347 SEC_TO_MSEC(timeout_sec));
2348 if (!status.isOk()) {
2349 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2350 return false;
2351 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2352 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2353 dumpstate_hal_hidl::toString(status).c_str());
2354 return false;
2355 }
2356 return true;
2357 });
2358 } else {
2359 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2360
2361 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2362 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2363 ::android::hardware::Return<void> status =
2364 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2365 if (!status.isOk()) {
2366 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2367 return false;
2368 }
2369 return true;
2370 });
2371 }
2372 auto result = dumpstate_board_task.get_future();
2373 std::thread(std::move(dumpstate_board_task)).detach();
2374
2375 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2376 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2377 if (!android::base::SetProperty(
2378 "ctl.interface_restart",
2379 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2380 MYLOGE("Couldn't restart dumpstate HAL\n");
2381 }
2382 }
2383 // Wait some time for init to kill dumpstate vendor HAL
2384 constexpr size_t killing_timeout_sec = 10;
2385 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2386 MYLOGE(
2387 "killing dumpstateBoard timed out after %zus, continue and "
2388 "there might be racing in content\n",
2389 killing_timeout_sec);
2390 }
2391}
2392
2393static void DoDumpstateBoardAidl(
2394 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2395 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2396 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2397 MYLOGI("Using IDumpstateDevice AIDL HAL");
2398
2399 const char* descriptor_to_kill;
2400 using DumpstateBoardTask = std::packaged_task<bool()>;
2401 DumpstateBoardTask dumpstate_board_task;
2402 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2403 GetDumpstateHalModeAidl(bugreport_mode);
2404
2405 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2406 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2407 timeout_sec]() -> bool {
2408 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2409
2410 if (!status.isOk()) {
2411 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2412 return false;
2413 }
2414 return true;
2415 });
2416 auto result = dumpstate_board_task.get_future();
2417 std::thread(std::move(dumpstate_board_task)).detach();
2418
2419 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2420 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2421 if (!android::base::SetProperty(
2422 "ctl.interface_restart",
2423 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2424 MYLOGE("Couldn't restart dumpstate HAL\n");
2425 }
2426 }
2427 // Wait some time for init to kill dumpstate vendor HAL
2428 constexpr size_t killing_timeout_sec = 10;
2429 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2430 MYLOGE(
2431 "killing dumpstateBoard timed out after %zus, continue and "
2432 "there might be racing in content\n",
2433 killing_timeout_sec);
2434 }
2435}
2436
2437static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2438 const std::string aidl_instance_name =
2439 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2440
2441 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2442 return nullptr;
2443 }
2444
2445 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2446
2447 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2448}
2449
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002450void Dumpstate::DumpstateBoard(int out_fd) {
2451 dprintf(out_fd, "========================================================\n");
2452 dprintf(out_fd, "== Board\n");
2453 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002454
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002455 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002456 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002457 * set to true and unmount it after invoking dumpstateBoard_* methods.
2458 * This is to enable debug builds to not have debugfs mounted during runtime.
2459 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002460 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002461 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002462 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002463 if (mount_debugfs) {
2464 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2465 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002466 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002467 }
2468
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002469 std::vector<std::string> paths;
2470 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002471 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002472 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2473 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002474 remover.emplace_back(android::base::make_scope_guard(
2475 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002476 }
Jie Song9fbfad02017-06-20 16:29:42 -07002477
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002478 // get dumpstate HAL AIDL implementation
2479 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2480 GetDumpstateBoardAidlService());
2481 if (dumpstate_hal_handle_aidl == nullptr) {
2482 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2483 }
2484
2485 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2486 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2487 if (dumpstate_hal_handle_aidl == nullptr) {
2488 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2489 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2490 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2491 }
2492 }
2493
2494 // if neither HIDL nor AIDL implementation found, then return
2495 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2496 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002497 return;
2498 }
2499
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002500 // this is used to hold the file descriptors and when this variable goes out of scope
2501 // the file descriptors are closed
2502 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002503
Nandana Dutt5c390032019-03-12 10:52:56 +00002504 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002505 for (size_t i = 0; i < paths.size(); i++) {
2506 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2507
2508 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2509 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2510 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2511 if (fd < 0) {
2512 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2513 return;
2514 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002515
2516 dumpstate_fds.emplace_back(fd.release());
2517 // we call fd.release() here to make sure "fd" does not get closed
2518 // after "fd" goes out of scope after this block.
2519 // "fd" will be closed when "dumpstate_fds" goes out of scope
2520 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002521 }
2522
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002523 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2524 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2525 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002526 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002527
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002528 if (dumpstate_hal_handle_aidl != nullptr) {
2529 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2530 timeout_sec);
2531 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2532 // run HIDL HAL only if AIDL HAL not found
2533 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2534 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002535 }
2536
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002537 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002538 auto keep_debugfs_mounted =
2539 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2540 if (keep_debugfs_mounted.empty())
2541 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002542 }
2543
Wei Wang587eac92018-04-05 12:17:20 -07002544 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2545 for (size_t i = 0; i < paths.size(); i++) {
2546 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002547 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2548 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002549 file_sizes[i] = -1;
2550 continue;
2551 }
2552 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002553 }
2554
2555 for (size_t i = 0; i < paths.size(); i++) {
2556 if (file_sizes[i] == -1) {
2557 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002558 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002559 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002560 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002561 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002562 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002563 remover[i].Disable();
2564 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2565 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002566 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002567}
2568
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002569static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002570 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002571 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2572 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002573 " -h: display this help message\n"
2574 " -b: play sound file instead of vibrate, at beginning of job\n"
2575 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002576 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002577 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002578 " -s: write zipped file to control socket (for init)\n"
2579 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002580 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002581 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002582 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002583 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002584 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002585 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002586}
2587
Wei Liuf87959e2016-08-26 14:51:42 -07002588static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002589 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002590}
2591
Felipe Leme1d486fe2016-10-14 18:06:47 -07002592bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002593 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2594 if (zip_entry_tasks_) {
2595 zip_entry_tasks_->run(/* do_cancel = */false);
2596 }
2597
Felipe Leme9a523ae2016-10-20 15:10:33 -07002598 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002599 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002600 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002601 // Final timestamp
2602 char date[80];
2603 time_t the_real_now_please_stand_up = time(nullptr);
2604 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002605 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002606 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002607
Felipe Leme9a523ae2016-10-20 15:10:33 -07002608 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002609 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002610 return false;
2611 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002612 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002613 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002614 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002615 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002616
Felipe Leme0f3fb202016-06-10 17:10:53 -07002617 // Add log file (which contains stderr output) to zip...
2618 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002619 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002620 MYLOGE("Failed to add dumpstate log to .zip file\n");
2621 return false;
2622 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002623 // TODO: Should truncate the existing file.
2624 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002625 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2626 return false;
2627 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002628 fprintf(stderr, "\n");
2629
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002630 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002631 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002632 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002633 return false;
2634 }
2635
Felipe Leme1d486fe2016-10-14 18:06:47 -07002636 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2637 ds.zip_file.reset(nullptr);
2638
Felipe Lemee9d2c542016-11-15 11:48:26 -08002639 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002640 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002641
Felipe Leme1e9edc62015-12-21 16:02:13 -08002642 return true;
2643}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002644
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002645static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2646 // clang-format off
2647 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2648 "--receiver-foreground", "--receiver-include-background", "-a", action};
2649 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002650
2651 am.insert(am.end(), args.begin(), args.end());
2652
Felipe Leme8d2410e2017-02-08 09:46:08 -08002653 RunCommand("", am,
2654 CommandOptions::WithTimeout(20)
2655 .Log("Sending broadcast: '%s'\n")
2656 .Always()
2657 .DropRoot()
2658 .RedirectStderr()
2659 .Build());
2660}
2661
Felipe Leme35b8cf12017-02-10 15:47:29 -08002662static void Vibrate(int duration_ms) {
2663 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002664 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2665 "oneshot", std::to_string(duration_ms)};
2666 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002667 CommandOptions::WithTimeout(10)
2668 .Log("Vibrate: '%s'\n")
2669 .Always()
2670 .Build());
2671 // clang-format on
2672}
2673
Nandana Dutt979388e2018-11-30 16:48:55 +00002674static void MaybeResolveSymlink(std::string* path) {
2675 std::string resolved_path;
2676 if (android::base::Readlink(*path, &resolved_path)) {
2677 *path = resolved_path;
2678 }
2679}
2680
Nandana Dutt4be45d12018-09-26 15:04:23 +01002681/*
2682 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002683 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002684 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002685static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002686 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2687
Nandana Dutt4be45d12018-09-26 15:04:23 +01002688 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2689 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002690 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002691 char date[80];
2692 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2693 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002694
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002695 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002696 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002697 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002698 ds.base_name_ += "-wifi";
2699 }
2700
Paul Chang0d2aad72020-02-13 20:04:03 +08002701 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002702 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002703 }
2704 ds.tmp_path_ = ds.GetPath(".tmp");
2705 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2706
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002707 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002708 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002709 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002710 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002711 "Bugreport dir: [%s] "
2712 "Base name: [%s] "
2713 "Suffix: [%s] "
2714 "Log path: [%s] "
2715 "Temporary path: [%s] "
2716 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002717 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2718 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002719
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002720 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2721 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2722 create_parent_dirs(ds.path_.c_str());
2723 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2724 if (ds.zip_file == nullptr) {
2725 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2726 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002727 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002728 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2729 ds.AddTextZipEntry("version.txt", ds.version_);
2730 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002731}
2732
2733/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002734 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002735 * printing zipped file status, etc.
2736 */
2737static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002738 bool do_text_file = !ds.FinishZipFile();
2739 if (do_text_file) {
2740 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002741 }
mhasank2d75c442020-06-11 15:05:25 -07002742
2743 std::string final_path = ds.path_;
2744 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002745 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002746 android::os::CopyFileToFile(ds.path_, final_path);
2747 }
2748
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002749 if (ds.options_->stream_to_socket) {
2750 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2751 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002752 if (do_text_file) {
2753 dprintf(ds.control_socket_fd_,
2754 "FAIL:could not create zip file, check %s "
2755 "for more details\n",
2756 ds.log_path_.c_str());
2757 } else {
mhasank2d75c442020-06-11 15:05:25 -07002758 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002759 }
2760 }
2761}
2762
Nandana Dutt4be45d12018-09-26 15:04:23 +01002763
Nandana Dutt58d72e22018-11-16 10:30:48 +00002764static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2765 switch (mode) {
2766 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2767 return "BUGREPORT_FULL";
2768 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2769 return "BUGREPORT_INTERACTIVE";
2770 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2771 return "BUGREPORT_REMOTE";
2772 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2773 return "BUGREPORT_WEAR";
2774 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2775 return "BUGREPORT_TELEPHONY";
2776 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2777 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002778 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2779 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002780 }
2781}
2782
Paul Changf59c2b72020-03-10 02:08:55 +08002783static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2784 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002785 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2786 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002787 options->bugreport_mode = mode;
2788 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002789 switch (mode) {
2790 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002791 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002792 break;
2793 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002794 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002795 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002796 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002797 break;
2798 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002799 options->do_vibrate = false;
2800 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002801 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002802 break;
2803 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002804 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002805 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002806 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002807 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002808 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002809 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002810 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002811 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002812 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002813 break;
2814 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002815 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002816 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002817 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002818 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2819 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002820 }
2821}
2822
Nandana Dutt58d72e22018-11-16 10:30:48 +00002823static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002824 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002825 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002826 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002827 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002828 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002829 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002830 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002831 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002832 options.do_progress_updates, options.bugreport_fd.get(),
2833 options.bugreport_mode_string.c_str(),
2834 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002835}
2836
Nandana Dutt54dbd672019-01-11 12:58:05 +00002837void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2838 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002839 const android::base::unique_fd& screenshot_fd_in,
2840 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002841 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002842 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2843 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002844
Paul Changf59c2b72020-03-10 02:08:55 +08002845 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002846}
2847
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002848Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2849 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002850 int c;
mhasankd451a472020-05-26 18:02:39 -07002851 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002852 switch (c) {
2853 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002854 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002855 case 's': stream_to_socket = true; break;
2856 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002857 case 'v': show_header_only = true; break;
2858 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002859 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002860 case 'P': do_progress_updates = true; break;
2861 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002862 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002863 case 'V':
2864 case 'd':
2865 case 'z':
2866 // compatibility no-op
2867 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002868 case 'w':
2869 // This was already processed
2870 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002871 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002872 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002873 break;
2874 default:
2875 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002876 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002877 break;
2878 // clang-format on
2879 }
2880 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002881
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002882 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002883 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002884 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002885 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002886 }
2887 }
2888
2889 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2890 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002891
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002892 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002893}
2894
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002895bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002896 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002897 return false;
2898 }
2899
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002900 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002901 return false;
2902 }
2903
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002904 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002905 return false;
2906 }
2907 return true;
2908}
2909
Nandana Dutt197661d2018-11-16 16:40:21 +00002910void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2911 options_ = std::move(options);
2912}
2913
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002914void Dumpstate::Initialize() {
2915 /* gets the sequential id */
2916 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2917 id_ = ++last_id;
2918 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2919}
2920
Nandana Duttd2f5f082019-01-18 17:13:52 +00002921Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2922 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002923 if (listener_ != nullptr) {
2924 switch (status) {
2925 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002926 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002927 break;
2928 case Dumpstate::RunStatus::HELP:
2929 break;
2930 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002931 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002932 break;
2933 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002934 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2935 break;
2936 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2937 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2938 break;
2939 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2940 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002941 break;
2942 }
2943 }
2944 return status;
2945}
2946
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002947void Dumpstate::Cancel() {
2948 CleanupTmpFiles();
2949 android::os::UnlinkAndLogOnError(log_path_);
2950 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2951 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2952 kDumpstateBoardFiles[i]);
2953 }
2954 tombstone_data_.clear();
2955 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002956 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002957
2958 // Instead of shutdown the pool, we delete temporary files directly since
2959 // shutdown blocking the call.
2960 if (dump_pool_) {
2961 dump_pool_->deleteTempFiles();
2962 }
2963 if (zip_entry_tasks_) {
2964 zip_entry_tasks_->run(/*do_cancel =*/ true);
2965 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002966}
2967
Nandana Dutt979388e2018-11-30 16:48:55 +00002968/*
2969 * Dumps relevant information to a bugreport based on the given options.
2970 *
2971 * The bugreport can be dumped to a file or streamed to a socket.
2972 *
2973 * How dumping to file works:
2974 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2975 * stderr is redirected a log file.
2976 *
2977 * The temporary bugreport is then populated via printfs, dumping contents of files and
2978 * output of commands to stdout.
2979 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002980 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002981 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002982 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002983 *
mhasank2d75c442020-06-11 15:05:25 -07002984 * Bugreports are first generated in a local directory and later copied to the caller's fd
2985 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002986 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002987Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2988 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002989 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002990 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002991 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002992 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002993 return RunStatus::INVALID_INPUT;
2994 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002995 /* set as high priority, and protect from OOM killer */
2996 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002997
Felipe Lemed071c682016-10-20 16:48:00 -07002998 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002999 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003000 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003001 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003002 } else {
3003 /* fallback to kernels <= 2.6.35 */
3004 oom_adj = fopen("/proc/self/oom_adj", "we");
3005 if (oom_adj) {
3006 fputs("-17", oom_adj);
3007 fclose(oom_adj);
3008 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003009 }
3010
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003011 if (version_ == VERSION_DEFAULT) {
3012 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003013 }
3014
Chris Morin5a50d482022-02-01 17:41:18 -08003015 if (version_ != VERSION_CURRENT) {
3016 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3017 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003018 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003019 }
3020
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003021 if (options_->show_header_only) {
3022 PrintHeader();
3023 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003024 }
3025
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003026 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3027 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003028
Felipe Leme7447d7c2016-11-03 18:12:22 -07003029 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003030 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003031 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003032 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003033
Sahana Raof35ed432019-07-12 10:47:52 +01003034 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3035 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3036 } else {
3037 // Wake lock will be released automatically on process death
3038 MYLOGD("Wake lock acquired.\n");
3039 }
3040
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003041 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003042
Felipe Lemef0292972016-11-22 13:57:05 -08003043 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003044 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3045 }
3046
Nandana Dutt235c6672019-11-14 15:22:32 +00003047 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003048 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003049
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003050 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003051
Christopher Ferrised9354f2014-10-01 17:35:01 -07003052 // If we are going to use a socket, do it as early as possible
3053 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003054 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003055 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003056 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003057 if (control_socket_fd_ == -1) {
3058 return ERROR;
3059 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003060 if (options_->progress_updates_to_socket) {
3061 options_->do_progress_updates = 1;
3062 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003063 }
3064
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003065 if (!PrepareToWriteToFile()) {
3066 return ERROR;
3067 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003068
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003069 // Interactive, wear & telephony modes are default to true.
3070 // and may enable from cli option or when using control socket
3071 if (options_->do_progress_updates) {
3072 // clang-format off
3073 std::vector<std::string> am_args = {
3074 "--receiver-permission", "android.permission.DUMP",
3075 };
3076 // clang-format on
3077 // Send STARTED broadcast for apps that listen to bugreport generation events
3078 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3079 if (options_->progress_updates_to_socket) {
3080 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003081 }
3082 }
3083
Nick Kralevichf3599b32016-01-25 15:05:16 -08003084 /* read /proc/cmdline before dropping root */
3085 FILE *cmdline = fopen("/proc/cmdline", "re");
3086 if (cmdline) {
3087 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3088 fclose(cmdline);
3089 }
3090
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003091 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003092 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003093 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003094
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003095 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003096 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3097 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003098 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003099 }
3100 }
3101
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003102 int dup_stdout_fd;
3103 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003104 // Redirect stderr to log_path_ for debugging.
3105 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3106 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3107 return ERROR;
3108 }
3109 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3110 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3111 strerror(errno));
3112 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003113
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003114 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3115 // moved into zip file later, if zipping.
3116 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3117 // TODO: why not write to a file instead of stdout to overcome this problem?
3118 /* TODO: rather than generating a text file now and zipping it later,
3119 it would be more efficient to redirect stdout to the zip entry
3120 directly, but the libziparchive doesn't support that option yet. */
3121 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3122 return ERROR;
3123 }
3124 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3125 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3126 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003127 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003128
3129 // Don't buffer stdout
3130 setvbuf(stdout, nullptr, _IONBF, 0);
3131
Rhed Jao5377d792020-07-16 17:37:39 +08003132 // Enable the parallel run if the client requests to output to a file.
3133 EnableParallelRunIfNeeded();
3134 // Using scope guard to make sure the dump pool can be shut down correctly.
3135 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3136 ShutdownDumpPool();
3137 });
3138
Felipe Leme608385d2016-02-01 10:35:38 -08003139 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3140 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003141 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003142 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003143
Gavin Corkery6968f552020-11-22 18:09:05 +00003144 bool is_dumpstate_restricted = options_->telephony_only
3145 || options_->wifi_only
3146 || options_->limited_only;
3147 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003148 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003149 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003150 }
3151 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003152
3153 if (!is_dumpstate_restricted) {
3154 // Snapshot the system trace now (if running) to avoid that dumpstate's
3155 // own activity pushes out interesting data from the trace ring buffer.
3156 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3157 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003158
3159 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3160 // from WMTRACE_DATA_DIR.
3161 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003162 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003163 onUiIntensiveBugreportDumpsFinished(calling_uid);
3164 MaybeCheckUserConsent(calling_uid, calling_package);
3165 if (options_->telephony_only) {
3166 DumpstateTelephonyOnly(calling_package);
3167 } else if (options_->wifi_only) {
3168 DumpstateWifiOnly();
3169 } else if (options_->limited_only) {
3170 DumpstateLimitedOnly();
3171 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003172 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003173 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003174 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003175 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003176 HandleUserConsentDenied();
3177 }
3178 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003179 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003180 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003181
Felipe Leme55b42a62015-11-10 17:39:08 -08003182 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003183 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003184
Abhijeet Kaure370d682019-10-01 16:49:30 +01003185 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003186 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003187 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003188 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003189
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003190 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003191 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003192 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003193 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003194 if (status != Dumpstate::RunStatus::OK &&
3195 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3196 // Do an early return if there were errors. We make an exception for consent
3197 // timing out because it's possible the user got distracted. In this case the
3198 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003199 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003200 return status;
3201 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003202 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3203 MYLOGI(
3204 "Did not receive user consent yet."
3205 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003206 const String16 incidentcompanion("incidentcompanion");
3207 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3208 if (ics != nullptr) {
3209 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3210 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3211 consent_callback_.get());
3212 } else {
3213 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3214 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003215 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003216 }
3217
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003218 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003219 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003220 for (int i = 0; i < 3; i++) {
3221 Vibrate(75);
3222 usleep((75 + 50) * 1000);
3223 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003224 }
3225
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003226 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3227 progress_->GetInitialMax());
3228 progress_->Save();
3229 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003230
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003231 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003232
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003233 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003234 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003235 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003236 }
3237
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003238 tombstone_data_.clear();
3239 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003240 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003241
Nandana Duttd2f5f082019-01-18 17:13:52 +00003242 return (consent_callback_ != nullptr &&
3243 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3244 ? USER_CONSENT_TIMED_OUT
3245 : RunStatus::OK;
3246}
3247
Paul Chang0d2aad72020-02-13 20:04:03 +08003248void Dumpstate::MaybeTakeEarlyScreenshot() {
3249 if (!options_->do_screenshot || !do_early_screenshot_) {
3250 return;
3251 }
3252
3253 TakeScreenshot();
3254}
3255
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003256void Dumpstate::MaybeSnapshotSystemTrace() {
3257 // If a background system trace is happening and is marked as "suitable for
3258 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3259 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3260 // case that no trace is ongoing, this command is a no-op.
3261 // Note: this should not be enqueued as we need to freeze the trace before
3262 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3263 // the dumpstate's own activity which is irrelevant.
3264 int res = RunCommand(
3265 "SERIALIZE PERFETTO TRACE",
3266 {"perfetto", "--save-for-bugreport"},
3267 CommandOptions::WithTimeout(10)
3268 .DropRoot()
3269 .CloseAllFileDescriptorsOnExec()
3270 .Build());
3271 has_system_trace_ = res == 0;
3272 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3273 // file in the later stages.
3274}
3275
Yohei Yukawa95305b32021-03-09 07:54:27 -08003276void Dumpstate::MaybeSnapshotWinTrace() {
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003277 // Include the proto logging from WMShell.
3278 RunCommand(
3279 // Empty name because it's not intended to be classified as a bugreport section.
3280 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3281 // in the bugreport.
3282 "", {"dumpsys", "activity", "service", "SystemUIService",
3283 "WMShell", "protolog", "save-for-bugreport"},
3284 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3285
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003286 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3287 for (const auto& service : {"window", "input_method"}) {
3288 RunCommand(
3289 // Empty name because it's not intended to be classified as a bugreport section.
3290 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3291 "", {"cmd", service, "tracing", "save-for-bugreport"},
3292 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3293 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003294}
3295
Paul Changeb4b4642020-05-28 22:05:47 +08003296void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003297 if (calling_uid == AID_SHELL || !CalledByApi()) {
3298 return;
3299 }
3300 if (listener_ != nullptr) {
3301 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3302 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003303 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003304 }
3305}
3306
Jichao Lie89d9c12019-11-21 19:02:51 -08003307void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3308 if (calling_uid == AID_SHELL || !CalledByApi()) {
3309 // No need to get consent for shell triggered dumpstates, or not through
3310 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003311 return;
3312 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003313 consent_callback_ = new ConsentCallback();
3314 const String16 incidentcompanion("incidentcompanion");
3315 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003316 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003317 if (ics != nullptr) {
3318 MYLOGD("Checking user consent via incidentcompanion service\n");
3319 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003320 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003321 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003322 } else {
3323 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3324 }
3325}
3326
Nandana Dutt5c390032019-03-12 10:52:56 +00003327bool Dumpstate::IsUserConsentDenied() const {
3328 return ds.consent_callback_ != nullptr &&
3329 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3330}
3331
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003332bool Dumpstate::CalledByApi() const {
3333 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3334}
3335
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003336void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003337 android::os::UnlinkAndLogOnError(tmp_path_);
3338 android::os::UnlinkAndLogOnError(screenshot_path_);
3339 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003340 if (dump_traces_path != nullptr) {
3341 android::os::UnlinkAndLogOnError(dump_traces_path);
3342 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003343}
3344
Rhed Jao5377d792020-07-16 17:37:39 +08003345void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003346 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003347 return;
3348 }
3349 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003350 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003351}
3352
3353void Dumpstate::ShutdownDumpPool() {
3354 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003355 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003356 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003357 if (zip_entry_tasks_) {
3358 zip_entry_tasks_->run(/* do_cancel = */true);
3359 zip_entry_tasks_ = nullptr;
3360 }
3361}
3362
3363void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3364 const std::string& entry_path) {
3365 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3366 if (!task_cancelled) {
3367 AddZipEntry(entry_name, entry_path);
3368 }
3369 android::os::UnlinkAndLogOnError(entry_path);
3370 };
3371 if (zip_entry_tasks_) {
3372 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3373 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3374 } else {
3375 // Invokes AddZipEntryAndCleanup immediately
3376 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3377 }
Rhed Jao5377d792020-07-16 17:37:39 +08003378}
3379
Nandana Duttd2f5f082019-01-18 17:13:52 +00003380Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3381 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003382 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003383 return USER_CONSENT_DENIED;
3384}
3385
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003386Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003387 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003388 // user consent (unless the caller is Shell).
3389 UserConsentResult consent_result;
3390 if (calling_uid == AID_SHELL) {
3391 consent_result = UserConsentResult::APPROVED;
3392 } else {
3393 consent_result = consent_callback_->getResult();
3394 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003395 if (consent_result == UserConsentResult::UNAVAILABLE) {
3396 // User has not responded yet.
3397 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003398 // Telephony is a fast report type, particularly on user builds where information may be
3399 // more aggressively limited. To give the user time to read the consent dialog, increase the
3400 // timeout.
3401 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3402 : USER_CONSENT_TIMEOUT_MS;
3403 if (elapsed_ms < timeout_ms) {
3404 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003405 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3406 sleep(delay_seconds);
3407 }
3408 consent_result = consent_callback_->getResult();
3409 }
3410 if (consent_result == UserConsentResult::DENIED) {
3411 // User has explicitly denied sharing with the app. To be safe delete the
3412 // internal bugreport & tmp files.
3413 return HandleUserConsentDenied();
3414 }
3415 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003416 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3417 if (copy_succeeded) {
3418 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003419 if (options_->do_screenshot &&
3420 options_->screenshot_fd.get() != -1 &&
3421 !options_->is_screenshot_copied) {
3422 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3423 options_->screenshot_fd.get());
3424 options_->is_screenshot_copied = copy_succeeded;
3425 if (copy_succeeded) {
3426 android::os::UnlinkAndLogOnError(screenshot_path_);
3427 }
3428 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003429 }
3430 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3431 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3432 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3433 // Since we do not have user consent to share the bugreport it does not get
3434 // copied over to the calling app but remains in the internal directory from
3435 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003436 std::string final_path = GetPath(".zip");
3437 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3438 if (copy_succeeded) {
3439 android::os::UnlinkAndLogOnError(path_);
3440 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003441 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3442 }
3443 // Unknown result; must be a programming error.
3444 MYLOGE("Unknown user consent result:%d\n", consent_result);
3445 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003446}
3447
Nandana Duttf02564e2019-02-15 15:24:24 +00003448Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003449 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3450 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3451 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003452 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003453 // When directly running dumpstate binary, the output is not expected to be written
3454 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003455 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003456
3457 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003458 // an app; they are irrelevant here because bugreport is triggered via command line.
3459 // Update Last ID before calling Run().
3460 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003461 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003462 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003463 return status;
3464}
3465
3466/* Main entry point for dumpstate binary. */
3467int run_main(int argc, char* argv[]) {
3468 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003469
3470 switch (status) {
3471 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003472 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003473 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003474 ShowUsage();
3475 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003476 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003477 fprintf(stderr, "Invalid combination of args\n");
3478 ShowUsage();
3479 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003480 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003481 FALLTHROUGH_INTENDED;
3482 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3483 FALLTHROUGH_INTENDED;
3484 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003485 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003486 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003487}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003488
3489// TODO(111441001): Default DumpOptions to sensible values.
3490Dumpstate::Dumpstate(const std::string& version)
3491 : pid_(getpid()),
3492 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003493 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003494 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003495 now_(time(nullptr)),
3496 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003497}
3498
3499Dumpstate& Dumpstate::GetInstance() {
3500 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3501 return singleton_;
3502}
3503
Rhed Jao5377d792020-07-16 17:37:39 +08003504DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3505 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3506 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003507 if (!title_.empty()) {
3508 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003509 if (title_.find("SHOW MAP") == std::string::npos) {
3510 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3511 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003512 }
3513}
3514
3515DurationReporter::~DurationReporter() {
3516 if (!title_.empty()) {
3517 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003518 if (elapsed >= .5f || verbose_) {
3519 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003520 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003521 if (!logcat_only_) {
3522 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003523 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3524 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003525 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003526 if (title_.find("SHOW MAP") == std::string::npos) {
3527 ATRACE_ASYNC_END(title_.c_str(), 0);
3528 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003529 }
3530}
3531
3532const int32_t Progress::kDefaultMax = 5000;
3533
3534Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3535}
3536
3537Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3538 : Progress(initial_max, growth_factor, "") {
3539 progress_ = progress;
3540}
3541
3542Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3543 : initial_max_(initial_max),
3544 progress_(0),
3545 max_(initial_max),
3546 growth_factor_(growth_factor),
3547 n_runs_(0),
3548 average_max_(0),
3549 path_(path) {
3550 if (!path_.empty()) {
3551 Load();
3552 }
3553}
3554
3555void Progress::Load() {
3556 MYLOGD("Loading stats from %s\n", path_.c_str());
3557 std::string content;
3558 if (!android::base::ReadFileToString(path_, &content)) {
3559 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3560 return;
3561 }
3562 if (content.empty()) {
3563 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3564 return;
3565 }
3566 std::vector<std::string> lines = android::base::Split(content, "\n");
3567
3568 if (lines.size() < 1) {
3569 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3570 (int)lines.size(), max_);
3571 return;
3572 }
3573 char* ptr;
3574 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3575 average_max_ = strtol(ptr, nullptr, 10);
3576 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3577 average_max_ > STATS_MAX_AVERAGE) {
3578 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3579 initial_max_ = Progress::kDefaultMax;
3580 } else {
3581 initial_max_ = average_max_;
3582 }
3583 max_ = initial_max_;
3584
3585 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3586}
3587
3588void Progress::Save() {
3589 int32_t total = n_runs_ * average_max_ + progress_;
3590 int32_t runs = n_runs_ + 1;
3591 int32_t average = floor(((float)total) / runs);
3592 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3593 path_.c_str());
3594 if (path_.empty()) {
3595 return;
3596 }
3597
3598 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3599 if (!android::base::WriteStringToFile(content, path_)) {
3600 MYLOGE("Could not save stats on %s\n", path_.c_str());
3601 }
3602}
3603
3604int32_t Progress::Get() const {
3605 return progress_;
3606}
3607
3608bool Progress::Inc(int32_t delta_sec) {
3609 bool changed = false;
3610 if (delta_sec >= 0) {
3611 progress_ += delta_sec;
3612 if (progress_ > max_) {
3613 int32_t old_max = max_;
3614 max_ = floor((float)progress_ * growth_factor_);
3615 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3616 changed = true;
3617 }
3618 }
3619 return changed;
3620}
3621
3622int32_t Progress::GetMax() const {
3623 return max_;
3624}
3625
3626int32_t Progress::GetInitialMax() const {
3627 return initial_max_;
3628}
3629
3630void Progress::Dump(int fd, const std::string& prefix) const {
3631 const char* pr = prefix.c_str();
3632 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3633 dprintf(fd, "%smax: %d\n", pr, max_);
3634 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3635 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3636 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3637 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3638 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3639}
3640
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003641std::string Dumpstate::GetPath(const std::string& suffix) const {
3642 return GetPath(bugreport_internal_dir_, suffix);
3643}
3644
3645std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3646 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3647 name_.c_str(), suffix.c_str());
3648}
3649
3650void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3651 progress_ = std::move(progress);
3652}
3653
3654void for_each_userid(void (*func)(int), const char *header) {
3655 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3656 "for_each_userid(%s)", header);
3657 DurationReporter duration_reporter(title);
3658 if (PropertiesHelper::IsDryRun()) return;
3659
3660 DIR *d;
3661 struct dirent *de;
3662
3663 if (header) printf("\n------ %s ------\n", header);
3664 func(0);
3665
3666 if (!(d = opendir("/data/system/users"))) {
3667 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3668 return;
3669 }
3670
3671 while ((de = readdir(d))) {
3672 int userid;
3673 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3674 continue;
3675 }
3676 func(userid);
3677 }
3678
3679 closedir(d);
3680}
3681
3682static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3683 DIR *d;
3684 struct dirent *de;
3685
3686 if (!(d = opendir("/proc"))) {
3687 printf("Failed to open /proc (%s)\n", strerror(errno));
3688 return;
3689 }
3690
3691 if (header) printf("\n------ %s ------\n", header);
3692 while ((de = readdir(d))) {
3693 if (ds.IsUserConsentDenied()) {
3694 MYLOGE(
3695 "Returning early because user denied consent to share bugreport with calling app.");
3696 closedir(d);
3697 return;
3698 }
3699 int pid;
3700 int fd;
3701 char cmdpath[255];
3702 char cmdline[255];
3703
3704 if (!(pid = atoi(de->d_name))) {
3705 continue;
3706 }
3707
3708 memset(cmdline, 0, sizeof(cmdline));
3709
3710 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3711 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3712 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3713 close(fd);
3714 if (cmdline[0]) {
3715 helper(pid, cmdline, arg);
3716 continue;
3717 }
3718 }
3719
3720 // if no cmdline, a kernel thread has comm
3721 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3722 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3723 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3724 close(fd);
3725 if (cmdline[1]) {
3726 cmdline[0] = '[';
3727 size_t len = strcspn(cmdline, "\f\b\r\n");
3728 cmdline[len] = ']';
3729 cmdline[len+1] = '\0';
3730 }
3731 }
3732 if (!cmdline[0]) {
3733 strcpy(cmdline, "N/A");
3734 }
3735 helper(pid, cmdline, arg);
3736 }
3737
3738 closedir(d);
3739}
3740
3741static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3742 for_each_pid_func *func = (for_each_pid_func*) arg;
3743 func(pid, cmdline);
3744}
3745
3746void for_each_pid(for_each_pid_func func, const char *header) {
3747 std::string title = header == nullptr ? "for_each_pid"
3748 : android::base::StringPrintf("for_each_pid(%s)", header);
3749 DurationReporter duration_reporter(title);
3750 if (PropertiesHelper::IsDryRun()) return;
3751
3752 __for_each_pid(for_each_pid_helper, header, (void *) func);
3753}
3754
3755static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3756 DIR *d;
3757 struct dirent *de;
3758 char taskpath[255];
3759 for_each_tid_func *func = (for_each_tid_func *) arg;
3760
3761 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3762
3763 if (!(d = opendir(taskpath))) {
3764 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3765 return;
3766 }
3767
3768 func(pid, pid, cmdline);
3769
3770 while ((de = readdir(d))) {
3771 if (ds.IsUserConsentDenied()) {
3772 MYLOGE(
3773 "Returning early because user denied consent to share bugreport with calling app.");
3774 closedir(d);
3775 return;
3776 }
3777 int tid;
3778 int fd;
3779 char commpath[255];
3780 char comm[255];
3781
3782 if (!(tid = atoi(de->d_name))) {
3783 continue;
3784 }
3785
3786 if (tid == pid)
3787 continue;
3788
3789 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3790 memset(comm, 0, sizeof(comm));
3791 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3792 strcpy(comm, "N/A");
3793 } else {
3794 char *c;
3795 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3796 close(fd);
3797
3798 c = strrchr(comm, '\n');
3799 if (c) {
3800 *c = '\0';
3801 }
3802 }
3803 func(pid, tid, comm);
3804 }
3805
3806 closedir(d);
3807}
3808
3809void for_each_tid(for_each_tid_func func, const char *header) {
3810 std::string title = header == nullptr ? "for_each_tid"
3811 : android::base::StringPrintf("for_each_tid(%s)", header);
3812 DurationReporter duration_reporter(title);
3813
3814 if (PropertiesHelper::IsDryRun()) return;
3815
3816 __for_each_pid(for_each_tid_helper, header, (void *) func);
3817}
3818
3819void show_wchan(int pid, int tid, const char *name) {
3820 if (PropertiesHelper::IsDryRun()) return;
3821
3822 char path[255];
3823 char buffer[255];
3824 int fd, ret, save_errno;
3825 char name_buffer[255];
3826
3827 memset(buffer, 0, sizeof(buffer));
3828
3829 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3830 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3831 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3832 return;
3833 }
3834
3835 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3836 save_errno = errno;
3837 close(fd);
3838
3839 if (ret < 0) {
3840 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3841 return;
3842 }
3843
3844 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3845 pid == tid ? 0 : 3, "", name);
3846
3847 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3848
3849 return;
3850}
3851
3852// print time in centiseconds
3853static void snprcent(char *buffer, size_t len, size_t spc,
3854 unsigned long long time) {
3855 static long hz; // cache discovered hz
3856
3857 if (hz <= 0) {
3858 hz = sysconf(_SC_CLK_TCK);
3859 if (hz <= 0) {
3860 hz = 1000;
3861 }
3862 }
3863
3864 // convert to centiseconds
3865 time = (time * 100 + (hz / 2)) / hz;
3866
3867 char str[16];
3868
3869 snprintf(str, sizeof(str), " %llu.%02u",
3870 time / 100, (unsigned)(time % 100));
3871 size_t offset = strlen(buffer);
3872 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3873 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3874}
3875
3876// print permille as a percent
3877static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3878 char str[16];
3879
3880 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3881 size_t offset = strlen(buffer);
3882 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3883 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3884}
3885
3886void show_showtime(int pid, const char *name) {
3887 if (PropertiesHelper::IsDryRun()) return;
3888
3889 char path[255];
3890 char buffer[1023];
3891 int fd, ret, save_errno;
3892
3893 memset(buffer, 0, sizeof(buffer));
3894
3895 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3896 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3897 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3898 return;
3899 }
3900
3901 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3902 save_errno = errno;
3903 close(fd);
3904
3905 if (ret < 0) {
3906 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3907 return;
3908 }
3909
3910 // field 14 is utime
3911 // field 15 is stime
3912 // field 42 is iotime
3913 unsigned long long utime = 0, stime = 0, iotime = 0;
3914 if (sscanf(buffer,
3915 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3916 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3917 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3918 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3919 &utime, &stime, &iotime) != 3) {
3920 return;
3921 }
3922
3923 unsigned long long total = utime + stime;
3924 if (!total) {
3925 return;
3926 }
3927
3928 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3929 if (permille > 1000) {
3930 permille = 1000;
3931 }
3932
3933 // try to beautify and stabilize columns at <80 characters
3934 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3935 if ((name[0] != '[') || utime) {
3936 snprcent(buffer, sizeof(buffer), 57, utime);
3937 }
3938 snprcent(buffer, sizeof(buffer), 65, stime);
3939 if ((name[0] != '[') || iotime) {
3940 snprcent(buffer, sizeof(buffer), 73, iotime);
3941 }
3942 if (iotime) {
3943 snprdec(buffer, sizeof(buffer), 79, permille);
3944 }
3945 puts(buffer); // adds a trailing newline
3946
3947 return;
3948}
3949
3950void do_dmesg() {
3951 const char *title = "KERNEL LOG (dmesg)";
3952 DurationReporter duration_reporter(title);
3953 printf("------ %s ------\n", title);
3954
3955 if (PropertiesHelper::IsDryRun()) return;
3956
3957 /* Get size of kernel buffer */
3958 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3959 if (size <= 0) {
3960 printf("Unexpected klogctl return value: %d\n\n", size);
3961 return;
3962 }
3963 char *buf = (char *) malloc(size + 1);
3964 if (buf == nullptr) {
3965 printf("memory allocation failed\n\n");
3966 return;
3967 }
3968 int retval = klogctl(KLOG_READ_ALL, buf, size);
3969 if (retval < 0) {
3970 printf("klogctl failure\n\n");
3971 free(buf);
3972 return;
3973 }
3974 buf[retval] = '\0';
3975 printf("%s\n\n", buf);
3976 free(buf);
3977 return;
3978}
3979
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003980int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3981 DurationReporter duration_reporter(title);
3982
3983 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3984
3985 UpdateProgress(WEIGHT_FILE);
3986
3987 return status;
3988}
3989
3990int read_file_as_long(const char *path, long int *output) {
3991 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3992 if (fd < 0) {
3993 int err = errno;
3994 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3995 return -1;
3996 }
3997 char buffer[50];
3998 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3999 if (bytes_read == -1) {
4000 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4001 return -2;
4002 }
4003 if (bytes_read == 0) {
4004 MYLOGE("File %s is empty\n", path);
4005 return -3;
4006 }
4007 *output = atoi(buffer);
4008 return 0;
4009}
4010
4011/* calls skip to gate calling dump_from_fd recursively
4012 * in the specified directory. dump_from_fd defaults to
4013 * dump_file_from_fd above when set to NULL. skip defaults
4014 * to false when set to NULL. dump_from_fd will always be
4015 * called with title NULL.
4016 */
4017int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4018 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4019 DurationReporter duration_reporter(title);
4020 DIR *dirp;
4021 struct dirent *d;
4022 char *newpath = nullptr;
4023 const char *slash = "/";
4024 int retval = 0;
4025
4026 if (!title.empty()) {
4027 printf("------ %s (%s) ------\n", title.c_str(), dir);
4028 }
4029 if (PropertiesHelper::IsDryRun()) return 0;
4030
4031 if (dir[strlen(dir) - 1] == '/') {
4032 ++slash;
4033 }
4034 dirp = opendir(dir);
4035 if (dirp == nullptr) {
4036 retval = -errno;
4037 MYLOGE("%s: %s\n", dir, strerror(errno));
4038 return retval;
4039 }
4040
4041 if (!dump_from_fd) {
4042 dump_from_fd = dump_file_from_fd;
4043 }
4044 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4045 if ((d->d_name[0] == '.')
4046 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4047 || (d->d_name[1] == '\0'))) {
4048 continue;
4049 }
4050 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4051 (d->d_type == DT_DIR) ? "/" : "");
4052 if (!newpath) {
4053 retval = -errno;
4054 continue;
4055 }
4056 if (skip && (*skip)(newpath)) {
4057 continue;
4058 }
4059 if (d->d_type == DT_DIR) {
4060 int ret = dump_files("", newpath, skip, dump_from_fd);
4061 if (ret < 0) {
4062 retval = ret;
4063 }
4064 continue;
4065 }
4066 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4067 if (fd.get() < 0) {
4068 retval = -1;
4069 printf("*** %s: %s\n", newpath, strerror(errno));
4070 continue;
4071 }
4072 (*dump_from_fd)(nullptr, newpath, fd.get());
4073 }
4074 closedir(dirp);
4075 if (!title.empty()) {
4076 printf("\n");
4077 }
4078 return retval;
4079}
4080
4081/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4082 * it's possible to avoid issues where opening the file itself can get
4083 * stuck.
4084 */
4085int dump_file_from_fd(const char *title, const char *path, int fd) {
4086 if (PropertiesHelper::IsDryRun()) return 0;
4087
4088 int flags = fcntl(fd, F_GETFL);
4089 if (flags == -1) {
4090 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4091 return -1;
4092 } else if (!(flags & O_NONBLOCK)) {
4093 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4094 return -1;
4095 }
4096 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4097}
4098
4099int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004100 const CommandOptions& options, bool verbose_duration, int out_fd) {
4101 DurationReporter duration_reporter(title, false /* logcat_only */,
4102 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004103
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004104 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004105
4106 /* TODO: for now we're simplifying the progress calculation by using the
4107 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4108 * where its weight should be much higher proportionally to its timeout.
4109 * Ideally, it should use a options.EstimatedDuration() instead...*/
4110 UpdateProgress(options.Timeout());
4111
4112 return status;
4113}
4114
4115void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004116 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004117 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4118 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4119 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004120 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004121}
4122
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004123static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004124 int s = android_get_control_socket(service);
4125 if (s < 0) {
4126 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4127 return -1;
4128 }
4129 fcntl(s, F_SETFD, FD_CLOEXEC);
4130
4131 // Set backlog to 0 to make sure that queue size will be minimum.
4132 // In Linux, because the minimum queue will be 1, connect() will be blocked
4133 // if the other clients already called connect() and the connection request was not accepted.
4134 if (listen(s, 0) < 0) {
4135 MYLOGE("listen(control socket): %s\n", strerror(errno));
4136 return -1;
4137 }
4138
4139 struct sockaddr addr;
4140 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004141 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004142
4143 // Close socket just after accept(), to make sure that connect() by client will get error
4144 // when the socket is used by the other services.
4145 // There is still a race condition possibility between accept and close, but there is no way
4146 // to close-on-accept atomically.
4147 // See detail; b/123306389#comment25
4148 close(s);
4149
4150 if (fd < 0) {
4151 MYLOGE("accept(control socket): %s\n", strerror(errno));
4152 return -1;
4153 }
4154
4155 return fd;
4156}
4157
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004158// TODO: should call is_valid_output_file and/or be merged into it.
4159void create_parent_dirs(const char *path) {
4160 char *chp = const_cast<char *> (path);
4161
4162 /* skip initial slash */
4163 if (chp[0] == '/')
4164 chp++;
4165
4166 /* create leading directories, if necessary */
4167 struct stat dir_stat;
4168 while (chp && chp[0]) {
4169 chp = strchr(chp, '/');
4170 if (chp) {
4171 *chp = 0;
4172 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4173 MYLOGI("Creating directory %s\n", path);
4174 if (mkdir(path, 0770)) { /* drwxrwx--- */
4175 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4176 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4177 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4178 }
4179 }
4180 *chp++ = '/';
4181 }
4182 }
4183}
4184
4185bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4186 create_parent_dirs(path);
4187
4188 int fd = TEMP_FAILURE_RETRY(open(path,
4189 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4190 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4191 if (fd < 0) {
4192 MYLOGE("%s: %s\n", path, strerror(errno));
4193 return false;
4194 }
4195
4196 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4197 close(fd);
4198 return true;
4199}
4200
4201bool redirect_to_file(FILE* redirect, char* path) {
4202 return _redirect_to_file(redirect, path, O_TRUNC);
4203}
4204
4205bool redirect_to_existing_file(FILE* redirect, char* path) {
4206 return _redirect_to_file(redirect, path, O_APPEND);
4207}
4208
4209void dump_route_tables() {
4210 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4211 if (PropertiesHelper::IsDryRun()) return;
4212 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4213 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4214 FILE* fp = fopen(RT_TABLES_PATH, "re");
4215 if (!fp) {
4216 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4217 return;
4218 }
4219 char table[16];
4220 // Each line has an integer (the table number), a space, and a string (the table name). We only
4221 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4222 // Add a fixed max limit so this doesn't go awry.
4223 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4224 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4225 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4226 }
4227 fclose(fp);
4228}
4229
Li Li830179f2022-01-04 12:53:29 -08004230void dump_frozen_cgroupfs(const char *dir, int level,
4231 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4232 DIR *dirp;
4233 struct dirent *d;
4234 char *newpath = nullptr;
4235
4236 dirp = opendir(dir);
4237 if (dirp == nullptr) {
4238 MYLOGE("%s: %s\n", dir, strerror(errno));
4239 return;
4240 }
4241
4242 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4243 if ((d->d_name[0] == '.')
4244 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4245 || (d->d_name[1] == '\0'))) {
4246 continue;
4247 }
4248 if (d->d_type == DT_DIR) {
4249 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4250 if (!newpath) {
4251 continue;
4252 }
4253 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4254 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4255 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4256 char *freezer = nullptr;
4257 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4258 if (freezer) {
4259 FILE* fp = fopen(freezer, "r");
4260 if (fp != NULL) {
4261 int frozen;
4262 fscanf(fp, "%d", &frozen);
4263 if (frozen > 0) {
4264 dump_files("", newpath, skip_none, dump_from_fd);
4265 }
4266 fclose(fp);
4267 }
4268 free(freezer);
4269 }
4270 }
4271 }
4272 }
4273 closedir(dirp);
4274}
4275
4276void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004277 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4278 DurationReporter duration_reporter("FROZEN CGROUPFS");
4279 if (PropertiesHelper::IsDryRun()) return;
4280 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4281}
4282
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004283void Dumpstate::UpdateProgress(int32_t delta_sec) {
4284 if (progress_ == nullptr) {
4285 MYLOGE("UpdateProgress: progress_ not set\n");
4286 return;
4287 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004288 // This function updates progress related members of the dumpstate and reports
4289 // progress percentage to the bugreport client. Since it could be called by
4290 // different dump tasks at the same time if the parallel run is enabled, a
4291 // mutex lock is necessary here to synchronize the call.
4292 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004293
4294 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004295 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004296
4297 // ...but only notifiy listeners when necessary.
4298 if (!options_->do_progress_updates) return;
4299
4300 int progress = progress_->Get();
4301 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004302 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004303
Nandana Dutt402a8392019-06-14 14:25:13 +01004304 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004305 return;
4306 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004307 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004308
4309 if (control_socket_fd_ >= 0) {
4310 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4311 fsync(control_socket_fd_);
4312 }
4313
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004314 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004315 if (percent % 10 == 0) {
4316 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004317 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004318 } else {
4319 // stderr is ignored on normal invocations, but useful when calling
4320 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004321 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004322 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004323
4324 listener_->onProgress(percent);
4325 }
4326}
4327
4328void Dumpstate::TakeScreenshot(const std::string& path) {
4329 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4330 int status =
4331 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4332 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4333 if (status == 0) {
4334 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4335 } else {
4336 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4337 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004338 if (listener_ != nullptr) {
4339 // Show a visual indication to indicate screenshot is taken via
4340 // IDumpstateListener.onScreenshotTaken()
4341 listener_->onScreenshotTaken(status == 0);
4342 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004343}
4344
4345bool is_dir(const char* pathname) {
4346 struct stat info;
4347 if (stat(pathname, &info) == -1) {
4348 return false;
4349 }
4350 return S_ISDIR(info.st_mode);
4351}
4352
4353time_t get_mtime(int fd, time_t default_mtime) {
4354 struct stat info;
4355 if (fstat(fd, &info) == -1) {
4356 return default_mtime;
4357 }
4358 return info.st_mtime;
4359}