blob: bb4d58b153df3d85c3dd8232769269c68f60ee85 [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"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800817 printf("Uptime: ");
818 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
819 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800820 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800821 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
822 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000823 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800824 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800825}
826
Felipe Leme24b66ee2016-06-16 10:55:26 -0700827// List of file extensions that can cause a zip file attachment to be rejected by some email
828// service providers.
829static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
830 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
831 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
832 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
833};
834
Vishnu Naire97d6122018-01-18 13:58:56 -0800835status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
836 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700837 std::string valid_name = entry_name;
838
839 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700840 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700841 if (idx != std::string::npos) {
842 std::string extension = entry_name.substr(idx);
843 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
844 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
845 valid_name = entry_name + ".renamed";
846 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
847 }
848 }
849
Felipe Leme6fe9db62016-02-12 09:04:16 -0800850 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
851 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000852 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
853 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700854 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700855 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700856 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700857 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800858 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800859 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000860 bool finished_entry = false;
861 auto finish_entry = [this, &finished_entry] {
862 if (!finished_entry) {
863 // This should only be called when we're going to return an earlier error,
864 // which would've been logged. This may imply the file is already corrupt
865 // and any further logging from FinishEntry is more likely to mislead than
866 // not.
867 this->zip_writer_->FinishEntry();
868 }
869 };
870 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800871 auto start = std::chrono::steady_clock::now();
872 auto end = start + timeout;
873 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800874
Felipe Leme770410d2016-01-26 17:07:14 -0800875 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800876 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800877 if (timeout.count() > 0) {
878 // lambda to recalculate the timeout.
879 auto time_left_ms = [end]() {
880 auto now = std::chrono::steady_clock::now();
881 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
882 return std::max(diff.count(), 0LL);
883 };
884
885 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
886 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000887 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
888 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800889 return -errno;
890 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000891 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 entry_name.c_str(), strerror(errno), timeout.count());
893 return TIMED_OUT;
894 }
895 }
896
Zach Riggle22200402016-08-18 01:01:24 -0400897 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800898 if (bytes_read == 0) {
899 break;
900 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800901 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800902 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700904 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700906 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800907 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800908 }
909 }
910
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700911 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000912 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700913 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700914 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800915 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916 }
917
Vishnu Naire97d6122018-01-18 13:58:56 -0800918 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800919}
920
Felipe Leme1d486fe2016-10-14 18:06:47 -0700921bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
922 android::base::unique_fd fd(
923 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700924 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800925 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800926 return false;
927 }
928
Vishnu Naire97d6122018-01-18 13:58:56 -0800929 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800930}
931
932/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700933static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800934 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800935}
936
Felipe Leme1d486fe2016-10-14 18:06:47 -0700937void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700938 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800939 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700940 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800941}
942
Felipe Leme1d486fe2016-10-14 18:06:47 -0700943bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800944 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000945 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
946 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700948 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800950 return false;
951 }
952
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700954 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700955 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700956 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800957 return false;
958 }
959
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700961 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700962 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800963 return false;
964 }
965
966 return true;
967}
968
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800969static void DoKmsg() {
970 struct stat st;
971 if (!stat(PSTORE_LAST_KMSG, &st)) {
972 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
973 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
974 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
975 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
976 } else {
977 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
978 DumpFile("LAST KMSG", "/proc/last_kmsg");
979 }
980}
981
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800982static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800983 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800984 RunCommand(
985 "KERNEL LOG",
986 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
987 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
988}
989
Nandana Duttdb379fa2019-10-09 16:54:41 +0100990static void DoSystemLogcat(time_t since) {
991 char since_str[80];
992 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
993
994 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
995 RunCommand("SYSTEM LOG",
996 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
997 since_str},
998 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
999}
1000
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001001static void DoRadioLogcat() {
1002 unsigned long timeout_ms = logcat_timeout({"radio"});
1003 RunCommand(
1004 "RADIO LOG",
1005 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1006 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1007}
1008
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001009static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001010 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001011 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1012 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001013 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001014 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001015 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1016 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001017 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001018 RunCommand(
1019 "EVENT LOG",
1020 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001021 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001022 timeout_ms = logcat_timeout({"stats"});
1023 RunCommand(
1024 "STATS LOG",
1025 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001026 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001027 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001028
1029 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1030
1031 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001032 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1033 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001034}
1035
Mike Ma5c267872019-08-21 11:31:34 -07001036static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001037 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1038 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1039 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1040 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1041 if (fd < 0) {
1042 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1043 return;
1044 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001045 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001046 bool empty = 0 == lseek(fd, 0, SEEK_END);
1047 if (!empty) {
1048 // Use a different name from "incident.proto"
1049 // /proto/incident.proto is reserved for incident service dump
1050 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001051 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1052 path);
1053 } else {
1054 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001055 }
Mike Ma5c267872019-08-21 11:31:34 -07001056}
1057
Aaron Huanga99452a2022-04-27 18:51:16 +08001058static void DumpNetstatsProto() {
1059 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1060 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1061 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1062 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1063 if (fd < 0) {
1064 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1065 return;
1066 }
1067 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1068 CommandOptions::WithTimeout(120).Build());
1069 bool empty = 0 == lseek(fd, 0, SEEK_END);
1070 if (!empty) {
1071 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1072 path);
1073 } else {
1074 unlink(path.c_str());
1075 }
1076}
1077
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001078static void MaybeAddSystemTraceToZip() {
1079 // This function copies into the .zip the system trace that was snapshotted
1080 // by the early call to MaybeSnapshotSystemTrace(), if any background
1081 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001082 if (!ds.has_system_trace_) {
1083 // No background trace was happening at the time dumpstate was invoked.
1084 return;
1085 }
1086 ds.AddZipEntry(
1087 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1088 SYSTEM_TRACE_SNAPSHOT);
1089 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1090}
1091
Sunny Goyal35949782019-11-19 15:54:36 -08001092static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001093 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1094 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1095 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1096 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1097 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1098 if (fd < 0) {
1099 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1100 return;
1101 }
1102 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001103 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001104 bool empty = 0 == lseek(fd, 0, SEEK_END);
1105 if (!empty) {
1106 ds.AddZipEntry("visible_windows.zip", path);
1107 } else {
1108 MYLOGW("Failed to dump visible windows\n");
1109 }
1110 unlink(path.c_str());
1111}
1112
Jayachandran Ca94c7172017-06-10 15:08:12 -07001113static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001114 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1115 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001116 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001117 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001118 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1119 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1120 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1121 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001122}
1123
Woody Lin20767a92022-11-29 15:50:24 +08001124static void DumpShutdownCheckpoints() {
1125 const bool shutdown_checkpoints_dumped = AddDumps(
1126 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1127 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1128 if (!shutdown_checkpoints_dumped) {
1129 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1130 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1131 }
1132}
1133
David Andersond9ba4752018-12-11 18:26:59 -08001134static void DumpDynamicPartitionInfo() {
1135 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1136 return;
1137 }
1138
1139 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001140 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001141}
1142
Chris Morin5a50d482022-02-01 17:41:18 -08001143static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001144 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1145 anr_traces_dir.c_str());
1146
1147 // If we're here, dump_traces_path will always be a temporary file
1148 // (created with mkostemp or similar) that contains dumps taken earlier
1149 // on in the process.
1150 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001151 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1152 dump_traces_path);
1153 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001154
1155 const int ret = unlink(dump_traces_path);
1156 if (ret == -1) {
1157 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1158 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001159 }
1160 }
1161
Narayan Kamathbd863722017-06-01 18:50:12 +01001162 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001163 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001164 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001165 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001166 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001167
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001168 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001169 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001170 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001171 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001172 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1173 }
1174}
1175
1176static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001177 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001178
Chris Morin5a50d482022-02-01 17:41:18 -08001179 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001180
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001181 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1182
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001183 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001184 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001185 int i = 0;
1186 while (true) {
1187 const std::string slow_trace_path =
1188 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1189 if (stat(slow_trace_path.c_str(), &st)) {
1190 // No traces file at this index, done with the files.
1191 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001192 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001193 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1194 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001195 }
1196}
1197
Wei Wang509bb5d2017-06-09 14:42:12 -07001198static void DumpBlockStatFiles() {
1199 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001200
Wei Wang1dc1ef52017-06-12 11:28:37 -07001201 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1202
1203 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001204 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1205 return;
1206 }
1207
1208 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001209 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001210 if ((d->d_name[0] == '.')
1211 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1212 || (d->d_name[1] == '\0'))) {
1213 continue;
1214 }
1215 const std::string new_path =
1216 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1217 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1218 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1219 printf("\n");
1220 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001221 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001222}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001223
1224static void DumpPacketStats() {
1225 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001226}
1227
1228static void DumpIpAddrAndRules() {
1229 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1230 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1231 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1232 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1233 RunCommand("IP RULES", {"ip", "rule", "show"});
1234 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1235}
1236
Nandana Dutt5c390032019-03-12 10:52:56 +00001237static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1238 std::chrono::milliseconds timeout,
1239 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001240 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001241 sp<android::IServiceManager> sm = defaultServiceManager();
1242 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001243 Vector<String16> args;
1244 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1246 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001247 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001248 std::string path(title);
1249 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001250 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001251 if (PropertiesHelper::IsDryRun()) {
1252 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1253 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1254 } else {
Devin Mooreae68df22023-02-24 20:59:51 +00001255 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID,
1256 service, args);
1257 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001258 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1259 std::chrono::duration<double> elapsed_seconds;
1260 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1261 service == String16("meminfo")) {
1262 // Use a longer timeout for meminfo, since 30s is not always enough.
1263 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1264 /* as_proto = */ false, elapsed_seconds,
1265 bytes_written);
1266 } else {
1267 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1268 /* as_proto = */ false, elapsed_seconds,
1269 bytes_written);
1270 }
1271 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1272 bool dump_complete = (status == OK);
1273 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001274 } else {
1275 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1276 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001277 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001278 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001279
1280 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1281 std::chrono::steady_clock::now() - start);
1282 if (elapsed_duration > timeout) {
1283 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1284 elapsed_duration.count());
1285 break;
1286 }
1287 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001288 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001289}
1290
Vishnu Nair64afc022018-02-01 15:29:34 -08001291static void RunDumpsysText(const std::string& title, int priority,
1292 std::chrono::milliseconds timeout,
1293 std::chrono::milliseconds service_timeout) {
1294 DurationReporter duration_reporter(title);
1295 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1296 fsync(STDOUT_FILENO);
1297 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1298}
1299
1300/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001301static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1302 std::chrono::milliseconds timeout,
1303 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001304 DurationReporter duration_reporter(title);
1305 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1306 fsync(STDOUT_FILENO);
1307 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1308 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001309
1310 RETURN_IF_USER_DENIED_CONSENT();
1311
1312 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1313 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001314}
1315
Nandana Dutt5c390032019-03-12 10:52:56 +00001316static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1317 std::chrono::milliseconds timeout,
1318 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001319 sp<android::IServiceManager> sm = defaultServiceManager();
1320 Dumpsys dumpsys(sm.get());
1321 Vector<String16> args;
1322 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1323 DurationReporter duration_reporter(title);
1324
1325 auto start = std::chrono::steady_clock::now();
1326 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1327 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001328 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001329 std::string path(kProtoPath);
1330 path.append(String8(service).c_str());
1331 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1332 path.append("_CRITICAL");
1333 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1334 path.append("_HIGH");
1335 }
1336 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001337 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001338 if (status == OK) {
1339 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1340 bool dumpTerminated = (status == OK);
1341 dumpsys.stopDumpThread(dumpTerminated);
1342 }
1343 ZipWriter::FileEntry file_entry;
1344 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001345
1346 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1347 std::chrono::steady_clock::now() - start);
1348 if (elapsed_duration > timeout) {
1349 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1350 elapsed_duration.count());
1351 break;
1352 }
1353 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001354 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001355}
1356
Nandana Dutta7db6342018-11-21 14:53:34 +00001357// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001358static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001359 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1360 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001361
1362 RETURN_IF_USER_DENIED_CONSENT();
1363
1364 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1365 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001366}
1367
1368// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001369static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001370 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1371 // high priority. Reduce timeout once they are able to dump in a shorter time or
1372 // moved to a parallel task.
1373 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1374 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001375
1376 RETURN_IF_USER_DENIED_CONSENT();
1377
1378 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1379 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001380}
1381
1382// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001383static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001384 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001385
1386 RETURN_IF_USER_DENIED_CONSENT();
1387
1388 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1389 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001390}
1391
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001392/*
1393 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1394 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1395 * if it's not running in the parallel task.
1396 */
1397static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001398 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001399 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1400 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001401
Steven Moreland44cd9482018-01-04 16:24:13 -08001402 using android::hidl::manager::V1_0::IServiceManager;
1403 using android::hardware::defaultServiceManager;
1404
1405 sp<IServiceManager> sm = defaultServiceManager();
1406 if (sm == nullptr) {
1407 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1408 return;
1409 }
1410
1411 auto ret = sm->list([&](const auto& interfaces) {
1412 for (const std::string& interface : interfaces) {
1413 std::string cleanName = interface;
1414 std::replace_if(cleanName.begin(),
1415 cleanName.end(),
1416 [](char c) {
1417 return !isalnum(c) &&
1418 std::string("@-_:.").find(c) == std::string::npos;
1419 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001420 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001421
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001422 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001423 {
1424 auto fd = android::base::unique_fd(
1425 TEMP_FAILURE_RETRY(open(path.c_str(),
1426 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1427 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1428 if (fd < 0) {
1429 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1430 continue;
1431 }
1432 RunCommandToFd(fd,
1433 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001434 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001435 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1436
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001437 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001438 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001439 if (!empty) {
1440 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1441 path);
1442 } else {
1443 unlink(path.c_str());
1444 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001445 }
1446 });
1447
1448 if (!ret.isOk()) {
1449 MYLOGE("Could not list hals from hwservicemanager.\n");
1450 }
1451}
1452
Devin Moore8df81bb2022-06-08 22:47:02 +00001453// Dump all of the files that make up the vendor interface.
1454// See the files listed in dumpFileList() for the latest list of files.
1455static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001456
1457 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1458 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001459 for (const auto vintfFile : vintfFiles) {
1460 struct stat st;
1461 if (stat(vintfFile.c_str(), &st) == 0) {
1462 if (S_ISDIR(st.st_mode)) {
1463 ds.AddDir(vintfFile, true /* recursive */);
1464 } else {
1465 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1466 vintfFile);
1467 }
1468 }
1469 }
1470}
1471
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001472static void DumpExternalFragmentationInfo() {
1473 struct stat st;
1474 if (stat("/proc/buddyinfo", &st) != 0) {
1475 MYLOGE("Unable to dump external fragmentation info\n");
1476 return;
1477 }
1478
1479 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1480 std::ifstream ifs("/proc/buddyinfo");
1481 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1482 for (std::string line; std::getline(ifs, line);) {
1483 std::smatch match_results;
1484 if (std::regex_match(line, match_results, unusable_index_regex)) {
1485 std::stringstream free_pages(std::string{match_results[3]});
1486 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1487 std::istream_iterator<int>());
1488
1489 int total_free_pages = 0;
1490 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1491 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1492 }
1493
1494 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1495 match_results[2].str().c_str());
1496
1497 int usable_free_pages = total_free_pages;
1498 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1499 auto unusable_index = (total_free_pages - usable_free_pages) /
1500 static_cast<double>(total_free_pages);
1501 printf(" %5.3f", unusable_index);
1502 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1503 }
1504
1505 printf("\n");
1506 }
1507 }
1508 printf("\n");
1509}
1510
mhasankd451a472020-05-26 18:02:39 -07001511static void DumpstateLimitedOnly() {
1512 // Trimmed-down version of dumpstate to only include a whitelisted
1513 // set of logs (system log, event log, and system server / system app
1514 // crashes, and networking logs). See b/136273873 and b/138459828
1515 // for context.
1516 DurationReporter duration_reporter("DUMPSTATE");
1517 unsigned long timeout_ms;
1518 // calculate timeout
1519 timeout_ms = logcat_timeout({"main", "system", "crash"});
1520 RunCommand("SYSTEM LOG",
1521 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1522 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1523 timeout_ms = logcat_timeout({"events"});
1524 RunCommand(
1525 "EVENT LOG",
1526 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1527 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1528
1529 printf("========================================================\n");
1530 printf("== Networking Service\n");
1531 printf("========================================================\n");
1532
1533 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1534 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001535 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1536 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001537
1538 printf("========================================================\n");
1539 printf("== Dropbox crashes\n");
1540 printf("========================================================\n");
1541
1542 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1543 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1544
1545 printf("========================================================\n");
1546 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1547 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1548 printf("========================================================\n");
1549 printf("== dumpstate: done (id %d)\n", ds.id_);
1550 printf("========================================================\n");
1551}
1552
Rhed Jaoe017f982020-07-21 17:58:41 +08001553/*
1554 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1555 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1556 * if it's not running in the parallel task.
1557 */
1558static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1559 dprintf(out_fd, "========================================================\n");
1560 dprintf(out_fd, "== Checkins\n");
1561 dprintf(out_fd, "========================================================\n");
1562
1563 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001564 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1565 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1566 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1567 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1568}
1569
1570/*
1571 * Runs dumpsys on activity service to dump all application activities, services
1572 * and providers in the device.
1573 *
1574 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1575 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1576 * if it's not running in the parallel task.
1577 */
1578static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1579 dprintf(out_fd, "========================================================\n");
1580 dprintf(out_fd, "== Running Application Activities\n");
1581 dprintf(out_fd, "========================================================\n");
1582
1583 // The following dumpsys internally collects output from running apps, so it can take a long
1584 // time. So let's extend the timeout.
1585
1586 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1587
1588 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1589
1590 dprintf(out_fd, "========================================================\n");
1591 dprintf(out_fd, "== Running Application Services (platform)\n");
1592 dprintf(out_fd, "========================================================\n");
1593
1594 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1595 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1596
1597 dprintf(out_fd, "========================================================\n");
1598 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1599 dprintf(out_fd, "========================================================\n");
1600
1601 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1602 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1603
1604 dprintf(out_fd, "========================================================\n");
1605 dprintf(out_fd, "== Running Application Providers (platform)\n");
1606 dprintf(out_fd, "========================================================\n");
1607
1608 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001609 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001610
1611 dprintf(out_fd, "========================================================\n");
1612 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1613 dprintf(out_fd, "========================================================\n");
1614
1615 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1616 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1617}
1618
Nandana Dutt5c390032019-03-12 10:52:56 +00001619// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1620// via the consent they are shown. Ignores other errors that occur while running various
1621// commands. The consent checking is currently done around long running tasks, which happen to
1622// be distributed fairly evenly throughout the function.
1623static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001624 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001625
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001626 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001627 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1628 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001629 if (ds.dump_pool_) {
1630 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1631 // drop root user. Restarts it with two threads for the parallel run.
1632 ds.dump_pool_->start(/* thread_counts = */2);
1633
Chris Morinbc223142022-02-04 14:17:11 -08001634 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1635 dump_incident_report = ds.dump_pool_->enqueueTask(
1636 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001637 dump_netstats_report = ds.dump_pool_->enqueueTask(
1638 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001639 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1640 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1641 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001642 }
1643
Nandana Dutt5c390032019-03-12 10:52:56 +00001644 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1645 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1646 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001647 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001648 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001649 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001650 DumpFile("MEMORY INFO", "/proc/meminfo");
1651 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001652 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001653
Kevin Jeon947922b2022-09-21 00:29:18 +00001654 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1655 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001656
Sunny Goyal35949782019-11-19 15:54:36 -08001657 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1658
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001659 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1660 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1661 DumpFile("SLAB INFO", "/proc/slabinfo");
1662 DumpFile("ZONEINFO", "/proc/zoneinfo");
1663 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1664 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001665 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001666
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001667 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001668
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001669 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001670 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001671
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001672 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001673 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001674 } else {
1675 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1676 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001677
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001678 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001679 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001680 struct stat s;
1681 if (stat("/proc/modules", &s) != 0) {
1682 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1683 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001684 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001685 RunCommand("MODULES INFO",
1686 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1687 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1688 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001689 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001690
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001691 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001692 DoKernelLogcat();
1693 } else {
1694 do_dmesg();
1695 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001696
Devin Moore8df81bb2022-06-08 22:47:02 +00001697 DumpVintf();
1698
Felipe Lemef0292972016-11-22 13:57:05 -08001699 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001700
Jeff Brown1dc94e32014-09-11 14:15:27 -07001701 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001702 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Jack Yu5a6b2e22020-08-14 18:13:35 +08001704 /* Dump Nfc NCI logs */
1705 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001706
Paul Chang0d2aad72020-02-13 20:04:03 +08001707 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001708 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001709 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001710 }
1711
Felipe Lemee184f662016-10-27 10:04:47 -07001712 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001713
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001714 MaybeAddSystemTraceToZip();
1715
Narayan Kamath8f788292017-05-25 13:20:39 +01001716 // NOTE: tombstones are always added as separate entries in the zip archive
1717 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001718 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001719 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001720 if (!tombstones_dumped) {
1721 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001722 }
1723
Jayachandran Ca94c7172017-06-10 15:08:12 -07001724 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001725
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001726 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001727
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001728 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001729
Woody Lin20767a92022-11-29 15:50:24 +08001730 DumpShutdownCheckpoints();
1731
Jayachandran Ca94c7172017-06-10 15:08:12 -07001732 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001733
1734 dump_route_tables();
1735
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001736 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1737 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1738 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001739
Nandana Dutt5c390032019-03-12 10:52:56 +00001740 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001741
Chiachang Wang668ede42021-05-17 17:14:20 +08001742 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1743 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1744 // dump with priority parameters to dump high priority information.
1745 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1746 CommandOptions::WithTimeout(10).Build());
1747
Elliott Hughes23ccc622017-02-28 10:14:22 -08001748 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001749
Jin Qianf334d662017-10-10 14:41:37 -07001750 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001751
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001752 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001753
Colin Crossf45fa6b2012-03-26 12:38:26 -07001754 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001755 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1756 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1757
1758 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1759 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1760 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1761 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1762 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001763
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001764 /* Add window and surface trace files. */
1765 if (!PropertiesHelper::IsUserBuild()) {
1766 ds.AddDir(WMTRACE_DATA_DIR, false);
1767 }
1768
Yifan Hongd90cc652020-02-08 16:52:02 -08001769 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1770
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001771 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001772 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001773 } else {
1774 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1775 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001776
Steven Moreland7440ddb2016-12-15 16:13:39 -08001777 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001778 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1779 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001780 // su does not exist on user builds, so try running without it.
1781 // This way any implementations of vril-dump that do not require
1782 // root can run on user builds.
1783 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001784 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001785 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001786 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001787 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001788 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001789 }
1790
Felipe Lemed8b94e52016-12-08 10:21:44 -08001791 printf("========================================================\n");
1792 printf("== Android Framework Services\n");
1793 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001794
Nandana Dutt5c390032019-03-12 10:52:56 +00001795 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001796
Jack He91ff2fe2021-02-18 18:23:43 -08001797 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1798 ds.AddDir("/data/misc/bluetooth/logs", true);
1799
Rhed Jaoe017f982020-07-21 17:58:41 +08001800 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001801 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001802 } else {
1803 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1804 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001805
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001806 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001807
Adrian Roos8b397ab2017-04-04 16:35:44 -07001808 printf("========================================================\n");
1809 printf("== Dropbox crashes\n");
1810 printf("========================================================\n");
1811
1812 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1813 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1814
Felipe Lemed8b94e52016-12-08 10:21:44 -08001815 printf("========================================================\n");
1816 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1817 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1818 printf("========================================================\n");
1819 printf("== dumpstate: done (id %d)\n", ds.id_);
1820 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001821
1822 printf("========================================================\n");
1823 printf("== Obtaining statsd metadata\n");
1824 printf("========================================================\n");
1825 // This differs from the usual dumpsys stats, which is the stats report data.
1826 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001827
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001828 // Add linker configuration directory
1829 ds.AddDir(LINKERCONFIG_DIR, true);
1830
Li Li830179f2022-01-04 12:53:29 -08001831 /* Dump frozen cgroupfs */
1832 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001833
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001834 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001835 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1836 } else {
1837 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1838 DumpNetstatsProto);
1839 }
1840
1841 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001842 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001843 } else {
1844 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1845 DumpIncidentReport);
1846 }
Mike Ma5c267872019-08-21 11:31:34 -07001847
Nandana Dutt5c390032019-03-12 10:52:56 +00001848 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001849}
1850
Nandana Dutt5c390032019-03-12 10:52:56 +00001851/*
1852 * Dumps state for the default case; drops root after it's no longer necessary.
1853 *
1854 * Returns RunStatus::OK if everything went fine.
1855 * Returns RunStatus::ERROR if there was an error.
1856 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1857 * with the caller.
1858 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001859Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001860 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1861 // buffer.
1862 DoLogcat();
1863 // Capture timestamp after first logcat to use in next logcat
1864 time_t logcat_ts = time(nullptr);
1865
Nandana Dutt4be45d12018-09-26 15:04:23 +01001866 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001867 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001868 if (dump_pool_) {
1869 RETURN_IF_USER_DENIED_CONSENT();
1870 // One thread is enough since we only need to enqueue DumpTraces here.
1871 dump_pool_->start(/* thread_counts = */1);
1872
1873 // DumpTraces takes long time, post it to the another thread in the
1874 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001875 dump_traces = dump_pool_->enqueueTask(
1876 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001877 } else {
1878 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1879 &dump_traces_path);
1880 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001881
1882 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001883 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001884 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1885 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001886 ds.shutdown_checkpoints_ = GetDumpFds(
1887 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001888 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001889
1890 ds.AddDir(RECOVERY_DIR, true);
1891 ds.AddDir(RECOVERY_DATA_DIR, true);
1892 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001893 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001894 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1895 if (!PropertiesHelper::IsUserBuild()) {
1896 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1897 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001898 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001899 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001900 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001901 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001902 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1903 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1904 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001905 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001906 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001907 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001908 if (!PropertiesHelper::IsUserBuild()) {
1909 // Include dropbox entry files inside ZIP, but exclude
1910 // noisy WTF and StrictMode entries
1911 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1912 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001913
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001914 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001915 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1916
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001917 // Dump IPsec stats. No keys are exposed here.
1918 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1919
Nandana Dutt4be45d12018-09-26 15:04:23 +01001920 // Run ss as root so we can see socket marks.
1921 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1922
1923 // Run iotop as root to show top 100 IO threads
1924 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1925
Erick Reyese68df822019-02-11 14:46:36 -08001926 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001927 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1928 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001929
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001930 DumpFile("PSI cpu", "/proc/pressure/cpu");
1931 DumpFile("PSI memory", "/proc/pressure/memory");
1932 DumpFile("PSI io", "/proc/pressure/io");
1933
Mårten Kongstad60195a72022-09-20 14:14:20 +02001934 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1935 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1936
Rhed Jao5377d792020-07-16 17:37:39 +08001937 if (dump_pool_) {
1938 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001939 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001940
Chris Morinbc223142022-02-04 14:17:11 -08001941 // Current running thread in the pool is the root user also. Delete
1942 // the pool and make a new one later to ensure none of threads in the pool are root.
1943 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001944 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001945 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001946 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001947 }
1948
Nandana Dutt5c390032019-03-12 10:52:56 +00001949 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001950 Dumpstate::RunStatus status = dumpstate();
1951 // Capture logcat since the last time we did it.
1952 DoSystemLogcat(logcat_ts);
1953 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001954}
1955
Rhed Jaob5685b32020-08-14 17:19:17 +08001956// Common states for telephony and wifi which are needed to be collected before
1957// dumpstate drop the root user.
1958static void DumpstateRadioAsRoot() {
1959 DumpIpTablesAsRoot();
1960 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1961}
1962
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001963// This method collects common dumpsys for telephony and wifi. Typically, wifi
1964// reports are fine to include all information, but telephony reports on user
1965// builds need to strip some content (see DumpstateTelephonyOnly).
1966static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001967 // We need to be picky about some stuff for telephony reports on user builds.
1968 if (!include_sensitive_info) {
1969 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1970 DoRadioLogcat();
1971 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001972 // DumpHals takes long time, post it to the another thread in the pool,
1973 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001974 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001975 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001976 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001977 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001978 // Contains various system properties and process startup info.
1979 do_dmesg();
1980 // Logs other than the radio buffer may contain package/component names and potential PII.
1981 DoLogcat();
1982 // Too broad for connectivity problems.
1983 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001984 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1985 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001986 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001987 } else {
1988 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1989 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001990 }
1991
Jayachandran Ca94c7172017-06-10 15:08:12 -07001992 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001993 DumpIpAddrAndRules();
1994 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001995 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1996 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001997}
1998
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001999// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2000// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2001// for what can be included on user builds: all reported information MUST directly relate to
2002// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2003// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2004// names are not), and MUST NOT contain logs of user application traffic.
2005// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002006static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002007 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002008
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002009 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002010
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002011 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002012
Rhed Jaob5685b32020-08-14 17:19:17 +08002013 DumpstateRadioAsRoot();
2014 if (!DropRootUser()) {
2015 return;
2016 }
2017
2018 // Starts thread pool after the root user is dropped, and two additional threads
2019 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002020 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002021 if (ds.dump_pool_) {
2022 ds.dump_pool_->start(/*thread_counts =*/2);
2023
2024 // DumpstateBoard takes long time, post it to the another thread in the pool,
2025 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002026 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2027 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002028 }
2029
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002030 DumpstateRadioCommon(include_sensitive_info);
2031
2032 if (include_sensitive_info) {
2033 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2034 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2035 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2036 // way.
2037 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2038 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002039
2040 printf("========================================================\n");
2041 printf("== Android Framework Services\n");
2042 printf("========================================================\n");
2043
Vishnu Nair652cc802017-11-30 15:18:30 -08002044 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2045 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002046 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2047 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002048 if (include_sensitive_info) {
2049 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2050 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2051 SEC_TO_MSEC(10));
2052 } else {
2053 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2054 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2055 // give a higher timeout as well.
2056 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2057 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2058 }
2059 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002060 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2061 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002062 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002063 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2064 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002065 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2066 SEC_TO_MSEC(10));
Grant Menke9bf3b2b2023-02-24 13:11:07 -08002067 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2068 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002069 if (include_sensitive_info) {
2070 // Contains raw IP addresses, omit from reports on user builds.
2071 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2072 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2073 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2074 SEC_TO_MSEC(10));
2075 // Contains package/component names, omit from reports on user builds.
2076 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2077 SEC_TO_MSEC(10));
2078 // Contains package names, but should be relatively simple to remove them (also contains
2079 // UIDs already), omit from reports on user builds.
2080 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2081 SEC_TO_MSEC(10));
2082 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002083
2084 printf("========================================================\n");
2085 printf("== Running Application Services\n");
2086 printf("========================================================\n");
2087
2088 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2089
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002090 if (include_sensitive_info) {
2091 printf("========================================================\n");
2092 printf("== Running Application Services (non-platform)\n");
2093 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002094
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002095 // Contains package/component names and potential PII, omit from reports on user builds.
2096 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2097 // carrier_config dumpsys instead.
2098 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2099 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002100
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002101 printf("========================================================\n");
2102 printf("== Checkins\n");
2103 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002104
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002105 // Contains package/component names, omit from reports on user builds.
2106 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2107 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002108
2109 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002110 printf("== dumpstate: done (id %d)\n", ds.id_);
2111 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002112
2113 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002114 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002115 } else {
2116 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2117 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002118}
2119
mukesh agrawal253dad42018-01-23 21:59:59 -08002120// This method collects dumpsys for wifi debugging only
2121static void DumpstateWifiOnly() {
2122 DurationReporter duration_reporter("DUMPSTATE");
2123
Rhed Jaob5685b32020-08-14 17:19:17 +08002124 DumpstateRadioAsRoot();
2125 if (!DropRootUser()) {
2126 return;
2127 }
2128
2129 // Starts thread pool after the root user is dropped. Only one additional
2130 // thread is needed for DumpHals in the DumpstateRadioCommon.
2131 if (ds.dump_pool_) {
2132 ds.dump_pool_->start(/*thread_counts =*/1);
2133 }
2134
mukesh agrawal253dad42018-01-23 21:59:59 -08002135 DumpstateRadioCommon();
2136
2137 printf("========================================================\n");
2138 printf("== Android Framework Services\n");
2139 printf("========================================================\n");
2140
2141 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2142 SEC_TO_MSEC(10));
2143 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2144 SEC_TO_MSEC(10));
2145
2146 printf("========================================================\n");
2147 printf("== dumpstate: done (id %d)\n", ds.id_);
2148 printf("========================================================\n");
2149}
2150
Nandana Duttcf419a72019-03-14 10:40:17 +00002151Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002152 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002153 const size_t buf_size = temp_file_pattern.length() + 1;
2154 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2155 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2156
2157 // Create a new, empty file to receive all trace dumps.
2158 //
2159 // TODO: This can be simplified once we remove support for the old style
2160 // dumps. We can have a file descriptor passed in to dump_traces instead
2161 // of creating a file, closing it and then reopening it again.
2162 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2163 if (fd < 0) {
2164 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002165 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002166 }
2167
2168 // Nobody should have access to this temporary file except dumpstate, but we
2169 // temporarily grant 'read' to 'others' here because this file is created
2170 // when tombstoned is still running as root, but dumped after dropping. This
2171 // can go away once support for old style dumping has.
2172 const int chmod_ret = fchmod(fd, 0666);
2173 if (chmod_ret < 0) {
2174 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002175 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002176 }
2177
2178 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2179 if (proc.get() == nullptr) {
2180 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002181 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002182 }
2183
2184 // Number of times process dumping has timed out. If we encounter too many
2185 // failures, we'll give up.
2186 int timeout_failures = 0;
2187 bool dalvik_found = false;
2188
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002189 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002190
2191 struct dirent* d;
2192 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002193 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002194 int pid = atoi(d->d_name);
2195 if (pid <= 0) {
2196 continue;
2197 }
2198
Kevin Jeond0f8a982023-04-07 14:27:11 -04002199 // Skip cached processes.
2200 if (IsCached(pid)) {
2201 // For consistency, the header and footer to this message match those
2202 // dumped by debuggerd in the success case.
2203 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2204 dprintf(fd, "Dump skipped for cached process.\n");
2205 dprintf(fd, "---- end %d ----", pid);
2206 continue;
2207 }
2208
Nandana Duttfaafd522019-03-11 09:23:09 +00002209 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2210 std::string exe;
2211 if (!android::base::Readlink(link_name, &exe)) {
2212 continue;
2213 }
2214
2215 bool is_java_process;
2216 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2217 // Don't bother dumping backtraces for the zygote.
2218 if (IsZygote(pid)) {
2219 continue;
2220 }
2221
2222 dalvik_found = true;
2223 is_java_process = true;
2224 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2225 is_java_process = false;
2226 } else {
2227 // Probably a native process we don't care about, continue.
2228 continue;
2229 }
2230
2231 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2232 if (timeout_failures == 3) {
2233 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2234 break;
2235 }
2236
2237 const uint64_t start = Nanotime();
2238 const int ret = dump_backtrace_to_file_timeout(
2239 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2240 is_java_process ? 5 : 20, fd);
2241
2242 if (ret == -1) {
2243 // For consistency, the header and footer to this message match those
2244 // dumped by debuggerd in the success case.
2245 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2246 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2247 dprintf(fd, "---- end %d ----", pid);
2248 timeout_failures++;
2249 continue;
2250 }
2251
2252 // We've successfully dumped stack traces, reset the failure count
2253 // and write a summary of the elapsed time to the file and continue with the
2254 // next process.
2255 timeout_failures = 0;
2256
2257 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2258 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2259 }
2260
2261 if (!dalvik_found) {
2262 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2263 }
2264
Nandana Duttcf419a72019-03-14 10:40:17 +00002265 *path = file_name_buf.release();
2266 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002267}
2268
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002269static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2270 const Dumpstate::BugreportMode bugreport_mode) {
2271 switch (bugreport_mode) {
2272 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2273 return dumpstate_hal_hidl::DumpstateMode::FULL;
2274 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2275 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2276 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2277 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2278 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2279 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2280 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2281 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2282 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2283 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2284 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2285 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2286 }
2287 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2288}
2289
2290static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2291 const Dumpstate::BugreportMode bugreport_mode) {
2292 switch (bugreport_mode) {
2293 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2294 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2295 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2296 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2297 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2298 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2299 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2300 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2301 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2302 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2303 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2304 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2305 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2306 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2307 }
2308 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2309}
2310
2311static void DoDumpstateBoardHidl(
2312 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2313 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2314 const Dumpstate::BugreportMode bugreport_mode,
2315 const size_t timeout_sec) {
2316
2317 using ScopedNativeHandle =
2318 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2319 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2320 [](native_handle_t* handle) {
2321 // we don't close file handle's here
2322 // via native_handle_close(handle)
2323 // instead we let dumpstate_fds close the file handles when
2324 // dumpstate_fds gets destroyed
2325 native_handle_delete(handle);
2326 });
2327 if (handle == nullptr) {
2328 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2329 return;
2330 }
2331
2332 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2333 handle.get()->data[i] = dumpstate_fds[i].get();
2334 }
2335
2336 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2337 // implement just 1.0.
2338 const char* descriptor_to_kill;
2339 using DumpstateBoardTask = std::packaged_task<bool()>;
2340 DumpstateBoardTask dumpstate_board_task;
2341 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2342 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2343 if (dumpstate_hal != nullptr) {
2344 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2345
2346 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2347 GetDumpstateHalModeHidl(bugreport_mode);
2348
2349 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2350 dumpstate_board_task =
2351 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2352 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2353 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2354 SEC_TO_MSEC(timeout_sec));
2355 if (!status.isOk()) {
2356 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2357 return false;
2358 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2359 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2360 dumpstate_hal_hidl::toString(status).c_str());
2361 return false;
2362 }
2363 return true;
2364 });
2365 } else {
2366 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2367
2368 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2369 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2370 ::android::hardware::Return<void> status =
2371 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2372 if (!status.isOk()) {
2373 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2374 return false;
2375 }
2376 return true;
2377 });
2378 }
2379 auto result = dumpstate_board_task.get_future();
2380 std::thread(std::move(dumpstate_board_task)).detach();
2381
2382 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2383 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2384 if (!android::base::SetProperty(
2385 "ctl.interface_restart",
2386 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2387 MYLOGE("Couldn't restart dumpstate HAL\n");
2388 }
2389 }
2390 // Wait some time for init to kill dumpstate vendor HAL
2391 constexpr size_t killing_timeout_sec = 10;
2392 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2393 MYLOGE(
2394 "killing dumpstateBoard timed out after %zus, continue and "
2395 "there might be racing in content\n",
2396 killing_timeout_sec);
2397 }
2398}
2399
2400static void DoDumpstateBoardAidl(
2401 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2402 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2403 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2404 MYLOGI("Using IDumpstateDevice AIDL HAL");
2405
2406 const char* descriptor_to_kill;
2407 using DumpstateBoardTask = std::packaged_task<bool()>;
2408 DumpstateBoardTask dumpstate_board_task;
2409 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2410 GetDumpstateHalModeAidl(bugreport_mode);
2411
2412 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2413 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2414 timeout_sec]() -> bool {
2415 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2416
2417 if (!status.isOk()) {
2418 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2419 return false;
2420 }
2421 return true;
2422 });
2423 auto result = dumpstate_board_task.get_future();
2424 std::thread(std::move(dumpstate_board_task)).detach();
2425
2426 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2427 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2428 if (!android::base::SetProperty(
2429 "ctl.interface_restart",
2430 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2431 MYLOGE("Couldn't restart dumpstate HAL\n");
2432 }
2433 }
2434 // Wait some time for init to kill dumpstate vendor HAL
2435 constexpr size_t killing_timeout_sec = 10;
2436 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2437 MYLOGE(
2438 "killing dumpstateBoard timed out after %zus, continue and "
2439 "there might be racing in content\n",
2440 killing_timeout_sec);
2441 }
2442}
2443
2444static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2445 const std::string aidl_instance_name =
2446 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2447
2448 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2449 return nullptr;
2450 }
2451
2452 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2453
2454 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2455}
2456
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002457void Dumpstate::DumpstateBoard(int out_fd) {
2458 dprintf(out_fd, "========================================================\n");
2459 dprintf(out_fd, "== Board\n");
2460 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002461
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002462 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002463 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002464 * set to true and unmount it after invoking dumpstateBoard_* methods.
2465 * This is to enable debug builds to not have debugfs mounted during runtime.
2466 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002467 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002468 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002469 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002470 if (mount_debugfs) {
2471 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2472 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002473 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002474 }
2475
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002476 std::vector<std::string> paths;
2477 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002478 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002479 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2480 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002481 remover.emplace_back(android::base::make_scope_guard(
2482 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002483 }
Jie Song9fbfad02017-06-20 16:29:42 -07002484
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002485 // get dumpstate HAL AIDL implementation
2486 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2487 GetDumpstateBoardAidlService());
2488 if (dumpstate_hal_handle_aidl == nullptr) {
2489 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2490 }
2491
2492 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2493 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2494 if (dumpstate_hal_handle_aidl == nullptr) {
2495 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2496 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2497 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2498 }
2499 }
2500
2501 // if neither HIDL nor AIDL implementation found, then return
2502 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2503 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002504 return;
2505 }
2506
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002507 // this is used to hold the file descriptors and when this variable goes out of scope
2508 // the file descriptors are closed
2509 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002510
Nandana Dutt5c390032019-03-12 10:52:56 +00002511 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002512 for (size_t i = 0; i < paths.size(); i++) {
2513 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2514
2515 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2516 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2517 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2518 if (fd < 0) {
2519 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2520 return;
2521 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002522
2523 dumpstate_fds.emplace_back(fd.release());
2524 // we call fd.release() here to make sure "fd" does not get closed
2525 // after "fd" goes out of scope after this block.
2526 // "fd" will be closed when "dumpstate_fds" goes out of scope
2527 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002528 }
2529
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002530 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2531 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2532 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002533 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002534
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002535 if (dumpstate_hal_handle_aidl != nullptr) {
2536 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2537 timeout_sec);
2538 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2539 // run HIDL HAL only if AIDL HAL not found
2540 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2541 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002542 }
2543
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002544 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002545 auto keep_debugfs_mounted =
2546 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2547 if (keep_debugfs_mounted.empty())
2548 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002549 }
2550
Wei Wang587eac92018-04-05 12:17:20 -07002551 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2552 for (size_t i = 0; i < paths.size(); i++) {
2553 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002554 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2555 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002556 file_sizes[i] = -1;
2557 continue;
2558 }
2559 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002560 }
2561
2562 for (size_t i = 0; i < paths.size(); i++) {
2563 if (file_sizes[i] == -1) {
2564 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002565 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002566 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002567 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002568 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002569 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002570 remover[i].Disable();
2571 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2572 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002573 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002574}
2575
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002576static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002577 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002578 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2579 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002580 " -h: display this help message\n"
2581 " -b: play sound file instead of vibrate, at beginning of job\n"
2582 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002583 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002584 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002585 " -s: write zipped file to control socket (for init)\n"
2586 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002587 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002588 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002589 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002590 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002591 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002592 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002593}
2594
Wei Liuf87959e2016-08-26 14:51:42 -07002595static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002596 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002597}
2598
Felipe Leme1d486fe2016-10-14 18:06:47 -07002599bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002600 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2601 if (zip_entry_tasks_) {
2602 zip_entry_tasks_->run(/* do_cancel = */false);
2603 }
2604
Felipe Leme9a523ae2016-10-20 15:10:33 -07002605 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002606 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002607 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002608 // Final timestamp
2609 char date[80];
2610 time_t the_real_now_please_stand_up = time(nullptr);
2611 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002612 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002613 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002614
Felipe Leme9a523ae2016-10-20 15:10:33 -07002615 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002616 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002617 return false;
2618 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002619 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002620 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002621 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002622 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002623
Felipe Leme0f3fb202016-06-10 17:10:53 -07002624 // Add log file (which contains stderr output) to zip...
2625 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002626 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002627 MYLOGE("Failed to add dumpstate log to .zip file\n");
2628 return false;
2629 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002630 // TODO: Should truncate the existing file.
2631 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002632 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2633 return false;
2634 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002635 fprintf(stderr, "\n");
2636
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002637 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002638 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002639 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002640 return false;
2641 }
2642
Felipe Leme1d486fe2016-10-14 18:06:47 -07002643 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2644 ds.zip_file.reset(nullptr);
2645
Felipe Lemee9d2c542016-11-15 11:48:26 -08002646 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002647 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002648
Felipe Leme1e9edc62015-12-21 16:02:13 -08002649 return true;
2650}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002651
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002652static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2653 // clang-format off
2654 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2655 "--receiver-foreground", "--receiver-include-background", "-a", action};
2656 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002657
2658 am.insert(am.end(), args.begin(), args.end());
2659
Felipe Leme8d2410e2017-02-08 09:46:08 -08002660 RunCommand("", am,
2661 CommandOptions::WithTimeout(20)
2662 .Log("Sending broadcast: '%s'\n")
2663 .Always()
2664 .DropRoot()
2665 .RedirectStderr()
2666 .Build());
2667}
2668
Felipe Leme35b8cf12017-02-10 15:47:29 -08002669static void Vibrate(int duration_ms) {
2670 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002671 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2672 "oneshot", std::to_string(duration_ms)};
2673 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002674 CommandOptions::WithTimeout(10)
2675 .Log("Vibrate: '%s'\n")
2676 .Always()
2677 .Build());
2678 // clang-format on
2679}
2680
Nandana Dutt979388e2018-11-30 16:48:55 +00002681static void MaybeResolveSymlink(std::string* path) {
2682 std::string resolved_path;
2683 if (android::base::Readlink(*path, &resolved_path)) {
2684 *path = resolved_path;
2685 }
2686}
2687
Nandana Dutt4be45d12018-09-26 15:04:23 +01002688/*
2689 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002690 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002691 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002692static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002693 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2694
Nandana Dutt4be45d12018-09-26 15:04:23 +01002695 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2696 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002697 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002698 char date[80];
2699 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2700 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002701
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002702 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002703 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002704 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002705 ds.base_name_ += "-wifi";
2706 }
2707
Paul Chang0d2aad72020-02-13 20:04:03 +08002708 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002709 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002710 }
2711 ds.tmp_path_ = ds.GetPath(".tmp");
2712 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2713
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002714 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002715 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002716 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002717 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002718 "Bugreport dir: [%s] "
2719 "Base name: [%s] "
2720 "Suffix: [%s] "
2721 "Log path: [%s] "
2722 "Temporary path: [%s] "
2723 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002724 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2725 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002726
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002727 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2728 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2729 create_parent_dirs(ds.path_.c_str());
2730 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2731 if (ds.zip_file == nullptr) {
2732 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2733 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002734 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002735 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2736 ds.AddTextZipEntry("version.txt", ds.version_);
2737 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002738}
2739
2740/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002741 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002742 * printing zipped file status, etc.
2743 */
2744static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002745 bool do_text_file = !ds.FinishZipFile();
2746 if (do_text_file) {
2747 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002748 }
mhasank2d75c442020-06-11 15:05:25 -07002749
2750 std::string final_path = ds.path_;
2751 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002752 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002753 android::os::CopyFileToFile(ds.path_, final_path);
2754 }
2755
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002756 if (ds.options_->stream_to_socket) {
2757 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2758 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002759 if (do_text_file) {
2760 dprintf(ds.control_socket_fd_,
2761 "FAIL:could not create zip file, check %s "
2762 "for more details\n",
2763 ds.log_path_.c_str());
2764 } else {
mhasank2d75c442020-06-11 15:05:25 -07002765 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002766 }
2767 }
2768}
2769
Nandana Dutt4be45d12018-09-26 15:04:23 +01002770
Nandana Dutt58d72e22018-11-16 10:30:48 +00002771static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2772 switch (mode) {
2773 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2774 return "BUGREPORT_FULL";
2775 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2776 return "BUGREPORT_INTERACTIVE";
2777 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2778 return "BUGREPORT_REMOTE";
2779 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2780 return "BUGREPORT_WEAR";
2781 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2782 return "BUGREPORT_TELEPHONY";
2783 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2784 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002785 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2786 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002787 }
2788}
2789
Paul Changf59c2b72020-03-10 02:08:55 +08002790static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2791 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002792 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2793 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002794 options->bugreport_mode = mode;
2795 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002796 switch (mode) {
2797 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002798 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002799 break;
2800 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002801 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002802 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002803 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002804 break;
2805 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002806 options->do_vibrate = false;
2807 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002808 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002809 break;
2810 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002811 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002812 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002813 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002814 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002815 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002817 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002818 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002819 break;
2820 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002821 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002822 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002823 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002824 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2825 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002826 }
2827}
2828
Nandana Dutt58d72e22018-11-16 10:30:48 +00002829static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002830 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002831 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002832 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002833 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002834 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002835 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002836 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002837 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002838 options.do_progress_updates, options.bugreport_fd.get(),
2839 options.bugreport_mode_string.c_str(),
2840 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002841}
2842
Nandana Dutt54dbd672019-01-11 12:58:05 +00002843void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2844 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002845 const android::base::unique_fd& screenshot_fd_in,
2846 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002847 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002848 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2849 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002850
Paul Changf59c2b72020-03-10 02:08:55 +08002851 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002852}
2853
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002854Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2855 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002856 int c;
mhasankd451a472020-05-26 18:02:39 -07002857 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002858 switch (c) {
2859 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002860 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002861 case 's': stream_to_socket = true; break;
2862 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002863 case 'v': show_header_only = true; break;
2864 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002865 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002866 case 'P': do_progress_updates = true; break;
2867 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002868 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002869 case 'V':
2870 case 'd':
2871 case 'z':
2872 // compatibility no-op
2873 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002874 case 'w':
2875 // This was already processed
2876 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002877 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002878 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002879 break;
2880 default:
2881 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002882 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002883 break;
2884 // clang-format on
2885 }
2886 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002887
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002888 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002889 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002890 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002891 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002892 }
2893 }
2894
2895 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2896 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002897
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002898 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002899}
2900
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002901bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002902 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002903 return false;
2904 }
2905
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002906 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002907 return false;
2908 }
2909
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002910 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002911 return false;
2912 }
2913 return true;
2914}
2915
Nandana Dutt197661d2018-11-16 16:40:21 +00002916void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2917 options_ = std::move(options);
2918}
2919
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002920void Dumpstate::Initialize() {
2921 /* gets the sequential id */
2922 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2923 id_ = ++last_id;
2924 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2925}
2926
Nandana Duttd2f5f082019-01-18 17:13:52 +00002927Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2928 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002929 if (listener_ != nullptr) {
2930 switch (status) {
2931 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002932 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002933 break;
2934 case Dumpstate::RunStatus::HELP:
2935 break;
2936 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002937 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002938 break;
2939 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002940 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2941 break;
2942 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2943 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2944 break;
2945 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2946 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002947 break;
2948 }
2949 }
2950 return status;
2951}
2952
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002953void Dumpstate::Cancel() {
2954 CleanupTmpFiles();
2955 android::os::UnlinkAndLogOnError(log_path_);
2956 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2957 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2958 kDumpstateBoardFiles[i]);
2959 }
2960 tombstone_data_.clear();
2961 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002962 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002963
2964 // Instead of shutdown the pool, we delete temporary files directly since
2965 // shutdown blocking the call.
2966 if (dump_pool_) {
2967 dump_pool_->deleteTempFiles();
2968 }
2969 if (zip_entry_tasks_) {
2970 zip_entry_tasks_->run(/*do_cancel =*/ true);
2971 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002972}
2973
Nandana Dutt979388e2018-11-30 16:48:55 +00002974/*
2975 * Dumps relevant information to a bugreport based on the given options.
2976 *
2977 * The bugreport can be dumped to a file or streamed to a socket.
2978 *
2979 * How dumping to file works:
2980 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2981 * stderr is redirected a log file.
2982 *
2983 * The temporary bugreport is then populated via printfs, dumping contents of files and
2984 * output of commands to stdout.
2985 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002986 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002987 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002988 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002989 *
mhasank2d75c442020-06-11 15:05:25 -07002990 * Bugreports are first generated in a local directory and later copied to the caller's fd
2991 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002992 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002993Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2994 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002995 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002996 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002997 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002998 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002999 return RunStatus::INVALID_INPUT;
3000 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003001 /* set as high priority, and protect from OOM killer */
3002 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003003
Felipe Lemed071c682016-10-20 16:48:00 -07003004 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003005 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003006 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003007 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003008 } else {
3009 /* fallback to kernels <= 2.6.35 */
3010 oom_adj = fopen("/proc/self/oom_adj", "we");
3011 if (oom_adj) {
3012 fputs("-17", oom_adj);
3013 fclose(oom_adj);
3014 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003015 }
3016
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003017 if (version_ == VERSION_DEFAULT) {
3018 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003019 }
3020
Chris Morin5a50d482022-02-01 17:41:18 -08003021 if (version_ != VERSION_CURRENT) {
3022 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3023 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003024 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003025 }
3026
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003027 if (options_->show_header_only) {
3028 PrintHeader();
3029 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003030 }
3031
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003032 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3033 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003034
Felipe Leme7447d7c2016-11-03 18:12:22 -07003035 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003036 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003037 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003038 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003039
Sahana Raof35ed432019-07-12 10:47:52 +01003040 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3041 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3042 } else {
3043 // Wake lock will be released automatically on process death
3044 MYLOGD("Wake lock acquired.\n");
3045 }
3046
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003047 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003048
Felipe Lemef0292972016-11-22 13:57:05 -08003049 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003050 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3051 }
3052
Nandana Dutt235c6672019-11-14 15:22:32 +00003053 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003054 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003055
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003056 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003057
Christopher Ferrised9354f2014-10-01 17:35:01 -07003058 // If we are going to use a socket, do it as early as possible
3059 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003060 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003061 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003062 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003063 if (control_socket_fd_ == -1) {
3064 return ERROR;
3065 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003066 if (options_->progress_updates_to_socket) {
3067 options_->do_progress_updates = 1;
3068 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003069 }
3070
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003071 if (!PrepareToWriteToFile()) {
3072 return ERROR;
3073 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003074
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003075 // Interactive, wear & telephony modes are default to true.
3076 // and may enable from cli option or when using control socket
3077 if (options_->do_progress_updates) {
3078 // clang-format off
3079 std::vector<std::string> am_args = {
3080 "--receiver-permission", "android.permission.DUMP",
3081 };
3082 // clang-format on
3083 // Send STARTED broadcast for apps that listen to bugreport generation events
3084 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3085 if (options_->progress_updates_to_socket) {
3086 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003087 }
3088 }
3089
Nick Kralevichf3599b32016-01-25 15:05:16 -08003090 /* read /proc/cmdline before dropping root */
3091 FILE *cmdline = fopen("/proc/cmdline", "re");
3092 if (cmdline) {
3093 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3094 fclose(cmdline);
3095 }
3096
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003097 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003098 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003099 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003100
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003101 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003102 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3103 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003104 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003105 }
3106 }
3107
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003108 int dup_stdout_fd;
3109 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003110 // Redirect stderr to log_path_ for debugging.
3111 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3112 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3113 return ERROR;
3114 }
3115 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3116 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3117 strerror(errno));
3118 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003119
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003120 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3121 // moved into zip file later, if zipping.
3122 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3123 // TODO: why not write to a file instead of stdout to overcome this problem?
3124 /* TODO: rather than generating a text file now and zipping it later,
3125 it would be more efficient to redirect stdout to the zip entry
3126 directly, but the libziparchive doesn't support that option yet. */
3127 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3128 return ERROR;
3129 }
3130 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3131 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3132 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003133 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003134
3135 // Don't buffer stdout
3136 setvbuf(stdout, nullptr, _IONBF, 0);
3137
Rhed Jao5377d792020-07-16 17:37:39 +08003138 // Enable the parallel run if the client requests to output to a file.
3139 EnableParallelRunIfNeeded();
3140 // Using scope guard to make sure the dump pool can be shut down correctly.
3141 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3142 ShutdownDumpPool();
3143 });
3144
Felipe Leme608385d2016-02-01 10:35:38 -08003145 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3146 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003147 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003148 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003149
Gavin Corkery6968f552020-11-22 18:09:05 +00003150 bool is_dumpstate_restricted = options_->telephony_only
3151 || options_->wifi_only
3152 || options_->limited_only;
3153 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003154 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003155 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003156 }
3157 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003158
3159 if (!is_dumpstate_restricted) {
3160 // Snapshot the system trace now (if running) to avoid that dumpstate's
3161 // own activity pushes out interesting data from the trace ring buffer.
3162 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3163 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003164
3165 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3166 // from WMTRACE_DATA_DIR.
3167 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003168 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003169 onUiIntensiveBugreportDumpsFinished(calling_uid);
3170 MaybeCheckUserConsent(calling_uid, calling_package);
3171 if (options_->telephony_only) {
3172 DumpstateTelephonyOnly(calling_package);
3173 } else if (options_->wifi_only) {
3174 DumpstateWifiOnly();
3175 } else if (options_->limited_only) {
3176 DumpstateLimitedOnly();
3177 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003178 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003179 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003180 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003181 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003182 HandleUserConsentDenied();
3183 }
3184 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003185 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003186 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003187
Felipe Leme55b42a62015-11-10 17:39:08 -08003188 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003189 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003190
Abhijeet Kaure370d682019-10-01 16:49:30 +01003191 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003192 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003193 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003194 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003195
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003196 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003197 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003198 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003199 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003200 if (status != Dumpstate::RunStatus::OK &&
3201 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3202 // Do an early return if there were errors. We make an exception for consent
3203 // timing out because it's possible the user got distracted. In this case the
3204 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003205 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003206 return status;
3207 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003208 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3209 MYLOGI(
3210 "Did not receive user consent yet."
3211 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003212 const String16 incidentcompanion("incidentcompanion");
3213 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3214 if (ics != nullptr) {
3215 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3216 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3217 consent_callback_.get());
3218 } else {
3219 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3220 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003221 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003222 }
3223
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003224 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003225 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003226 for (int i = 0; i < 3; i++) {
3227 Vibrate(75);
3228 usleep((75 + 50) * 1000);
3229 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003230 }
3231
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003232 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3233 progress_->GetInitialMax());
3234 progress_->Save();
3235 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003236
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003237 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003238
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003239 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003240 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003241 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003242 }
3243
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003244 tombstone_data_.clear();
3245 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003246 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003247
Nandana Duttd2f5f082019-01-18 17:13:52 +00003248 return (consent_callback_ != nullptr &&
3249 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3250 ? USER_CONSENT_TIMED_OUT
3251 : RunStatus::OK;
3252}
3253
Paul Chang0d2aad72020-02-13 20:04:03 +08003254void Dumpstate::MaybeTakeEarlyScreenshot() {
3255 if (!options_->do_screenshot || !do_early_screenshot_) {
3256 return;
3257 }
3258
3259 TakeScreenshot();
3260}
3261
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003262void Dumpstate::MaybeSnapshotSystemTrace() {
3263 // If a background system trace is happening and is marked as "suitable for
3264 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3265 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3266 // case that no trace is ongoing, this command is a no-op.
3267 // Note: this should not be enqueued as we need to freeze the trace before
3268 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3269 // the dumpstate's own activity which is irrelevant.
3270 int res = RunCommand(
3271 "SERIALIZE PERFETTO TRACE",
3272 {"perfetto", "--save-for-bugreport"},
3273 CommandOptions::WithTimeout(10)
3274 .DropRoot()
3275 .CloseAllFileDescriptorsOnExec()
3276 .Build());
3277 has_system_trace_ = res == 0;
3278 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3279 // file in the later stages.
3280}
3281
Yohei Yukawa95305b32021-03-09 07:54:27 -08003282void Dumpstate::MaybeSnapshotWinTrace() {
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003283 // Include the proto logging from WMShell.
3284 RunCommand(
3285 // Empty name because it's not intended to be classified as a bugreport section.
3286 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3287 // in the bugreport.
3288 "", {"dumpsys", "activity", "service", "SystemUIService",
3289 "WMShell", "protolog", "save-for-bugreport"},
3290 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3291
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003292 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3293 for (const auto& service : {"window", "input_method"}) {
3294 RunCommand(
3295 // Empty name because it's not intended to be classified as a bugreport section.
3296 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3297 "", {"cmd", service, "tracing", "save-for-bugreport"},
3298 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3299 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003300}
3301
Paul Changeb4b4642020-05-28 22:05:47 +08003302void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003303 if (calling_uid == AID_SHELL || !CalledByApi()) {
3304 return;
3305 }
3306 if (listener_ != nullptr) {
3307 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3308 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003309 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003310 }
3311}
3312
Jichao Lie89d9c12019-11-21 19:02:51 -08003313void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3314 if (calling_uid == AID_SHELL || !CalledByApi()) {
3315 // No need to get consent for shell triggered dumpstates, or not through
3316 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003317 return;
3318 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003319 consent_callback_ = new ConsentCallback();
3320 const String16 incidentcompanion("incidentcompanion");
3321 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003322 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003323 if (ics != nullptr) {
3324 MYLOGD("Checking user consent via incidentcompanion service\n");
3325 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003326 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003327 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003328 } else {
3329 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3330 }
3331}
3332
Nandana Dutt5c390032019-03-12 10:52:56 +00003333bool Dumpstate::IsUserConsentDenied() const {
3334 return ds.consent_callback_ != nullptr &&
3335 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3336}
3337
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003338bool Dumpstate::CalledByApi() const {
3339 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3340}
3341
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003342void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003343 android::os::UnlinkAndLogOnError(tmp_path_);
3344 android::os::UnlinkAndLogOnError(screenshot_path_);
3345 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003346 if (dump_traces_path != nullptr) {
3347 android::os::UnlinkAndLogOnError(dump_traces_path);
3348 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003349}
3350
Rhed Jao5377d792020-07-16 17:37:39 +08003351void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003352 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003353 return;
3354 }
3355 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003356 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003357}
3358
3359void Dumpstate::ShutdownDumpPool() {
3360 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003361 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003362 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003363 if (zip_entry_tasks_) {
3364 zip_entry_tasks_->run(/* do_cancel = */true);
3365 zip_entry_tasks_ = nullptr;
3366 }
3367}
3368
3369void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3370 const std::string& entry_path) {
3371 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3372 if (!task_cancelled) {
3373 AddZipEntry(entry_name, entry_path);
3374 }
3375 android::os::UnlinkAndLogOnError(entry_path);
3376 };
3377 if (zip_entry_tasks_) {
3378 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3379 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3380 } else {
3381 // Invokes AddZipEntryAndCleanup immediately
3382 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3383 }
Rhed Jao5377d792020-07-16 17:37:39 +08003384}
3385
Nandana Duttd2f5f082019-01-18 17:13:52 +00003386Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3387 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003388 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003389 return USER_CONSENT_DENIED;
3390}
3391
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003392Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003393 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003394 // user consent (unless the caller is Shell).
3395 UserConsentResult consent_result;
3396 if (calling_uid == AID_SHELL) {
3397 consent_result = UserConsentResult::APPROVED;
3398 } else {
3399 consent_result = consent_callback_->getResult();
3400 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003401 if (consent_result == UserConsentResult::UNAVAILABLE) {
3402 // User has not responded yet.
3403 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003404 // Telephony is a fast report type, particularly on user builds where information may be
3405 // more aggressively limited. To give the user time to read the consent dialog, increase the
3406 // timeout.
3407 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3408 : USER_CONSENT_TIMEOUT_MS;
3409 if (elapsed_ms < timeout_ms) {
3410 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003411 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3412 sleep(delay_seconds);
3413 }
3414 consent_result = consent_callback_->getResult();
3415 }
3416 if (consent_result == UserConsentResult::DENIED) {
3417 // User has explicitly denied sharing with the app. To be safe delete the
3418 // internal bugreport & tmp files.
3419 return HandleUserConsentDenied();
3420 }
3421 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003422 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3423 if (copy_succeeded) {
3424 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003425 if (options_->do_screenshot &&
3426 options_->screenshot_fd.get() != -1 &&
3427 !options_->is_screenshot_copied) {
3428 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3429 options_->screenshot_fd.get());
3430 options_->is_screenshot_copied = copy_succeeded;
3431 if (copy_succeeded) {
3432 android::os::UnlinkAndLogOnError(screenshot_path_);
3433 }
3434 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003435 }
3436 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3437 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3438 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3439 // Since we do not have user consent to share the bugreport it does not get
3440 // copied over to the calling app but remains in the internal directory from
3441 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003442 std::string final_path = GetPath(".zip");
3443 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3444 if (copy_succeeded) {
3445 android::os::UnlinkAndLogOnError(path_);
3446 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003447 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3448 }
3449 // Unknown result; must be a programming error.
3450 MYLOGE("Unknown user consent result:%d\n", consent_result);
3451 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003452}
3453
Nandana Duttf02564e2019-02-15 15:24:24 +00003454Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003455 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3456 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3457 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003458 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003459 // When directly running dumpstate binary, the output is not expected to be written
3460 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003461 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003462
3463 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003464 // an app; they are irrelevant here because bugreport is triggered via command line.
3465 // Update Last ID before calling Run().
3466 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003467 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003468 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003469 return status;
3470}
3471
3472/* Main entry point for dumpstate binary. */
3473int run_main(int argc, char* argv[]) {
3474 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003475
3476 switch (status) {
3477 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003478 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003479 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003480 ShowUsage();
3481 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003482 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003483 fprintf(stderr, "Invalid combination of args\n");
3484 ShowUsage();
3485 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003486 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003487 FALLTHROUGH_INTENDED;
3488 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3489 FALLTHROUGH_INTENDED;
3490 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003491 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003492 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003493}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003494
3495// TODO(111441001): Default DumpOptions to sensible values.
3496Dumpstate::Dumpstate(const std::string& version)
3497 : pid_(getpid()),
3498 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003499 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003500 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003501 now_(time(nullptr)),
3502 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003503}
3504
3505Dumpstate& Dumpstate::GetInstance() {
3506 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3507 return singleton_;
3508}
3509
Rhed Jao5377d792020-07-16 17:37:39 +08003510DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3511 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3512 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003513 if (!title_.empty()) {
3514 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003515 if (title_.find("SHOW MAP") == std::string::npos) {
3516 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3517 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003518 }
3519}
3520
3521DurationReporter::~DurationReporter() {
3522 if (!title_.empty()) {
3523 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003524 if (elapsed >= .5f || verbose_) {
3525 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003526 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003527 if (!logcat_only_) {
3528 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003529 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3530 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003531 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003532 if (title_.find("SHOW MAP") == std::string::npos) {
3533 ATRACE_ASYNC_END(title_.c_str(), 0);
3534 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003535 }
3536}
3537
3538const int32_t Progress::kDefaultMax = 5000;
3539
3540Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3541}
3542
3543Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3544 : Progress(initial_max, growth_factor, "") {
3545 progress_ = progress;
3546}
3547
3548Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3549 : initial_max_(initial_max),
3550 progress_(0),
3551 max_(initial_max),
3552 growth_factor_(growth_factor),
3553 n_runs_(0),
3554 average_max_(0),
3555 path_(path) {
3556 if (!path_.empty()) {
3557 Load();
3558 }
3559}
3560
3561void Progress::Load() {
3562 MYLOGD("Loading stats from %s\n", path_.c_str());
3563 std::string content;
3564 if (!android::base::ReadFileToString(path_, &content)) {
3565 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3566 return;
3567 }
3568 if (content.empty()) {
3569 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3570 return;
3571 }
3572 std::vector<std::string> lines = android::base::Split(content, "\n");
3573
3574 if (lines.size() < 1) {
3575 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3576 (int)lines.size(), max_);
3577 return;
3578 }
3579 char* ptr;
3580 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3581 average_max_ = strtol(ptr, nullptr, 10);
3582 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3583 average_max_ > STATS_MAX_AVERAGE) {
3584 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3585 initial_max_ = Progress::kDefaultMax;
3586 } else {
3587 initial_max_ = average_max_;
3588 }
3589 max_ = initial_max_;
3590
3591 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3592}
3593
3594void Progress::Save() {
3595 int32_t total = n_runs_ * average_max_ + progress_;
3596 int32_t runs = n_runs_ + 1;
3597 int32_t average = floor(((float)total) / runs);
3598 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3599 path_.c_str());
3600 if (path_.empty()) {
3601 return;
3602 }
3603
3604 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3605 if (!android::base::WriteStringToFile(content, path_)) {
3606 MYLOGE("Could not save stats on %s\n", path_.c_str());
3607 }
3608}
3609
3610int32_t Progress::Get() const {
3611 return progress_;
3612}
3613
3614bool Progress::Inc(int32_t delta_sec) {
3615 bool changed = false;
3616 if (delta_sec >= 0) {
3617 progress_ += delta_sec;
3618 if (progress_ > max_) {
3619 int32_t old_max = max_;
3620 max_ = floor((float)progress_ * growth_factor_);
3621 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3622 changed = true;
3623 }
3624 }
3625 return changed;
3626}
3627
3628int32_t Progress::GetMax() const {
3629 return max_;
3630}
3631
3632int32_t Progress::GetInitialMax() const {
3633 return initial_max_;
3634}
3635
3636void Progress::Dump(int fd, const std::string& prefix) const {
3637 const char* pr = prefix.c_str();
3638 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3639 dprintf(fd, "%smax: %d\n", pr, max_);
3640 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3641 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3642 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3643 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3644 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3645}
3646
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003647std::string Dumpstate::GetPath(const std::string& suffix) const {
3648 return GetPath(bugreport_internal_dir_, suffix);
3649}
3650
3651std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3652 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3653 name_.c_str(), suffix.c_str());
3654}
3655
3656void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3657 progress_ = std::move(progress);
3658}
3659
3660void for_each_userid(void (*func)(int), const char *header) {
3661 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3662 "for_each_userid(%s)", header);
3663 DurationReporter duration_reporter(title);
3664 if (PropertiesHelper::IsDryRun()) return;
3665
3666 DIR *d;
3667 struct dirent *de;
3668
3669 if (header) printf("\n------ %s ------\n", header);
3670 func(0);
3671
3672 if (!(d = opendir("/data/system/users"))) {
3673 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3674 return;
3675 }
3676
3677 while ((de = readdir(d))) {
3678 int userid;
3679 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3680 continue;
3681 }
3682 func(userid);
3683 }
3684
3685 closedir(d);
3686}
3687
3688static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3689 DIR *d;
3690 struct dirent *de;
3691
3692 if (!(d = opendir("/proc"))) {
3693 printf("Failed to open /proc (%s)\n", strerror(errno));
3694 return;
3695 }
3696
3697 if (header) printf("\n------ %s ------\n", header);
3698 while ((de = readdir(d))) {
3699 if (ds.IsUserConsentDenied()) {
3700 MYLOGE(
3701 "Returning early because user denied consent to share bugreport with calling app.");
3702 closedir(d);
3703 return;
3704 }
3705 int pid;
3706 int fd;
3707 char cmdpath[255];
3708 char cmdline[255];
3709
3710 if (!(pid = atoi(de->d_name))) {
3711 continue;
3712 }
3713
3714 memset(cmdline, 0, sizeof(cmdline));
3715
3716 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3717 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3718 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3719 close(fd);
3720 if (cmdline[0]) {
3721 helper(pid, cmdline, arg);
3722 continue;
3723 }
3724 }
3725
3726 // if no cmdline, a kernel thread has comm
3727 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3728 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3729 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3730 close(fd);
3731 if (cmdline[1]) {
3732 cmdline[0] = '[';
3733 size_t len = strcspn(cmdline, "\f\b\r\n");
3734 cmdline[len] = ']';
3735 cmdline[len+1] = '\0';
3736 }
3737 }
3738 if (!cmdline[0]) {
3739 strcpy(cmdline, "N/A");
3740 }
3741 helper(pid, cmdline, arg);
3742 }
3743
3744 closedir(d);
3745}
3746
3747static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3748 for_each_pid_func *func = (for_each_pid_func*) arg;
3749 func(pid, cmdline);
3750}
3751
3752void for_each_pid(for_each_pid_func func, const char *header) {
3753 std::string title = header == nullptr ? "for_each_pid"
3754 : android::base::StringPrintf("for_each_pid(%s)", header);
3755 DurationReporter duration_reporter(title);
3756 if (PropertiesHelper::IsDryRun()) return;
3757
3758 __for_each_pid(for_each_pid_helper, header, (void *) func);
3759}
3760
3761static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3762 DIR *d;
3763 struct dirent *de;
3764 char taskpath[255];
3765 for_each_tid_func *func = (for_each_tid_func *) arg;
3766
3767 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3768
3769 if (!(d = opendir(taskpath))) {
3770 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3771 return;
3772 }
3773
3774 func(pid, pid, cmdline);
3775
3776 while ((de = readdir(d))) {
3777 if (ds.IsUserConsentDenied()) {
3778 MYLOGE(
3779 "Returning early because user denied consent to share bugreport with calling app.");
3780 closedir(d);
3781 return;
3782 }
3783 int tid;
3784 int fd;
3785 char commpath[255];
3786 char comm[255];
3787
3788 if (!(tid = atoi(de->d_name))) {
3789 continue;
3790 }
3791
3792 if (tid == pid)
3793 continue;
3794
3795 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3796 memset(comm, 0, sizeof(comm));
3797 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3798 strcpy(comm, "N/A");
3799 } else {
3800 char *c;
3801 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3802 close(fd);
3803
3804 c = strrchr(comm, '\n');
3805 if (c) {
3806 *c = '\0';
3807 }
3808 }
3809 func(pid, tid, comm);
3810 }
3811
3812 closedir(d);
3813}
3814
3815void for_each_tid(for_each_tid_func func, const char *header) {
3816 std::string title = header == nullptr ? "for_each_tid"
3817 : android::base::StringPrintf("for_each_tid(%s)", header);
3818 DurationReporter duration_reporter(title);
3819
3820 if (PropertiesHelper::IsDryRun()) return;
3821
3822 __for_each_pid(for_each_tid_helper, header, (void *) func);
3823}
3824
3825void show_wchan(int pid, int tid, const char *name) {
3826 if (PropertiesHelper::IsDryRun()) return;
3827
3828 char path[255];
3829 char buffer[255];
3830 int fd, ret, save_errno;
3831 char name_buffer[255];
3832
3833 memset(buffer, 0, sizeof(buffer));
3834
3835 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3836 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3837 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3838 return;
3839 }
3840
3841 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3842 save_errno = errno;
3843 close(fd);
3844
3845 if (ret < 0) {
3846 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3847 return;
3848 }
3849
3850 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3851 pid == tid ? 0 : 3, "", name);
3852
3853 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3854
3855 return;
3856}
3857
3858// print time in centiseconds
3859static void snprcent(char *buffer, size_t len, size_t spc,
3860 unsigned long long time) {
3861 static long hz; // cache discovered hz
3862
3863 if (hz <= 0) {
3864 hz = sysconf(_SC_CLK_TCK);
3865 if (hz <= 0) {
3866 hz = 1000;
3867 }
3868 }
3869
3870 // convert to centiseconds
3871 time = (time * 100 + (hz / 2)) / hz;
3872
3873 char str[16];
3874
3875 snprintf(str, sizeof(str), " %llu.%02u",
3876 time / 100, (unsigned)(time % 100));
3877 size_t offset = strlen(buffer);
3878 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3879 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3880}
3881
3882// print permille as a percent
3883static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3884 char str[16];
3885
3886 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3887 size_t offset = strlen(buffer);
3888 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3889 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3890}
3891
3892void show_showtime(int pid, const char *name) {
3893 if (PropertiesHelper::IsDryRun()) return;
3894
3895 char path[255];
3896 char buffer[1023];
3897 int fd, ret, save_errno;
3898
3899 memset(buffer, 0, sizeof(buffer));
3900
3901 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3902 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3903 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3904 return;
3905 }
3906
3907 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3908 save_errno = errno;
3909 close(fd);
3910
3911 if (ret < 0) {
3912 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3913 return;
3914 }
3915
3916 // field 14 is utime
3917 // field 15 is stime
3918 // field 42 is iotime
3919 unsigned long long utime = 0, stime = 0, iotime = 0;
3920 if (sscanf(buffer,
3921 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3922 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3923 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3924 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3925 &utime, &stime, &iotime) != 3) {
3926 return;
3927 }
3928
3929 unsigned long long total = utime + stime;
3930 if (!total) {
3931 return;
3932 }
3933
3934 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3935 if (permille > 1000) {
3936 permille = 1000;
3937 }
3938
3939 // try to beautify and stabilize columns at <80 characters
3940 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3941 if ((name[0] != '[') || utime) {
3942 snprcent(buffer, sizeof(buffer), 57, utime);
3943 }
3944 snprcent(buffer, sizeof(buffer), 65, stime);
3945 if ((name[0] != '[') || iotime) {
3946 snprcent(buffer, sizeof(buffer), 73, iotime);
3947 }
3948 if (iotime) {
3949 snprdec(buffer, sizeof(buffer), 79, permille);
3950 }
3951 puts(buffer); // adds a trailing newline
3952
3953 return;
3954}
3955
3956void do_dmesg() {
3957 const char *title = "KERNEL LOG (dmesg)";
3958 DurationReporter duration_reporter(title);
3959 printf("------ %s ------\n", title);
3960
3961 if (PropertiesHelper::IsDryRun()) return;
3962
3963 /* Get size of kernel buffer */
3964 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3965 if (size <= 0) {
3966 printf("Unexpected klogctl return value: %d\n\n", size);
3967 return;
3968 }
3969 char *buf = (char *) malloc(size + 1);
3970 if (buf == nullptr) {
3971 printf("memory allocation failed\n\n");
3972 return;
3973 }
3974 int retval = klogctl(KLOG_READ_ALL, buf, size);
3975 if (retval < 0) {
3976 printf("klogctl failure\n\n");
3977 free(buf);
3978 return;
3979 }
3980 buf[retval] = '\0';
3981 printf("%s\n\n", buf);
3982 free(buf);
3983 return;
3984}
3985
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003986int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3987 DurationReporter duration_reporter(title);
3988
3989 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3990
3991 UpdateProgress(WEIGHT_FILE);
3992
3993 return status;
3994}
3995
3996int read_file_as_long(const char *path, long int *output) {
3997 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3998 if (fd < 0) {
3999 int err = errno;
4000 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4001 return -1;
4002 }
4003 char buffer[50];
4004 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4005 if (bytes_read == -1) {
4006 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4007 return -2;
4008 }
4009 if (bytes_read == 0) {
4010 MYLOGE("File %s is empty\n", path);
4011 return -3;
4012 }
4013 *output = atoi(buffer);
4014 return 0;
4015}
4016
4017/* calls skip to gate calling dump_from_fd recursively
4018 * in the specified directory. dump_from_fd defaults to
4019 * dump_file_from_fd above when set to NULL. skip defaults
4020 * to false when set to NULL. dump_from_fd will always be
4021 * called with title NULL.
4022 */
4023int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4024 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4025 DurationReporter duration_reporter(title);
4026 DIR *dirp;
4027 struct dirent *d;
4028 char *newpath = nullptr;
4029 const char *slash = "/";
4030 int retval = 0;
4031
4032 if (!title.empty()) {
4033 printf("------ %s (%s) ------\n", title.c_str(), dir);
4034 }
4035 if (PropertiesHelper::IsDryRun()) return 0;
4036
4037 if (dir[strlen(dir) - 1] == '/') {
4038 ++slash;
4039 }
4040 dirp = opendir(dir);
4041 if (dirp == nullptr) {
4042 retval = -errno;
4043 MYLOGE("%s: %s\n", dir, strerror(errno));
4044 return retval;
4045 }
4046
4047 if (!dump_from_fd) {
4048 dump_from_fd = dump_file_from_fd;
4049 }
4050 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4051 if ((d->d_name[0] == '.')
4052 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4053 || (d->d_name[1] == '\0'))) {
4054 continue;
4055 }
4056 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4057 (d->d_type == DT_DIR) ? "/" : "");
4058 if (!newpath) {
4059 retval = -errno;
4060 continue;
4061 }
4062 if (skip && (*skip)(newpath)) {
4063 continue;
4064 }
4065 if (d->d_type == DT_DIR) {
4066 int ret = dump_files("", newpath, skip, dump_from_fd);
4067 if (ret < 0) {
4068 retval = ret;
4069 }
4070 continue;
4071 }
4072 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4073 if (fd.get() < 0) {
4074 retval = -1;
4075 printf("*** %s: %s\n", newpath, strerror(errno));
4076 continue;
4077 }
4078 (*dump_from_fd)(nullptr, newpath, fd.get());
4079 }
4080 closedir(dirp);
4081 if (!title.empty()) {
4082 printf("\n");
4083 }
4084 return retval;
4085}
4086
4087/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4088 * it's possible to avoid issues where opening the file itself can get
4089 * stuck.
4090 */
4091int dump_file_from_fd(const char *title, const char *path, int fd) {
4092 if (PropertiesHelper::IsDryRun()) return 0;
4093
4094 int flags = fcntl(fd, F_GETFL);
4095 if (flags == -1) {
4096 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4097 return -1;
4098 } else if (!(flags & O_NONBLOCK)) {
4099 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4100 return -1;
4101 }
4102 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4103}
4104
4105int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004106 const CommandOptions& options, bool verbose_duration, int out_fd) {
4107 DurationReporter duration_reporter(title, false /* logcat_only */,
4108 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004109
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004110 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004111
4112 /* TODO: for now we're simplifying the progress calculation by using the
4113 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4114 * where its weight should be much higher proportionally to its timeout.
4115 * Ideally, it should use a options.EstimatedDuration() instead...*/
4116 UpdateProgress(options.Timeout());
4117
4118 return status;
4119}
4120
4121void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004122 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004123 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4124 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4125 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004126 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004127}
4128
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004129static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004130 int s = android_get_control_socket(service);
4131 if (s < 0) {
4132 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4133 return -1;
4134 }
4135 fcntl(s, F_SETFD, FD_CLOEXEC);
4136
4137 // Set backlog to 0 to make sure that queue size will be minimum.
4138 // In Linux, because the minimum queue will be 1, connect() will be blocked
4139 // if the other clients already called connect() and the connection request was not accepted.
4140 if (listen(s, 0) < 0) {
4141 MYLOGE("listen(control socket): %s\n", strerror(errno));
4142 return -1;
4143 }
4144
4145 struct sockaddr addr;
4146 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004147 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004148
4149 // Close socket just after accept(), to make sure that connect() by client will get error
4150 // when the socket is used by the other services.
4151 // There is still a race condition possibility between accept and close, but there is no way
4152 // to close-on-accept atomically.
4153 // See detail; b/123306389#comment25
4154 close(s);
4155
4156 if (fd < 0) {
4157 MYLOGE("accept(control socket): %s\n", strerror(errno));
4158 return -1;
4159 }
4160
4161 return fd;
4162}
4163
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004164// TODO: should call is_valid_output_file and/or be merged into it.
4165void create_parent_dirs(const char *path) {
4166 char *chp = const_cast<char *> (path);
4167
4168 /* skip initial slash */
4169 if (chp[0] == '/')
4170 chp++;
4171
4172 /* create leading directories, if necessary */
4173 struct stat dir_stat;
4174 while (chp && chp[0]) {
4175 chp = strchr(chp, '/');
4176 if (chp) {
4177 *chp = 0;
4178 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4179 MYLOGI("Creating directory %s\n", path);
4180 if (mkdir(path, 0770)) { /* drwxrwx--- */
4181 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4182 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4183 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4184 }
4185 }
4186 *chp++ = '/';
4187 }
4188 }
4189}
4190
4191bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4192 create_parent_dirs(path);
4193
4194 int fd = TEMP_FAILURE_RETRY(open(path,
4195 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4196 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4197 if (fd < 0) {
4198 MYLOGE("%s: %s\n", path, strerror(errno));
4199 return false;
4200 }
4201
4202 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4203 close(fd);
4204 return true;
4205}
4206
4207bool redirect_to_file(FILE* redirect, char* path) {
4208 return _redirect_to_file(redirect, path, O_TRUNC);
4209}
4210
4211bool redirect_to_existing_file(FILE* redirect, char* path) {
4212 return _redirect_to_file(redirect, path, O_APPEND);
4213}
4214
4215void dump_route_tables() {
4216 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4217 if (PropertiesHelper::IsDryRun()) return;
4218 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4219 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4220 FILE* fp = fopen(RT_TABLES_PATH, "re");
4221 if (!fp) {
4222 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4223 return;
4224 }
4225 char table[16];
4226 // Each line has an integer (the table number), a space, and a string (the table name). We only
4227 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4228 // Add a fixed max limit so this doesn't go awry.
4229 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4230 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4231 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4232 }
4233 fclose(fp);
4234}
4235
Li Li830179f2022-01-04 12:53:29 -08004236void dump_frozen_cgroupfs(const char *dir, int level,
4237 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4238 DIR *dirp;
4239 struct dirent *d;
4240 char *newpath = nullptr;
4241
4242 dirp = opendir(dir);
4243 if (dirp == nullptr) {
4244 MYLOGE("%s: %s\n", dir, strerror(errno));
4245 return;
4246 }
4247
4248 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4249 if ((d->d_name[0] == '.')
4250 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4251 || (d->d_name[1] == '\0'))) {
4252 continue;
4253 }
4254 if (d->d_type == DT_DIR) {
4255 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4256 if (!newpath) {
4257 continue;
4258 }
4259 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4260 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4261 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4262 char *freezer = nullptr;
4263 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4264 if (freezer) {
4265 FILE* fp = fopen(freezer, "r");
4266 if (fp != NULL) {
4267 int frozen;
4268 fscanf(fp, "%d", &frozen);
4269 if (frozen > 0) {
4270 dump_files("", newpath, skip_none, dump_from_fd);
4271 }
4272 fclose(fp);
4273 }
4274 free(freezer);
4275 }
4276 }
4277 }
4278 }
4279 closedir(dirp);
4280}
4281
4282void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004283 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4284 DurationReporter duration_reporter("FROZEN CGROUPFS");
4285 if (PropertiesHelper::IsDryRun()) return;
4286 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4287}
4288
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004289void Dumpstate::UpdateProgress(int32_t delta_sec) {
4290 if (progress_ == nullptr) {
4291 MYLOGE("UpdateProgress: progress_ not set\n");
4292 return;
4293 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004294 // This function updates progress related members of the dumpstate and reports
4295 // progress percentage to the bugreport client. Since it could be called by
4296 // different dump tasks at the same time if the parallel run is enabled, a
4297 // mutex lock is necessary here to synchronize the call.
4298 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004299
4300 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004301 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004302
4303 // ...but only notifiy listeners when necessary.
4304 if (!options_->do_progress_updates) return;
4305
4306 int progress = progress_->Get();
4307 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004308 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004309
Nandana Dutt402a8392019-06-14 14:25:13 +01004310 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004311 return;
4312 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004313 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004314
4315 if (control_socket_fd_ >= 0) {
4316 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4317 fsync(control_socket_fd_);
4318 }
4319
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004320 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004321 if (percent % 10 == 0) {
4322 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004323 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004324 } else {
4325 // stderr is ignored on normal invocations, but useful when calling
4326 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004327 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004328 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004329
4330 listener_->onProgress(percent);
4331 }
4332}
4333
4334void Dumpstate::TakeScreenshot(const std::string& path) {
4335 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4336 int status =
4337 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4338 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4339 if (status == 0) {
4340 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4341 } else {
4342 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4343 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004344 if (listener_ != nullptr) {
4345 // Show a visual indication to indicate screenshot is taken via
4346 // IDumpstateListener.onScreenshotTaken()
4347 listener_->onScreenshotTaken(status == 0);
4348 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004349}
4350
4351bool is_dir(const char* pathname) {
4352 struct stat info;
4353 if (stat(pathname, &info) == -1) {
4354 return false;
4355 }
4356 return S_ISDIR(info.st_mode);
4357}
4358
4359time_t get_mtime(int fd, time_t default_mtime) {
4360 struct stat info;
4361 if (fstat(fd, &info) == -1) {
4362 return default_mtime;
4363 }
4364 return info.st_mtime;
4365}