blob: f5200460a274dac14285c47a63ef5fc9d1661e61 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080077#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070078#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010079#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000080#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000081#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000083#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010084#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080085#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010086#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070087#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070088#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070089#include <private/android_filesystem_config.h>
90#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080091#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070092#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000093#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080094#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070095#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070096#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080097
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000098namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
99namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
100namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
101
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using ::std::literals::chrono_literals::operator""ms;
103using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800104using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800105
Felipe Leme47e9be22016-12-21 15:37:07 -0800106// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800107using android::defaultServiceManager;
108using android::Dumpsys;
109using android::INVALID_OPERATION;
110using android::IServiceManager;
111using android::OK;
112using android::sp;
113using android::status_t;
114using android::String16;
115using android::String8;
116using android::TIMED_OUT;
117using android::UNKNOWN_ERROR;
118using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000119using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000120using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121using android::os::dumpstate::CommandOptions;
122using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800123using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800124using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800125using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800126using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800127
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100128// Keep in sync with
129// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
130static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
131
132/* Most simple commands have 10 as timeout, so 5 is a good estimate */
133static const int32_t WEIGHT_FILE = 5;
134
135// TODO: temporary variables and functions used during C++ refactoring
136static Dumpstate& ds = Dumpstate::GetInstance();
137static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100138 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800139 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
140 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100141}
142
143// Reasonable value for max stats.
144static const int STATS_MAX_N_RUNS = 1000;
145static const long STATS_MAX_AVERAGE = 100000;
146
147CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
148
Nandana Duttd2f5f082019-01-18 17:13:52 +0000149typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
150
Colin Crossf45fa6b2012-03-26 12:38:26 -0700151/* read before root is shed */
152static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700153static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000154static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800155// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
156// it's often the case that they time out far too quickly for consent with such a hefty dialog for
157// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
158// roughly match full reports' durations.
159static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700160
Felipe Leme1d486fe2016-10-14 18:06:47 -0700161// TODO: variables and functions below should be part of dumpstate object
162
Felipe Leme635ca312016-01-05 14:23:02 -0800163static std::set<std::string> mount_points;
164void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800165
Todd Poynor2a83daa2013-11-22 15:44:22 -0800166#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700167#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700168#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169
Felipe Lemee82a27d2016-01-05 13:35:44 -0800170#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700171#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700172#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700173#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700174#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800175#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100176#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
177#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800178#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900179#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800180#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700181#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800182#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900183#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700184#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000185#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700186#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200187#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700188#define DROPBOX_DIR "/data/system/dropbox"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700189
Narayan Kamath8f788292017-05-25 13:20:39 +0100190// TODO(narayan): Since this information has to be kept in sync
191// with tombstoned, we should just put it in a common header.
192//
193// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100194static const std::string TOMBSTONE_DIR = "/data/tombstones/";
195static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
196static const std::string ANR_DIR = "/data/anr/";
197static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800198static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
199static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000202
Nandana Dutt5c390032019-03-12 10:52:56 +0000203#define RETURN_IF_USER_DENIED_CONSENT() \
204 if (ds.IsUserConsentDenied()) { \
205 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
206 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
207 }
208
209// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
210// if consent is found to be denied.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 func_ptr(__VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao5377d792020-07-16 17:37:39 +0800216// Runs func_ptr, and logs a duration report after it's finished.
217#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
218 { \
219 DurationReporter duration_reporter_in_macro(log_title); \
220 func_ptr(__VA_ARGS__); \
221 }
222
223// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
224// is output after a slow function is finished.
225#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
226 RETURN_IF_USER_DENIED_CONSENT(); \
227 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
228 RETURN_IF_USER_DENIED_CONSENT();
229
Chris Morinbc223142022-02-04 14:17:11 -0800230#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800231 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800232 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800233 RETURN_IF_USER_DENIED_CONSENT();
234
Sahana Raof35ed432019-07-12 10:47:52 +0100235static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
236
Rhed Jao5377d792020-07-16 17:37:39 +0800237// Names of parallel tasks, they are used for the DumpPool to identify the dump
238// task and the log title of the duration report.
239static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800240static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800241static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800242static const std::string DUMP_HALS_TASK = "DUMP HALS";
243static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800244static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800245
Nandana Dutt979388e2018-11-30 16:48:55 +0000246namespace android {
247namespace os {
248namespace {
249
250static int Open(std::string path, int flags, mode_t mode = 0) {
251 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
252 if (fd == -1) {
253 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
254 }
255 return fd;
256}
257
mhasank2d75c442020-06-11 15:05:25 -0700258static int OpenForWrite(std::string path) {
259 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
260 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
261}
Nandana Dutt979388e2018-11-30 16:48:55 +0000262
263static int OpenForRead(std::string path) {
264 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
265}
266
267bool CopyFile(int in_fd, int out_fd) {
268 char buf[4096];
269 ssize_t byte_count;
270 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
271 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
272 return false;
273 }
274 }
275 return (byte_count != -1);
276}
277
278static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000279 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000280
281 // Obtain a handle to the source file.
282 android::base::unique_fd in_fd(OpenForRead(input_file));
283 if (out_fd != -1 && in_fd.get() != -1) {
284 if (CopyFile(in_fd.get(), out_fd)) {
285 return true;
286 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000287 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000288 }
289 return false;
290}
291
Nandana Duttd2f5f082019-01-18 17:13:52 +0000292static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000293 if (file.empty()) {
294 return false;
295 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000296 if (unlink(file.c_str())) {
297 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000298 return false;
299 }
300 return true;
301}
Nandana Dutt979388e2018-11-30 16:48:55 +0000302
Nikita Ioffea325a572019-05-16 19:49:47 +0100303int64_t GetModuleMetadataVersion() {
304 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
305 if (binder == nullptr) {
306 MYLOGE("Failed to retrieve package_native service");
307 return 0L;
308 }
309 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
310 std::string package_name;
311 auto status = package_service->getModuleMetadataPackageName(&package_name);
312 if (!status.isOk()) {
313 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
314 return 0L;
315 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100316 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100317 int64_t version_code;
318 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
319 &version_code);
320 if (!status.isOk()) {
321 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
322 return 0L;
323 }
324 return version_code;
325}
326
mhasank2d75c442020-06-11 15:05:25 -0700327static bool PathExists(const std::string& path) {
328 struct stat sb;
329 return stat(path.c_str(), &sb) == 0;
330}
331
332static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
333 if (input_file == output_file) {
334 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
335 output_file.c_str());
336 return false;
337 }
338 else if (PathExists(output_file)) {
339 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
340 return false;
341 }
342
343 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
344 android::base::unique_fd out_fd(OpenForWrite(output_file));
345 return CopyFileToFd(input_file, out_fd.get());
346}
347
Nandana Dutt979388e2018-11-30 16:48:55 +0000348} // namespace
349} // namespace os
350} // namespace android
351
Felipe Leme678727a2016-09-21 17:22:11 -0700352static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800353 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800354 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
355 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
356}
357static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
358 int out_fd) {
359 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700360}
361static int DumpFile(const std::string& title, const std::string& path) {
362 return ds.DumpFile(title, path);
363}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800364
Felipe Lemee844a9d2016-09-21 15:01:39 -0700365// Relative directory (inside the zip) for all files copied as-is into the bugreport.
366static const std::string ZIP_ROOT_DIR = "FS";
367
Vishnu Naire97d6122018-01-18 13:58:56 -0800368static const std::string kProtoPath = "proto/";
369static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700370static const std::string kDumpstateBoardFiles[] = {
371 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700372 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700373};
374static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
375
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700376static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700377static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700378
Felipe Lemef0292972016-11-22 13:57:05 -0800379static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
380
Narayan Kamath8f788292017-05-25 13:20:39 +0100381/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100382 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800383 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800384 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100385 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800387 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100388 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100389
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700390 if (dump_dir == nullptr) {
391 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700392 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700393 }
394
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700395 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 struct dirent* entry = nullptr;
397 while ((entry = readdir(dump_dir.get()))) {
398 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100399 continue;
400 }
401
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 const std::string base_name(entry->d_name);
403 if (base_name.find(file_prefix) != 0) {
404 continue;
405 }
406
407 const std::string abs_path = dir_path + base_name;
408 android::base::unique_fd fd(
409 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
410 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700411 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 break;
413 }
414
415 struct stat st = {};
416 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700417 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100418 continue;
419 }
420
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700421 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700422 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800423 if (!dump_data.empty()) {
424 std::sort(dump_data.begin(), dump_data.end(),
425 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
426 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100429}
430
Narayan Kamathbd863722017-06-01 18:50:12 +0100431static bool AddDumps(const std::vector<DumpData>::const_iterator start,
432 const std::vector<DumpData>::const_iterator end,
433 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100435 for (auto it = start; it != end; ++it) {
436 const std::string& name = it->name;
437 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100438 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100439
440 // Seek to the beginning of the file before dumping any data. A given
441 // DumpData entry might be dumped multiple times in the report.
442 //
443 // For example, the most recent ANR entry is dumped to the body of the
444 // main entry and it also shows up as a separate entry in the bugreport
445 // ZIP file.
446 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
447 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
448 strerror(errno));
449 }
450
Chris Morinc2cba7a2022-02-01 17:06:50 -0800451 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800452 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100453 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455 } else {
456 dump_file_from_fd(type_name, name.c_str(), fd);
457 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100458 }
459
460 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700461}
462
Felipe Leme635ca312016-01-05 14:23:02 -0800463// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700464void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char path[PATH_MAX];
466
467 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
468 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700469 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800470 char linkname[PATH_MAX];
471 ssize_t r = readlink(path, linkname, PATH_MAX);
472 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800473 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800474 return;
475 }
476 linkname[r] = '\0';
477
478 if (mount_points.find(linkname) == mount_points.end()) {
479 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700480 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700481 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800482 mount_points.insert(linkname);
483 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800484 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800485 }
486 }
487}
488
489void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700490 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800491 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800492 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700493 for_each_pid(do_mountinfo, nullptr);
494 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800495}
496
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700497static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
498{
499 DIR *d;
500 struct dirent *de;
501 char path[PATH_MAX];
502
503 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700504 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700505 return;
506 }
507
508 while ((de = readdir(d))) {
509 if (de->d_type != DT_LNK) {
510 continue;
511 }
512 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700513 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700514 }
515
516 closedir(d);
517}
518
Mark Salyzyn326842f2015-04-30 09:49:41 -0700519static bool skip_not_stat(const char *path) {
520 static const char stat[] = "/stat";
521 size_t len = strlen(path);
522 if (path[len - 1] == '/') { /* Directory? */
523 return false;
524 }
525 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
526}
527
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700528static bool skip_wtf_strictmode(const char *path) {
529 if (strstr(path, "_wtf")) {
530 return true;
531 } else if (strstr(path, "_strictmode")) {
532 return true;
533 }
534 return false;
535}
536
Felipe Leme4c2d6632016-09-28 14:32:00 -0700537static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800538 return false;
539}
540
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700541unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800543//
544// stat offsets
545// Name units description
546// ---- ----- -----------
547// read I/Os requests number of read I/Os processed
548#define __STAT_READ_IOS 0
549// read merges requests number of read I/Os merged with in-queue I/O
550#define __STAT_READ_MERGES 1
551// read sectors sectors number of sectors read
552#define __STAT_READ_SECTORS 2
553// read ticks milliseconds total wait time for read requests
554#define __STAT_READ_TICKS 3
555// write I/Os requests number of write I/Os processed
556#define __STAT_WRITE_IOS 4
557// write merges requests number of write I/Os merged with in-queue I/O
558#define __STAT_WRITE_MERGES 5
559// write sectors sectors number of sectors written
560#define __STAT_WRITE_SECTORS 6
561// write ticks milliseconds total wait time for write requests
562#define __STAT_WRITE_TICKS 7
563// in_flight requests number of I/Os currently in flight
564#define __STAT_IN_FLIGHT 8
565// io_ticks milliseconds total time this block device has been active
566#define __STAT_IO_TICKS 9
567// time_in_queue milliseconds total wait time for all requests
568#define __STAT_IN_QUEUE 10
569#define __STAT_NUMBER_FIELD 11
570//
571// read I/Os, write I/Os
572// =====================
573//
574// These values increment when an I/O request completes.
575//
576// read merges, write merges
577// =========================
578//
579// These values increment when an I/O request is merged with an
580// already-queued I/O request.
581//
582// read sectors, write sectors
583// ===========================
584//
585// These values count the number of sectors read from or written to this
586// block device. The "sectors" in question are the standard UNIX 512-byte
587// sectors, not any device- or filesystem-specific block size. The
588// counters are incremented when the I/O completes.
589#define SECTOR_SIZE 512
590//
591// read ticks, write ticks
592// =======================
593//
594// These values count the number of milliseconds that I/O requests have
595// waited on this block device. If there are multiple I/O requests waiting,
596// these values will increase at a rate greater than 1000/second; for
597// example, if 60 read requests wait for an average of 30 ms, the read_ticks
598// field will increase by 60*30 = 1800.
599//
600// in_flight
601// =========
602//
603// This value counts the number of I/O requests that have been issued to
604// the device driver but have not yet completed. It does not include I/O
605// requests that are in the queue but not yet issued to the device driver.
606//
607// io_ticks
608// ========
609//
610// This value counts the number of milliseconds during which the device has
611// had I/O requests queued.
612//
613// time_in_queue
614// =============
615//
616// This value counts the number of milliseconds that I/O requests have waited
617// on this block device. If there are multiple I/O requests waiting, this
618// value will increase as the product of the number of milliseconds times the
619// number of requests waiting (see "read ticks" above for an example).
620#define S_TO_MS 1000
621//
622
Mark Salyzyn326842f2015-04-30 09:49:41 -0700623static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800624 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700626 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700628 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 getline(&buffer, &i, fp);
630 fclose(fp);
631 if (!buffer) {
632 return -errno;
633 }
634 i = strlen(buffer);
635 while ((i > 0) && (buffer[i - 1] == '\n')) {
636 buffer[--i] = '\0';
637 }
638 if (!*buffer) {
639 free(buffer);
640 return 0;
641 }
642 z = true;
643 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800644 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700645 if (fields[i] != 0) {
646 z = false;
647 }
648 }
649 if (z) { /* never accessed */
650 free(buffer);
651 return 0;
652 }
653
Wei Wang509bb5d2017-06-09 14:42:12 -0700654 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
655 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700656 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700657
658 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
659 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
660 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700661 free(buffer);
662
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800663 if (fields[__STAT_IO_TICKS]) {
664 unsigned long read_perf = 0;
665 unsigned long read_ios = 0;
666 if (fields[__STAT_READ_TICKS]) {
667 unsigned long long divisor = fields[__STAT_READ_TICKS]
668 * fields[__STAT_IO_TICKS];
669 read_perf = ((unsigned long long)SECTOR_SIZE
670 * fields[__STAT_READ_SECTORS]
671 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
672 / divisor;
673 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
674 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
675 / divisor;
676 }
677
678 unsigned long write_perf = 0;
679 unsigned long write_ios = 0;
680 if (fields[__STAT_WRITE_TICKS]) {
681 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
682 * fields[__STAT_IO_TICKS];
683 write_perf = ((unsigned long long)SECTOR_SIZE
684 * fields[__STAT_WRITE_SECTORS]
685 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
686 / divisor;
687 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
688 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
689 / divisor;
690 }
691
692 unsigned queue = (fields[__STAT_IN_QUEUE]
693 + (fields[__STAT_IO_TICKS] >> 1))
694 / fields[__STAT_IO_TICKS];
695
696 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700697 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800698 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700699 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800700 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800701 }
702
703 /* bugreport timeout factor adjustment */
704 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
705 worst_write_perf = write_perf;
706 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700707 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700708 return 0;
709}
710
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
712
Tom Cherryf4472f32020-08-05 09:31:17 -0700713// Returns the actual readable size of the given buffer or -1 on error.
714static long logcat_buffer_readable_size(const std::string& buffer) {
715 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
716 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
717 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
718
719 return android_logger_get_log_readable_size(logger);
720}
721
722// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800723static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
724 unsigned long timeout_ms = 0;
725 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700726 long readable_size = logcat_buffer_readable_size(buffer);
727 if (readable_size > 0) {
728 // Engineering margin is ten-fold our guess.
729 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
730 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800731 }
732 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700733}
734
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800735// Opens a socket and returns its file descriptor.
736static int open_socket(const char* service);
737
Nandana Duttd2f5f082019-01-18 17:13:52 +0000738Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
739}
740
741android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
742 std::lock_guard<std::mutex> lock(lock_);
743 result_ = APPROVED;
744 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800745
746 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
747 // consent is granted.
748 if (ds.options_->is_screenshot_copied) {
749 return android::binder::Status::ok();
750 }
751
752 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
753 !ds.do_early_screenshot_) {
754 return android::binder::Status::ok();
755 }
756
757 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
758 ds.options_->screenshot_fd.get());
759 ds.options_->is_screenshot_copied = copy_succeeded;
760 if (copy_succeeded) {
761 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
762 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000763 return android::binder::Status::ok();
764}
765
766android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
767 std::lock_guard<std::mutex> lock(lock_);
768 result_ = DENIED;
769 MYLOGW("User denied consent to share bugreport\n");
770 return android::binder::Status::ok();
771}
772
773UserConsentResult Dumpstate::ConsentCallback::getResult() {
774 std::lock_guard<std::mutex> lock(lock_);
775 return result_;
776}
777
778uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800779 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000780}
781
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700782void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200783 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700784 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
787 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
789 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
790 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200791 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700792 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700793
Felipe Lemed8b94e52016-12-08 10:21:44 -0800794 printf("========================================================\n");
795 printf("== dumpstate: %s\n", date);
796 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700797
Felipe Lemed8b94e52016-12-08 10:21:44 -0800798 printf("\n");
799 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700800 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
802 printf("Bootloader: %s\n", bootloader.c_str());
803 printf("Radio: %s\n", radio.c_str());
804 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100805 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
806 if (module_metadata_version != 0) {
807 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
808 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200809 printf("Android SDK version: %s\n", sdkversion.c_str());
810 printf("SDK extensions: ");
811 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
812 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700813
Felipe Lemed8b94e52016-12-08 10:21:44 -0800814 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800815 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000817 printf("Bootconfig: ");
818 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800819 printf("Uptime: ");
820 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
821 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800822 printf("Bugreport format version: %s\n", version_.c_str());
Kevin Jeonfa64e642023-07-27 11:36:41 -0400823 printf(
824 "Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d strict_run=%d args=%s "
825 "bugreport_mode=%s\n",
826 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
827 PropertiesHelper::IsStrictRun(), options_->args.c_str(),
828 options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800829 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800830}
831
Felipe Leme24b66ee2016-06-16 10:55:26 -0700832// List of file extensions that can cause a zip file attachment to be rejected by some email
833// service providers.
834static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
835 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
836 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
837 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
838};
839
Vishnu Naire97d6122018-01-18 13:58:56 -0800840status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
841 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700842 std::string valid_name = entry_name;
843
844 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700845 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700846 if (idx != std::string::npos) {
847 std::string extension = entry_name.substr(idx);
848 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
849 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
850 valid_name = entry_name + ".renamed";
851 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
852 }
853 }
854
Felipe Leme6fe9db62016-02-12 09:04:16 -0800855 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
856 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000857 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
858 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700859 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700860 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700861 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700862 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800863 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800864 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000865 bool finished_entry = false;
866 auto finish_entry = [this, &finished_entry] {
867 if (!finished_entry) {
868 // This should only be called when we're going to return an earlier error,
869 // which would've been logged. This may imply the file is already corrupt
870 // and any further logging from FinishEntry is more likely to mislead than
871 // not.
872 this->zip_writer_->FinishEntry();
873 }
874 };
875 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800876 auto start = std::chrono::steady_clock::now();
877 auto end = start + timeout;
878 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800879
Felipe Leme770410d2016-01-26 17:07:14 -0800880 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800881 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800882 if (timeout.count() > 0) {
883 // lambda to recalculate the timeout.
884 auto time_left_ms = [end]() {
885 auto now = std::chrono::steady_clock::now();
886 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
887 return std::max(diff.count(), 0LL);
888 };
889
890 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
891 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000892 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
893 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 return -errno;
895 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000896 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800897 entry_name.c_str(), strerror(errno), timeout.count());
898 return TIMED_OUT;
899 }
900 }
901
Zach Riggle22200402016-08-18 01:01:24 -0400902 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 if (bytes_read == 0) {
904 break;
905 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800906 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800907 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800908 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700909 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700911 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800912 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800913 }
914 }
915
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700916 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000917 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700918 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700919 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921 }
922
Vishnu Naire97d6122018-01-18 13:58:56 -0800923 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800924}
925
Felipe Leme1d486fe2016-10-14 18:06:47 -0700926bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
927 android::base::unique_fd fd(
928 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700929 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800930 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800931 return false;
932 }
933
Vishnu Naire97d6122018-01-18 13:58:56 -0800934 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800935}
936
937/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700938static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800939 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800940}
941
Felipe Leme1d486fe2016-10-14 18:06:47 -0700942void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700943 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800944 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700945 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800946}
947
Felipe Leme1d486fe2016-10-14 18:06:47 -0700948bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800949 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000950 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
951 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700952 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700954 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800955 return false;
956 }
957
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700958 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700959 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700961 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800962 return false;
963 }
964
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700965 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700966 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700967 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800968 return false;
969 }
970
971 return true;
972}
973
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800974static void DoKmsg() {
975 struct stat st;
976 if (!stat(PSTORE_LAST_KMSG, &st)) {
977 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
978 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
979 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
980 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
981 } else {
982 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
983 DumpFile("LAST KMSG", "/proc/last_kmsg");
984 }
985}
986
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800987static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800988 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800989 RunCommand(
990 "KERNEL LOG",
991 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
992 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
993}
994
Nandana Duttdb379fa2019-10-09 16:54:41 +0100995static void DoSystemLogcat(time_t since) {
996 char since_str[80];
997 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
998
999 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
1000 RunCommand("SYSTEM LOG",
1001 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1002 since_str},
1003 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1004}
1005
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001006static void DoRadioLogcat() {
1007 unsigned long timeout_ms = logcat_timeout({"radio"});
1008 RunCommand(
1009 "RADIO LOG",
1010 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1011 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1012}
1013
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001014static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001015 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001016 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1017 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001018 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001019 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001020 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1021 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001022 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001023 RunCommand(
1024 "EVENT LOG",
1025 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001026 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001027 timeout_ms = logcat_timeout({"stats"});
1028 RunCommand(
1029 "STATS LOG",
1030 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001031 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001032 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001033
1034 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1035
1036 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001037 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1038 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001039}
1040
Mike Ma5c267872019-08-21 11:31:34 -07001041static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001042 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1043 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1044 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1045 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1046 if (fd < 0) {
1047 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1048 return;
1049 }
Kevin Jeonfa64e642023-07-27 11:36:41 -04001050 RunCommandToFd(fd, "", {"incident", "-u"},
1051 CommandOptions::WithTimeout(PropertiesHelper::IsStrictRun() ? 20 : 120).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001052 bool empty = 0 == lseek(fd, 0, SEEK_END);
1053 if (!empty) {
1054 // Use a different name from "incident.proto"
1055 // /proto/incident.proto is reserved for incident service dump
1056 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001057 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1058 path);
1059 } else {
1060 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001061 }
Mike Ma5c267872019-08-21 11:31:34 -07001062}
1063
Aaron Huanga99452a2022-04-27 18:51:16 +08001064static void DumpNetstatsProto() {
1065 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1066 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1067 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1068 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1069 if (fd < 0) {
1070 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1071 return;
1072 }
1073 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1074 CommandOptions::WithTimeout(120).Build());
1075 bool empty = 0 == lseek(fd, 0, SEEK_END);
1076 if (!empty) {
1077 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1078 path);
1079 } else {
1080 unlink(path.c_str());
1081 }
1082}
1083
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001084static void MaybeAddSystemTraceToZip() {
1085 // This function copies into the .zip the system trace that was snapshotted
1086 // by the early call to MaybeSnapshotSystemTrace(), if any background
1087 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001088 if (!ds.has_system_trace_) {
1089 // No background trace was happening at the time dumpstate was invoked.
1090 return;
1091 }
1092 ds.AddZipEntry(
1093 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1094 SYSTEM_TRACE_SNAPSHOT);
1095 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1096}
1097
Sunny Goyal35949782019-11-19 15:54:36 -08001098static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001099 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1100 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1101 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1102 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1103 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1104 if (fd < 0) {
1105 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1106 return;
1107 }
1108 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001109 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001110 bool empty = 0 == lseek(fd, 0, SEEK_END);
1111 if (!empty) {
1112 ds.AddZipEntry("visible_windows.zip", path);
1113 } else {
1114 MYLOGW("Failed to dump visible windows\n");
1115 }
1116 unlink(path.c_str());
1117}
1118
Jayachandran Ca94c7172017-06-10 15:08:12 -07001119static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001120 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1121 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001122 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001123 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001124 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1125 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1126 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1127 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001128}
1129
Woody Lin20767a92022-11-29 15:50:24 +08001130static void DumpShutdownCheckpoints() {
1131 const bool shutdown_checkpoints_dumped = AddDumps(
1132 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1133 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1134 if (!shutdown_checkpoints_dumped) {
1135 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1136 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1137 }
1138}
1139
David Andersond9ba4752018-12-11 18:26:59 -08001140static void DumpDynamicPartitionInfo() {
1141 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1142 return;
1143 }
1144
1145 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001146 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001147}
1148
Chris Morin5a50d482022-02-01 17:41:18 -08001149static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001150 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1151 anr_traces_dir.c_str());
1152
1153 // If we're here, dump_traces_path will always be a temporary file
1154 // (created with mkostemp or similar) that contains dumps taken earlier
1155 // on in the process.
1156 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001157 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1158 dump_traces_path);
1159 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001160
1161 const int ret = unlink(dump_traces_path);
1162 if (ret == -1) {
1163 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1164 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001165 }
1166 }
1167
Narayan Kamathbd863722017-06-01 18:50:12 +01001168 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001169 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001170 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001171 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001172 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001173
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001174 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001175 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001176 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001177 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001178 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1179 }
1180}
1181
1182static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001183 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001184
Chris Morin5a50d482022-02-01 17:41:18 -08001185 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001186
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001187 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1188
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001189 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001190 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001191 int i = 0;
1192 while (true) {
1193 const std::string slow_trace_path =
1194 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1195 if (stat(slow_trace_path.c_str(), &st)) {
1196 // No traces file at this index, done with the files.
1197 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001198 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001199 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1200 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001201 }
1202}
1203
Wei Wang509bb5d2017-06-09 14:42:12 -07001204static void DumpBlockStatFiles() {
1205 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001206
Wei Wang1dc1ef52017-06-12 11:28:37 -07001207 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1208
1209 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001210 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1211 return;
1212 }
1213
1214 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001215 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001216 if ((d->d_name[0] == '.')
1217 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1218 || (d->d_name[1] == '\0'))) {
1219 continue;
1220 }
1221 const std::string new_path =
1222 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1223 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1224 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1225 printf("\n");
1226 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001227 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001228}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001229
1230static void DumpPacketStats() {
1231 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001232}
1233
1234static void DumpIpAddrAndRules() {
1235 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1236 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1237 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1238 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1239 RunCommand("IP RULES", {"ip", "rule", "show"});
1240 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1241}
1242
Nandana Dutt5c390032019-03-12 10:52:56 +00001243static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1244 std::chrono::milliseconds timeout,
1245 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001246 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001247 sp<android::IServiceManager> sm = defaultServiceManager();
1248 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001249 Vector<String16> args;
1250 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001251 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1252 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001253 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001254 std::string path(title);
1255 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001256 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001257 if (PropertiesHelper::IsDryRun()) {
1258 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1259 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1260 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001261 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1262 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001263 service, args);
1264 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001265 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1266 std::chrono::duration<double> elapsed_seconds;
1267 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1268 service == String16("meminfo")) {
1269 // Use a longer timeout for meminfo, since 30s is not always enough.
1270 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1271 /* as_proto = */ false, elapsed_seconds,
1272 bytes_written);
1273 } else {
1274 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1275 /* as_proto = */ false, elapsed_seconds,
1276 bytes_written);
1277 }
1278 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1279 bool dump_complete = (status == OK);
1280 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001281 } else {
1282 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1283 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001284 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001285 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001286
1287 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1288 std::chrono::steady_clock::now() - start);
1289 if (elapsed_duration > timeout) {
1290 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1291 elapsed_duration.count());
1292 break;
1293 }
1294 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001295 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001296}
1297
Vishnu Nair64afc022018-02-01 15:29:34 -08001298static void RunDumpsysText(const std::string& title, int priority,
1299 std::chrono::milliseconds timeout,
1300 std::chrono::milliseconds service_timeout) {
1301 DurationReporter duration_reporter(title);
1302 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1303 fsync(STDOUT_FILENO);
1304 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1305}
1306
1307/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001308static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1309 std::chrono::milliseconds timeout,
1310 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001311 DurationReporter duration_reporter(title);
1312 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1313 fsync(STDOUT_FILENO);
1314 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1315 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001316
1317 RETURN_IF_USER_DENIED_CONSENT();
1318
1319 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1320 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001321}
1322
Nandana Dutt5c390032019-03-12 10:52:56 +00001323static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1324 std::chrono::milliseconds timeout,
1325 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001326 sp<android::IServiceManager> sm = defaultServiceManager();
1327 Dumpsys dumpsys(sm.get());
1328 Vector<String16> args;
1329 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1330 DurationReporter duration_reporter(title);
1331
1332 auto start = std::chrono::steady_clock::now();
1333 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1334 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001335 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001336 std::string path(kProtoPath);
1337 path.append(String8(service).c_str());
1338 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1339 path.append("_CRITICAL");
1340 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1341 path.append("_HIGH");
1342 }
1343 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001344 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001345 if (status == OK) {
1346 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1347 bool dumpTerminated = (status == OK);
1348 dumpsys.stopDumpThread(dumpTerminated);
1349 }
1350 ZipWriter::FileEntry file_entry;
1351 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001352
1353 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1354 std::chrono::steady_clock::now() - start);
1355 if (elapsed_duration > timeout) {
1356 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1357 elapsed_duration.count());
1358 break;
1359 }
1360 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001361 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001362}
1363
Nandana Dutta7db6342018-11-21 14:53:34 +00001364// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001365static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001366 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1367 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001368
1369 RETURN_IF_USER_DENIED_CONSENT();
1370
1371 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1372 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001373}
1374
1375// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001376static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001377 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1378 // high priority. Reduce timeout once they are able to dump in a shorter time or
1379 // moved to a parallel task.
1380 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1381 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001382
1383 RETURN_IF_USER_DENIED_CONSENT();
1384
1385 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1386 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001387}
1388
1389// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001390static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001391 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001392
1393 RETURN_IF_USER_DENIED_CONSENT();
1394
1395 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1396 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001397}
1398
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001399/*
1400 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1401 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1402 * if it's not running in the parallel task.
1403 */
1404static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001405 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001406 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1407 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001408
Steven Moreland44cd9482018-01-04 16:24:13 -08001409 using android::hidl::manager::V1_0::IServiceManager;
1410 using android::hardware::defaultServiceManager;
1411
1412 sp<IServiceManager> sm = defaultServiceManager();
1413 if (sm == nullptr) {
1414 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1415 return;
1416 }
1417
1418 auto ret = sm->list([&](const auto& interfaces) {
1419 for (const std::string& interface : interfaces) {
1420 std::string cleanName = interface;
1421 std::replace_if(cleanName.begin(),
1422 cleanName.end(),
1423 [](char c) {
1424 return !isalnum(c) &&
1425 std::string("@-_:.").find(c) == std::string::npos;
1426 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001427 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001428
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001429 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001430 {
1431 auto fd = android::base::unique_fd(
1432 TEMP_FAILURE_RETRY(open(path.c_str(),
1433 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1434 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1435 if (fd < 0) {
1436 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1437 continue;
1438 }
1439 RunCommandToFd(fd,
1440 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001441 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001442 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1443
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001444 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001445 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001446 if (!empty) {
1447 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1448 path);
1449 } else {
1450 unlink(path.c_str());
1451 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001452 }
1453 });
1454
1455 if (!ret.isOk()) {
1456 MYLOGE("Could not list hals from hwservicemanager.\n");
1457 }
1458}
1459
Devin Moore8df81bb2022-06-08 22:47:02 +00001460// Dump all of the files that make up the vendor interface.
1461// See the files listed in dumpFileList() for the latest list of files.
1462static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001463
1464 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1465 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001466 for (const auto vintfFile : vintfFiles) {
1467 struct stat st;
1468 if (stat(vintfFile.c_str(), &st) == 0) {
1469 if (S_ISDIR(st.st_mode)) {
1470 ds.AddDir(vintfFile, true /* recursive */);
1471 } else {
1472 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1473 vintfFile);
1474 }
1475 }
1476 }
1477}
1478
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001479static void DumpExternalFragmentationInfo() {
1480 struct stat st;
1481 if (stat("/proc/buddyinfo", &st) != 0) {
1482 MYLOGE("Unable to dump external fragmentation info\n");
1483 return;
1484 }
1485
1486 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1487 std::ifstream ifs("/proc/buddyinfo");
1488 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1489 for (std::string line; std::getline(ifs, line);) {
1490 std::smatch match_results;
1491 if (std::regex_match(line, match_results, unusable_index_regex)) {
1492 std::stringstream free_pages(std::string{match_results[3]});
1493 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1494 std::istream_iterator<int>());
1495
1496 int total_free_pages = 0;
1497 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1498 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1499 }
1500
1501 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1502 match_results[2].str().c_str());
1503
1504 int usable_free_pages = total_free_pages;
1505 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1506 auto unusable_index = (total_free_pages - usable_free_pages) /
1507 static_cast<double>(total_free_pages);
1508 printf(" %5.3f", unusable_index);
1509 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1510 }
1511
1512 printf("\n");
1513 }
1514 }
1515 printf("\n");
1516}
1517
mhasankd451a472020-05-26 18:02:39 -07001518static void DumpstateLimitedOnly() {
1519 // Trimmed-down version of dumpstate to only include a whitelisted
1520 // set of logs (system log, event log, and system server / system app
1521 // crashes, and networking logs). See b/136273873 and b/138459828
1522 // for context.
1523 DurationReporter duration_reporter("DUMPSTATE");
1524 unsigned long timeout_ms;
1525 // calculate timeout
1526 timeout_ms = logcat_timeout({"main", "system", "crash"});
1527 RunCommand("SYSTEM LOG",
1528 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1529 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1530 timeout_ms = logcat_timeout({"events"});
1531 RunCommand(
1532 "EVENT LOG",
1533 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1534 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1535
1536 printf("========================================================\n");
1537 printf("== Networking Service\n");
1538 printf("========================================================\n");
1539
1540 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1541 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001542 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1543 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001544
1545 printf("========================================================\n");
1546 printf("== Dropbox crashes\n");
1547 printf("========================================================\n");
1548
1549 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1550 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1551
1552 printf("========================================================\n");
1553 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1554 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1555 printf("========================================================\n");
1556 printf("== dumpstate: done (id %d)\n", ds.id_);
1557 printf("========================================================\n");
1558}
1559
Rhed Jaoe017f982020-07-21 17:58:41 +08001560/*
1561 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1562 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1563 * if it's not running in the parallel task.
1564 */
1565static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1566 dprintf(out_fd, "========================================================\n");
1567 dprintf(out_fd, "== Checkins\n");
1568 dprintf(out_fd, "========================================================\n");
1569
1570 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001571 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1572 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1573 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1574 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1575}
1576
1577/*
1578 * Runs dumpsys on activity service to dump all application activities, services
1579 * and providers in the device.
1580 *
1581 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1582 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1583 * if it's not running in the parallel task.
1584 */
1585static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1586 dprintf(out_fd, "========================================================\n");
1587 dprintf(out_fd, "== Running Application Activities\n");
1588 dprintf(out_fd, "========================================================\n");
1589
1590 // The following dumpsys internally collects output from running apps, so it can take a long
1591 // time. So let's extend the timeout.
1592
1593 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1594
1595 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1596
1597 dprintf(out_fd, "========================================================\n");
1598 dprintf(out_fd, "== Running Application Services (platform)\n");
1599 dprintf(out_fd, "========================================================\n");
1600
1601 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1602 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1603
1604 dprintf(out_fd, "========================================================\n");
1605 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1606 dprintf(out_fd, "========================================================\n");
1607
1608 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1609 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1610
1611 dprintf(out_fd, "========================================================\n");
1612 dprintf(out_fd, "== Running Application Providers (platform)\n");
1613 dprintf(out_fd, "========================================================\n");
1614
1615 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001616 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001617
1618 dprintf(out_fd, "========================================================\n");
1619 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1620 dprintf(out_fd, "========================================================\n");
1621
1622 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1623 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1624}
1625
Nandana Dutt5c390032019-03-12 10:52:56 +00001626// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1627// via the consent they are shown. Ignores other errors that occur while running various
1628// commands. The consent checking is currently done around long running tasks, which happen to
1629// be distributed fairly evenly throughout the function.
1630static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001631 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001632
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001633 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001634 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1635 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001636 if (ds.dump_pool_) {
1637 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1638 // drop root user. Restarts it with two threads for the parallel run.
1639 ds.dump_pool_->start(/* thread_counts = */2);
1640
Chris Morinbc223142022-02-04 14:17:11 -08001641 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1642 dump_incident_report = ds.dump_pool_->enqueueTask(
1643 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001644 dump_netstats_report = ds.dump_pool_->enqueueTask(
1645 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001646 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1647 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1648 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001649 }
1650
Nandana Dutt5c390032019-03-12 10:52:56 +00001651 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1652 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1653 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001654 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001655 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001656 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001657 DumpFile("MEMORY INFO", "/proc/meminfo");
1658 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001659 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001660
Kevin Jeon947922b2022-09-21 00:29:18 +00001661 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1662 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001663
Sunny Goyal35949782019-11-19 15:54:36 -08001664 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1665
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001666 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1667 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1668 DumpFile("SLAB INFO", "/proc/slabinfo");
1669 DumpFile("ZONEINFO", "/proc/zoneinfo");
1670 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1671 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001672 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001673
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001674 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001675
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001676 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001677 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001678
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001679 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001680 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001681 } else {
1682 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1683 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001684
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001685 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001686 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001687 struct stat s;
1688 if (stat("/proc/modules", &s) != 0) {
1689 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1690 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001691 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001692 RunCommand("MODULES INFO",
1693 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1694 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1695 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001696 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001697
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001698 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001699 DoKernelLogcat();
1700 } else {
1701 do_dmesg();
1702 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Devin Moore8df81bb2022-06-08 22:47:02 +00001704 DumpVintf();
1705
Felipe Lemef0292972016-11-22 13:57:05 -08001706 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001707
Jeff Brown1dc94e32014-09-11 14:15:27 -07001708 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001709 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710
Jack Yu5a6b2e22020-08-14 18:13:35 +08001711 /* Dump Nfc NCI logs */
1712 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001713
Paul Chang0d2aad72020-02-13 20:04:03 +08001714 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001715 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001716 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001717 }
1718
Felipe Lemee184f662016-10-27 10:04:47 -07001719 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001720
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001721 MaybeAddSystemTraceToZip();
1722
Narayan Kamath8f788292017-05-25 13:20:39 +01001723 // NOTE: tombstones are always added as separate entries in the zip archive
1724 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001725 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001726 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001727 if (!tombstones_dumped) {
1728 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001729 }
1730
Jayachandran Ca94c7172017-06-10 15:08:12 -07001731 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001732
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001733 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001734
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001735 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001736
Woody Lin20767a92022-11-29 15:50:24 +08001737 DumpShutdownCheckpoints();
1738
Jayachandran Ca94c7172017-06-10 15:08:12 -07001739 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001740
1741 dump_route_tables();
1742
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001743 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1744 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1745 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001746
Nandana Dutt5c390032019-03-12 10:52:56 +00001747 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001748
Chiachang Wang668ede42021-05-17 17:14:20 +08001749 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1750 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1751 // dump with priority parameters to dump high priority information.
1752 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1753 CommandOptions::WithTimeout(10).Build());
1754
Elliott Hughes23ccc622017-02-28 10:14:22 -08001755 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001756
Jin Qianf334d662017-10-10 14:41:37 -07001757 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001758
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001759 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001760
Colin Crossf45fa6b2012-03-26 12:38:26 -07001761 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001762 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1763 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1764
1765 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1766 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1767 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1768 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1769 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001770
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001771 /* Add window and surface trace files. */
1772 if (!PropertiesHelper::IsUserBuild()) {
1773 ds.AddDir(WMTRACE_DATA_DIR, false);
1774 }
1775
Yifan Hongd90cc652020-02-08 16:52:02 -08001776 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1777
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001778 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001779 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001780 } else {
1781 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1782 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001783
Steven Moreland7440ddb2016-12-15 16:13:39 -08001784 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001785 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1786 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001787 // su does not exist on user builds, so try running without it.
1788 // This way any implementations of vril-dump that do not require
1789 // root can run on user builds.
1790 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001791 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001792 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001793 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001794 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001795 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001796 }
1797
Felipe Lemed8b94e52016-12-08 10:21:44 -08001798 printf("========================================================\n");
1799 printf("== Android Framework Services\n");
1800 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001801
Nandana Dutt5c390032019-03-12 10:52:56 +00001802 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001803
Jack He91ff2fe2021-02-18 18:23:43 -08001804 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1805 ds.AddDir("/data/misc/bluetooth/logs", true);
1806
Rhed Jaoe017f982020-07-21 17:58:41 +08001807 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001808 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001809 } else {
1810 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1811 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001812
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001813 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001814
Adrian Roos8b397ab2017-04-04 16:35:44 -07001815 printf("========================================================\n");
1816 printf("== Dropbox crashes\n");
1817 printf("========================================================\n");
1818
1819 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1820 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1821
Felipe Lemed8b94e52016-12-08 10:21:44 -08001822 printf("========================================================\n");
1823 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1824 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1825 printf("========================================================\n");
1826 printf("== dumpstate: done (id %d)\n", ds.id_);
1827 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001828
1829 printf("========================================================\n");
1830 printf("== Obtaining statsd metadata\n");
1831 printf("========================================================\n");
1832 // This differs from the usual dumpsys stats, which is the stats report data.
1833 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001834
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001835 // Add linker configuration directory
1836 ds.AddDir(LINKERCONFIG_DIR, true);
1837
Li Li830179f2022-01-04 12:53:29 -08001838 /* Dump frozen cgroupfs */
1839 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001840
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001841 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001842 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1843 } else {
1844 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1845 DumpNetstatsProto);
1846 }
1847
1848 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001849 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001850 } else {
1851 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1852 DumpIncidentReport);
1853 }
Mike Ma5c267872019-08-21 11:31:34 -07001854
Nandana Dutt5c390032019-03-12 10:52:56 +00001855 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001856}
1857
Nandana Dutt5c390032019-03-12 10:52:56 +00001858/*
1859 * Dumps state for the default case; drops root after it's no longer necessary.
1860 *
1861 * Returns RunStatus::OK if everything went fine.
1862 * Returns RunStatus::ERROR if there was an error.
1863 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1864 * with the caller.
1865 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001866Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001867 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1868 // buffer.
1869 DoLogcat();
1870 // Capture timestamp after first logcat to use in next logcat
1871 time_t logcat_ts = time(nullptr);
1872
Nandana Dutt4be45d12018-09-26 15:04:23 +01001873 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001874 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001875 if (dump_pool_) {
1876 RETURN_IF_USER_DENIED_CONSENT();
1877 // One thread is enough since we only need to enqueue DumpTraces here.
1878 dump_pool_->start(/* thread_counts = */1);
1879
1880 // DumpTraces takes long time, post it to the another thread in the
1881 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001882 dump_traces = dump_pool_->enqueueTask(
1883 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001884 } else {
1885 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1886 &dump_traces_path);
1887 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001888
1889 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001890 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001891 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1892 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001893 ds.shutdown_checkpoints_ = GetDumpFds(
1894 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001895 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001896
1897 ds.AddDir(RECOVERY_DIR, true);
1898 ds.AddDir(RECOVERY_DATA_DIR, true);
1899 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001900 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001901 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1902 if (!PropertiesHelper::IsUserBuild()) {
1903 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1904 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001905 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001906 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001907 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001908 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001909 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1910 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1911 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001912 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001913 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001914 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001915 if (!PropertiesHelper::IsUserBuild()) {
1916 // Include dropbox entry files inside ZIP, but exclude
1917 // noisy WTF and StrictMode entries
1918 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1919 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001920
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001921 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001922 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1923
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001924 // Dump IPsec stats. No keys are exposed here.
1925 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1926
Nandana Dutt4be45d12018-09-26 15:04:23 +01001927 // Run ss as root so we can see socket marks.
1928 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1929
1930 // Run iotop as root to show top 100 IO threads
1931 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1932
Erick Reyese68df822019-02-11 14:46:36 -08001933 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001934 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1935 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001936
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001937 DumpFile("PSI cpu", "/proc/pressure/cpu");
1938 DumpFile("PSI memory", "/proc/pressure/memory");
1939 DumpFile("PSI io", "/proc/pressure/io");
1940
Mårten Kongstad60195a72022-09-20 14:14:20 +02001941 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1942 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1943
Rhed Jao5377d792020-07-16 17:37:39 +08001944 if (dump_pool_) {
1945 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001946 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001947
Chris Morinbc223142022-02-04 14:17:11 -08001948 // Current running thread in the pool is the root user also. Delete
1949 // the pool and make a new one later to ensure none of threads in the pool are root.
1950 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001951 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001952 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001953 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001954 }
1955
Nandana Dutt5c390032019-03-12 10:52:56 +00001956 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001957 Dumpstate::RunStatus status = dumpstate();
1958 // Capture logcat since the last time we did it.
1959 DoSystemLogcat(logcat_ts);
1960 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001961}
1962
Rhed Jaob5685b32020-08-14 17:19:17 +08001963// Common states for telephony and wifi which are needed to be collected before
1964// dumpstate drop the root user.
1965static void DumpstateRadioAsRoot() {
1966 DumpIpTablesAsRoot();
1967 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1968}
1969
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001970// This method collects common dumpsys for telephony and wifi. Typically, wifi
1971// reports are fine to include all information, but telephony reports on user
1972// builds need to strip some content (see DumpstateTelephonyOnly).
1973static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001974 // We need to be picky about some stuff for telephony reports on user builds.
1975 if (!include_sensitive_info) {
1976 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1977 DoRadioLogcat();
1978 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001979 // DumpHals takes long time, post it to the another thread in the pool,
1980 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001981 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001982 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001983 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001984 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001985 // Contains various system properties and process startup info.
1986 do_dmesg();
1987 // Logs other than the radio buffer may contain package/component names and potential PII.
1988 DoLogcat();
1989 // Too broad for connectivity problems.
1990 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001991 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1992 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001993 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001994 } else {
1995 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1996 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001997 }
1998
Jayachandran Ca94c7172017-06-10 15:08:12 -07001999 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002000 DumpIpAddrAndRules();
2001 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002002 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2003 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002004}
2005
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002006// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2007// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2008// for what can be included on user builds: all reported information MUST directly relate to
2009// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2010// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2011// names are not), and MUST NOT contain logs of user application traffic.
2012// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002013static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002014 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002015
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002016 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002017
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002018 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002019
Rhed Jaob5685b32020-08-14 17:19:17 +08002020 DumpstateRadioAsRoot();
2021 if (!DropRootUser()) {
2022 return;
2023 }
2024
2025 // Starts thread pool after the root user is dropped, and two additional threads
2026 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002027 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002028 if (ds.dump_pool_) {
2029 ds.dump_pool_->start(/*thread_counts =*/2);
2030
2031 // DumpstateBoard takes long time, post it to the another thread in the pool,
2032 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002033 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2034 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002035 }
2036
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002037 DumpstateRadioCommon(include_sensitive_info);
2038
2039 if (include_sensitive_info) {
2040 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2041 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2042 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2043 // way.
2044 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2045 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002046
2047 printf("========================================================\n");
2048 printf("== Android Framework Services\n");
2049 printf("========================================================\n");
2050
Vishnu Nair652cc802017-11-30 15:18:30 -08002051 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2052 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002053 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2054 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002055 if (include_sensitive_info) {
2056 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2057 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2058 SEC_TO_MSEC(10));
2059 } else {
2060 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2061 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2062 // give a higher timeout as well.
2063 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2064 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2065 }
2066 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002067 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2068 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002069 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002070 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2071 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002072 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2073 SEC_TO_MSEC(10));
Grant Menke9bf3b2b2023-02-24 13:11:07 -08002074 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2075 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002076 if (include_sensitive_info) {
2077 // Contains raw IP addresses, omit from reports on user builds.
2078 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2079 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2080 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2081 SEC_TO_MSEC(10));
2082 // Contains package/component names, omit from reports on user builds.
2083 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2084 SEC_TO_MSEC(10));
2085 // Contains package names, but should be relatively simple to remove them (also contains
2086 // UIDs already), omit from reports on user builds.
2087 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2088 SEC_TO_MSEC(10));
2089 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002090
2091 printf("========================================================\n");
2092 printf("== Running Application Services\n");
2093 printf("========================================================\n");
2094
2095 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2096
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002097 if (include_sensitive_info) {
2098 printf("========================================================\n");
2099 printf("== Running Application Services (non-platform)\n");
2100 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002101
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002102 // Contains package/component names and potential PII, omit from reports on user builds.
2103 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2104 // carrier_config dumpsys instead.
2105 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2106 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002107
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002108 printf("========================================================\n");
2109 printf("== Checkins\n");
2110 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002111
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002112 // Contains package/component names, omit from reports on user builds.
2113 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2114 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002115
2116 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002117 printf("== dumpstate: done (id %d)\n", ds.id_);
2118 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002119
2120 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002121 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002122 } else {
2123 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2124 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002125}
2126
mukesh agrawal253dad42018-01-23 21:59:59 -08002127// This method collects dumpsys for wifi debugging only
2128static void DumpstateWifiOnly() {
2129 DurationReporter duration_reporter("DUMPSTATE");
2130
Rhed Jaob5685b32020-08-14 17:19:17 +08002131 DumpstateRadioAsRoot();
2132 if (!DropRootUser()) {
2133 return;
2134 }
2135
2136 // Starts thread pool after the root user is dropped. Only one additional
2137 // thread is needed for DumpHals in the DumpstateRadioCommon.
2138 if (ds.dump_pool_) {
2139 ds.dump_pool_->start(/*thread_counts =*/1);
2140 }
2141
mukesh agrawal253dad42018-01-23 21:59:59 -08002142 DumpstateRadioCommon();
2143
2144 printf("========================================================\n");
2145 printf("== Android Framework Services\n");
2146 printf("========================================================\n");
2147
2148 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2149 SEC_TO_MSEC(10));
2150 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2151 SEC_TO_MSEC(10));
2152
2153 printf("========================================================\n");
2154 printf("== dumpstate: done (id %d)\n", ds.id_);
2155 printf("========================================================\n");
2156}
2157
Nandana Duttcf419a72019-03-14 10:40:17 +00002158Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002159 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002160 const size_t buf_size = temp_file_pattern.length() + 1;
2161 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2162 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2163
2164 // Create a new, empty file to receive all trace dumps.
2165 //
2166 // TODO: This can be simplified once we remove support for the old style
2167 // dumps. We can have a file descriptor passed in to dump_traces instead
2168 // of creating a file, closing it and then reopening it again.
2169 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2170 if (fd < 0) {
2171 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002172 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002173 }
2174
2175 // Nobody should have access to this temporary file except dumpstate, but we
2176 // temporarily grant 'read' to 'others' here because this file is created
2177 // when tombstoned is still running as root, but dumped after dropping. This
2178 // can go away once support for old style dumping has.
2179 const int chmod_ret = fchmod(fd, 0666);
2180 if (chmod_ret < 0) {
2181 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002182 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002183 }
2184
2185 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2186 if (proc.get() == nullptr) {
2187 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002188 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002189 }
2190
2191 // Number of times process dumping has timed out. If we encounter too many
2192 // failures, we'll give up.
2193 int timeout_failures = 0;
2194 bool dalvik_found = false;
2195
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002196 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002197
2198 struct dirent* d;
2199 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002200 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002201 int pid = atoi(d->d_name);
2202 if (pid <= 0) {
2203 continue;
2204 }
2205
Kevin Jeond0f8a982023-04-07 14:27:11 -04002206 // Skip cached processes.
2207 if (IsCached(pid)) {
2208 // For consistency, the header and footer to this message match those
2209 // dumped by debuggerd in the success case.
2210 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2211 dprintf(fd, "Dump skipped for cached process.\n");
2212 dprintf(fd, "---- end %d ----", pid);
2213 continue;
2214 }
2215
Nandana Duttfaafd522019-03-11 09:23:09 +00002216 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2217 std::string exe;
2218 if (!android::base::Readlink(link_name, &exe)) {
2219 continue;
2220 }
2221
2222 bool is_java_process;
2223 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2224 // Don't bother dumping backtraces for the zygote.
2225 if (IsZygote(pid)) {
2226 continue;
2227 }
2228
2229 dalvik_found = true;
2230 is_java_process = true;
2231 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2232 is_java_process = false;
2233 } else {
2234 // Probably a native process we don't care about, continue.
2235 continue;
2236 }
2237
2238 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2239 if (timeout_failures == 3) {
2240 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2241 break;
2242 }
2243
2244 const uint64_t start = Nanotime();
2245 const int ret = dump_backtrace_to_file_timeout(
Kevin Jeonb8a39362023-04-04 15:00:34 -04002246 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
Nandana Duttfaafd522019-03-11 09:23:09 +00002247
2248 if (ret == -1) {
2249 // For consistency, the header and footer to this message match those
2250 // dumped by debuggerd in the success case.
2251 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2252 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2253 dprintf(fd, "---- end %d ----", pid);
2254 timeout_failures++;
2255 continue;
2256 }
2257
2258 // We've successfully dumped stack traces, reset the failure count
2259 // and write a summary of the elapsed time to the file and continue with the
2260 // next process.
2261 timeout_failures = 0;
2262
2263 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2264 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2265 }
2266
2267 if (!dalvik_found) {
2268 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2269 }
2270
Nandana Duttcf419a72019-03-14 10:40:17 +00002271 *path = file_name_buf.release();
2272 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002273}
2274
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002275static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2276 const Dumpstate::BugreportMode bugreport_mode) {
2277 switch (bugreport_mode) {
2278 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2279 return dumpstate_hal_hidl::DumpstateMode::FULL;
2280 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2281 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2282 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2283 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2284 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2285 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2286 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2287 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2288 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2289 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2290 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2291 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2292 }
2293 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2294}
2295
2296static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2297 const Dumpstate::BugreportMode bugreport_mode) {
2298 switch (bugreport_mode) {
2299 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2300 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2301 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2302 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2303 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2304 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2305 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2306 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2307 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2308 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2309 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2310 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2311 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2312 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2313 }
2314 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2315}
2316
2317static void DoDumpstateBoardHidl(
2318 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2319 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2320 const Dumpstate::BugreportMode bugreport_mode,
2321 const size_t timeout_sec) {
2322
2323 using ScopedNativeHandle =
2324 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2325 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2326 [](native_handle_t* handle) {
2327 // we don't close file handle's here
2328 // via native_handle_close(handle)
2329 // instead we let dumpstate_fds close the file handles when
2330 // dumpstate_fds gets destroyed
2331 native_handle_delete(handle);
2332 });
2333 if (handle == nullptr) {
2334 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2335 return;
2336 }
2337
2338 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2339 handle.get()->data[i] = dumpstate_fds[i].get();
2340 }
2341
2342 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2343 // implement just 1.0.
2344 const char* descriptor_to_kill;
2345 using DumpstateBoardTask = std::packaged_task<bool()>;
2346 DumpstateBoardTask dumpstate_board_task;
2347 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2348 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2349 if (dumpstate_hal != nullptr) {
2350 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2351
2352 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2353 GetDumpstateHalModeHidl(bugreport_mode);
2354
2355 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2356 dumpstate_board_task =
2357 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2358 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2359 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2360 SEC_TO_MSEC(timeout_sec));
2361 if (!status.isOk()) {
2362 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2363 return false;
2364 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2365 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2366 dumpstate_hal_hidl::toString(status).c_str());
2367 return false;
2368 }
2369 return true;
2370 });
2371 } else {
2372 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2373
2374 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2375 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2376 ::android::hardware::Return<void> status =
2377 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2378 if (!status.isOk()) {
2379 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2380 return false;
2381 }
2382 return true;
2383 });
2384 }
2385 auto result = dumpstate_board_task.get_future();
2386 std::thread(std::move(dumpstate_board_task)).detach();
2387
2388 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2389 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2390 if (!android::base::SetProperty(
2391 "ctl.interface_restart",
2392 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2393 MYLOGE("Couldn't restart dumpstate HAL\n");
2394 }
2395 }
2396 // Wait some time for init to kill dumpstate vendor HAL
2397 constexpr size_t killing_timeout_sec = 10;
2398 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2399 MYLOGE(
2400 "killing dumpstateBoard timed out after %zus, continue and "
2401 "there might be racing in content\n",
2402 killing_timeout_sec);
2403 }
2404}
2405
2406static void DoDumpstateBoardAidl(
2407 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2408 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2409 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2410 MYLOGI("Using IDumpstateDevice AIDL HAL");
2411
2412 const char* descriptor_to_kill;
2413 using DumpstateBoardTask = std::packaged_task<bool()>;
2414 DumpstateBoardTask dumpstate_board_task;
2415 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2416 GetDumpstateHalModeAidl(bugreport_mode);
2417
2418 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2419 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2420 timeout_sec]() -> bool {
2421 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2422
2423 if (!status.isOk()) {
2424 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2425 return false;
2426 }
2427 return true;
2428 });
2429 auto result = dumpstate_board_task.get_future();
2430 std::thread(std::move(dumpstate_board_task)).detach();
2431
2432 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2433 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2434 if (!android::base::SetProperty(
2435 "ctl.interface_restart",
2436 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2437 MYLOGE("Couldn't restart dumpstate HAL\n");
2438 }
2439 }
2440 // Wait some time for init to kill dumpstate vendor HAL
2441 constexpr size_t killing_timeout_sec = 10;
2442 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2443 MYLOGE(
2444 "killing dumpstateBoard timed out after %zus, continue and "
2445 "there might be racing in content\n",
2446 killing_timeout_sec);
2447 }
2448}
2449
2450static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2451 const std::string aidl_instance_name =
2452 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2453
2454 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2455 return nullptr;
2456 }
2457
2458 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2459
2460 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2461}
2462
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002463void Dumpstate::DumpstateBoard(int out_fd) {
2464 dprintf(out_fd, "========================================================\n");
2465 dprintf(out_fd, "== Board\n");
2466 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002467
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002468 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002469 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002470 * set to true and unmount it after invoking dumpstateBoard_* methods.
2471 * This is to enable debug builds to not have debugfs mounted during runtime.
2472 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002473 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002474 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002475 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002476 if (mount_debugfs) {
2477 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2478 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002479 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002480 }
2481
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002482 std::vector<std::string> paths;
2483 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002484 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002485 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2486 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002487 remover.emplace_back(android::base::make_scope_guard(
2488 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002489 }
Jie Song9fbfad02017-06-20 16:29:42 -07002490
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002491 // get dumpstate HAL AIDL implementation
2492 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2493 GetDumpstateBoardAidlService());
2494 if (dumpstate_hal_handle_aidl == nullptr) {
2495 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2496 }
2497
2498 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2499 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2500 if (dumpstate_hal_handle_aidl == nullptr) {
2501 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2502 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2503 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2504 }
2505 }
2506
2507 // if neither HIDL nor AIDL implementation found, then return
2508 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2509 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002510 return;
2511 }
2512
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002513 // this is used to hold the file descriptors and when this variable goes out of scope
2514 // the file descriptors are closed
2515 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002516
Nandana Dutt5c390032019-03-12 10:52:56 +00002517 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002518 for (size_t i = 0; i < paths.size(); i++) {
2519 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2520
2521 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2522 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2523 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2524 if (fd < 0) {
2525 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2526 return;
2527 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002528
2529 dumpstate_fds.emplace_back(fd.release());
2530 // we call fd.release() here to make sure "fd" does not get closed
2531 // after "fd" goes out of scope after this block.
2532 // "fd" will be closed when "dumpstate_fds" goes out of scope
2533 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002534 }
2535
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002536 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2537 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2538 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002539 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002540
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002541 if (dumpstate_hal_handle_aidl != nullptr) {
2542 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2543 timeout_sec);
2544 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2545 // run HIDL HAL only if AIDL HAL not found
2546 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2547 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002548 }
2549
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002550 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002551 auto keep_debugfs_mounted =
2552 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2553 if (keep_debugfs_mounted.empty())
2554 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002555 }
2556
Wei Wang587eac92018-04-05 12:17:20 -07002557 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2558 for (size_t i = 0; i < paths.size(); i++) {
2559 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002560 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2561 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002562 file_sizes[i] = -1;
2563 continue;
2564 }
2565 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002566 }
2567
2568 for (size_t i = 0; i < paths.size(); i++) {
2569 if (file_sizes[i] == -1) {
2570 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002571 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002572 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002573 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002574 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002575 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002576 remover[i].Disable();
2577 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2578 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002579 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002580}
2581
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002582static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002583 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002584 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2585 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002586 " -h: display this help message\n"
2587 " -b: play sound file instead of vibrate, at beginning of job\n"
2588 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002589 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002590 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002591 " -s: write zipped file to control socket (for init)\n"
2592 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002593 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002594 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002595 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002596 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002597 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002598 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002599}
2600
Wei Liuf87959e2016-08-26 14:51:42 -07002601static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002602 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002603}
2604
Felipe Leme1d486fe2016-10-14 18:06:47 -07002605bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002606 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2607 if (zip_entry_tasks_) {
2608 zip_entry_tasks_->run(/* do_cancel = */false);
2609 }
2610
Felipe Leme9a523ae2016-10-20 15:10:33 -07002611 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002612 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002613 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002614 // Final timestamp
2615 char date[80];
2616 time_t the_real_now_please_stand_up = time(nullptr);
2617 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002618 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002619 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002620
Felipe Leme9a523ae2016-10-20 15:10:33 -07002621 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002622 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002623 return false;
2624 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002625 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002626 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002627 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002628 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002629
Felipe Leme0f3fb202016-06-10 17:10:53 -07002630 // Add log file (which contains stderr output) to zip...
2631 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002632 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002633 MYLOGE("Failed to add dumpstate log to .zip file\n");
2634 return false;
2635 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002636 // TODO: Should truncate the existing file.
2637 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002638 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2639 return false;
2640 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002641 fprintf(stderr, "\n");
2642
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002643 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002644 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002645 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002646 return false;
2647 }
2648
Felipe Leme1d486fe2016-10-14 18:06:47 -07002649 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2650 ds.zip_file.reset(nullptr);
2651
Felipe Lemee9d2c542016-11-15 11:48:26 -08002652 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002653 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002654
Felipe Leme1e9edc62015-12-21 16:02:13 -08002655 return true;
2656}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002657
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002658static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2659 // clang-format off
2660 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2661 "--receiver-foreground", "--receiver-include-background", "-a", action};
2662 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002663
2664 am.insert(am.end(), args.begin(), args.end());
2665
Felipe Leme8d2410e2017-02-08 09:46:08 -08002666 RunCommand("", am,
2667 CommandOptions::WithTimeout(20)
2668 .Log("Sending broadcast: '%s'\n")
2669 .Always()
2670 .DropRoot()
2671 .RedirectStderr()
2672 .Build());
2673}
2674
Felipe Leme35b8cf12017-02-10 15:47:29 -08002675static void Vibrate(int duration_ms) {
2676 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002677 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2678 "oneshot", std::to_string(duration_ms)};
2679 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002680 CommandOptions::WithTimeout(10)
2681 .Log("Vibrate: '%s'\n")
2682 .Always()
2683 .Build());
2684 // clang-format on
2685}
2686
Nandana Dutt979388e2018-11-30 16:48:55 +00002687static void MaybeResolveSymlink(std::string* path) {
2688 std::string resolved_path;
2689 if (android::base::Readlink(*path, &resolved_path)) {
2690 *path = resolved_path;
2691 }
2692}
2693
Nandana Dutt4be45d12018-09-26 15:04:23 +01002694/*
2695 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002696 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002697 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002698static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002699 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2700
Nandana Dutt4be45d12018-09-26 15:04:23 +01002701 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2702 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002703 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002704 char date[80];
2705 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2706 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002707
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002708 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002709 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002710 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002711 ds.base_name_ += "-wifi";
2712 }
2713
Paul Chang0d2aad72020-02-13 20:04:03 +08002714 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002715 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002716 }
2717 ds.tmp_path_ = ds.GetPath(".tmp");
2718 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2719
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002720 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002721 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002722 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002723 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002724 "Bugreport dir: [%s] "
2725 "Base name: [%s] "
2726 "Suffix: [%s] "
2727 "Log path: [%s] "
2728 "Temporary path: [%s] "
2729 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002730 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2731 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002732
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002733 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2734 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2735 create_parent_dirs(ds.path_.c_str());
2736 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2737 if (ds.zip_file == nullptr) {
2738 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2739 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002740 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002741 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2742 ds.AddTextZipEntry("version.txt", ds.version_);
2743 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002744}
2745
2746/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002747 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002748 * printing zipped file status, etc.
2749 */
2750static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002751 bool do_text_file = !ds.FinishZipFile();
2752 if (do_text_file) {
2753 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002754 }
mhasank2d75c442020-06-11 15:05:25 -07002755
2756 std::string final_path = ds.path_;
2757 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002758 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002759 android::os::CopyFileToFile(ds.path_, final_path);
2760 }
2761
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002762 if (ds.options_->stream_to_socket) {
2763 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2764 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002765 if (do_text_file) {
2766 dprintf(ds.control_socket_fd_,
2767 "FAIL:could not create zip file, check %s "
2768 "for more details\n",
2769 ds.log_path_.c_str());
2770 } else {
mhasank2d75c442020-06-11 15:05:25 -07002771 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002772 }
2773 }
2774}
2775
Nandana Dutt4be45d12018-09-26 15:04:23 +01002776
Nandana Dutt58d72e22018-11-16 10:30:48 +00002777static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2778 switch (mode) {
2779 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2780 return "BUGREPORT_FULL";
2781 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2782 return "BUGREPORT_INTERACTIVE";
2783 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2784 return "BUGREPORT_REMOTE";
2785 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2786 return "BUGREPORT_WEAR";
2787 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2788 return "BUGREPORT_TELEPHONY";
2789 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2790 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002791 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2792 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002793 }
2794}
2795
Paul Changf59c2b72020-03-10 02:08:55 +08002796static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2797 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002798 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2799 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002800 options->bugreport_mode = mode;
2801 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002802 switch (mode) {
2803 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002804 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002805 break;
2806 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002807 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002808 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002809 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002810 break;
2811 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002812 options->do_vibrate = false;
2813 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002814 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002815 break;
2816 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002817 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002818 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002819 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002820 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002821 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002822 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002823 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002824 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002825 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002826 break;
2827 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002828 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002829 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002830 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002831 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2832 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002833 }
2834}
2835
Nandana Dutt58d72e22018-11-16 10:30:48 +00002836static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002837 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002838 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002839 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002840 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002841 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002842 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002843 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002844 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002845 options.do_progress_updates, options.bugreport_fd.get(),
2846 options.bugreport_mode_string.c_str(),
2847 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002848}
2849
Nandana Dutt54dbd672019-01-11 12:58:05 +00002850void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2851 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002852 const android::base::unique_fd& screenshot_fd_in,
2853 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002854 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002855 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2856 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002857
Paul Changf59c2b72020-03-10 02:08:55 +08002858 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002859}
2860
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002861Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2862 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002863 int c;
mhasankd451a472020-05-26 18:02:39 -07002864 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002865 switch (c) {
2866 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002867 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002868 case 's': stream_to_socket = true; break;
2869 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002870 case 'v': show_header_only = true; break;
2871 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002872 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002873 case 'P': do_progress_updates = true; break;
2874 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002875 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002876 case 'V':
2877 case 'd':
2878 case 'z':
2879 // compatibility no-op
2880 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002881 case 'w':
2882 // This was already processed
2883 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002884 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002885 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002886 break;
2887 default:
2888 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002889 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002890 break;
2891 // clang-format on
2892 }
2893 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002894
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002895 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002896 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002897 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002898 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002899 }
2900 }
2901
2902 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2903 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002904
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002905 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002906}
2907
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002908bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002909 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002910 return false;
2911 }
2912
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002913 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002914 return false;
2915 }
2916
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002917 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002918 return false;
2919 }
2920 return true;
2921}
2922
Nandana Dutt197661d2018-11-16 16:40:21 +00002923void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2924 options_ = std::move(options);
2925}
2926
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002927void Dumpstate::Initialize() {
2928 /* gets the sequential id */
2929 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2930 id_ = ++last_id;
2931 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2932}
2933
Nandana Duttd2f5f082019-01-18 17:13:52 +00002934Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2935 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002936 if (listener_ != nullptr) {
2937 switch (status) {
2938 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002939 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002940 break;
2941 case Dumpstate::RunStatus::HELP:
2942 break;
2943 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002944 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002945 break;
2946 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002947 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2948 break;
2949 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2950 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2951 break;
2952 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2953 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002954 break;
2955 }
2956 }
2957 return status;
2958}
2959
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002960void Dumpstate::Cancel() {
2961 CleanupTmpFiles();
2962 android::os::UnlinkAndLogOnError(log_path_);
2963 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2964 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2965 kDumpstateBoardFiles[i]);
2966 }
2967 tombstone_data_.clear();
2968 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002969 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002970
2971 // Instead of shutdown the pool, we delete temporary files directly since
2972 // shutdown blocking the call.
2973 if (dump_pool_) {
2974 dump_pool_->deleteTempFiles();
2975 }
2976 if (zip_entry_tasks_) {
2977 zip_entry_tasks_->run(/*do_cancel =*/ true);
2978 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002979}
2980
Nandana Dutt979388e2018-11-30 16:48:55 +00002981/*
2982 * Dumps relevant information to a bugreport based on the given options.
2983 *
2984 * The bugreport can be dumped to a file or streamed to a socket.
2985 *
2986 * How dumping to file works:
2987 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2988 * stderr is redirected a log file.
2989 *
2990 * The temporary bugreport is then populated via printfs, dumping contents of files and
2991 * output of commands to stdout.
2992 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002993 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002994 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002995 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002996 *
mhasank2d75c442020-06-11 15:05:25 -07002997 * Bugreports are first generated in a local directory and later copied to the caller's fd
2998 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002999 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003000Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3001 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003002 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003003 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003004 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003005 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003006 return RunStatus::INVALID_INPUT;
3007 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003008 /* set as high priority, and protect from OOM killer */
3009 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003010
Felipe Lemed071c682016-10-20 16:48:00 -07003011 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003012 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003013 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003014 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003015 } else {
3016 /* fallback to kernels <= 2.6.35 */
3017 oom_adj = fopen("/proc/self/oom_adj", "we");
3018 if (oom_adj) {
3019 fputs("-17", oom_adj);
3020 fclose(oom_adj);
3021 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003022 }
3023
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003024 if (version_ == VERSION_DEFAULT) {
3025 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003026 }
3027
Chris Morin5a50d482022-02-01 17:41:18 -08003028 if (version_ != VERSION_CURRENT) {
3029 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3030 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003031 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003032 }
3033
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003034 if (options_->show_header_only) {
3035 PrintHeader();
3036 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003037 }
3038
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003039 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3040 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003041
Felipe Leme7447d7c2016-11-03 18:12:22 -07003042 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003043 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003044 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003045 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003046
Sahana Raof35ed432019-07-12 10:47:52 +01003047 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3048 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3049 } else {
3050 // Wake lock will be released automatically on process death
3051 MYLOGD("Wake lock acquired.\n");
3052 }
3053
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003054 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003055
Felipe Lemef0292972016-11-22 13:57:05 -08003056 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003057 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3058 }
3059
Kevin Jeonfa64e642023-07-27 11:36:41 -04003060 if (PropertiesHelper::IsStrictRun()) {
3061 MYLOGI(
3062 "Running on strict-run mode, which has shorter timeouts "
3063 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3064 }
3065
Nandana Dutt235c6672019-11-14 15:22:32 +00003066 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003067 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003068
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003069 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003070
Christopher Ferrised9354f2014-10-01 17:35:01 -07003071 // If we are going to use a socket, do it as early as possible
3072 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003073 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003074 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003075 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003076 if (control_socket_fd_ == -1) {
3077 return ERROR;
3078 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003079 if (options_->progress_updates_to_socket) {
3080 options_->do_progress_updates = 1;
3081 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003082 }
3083
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003084 if (!PrepareToWriteToFile()) {
3085 return ERROR;
3086 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003087
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003088 // Interactive, wear & telephony modes are default to true.
3089 // and may enable from cli option or when using control socket
3090 if (options_->do_progress_updates) {
3091 // clang-format off
3092 std::vector<std::string> am_args = {
3093 "--receiver-permission", "android.permission.DUMP",
3094 };
3095 // clang-format on
3096 // Send STARTED broadcast for apps that listen to bugreport generation events
3097 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3098 if (options_->progress_updates_to_socket) {
3099 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003100 }
3101 }
3102
Nick Kralevichf3599b32016-01-25 15:05:16 -08003103 /* read /proc/cmdline before dropping root */
3104 FILE *cmdline = fopen("/proc/cmdline", "re");
3105 if (cmdline) {
3106 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3107 fclose(cmdline);
3108 }
3109
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003110 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003111 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003112 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003113
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003114 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003115 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3116 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003117 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003118 }
3119 }
3120
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003121 int dup_stdout_fd;
3122 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003123 // Redirect stderr to log_path_ for debugging.
3124 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3125 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3126 return ERROR;
3127 }
3128 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3129 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3130 strerror(errno));
3131 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003132
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003133 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3134 // moved into zip file later, if zipping.
3135 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3136 // TODO: why not write to a file instead of stdout to overcome this problem?
3137 /* TODO: rather than generating a text file now and zipping it later,
3138 it would be more efficient to redirect stdout to the zip entry
3139 directly, but the libziparchive doesn't support that option yet. */
3140 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3141 return ERROR;
3142 }
3143 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3144 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3145 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003146 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003147
3148 // Don't buffer stdout
3149 setvbuf(stdout, nullptr, _IONBF, 0);
3150
Rhed Jao5377d792020-07-16 17:37:39 +08003151 // Enable the parallel run if the client requests to output to a file.
3152 EnableParallelRunIfNeeded();
3153 // Using scope guard to make sure the dump pool can be shut down correctly.
3154 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3155 ShutdownDumpPool();
3156 });
3157
Felipe Leme608385d2016-02-01 10:35:38 -08003158 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3159 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003160 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003161 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003162
Gavin Corkery6968f552020-11-22 18:09:05 +00003163 bool is_dumpstate_restricted = options_->telephony_only
3164 || options_->wifi_only
3165 || options_->limited_only;
3166 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003167 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003168 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003169 }
3170 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003171
3172 if (!is_dumpstate_restricted) {
3173 // Snapshot the system trace now (if running) to avoid that dumpstate's
3174 // own activity pushes out interesting data from the trace ring buffer.
3175 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3176 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003177
3178 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3179 // from WMTRACE_DATA_DIR.
3180 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003181 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003182 onUiIntensiveBugreportDumpsFinished(calling_uid);
3183 MaybeCheckUserConsent(calling_uid, calling_package);
3184 if (options_->telephony_only) {
3185 DumpstateTelephonyOnly(calling_package);
3186 } else if (options_->wifi_only) {
3187 DumpstateWifiOnly();
3188 } else if (options_->limited_only) {
3189 DumpstateLimitedOnly();
3190 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003191 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003192 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003193 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003194 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003195 HandleUserConsentDenied();
3196 }
3197 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003198 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003199 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003200
Felipe Leme55b42a62015-11-10 17:39:08 -08003201 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003202 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003203
Abhijeet Kaure370d682019-10-01 16:49:30 +01003204 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003205 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003206 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003207 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003208
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003209 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003210 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003211 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003212 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003213 if (status != Dumpstate::RunStatus::OK &&
3214 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3215 // Do an early return if there were errors. We make an exception for consent
3216 // timing out because it's possible the user got distracted. In this case the
3217 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003218 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003219 return status;
3220 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003221 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3222 MYLOGI(
3223 "Did not receive user consent yet."
3224 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003225 const String16 incidentcompanion("incidentcompanion");
3226 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3227 if (ics != nullptr) {
3228 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3229 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3230 consent_callback_.get());
3231 } else {
3232 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3233 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003234 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003235 }
3236
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003237 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003238 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003239 for (int i = 0; i < 3; i++) {
3240 Vibrate(75);
3241 usleep((75 + 50) * 1000);
3242 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003243 }
3244
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003245 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3246 progress_->GetInitialMax());
3247 progress_->Save();
3248 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003249
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003250 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003251
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003252 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003253 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003254 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003255 }
3256
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003257 tombstone_data_.clear();
3258 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003259 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003260
Nandana Duttd2f5f082019-01-18 17:13:52 +00003261 return (consent_callback_ != nullptr &&
3262 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3263 ? USER_CONSENT_TIMED_OUT
3264 : RunStatus::OK;
3265}
3266
Paul Chang0d2aad72020-02-13 20:04:03 +08003267void Dumpstate::MaybeTakeEarlyScreenshot() {
3268 if (!options_->do_screenshot || !do_early_screenshot_) {
3269 return;
3270 }
3271
3272 TakeScreenshot();
3273}
3274
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003275void Dumpstate::MaybeSnapshotSystemTrace() {
3276 // If a background system trace is happening and is marked as "suitable for
3277 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3278 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3279 // case that no trace is ongoing, this command is a no-op.
3280 // Note: this should not be enqueued as we need to freeze the trace before
3281 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3282 // the dumpstate's own activity which is irrelevant.
3283 int res = RunCommand(
3284 "SERIALIZE PERFETTO TRACE",
3285 {"perfetto", "--save-for-bugreport"},
3286 CommandOptions::WithTimeout(10)
3287 .DropRoot()
3288 .CloseAllFileDescriptorsOnExec()
3289 .Build());
3290 has_system_trace_ = res == 0;
3291 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3292 // file in the later stages.
3293}
3294
Yohei Yukawa95305b32021-03-09 07:54:27 -08003295void Dumpstate::MaybeSnapshotWinTrace() {
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003296 // Include the proto logging from WMShell.
3297 RunCommand(
3298 // Empty name because it's not intended to be classified as a bugreport section.
3299 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3300 // in the bugreport.
3301 "", {"dumpsys", "activity", "service", "SystemUIService",
3302 "WMShell", "protolog", "save-for-bugreport"},
3303 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3304
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003305 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3306 for (const auto& service : {"window", "input_method"}) {
3307 RunCommand(
3308 // Empty name because it's not intended to be classified as a bugreport section.
3309 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3310 "", {"cmd", service, "tracing", "save-for-bugreport"},
3311 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3312 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003313}
3314
Paul Changeb4b4642020-05-28 22:05:47 +08003315void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003316 if (calling_uid == AID_SHELL || !CalledByApi()) {
3317 return;
3318 }
3319 if (listener_ != nullptr) {
3320 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3321 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003322 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003323 }
3324}
3325
Jichao Lie89d9c12019-11-21 19:02:51 -08003326void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3327 if (calling_uid == AID_SHELL || !CalledByApi()) {
3328 // No need to get consent for shell triggered dumpstates, or not through
3329 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003330 return;
3331 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003332 consent_callback_ = new ConsentCallback();
3333 const String16 incidentcompanion("incidentcompanion");
3334 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003335 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003336 if (ics != nullptr) {
3337 MYLOGD("Checking user consent via incidentcompanion service\n");
3338 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003339 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003340 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003341 } else {
3342 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3343 }
3344}
3345
Nandana Dutt5c390032019-03-12 10:52:56 +00003346bool Dumpstate::IsUserConsentDenied() const {
3347 return ds.consent_callback_ != nullptr &&
3348 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3349}
3350
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003351bool Dumpstate::CalledByApi() const {
3352 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3353}
3354
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003355void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003356 android::os::UnlinkAndLogOnError(tmp_path_);
3357 android::os::UnlinkAndLogOnError(screenshot_path_);
3358 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003359 if (dump_traces_path != nullptr) {
3360 android::os::UnlinkAndLogOnError(dump_traces_path);
3361 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003362}
3363
Rhed Jao5377d792020-07-16 17:37:39 +08003364void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003365 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003366 return;
3367 }
3368 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003369 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003370}
3371
3372void Dumpstate::ShutdownDumpPool() {
3373 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003374 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003375 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003376 if (zip_entry_tasks_) {
3377 zip_entry_tasks_->run(/* do_cancel = */true);
3378 zip_entry_tasks_ = nullptr;
3379 }
3380}
3381
3382void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3383 const std::string& entry_path) {
3384 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3385 if (!task_cancelled) {
3386 AddZipEntry(entry_name, entry_path);
3387 }
3388 android::os::UnlinkAndLogOnError(entry_path);
3389 };
3390 if (zip_entry_tasks_) {
3391 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3392 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3393 } else {
3394 // Invokes AddZipEntryAndCleanup immediately
3395 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3396 }
Rhed Jao5377d792020-07-16 17:37:39 +08003397}
3398
Nandana Duttd2f5f082019-01-18 17:13:52 +00003399Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3400 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003401 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003402 return USER_CONSENT_DENIED;
3403}
3404
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003405Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003406 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003407 // user consent (unless the caller is Shell).
3408 UserConsentResult consent_result;
3409 if (calling_uid == AID_SHELL) {
3410 consent_result = UserConsentResult::APPROVED;
3411 } else {
3412 consent_result = consent_callback_->getResult();
3413 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003414 if (consent_result == UserConsentResult::UNAVAILABLE) {
3415 // User has not responded yet.
3416 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003417 // Telephony is a fast report type, particularly on user builds where information may be
3418 // more aggressively limited. To give the user time to read the consent dialog, increase the
3419 // timeout.
3420 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3421 : USER_CONSENT_TIMEOUT_MS;
3422 if (elapsed_ms < timeout_ms) {
3423 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003424 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3425 sleep(delay_seconds);
3426 }
3427 consent_result = consent_callback_->getResult();
3428 }
3429 if (consent_result == UserConsentResult::DENIED) {
3430 // User has explicitly denied sharing with the app. To be safe delete the
3431 // internal bugreport & tmp files.
3432 return HandleUserConsentDenied();
3433 }
3434 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003435 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3436 if (copy_succeeded) {
3437 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003438 if (options_->do_screenshot &&
3439 options_->screenshot_fd.get() != -1 &&
3440 !options_->is_screenshot_copied) {
3441 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3442 options_->screenshot_fd.get());
3443 options_->is_screenshot_copied = copy_succeeded;
3444 if (copy_succeeded) {
3445 android::os::UnlinkAndLogOnError(screenshot_path_);
3446 }
3447 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003448 }
3449 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3450 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3451 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3452 // Since we do not have user consent to share the bugreport it does not get
3453 // copied over to the calling app but remains in the internal directory from
3454 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003455 std::string final_path = GetPath(".zip");
3456 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3457 if (copy_succeeded) {
3458 android::os::UnlinkAndLogOnError(path_);
3459 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003460 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3461 }
3462 // Unknown result; must be a programming error.
3463 MYLOGE("Unknown user consent result:%d\n", consent_result);
3464 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003465}
3466
Nandana Duttf02564e2019-02-15 15:24:24 +00003467Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003468 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3469 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3470 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003471 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003472 // When directly running dumpstate binary, the output is not expected to be written
3473 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003474 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003475
3476 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003477 // an app; they are irrelevant here because bugreport is triggered via command line.
3478 // Update Last ID before calling Run().
3479 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003480 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003481 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003482 return status;
3483}
3484
3485/* Main entry point for dumpstate binary. */
3486int run_main(int argc, char* argv[]) {
3487 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003488
3489 switch (status) {
3490 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003491 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003492 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003493 ShowUsage();
3494 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003495 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003496 fprintf(stderr, "Invalid combination of args\n");
3497 ShowUsage();
3498 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003499 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003500 FALLTHROUGH_INTENDED;
3501 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3502 FALLTHROUGH_INTENDED;
3503 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003504 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003505 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003506}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003507
3508// TODO(111441001): Default DumpOptions to sensible values.
3509Dumpstate::Dumpstate(const std::string& version)
3510 : pid_(getpid()),
3511 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003512 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003513 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003514 now_(time(nullptr)),
3515 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003516}
3517
3518Dumpstate& Dumpstate::GetInstance() {
3519 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3520 return singleton_;
3521}
3522
Rhed Jao5377d792020-07-16 17:37:39 +08003523DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3524 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3525 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003526 if (!title_.empty()) {
3527 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003528 if (title_.find("SHOW MAP") == std::string::npos) {
3529 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3530 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003531 }
3532}
3533
3534DurationReporter::~DurationReporter() {
3535 if (!title_.empty()) {
3536 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003537 if (elapsed >= .5f || verbose_) {
3538 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003539 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003540 if (!logcat_only_) {
3541 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003542 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3543 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003544 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003545 if (title_.find("SHOW MAP") == std::string::npos) {
3546 ATRACE_ASYNC_END(title_.c_str(), 0);
3547 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003548 }
3549}
3550
3551const int32_t Progress::kDefaultMax = 5000;
3552
3553Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3554}
3555
3556Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3557 : Progress(initial_max, growth_factor, "") {
3558 progress_ = progress;
3559}
3560
3561Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3562 : initial_max_(initial_max),
3563 progress_(0),
3564 max_(initial_max),
3565 growth_factor_(growth_factor),
3566 n_runs_(0),
3567 average_max_(0),
3568 path_(path) {
3569 if (!path_.empty()) {
3570 Load();
3571 }
3572}
3573
3574void Progress::Load() {
3575 MYLOGD("Loading stats from %s\n", path_.c_str());
3576 std::string content;
3577 if (!android::base::ReadFileToString(path_, &content)) {
3578 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3579 return;
3580 }
3581 if (content.empty()) {
3582 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3583 return;
3584 }
3585 std::vector<std::string> lines = android::base::Split(content, "\n");
3586
3587 if (lines.size() < 1) {
3588 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3589 (int)lines.size(), max_);
3590 return;
3591 }
3592 char* ptr;
3593 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3594 average_max_ = strtol(ptr, nullptr, 10);
3595 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3596 average_max_ > STATS_MAX_AVERAGE) {
3597 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3598 initial_max_ = Progress::kDefaultMax;
3599 } else {
3600 initial_max_ = average_max_;
3601 }
3602 max_ = initial_max_;
3603
3604 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3605}
3606
3607void Progress::Save() {
3608 int32_t total = n_runs_ * average_max_ + progress_;
3609 int32_t runs = n_runs_ + 1;
3610 int32_t average = floor(((float)total) / runs);
3611 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3612 path_.c_str());
3613 if (path_.empty()) {
3614 return;
3615 }
3616
3617 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3618 if (!android::base::WriteStringToFile(content, path_)) {
3619 MYLOGE("Could not save stats on %s\n", path_.c_str());
3620 }
3621}
3622
3623int32_t Progress::Get() const {
3624 return progress_;
3625}
3626
3627bool Progress::Inc(int32_t delta_sec) {
3628 bool changed = false;
3629 if (delta_sec >= 0) {
3630 progress_ += delta_sec;
3631 if (progress_ > max_) {
3632 int32_t old_max = max_;
3633 max_ = floor((float)progress_ * growth_factor_);
3634 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3635 changed = true;
3636 }
3637 }
3638 return changed;
3639}
3640
3641int32_t Progress::GetMax() const {
3642 return max_;
3643}
3644
3645int32_t Progress::GetInitialMax() const {
3646 return initial_max_;
3647}
3648
3649void Progress::Dump(int fd, const std::string& prefix) const {
3650 const char* pr = prefix.c_str();
3651 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3652 dprintf(fd, "%smax: %d\n", pr, max_);
3653 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3654 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3655 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3656 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3657 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3658}
3659
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003660std::string Dumpstate::GetPath(const std::string& suffix) const {
3661 return GetPath(bugreport_internal_dir_, suffix);
3662}
3663
3664std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3665 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3666 name_.c_str(), suffix.c_str());
3667}
3668
3669void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3670 progress_ = std::move(progress);
3671}
3672
3673void for_each_userid(void (*func)(int), const char *header) {
3674 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3675 "for_each_userid(%s)", header);
3676 DurationReporter duration_reporter(title);
3677 if (PropertiesHelper::IsDryRun()) return;
3678
3679 DIR *d;
3680 struct dirent *de;
3681
3682 if (header) printf("\n------ %s ------\n", header);
3683 func(0);
3684
3685 if (!(d = opendir("/data/system/users"))) {
3686 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3687 return;
3688 }
3689
3690 while ((de = readdir(d))) {
3691 int userid;
3692 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3693 continue;
3694 }
3695 func(userid);
3696 }
3697
3698 closedir(d);
3699}
3700
3701static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3702 DIR *d;
3703 struct dirent *de;
3704
3705 if (!(d = opendir("/proc"))) {
3706 printf("Failed to open /proc (%s)\n", strerror(errno));
3707 return;
3708 }
3709
3710 if (header) printf("\n------ %s ------\n", header);
3711 while ((de = readdir(d))) {
3712 if (ds.IsUserConsentDenied()) {
3713 MYLOGE(
3714 "Returning early because user denied consent to share bugreport with calling app.");
3715 closedir(d);
3716 return;
3717 }
3718 int pid;
3719 int fd;
3720 char cmdpath[255];
3721 char cmdline[255];
3722
3723 if (!(pid = atoi(de->d_name))) {
3724 continue;
3725 }
3726
3727 memset(cmdline, 0, sizeof(cmdline));
3728
3729 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3730 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3731 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3732 close(fd);
3733 if (cmdline[0]) {
3734 helper(pid, cmdline, arg);
3735 continue;
3736 }
3737 }
3738
3739 // if no cmdline, a kernel thread has comm
3740 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3741 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3742 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3743 close(fd);
3744 if (cmdline[1]) {
3745 cmdline[0] = '[';
3746 size_t len = strcspn(cmdline, "\f\b\r\n");
3747 cmdline[len] = ']';
3748 cmdline[len+1] = '\0';
3749 }
3750 }
3751 if (!cmdline[0]) {
3752 strcpy(cmdline, "N/A");
3753 }
3754 helper(pid, cmdline, arg);
3755 }
3756
3757 closedir(d);
3758}
3759
3760static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3761 for_each_pid_func *func = (for_each_pid_func*) arg;
3762 func(pid, cmdline);
3763}
3764
3765void for_each_pid(for_each_pid_func func, const char *header) {
3766 std::string title = header == nullptr ? "for_each_pid"
3767 : android::base::StringPrintf("for_each_pid(%s)", header);
3768 DurationReporter duration_reporter(title);
3769 if (PropertiesHelper::IsDryRun()) return;
3770
3771 __for_each_pid(for_each_pid_helper, header, (void *) func);
3772}
3773
3774static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3775 DIR *d;
3776 struct dirent *de;
3777 char taskpath[255];
3778 for_each_tid_func *func = (for_each_tid_func *) arg;
3779
3780 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3781
3782 if (!(d = opendir(taskpath))) {
3783 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3784 return;
3785 }
3786
3787 func(pid, pid, cmdline);
3788
3789 while ((de = readdir(d))) {
3790 if (ds.IsUserConsentDenied()) {
3791 MYLOGE(
3792 "Returning early because user denied consent to share bugreport with calling app.");
3793 closedir(d);
3794 return;
3795 }
3796 int tid;
3797 int fd;
3798 char commpath[255];
3799 char comm[255];
3800
3801 if (!(tid = atoi(de->d_name))) {
3802 continue;
3803 }
3804
3805 if (tid == pid)
3806 continue;
3807
3808 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3809 memset(comm, 0, sizeof(comm));
3810 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3811 strcpy(comm, "N/A");
3812 } else {
3813 char *c;
3814 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3815 close(fd);
3816
3817 c = strrchr(comm, '\n');
3818 if (c) {
3819 *c = '\0';
3820 }
3821 }
3822 func(pid, tid, comm);
3823 }
3824
3825 closedir(d);
3826}
3827
3828void for_each_tid(for_each_tid_func func, const char *header) {
3829 std::string title = header == nullptr ? "for_each_tid"
3830 : android::base::StringPrintf("for_each_tid(%s)", header);
3831 DurationReporter duration_reporter(title);
3832
3833 if (PropertiesHelper::IsDryRun()) return;
3834
3835 __for_each_pid(for_each_tid_helper, header, (void *) func);
3836}
3837
3838void show_wchan(int pid, int tid, const char *name) {
3839 if (PropertiesHelper::IsDryRun()) return;
3840
3841 char path[255];
3842 char buffer[255];
3843 int fd, ret, save_errno;
3844 char name_buffer[255];
3845
3846 memset(buffer, 0, sizeof(buffer));
3847
3848 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3849 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3850 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3851 return;
3852 }
3853
3854 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3855 save_errno = errno;
3856 close(fd);
3857
3858 if (ret < 0) {
3859 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3860 return;
3861 }
3862
3863 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3864 pid == tid ? 0 : 3, "", name);
3865
3866 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3867
3868 return;
3869}
3870
3871// print time in centiseconds
3872static void snprcent(char *buffer, size_t len, size_t spc,
3873 unsigned long long time) {
3874 static long hz; // cache discovered hz
3875
3876 if (hz <= 0) {
3877 hz = sysconf(_SC_CLK_TCK);
3878 if (hz <= 0) {
3879 hz = 1000;
3880 }
3881 }
3882
3883 // convert to centiseconds
3884 time = (time * 100 + (hz / 2)) / hz;
3885
3886 char str[16];
3887
3888 snprintf(str, sizeof(str), " %llu.%02u",
3889 time / 100, (unsigned)(time % 100));
3890 size_t offset = strlen(buffer);
3891 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3892 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3893}
3894
3895// print permille as a percent
3896static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3897 char str[16];
3898
3899 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3900 size_t offset = strlen(buffer);
3901 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3902 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3903}
3904
3905void show_showtime(int pid, const char *name) {
3906 if (PropertiesHelper::IsDryRun()) return;
3907
3908 char path[255];
3909 char buffer[1023];
3910 int fd, ret, save_errno;
3911
3912 memset(buffer, 0, sizeof(buffer));
3913
3914 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3915 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3916 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3917 return;
3918 }
3919
3920 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3921 save_errno = errno;
3922 close(fd);
3923
3924 if (ret < 0) {
3925 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3926 return;
3927 }
3928
3929 // field 14 is utime
3930 // field 15 is stime
3931 // field 42 is iotime
3932 unsigned long long utime = 0, stime = 0, iotime = 0;
3933 if (sscanf(buffer,
3934 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3935 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3936 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3937 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3938 &utime, &stime, &iotime) != 3) {
3939 return;
3940 }
3941
3942 unsigned long long total = utime + stime;
3943 if (!total) {
3944 return;
3945 }
3946
3947 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3948 if (permille > 1000) {
3949 permille = 1000;
3950 }
3951
3952 // try to beautify and stabilize columns at <80 characters
3953 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3954 if ((name[0] != '[') || utime) {
3955 snprcent(buffer, sizeof(buffer), 57, utime);
3956 }
3957 snprcent(buffer, sizeof(buffer), 65, stime);
3958 if ((name[0] != '[') || iotime) {
3959 snprcent(buffer, sizeof(buffer), 73, iotime);
3960 }
3961 if (iotime) {
3962 snprdec(buffer, sizeof(buffer), 79, permille);
3963 }
3964 puts(buffer); // adds a trailing newline
3965
3966 return;
3967}
3968
3969void do_dmesg() {
3970 const char *title = "KERNEL LOG (dmesg)";
3971 DurationReporter duration_reporter(title);
3972 printf("------ %s ------\n", title);
3973
3974 if (PropertiesHelper::IsDryRun()) return;
3975
3976 /* Get size of kernel buffer */
3977 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3978 if (size <= 0) {
3979 printf("Unexpected klogctl return value: %d\n\n", size);
3980 return;
3981 }
3982 char *buf = (char *) malloc(size + 1);
3983 if (buf == nullptr) {
3984 printf("memory allocation failed\n\n");
3985 return;
3986 }
3987 int retval = klogctl(KLOG_READ_ALL, buf, size);
3988 if (retval < 0) {
3989 printf("klogctl failure\n\n");
3990 free(buf);
3991 return;
3992 }
3993 buf[retval] = '\0';
3994 printf("%s\n\n", buf);
3995 free(buf);
3996 return;
3997}
3998
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003999int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4000 DurationReporter duration_reporter(title);
4001
4002 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4003
4004 UpdateProgress(WEIGHT_FILE);
4005
4006 return status;
4007}
4008
4009int read_file_as_long(const char *path, long int *output) {
4010 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4011 if (fd < 0) {
4012 int err = errno;
4013 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4014 return -1;
4015 }
4016 char buffer[50];
4017 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4018 if (bytes_read == -1) {
4019 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4020 return -2;
4021 }
4022 if (bytes_read == 0) {
4023 MYLOGE("File %s is empty\n", path);
4024 return -3;
4025 }
4026 *output = atoi(buffer);
4027 return 0;
4028}
4029
4030/* calls skip to gate calling dump_from_fd recursively
4031 * in the specified directory. dump_from_fd defaults to
4032 * dump_file_from_fd above when set to NULL. skip defaults
4033 * to false when set to NULL. dump_from_fd will always be
4034 * called with title NULL.
4035 */
4036int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4037 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4038 DurationReporter duration_reporter(title);
4039 DIR *dirp;
4040 struct dirent *d;
4041 char *newpath = nullptr;
4042 const char *slash = "/";
4043 int retval = 0;
4044
4045 if (!title.empty()) {
4046 printf("------ %s (%s) ------\n", title.c_str(), dir);
4047 }
4048 if (PropertiesHelper::IsDryRun()) return 0;
4049
4050 if (dir[strlen(dir) - 1] == '/') {
4051 ++slash;
4052 }
4053 dirp = opendir(dir);
4054 if (dirp == nullptr) {
4055 retval = -errno;
4056 MYLOGE("%s: %s\n", dir, strerror(errno));
4057 return retval;
4058 }
4059
4060 if (!dump_from_fd) {
4061 dump_from_fd = dump_file_from_fd;
4062 }
4063 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4064 if ((d->d_name[0] == '.')
4065 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4066 || (d->d_name[1] == '\0'))) {
4067 continue;
4068 }
4069 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4070 (d->d_type == DT_DIR) ? "/" : "");
4071 if (!newpath) {
4072 retval = -errno;
4073 continue;
4074 }
4075 if (skip && (*skip)(newpath)) {
4076 continue;
4077 }
4078 if (d->d_type == DT_DIR) {
4079 int ret = dump_files("", newpath, skip, dump_from_fd);
4080 if (ret < 0) {
4081 retval = ret;
4082 }
4083 continue;
4084 }
4085 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4086 if (fd.get() < 0) {
4087 retval = -1;
4088 printf("*** %s: %s\n", newpath, strerror(errno));
4089 continue;
4090 }
4091 (*dump_from_fd)(nullptr, newpath, fd.get());
4092 }
4093 closedir(dirp);
4094 if (!title.empty()) {
4095 printf("\n");
4096 }
4097 return retval;
4098}
4099
4100/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4101 * it's possible to avoid issues where opening the file itself can get
4102 * stuck.
4103 */
4104int dump_file_from_fd(const char *title, const char *path, int fd) {
4105 if (PropertiesHelper::IsDryRun()) return 0;
4106
4107 int flags = fcntl(fd, F_GETFL);
4108 if (flags == -1) {
4109 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4110 return -1;
4111 } else if (!(flags & O_NONBLOCK)) {
4112 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4113 return -1;
4114 }
4115 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4116}
4117
4118int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004119 const CommandOptions& options, bool verbose_duration, int out_fd) {
4120 DurationReporter duration_reporter(title, false /* logcat_only */,
4121 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004122
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004123 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004124
4125 /* TODO: for now we're simplifying the progress calculation by using the
4126 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4127 * where its weight should be much higher proportionally to its timeout.
4128 * Ideally, it should use a options.EstimatedDuration() instead...*/
4129 UpdateProgress(options.Timeout());
4130
4131 return status;
4132}
4133
4134void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004135 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004136 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4137 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4138 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004139 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004140}
4141
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004142static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004143 int s = android_get_control_socket(service);
4144 if (s < 0) {
4145 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4146 return -1;
4147 }
4148 fcntl(s, F_SETFD, FD_CLOEXEC);
4149
4150 // Set backlog to 0 to make sure that queue size will be minimum.
4151 // In Linux, because the minimum queue will be 1, connect() will be blocked
4152 // if the other clients already called connect() and the connection request was not accepted.
4153 if (listen(s, 0) < 0) {
4154 MYLOGE("listen(control socket): %s\n", strerror(errno));
4155 return -1;
4156 }
4157
4158 struct sockaddr addr;
4159 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004160 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004161
4162 // Close socket just after accept(), to make sure that connect() by client will get error
4163 // when the socket is used by the other services.
4164 // There is still a race condition possibility between accept and close, but there is no way
4165 // to close-on-accept atomically.
4166 // See detail; b/123306389#comment25
4167 close(s);
4168
4169 if (fd < 0) {
4170 MYLOGE("accept(control socket): %s\n", strerror(errno));
4171 return -1;
4172 }
4173
4174 return fd;
4175}
4176
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004177// TODO: should call is_valid_output_file and/or be merged into it.
4178void create_parent_dirs(const char *path) {
4179 char *chp = const_cast<char *> (path);
4180
4181 /* skip initial slash */
4182 if (chp[0] == '/')
4183 chp++;
4184
4185 /* create leading directories, if necessary */
4186 struct stat dir_stat;
4187 while (chp && chp[0]) {
4188 chp = strchr(chp, '/');
4189 if (chp) {
4190 *chp = 0;
4191 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4192 MYLOGI("Creating directory %s\n", path);
4193 if (mkdir(path, 0770)) { /* drwxrwx--- */
4194 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4195 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4196 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4197 }
4198 }
4199 *chp++ = '/';
4200 }
4201 }
4202}
4203
4204bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4205 create_parent_dirs(path);
4206
4207 int fd = TEMP_FAILURE_RETRY(open(path,
4208 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4209 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4210 if (fd < 0) {
4211 MYLOGE("%s: %s\n", path, strerror(errno));
4212 return false;
4213 }
4214
4215 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4216 close(fd);
4217 return true;
4218}
4219
4220bool redirect_to_file(FILE* redirect, char* path) {
4221 return _redirect_to_file(redirect, path, O_TRUNC);
4222}
4223
4224bool redirect_to_existing_file(FILE* redirect, char* path) {
4225 return _redirect_to_file(redirect, path, O_APPEND);
4226}
4227
4228void dump_route_tables() {
4229 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4230 if (PropertiesHelper::IsDryRun()) return;
4231 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4232 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4233 FILE* fp = fopen(RT_TABLES_PATH, "re");
4234 if (!fp) {
4235 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4236 return;
4237 }
4238 char table[16];
4239 // Each line has an integer (the table number), a space, and a string (the table name). We only
4240 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4241 // Add a fixed max limit so this doesn't go awry.
4242 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4243 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4244 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4245 }
4246 fclose(fp);
4247}
4248
Li Li830179f2022-01-04 12:53:29 -08004249void dump_frozen_cgroupfs(const char *dir, int level,
4250 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4251 DIR *dirp;
4252 struct dirent *d;
4253 char *newpath = nullptr;
4254
4255 dirp = opendir(dir);
4256 if (dirp == nullptr) {
4257 MYLOGE("%s: %s\n", dir, strerror(errno));
4258 return;
4259 }
4260
4261 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4262 if ((d->d_name[0] == '.')
4263 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4264 || (d->d_name[1] == '\0'))) {
4265 continue;
4266 }
4267 if (d->d_type == DT_DIR) {
4268 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4269 if (!newpath) {
4270 continue;
4271 }
4272 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4273 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4274 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4275 char *freezer = nullptr;
4276 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4277 if (freezer) {
4278 FILE* fp = fopen(freezer, "r");
4279 if (fp != NULL) {
4280 int frozen;
4281 fscanf(fp, "%d", &frozen);
4282 if (frozen > 0) {
4283 dump_files("", newpath, skip_none, dump_from_fd);
4284 }
4285 fclose(fp);
4286 }
4287 free(freezer);
4288 }
4289 }
4290 }
4291 }
4292 closedir(dirp);
4293}
4294
4295void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004296 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4297 DurationReporter duration_reporter("FROZEN CGROUPFS");
4298 if (PropertiesHelper::IsDryRun()) return;
4299 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4300}
4301
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004302void Dumpstate::UpdateProgress(int32_t delta_sec) {
4303 if (progress_ == nullptr) {
4304 MYLOGE("UpdateProgress: progress_ not set\n");
4305 return;
4306 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004307 // This function updates progress related members of the dumpstate and reports
4308 // progress percentage to the bugreport client. Since it could be called by
4309 // different dump tasks at the same time if the parallel run is enabled, a
4310 // mutex lock is necessary here to synchronize the call.
4311 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004312
4313 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004314 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004315
4316 // ...but only notifiy listeners when necessary.
4317 if (!options_->do_progress_updates) return;
4318
4319 int progress = progress_->Get();
4320 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004321 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004322
Nandana Dutt402a8392019-06-14 14:25:13 +01004323 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004324 return;
4325 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004326 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004327
4328 if (control_socket_fd_ >= 0) {
4329 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4330 fsync(control_socket_fd_);
4331 }
4332
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004333 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004334 if (percent % 10 == 0) {
4335 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004336 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004337 } else {
4338 // stderr is ignored on normal invocations, but useful when calling
4339 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004340 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004341 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004342
4343 listener_->onProgress(percent);
4344 }
4345}
4346
4347void Dumpstate::TakeScreenshot(const std::string& path) {
4348 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4349 int status =
4350 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4351 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4352 if (status == 0) {
4353 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4354 } else {
4355 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4356 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004357 if (listener_ != nullptr) {
4358 // Show a visual indication to indicate screenshot is taken via
4359 // IDumpstateListener.onScreenshotTaken()
4360 listener_->onScreenshotTaken(status == 0);
4361 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004362}
4363
4364bool is_dir(const char* pathname) {
4365 struct stat info;
4366 if (stat(pathname, &info) == -1) {
4367 return false;
4368 }
4369 return S_ISDIR(info.st_mode);
4370}
4371
4372time_t get_mtime(int fd, time_t default_mtime) {
4373 struct stat info;
4374 if (fstat(fd, &info) == -1) {
4375 return default_mtime;
4376 }
4377 return info.st_mtime;
4378}