blob: e18c8e380dc209a8add8e3db3cf060240fd0e12d [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"
Mårten Kongstad5ad813f2023-09-28 10:09:18 +0200189#define PRINT_FLAGS "/system/bin/printflags"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700190
Narayan Kamath8f788292017-05-25 13:20:39 +0100191// TODO(narayan): Since this information has to be kept in sync
192// with tombstoned, we should just put it in a common header.
193//
194// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100195static const std::string TOMBSTONE_DIR = "/data/tombstones/";
196static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
197static const std::string ANR_DIR = "/data/anr/";
198static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800199static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
200static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700201
Felipe Lemee844a9d2016-09-21 15:01:39 -0700202// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000203
Nandana Dutt5c390032019-03-12 10:52:56 +0000204#define RETURN_IF_USER_DENIED_CONSENT() \
205 if (ds.IsUserConsentDenied()) { \
206 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
207 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
208 }
209
210// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
211// if consent is found to be denied.
212#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
213 RETURN_IF_USER_DENIED_CONSENT(); \
214 func_ptr(__VA_ARGS__); \
215 RETURN_IF_USER_DENIED_CONSENT();
216
Rhed Jao5377d792020-07-16 17:37:39 +0800217// Runs func_ptr, and logs a duration report after it's finished.
218#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
219 { \
220 DurationReporter duration_reporter_in_macro(log_title); \
221 func_ptr(__VA_ARGS__); \
222 }
223
224// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
225// is output after a slow function is finished.
226#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
227 RETURN_IF_USER_DENIED_CONSENT(); \
228 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
229 RETURN_IF_USER_DENIED_CONSENT();
230
Chris Morinbc223142022-02-04 14:17:11 -0800231#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800232 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800233 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800234 RETURN_IF_USER_DENIED_CONSENT();
235
Sahana Raof35ed432019-07-12 10:47:52 +0100236static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
237
Rhed Jao5377d792020-07-16 17:37:39 +0800238// Names of parallel tasks, they are used for the DumpPool to identify the dump
239// task and the log title of the duration report.
240static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800241static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800242static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800243static const std::string DUMP_HALS_TASK = "DUMP HALS";
244static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800245static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800246
Nandana Dutt979388e2018-11-30 16:48:55 +0000247namespace android {
248namespace os {
249namespace {
250
251static int Open(std::string path, int flags, mode_t mode = 0) {
252 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
253 if (fd == -1) {
254 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
255 }
256 return fd;
257}
258
mhasank2d75c442020-06-11 15:05:25 -0700259static int OpenForWrite(std::string path) {
260 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
261 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
262}
Nandana Dutt979388e2018-11-30 16:48:55 +0000263
264static int OpenForRead(std::string path) {
265 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
266}
267
268bool CopyFile(int in_fd, int out_fd) {
269 char buf[4096];
270 ssize_t byte_count;
271 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
272 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
273 return false;
274 }
275 }
276 return (byte_count != -1);
277}
278
279static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000280 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000281
282 // Obtain a handle to the source file.
283 android::base::unique_fd in_fd(OpenForRead(input_file));
284 if (out_fd != -1 && in_fd.get() != -1) {
285 if (CopyFile(in_fd.get(), out_fd)) {
286 return true;
287 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000288 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000289 }
290 return false;
291}
292
Nandana Duttd2f5f082019-01-18 17:13:52 +0000293static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000294 if (file.empty()) {
295 return false;
296 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000297 if (unlink(file.c_str())) {
298 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000299 return false;
300 }
301 return true;
302}
Nandana Dutt979388e2018-11-30 16:48:55 +0000303
Nikita Ioffea325a572019-05-16 19:49:47 +0100304int64_t GetModuleMetadataVersion() {
305 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
306 if (binder == nullptr) {
307 MYLOGE("Failed to retrieve package_native service");
308 return 0L;
309 }
310 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
311 std::string package_name;
312 auto status = package_service->getModuleMetadataPackageName(&package_name);
313 if (!status.isOk()) {
314 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
315 return 0L;
316 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100317 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100318 int64_t version_code;
319 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
320 &version_code);
321 if (!status.isOk()) {
322 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
323 return 0L;
324 }
325 return version_code;
326}
327
mhasank2d75c442020-06-11 15:05:25 -0700328static bool PathExists(const std::string& path) {
329 struct stat sb;
330 return stat(path.c_str(), &sb) == 0;
331}
332
333static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
334 if (input_file == output_file) {
335 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
336 output_file.c_str());
337 return false;
338 }
339 else if (PathExists(output_file)) {
340 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
341 return false;
342 }
343
344 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
345 android::base::unique_fd out_fd(OpenForWrite(output_file));
346 return CopyFileToFd(input_file, out_fd.get());
347}
348
Nandana Dutt979388e2018-11-30 16:48:55 +0000349} // namespace
350} // namespace os
351} // namespace android
352
Felipe Leme678727a2016-09-21 17:22:11 -0700353static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800354 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800355 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
356 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
357}
358static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
359 int out_fd) {
360 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700361}
362static int DumpFile(const std::string& title, const std::string& path) {
363 return ds.DumpFile(title, path);
364}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800365
Felipe Lemee844a9d2016-09-21 15:01:39 -0700366// Relative directory (inside the zip) for all files copied as-is into the bugreport.
367static const std::string ZIP_ROOT_DIR = "FS";
368
Vishnu Naire97d6122018-01-18 13:58:56 -0800369static const std::string kProtoPath = "proto/";
370static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700371static const std::string kDumpstateBoardFiles[] = {
372 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700373 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700374};
375static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
376
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700377static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700378static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700379
Felipe Lemef0292972016-11-22 13:57:05 -0800380static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
381
Narayan Kamath8f788292017-05-25 13:20:39 +0100382/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100383 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800384 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800385 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100386 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700387static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800388 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100389 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100390
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700391 if (dump_dir == nullptr) {
392 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700393 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700394 }
395
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700396 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100397 struct dirent* entry = nullptr;
398 while ((entry = readdir(dump_dir.get()))) {
399 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100400 continue;
401 }
402
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 const std::string base_name(entry->d_name);
404 if (base_name.find(file_prefix) != 0) {
405 continue;
406 }
407
408 const std::string abs_path = dir_path + base_name;
409 android::base::unique_fd fd(
410 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
411 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700412 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100413 break;
414 }
415
416 struct stat st = {};
417 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700418 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100419 continue;
420 }
421
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700422 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700423 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800424 if (!dump_data.empty()) {
425 std::sort(dump_data.begin(), dump_data.end(),
426 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
427 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100428
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700429 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100430}
431
Narayan Kamathbd863722017-06-01 18:50:12 +0100432static bool AddDumps(const std::vector<DumpData>::const_iterator start,
433 const std::vector<DumpData>::const_iterator end,
434 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100435 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100436 for (auto it = start; it != end; ++it) {
437 const std::string& name = it->name;
438 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100439 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100440
441 // Seek to the beginning of the file before dumping any data. A given
442 // DumpData entry might be dumped multiple times in the report.
443 //
444 // For example, the most recent ANR entry is dumped to the body of the
445 // main entry and it also shows up as a separate entry in the bugreport
446 // ZIP file.
447 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
448 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
449 strerror(errno));
450 }
451
Chris Morinc2cba7a2022-02-01 17:06:50 -0800452 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800453 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100454 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100455 }
456 } else {
457 dump_file_from_fd(type_name, name.c_str(), fd);
458 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100459 }
460
461 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700462}
463
Felipe Leme635ca312016-01-05 14:23:02 -0800464// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700465void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800466 char path[PATH_MAX];
467
468 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
469 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700470 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800471 char linkname[PATH_MAX];
472 ssize_t r = readlink(path, linkname, PATH_MAX);
473 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800474 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800475 return;
476 }
477 linkname[r] = '\0';
478
479 if (mount_points.find(linkname) == mount_points.end()) {
480 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700481 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700482 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800483 mount_points.insert(linkname);
484 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800485 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800486 }
487 }
488}
489
490void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700491 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800492 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800493 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700494 for_each_pid(do_mountinfo, nullptr);
495 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800496}
497
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700498static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
499{
500 DIR *d;
501 struct dirent *de;
502 char path[PATH_MAX];
503
504 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700505 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700506 return;
507 }
508
509 while ((de = readdir(d))) {
510 if (de->d_type != DT_LNK) {
511 continue;
512 }
513 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700514 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700515 }
516
517 closedir(d);
518}
519
Mark Salyzyn326842f2015-04-30 09:49:41 -0700520static bool skip_not_stat(const char *path) {
521 static const char stat[] = "/stat";
522 size_t len = strlen(path);
523 if (path[len - 1] == '/') { /* Directory? */
524 return false;
525 }
526 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
527}
528
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700529static bool skip_wtf_strictmode(const char *path) {
530 if (strstr(path, "_wtf")) {
531 return true;
532 } else if (strstr(path, "_strictmode")) {
533 return true;
534 }
535 return false;
536}
537
Felipe Leme4c2d6632016-09-28 14:32:00 -0700538static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800539 return false;
540}
541
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700542unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700543
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800544//
545// stat offsets
546// Name units description
547// ---- ----- -----------
548// read I/Os requests number of read I/Os processed
549#define __STAT_READ_IOS 0
550// read merges requests number of read I/Os merged with in-queue I/O
551#define __STAT_READ_MERGES 1
552// read sectors sectors number of sectors read
553#define __STAT_READ_SECTORS 2
554// read ticks milliseconds total wait time for read requests
555#define __STAT_READ_TICKS 3
556// write I/Os requests number of write I/Os processed
557#define __STAT_WRITE_IOS 4
558// write merges requests number of write I/Os merged with in-queue I/O
559#define __STAT_WRITE_MERGES 5
560// write sectors sectors number of sectors written
561#define __STAT_WRITE_SECTORS 6
562// write ticks milliseconds total wait time for write requests
563#define __STAT_WRITE_TICKS 7
564// in_flight requests number of I/Os currently in flight
565#define __STAT_IN_FLIGHT 8
566// io_ticks milliseconds total time this block device has been active
567#define __STAT_IO_TICKS 9
568// time_in_queue milliseconds total wait time for all requests
569#define __STAT_IN_QUEUE 10
570#define __STAT_NUMBER_FIELD 11
571//
572// read I/Os, write I/Os
573// =====================
574//
575// These values increment when an I/O request completes.
576//
577// read merges, write merges
578// =========================
579//
580// These values increment when an I/O request is merged with an
581// already-queued I/O request.
582//
583// read sectors, write sectors
584// ===========================
585//
586// These values count the number of sectors read from or written to this
587// block device. The "sectors" in question are the standard UNIX 512-byte
588// sectors, not any device- or filesystem-specific block size. The
589// counters are incremented when the I/O completes.
590#define SECTOR_SIZE 512
591//
592// read ticks, write ticks
593// =======================
594//
595// These values count the number of milliseconds that I/O requests have
596// waited on this block device. If there are multiple I/O requests waiting,
597// these values will increase at a rate greater than 1000/second; for
598// example, if 60 read requests wait for an average of 30 ms, the read_ticks
599// field will increase by 60*30 = 1800.
600//
601// in_flight
602// =========
603//
604// This value counts the number of I/O requests that have been issued to
605// the device driver but have not yet completed. It does not include I/O
606// requests that are in the queue but not yet issued to the device driver.
607//
608// io_ticks
609// ========
610//
611// This value counts the number of milliseconds during which the device has
612// had I/O requests queued.
613//
614// time_in_queue
615// =============
616//
617// This value counts the number of milliseconds that I/O requests have waited
618// on this block device. If there are multiple I/O requests waiting, this
619// value will increase as the product of the number of milliseconds times the
620// number of requests waiting (see "read ticks" above for an example).
621#define S_TO_MS 1000
622//
623
Mark Salyzyn326842f2015-04-30 09:49:41 -0700624static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800625 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700626 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700627 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700628 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700629 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700630 getline(&buffer, &i, fp);
631 fclose(fp);
632 if (!buffer) {
633 return -errno;
634 }
635 i = strlen(buffer);
636 while ((i > 0) && (buffer[i - 1] == '\n')) {
637 buffer[--i] = '\0';
638 }
639 if (!*buffer) {
640 free(buffer);
641 return 0;
642 }
643 z = true;
644 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800645 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700646 if (fields[i] != 0) {
647 z = false;
648 }
649 }
650 if (z) { /* never accessed */
651 free(buffer);
652 return 0;
653 }
654
Wei Wang509bb5d2017-06-09 14:42:12 -0700655 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
656 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700657 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700658
659 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
660 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
661 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700662 free(buffer);
663
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800664 if (fields[__STAT_IO_TICKS]) {
665 unsigned long read_perf = 0;
666 unsigned long read_ios = 0;
667 if (fields[__STAT_READ_TICKS]) {
668 unsigned long long divisor = fields[__STAT_READ_TICKS]
669 * fields[__STAT_IO_TICKS];
670 read_perf = ((unsigned long long)SECTOR_SIZE
671 * fields[__STAT_READ_SECTORS]
672 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
673 / divisor;
674 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
675 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
676 / divisor;
677 }
678
679 unsigned long write_perf = 0;
680 unsigned long write_ios = 0;
681 if (fields[__STAT_WRITE_TICKS]) {
682 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
683 * fields[__STAT_IO_TICKS];
684 write_perf = ((unsigned long long)SECTOR_SIZE
685 * fields[__STAT_WRITE_SECTORS]
686 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
687 / divisor;
688 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
689 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
690 / divisor;
691 }
692
693 unsigned queue = (fields[__STAT_IN_QUEUE]
694 + (fields[__STAT_IO_TICKS] >> 1))
695 / fields[__STAT_IO_TICKS];
696
697 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700698 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 -0800699 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700700 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 -0800701 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800702 }
703
704 /* bugreport timeout factor adjustment */
705 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
706 worst_write_perf = write_perf;
707 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700708 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700709 return 0;
710}
711
Yao Chenbe3bbc12018-01-17 16:31:10 -0800712static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
713
Tom Cherryf4472f32020-08-05 09:31:17 -0700714// Returns the actual readable size of the given buffer or -1 on error.
715static long logcat_buffer_readable_size(const std::string& buffer) {
716 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
717 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
718 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
719
720 return android_logger_get_log_readable_size(logger);
721}
722
723// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800724static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
725 unsigned long timeout_ms = 0;
726 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700727 long readable_size = logcat_buffer_readable_size(buffer);
728 if (readable_size > 0) {
729 // Engineering margin is ten-fold our guess.
730 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
731 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800732 }
733 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700734}
735
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800736// Opens a socket and returns its file descriptor.
737static int open_socket(const char* service);
738
Nandana Duttd2f5f082019-01-18 17:13:52 +0000739Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
740}
741
742android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
743 std::lock_guard<std::mutex> lock(lock_);
744 result_ = APPROVED;
745 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800746
747 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
748 // consent is granted.
749 if (ds.options_->is_screenshot_copied) {
750 return android::binder::Status::ok();
751 }
752
753 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
754 !ds.do_early_screenshot_) {
755 return android::binder::Status::ok();
756 }
757
758 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
759 ds.options_->screenshot_fd.get());
760 ds.options_->is_screenshot_copied = copy_succeeded;
761 if (copy_succeeded) {
762 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
763 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000764 return android::binder::Status::ok();
765}
766
767android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
768 std::lock_guard<std::mutex> lock(lock_);
769 result_ = DENIED;
770 MYLOGW("User denied consent to share bugreport\n");
771 return android::binder::Status::ok();
772}
773
774UserConsentResult Dumpstate::ConsentCallback::getResult() {
775 std::lock_guard<std::mutex> lock(lock_);
776 return result_;
777}
778
779uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800780 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000781}
782
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700783void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200784 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700785 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700786
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700787 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
788 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700789 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
790 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
791 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200792 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700793 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700794
Felipe Lemed8b94e52016-12-08 10:21:44 -0800795 printf("========================================================\n");
796 printf("== dumpstate: %s\n", date);
797 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700798
Felipe Lemed8b94e52016-12-08 10:21:44 -0800799 printf("\n");
800 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700801 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800802 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
803 printf("Bootloader: %s\n", bootloader.c_str());
804 printf("Radio: %s\n", radio.c_str());
805 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100806 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
807 if (module_metadata_version != 0) {
808 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
809 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200810 printf("Android SDK version: %s\n", sdkversion.c_str());
811 printf("SDK extensions: ");
812 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
813 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700814
Felipe Lemed8b94e52016-12-08 10:21:44 -0800815 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800816 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800817 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000818 printf("Bootconfig: ");
819 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800820 printf("Uptime: ");
821 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
822 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800823 printf("Bugreport format version: %s\n", version_.c_str());
Kevin Jeonfa64e642023-07-27 11:36:41 -0400824 printf(
825 "Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d strict_run=%d args=%s "
826 "bugreport_mode=%s\n",
827 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
828 PropertiesHelper::IsStrictRun(), options_->args.c_str(),
829 options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800830 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800831}
832
Felipe Leme24b66ee2016-06-16 10:55:26 -0700833// List of file extensions that can cause a zip file attachment to be rejected by some email
834// service providers.
835static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
836 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
837 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
838 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
839};
840
Vishnu Naire97d6122018-01-18 13:58:56 -0800841status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
842 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700843 std::string valid_name = entry_name;
844
845 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700846 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700847 if (idx != std::string::npos) {
848 std::string extension = entry_name.substr(idx);
849 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
850 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
851 valid_name = entry_name + ".renamed";
852 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
853 }
854 }
855
Felipe Leme6fe9db62016-02-12 09:04:16 -0800856 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
857 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000858 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
859 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700860 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700861 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700862 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700863 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800864 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800865 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000866 bool finished_entry = false;
867 auto finish_entry = [this, &finished_entry] {
868 if (!finished_entry) {
869 // This should only be called when we're going to return an earlier error,
870 // which would've been logged. This may imply the file is already corrupt
871 // and any further logging from FinishEntry is more likely to mislead than
872 // not.
873 this->zip_writer_->FinishEntry();
874 }
875 };
876 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800877 auto start = std::chrono::steady_clock::now();
878 auto end = start + timeout;
879 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800880
Felipe Leme770410d2016-01-26 17:07:14 -0800881 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800882 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800883 if (timeout.count() > 0) {
884 // lambda to recalculate the timeout.
885 auto time_left_ms = [end]() {
886 auto now = std::chrono::steady_clock::now();
887 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
888 return std::max(diff.count(), 0LL);
889 };
890
891 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
892 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000893 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
894 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800895 return -errno;
896 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000897 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800898 entry_name.c_str(), strerror(errno), timeout.count());
899 return TIMED_OUT;
900 }
901 }
902
Zach Riggle22200402016-08-18 01:01:24 -0400903 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800904 if (bytes_read == 0) {
905 break;
906 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800907 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800908 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800909 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700910 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800911 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700912 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800913 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800914 }
915 }
916
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700917 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000918 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700919 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700920 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800921 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800922 }
923
Vishnu Naire97d6122018-01-18 13:58:56 -0800924 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800925}
926
Felipe Leme1d486fe2016-10-14 18:06:47 -0700927bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
928 android::base::unique_fd fd(
929 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700930 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800931 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800932 return false;
933 }
934
Vishnu Naire97d6122018-01-18 13:58:56 -0800935 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800936}
937
938/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700939static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800940 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800941}
942
Felipe Leme1d486fe2016-10-14 18:06:47 -0700943void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700944 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800945 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700946 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800947}
948
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800950 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000951 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
952 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700953 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700954 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700955 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800956 return false;
957 }
958
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700959 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700960 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700961 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700962 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800963 return false;
964 }
965
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700966 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700967 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700968 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800969 return false;
970 }
971
972 return true;
973}
974
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800975static void DoKmsg() {
976 struct stat st;
977 if (!stat(PSTORE_LAST_KMSG, &st)) {
978 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
979 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
980 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
981 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
982 } else {
983 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
984 DumpFile("LAST KMSG", "/proc/last_kmsg");
985 }
986}
987
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800988static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800989 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800990 RunCommand(
991 "KERNEL LOG",
992 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
993 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
994}
995
Nandana Duttdb379fa2019-10-09 16:54:41 +0100996static void DoSystemLogcat(time_t since) {
997 char since_str[80];
998 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
999
1000 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
1001 RunCommand("SYSTEM LOG",
1002 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1003 since_str},
1004 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1005}
1006
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001007static void DoRadioLogcat() {
1008 unsigned long timeout_ms = logcat_timeout({"radio"});
1009 RunCommand(
1010 "RADIO LOG",
1011 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1012 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1013}
1014
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001015static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001016 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001017 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1018 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001019 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001020 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001021 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1022 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001023 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001024 RunCommand(
1025 "EVENT LOG",
1026 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001027 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001028 timeout_ms = logcat_timeout({"stats"});
1029 RunCommand(
1030 "STATS LOG",
1031 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001032 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001033 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001034
1035 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1036
1037 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001038 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1039 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001040}
1041
Mike Ma5c267872019-08-21 11:31:34 -07001042static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001043 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1044 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1045 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1046 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1047 if (fd < 0) {
1048 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1049 return;
1050 }
Kevin Jeonfa64e642023-07-27 11:36:41 -04001051 RunCommandToFd(fd, "", {"incident", "-u"},
1052 CommandOptions::WithTimeout(PropertiesHelper::IsStrictRun() ? 20 : 120).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001053 bool empty = 0 == lseek(fd, 0, SEEK_END);
1054 if (!empty) {
1055 // Use a different name from "incident.proto"
1056 // /proto/incident.proto is reserved for incident service dump
1057 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001058 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1059 path);
1060 } else {
1061 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001062 }
Mike Ma5c267872019-08-21 11:31:34 -07001063}
1064
Aaron Huanga99452a2022-04-27 18:51:16 +08001065static void DumpNetstatsProto() {
1066 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1067 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1068 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1069 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1070 if (fd < 0) {
1071 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1072 return;
1073 }
1074 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1075 CommandOptions::WithTimeout(120).Build());
1076 bool empty = 0 == lseek(fd, 0, SEEK_END);
1077 if (!empty) {
1078 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1079 path);
1080 } else {
1081 unlink(path.c_str());
1082 }
1083}
1084
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001085static void MaybeAddSystemTraceToZip() {
1086 // This function copies into the .zip the system trace that was snapshotted
1087 // by the early call to MaybeSnapshotSystemTrace(), if any background
1088 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001089 if (!ds.has_system_trace_) {
1090 // No background trace was happening at the time dumpstate was invoked.
1091 return;
1092 }
1093 ds.AddZipEntry(
1094 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1095 SYSTEM_TRACE_SNAPSHOT);
1096 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1097}
1098
Sunny Goyal35949782019-11-19 15:54:36 -08001099static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001100 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1101 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1102 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1103 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1104 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1105 if (fd < 0) {
1106 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1107 return;
1108 }
1109 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001110 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001111 bool empty = 0 == lseek(fd, 0, SEEK_END);
1112 if (!empty) {
1113 ds.AddZipEntry("visible_windows.zip", path);
1114 } else {
1115 MYLOGW("Failed to dump visible windows\n");
1116 }
1117 unlink(path.c_str());
1118}
1119
Jayachandran Ca94c7172017-06-10 15:08:12 -07001120static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001121 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1122 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001123 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001124 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001125 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1126 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1127 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1128 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001129}
1130
Woody Lin20767a92022-11-29 15:50:24 +08001131static void DumpShutdownCheckpoints() {
1132 const bool shutdown_checkpoints_dumped = AddDumps(
1133 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1134 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1135 if (!shutdown_checkpoints_dumped) {
1136 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1137 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1138 }
1139}
1140
David Andersond9ba4752018-12-11 18:26:59 -08001141static void DumpDynamicPartitionInfo() {
1142 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1143 return;
1144 }
1145
1146 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001147 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001148}
1149
Chris Morin5a50d482022-02-01 17:41:18 -08001150static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001151 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1152 anr_traces_dir.c_str());
1153
1154 // If we're here, dump_traces_path will always be a temporary file
1155 // (created with mkostemp or similar) that contains dumps taken earlier
1156 // on in the process.
1157 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001158 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1159 dump_traces_path);
1160 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001161
1162 const int ret = unlink(dump_traces_path);
1163 if (ret == -1) {
1164 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1165 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001166 }
1167 }
1168
Narayan Kamathbd863722017-06-01 18:50:12 +01001169 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001170 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001171 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001172 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001173 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001174
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001175 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001176 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001177 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001178 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001179 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1180 }
1181}
1182
1183static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001184 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001185
Chris Morin5a50d482022-02-01 17:41:18 -08001186 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001187
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001188 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1189
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001190 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001191 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001192 int i = 0;
1193 while (true) {
1194 const std::string slow_trace_path =
1195 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1196 if (stat(slow_trace_path.c_str(), &st)) {
1197 // No traces file at this index, done with the files.
1198 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001199 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001200 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1201 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001202 }
1203}
1204
Wei Wang509bb5d2017-06-09 14:42:12 -07001205static void DumpBlockStatFiles() {
1206 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001207
Wei Wang1dc1ef52017-06-12 11:28:37 -07001208 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1209
1210 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001211 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1212 return;
1213 }
1214
1215 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001216 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001217 if ((d->d_name[0] == '.')
1218 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1219 || (d->d_name[1] == '\0'))) {
1220 continue;
1221 }
1222 const std::string new_path =
1223 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1224 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1225 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1226 printf("\n");
1227 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001228 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001229}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001230
1231static void DumpPacketStats() {
1232 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001233}
1234
1235static void DumpIpAddrAndRules() {
1236 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1237 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1238 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1239 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1240 RunCommand("IP RULES", {"ip", "rule", "show"});
1241 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1242}
1243
Nandana Dutt5c390032019-03-12 10:52:56 +00001244static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1245 std::chrono::milliseconds timeout,
1246 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001247 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001248 sp<android::IServiceManager> sm = defaultServiceManager();
1249 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001250 Vector<String16> args;
1251 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001252 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1253 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001254 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001255 std::string path(title);
1256 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001257 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001258 if (PropertiesHelper::IsDryRun()) {
1259 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1260 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1261 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001262 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1263 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001264 service, args);
1265 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001266 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1267 std::chrono::duration<double> elapsed_seconds;
1268 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1269 service == String16("meminfo")) {
1270 // Use a longer timeout for meminfo, since 30s is not always enough.
1271 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1272 /* as_proto = */ false, elapsed_seconds,
1273 bytes_written);
1274 } else {
1275 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1276 /* as_proto = */ false, elapsed_seconds,
1277 bytes_written);
1278 }
1279 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1280 bool dump_complete = (status == OK);
1281 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001282 } else {
1283 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1284 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001285 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001286 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001287
1288 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1289 std::chrono::steady_clock::now() - start);
1290 if (elapsed_duration > timeout) {
1291 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1292 elapsed_duration.count());
1293 break;
1294 }
1295 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001296 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001297}
1298
Vishnu Nair64afc022018-02-01 15:29:34 -08001299static void RunDumpsysText(const std::string& title, int priority,
1300 std::chrono::milliseconds timeout,
1301 std::chrono::milliseconds service_timeout) {
1302 DurationReporter duration_reporter(title);
1303 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1304 fsync(STDOUT_FILENO);
1305 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1306}
1307
1308/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001309static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1310 std::chrono::milliseconds timeout,
1311 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001312 DurationReporter duration_reporter(title);
1313 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1314 fsync(STDOUT_FILENO);
1315 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1316 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001317
1318 RETURN_IF_USER_DENIED_CONSENT();
1319
1320 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1321 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001322}
1323
Nandana Dutt5c390032019-03-12 10:52:56 +00001324static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1325 std::chrono::milliseconds timeout,
1326 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001327 sp<android::IServiceManager> sm = defaultServiceManager();
1328 Dumpsys dumpsys(sm.get());
1329 Vector<String16> args;
1330 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1331 DurationReporter duration_reporter(title);
1332
1333 auto start = std::chrono::steady_clock::now();
1334 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1335 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001336 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001337 std::string path(kProtoPath);
1338 path.append(String8(service).c_str());
1339 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1340 path.append("_CRITICAL");
1341 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1342 path.append("_HIGH");
1343 }
1344 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001345 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001346 if (status == OK) {
1347 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1348 bool dumpTerminated = (status == OK);
1349 dumpsys.stopDumpThread(dumpTerminated);
1350 }
1351 ZipWriter::FileEntry file_entry;
1352 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001353
1354 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1355 std::chrono::steady_clock::now() - start);
1356 if (elapsed_duration > timeout) {
1357 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1358 elapsed_duration.count());
1359 break;
1360 }
1361 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001362 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001363}
1364
Nandana Dutta7db6342018-11-21 14:53:34 +00001365// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001366static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001367 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1368 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001369
1370 RETURN_IF_USER_DENIED_CONSENT();
1371
1372 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1373 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001374}
1375
1376// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001377static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001378 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1379 // high priority. Reduce timeout once they are able to dump in a shorter time or
1380 // moved to a parallel task.
1381 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1382 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001383
1384 RETURN_IF_USER_DENIED_CONSENT();
1385
1386 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1387 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001388}
1389
1390// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001391static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001392 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001393
1394 RETURN_IF_USER_DENIED_CONSENT();
1395
1396 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1397 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001398}
1399
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001400/*
1401 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1402 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1403 * if it's not running in the parallel task.
1404 */
1405static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001406 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001407 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1408 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001409
Steven Moreland44cd9482018-01-04 16:24:13 -08001410 using android::hidl::manager::V1_0::IServiceManager;
1411 using android::hardware::defaultServiceManager;
1412
1413 sp<IServiceManager> sm = defaultServiceManager();
1414 if (sm == nullptr) {
1415 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1416 return;
1417 }
1418
1419 auto ret = sm->list([&](const auto& interfaces) {
1420 for (const std::string& interface : interfaces) {
1421 std::string cleanName = interface;
Steven Morelandc6b1fc22023-07-26 23:53:58 +00001422 std::replace_if(
1423 cleanName.begin(), cleanName.end(),
1424 [](char c) {
1425 return !isalnum(c) && std::string("@-_.").find(c) == std::string::npos;
1426 },
1427 '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001428 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001429
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001430 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001431 {
1432 auto fd = android::base::unique_fd(
1433 TEMP_FAILURE_RETRY(open(path.c_str(),
1434 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1435 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1436 if (fd < 0) {
1437 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1438 continue;
1439 }
1440 RunCommandToFd(fd,
1441 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001442 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001443 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1444
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001445 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001446 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001447 if (!empty) {
1448 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1449 path);
1450 } else {
1451 unlink(path.c_str());
1452 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001453 }
1454 });
1455
1456 if (!ret.isOk()) {
1457 MYLOGE("Could not list hals from hwservicemanager.\n");
1458 }
1459}
1460
Devin Moore8df81bb2022-06-08 22:47:02 +00001461// Dump all of the files that make up the vendor interface.
1462// See the files listed in dumpFileList() for the latest list of files.
1463static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001464
1465 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1466 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001467 for (const auto vintfFile : vintfFiles) {
1468 struct stat st;
1469 if (stat(vintfFile.c_str(), &st) == 0) {
1470 if (S_ISDIR(st.st_mode)) {
1471 ds.AddDir(vintfFile, true /* recursive */);
1472 } else {
1473 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1474 vintfFile);
1475 }
1476 }
1477 }
1478}
1479
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001480static void DumpExternalFragmentationInfo() {
1481 struct stat st;
1482 if (stat("/proc/buddyinfo", &st) != 0) {
1483 MYLOGE("Unable to dump external fragmentation info\n");
1484 return;
1485 }
1486
1487 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1488 std::ifstream ifs("/proc/buddyinfo");
1489 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1490 for (std::string line; std::getline(ifs, line);) {
1491 std::smatch match_results;
1492 if (std::regex_match(line, match_results, unusable_index_regex)) {
1493 std::stringstream free_pages(std::string{match_results[3]});
1494 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1495 std::istream_iterator<int>());
1496
1497 int total_free_pages = 0;
1498 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1499 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1500 }
1501
1502 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1503 match_results[2].str().c_str());
1504
1505 int usable_free_pages = total_free_pages;
1506 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1507 auto unusable_index = (total_free_pages - usable_free_pages) /
1508 static_cast<double>(total_free_pages);
1509 printf(" %5.3f", unusable_index);
1510 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1511 }
1512
1513 printf("\n");
1514 }
1515 }
1516 printf("\n");
1517}
1518
mhasankd451a472020-05-26 18:02:39 -07001519static void DumpstateLimitedOnly() {
1520 // Trimmed-down version of dumpstate to only include a whitelisted
1521 // set of logs (system log, event log, and system server / system app
1522 // crashes, and networking logs). See b/136273873 and b/138459828
1523 // for context.
1524 DurationReporter duration_reporter("DUMPSTATE");
1525 unsigned long timeout_ms;
1526 // calculate timeout
1527 timeout_ms = logcat_timeout({"main", "system", "crash"});
1528 RunCommand("SYSTEM LOG",
1529 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1530 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1531 timeout_ms = logcat_timeout({"events"});
1532 RunCommand(
1533 "EVENT LOG",
1534 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1535 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1536
1537 printf("========================================================\n");
1538 printf("== Networking Service\n");
1539 printf("========================================================\n");
1540
1541 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1542 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001543 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1544 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001545
1546 printf("========================================================\n");
1547 printf("== Dropbox crashes\n");
1548 printf("========================================================\n");
1549
1550 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1551 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1552
1553 printf("========================================================\n");
1554 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1555 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1556 printf("========================================================\n");
1557 printf("== dumpstate: done (id %d)\n", ds.id_);
1558 printf("========================================================\n");
1559}
1560
Rhed Jaoe017f982020-07-21 17:58:41 +08001561/*
1562 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1563 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1564 * if it's not running in the parallel task.
1565 */
1566static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1567 dprintf(out_fd, "========================================================\n");
1568 dprintf(out_fd, "== Checkins\n");
1569 dprintf(out_fd, "========================================================\n");
1570
1571 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001572 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1573 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1574 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1575 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1576}
1577
1578/*
1579 * Runs dumpsys on activity service to dump all application activities, services
1580 * and providers in the device.
1581 *
1582 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1583 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1584 * if it's not running in the parallel task.
1585 */
1586static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1587 dprintf(out_fd, "========================================================\n");
1588 dprintf(out_fd, "== Running Application Activities\n");
1589 dprintf(out_fd, "========================================================\n");
1590
1591 // The following dumpsys internally collects output from running apps, so it can take a long
1592 // time. So let's extend the timeout.
1593
1594 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1595
1596 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1597
1598 dprintf(out_fd, "========================================================\n");
1599 dprintf(out_fd, "== Running Application Services (platform)\n");
1600 dprintf(out_fd, "========================================================\n");
1601
1602 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1603 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1604
1605 dprintf(out_fd, "========================================================\n");
1606 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1607 dprintf(out_fd, "========================================================\n");
1608
1609 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1610 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1611
1612 dprintf(out_fd, "========================================================\n");
1613 dprintf(out_fd, "== Running Application Providers (platform)\n");
1614 dprintf(out_fd, "========================================================\n");
1615
1616 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001617 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001618
1619 dprintf(out_fd, "========================================================\n");
1620 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1621 dprintf(out_fd, "========================================================\n");
1622
1623 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1624 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1625}
1626
Nandana Dutt5c390032019-03-12 10:52:56 +00001627// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1628// via the consent they are shown. Ignores other errors that occur while running various
1629// commands. The consent checking is currently done around long running tasks, which happen to
1630// be distributed fairly evenly throughout the function.
1631static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001632 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001633
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001634 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001635 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1636 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001637 if (ds.dump_pool_) {
1638 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1639 // drop root user. Restarts it with two threads for the parallel run.
1640 ds.dump_pool_->start(/* thread_counts = */2);
1641
Chris Morinbc223142022-02-04 14:17:11 -08001642 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1643 dump_incident_report = ds.dump_pool_->enqueueTask(
1644 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001645 dump_netstats_report = ds.dump_pool_->enqueueTask(
1646 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001647 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1648 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1649 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001650 }
1651
Nandana Dutt5c390032019-03-12 10:52:56 +00001652 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1653 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1654 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001655 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001656 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001657 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001658 DumpFile("MEMORY INFO", "/proc/meminfo");
1659 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001660 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001661
Kevin Jeon947922b2022-09-21 00:29:18 +00001662 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1663 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001664
Sunny Goyal35949782019-11-19 15:54:36 -08001665 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1666
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001667 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1668 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1669 DumpFile("SLAB INFO", "/proc/slabinfo");
1670 DumpFile("ZONEINFO", "/proc/zoneinfo");
1671 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1672 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001673 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001674
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001675 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001676
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001677 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001678 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001679
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001680 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001681 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001682 } else {
1683 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1684 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001685
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001686 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001687 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001688 struct stat s;
1689 if (stat("/proc/modules", &s) != 0) {
1690 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1691 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001692 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001693 RunCommand("MODULES INFO",
1694 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1695 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1696 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001697 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001698
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001699 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001700 DoKernelLogcat();
1701 } else {
1702 do_dmesg();
1703 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001704
Devin Moore8df81bb2022-06-08 22:47:02 +00001705 DumpVintf();
1706
Felipe Lemef0292972016-11-22 13:57:05 -08001707 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001708
Jeff Brown1dc94e32014-09-11 14:15:27 -07001709 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001710 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001711
Jack Yu5a6b2e22020-08-14 18:13:35 +08001712 /* Dump Nfc NCI logs */
1713 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001714
Paul Chang0d2aad72020-02-13 20:04:03 +08001715 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001716 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001717 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001718 }
1719
Felipe Lemee184f662016-10-27 10:04:47 -07001720 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001721
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001722 MaybeAddSystemTraceToZip();
1723
Narayan Kamath8f788292017-05-25 13:20:39 +01001724 // NOTE: tombstones are always added as separate entries in the zip archive
1725 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001726 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001727 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001728 if (!tombstones_dumped) {
1729 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001730 }
1731
Jayachandran Ca94c7172017-06-10 15:08:12 -07001732 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001733
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001734 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001735
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001736 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001737
Woody Lin20767a92022-11-29 15:50:24 +08001738 DumpShutdownCheckpoints();
1739
Jayachandran Ca94c7172017-06-10 15:08:12 -07001740 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001741
1742 dump_route_tables();
1743
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001744 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1745 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1746 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001747
Nandana Dutt5c390032019-03-12 10:52:56 +00001748 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001749
Chiachang Wang668ede42021-05-17 17:14:20 +08001750 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1751 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1752 // dump with priority parameters to dump high priority information.
1753 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1754 CommandOptions::WithTimeout(10).Build());
1755
Elliott Hughes23ccc622017-02-28 10:14:22 -08001756 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001757
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001758 DumpFile("SYSTEM BUILD-TIME RELEASE FLAGS", "/system/etc/build_flags.json");
1759 DumpFile("SYSTEM_EXT BUILD-TIME RELEASE FLAGS", "/system_ext/etc/build_flags.json");
1760 DumpFile("PRODUCT BUILD-TIME RELEASE FLAGS", "/product/etc/build_flags.json");
1761 DumpFile("VENDOR BUILD-TIME RELEASE FLAGS", "/vendor/etc/build_flags.json");
1762
Mårten Kongstad5ad813f2023-09-28 10:09:18 +02001763 RunCommand("ACONFIG FLAGS", {PRINT_FLAGS},
1764 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001765
Jin Qianf334d662017-10-10 14:41:37 -07001766 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001767
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001768 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001769
Colin Crossf45fa6b2012-03-26 12:38:26 -07001770 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001771 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1772 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1773
1774 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1775 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1776 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1777 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1778 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001779
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001780 /* Add window and surface trace files. */
1781 if (!PropertiesHelper::IsUserBuild()) {
1782 ds.AddDir(WMTRACE_DATA_DIR, false);
1783 }
1784
Yifan Hongd90cc652020-02-08 16:52:02 -08001785 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1786
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001787 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001788 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001789 } else {
1790 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1791 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001792
Steven Moreland7440ddb2016-12-15 16:13:39 -08001793 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001794 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1795 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001796 // su does not exist on user builds, so try running without it.
1797 // This way any implementations of vril-dump that do not require
1798 // root can run on user builds.
1799 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001800 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001801 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001802 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001803 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001804 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001805 }
1806
Felipe Lemed8b94e52016-12-08 10:21:44 -08001807 printf("========================================================\n");
1808 printf("== Android Framework Services\n");
1809 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001810
Nandana Dutt5c390032019-03-12 10:52:56 +00001811 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001812
Jack He91ff2fe2021-02-18 18:23:43 -08001813 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1814 ds.AddDir("/data/misc/bluetooth/logs", true);
1815
Rhed Jaoe017f982020-07-21 17:58:41 +08001816 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001817 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001818 } else {
1819 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1820 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001821
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001822 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001823
Adrian Roos8b397ab2017-04-04 16:35:44 -07001824 printf("========================================================\n");
1825 printf("== Dropbox crashes\n");
1826 printf("========================================================\n");
1827
1828 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1829 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1830
Felipe Lemed8b94e52016-12-08 10:21:44 -08001831 printf("========================================================\n");
1832 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1833 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1834 printf("========================================================\n");
1835 printf("== dumpstate: done (id %d)\n", ds.id_);
1836 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001837
1838 printf("========================================================\n");
1839 printf("== Obtaining statsd metadata\n");
1840 printf("========================================================\n");
1841 // This differs from the usual dumpsys stats, which is the stats report data.
1842 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001843
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001844 // Add linker configuration directory
1845 ds.AddDir(LINKERCONFIG_DIR, true);
1846
Li Li830179f2022-01-04 12:53:29 -08001847 /* Dump frozen cgroupfs */
1848 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001849
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001850 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001851 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1852 } else {
1853 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1854 DumpNetstatsProto);
1855 }
1856
1857 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001858 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001859 } else {
1860 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1861 DumpIncidentReport);
1862 }
Mike Ma5c267872019-08-21 11:31:34 -07001863
Nandana Dutt5c390032019-03-12 10:52:56 +00001864 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001865}
1866
Nandana Dutt5c390032019-03-12 10:52:56 +00001867/*
1868 * Dumps state for the default case; drops root after it's no longer necessary.
1869 *
1870 * Returns RunStatus::OK if everything went fine.
1871 * Returns RunStatus::ERROR if there was an error.
1872 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1873 * with the caller.
1874 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001875Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001876 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1877 // buffer.
1878 DoLogcat();
1879 // Capture timestamp after first logcat to use in next logcat
1880 time_t logcat_ts = time(nullptr);
1881
Nandana Dutt4be45d12018-09-26 15:04:23 +01001882 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001883 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001884 if (dump_pool_) {
1885 RETURN_IF_USER_DENIED_CONSENT();
1886 // One thread is enough since we only need to enqueue DumpTraces here.
1887 dump_pool_->start(/* thread_counts = */1);
1888
1889 // DumpTraces takes long time, post it to the another thread in the
1890 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001891 dump_traces = dump_pool_->enqueueTask(
1892 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001893 } else {
1894 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1895 &dump_traces_path);
1896 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001897
1898 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001899 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001900 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1901 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001902 ds.shutdown_checkpoints_ = GetDumpFds(
1903 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001904 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001905
1906 ds.AddDir(RECOVERY_DIR, true);
1907 ds.AddDir(RECOVERY_DATA_DIR, true);
1908 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001909 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001910 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1911 if (!PropertiesHelper::IsUserBuild()) {
1912 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1913 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001914 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001915 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001916 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001917 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001918 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1919 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1920 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001921 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001922 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001923 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001924 if (!PropertiesHelper::IsUserBuild()) {
1925 // Include dropbox entry files inside ZIP, but exclude
1926 // noisy WTF and StrictMode entries
1927 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1928 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001929
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001930 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001931 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1932
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001933 // Dump IPsec stats. No keys are exposed here.
1934 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1935
Nandana Dutt4be45d12018-09-26 15:04:23 +01001936 // Run ss as root so we can see socket marks.
1937 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1938
1939 // Run iotop as root to show top 100 IO threads
1940 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1941
Erick Reyese68df822019-02-11 14:46:36 -08001942 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001943 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1944 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001945
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001946 DumpFile("PSI cpu", "/proc/pressure/cpu");
1947 DumpFile("PSI memory", "/proc/pressure/memory");
1948 DumpFile("PSI io", "/proc/pressure/io");
1949
Mårten Kongstad60195a72022-09-20 14:14:20 +02001950 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1951 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1952
Rhed Jao5377d792020-07-16 17:37:39 +08001953 if (dump_pool_) {
1954 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001955 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001956
Chris Morinbc223142022-02-04 14:17:11 -08001957 // Current running thread in the pool is the root user also. Delete
1958 // the pool and make a new one later to ensure none of threads in the pool are root.
1959 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001960 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001961 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001962 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001963 }
1964
Nandana Dutt5c390032019-03-12 10:52:56 +00001965 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001966 Dumpstate::RunStatus status = dumpstate();
1967 // Capture logcat since the last time we did it.
1968 DoSystemLogcat(logcat_ts);
1969 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001970}
1971
Rhed Jaob5685b32020-08-14 17:19:17 +08001972// Common states for telephony and wifi which are needed to be collected before
1973// dumpstate drop the root user.
1974static void DumpstateRadioAsRoot() {
1975 DumpIpTablesAsRoot();
1976 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1977}
1978
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001979// This method collects common dumpsys for telephony and wifi. Typically, wifi
1980// reports are fine to include all information, but telephony reports on user
1981// builds need to strip some content (see DumpstateTelephonyOnly).
1982static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001983 // We need to be picky about some stuff for telephony reports on user builds.
1984 if (!include_sensitive_info) {
1985 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1986 DoRadioLogcat();
1987 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001988 // DumpHals takes long time, post it to the another thread in the pool,
1989 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001990 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001991 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001992 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001993 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001994 // Contains various system properties and process startup info.
1995 do_dmesg();
1996 // Logs other than the radio buffer may contain package/component names and potential PII.
1997 DoLogcat();
1998 // Too broad for connectivity problems.
1999 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08002000 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
2001 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002002 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08002003 } else {
2004 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
2005 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002006 }
2007
Jayachandran Ca94c7172017-06-10 15:08:12 -07002008 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002009 DumpIpAddrAndRules();
2010 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002011 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2012 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002013}
2014
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002015// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2016// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2017// for what can be included on user builds: all reported information MUST directly relate to
2018// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2019// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2020// names are not), and MUST NOT contain logs of user application traffic.
2021// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002022static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002023 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002024
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002025 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002026
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002027 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002028
Rhed Jaob5685b32020-08-14 17:19:17 +08002029 DumpstateRadioAsRoot();
2030 if (!DropRootUser()) {
2031 return;
2032 }
2033
2034 // Starts thread pool after the root user is dropped, and two additional threads
2035 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002036 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002037 if (ds.dump_pool_) {
2038 ds.dump_pool_->start(/*thread_counts =*/2);
2039
2040 // DumpstateBoard takes long time, post it to the another thread in the pool,
2041 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002042 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2043 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002044 }
2045
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002046 DumpstateRadioCommon(include_sensitive_info);
2047
2048 if (include_sensitive_info) {
2049 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2050 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2051 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2052 // way.
2053 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2054 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002055
2056 printf("========================================================\n");
2057 printf("== Android Framework Services\n");
2058 printf("========================================================\n");
2059
Vishnu Nair652cc802017-11-30 15:18:30 -08002060 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2061 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002062 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2063 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002064 if (include_sensitive_info) {
2065 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2066 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2067 SEC_TO_MSEC(10));
2068 } else {
2069 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2070 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2071 // give a higher timeout as well.
2072 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2073 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2074 }
2075 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002076 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2077 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002078 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002079 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2080 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002081 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2082 SEC_TO_MSEC(10));
Grant Menke9bf3b2b2023-02-24 13:11:07 -08002083 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2084 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002085 if (include_sensitive_info) {
2086 // Contains raw IP addresses, omit from reports on user builds.
2087 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2088 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2089 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2090 SEC_TO_MSEC(10));
2091 // Contains package/component names, omit from reports on user builds.
2092 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2093 SEC_TO_MSEC(10));
2094 // Contains package names, but should be relatively simple to remove them (also contains
2095 // UIDs already), omit from reports on user builds.
2096 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2097 SEC_TO_MSEC(10));
2098 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002099
2100 printf("========================================================\n");
2101 printf("== Running Application Services\n");
2102 printf("========================================================\n");
2103
2104 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2105
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002106 if (include_sensitive_info) {
2107 printf("========================================================\n");
2108 printf("== Running Application Services (non-platform)\n");
2109 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002110
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002111 // Contains package/component names and potential PII, omit from reports on user builds.
2112 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2113 // carrier_config dumpsys instead.
2114 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2115 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002116
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002117 printf("========================================================\n");
2118 printf("== Checkins\n");
2119 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002120
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002121 // Contains package/component names, omit from reports on user builds.
2122 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2123 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002124
2125 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002126 printf("== dumpstate: done (id %d)\n", ds.id_);
2127 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002128
2129 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002130 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002131 } else {
2132 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2133 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002134}
2135
mukesh agrawal253dad42018-01-23 21:59:59 -08002136// This method collects dumpsys for wifi debugging only
2137static void DumpstateWifiOnly() {
2138 DurationReporter duration_reporter("DUMPSTATE");
2139
Rhed Jaob5685b32020-08-14 17:19:17 +08002140 DumpstateRadioAsRoot();
2141 if (!DropRootUser()) {
2142 return;
2143 }
2144
2145 // Starts thread pool after the root user is dropped. Only one additional
2146 // thread is needed for DumpHals in the DumpstateRadioCommon.
2147 if (ds.dump_pool_) {
2148 ds.dump_pool_->start(/*thread_counts =*/1);
2149 }
2150
mukesh agrawal253dad42018-01-23 21:59:59 -08002151 DumpstateRadioCommon();
2152
2153 printf("========================================================\n");
2154 printf("== Android Framework Services\n");
2155 printf("========================================================\n");
2156
2157 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2158 SEC_TO_MSEC(10));
2159 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2160 SEC_TO_MSEC(10));
2161
2162 printf("========================================================\n");
2163 printf("== dumpstate: done (id %d)\n", ds.id_);
2164 printf("========================================================\n");
2165}
2166
Nandana Duttcf419a72019-03-14 10:40:17 +00002167Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002168 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002169 const size_t buf_size = temp_file_pattern.length() + 1;
2170 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2171 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2172
2173 // Create a new, empty file to receive all trace dumps.
2174 //
2175 // TODO: This can be simplified once we remove support for the old style
2176 // dumps. We can have a file descriptor passed in to dump_traces instead
2177 // of creating a file, closing it and then reopening it again.
2178 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2179 if (fd < 0) {
2180 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002181 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002182 }
2183
2184 // Nobody should have access to this temporary file except dumpstate, but we
2185 // temporarily grant 'read' to 'others' here because this file is created
2186 // when tombstoned is still running as root, but dumped after dropping. This
2187 // can go away once support for old style dumping has.
2188 const int chmod_ret = fchmod(fd, 0666);
2189 if (chmod_ret < 0) {
2190 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002191 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002192 }
2193
2194 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2195 if (proc.get() == nullptr) {
2196 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002197 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002198 }
2199
2200 // Number of times process dumping has timed out. If we encounter too many
2201 // failures, we'll give up.
2202 int timeout_failures = 0;
2203 bool dalvik_found = false;
2204
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002205 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002206
2207 struct dirent* d;
2208 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002209 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002210 int pid = atoi(d->d_name);
2211 if (pid <= 0) {
2212 continue;
2213 }
2214
Kevin Jeond0f8a982023-04-07 14:27:11 -04002215 // Skip cached processes.
2216 if (IsCached(pid)) {
2217 // For consistency, the header and footer to this message match those
2218 // dumped by debuggerd in the success case.
2219 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2220 dprintf(fd, "Dump skipped for cached process.\n");
2221 dprintf(fd, "---- end %d ----", pid);
2222 continue;
2223 }
2224
Nandana Duttfaafd522019-03-11 09:23:09 +00002225 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2226 std::string exe;
2227 if (!android::base::Readlink(link_name, &exe)) {
2228 continue;
2229 }
2230
2231 bool is_java_process;
2232 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2233 // Don't bother dumping backtraces for the zygote.
2234 if (IsZygote(pid)) {
2235 continue;
2236 }
2237
2238 dalvik_found = true;
2239 is_java_process = true;
2240 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2241 is_java_process = false;
2242 } else {
2243 // Probably a native process we don't care about, continue.
2244 continue;
2245 }
2246
2247 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2248 if (timeout_failures == 3) {
2249 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2250 break;
2251 }
2252
2253 const uint64_t start = Nanotime();
2254 const int ret = dump_backtrace_to_file_timeout(
Kevin Jeonb8a39362023-04-04 15:00:34 -04002255 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
Nandana Duttfaafd522019-03-11 09:23:09 +00002256
2257 if (ret == -1) {
2258 // For consistency, the header and footer to this message match those
2259 // dumped by debuggerd in the success case.
2260 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2261 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2262 dprintf(fd, "---- end %d ----", pid);
2263 timeout_failures++;
2264 continue;
2265 }
2266
2267 // We've successfully dumped stack traces, reset the failure count
2268 // and write a summary of the elapsed time to the file and continue with the
2269 // next process.
2270 timeout_failures = 0;
2271
2272 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2273 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2274 }
2275
2276 if (!dalvik_found) {
2277 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2278 }
2279
Nandana Duttcf419a72019-03-14 10:40:17 +00002280 *path = file_name_buf.release();
2281 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002282}
2283
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002284static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2285 const Dumpstate::BugreportMode bugreport_mode) {
2286 switch (bugreport_mode) {
2287 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2288 return dumpstate_hal_hidl::DumpstateMode::FULL;
2289 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2290 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2291 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2292 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2293 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2294 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2295 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2296 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2297 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2298 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2299 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2300 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2301 }
2302 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2303}
2304
2305static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2306 const Dumpstate::BugreportMode bugreport_mode) {
2307 switch (bugreport_mode) {
2308 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2309 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2310 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2311 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2312 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2313 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2314 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2315 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2316 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2317 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2318 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2319 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2320 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2321 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2322 }
2323 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2324}
2325
2326static void DoDumpstateBoardHidl(
2327 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2328 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2329 const Dumpstate::BugreportMode bugreport_mode,
2330 const size_t timeout_sec) {
2331
2332 using ScopedNativeHandle =
2333 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2334 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2335 [](native_handle_t* handle) {
2336 // we don't close file handle's here
2337 // via native_handle_close(handle)
2338 // instead we let dumpstate_fds close the file handles when
2339 // dumpstate_fds gets destroyed
2340 native_handle_delete(handle);
2341 });
2342 if (handle == nullptr) {
2343 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2344 return;
2345 }
2346
2347 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2348 handle.get()->data[i] = dumpstate_fds[i].get();
2349 }
2350
2351 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2352 // implement just 1.0.
2353 const char* descriptor_to_kill;
2354 using DumpstateBoardTask = std::packaged_task<bool()>;
2355 DumpstateBoardTask dumpstate_board_task;
2356 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2357 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2358 if (dumpstate_hal != nullptr) {
2359 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2360
2361 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2362 GetDumpstateHalModeHidl(bugreport_mode);
2363
2364 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2365 dumpstate_board_task =
2366 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2367 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2368 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2369 SEC_TO_MSEC(timeout_sec));
2370 if (!status.isOk()) {
2371 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2372 return false;
2373 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2374 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2375 dumpstate_hal_hidl::toString(status).c_str());
2376 return false;
2377 }
2378 return true;
2379 });
2380 } else {
2381 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2382
2383 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2384 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2385 ::android::hardware::Return<void> status =
2386 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2387 if (!status.isOk()) {
2388 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2389 return false;
2390 }
2391 return true;
2392 });
2393 }
2394 auto result = dumpstate_board_task.get_future();
2395 std::thread(std::move(dumpstate_board_task)).detach();
2396
2397 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2398 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2399 if (!android::base::SetProperty(
2400 "ctl.interface_restart",
2401 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2402 MYLOGE("Couldn't restart dumpstate HAL\n");
2403 }
2404 }
2405 // Wait some time for init to kill dumpstate vendor HAL
2406 constexpr size_t killing_timeout_sec = 10;
2407 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2408 MYLOGE(
2409 "killing dumpstateBoard timed out after %zus, continue and "
2410 "there might be racing in content\n",
2411 killing_timeout_sec);
2412 }
2413}
2414
2415static void DoDumpstateBoardAidl(
2416 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2417 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2418 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2419 MYLOGI("Using IDumpstateDevice AIDL HAL");
2420
2421 const char* descriptor_to_kill;
2422 using DumpstateBoardTask = std::packaged_task<bool()>;
2423 DumpstateBoardTask dumpstate_board_task;
2424 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2425 GetDumpstateHalModeAidl(bugreport_mode);
2426
2427 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2428 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2429 timeout_sec]() -> bool {
2430 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2431
2432 if (!status.isOk()) {
2433 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2434 return false;
2435 }
2436 return true;
2437 });
2438 auto result = dumpstate_board_task.get_future();
2439 std::thread(std::move(dumpstate_board_task)).detach();
2440
2441 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2442 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2443 if (!android::base::SetProperty(
2444 "ctl.interface_restart",
2445 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2446 MYLOGE("Couldn't restart dumpstate HAL\n");
2447 }
2448 }
2449 // Wait some time for init to kill dumpstate vendor HAL
2450 constexpr size_t killing_timeout_sec = 10;
2451 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2452 MYLOGE(
2453 "killing dumpstateBoard timed out after %zus, continue and "
2454 "there might be racing in content\n",
2455 killing_timeout_sec);
2456 }
2457}
2458
2459static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2460 const std::string aidl_instance_name =
2461 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2462
2463 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2464 return nullptr;
2465 }
2466
2467 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2468
2469 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2470}
2471
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002472void Dumpstate::DumpstateBoard(int out_fd) {
2473 dprintf(out_fd, "========================================================\n");
2474 dprintf(out_fd, "== Board\n");
2475 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002476
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002477 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002478 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002479 * set to true and unmount it after invoking dumpstateBoard_* methods.
2480 * This is to enable debug builds to not have debugfs mounted during runtime.
2481 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002482 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002483 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002484 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002485 if (mount_debugfs) {
2486 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2487 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002488 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002489 }
2490
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002491 std::vector<std::string> paths;
2492 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002493 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002494 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2495 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002496 remover.emplace_back(android::base::make_scope_guard(
2497 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002498 }
Jie Song9fbfad02017-06-20 16:29:42 -07002499
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002500 // get dumpstate HAL AIDL implementation
2501 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2502 GetDumpstateBoardAidlService());
2503 if (dumpstate_hal_handle_aidl == nullptr) {
2504 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2505 }
2506
2507 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2508 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2509 if (dumpstate_hal_handle_aidl == nullptr) {
2510 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2511 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2512 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2513 }
2514 }
2515
2516 // if neither HIDL nor AIDL implementation found, then return
2517 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2518 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002519 return;
2520 }
2521
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002522 // this is used to hold the file descriptors and when this variable goes out of scope
2523 // the file descriptors are closed
2524 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002525
Nandana Dutt5c390032019-03-12 10:52:56 +00002526 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002527 for (size_t i = 0; i < paths.size(); i++) {
2528 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2529
2530 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2531 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2532 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2533 if (fd < 0) {
2534 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2535 return;
2536 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002537
2538 dumpstate_fds.emplace_back(fd.release());
2539 // we call fd.release() here to make sure "fd" does not get closed
2540 // after "fd" goes out of scope after this block.
2541 // "fd" will be closed when "dumpstate_fds" goes out of scope
2542 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002543 }
2544
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002545 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2546 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2547 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002548 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002549
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002550 if (dumpstate_hal_handle_aidl != nullptr) {
2551 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2552 timeout_sec);
2553 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2554 // run HIDL HAL only if AIDL HAL not found
2555 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2556 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002557 }
2558
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002559 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002560 auto keep_debugfs_mounted =
2561 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2562 if (keep_debugfs_mounted.empty())
2563 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002564 }
2565
Wei Wang587eac92018-04-05 12:17:20 -07002566 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2567 for (size_t i = 0; i < paths.size(); i++) {
2568 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002569 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2570 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002571 file_sizes[i] = -1;
2572 continue;
2573 }
2574 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002575 }
2576
2577 for (size_t i = 0; i < paths.size(); i++) {
2578 if (file_sizes[i] == -1) {
2579 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002580 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002581 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002582 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002583 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002584 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002585 remover[i].Disable();
2586 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2587 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002588 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002589}
2590
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002591static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002592 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002593 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2594 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002595 " -h: display this help message\n"
2596 " -b: play sound file instead of vibrate, at beginning of job\n"
2597 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002598 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002599 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002600 " -s: write zipped file to control socket (for init)\n"
2601 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002602 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002603 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002604 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002605 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002606 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002607 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002608}
2609
Wei Liuf87959e2016-08-26 14:51:42 -07002610static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002611 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002612}
2613
Felipe Leme1d486fe2016-10-14 18:06:47 -07002614bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002615 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2616 if (zip_entry_tasks_) {
2617 zip_entry_tasks_->run(/* do_cancel = */false);
2618 }
2619
Felipe Leme9a523ae2016-10-20 15:10:33 -07002620 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002621 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002622 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002623 // Final timestamp
2624 char date[80];
2625 time_t the_real_now_please_stand_up = time(nullptr);
2626 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002627 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002628 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002629
Felipe Leme9a523ae2016-10-20 15:10:33 -07002630 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002631 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002632 return false;
2633 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002634 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002635 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002636 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002637 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002638
Felipe Leme0f3fb202016-06-10 17:10:53 -07002639 // Add log file (which contains stderr output) to zip...
2640 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002641 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002642 MYLOGE("Failed to add dumpstate log to .zip file\n");
2643 return false;
2644 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002645 // TODO: Should truncate the existing file.
2646 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002647 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2648 return false;
2649 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002650 fprintf(stderr, "\n");
2651
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002652 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002653 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002654 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002655 return false;
2656 }
2657
Felipe Leme1d486fe2016-10-14 18:06:47 -07002658 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2659 ds.zip_file.reset(nullptr);
2660
Felipe Lemee9d2c542016-11-15 11:48:26 -08002661 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002662 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002663
Felipe Leme1e9edc62015-12-21 16:02:13 -08002664 return true;
2665}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002666
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002667static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2668 // clang-format off
2669 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2670 "--receiver-foreground", "--receiver-include-background", "-a", action};
2671 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002672
2673 am.insert(am.end(), args.begin(), args.end());
2674
Felipe Leme8d2410e2017-02-08 09:46:08 -08002675 RunCommand("", am,
2676 CommandOptions::WithTimeout(20)
2677 .Log("Sending broadcast: '%s'\n")
2678 .Always()
2679 .DropRoot()
2680 .RedirectStderr()
2681 .Build());
2682}
2683
Felipe Leme35b8cf12017-02-10 15:47:29 -08002684static void Vibrate(int duration_ms) {
2685 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002686 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2687 "oneshot", std::to_string(duration_ms)};
2688 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002689 CommandOptions::WithTimeout(10)
2690 .Log("Vibrate: '%s'\n")
2691 .Always()
2692 .Build());
2693 // clang-format on
2694}
2695
Nandana Dutt979388e2018-11-30 16:48:55 +00002696static void MaybeResolveSymlink(std::string* path) {
2697 std::string resolved_path;
2698 if (android::base::Readlink(*path, &resolved_path)) {
2699 *path = resolved_path;
2700 }
2701}
2702
Nandana Dutt4be45d12018-09-26 15:04:23 +01002703/*
2704 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002705 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002706 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002707static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002708 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2709
Nandana Dutt4be45d12018-09-26 15:04:23 +01002710 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2711 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002712 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002713 char date[80];
2714 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2715 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002716
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002717 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002718 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002719 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002720 ds.base_name_ += "-wifi";
2721 }
2722
Paul Chang0d2aad72020-02-13 20:04:03 +08002723 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002724 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002725 }
2726 ds.tmp_path_ = ds.GetPath(".tmp");
2727 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2728
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002729 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002730 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002731 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002732 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002733 "Bugreport dir: [%s] "
2734 "Base name: [%s] "
2735 "Suffix: [%s] "
2736 "Log path: [%s] "
2737 "Temporary path: [%s] "
2738 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002739 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2740 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002741
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002742 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2743 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2744 create_parent_dirs(ds.path_.c_str());
2745 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2746 if (ds.zip_file == nullptr) {
2747 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2748 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002749 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002750 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2751 ds.AddTextZipEntry("version.txt", ds.version_);
2752 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002753}
2754
2755/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002756 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002757 * printing zipped file status, etc.
2758 */
2759static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002760 bool do_text_file = !ds.FinishZipFile();
2761 if (do_text_file) {
2762 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002763 }
mhasank2d75c442020-06-11 15:05:25 -07002764
2765 std::string final_path = ds.path_;
2766 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002767 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002768 android::os::CopyFileToFile(ds.path_, final_path);
2769 }
2770
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002771 if (ds.options_->stream_to_socket) {
2772 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2773 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002774 if (do_text_file) {
2775 dprintf(ds.control_socket_fd_,
2776 "FAIL:could not create zip file, check %s "
2777 "for more details\n",
2778 ds.log_path_.c_str());
2779 } else {
mhasank2d75c442020-06-11 15:05:25 -07002780 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002781 }
2782 }
2783}
2784
Nandana Dutt4be45d12018-09-26 15:04:23 +01002785
Nandana Dutt58d72e22018-11-16 10:30:48 +00002786static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2787 switch (mode) {
2788 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2789 return "BUGREPORT_FULL";
2790 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2791 return "BUGREPORT_INTERACTIVE";
2792 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2793 return "BUGREPORT_REMOTE";
2794 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2795 return "BUGREPORT_WEAR";
2796 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2797 return "BUGREPORT_TELEPHONY";
2798 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2799 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002800 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2801 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002802 }
2803}
2804
Paul Changf59c2b72020-03-10 02:08:55 +08002805static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2806 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002807 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2808 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002809 options->bugreport_mode = mode;
2810 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002811 switch (mode) {
2812 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002813 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002814 break;
2815 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002816 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002817 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002818 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002819 break;
2820 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002821 options->do_vibrate = false;
2822 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002823 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002824 break;
2825 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002826 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002827 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002828 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002829 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002830 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002831 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002832 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002833 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002834 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002835 break;
2836 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002837 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002838 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002839 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002840 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2841 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002842 }
2843}
2844
Nandana Dutt58d72e22018-11-16 10:30:48 +00002845static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002846 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002847 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002848 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002849 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002850 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002851 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002852 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002853 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002854 options.do_progress_updates, options.bugreport_fd.get(),
2855 options.bugreport_mode_string.c_str(),
2856 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002857}
2858
Nandana Dutt54dbd672019-01-11 12:58:05 +00002859void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2860 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002861 const android::base::unique_fd& screenshot_fd_in,
2862 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002863 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002864 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2865 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002866
Paul Changf59c2b72020-03-10 02:08:55 +08002867 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002868}
2869
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002870Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2871 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002872 int c;
mhasankd451a472020-05-26 18:02:39 -07002873 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002874 switch (c) {
2875 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002876 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002877 case 's': stream_to_socket = true; break;
2878 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002879 case 'v': show_header_only = true; break;
2880 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002881 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002882 case 'P': do_progress_updates = true; break;
2883 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002884 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002885 case 'V':
2886 case 'd':
2887 case 'z':
2888 // compatibility no-op
2889 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002890 case 'w':
2891 // This was already processed
2892 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002893 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002894 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002895 break;
2896 default:
2897 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002898 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002899 break;
2900 // clang-format on
2901 }
2902 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002903
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002904 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002905 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002906 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002907 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002908 }
2909 }
2910
2911 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2912 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002913
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002914 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002915}
2916
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002917bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002918 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002919 return false;
2920 }
2921
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002922 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002923 return false;
2924 }
2925
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002926 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002927 return false;
2928 }
2929 return true;
2930}
2931
Nandana Dutt197661d2018-11-16 16:40:21 +00002932void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2933 options_ = std::move(options);
2934}
2935
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002936void Dumpstate::Initialize() {
2937 /* gets the sequential id */
2938 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2939 id_ = ++last_id;
2940 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2941}
2942
Nandana Duttd2f5f082019-01-18 17:13:52 +00002943Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2944 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002945 if (listener_ != nullptr) {
2946 switch (status) {
2947 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002948 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002949 break;
2950 case Dumpstate::RunStatus::HELP:
2951 break;
2952 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002953 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002954 break;
2955 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002956 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2957 break;
2958 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2959 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2960 break;
2961 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2962 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002963 break;
2964 }
2965 }
2966 return status;
2967}
2968
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002969void Dumpstate::Cancel() {
2970 CleanupTmpFiles();
2971 android::os::UnlinkAndLogOnError(log_path_);
2972 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2973 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2974 kDumpstateBoardFiles[i]);
2975 }
2976 tombstone_data_.clear();
2977 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002978 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002979
2980 // Instead of shutdown the pool, we delete temporary files directly since
2981 // shutdown blocking the call.
2982 if (dump_pool_) {
2983 dump_pool_->deleteTempFiles();
2984 }
2985 if (zip_entry_tasks_) {
2986 zip_entry_tasks_->run(/*do_cancel =*/ true);
2987 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002988}
2989
Nandana Dutt979388e2018-11-30 16:48:55 +00002990/*
2991 * Dumps relevant information to a bugreport based on the given options.
2992 *
2993 * The bugreport can be dumped to a file or streamed to a socket.
2994 *
2995 * How dumping to file works:
2996 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2997 * stderr is redirected a log file.
2998 *
2999 * The temporary bugreport is then populated via printfs, dumping contents of files and
3000 * output of commands to stdout.
3001 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003002 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003003 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003004 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003005 *
mhasank2d75c442020-06-11 15:05:25 -07003006 * Bugreports are first generated in a local directory and later copied to the caller's fd
3007 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003008 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003009Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3010 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003011 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003012 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003013 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003014 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003015 return RunStatus::INVALID_INPUT;
3016 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003017 /* set as high priority, and protect from OOM killer */
3018 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003019
Felipe Lemed071c682016-10-20 16:48:00 -07003020 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003021 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003022 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003023 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003024 } else {
3025 /* fallback to kernels <= 2.6.35 */
3026 oom_adj = fopen("/proc/self/oom_adj", "we");
3027 if (oom_adj) {
3028 fputs("-17", oom_adj);
3029 fclose(oom_adj);
3030 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003031 }
3032
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003033 if (version_ == VERSION_DEFAULT) {
3034 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003035 }
3036
Chris Morin5a50d482022-02-01 17:41:18 -08003037 if (version_ != VERSION_CURRENT) {
3038 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3039 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003040 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003041 }
3042
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003043 if (options_->show_header_only) {
3044 PrintHeader();
3045 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003046 }
3047
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003048 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3049 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003050
Felipe Leme7447d7c2016-11-03 18:12:22 -07003051 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003052 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003053 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003054 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003055
Sahana Raof35ed432019-07-12 10:47:52 +01003056 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3057 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3058 } else {
3059 // Wake lock will be released automatically on process death
3060 MYLOGD("Wake lock acquired.\n");
3061 }
3062
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003063 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003064
Felipe Lemef0292972016-11-22 13:57:05 -08003065 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003066 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3067 }
3068
Kevin Jeonfa64e642023-07-27 11:36:41 -04003069 if (PropertiesHelper::IsStrictRun()) {
3070 MYLOGI(
3071 "Running on strict-run mode, which has shorter timeouts "
3072 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3073 }
3074
Nandana Dutt235c6672019-11-14 15:22:32 +00003075 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003076 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003077
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003078 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003079
Christopher Ferrised9354f2014-10-01 17:35:01 -07003080 // If we are going to use a socket, do it as early as possible
3081 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003082 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003083 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003084 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003085 if (control_socket_fd_ == -1) {
3086 return ERROR;
3087 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003088 if (options_->progress_updates_to_socket) {
3089 options_->do_progress_updates = 1;
3090 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003091 }
3092
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003093 if (!PrepareToWriteToFile()) {
3094 return ERROR;
3095 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003096
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003097 // Interactive, wear & telephony modes are default to true.
3098 // and may enable from cli option or when using control socket
3099 if (options_->do_progress_updates) {
3100 // clang-format off
3101 std::vector<std::string> am_args = {
3102 "--receiver-permission", "android.permission.DUMP",
3103 };
3104 // clang-format on
3105 // Send STARTED broadcast for apps that listen to bugreport generation events
3106 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3107 if (options_->progress_updates_to_socket) {
3108 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003109 }
3110 }
3111
Nick Kralevichf3599b32016-01-25 15:05:16 -08003112 /* read /proc/cmdline before dropping root */
3113 FILE *cmdline = fopen("/proc/cmdline", "re");
3114 if (cmdline) {
3115 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3116 fclose(cmdline);
3117 }
3118
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003119 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003120 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003121 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003122
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003123 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003124 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3125 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003126 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003127 }
3128 }
3129
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003130 int dup_stdout_fd;
3131 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003132 // Redirect stderr to log_path_ for debugging.
3133 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3134 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3135 return ERROR;
3136 }
3137 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3138 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3139 strerror(errno));
3140 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003141
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003142 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3143 // moved into zip file later, if zipping.
3144 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3145 // TODO: why not write to a file instead of stdout to overcome this problem?
3146 /* TODO: rather than generating a text file now and zipping it later,
3147 it would be more efficient to redirect stdout to the zip entry
3148 directly, but the libziparchive doesn't support that option yet. */
3149 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3150 return ERROR;
3151 }
3152 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3153 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3154 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003155 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003156
3157 // Don't buffer stdout
3158 setvbuf(stdout, nullptr, _IONBF, 0);
3159
Rhed Jao5377d792020-07-16 17:37:39 +08003160 // Enable the parallel run if the client requests to output to a file.
3161 EnableParallelRunIfNeeded();
3162 // Using scope guard to make sure the dump pool can be shut down correctly.
3163 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3164 ShutdownDumpPool();
3165 });
3166
Felipe Leme608385d2016-02-01 10:35:38 -08003167 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3168 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003169 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003170 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003171
Gavin Corkery6968f552020-11-22 18:09:05 +00003172 bool is_dumpstate_restricted = options_->telephony_only
3173 || options_->wifi_only
3174 || options_->limited_only;
3175 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003176 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003177 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003178 }
3179 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003180
3181 if (!is_dumpstate_restricted) {
3182 // Snapshot the system trace now (if running) to avoid that dumpstate's
3183 // own activity pushes out interesting data from the trace ring buffer.
3184 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3185 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003186
3187 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3188 // from WMTRACE_DATA_DIR.
3189 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003190 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003191 onUiIntensiveBugreportDumpsFinished(calling_uid);
3192 MaybeCheckUserConsent(calling_uid, calling_package);
3193 if (options_->telephony_only) {
3194 DumpstateTelephonyOnly(calling_package);
3195 } else if (options_->wifi_only) {
3196 DumpstateWifiOnly();
3197 } else if (options_->limited_only) {
3198 DumpstateLimitedOnly();
3199 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003200 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003201 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003202 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003203 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003204 HandleUserConsentDenied();
3205 }
3206 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003207 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003208 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003209
Felipe Leme55b42a62015-11-10 17:39:08 -08003210 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003211 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003212
Abhijeet Kaure370d682019-10-01 16:49:30 +01003213 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003214 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003215 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003216 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003217
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003218 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003219 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003220 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003221 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003222 if (status != Dumpstate::RunStatus::OK &&
3223 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3224 // Do an early return if there were errors. We make an exception for consent
3225 // timing out because it's possible the user got distracted. In this case the
3226 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003227 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003228 return status;
3229 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003230 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3231 MYLOGI(
3232 "Did not receive user consent yet."
3233 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003234 const String16 incidentcompanion("incidentcompanion");
3235 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3236 if (ics != nullptr) {
3237 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3238 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3239 consent_callback_.get());
3240 } else {
3241 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3242 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003243 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003244 }
3245
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003246 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003247 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003248 for (int i = 0; i < 3; i++) {
3249 Vibrate(75);
3250 usleep((75 + 50) * 1000);
3251 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003252 }
3253
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003254 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3255 progress_->GetInitialMax());
3256 progress_->Save();
3257 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003258
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003259 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003260
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003261 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003262 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003263 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003264 }
3265
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003266 tombstone_data_.clear();
3267 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003268 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003269
Nandana Duttd2f5f082019-01-18 17:13:52 +00003270 return (consent_callback_ != nullptr &&
3271 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3272 ? USER_CONSENT_TIMED_OUT
3273 : RunStatus::OK;
3274}
3275
Paul Chang0d2aad72020-02-13 20:04:03 +08003276void Dumpstate::MaybeTakeEarlyScreenshot() {
3277 if (!options_->do_screenshot || !do_early_screenshot_) {
3278 return;
3279 }
3280
3281 TakeScreenshot();
3282}
3283
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003284void Dumpstate::MaybeSnapshotSystemTrace() {
3285 // If a background system trace is happening and is marked as "suitable for
3286 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3287 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3288 // case that no trace is ongoing, this command is a no-op.
3289 // Note: this should not be enqueued as we need to freeze the trace before
3290 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3291 // the dumpstate's own activity which is irrelevant.
3292 int res = RunCommand(
3293 "SERIALIZE PERFETTO TRACE",
3294 {"perfetto", "--save-for-bugreport"},
3295 CommandOptions::WithTimeout(10)
3296 .DropRoot()
3297 .CloseAllFileDescriptorsOnExec()
3298 .Build());
3299 has_system_trace_ = res == 0;
3300 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3301 // file in the later stages.
3302}
3303
Yohei Yukawa95305b32021-03-09 07:54:27 -08003304void Dumpstate::MaybeSnapshotWinTrace() {
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003305 // Include the proto logging from WMShell.
3306 RunCommand(
3307 // Empty name because it's not intended to be classified as a bugreport section.
3308 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3309 // in the bugreport.
3310 "", {"dumpsys", "activity", "service", "SystemUIService",
3311 "WMShell", "protolog", "save-for-bugreport"},
3312 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3313
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003314 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3315 for (const auto& service : {"window", "input_method"}) {
3316 RunCommand(
3317 // Empty name because it's not intended to be classified as a bugreport section.
3318 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3319 "", {"cmd", service, "tracing", "save-for-bugreport"},
3320 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3321 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003322}
3323
Paul Changeb4b4642020-05-28 22:05:47 +08003324void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003325 if (calling_uid == AID_SHELL || !CalledByApi()) {
3326 return;
3327 }
3328 if (listener_ != nullptr) {
3329 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3330 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003331 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003332 }
3333}
3334
Jichao Lie89d9c12019-11-21 19:02:51 -08003335void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3336 if (calling_uid == AID_SHELL || !CalledByApi()) {
3337 // No need to get consent for shell triggered dumpstates, or not through
3338 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003339 return;
3340 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003341 consent_callback_ = new ConsentCallback();
3342 const String16 incidentcompanion("incidentcompanion");
3343 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003344 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003345 if (ics != nullptr) {
3346 MYLOGD("Checking user consent via incidentcompanion service\n");
3347 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003348 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003349 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003350 } else {
3351 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3352 }
3353}
3354
Nandana Dutt5c390032019-03-12 10:52:56 +00003355bool Dumpstate::IsUserConsentDenied() const {
3356 return ds.consent_callback_ != nullptr &&
3357 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3358}
3359
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003360bool Dumpstate::CalledByApi() const {
3361 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3362}
3363
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003364void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003365 android::os::UnlinkAndLogOnError(tmp_path_);
3366 android::os::UnlinkAndLogOnError(screenshot_path_);
3367 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003368 if (dump_traces_path != nullptr) {
3369 android::os::UnlinkAndLogOnError(dump_traces_path);
3370 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003371}
3372
Rhed Jao5377d792020-07-16 17:37:39 +08003373void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003374 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003375 return;
3376 }
3377 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003378 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003379}
3380
3381void Dumpstate::ShutdownDumpPool() {
3382 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003383 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003384 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003385 if (zip_entry_tasks_) {
3386 zip_entry_tasks_->run(/* do_cancel = */true);
3387 zip_entry_tasks_ = nullptr;
3388 }
3389}
3390
3391void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3392 const std::string& entry_path) {
3393 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3394 if (!task_cancelled) {
3395 AddZipEntry(entry_name, entry_path);
3396 }
3397 android::os::UnlinkAndLogOnError(entry_path);
3398 };
3399 if (zip_entry_tasks_) {
3400 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3401 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3402 } else {
3403 // Invokes AddZipEntryAndCleanup immediately
3404 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3405 }
Rhed Jao5377d792020-07-16 17:37:39 +08003406}
3407
Nandana Duttd2f5f082019-01-18 17:13:52 +00003408Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3409 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003410 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003411 return USER_CONSENT_DENIED;
3412}
3413
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003414Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003415 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003416 // user consent (unless the caller is Shell).
3417 UserConsentResult consent_result;
3418 if (calling_uid == AID_SHELL) {
3419 consent_result = UserConsentResult::APPROVED;
3420 } else {
3421 consent_result = consent_callback_->getResult();
3422 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003423 if (consent_result == UserConsentResult::UNAVAILABLE) {
3424 // User has not responded yet.
3425 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003426 // Telephony is a fast report type, particularly on user builds where information may be
3427 // more aggressively limited. To give the user time to read the consent dialog, increase the
3428 // timeout.
3429 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3430 : USER_CONSENT_TIMEOUT_MS;
3431 if (elapsed_ms < timeout_ms) {
3432 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003433 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3434 sleep(delay_seconds);
3435 }
3436 consent_result = consent_callback_->getResult();
3437 }
3438 if (consent_result == UserConsentResult::DENIED) {
3439 // User has explicitly denied sharing with the app. To be safe delete the
3440 // internal bugreport & tmp files.
3441 return HandleUserConsentDenied();
3442 }
3443 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003444 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3445 if (copy_succeeded) {
3446 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003447 if (options_->do_screenshot &&
3448 options_->screenshot_fd.get() != -1 &&
3449 !options_->is_screenshot_copied) {
3450 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3451 options_->screenshot_fd.get());
3452 options_->is_screenshot_copied = copy_succeeded;
3453 if (copy_succeeded) {
3454 android::os::UnlinkAndLogOnError(screenshot_path_);
3455 }
3456 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003457 }
3458 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3459 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3460 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3461 // Since we do not have user consent to share the bugreport it does not get
3462 // copied over to the calling app but remains in the internal directory from
3463 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003464 std::string final_path = GetPath(".zip");
3465 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3466 if (copy_succeeded) {
3467 android::os::UnlinkAndLogOnError(path_);
3468 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003469 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3470 }
3471 // Unknown result; must be a programming error.
3472 MYLOGE("Unknown user consent result:%d\n", consent_result);
3473 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003474}
3475
Nandana Duttf02564e2019-02-15 15:24:24 +00003476Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003477 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3478 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3479 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003480 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003481 // When directly running dumpstate binary, the output is not expected to be written
3482 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003483 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003484
3485 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003486 // an app; they are irrelevant here because bugreport is triggered via command line.
3487 // Update Last ID before calling Run().
3488 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003489 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003490 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003491 return status;
3492}
3493
3494/* Main entry point for dumpstate binary. */
3495int run_main(int argc, char* argv[]) {
3496 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003497
3498 switch (status) {
3499 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003500 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003501 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003502 ShowUsage();
3503 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003504 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003505 fprintf(stderr, "Invalid combination of args\n");
3506 ShowUsage();
3507 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003508 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003509 FALLTHROUGH_INTENDED;
3510 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3511 FALLTHROUGH_INTENDED;
3512 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003513 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003514 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003515}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003516
3517// TODO(111441001): Default DumpOptions to sensible values.
3518Dumpstate::Dumpstate(const std::string& version)
3519 : pid_(getpid()),
3520 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003521 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003522 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003523 now_(time(nullptr)),
3524 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003525}
3526
3527Dumpstate& Dumpstate::GetInstance() {
3528 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3529 return singleton_;
3530}
3531
Rhed Jao5377d792020-07-16 17:37:39 +08003532DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3533 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3534 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003535 if (!title_.empty()) {
3536 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003537 if (title_.find("SHOW MAP") == std::string::npos) {
3538 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3539 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003540 }
3541}
3542
3543DurationReporter::~DurationReporter() {
3544 if (!title_.empty()) {
3545 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003546 if (elapsed >= .5f || verbose_) {
3547 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003548 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003549 if (!logcat_only_) {
3550 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003551 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3552 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003553 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003554 if (title_.find("SHOW MAP") == std::string::npos) {
3555 ATRACE_ASYNC_END(title_.c_str(), 0);
3556 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003557 }
3558}
3559
3560const int32_t Progress::kDefaultMax = 5000;
3561
3562Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3563}
3564
3565Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3566 : Progress(initial_max, growth_factor, "") {
3567 progress_ = progress;
3568}
3569
3570Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3571 : initial_max_(initial_max),
3572 progress_(0),
3573 max_(initial_max),
3574 growth_factor_(growth_factor),
3575 n_runs_(0),
3576 average_max_(0),
3577 path_(path) {
3578 if (!path_.empty()) {
3579 Load();
3580 }
3581}
3582
3583void Progress::Load() {
3584 MYLOGD("Loading stats from %s\n", path_.c_str());
3585 std::string content;
3586 if (!android::base::ReadFileToString(path_, &content)) {
3587 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3588 return;
3589 }
3590 if (content.empty()) {
3591 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3592 return;
3593 }
3594 std::vector<std::string> lines = android::base::Split(content, "\n");
3595
3596 if (lines.size() < 1) {
3597 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3598 (int)lines.size(), max_);
3599 return;
3600 }
3601 char* ptr;
3602 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3603 average_max_ = strtol(ptr, nullptr, 10);
3604 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3605 average_max_ > STATS_MAX_AVERAGE) {
3606 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3607 initial_max_ = Progress::kDefaultMax;
3608 } else {
3609 initial_max_ = average_max_;
3610 }
3611 max_ = initial_max_;
3612
3613 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3614}
3615
3616void Progress::Save() {
3617 int32_t total = n_runs_ * average_max_ + progress_;
3618 int32_t runs = n_runs_ + 1;
3619 int32_t average = floor(((float)total) / runs);
3620 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3621 path_.c_str());
3622 if (path_.empty()) {
3623 return;
3624 }
3625
3626 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3627 if (!android::base::WriteStringToFile(content, path_)) {
3628 MYLOGE("Could not save stats on %s\n", path_.c_str());
3629 }
3630}
3631
3632int32_t Progress::Get() const {
3633 return progress_;
3634}
3635
3636bool Progress::Inc(int32_t delta_sec) {
3637 bool changed = false;
3638 if (delta_sec >= 0) {
3639 progress_ += delta_sec;
3640 if (progress_ > max_) {
3641 int32_t old_max = max_;
3642 max_ = floor((float)progress_ * growth_factor_);
3643 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3644 changed = true;
3645 }
3646 }
3647 return changed;
3648}
3649
3650int32_t Progress::GetMax() const {
3651 return max_;
3652}
3653
3654int32_t Progress::GetInitialMax() const {
3655 return initial_max_;
3656}
3657
3658void Progress::Dump(int fd, const std::string& prefix) const {
3659 const char* pr = prefix.c_str();
3660 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3661 dprintf(fd, "%smax: %d\n", pr, max_);
3662 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3663 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3664 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3665 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3666 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3667}
3668
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003669std::string Dumpstate::GetPath(const std::string& suffix) const {
3670 return GetPath(bugreport_internal_dir_, suffix);
3671}
3672
3673std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3674 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3675 name_.c_str(), suffix.c_str());
3676}
3677
3678void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3679 progress_ = std::move(progress);
3680}
3681
3682void for_each_userid(void (*func)(int), const char *header) {
3683 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3684 "for_each_userid(%s)", header);
3685 DurationReporter duration_reporter(title);
3686 if (PropertiesHelper::IsDryRun()) return;
3687
3688 DIR *d;
3689 struct dirent *de;
3690
3691 if (header) printf("\n------ %s ------\n", header);
3692 func(0);
3693
3694 if (!(d = opendir("/data/system/users"))) {
3695 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3696 return;
3697 }
3698
3699 while ((de = readdir(d))) {
3700 int userid;
3701 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3702 continue;
3703 }
3704 func(userid);
3705 }
3706
3707 closedir(d);
3708}
3709
3710static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3711 DIR *d;
3712 struct dirent *de;
3713
3714 if (!(d = opendir("/proc"))) {
3715 printf("Failed to open /proc (%s)\n", strerror(errno));
3716 return;
3717 }
3718
3719 if (header) printf("\n------ %s ------\n", header);
3720 while ((de = readdir(d))) {
3721 if (ds.IsUserConsentDenied()) {
3722 MYLOGE(
3723 "Returning early because user denied consent to share bugreport with calling app.");
3724 closedir(d);
3725 return;
3726 }
3727 int pid;
3728 int fd;
3729 char cmdpath[255];
3730 char cmdline[255];
3731
3732 if (!(pid = atoi(de->d_name))) {
3733 continue;
3734 }
3735
3736 memset(cmdline, 0, sizeof(cmdline));
3737
3738 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3739 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3740 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3741 close(fd);
3742 if (cmdline[0]) {
3743 helper(pid, cmdline, arg);
3744 continue;
3745 }
3746 }
3747
3748 // if no cmdline, a kernel thread has comm
3749 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3750 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3751 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3752 close(fd);
3753 if (cmdline[1]) {
3754 cmdline[0] = '[';
3755 size_t len = strcspn(cmdline, "\f\b\r\n");
3756 cmdline[len] = ']';
3757 cmdline[len+1] = '\0';
3758 }
3759 }
3760 if (!cmdline[0]) {
3761 strcpy(cmdline, "N/A");
3762 }
3763 helper(pid, cmdline, arg);
3764 }
3765
3766 closedir(d);
3767}
3768
3769static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3770 for_each_pid_func *func = (for_each_pid_func*) arg;
3771 func(pid, cmdline);
3772}
3773
3774void for_each_pid(for_each_pid_func func, const char *header) {
3775 std::string title = header == nullptr ? "for_each_pid"
3776 : android::base::StringPrintf("for_each_pid(%s)", header);
3777 DurationReporter duration_reporter(title);
3778 if (PropertiesHelper::IsDryRun()) return;
3779
3780 __for_each_pid(for_each_pid_helper, header, (void *) func);
3781}
3782
3783static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3784 DIR *d;
3785 struct dirent *de;
3786 char taskpath[255];
3787 for_each_tid_func *func = (for_each_tid_func *) arg;
3788
3789 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3790
3791 if (!(d = opendir(taskpath))) {
3792 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3793 return;
3794 }
3795
3796 func(pid, pid, cmdline);
3797
3798 while ((de = readdir(d))) {
3799 if (ds.IsUserConsentDenied()) {
3800 MYLOGE(
3801 "Returning early because user denied consent to share bugreport with calling app.");
3802 closedir(d);
3803 return;
3804 }
3805 int tid;
3806 int fd;
3807 char commpath[255];
3808 char comm[255];
3809
3810 if (!(tid = atoi(de->d_name))) {
3811 continue;
3812 }
3813
3814 if (tid == pid)
3815 continue;
3816
3817 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3818 memset(comm, 0, sizeof(comm));
3819 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3820 strcpy(comm, "N/A");
3821 } else {
3822 char *c;
3823 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3824 close(fd);
3825
3826 c = strrchr(comm, '\n');
3827 if (c) {
3828 *c = '\0';
3829 }
3830 }
3831 func(pid, tid, comm);
3832 }
3833
3834 closedir(d);
3835}
3836
3837void for_each_tid(for_each_tid_func func, const char *header) {
3838 std::string title = header == nullptr ? "for_each_tid"
3839 : android::base::StringPrintf("for_each_tid(%s)", header);
3840 DurationReporter duration_reporter(title);
3841
3842 if (PropertiesHelper::IsDryRun()) return;
3843
3844 __for_each_pid(for_each_tid_helper, header, (void *) func);
3845}
3846
3847void show_wchan(int pid, int tid, const char *name) {
3848 if (PropertiesHelper::IsDryRun()) return;
3849
3850 char path[255];
3851 char buffer[255];
3852 int fd, ret, save_errno;
3853 char name_buffer[255];
3854
3855 memset(buffer, 0, sizeof(buffer));
3856
3857 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3858 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3859 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3860 return;
3861 }
3862
3863 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3864 save_errno = errno;
3865 close(fd);
3866
3867 if (ret < 0) {
3868 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3869 return;
3870 }
3871
3872 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3873 pid == tid ? 0 : 3, "", name);
3874
3875 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3876
3877 return;
3878}
3879
3880// print time in centiseconds
3881static void snprcent(char *buffer, size_t len, size_t spc,
3882 unsigned long long time) {
3883 static long hz; // cache discovered hz
3884
3885 if (hz <= 0) {
3886 hz = sysconf(_SC_CLK_TCK);
3887 if (hz <= 0) {
3888 hz = 1000;
3889 }
3890 }
3891
3892 // convert to centiseconds
3893 time = (time * 100 + (hz / 2)) / hz;
3894
3895 char str[16];
3896
3897 snprintf(str, sizeof(str), " %llu.%02u",
3898 time / 100, (unsigned)(time % 100));
3899 size_t offset = strlen(buffer);
3900 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3901 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3902}
3903
3904// print permille as a percent
3905static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3906 char str[16];
3907
3908 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3909 size_t offset = strlen(buffer);
3910 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3911 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3912}
3913
3914void show_showtime(int pid, const char *name) {
3915 if (PropertiesHelper::IsDryRun()) return;
3916
3917 char path[255];
3918 char buffer[1023];
3919 int fd, ret, save_errno;
3920
3921 memset(buffer, 0, sizeof(buffer));
3922
3923 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3924 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3925 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3926 return;
3927 }
3928
3929 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3930 save_errno = errno;
3931 close(fd);
3932
3933 if (ret < 0) {
3934 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3935 return;
3936 }
3937
3938 // field 14 is utime
3939 // field 15 is stime
3940 // field 42 is iotime
3941 unsigned long long utime = 0, stime = 0, iotime = 0;
3942 if (sscanf(buffer,
3943 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3944 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3945 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3946 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3947 &utime, &stime, &iotime) != 3) {
3948 return;
3949 }
3950
3951 unsigned long long total = utime + stime;
3952 if (!total) {
3953 return;
3954 }
3955
3956 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3957 if (permille > 1000) {
3958 permille = 1000;
3959 }
3960
3961 // try to beautify and stabilize columns at <80 characters
3962 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3963 if ((name[0] != '[') || utime) {
3964 snprcent(buffer, sizeof(buffer), 57, utime);
3965 }
3966 snprcent(buffer, sizeof(buffer), 65, stime);
3967 if ((name[0] != '[') || iotime) {
3968 snprcent(buffer, sizeof(buffer), 73, iotime);
3969 }
3970 if (iotime) {
3971 snprdec(buffer, sizeof(buffer), 79, permille);
3972 }
3973 puts(buffer); // adds a trailing newline
3974
3975 return;
3976}
3977
3978void do_dmesg() {
3979 const char *title = "KERNEL LOG (dmesg)";
3980 DurationReporter duration_reporter(title);
3981 printf("------ %s ------\n", title);
3982
3983 if (PropertiesHelper::IsDryRun()) return;
3984
3985 /* Get size of kernel buffer */
3986 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3987 if (size <= 0) {
3988 printf("Unexpected klogctl return value: %d\n\n", size);
3989 return;
3990 }
3991 char *buf = (char *) malloc(size + 1);
3992 if (buf == nullptr) {
3993 printf("memory allocation failed\n\n");
3994 return;
3995 }
3996 int retval = klogctl(KLOG_READ_ALL, buf, size);
3997 if (retval < 0) {
3998 printf("klogctl failure\n\n");
3999 free(buf);
4000 return;
4001 }
4002 buf[retval] = '\0';
4003 printf("%s\n\n", buf);
4004 free(buf);
4005 return;
4006}
4007
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004008int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4009 DurationReporter duration_reporter(title);
4010
4011 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4012
4013 UpdateProgress(WEIGHT_FILE);
4014
4015 return status;
4016}
4017
4018int read_file_as_long(const char *path, long int *output) {
4019 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4020 if (fd < 0) {
4021 int err = errno;
4022 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4023 return -1;
4024 }
4025 char buffer[50];
4026 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4027 if (bytes_read == -1) {
4028 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4029 return -2;
4030 }
4031 if (bytes_read == 0) {
4032 MYLOGE("File %s is empty\n", path);
4033 return -3;
4034 }
4035 *output = atoi(buffer);
4036 return 0;
4037}
4038
4039/* calls skip to gate calling dump_from_fd recursively
4040 * in the specified directory. dump_from_fd defaults to
4041 * dump_file_from_fd above when set to NULL. skip defaults
4042 * to false when set to NULL. dump_from_fd will always be
4043 * called with title NULL.
4044 */
4045int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4046 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4047 DurationReporter duration_reporter(title);
4048 DIR *dirp;
4049 struct dirent *d;
4050 char *newpath = nullptr;
4051 const char *slash = "/";
4052 int retval = 0;
4053
4054 if (!title.empty()) {
4055 printf("------ %s (%s) ------\n", title.c_str(), dir);
4056 }
4057 if (PropertiesHelper::IsDryRun()) return 0;
4058
4059 if (dir[strlen(dir) - 1] == '/') {
4060 ++slash;
4061 }
4062 dirp = opendir(dir);
4063 if (dirp == nullptr) {
4064 retval = -errno;
4065 MYLOGE("%s: %s\n", dir, strerror(errno));
4066 return retval;
4067 }
4068
4069 if (!dump_from_fd) {
4070 dump_from_fd = dump_file_from_fd;
4071 }
4072 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4073 if ((d->d_name[0] == '.')
4074 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4075 || (d->d_name[1] == '\0'))) {
4076 continue;
4077 }
4078 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4079 (d->d_type == DT_DIR) ? "/" : "");
4080 if (!newpath) {
4081 retval = -errno;
4082 continue;
4083 }
4084 if (skip && (*skip)(newpath)) {
4085 continue;
4086 }
4087 if (d->d_type == DT_DIR) {
4088 int ret = dump_files("", newpath, skip, dump_from_fd);
4089 if (ret < 0) {
4090 retval = ret;
4091 }
4092 continue;
4093 }
4094 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4095 if (fd.get() < 0) {
4096 retval = -1;
4097 printf("*** %s: %s\n", newpath, strerror(errno));
4098 continue;
4099 }
4100 (*dump_from_fd)(nullptr, newpath, fd.get());
4101 }
4102 closedir(dirp);
4103 if (!title.empty()) {
4104 printf("\n");
4105 }
4106 return retval;
4107}
4108
4109/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4110 * it's possible to avoid issues where opening the file itself can get
4111 * stuck.
4112 */
4113int dump_file_from_fd(const char *title, const char *path, int fd) {
4114 if (PropertiesHelper::IsDryRun()) return 0;
4115
4116 int flags = fcntl(fd, F_GETFL);
4117 if (flags == -1) {
4118 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4119 return -1;
4120 } else if (!(flags & O_NONBLOCK)) {
4121 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4122 return -1;
4123 }
4124 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4125}
4126
4127int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004128 const CommandOptions& options, bool verbose_duration, int out_fd) {
4129 DurationReporter duration_reporter(title, false /* logcat_only */,
4130 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004131
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004132 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004133
4134 /* TODO: for now we're simplifying the progress calculation by using the
4135 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4136 * where its weight should be much higher proportionally to its timeout.
4137 * Ideally, it should use a options.EstimatedDuration() instead...*/
4138 UpdateProgress(options.Timeout());
4139
4140 return status;
4141}
4142
4143void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004144 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004145 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4146 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4147 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004148 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004149}
4150
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004151static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004152 int s = android_get_control_socket(service);
4153 if (s < 0) {
4154 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4155 return -1;
4156 }
4157 fcntl(s, F_SETFD, FD_CLOEXEC);
4158
4159 // Set backlog to 0 to make sure that queue size will be minimum.
4160 // In Linux, because the minimum queue will be 1, connect() will be blocked
4161 // if the other clients already called connect() and the connection request was not accepted.
4162 if (listen(s, 0) < 0) {
4163 MYLOGE("listen(control socket): %s\n", strerror(errno));
4164 return -1;
4165 }
4166
4167 struct sockaddr addr;
4168 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004169 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004170
4171 // Close socket just after accept(), to make sure that connect() by client will get error
4172 // when the socket is used by the other services.
4173 // There is still a race condition possibility between accept and close, but there is no way
4174 // to close-on-accept atomically.
4175 // See detail; b/123306389#comment25
4176 close(s);
4177
4178 if (fd < 0) {
4179 MYLOGE("accept(control socket): %s\n", strerror(errno));
4180 return -1;
4181 }
4182
4183 return fd;
4184}
4185
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004186// TODO: should call is_valid_output_file and/or be merged into it.
4187void create_parent_dirs(const char *path) {
4188 char *chp = const_cast<char *> (path);
4189
4190 /* skip initial slash */
4191 if (chp[0] == '/')
4192 chp++;
4193
4194 /* create leading directories, if necessary */
4195 struct stat dir_stat;
4196 while (chp && chp[0]) {
4197 chp = strchr(chp, '/');
4198 if (chp) {
4199 *chp = 0;
4200 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4201 MYLOGI("Creating directory %s\n", path);
4202 if (mkdir(path, 0770)) { /* drwxrwx--- */
4203 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4204 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4205 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4206 }
4207 }
4208 *chp++ = '/';
4209 }
4210 }
4211}
4212
4213bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4214 create_parent_dirs(path);
4215
4216 int fd = TEMP_FAILURE_RETRY(open(path,
4217 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4218 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4219 if (fd < 0) {
4220 MYLOGE("%s: %s\n", path, strerror(errno));
4221 return false;
4222 }
4223
4224 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4225 close(fd);
4226 return true;
4227}
4228
4229bool redirect_to_file(FILE* redirect, char* path) {
4230 return _redirect_to_file(redirect, path, O_TRUNC);
4231}
4232
4233bool redirect_to_existing_file(FILE* redirect, char* path) {
4234 return _redirect_to_file(redirect, path, O_APPEND);
4235}
4236
4237void dump_route_tables() {
4238 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4239 if (PropertiesHelper::IsDryRun()) return;
4240 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4241 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4242 FILE* fp = fopen(RT_TABLES_PATH, "re");
4243 if (!fp) {
4244 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4245 return;
4246 }
4247 char table[16];
4248 // Each line has an integer (the table number), a space, and a string (the table name). We only
4249 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4250 // Add a fixed max limit so this doesn't go awry.
4251 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4252 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4253 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4254 }
4255 fclose(fp);
4256}
4257
Li Li830179f2022-01-04 12:53:29 -08004258void dump_frozen_cgroupfs(const char *dir, int level,
4259 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4260 DIR *dirp;
4261 struct dirent *d;
4262 char *newpath = nullptr;
4263
4264 dirp = opendir(dir);
4265 if (dirp == nullptr) {
4266 MYLOGE("%s: %s\n", dir, strerror(errno));
4267 return;
4268 }
4269
4270 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4271 if ((d->d_name[0] == '.')
4272 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4273 || (d->d_name[1] == '\0'))) {
4274 continue;
4275 }
4276 if (d->d_type == DT_DIR) {
4277 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4278 if (!newpath) {
4279 continue;
4280 }
4281 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4282 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4283 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4284 char *freezer = nullptr;
4285 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4286 if (freezer) {
4287 FILE* fp = fopen(freezer, "r");
4288 if (fp != NULL) {
4289 int frozen;
4290 fscanf(fp, "%d", &frozen);
4291 if (frozen > 0) {
4292 dump_files("", newpath, skip_none, dump_from_fd);
4293 }
4294 fclose(fp);
4295 }
4296 free(freezer);
4297 }
4298 }
4299 }
4300 }
4301 closedir(dirp);
4302}
4303
4304void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004305 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4306 DurationReporter duration_reporter("FROZEN CGROUPFS");
4307 if (PropertiesHelper::IsDryRun()) return;
4308 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4309}
4310
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004311void Dumpstate::UpdateProgress(int32_t delta_sec) {
4312 if (progress_ == nullptr) {
4313 MYLOGE("UpdateProgress: progress_ not set\n");
4314 return;
4315 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004316 // This function updates progress related members of the dumpstate and reports
4317 // progress percentage to the bugreport client. Since it could be called by
4318 // different dump tasks at the same time if the parallel run is enabled, a
4319 // mutex lock is necessary here to synchronize the call.
4320 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004321
4322 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004323 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004324
4325 // ...but only notifiy listeners when necessary.
4326 if (!options_->do_progress_updates) return;
4327
4328 int progress = progress_->Get();
4329 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004330 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004331
Nandana Dutt402a8392019-06-14 14:25:13 +01004332 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004333 return;
4334 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004335 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004336
4337 if (control_socket_fd_ >= 0) {
4338 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4339 fsync(control_socket_fd_);
4340 }
4341
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004342 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004343 if (percent % 10 == 0) {
4344 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004345 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004346 } else {
4347 // stderr is ignored on normal invocations, but useful when calling
4348 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004349 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004350 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004351
4352 listener_->onProgress(percent);
4353 }
4354}
4355
4356void Dumpstate::TakeScreenshot(const std::string& path) {
4357 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4358 int status =
4359 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4360 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4361 if (status == 0) {
4362 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4363 } else {
4364 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4365 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004366 if (listener_ != nullptr) {
4367 // Show a visual indication to indicate screenshot is taken via
4368 // IDumpstateListener.onScreenshotTaken()
4369 listener_->onScreenshotTaken(status == 0);
4370 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004371}
4372
4373bool is_dir(const char* pathname) {
4374 struct stat info;
4375 if (stat(pathname, &info) == -1) {
4376 return false;
4377 }
4378 return S_ISDIR(info.st_mode);
4379}
4380
4381time_t get_mtime(int fd, time_t default_mtime) {
4382 struct stat info;
4383 if (fstat(fd, &info) == -1) {
4384 return default_mtime;
4385 }
4386 return info.st_mtime;
4387}