blob: 69a1df27b2e4ad8f03629f60457080e3bc3ea39d [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080077#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070078#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010079#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000080#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000081#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000083#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010084#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080085#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010086#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070087#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070088#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070089#include <private/android_filesystem_config.h>
90#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080091#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070092#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000093#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080094#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070095#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070096#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080097
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000098namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
99namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
100namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
101
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using ::std::literals::chrono_literals::operator""ms;
103using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800104using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800105
Felipe Leme47e9be22016-12-21 15:37:07 -0800106// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800107using android::defaultServiceManager;
108using android::Dumpsys;
109using android::INVALID_OPERATION;
110using android::IServiceManager;
111using android::OK;
112using android::sp;
113using android::status_t;
114using android::String16;
115using android::String8;
116using android::TIMED_OUT;
117using android::UNKNOWN_ERROR;
118using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000119using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000120using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121using android::os::dumpstate::CommandOptions;
122using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800123using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800124using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800125using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800126using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800127
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100128// Keep in sync with
129// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
130static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
131
132/* Most simple commands have 10 as timeout, so 5 is a good estimate */
133static const int32_t WEIGHT_FILE = 5;
134
135// TODO: temporary variables and functions used during C++ refactoring
136static Dumpstate& ds = Dumpstate::GetInstance();
137static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100138 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800139 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
140 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100141}
142
143// Reasonable value for max stats.
144static const int STATS_MAX_N_RUNS = 1000;
145static const long STATS_MAX_AVERAGE = 100000;
146
147CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
148
Nandana Duttd2f5f082019-01-18 17:13:52 +0000149typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
150
Colin Crossf45fa6b2012-03-26 12:38:26 -0700151/* read before root is shed */
152static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700153static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000154static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800155// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
156// it's often the case that they time out far too quickly for consent with such a hefty dialog for
157// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
158// roughly match full reports' durations.
159static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700160
Felipe Leme1d486fe2016-10-14 18:06:47 -0700161// TODO: variables and functions below should be part of dumpstate object
162
Felipe Leme635ca312016-01-05 14:23:02 -0800163static std::set<std::string> mount_points;
164void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800165
Todd Poynor2a83daa2013-11-22 15:44:22 -0800166#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700167#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700168#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169
Felipe Lemee82a27d2016-01-05 13:35:44 -0800170#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700171#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700172#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700173#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700174#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800175#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100176#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
177#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800178#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900179#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800180#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700181#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800182#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900183#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700184#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000185#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700186#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200187#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700188
Narayan Kamath8f788292017-05-25 13:20:39 +0100189// TODO(narayan): Since this information has to be kept in sync
190// with tombstoned, we should just put it in a common header.
191//
192// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100193static const std::string TOMBSTONE_DIR = "/data/tombstones/";
194static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
195static const std::string ANR_DIR = "/data/anr/";
196static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800197static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
198static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700199
Felipe Lemee844a9d2016-09-21 15:01:39 -0700200// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000201
Nandana Dutt5c390032019-03-12 10:52:56 +0000202#define RETURN_IF_USER_DENIED_CONSENT() \
203 if (ds.IsUserConsentDenied()) { \
204 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
205 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
206 }
207
208// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
209// if consent is found to be denied.
210#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
211 RETURN_IF_USER_DENIED_CONSENT(); \
212 func_ptr(__VA_ARGS__); \
213 RETURN_IF_USER_DENIED_CONSENT();
214
Rhed Jao5377d792020-07-16 17:37:39 +0800215// Runs func_ptr, and logs a duration report after it's finished.
216#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
217 { \
218 DurationReporter duration_reporter_in_macro(log_title); \
219 func_ptr(__VA_ARGS__); \
220 }
221
222// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
223// is output after a slow function is finished.
224#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
225 RETURN_IF_USER_DENIED_CONSENT(); \
226 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
227 RETURN_IF_USER_DENIED_CONSENT();
228
Chris Morinbc223142022-02-04 14:17:11 -0800229#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800230 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800231 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800232 RETURN_IF_USER_DENIED_CONSENT();
233
Sahana Raof35ed432019-07-12 10:47:52 +0100234static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
235
Rhed Jao5377d792020-07-16 17:37:39 +0800236// Names of parallel tasks, they are used for the DumpPool to identify the dump
237// task and the log title of the duration report.
238static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800239static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huang24d215d2022-04-27 18:51:16 +0800240static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800241static const std::string DUMP_HALS_TASK = "DUMP HALS";
242static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800243static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariotti306633e2022-09-05 16:30:47 +0000244static const std::string POST_PROCESS_UI_TRACES_TASK = "POST-PROCESS UI TRACES";
Rhed Jao5377d792020-07-16 17:37:39 +0800245
Nandana Dutt979388e2018-11-30 16:48:55 +0000246namespace android {
247namespace os {
248namespace {
249
250static int Open(std::string path, int flags, mode_t mode = 0) {
251 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
252 if (fd == -1) {
253 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
254 }
255 return fd;
256}
257
mhasank2d75c442020-06-11 15:05:25 -0700258static int OpenForWrite(std::string path) {
259 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
260 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
261}
Nandana Dutt979388e2018-11-30 16:48:55 +0000262
263static int OpenForRead(std::string path) {
264 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
265}
266
267bool CopyFile(int in_fd, int out_fd) {
268 char buf[4096];
269 ssize_t byte_count;
270 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
271 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
272 return false;
273 }
274 }
275 return (byte_count != -1);
276}
277
278static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000279 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000280
281 // Obtain a handle to the source file.
282 android::base::unique_fd in_fd(OpenForRead(input_file));
283 if (out_fd != -1 && in_fd.get() != -1) {
284 if (CopyFile(in_fd.get(), out_fd)) {
285 return true;
286 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000287 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000288 }
289 return false;
290}
291
Nandana Duttd2f5f082019-01-18 17:13:52 +0000292static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000293 if (file.empty()) {
294 return false;
295 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000296 if (unlink(file.c_str())) {
297 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000298 return false;
299 }
300 return true;
301}
Nandana Dutt979388e2018-11-30 16:48:55 +0000302
Nikita Ioffea325a572019-05-16 19:49:47 +0100303int64_t GetModuleMetadataVersion() {
304 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
305 if (binder == nullptr) {
306 MYLOGE("Failed to retrieve package_native service");
307 return 0L;
308 }
309 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
310 std::string package_name;
311 auto status = package_service->getModuleMetadataPackageName(&package_name);
312 if (!status.isOk()) {
313 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
314 return 0L;
315 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100316 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100317 int64_t version_code;
318 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
319 &version_code);
320 if (!status.isOk()) {
321 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
322 return 0L;
323 }
324 return version_code;
325}
326
mhasank2d75c442020-06-11 15:05:25 -0700327static bool PathExists(const std::string& path) {
328 struct stat sb;
329 return stat(path.c_str(), &sb) == 0;
330}
331
332static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
333 if (input_file == output_file) {
334 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
335 output_file.c_str());
336 return false;
337 }
338 else if (PathExists(output_file)) {
339 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
340 return false;
341 }
342
343 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
344 android::base::unique_fd out_fd(OpenForWrite(output_file));
345 return CopyFileToFd(input_file, out_fd.get());
346}
347
Nandana Dutt979388e2018-11-30 16:48:55 +0000348} // namespace
349} // namespace os
350} // namespace android
351
Felipe Leme678727a2016-09-21 17:22:11 -0700352static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800353 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800354 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
355 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
356}
357static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
358 int out_fd) {
359 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700360}
361static int DumpFile(const std::string& title, const std::string& path) {
362 return ds.DumpFile(title, path);
363}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800364
Felipe Lemee844a9d2016-09-21 15:01:39 -0700365// Relative directory (inside the zip) for all files copied as-is into the bugreport.
366static const std::string ZIP_ROOT_DIR = "FS";
367
Vishnu Naire97d6122018-01-18 13:58:56 -0800368static const std::string kProtoPath = "proto/";
369static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700370static const std::string kDumpstateBoardFiles[] = {
371 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700372 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700373};
374static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
375
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700376static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700377static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700378
Felipe Lemef0292972016-11-22 13:57:05 -0800379static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
380
Narayan Kamath8f788292017-05-25 13:20:39 +0100381/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100382 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800383 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800384 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100385 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800387 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100388 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100389
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700390 if (dump_dir == nullptr) {
391 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700392 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700393 }
394
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700395 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 struct dirent* entry = nullptr;
397 while ((entry = readdir(dump_dir.get()))) {
398 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100399 continue;
400 }
401
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 const std::string base_name(entry->d_name);
403 if (base_name.find(file_prefix) != 0) {
404 continue;
405 }
406
407 const std::string abs_path = dir_path + base_name;
408 android::base::unique_fd fd(
409 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
410 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700411 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 break;
413 }
414
415 struct stat st = {};
416 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700417 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100418 continue;
419 }
420
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700421 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700422 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800423 if (!dump_data.empty()) {
424 std::sort(dump_data.begin(), dump_data.end(),
425 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
426 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100429}
430
Narayan Kamathbd863722017-06-01 18:50:12 +0100431static bool AddDumps(const std::vector<DumpData>::const_iterator start,
432 const std::vector<DumpData>::const_iterator end,
433 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100435 for (auto it = start; it != end; ++it) {
436 const std::string& name = it->name;
437 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100438 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100439
440 // Seek to the beginning of the file before dumping any data. A given
441 // DumpData entry might be dumped multiple times in the report.
442 //
443 // For example, the most recent ANR entry is dumped to the body of the
444 // main entry and it also shows up as a separate entry in the bugreport
445 // ZIP file.
446 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
447 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
448 strerror(errno));
449 }
450
Chris Morinc2cba7a2022-02-01 17:06:50 -0800451 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800452 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100453 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455 } else {
456 dump_file_from_fd(type_name, name.c_str(), fd);
457 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100458 }
459
460 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700461}
462
Felipe Leme635ca312016-01-05 14:23:02 -0800463// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700464void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char path[PATH_MAX];
466
467 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
468 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700469 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800470 char linkname[PATH_MAX];
471 ssize_t r = readlink(path, linkname, PATH_MAX);
472 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800473 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800474 return;
475 }
476 linkname[r] = '\0';
477
478 if (mount_points.find(linkname) == mount_points.end()) {
479 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700480 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700481 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800482 mount_points.insert(linkname);
483 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800484 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800485 }
486 }
487}
488
489void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700490 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800491 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800492 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700493 for_each_pid(do_mountinfo, nullptr);
494 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800495}
496
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700497static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
498{
499 DIR *d;
500 struct dirent *de;
501 char path[PATH_MAX];
502
503 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700504 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700505 return;
506 }
507
508 while ((de = readdir(d))) {
509 if (de->d_type != DT_LNK) {
510 continue;
511 }
512 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700513 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700514 }
515
516 closedir(d);
517}
518
Mark Salyzyn326842f2015-04-30 09:49:41 -0700519static bool skip_not_stat(const char *path) {
520 static const char stat[] = "/stat";
521 size_t len = strlen(path);
522 if (path[len - 1] == '/') { /* Directory? */
523 return false;
524 }
525 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
526}
527
Felipe Leme4c2d6632016-09-28 14:32:00 -0700528static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800529 return false;
530}
531
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700532unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700533
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800534//
535// stat offsets
536// Name units description
537// ---- ----- -----------
538// read I/Os requests number of read I/Os processed
539#define __STAT_READ_IOS 0
540// read merges requests number of read I/Os merged with in-queue I/O
541#define __STAT_READ_MERGES 1
542// read sectors sectors number of sectors read
543#define __STAT_READ_SECTORS 2
544// read ticks milliseconds total wait time for read requests
545#define __STAT_READ_TICKS 3
546// write I/Os requests number of write I/Os processed
547#define __STAT_WRITE_IOS 4
548// write merges requests number of write I/Os merged with in-queue I/O
549#define __STAT_WRITE_MERGES 5
550// write sectors sectors number of sectors written
551#define __STAT_WRITE_SECTORS 6
552// write ticks milliseconds total wait time for write requests
553#define __STAT_WRITE_TICKS 7
554// in_flight requests number of I/Os currently in flight
555#define __STAT_IN_FLIGHT 8
556// io_ticks milliseconds total time this block device has been active
557#define __STAT_IO_TICKS 9
558// time_in_queue milliseconds total wait time for all requests
559#define __STAT_IN_QUEUE 10
560#define __STAT_NUMBER_FIELD 11
561//
562// read I/Os, write I/Os
563// =====================
564//
565// These values increment when an I/O request completes.
566//
567// read merges, write merges
568// =========================
569//
570// These values increment when an I/O request is merged with an
571// already-queued I/O request.
572//
573// read sectors, write sectors
574// ===========================
575//
576// These values count the number of sectors read from or written to this
577// block device. The "sectors" in question are the standard UNIX 512-byte
578// sectors, not any device- or filesystem-specific block size. The
579// counters are incremented when the I/O completes.
580#define SECTOR_SIZE 512
581//
582// read ticks, write ticks
583// =======================
584//
585// These values count the number of milliseconds that I/O requests have
586// waited on this block device. If there are multiple I/O requests waiting,
587// these values will increase at a rate greater than 1000/second; for
588// example, if 60 read requests wait for an average of 30 ms, the read_ticks
589// field will increase by 60*30 = 1800.
590//
591// in_flight
592// =========
593//
594// This value counts the number of I/O requests that have been issued to
595// the device driver but have not yet completed. It does not include I/O
596// requests that are in the queue but not yet issued to the device driver.
597//
598// io_ticks
599// ========
600//
601// This value counts the number of milliseconds during which the device has
602// had I/O requests queued.
603//
604// time_in_queue
605// =============
606//
607// This value counts the number of milliseconds that I/O requests have waited
608// on this block device. If there are multiple I/O requests waiting, this
609// value will increase as the product of the number of milliseconds times the
610// number of requests waiting (see "read ticks" above for an example).
611#define S_TO_MS 1000
612//
613
Mark Salyzyn326842f2015-04-30 09:49:41 -0700614static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800615 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700616 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700617 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700618 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700619 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700620 getline(&buffer, &i, fp);
621 fclose(fp);
622 if (!buffer) {
623 return -errno;
624 }
625 i = strlen(buffer);
626 while ((i > 0) && (buffer[i - 1] == '\n')) {
627 buffer[--i] = '\0';
628 }
629 if (!*buffer) {
630 free(buffer);
631 return 0;
632 }
633 z = true;
634 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800635 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700636 if (fields[i] != 0) {
637 z = false;
638 }
639 }
640 if (z) { /* never accessed */
641 free(buffer);
642 return 0;
643 }
644
Wei Wang509bb5d2017-06-09 14:42:12 -0700645 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
646 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700647 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700648
649 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
650 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
651 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700652 free(buffer);
653
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800654 if (fields[__STAT_IO_TICKS]) {
655 unsigned long read_perf = 0;
656 unsigned long read_ios = 0;
657 if (fields[__STAT_READ_TICKS]) {
658 unsigned long long divisor = fields[__STAT_READ_TICKS]
659 * fields[__STAT_IO_TICKS];
660 read_perf = ((unsigned long long)SECTOR_SIZE
661 * fields[__STAT_READ_SECTORS]
662 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
663 / divisor;
664 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
665 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
666 / divisor;
667 }
668
669 unsigned long write_perf = 0;
670 unsigned long write_ios = 0;
671 if (fields[__STAT_WRITE_TICKS]) {
672 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
673 * fields[__STAT_IO_TICKS];
674 write_perf = ((unsigned long long)SECTOR_SIZE
675 * fields[__STAT_WRITE_SECTORS]
676 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
677 / divisor;
678 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
679 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
680 / divisor;
681 }
682
683 unsigned queue = (fields[__STAT_IN_QUEUE]
684 + (fields[__STAT_IO_TICKS] >> 1))
685 / fields[__STAT_IO_TICKS];
686
687 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700688 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 -0800689 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700690 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 -0800691 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800692 }
693
694 /* bugreport timeout factor adjustment */
695 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
696 worst_write_perf = write_perf;
697 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700698 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700699 return 0;
700}
701
Yao Chenbe3bbc12018-01-17 16:31:10 -0800702static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
703
Tom Cherryf4472f32020-08-05 09:31:17 -0700704// Returns the actual readable size of the given buffer or -1 on error.
705static long logcat_buffer_readable_size(const std::string& buffer) {
706 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
707 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
708 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
709
710 return android_logger_get_log_readable_size(logger);
711}
712
713// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800714static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
715 unsigned long timeout_ms = 0;
716 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700717 long readable_size = logcat_buffer_readable_size(buffer);
718 if (readable_size > 0) {
719 // Engineering margin is ten-fold our guess.
720 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
721 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800722 }
723 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700724}
725
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800726// Opens a socket and returns its file descriptor.
727static int open_socket(const char* service);
728
Nandana Duttd2f5f082019-01-18 17:13:52 +0000729Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
730}
731
732android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
733 std::lock_guard<std::mutex> lock(lock_);
734 result_ = APPROVED;
735 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800736
737 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
738 // consent is granted.
739 if (ds.options_->is_screenshot_copied) {
740 return android::binder::Status::ok();
741 }
742
743 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
744 !ds.do_early_screenshot_) {
745 return android::binder::Status::ok();
746 }
747
748 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
749 ds.options_->screenshot_fd.get());
750 ds.options_->is_screenshot_copied = copy_succeeded;
751 if (copy_succeeded) {
752 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
753 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000754 return android::binder::Status::ok();
755}
756
757android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
758 std::lock_guard<std::mutex> lock(lock_);
759 result_ = DENIED;
760 MYLOGW("User denied consent to share bugreport\n");
761 return android::binder::Status::ok();
762}
763
764UserConsentResult Dumpstate::ConsentCallback::getResult() {
765 std::lock_guard<std::mutex> lock(lock_);
766 return result_;
767}
768
769uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800770 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000771}
772
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700773void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200774 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700775 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700776
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700777 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
778 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700779 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
780 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
781 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200782 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700783 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700784
Felipe Lemed8b94e52016-12-08 10:21:44 -0800785 printf("========================================================\n");
786 printf("== dumpstate: %s\n", date);
787 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700788
Felipe Lemed8b94e52016-12-08 10:21:44 -0800789 printf("\n");
790 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700791 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800792 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
793 printf("Bootloader: %s\n", bootloader.c_str());
794 printf("Radio: %s\n", radio.c_str());
795 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100796 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
797 if (module_metadata_version != 0) {
798 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
799 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200800 printf("Android SDK version: %s\n", sdkversion.c_str());
801 printf("SDK extensions: ");
802 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
803 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700804
Felipe Lemed8b94e52016-12-08 10:21:44 -0800805 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800806 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800807 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800808 printf("Uptime: ");
809 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
810 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800811 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800812 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
813 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000814 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800815 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800816}
817
Felipe Leme24b66ee2016-06-16 10:55:26 -0700818// List of file extensions that can cause a zip file attachment to be rejected by some email
819// service providers.
820static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
821 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
822 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
823 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
824};
825
Vishnu Naire97d6122018-01-18 13:58:56 -0800826status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
827 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700828 std::string valid_name = entry_name;
829
830 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700831 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700832 if (idx != std::string::npos) {
833 std::string extension = entry_name.substr(idx);
834 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
835 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
836 valid_name = entry_name + ".renamed";
837 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
838 }
839 }
840
Felipe Leme6fe9db62016-02-12 09:04:16 -0800841 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
842 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000843 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
844 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700845 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700846 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700847 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700848 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800849 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800850 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000851 bool finished_entry = false;
852 auto finish_entry = [this, &finished_entry] {
853 if (!finished_entry) {
854 // This should only be called when we're going to return an earlier error,
855 // which would've been logged. This may imply the file is already corrupt
856 // and any further logging from FinishEntry is more likely to mislead than
857 // not.
858 this->zip_writer_->FinishEntry();
859 }
860 };
861 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800862 auto start = std::chrono::steady_clock::now();
863 auto end = start + timeout;
864 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800865
Felipe Leme770410d2016-01-26 17:07:14 -0800866 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800867 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800868 if (timeout.count() > 0) {
869 // lambda to recalculate the timeout.
870 auto time_left_ms = [end]() {
871 auto now = std::chrono::steady_clock::now();
872 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
873 return std::max(diff.count(), 0LL);
874 };
875
876 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
877 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000878 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
879 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800880 return -errno;
881 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000882 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800883 entry_name.c_str(), strerror(errno), timeout.count());
884 return TIMED_OUT;
885 }
886 }
887
Zach Riggle22200402016-08-18 01:01:24 -0400888 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800889 if (bytes_read == 0) {
890 break;
891 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800892 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800893 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800894 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700895 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800896 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700897 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800898 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800899 }
900 }
901
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700902 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000903 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700904 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700905 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800906 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800907 }
908
Vishnu Naire97d6122018-01-18 13:58:56 -0800909 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910}
911
Felipe Leme1d486fe2016-10-14 18:06:47 -0700912bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
913 android::base::unique_fd fd(
914 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700915 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800916 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800917 return false;
918 }
919
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921}
922
923/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700924static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800925 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800926}
927
Felipe Leme1d486fe2016-10-14 18:06:47 -0700928void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700929 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800930 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700931 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800932}
933
Felipe Leme1d486fe2016-10-14 18:06:47 -0700934bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800935 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000936 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
937 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700938 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700939 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700940 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800941 return false;
942 }
943
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700944 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700945 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700946 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800948 return false;
949 }
950
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700951 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700952 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800954 return false;
955 }
956
957 return true;
958}
959
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800960static void DoKmsg() {
961 struct stat st;
962 if (!stat(PSTORE_LAST_KMSG, &st)) {
963 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
964 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
965 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
966 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
967 } else {
968 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
969 DumpFile("LAST KMSG", "/proc/last_kmsg");
970 }
971}
972
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800973static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800974 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800975 RunCommand(
976 "KERNEL LOG",
977 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
978 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
979}
980
Nandana Duttdb379fa2019-10-09 16:54:41 +0100981static void DoSystemLogcat(time_t since) {
982 char since_str[80];
983 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
984
985 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
986 RunCommand("SYSTEM LOG",
987 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
988 since_str},
989 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
990}
991
Hunter Knepshield820f9bc2020-02-05 20:10:53 -0800992static void DoRadioLogcat() {
993 unsigned long timeout_ms = logcat_timeout({"radio"});
994 RunCommand(
995 "RADIO LOG",
996 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
997 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
998}
999
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001000static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001001 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001002 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1003 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001004 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001005 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001006 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1007 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001008 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001009 RunCommand(
1010 "EVENT LOG",
1011 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001012 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001013 timeout_ms = logcat_timeout({"stats"});
1014 RunCommand(
1015 "STATS LOG",
1016 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001017 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001018 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001019
1020 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1021
1022 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001023 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1024 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001025}
1026
Mike Ma5c267872019-08-21 11:31:34 -07001027static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001028 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1029 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1030 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1031 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1032 if (fd < 0) {
1033 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1034 return;
1035 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001036 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001037 bool empty = 0 == lseek(fd, 0, SEEK_END);
1038 if (!empty) {
1039 // Use a different name from "incident.proto"
1040 // /proto/incident.proto is reserved for incident service dump
1041 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001042 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1043 path);
1044 } else {
1045 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001046 }
Mike Ma5c267872019-08-21 11:31:34 -07001047}
1048
Aaron Huang24d215d2022-04-27 18:51:16 +08001049static void DumpNetstatsProto() {
1050 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1051 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1052 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1053 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1054 if (fd < 0) {
1055 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1056 return;
1057 }
1058 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001059 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001060 bool empty = 0 == lseek(fd, 0, SEEK_END);
1061 if (!empty) {
1062 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1063 path);
1064 } else {
1065 unlink(path.c_str());
1066 }
1067}
1068
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001069static void MaybeAddSystemTraceToZip() {
1070 // This function copies into the .zip the system trace that was snapshotted
1071 // by the early call to MaybeSnapshotSystemTrace(), if any background
1072 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001073 if (!ds.has_system_trace_) {
1074 // No background trace was happening at the time dumpstate was invoked.
1075 return;
1076 }
1077 ds.AddZipEntry(
1078 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1079 SYSTEM_TRACE_SNAPSHOT);
1080 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1081}
1082
Sunny Goyal35949782019-11-19 15:54:36 -08001083static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001084 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1085 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1086 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1087 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1088 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1089 if (fd < 0) {
1090 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1091 return;
1092 }
1093 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001094 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001095 bool empty = 0 == lseek(fd, 0, SEEK_END);
1096 if (!empty) {
1097 ds.AddZipEntry("visible_windows.zip", path);
1098 } else {
1099 MYLOGW("Failed to dump visible windows\n");
1100 }
1101 unlink(path.c_str());
1102}
1103
Jayachandran Ca94c7172017-06-10 15:08:12 -07001104static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001105 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1106 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001107 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001108 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001109 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1110 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1111 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1112 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001113}
1114
Woody Lin20767a92022-11-29 15:50:24 +08001115static void DumpShutdownCheckpoints() {
1116 const bool shutdown_checkpoints_dumped = AddDumps(
1117 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1118 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1119 if (!shutdown_checkpoints_dumped) {
1120 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1121 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1122 }
1123}
1124
David Andersond9ba4752018-12-11 18:26:59 -08001125static void DumpDynamicPartitionInfo() {
1126 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1127 return;
1128 }
1129
1130 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001131 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001132}
1133
Chris Morin5a50d482022-02-01 17:41:18 -08001134static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001135 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1136 anr_traces_dir.c_str());
1137
1138 // If we're here, dump_traces_path will always be a temporary file
1139 // (created with mkostemp or similar) that contains dumps taken earlier
1140 // on in the process.
1141 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001142 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1143 dump_traces_path);
1144 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001145
1146 const int ret = unlink(dump_traces_path);
1147 if (ret == -1) {
1148 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1149 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001150 }
1151 }
1152
Narayan Kamathbd863722017-06-01 18:50:12 +01001153 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001154 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001155 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001156 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001157 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001158
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001159 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001160 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001161 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001162 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001163 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1164 }
1165}
1166
1167static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001168 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001169
Chris Morin5a50d482022-02-01 17:41:18 -08001170 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001171
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001172 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1173
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001174 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001175 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001176 int i = 0;
1177 while (true) {
1178 const std::string slow_trace_path =
1179 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1180 if (stat(slow_trace_path.c_str(), &st)) {
1181 // No traces file at this index, done with the files.
1182 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001183 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001184 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1185 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001186 }
1187}
1188
Wei Wang509bb5d2017-06-09 14:42:12 -07001189static void DumpBlockStatFiles() {
1190 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001191
Wei Wang1dc1ef52017-06-12 11:28:37 -07001192 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1193
1194 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001195 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1196 return;
1197 }
1198
1199 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001200 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001201 if ((d->d_name[0] == '.')
1202 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1203 || (d->d_name[1] == '\0'))) {
1204 continue;
1205 }
1206 const std::string new_path =
1207 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1208 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1209 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1210 printf("\n");
1211 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001212 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001213}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001214
1215static void DumpPacketStats() {
1216 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001217}
1218
1219static void DumpIpAddrAndRules() {
1220 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1221 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1222 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1223 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1224 RunCommand("IP RULES", {"ip", "rule", "show"});
1225 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1226}
1227
Nandana Dutt5c390032019-03-12 10:52:56 +00001228static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1229 std::chrono::milliseconds timeout,
1230 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001231 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001232 sp<android::IServiceManager> sm = defaultServiceManager();
1233 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001234 Vector<String16> args;
1235 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001236 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1237 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001238 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001239 std::string path(title);
1240 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001241 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001242 if (PropertiesHelper::IsDryRun()) {
1243 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1244 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1245 } else {
1246 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1247 if (status == OK) {
1248 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1249 std::chrono::duration<double> elapsed_seconds;
1250 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1251 service == String16("meminfo")) {
1252 // Use a longer timeout for meminfo, since 30s is not always enough.
1253 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1254 /* as_proto = */ false, elapsed_seconds,
1255 bytes_written);
1256 } else {
1257 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1258 /* as_proto = */ false, elapsed_seconds,
1259 bytes_written);
1260 }
1261 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1262 bool dump_complete = (status == OK);
1263 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001264 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001265 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001266
1267 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1268 std::chrono::steady_clock::now() - start);
1269 if (elapsed_duration > timeout) {
1270 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1271 elapsed_duration.count());
1272 break;
1273 }
1274 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001275 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001276}
1277
Vishnu Nair64afc022018-02-01 15:29:34 -08001278static void RunDumpsysText(const std::string& title, int priority,
1279 std::chrono::milliseconds timeout,
1280 std::chrono::milliseconds service_timeout) {
1281 DurationReporter duration_reporter(title);
1282 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1283 fsync(STDOUT_FILENO);
1284 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1285}
1286
1287/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001288static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1289 std::chrono::milliseconds timeout,
1290 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001291 DurationReporter duration_reporter(title);
1292 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1293 fsync(STDOUT_FILENO);
1294 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1295 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001296
1297 RETURN_IF_USER_DENIED_CONSENT();
1298
1299 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1300 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001301}
1302
Nandana Dutt5c390032019-03-12 10:52:56 +00001303static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1304 std::chrono::milliseconds timeout,
1305 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001306 sp<android::IServiceManager> sm = defaultServiceManager();
1307 Dumpsys dumpsys(sm.get());
1308 Vector<String16> args;
1309 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1310 DurationReporter duration_reporter(title);
1311
1312 auto start = std::chrono::steady_clock::now();
1313 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1314 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001315 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001316 std::string path(kProtoPath);
1317 path.append(String8(service).c_str());
1318 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1319 path.append("_CRITICAL");
1320 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1321 path.append("_HIGH");
1322 }
1323 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001324 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001325 if (status == OK) {
1326 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1327 bool dumpTerminated = (status == OK);
1328 dumpsys.stopDumpThread(dumpTerminated);
1329 }
1330 ZipWriter::FileEntry file_entry;
1331 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001332
1333 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1334 std::chrono::steady_clock::now() - start);
1335 if (elapsed_duration > timeout) {
1336 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1337 elapsed_duration.count());
1338 break;
1339 }
1340 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001341 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001342}
1343
Nandana Dutta7db6342018-11-21 14:53:34 +00001344// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001345static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001346 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1347 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001348
1349 RETURN_IF_USER_DENIED_CONSENT();
1350
1351 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1352 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001353}
1354
1355// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001356static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001357 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1358 // high priority. Reduce timeout once they are able to dump in a shorter time or
1359 // moved to a parallel task.
1360 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1361 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001362
1363 RETURN_IF_USER_DENIED_CONSENT();
1364
1365 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1366 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001367}
1368
1369// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001370static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001371 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001372
1373 RETURN_IF_USER_DENIED_CONSENT();
1374
1375 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1376 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001377}
1378
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001379/*
1380 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1381 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1382 * if it's not running in the parallel task.
1383 */
1384static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001385 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001386 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1387 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001388
Steven Moreland44cd9482018-01-04 16:24:13 -08001389 using android::hidl::manager::V1_0::IServiceManager;
1390 using android::hardware::defaultServiceManager;
1391
1392 sp<IServiceManager> sm = defaultServiceManager();
1393 if (sm == nullptr) {
1394 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1395 return;
1396 }
1397
1398 auto ret = sm->list([&](const auto& interfaces) {
1399 for (const std::string& interface : interfaces) {
1400 std::string cleanName = interface;
1401 std::replace_if(cleanName.begin(),
1402 cleanName.end(),
1403 [](char c) {
1404 return !isalnum(c) &&
1405 std::string("@-_:.").find(c) == std::string::npos;
1406 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001407 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001408
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001409 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001410 {
1411 auto fd = android::base::unique_fd(
1412 TEMP_FAILURE_RETRY(open(path.c_str(),
1413 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1414 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1415 if (fd < 0) {
1416 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1417 continue;
1418 }
1419 RunCommandToFd(fd,
1420 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001421 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001422 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1423
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001424 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001425 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001426 if (!empty) {
1427 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1428 path);
1429 } else {
1430 unlink(path.c_str());
1431 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001432 }
1433 });
1434
1435 if (!ret.isOk()) {
1436 MYLOGE("Could not list hals from hwservicemanager.\n");
1437 }
1438}
1439
Devin Moore8df81bb2022-06-08 22:47:02 +00001440// Dump all of the files that make up the vendor interface.
1441// See the files listed in dumpFileList() for the latest list of files.
1442static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001443
1444 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1445 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001446 for (const auto vintfFile : vintfFiles) {
1447 struct stat st;
1448 if (stat(vintfFile.c_str(), &st) == 0) {
1449 if (S_ISDIR(st.st_mode)) {
1450 ds.AddDir(vintfFile, true /* recursive */);
1451 } else {
1452 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1453 vintfFile);
1454 }
1455 }
1456 }
1457}
1458
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001459static void DumpExternalFragmentationInfo() {
1460 struct stat st;
1461 if (stat("/proc/buddyinfo", &st) != 0) {
1462 MYLOGE("Unable to dump external fragmentation info\n");
1463 return;
1464 }
1465
1466 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1467 std::ifstream ifs("/proc/buddyinfo");
1468 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1469 for (std::string line; std::getline(ifs, line);) {
1470 std::smatch match_results;
1471 if (std::regex_match(line, match_results, unusable_index_regex)) {
1472 std::stringstream free_pages(std::string{match_results[3]});
1473 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1474 std::istream_iterator<int>());
1475
1476 int total_free_pages = 0;
1477 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1478 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1479 }
1480
1481 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1482 match_results[2].str().c_str());
1483
1484 int usable_free_pages = total_free_pages;
1485 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1486 auto unusable_index = (total_free_pages - usable_free_pages) /
1487 static_cast<double>(total_free_pages);
1488 printf(" %5.3f", unusable_index);
1489 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1490 }
1491
1492 printf("\n");
1493 }
1494 }
1495 printf("\n");
1496}
1497
mhasankd451a472020-05-26 18:02:39 -07001498static void DumpstateLimitedOnly() {
1499 // Trimmed-down version of dumpstate to only include a whitelisted
1500 // set of logs (system log, event log, and system server / system app
1501 // crashes, and networking logs). See b/136273873 and b/138459828
1502 // for context.
1503 DurationReporter duration_reporter("DUMPSTATE");
1504 unsigned long timeout_ms;
1505 // calculate timeout
1506 timeout_ms = logcat_timeout({"main", "system", "crash"});
1507 RunCommand("SYSTEM LOG",
1508 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1509 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1510 timeout_ms = logcat_timeout({"events"});
1511 RunCommand(
1512 "EVENT LOG",
1513 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1514 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1515
1516 printf("========================================================\n");
1517 printf("== Networking Service\n");
1518 printf("========================================================\n");
1519
1520 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1521 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001522 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1523 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001524
1525 printf("========================================================\n");
1526 printf("== Dropbox crashes\n");
1527 printf("========================================================\n");
1528
1529 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1530 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1531
1532 printf("========================================================\n");
1533 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1534 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1535 printf("========================================================\n");
1536 printf("== dumpstate: done (id %d)\n", ds.id_);
1537 printf("========================================================\n");
1538}
1539
Rhed Jaoe017f982020-07-21 17:58:41 +08001540/*
1541 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1542 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1543 * if it's not running in the parallel task.
1544 */
1545static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1546 dprintf(out_fd, "========================================================\n");
1547 dprintf(out_fd, "== Checkins\n");
1548 dprintf(out_fd, "========================================================\n");
1549
1550 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001551 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1552 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1553 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1554 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1555}
1556
1557/*
1558 * Runs dumpsys on activity service to dump all application activities, services
1559 * and providers in the device.
1560 *
1561 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1562 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1563 * if it's not running in the parallel task.
1564 */
1565static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1566 dprintf(out_fd, "========================================================\n");
1567 dprintf(out_fd, "== Running Application Activities\n");
1568 dprintf(out_fd, "========================================================\n");
1569
1570 // The following dumpsys internally collects output from running apps, so it can take a long
1571 // time. So let's extend the timeout.
1572
1573 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1574
1575 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1576
1577 dprintf(out_fd, "========================================================\n");
1578 dprintf(out_fd, "== Running Application Services (platform)\n");
1579 dprintf(out_fd, "========================================================\n");
1580
1581 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1582 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1583
1584 dprintf(out_fd, "========================================================\n");
1585 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1586 dprintf(out_fd, "========================================================\n");
1587
1588 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1589 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1590
1591 dprintf(out_fd, "========================================================\n");
1592 dprintf(out_fd, "== Running Application Providers (platform)\n");
1593 dprintf(out_fd, "========================================================\n");
1594
1595 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001596 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001597
1598 dprintf(out_fd, "========================================================\n");
1599 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1600 dprintf(out_fd, "========================================================\n");
1601
1602 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1603 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1604}
1605
Nandana Dutt5c390032019-03-12 10:52:56 +00001606// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1607// via the consent they are shown. Ignores other errors that occur while running various
1608// commands. The consent checking is currently done around long running tasks, which happen to
1609// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001610Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001611 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001612
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001613 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001614 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariotti306633e2022-09-05 16:30:47 +00001615 dump_netstats_report, post_process_ui_traces;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001616 if (ds.dump_pool_) {
1617 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001618 // drop root user. Restarts it.
1619 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001620
Chris Morinbc223142022-02-04 14:17:11 -08001621 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1622 dump_incident_report = ds.dump_pool_->enqueueTask(
1623 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001624 dump_netstats_report = ds.dump_pool_->enqueueTask(
1625 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001626 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1627 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1628 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Kean Mariotti306633e2022-09-05 16:30:47 +00001629 post_process_ui_traces = ds.dump_pool_->enqueueTask(
1630 POST_PROCESS_UI_TRACES_TASK, &Dumpstate::MaybePostProcessUiTraces, &ds);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001631 }
1632
Nandana Dutt5c390032019-03-12 10:52:56 +00001633 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1634 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1635 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001636 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001637 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001638 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001639 DumpFile("MEMORY INFO", "/proc/meminfo");
1640 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001641 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001642
Kevin Jeon947922b2022-09-21 00:29:18 +00001643 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1644 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001645
Sunny Goyal35949782019-11-19 15:54:36 -08001646 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1647
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001648 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1649 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1650 DumpFile("SLAB INFO", "/proc/slabinfo");
1651 DumpFile("ZONEINFO", "/proc/zoneinfo");
1652 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1653 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001654 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001655
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001656 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001657
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001658 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001659 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001660
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001661 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001662 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001663 } else {
1664 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1665 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001666
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001667 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001668 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001669 struct stat s;
1670 if (stat("/proc/modules", &s) != 0) {
1671 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1672 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001673 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001674 RunCommand("MODULES INFO",
1675 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1676 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1677 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001678 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001679
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001680 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001681 DoKernelLogcat();
1682 } else {
1683 do_dmesg();
1684 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001685
Devin Moore8df81bb2022-06-08 22:47:02 +00001686 DumpVintf();
1687
Felipe Lemef0292972016-11-22 13:57:05 -08001688 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001689
Jeff Brown1dc94e32014-09-11 14:15:27 -07001690 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001691 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001692
Jack Yu5a6b2e22020-08-14 18:13:35 +08001693 /* Dump Nfc NCI logs */
1694 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001695
Paul Chang0d2aad72020-02-13 20:04:03 +08001696 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001697 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001698 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001699 }
1700
Felipe Lemee184f662016-10-27 10:04:47 -07001701 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001702
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001703 MaybeAddSystemTraceToZip();
1704
Narayan Kamath8f788292017-05-25 13:20:39 +01001705 // NOTE: tombstones are always added as separate entries in the zip archive
1706 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001707 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001708 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001709 if (!tombstones_dumped) {
1710 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001711 }
1712
Jayachandran Ca94c7172017-06-10 15:08:12 -07001713 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001714
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001715 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001716
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001717 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001718
Woody Lin20767a92022-11-29 15:50:24 +08001719 DumpShutdownCheckpoints();
1720
Jayachandran Ca94c7172017-06-10 15:08:12 -07001721 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001722
1723 dump_route_tables();
1724
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001725 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1726 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1727 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001728
Nandana Dutt5c390032019-03-12 10:52:56 +00001729 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001730
Chiachang Wang668ede42021-05-17 17:14:20 +08001731 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1732 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1733 // dump with priority parameters to dump high priority information.
1734 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1735 CommandOptions::WithTimeout(10).Build());
1736
Elliott Hughes23ccc622017-02-28 10:14:22 -08001737 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001738
Jin Qianf334d662017-10-10 14:41:37 -07001739 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001740
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001741 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001742
Colin Crossf45fa6b2012-03-26 12:38:26 -07001743 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001744 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1745 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1746
1747 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1748 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1749 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1750 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1751 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001752
Yifan Hongd90cc652020-02-08 16:52:02 -08001753 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1754
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001755 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001756 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001757 } else {
1758 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1759 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001760
Steven Moreland7440ddb2016-12-15 16:13:39 -08001761 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001762 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1763 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001764 // su does not exist on user builds, so try running without it.
1765 // This way any implementations of vril-dump that do not require
1766 // root can run on user builds.
1767 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001768 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001769 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001770 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001771 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001772 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001773 }
1774
Felipe Lemed8b94e52016-12-08 10:21:44 -08001775 printf("========================================================\n");
1776 printf("== Android Framework Services\n");
1777 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001778
Nandana Dutt5c390032019-03-12 10:52:56 +00001779 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001780
Jack He91ff2fe2021-02-18 18:23:43 -08001781 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1782 ds.AddDir("/data/misc/bluetooth/logs", true);
1783
Rhed Jaoe017f982020-07-21 17:58:41 +08001784 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001785 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001786 } else {
1787 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1788 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001789
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001790 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001791
Adrian Roos8b397ab2017-04-04 16:35:44 -07001792 printf("========================================================\n");
1793 printf("== Dropbox crashes\n");
1794 printf("========================================================\n");
1795
1796 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1797 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1798
Felipe Lemed8b94e52016-12-08 10:21:44 -08001799 printf("========================================================\n");
1800 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1801 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1802 printf("========================================================\n");
1803 printf("== dumpstate: done (id %d)\n", ds.id_);
1804 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001805
1806 printf("========================================================\n");
1807 printf("== Obtaining statsd metadata\n");
1808 printf("========================================================\n");
1809 // This differs from the usual dumpsys stats, which is the stats report data.
1810 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001811
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001812 // Add linker configuration directory
1813 ds.AddDir(LINKERCONFIG_DIR, true);
1814
Li Li830179f2022-01-04 12:53:29 -08001815 /* Dump frozen cgroupfs */
1816 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001817
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001818 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001819 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1820 } else {
1821 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1822 DumpNetstatsProto);
1823 }
1824
1825 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001826 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001827 } else {
1828 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1829 DumpIncidentReport);
1830 }
Mike Ma5c267872019-08-21 11:31:34 -07001831
Kean Mariotti306633e2022-09-05 16:30:47 +00001832 if (ds.dump_pool_) {
1833 WaitForTask(std::move(post_process_ui_traces));
1834 } else {
1835 RUN_SLOW_FUNCTION_AND_LOG(POST_PROCESS_UI_TRACES_TASK, MaybePostProcessUiTraces);
1836 }
1837
1838 MaybeAddUiTracesToZip();
1839
Nandana Dutt5c390032019-03-12 10:52:56 +00001840 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001841}
1842
Nandana Dutt5c390032019-03-12 10:52:56 +00001843/*
1844 * Dumps state for the default case; drops root after it's no longer necessary.
1845 *
1846 * Returns RunStatus::OK if everything went fine.
1847 * Returns RunStatus::ERROR if there was an error.
1848 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1849 * with the caller.
1850 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001851Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001852 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1853 // buffer.
1854 DoLogcat();
1855 // Capture timestamp after first logcat to use in next logcat
1856 time_t logcat_ts = time(nullptr);
1857
Nandana Dutt4be45d12018-09-26 15:04:23 +01001858 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001859 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001860 if (dump_pool_) {
1861 RETURN_IF_USER_DENIED_CONSENT();
1862 // One thread is enough since we only need to enqueue DumpTraces here.
1863 dump_pool_->start(/* thread_counts = */1);
1864
1865 // DumpTraces takes long time, post it to the another thread in the
1866 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001867 dump_traces = dump_pool_->enqueueTask(
1868 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001869 } else {
1870 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1871 &dump_traces_path);
1872 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001873
1874 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001875 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001876 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1877 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001878 ds.shutdown_checkpoints_ = GetDumpFds(
1879 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001880 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001881
1882 ds.AddDir(RECOVERY_DIR, true);
1883 ds.AddDir(RECOVERY_DATA_DIR, true);
1884 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001885 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001886 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1887 if (!PropertiesHelper::IsUserBuild()) {
1888 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1889 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001890 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001891 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001892 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001893 add_mountinfo();
1894 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001895 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001896 ds.AddDir(OTA_METADATA_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001897
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001898 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001899 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1900
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001901 // Dump IPsec stats. No keys are exposed here.
1902 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1903
Nandana Dutt4be45d12018-09-26 15:04:23 +01001904 // Run ss as root so we can see socket marks.
1905 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1906
1907 // Run iotop as root to show top 100 IO threads
1908 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1909
Erick Reyese68df822019-02-11 14:46:36 -08001910 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001911 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1912 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001913
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001914 DumpFile("PSI cpu", "/proc/pressure/cpu");
1915 DumpFile("PSI memory", "/proc/pressure/memory");
1916 DumpFile("PSI io", "/proc/pressure/io");
1917
Mårten Kongstad60195a72022-09-20 14:14:20 +02001918 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1919 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1920
Rhed Jao5377d792020-07-16 17:37:39 +08001921 if (dump_pool_) {
1922 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001923 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001924
Chris Morinbc223142022-02-04 14:17:11 -08001925 // Current running thread in the pool is the root user also. Delete
1926 // the pool and make a new one later to ensure none of threads in the pool are root.
1927 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001928 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001929 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001930 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001931 }
1932
Nandana Dutt5c390032019-03-12 10:52:56 +00001933 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001934 Dumpstate::RunStatus status = dumpstate();
1935 // Capture logcat since the last time we did it.
1936 DoSystemLogcat(logcat_ts);
1937 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001938}
1939
Rhed Jaob5685b32020-08-14 17:19:17 +08001940// Common states for telephony and wifi which are needed to be collected before
1941// dumpstate drop the root user.
1942static void DumpstateRadioAsRoot() {
1943 DumpIpTablesAsRoot();
1944 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1945}
1946
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001947// This method collects common dumpsys for telephony and wifi. Typically, wifi
1948// reports are fine to include all information, but telephony reports on user
1949// builds need to strip some content (see DumpstateTelephonyOnly).
1950static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001951 // We need to be picky about some stuff for telephony reports on user builds.
1952 if (!include_sensitive_info) {
1953 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1954 DoRadioLogcat();
1955 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001956 // DumpHals takes long time, post it to the another thread in the pool,
1957 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001958 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001959 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001960 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001961 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001962 // Contains various system properties and process startup info.
1963 do_dmesg();
1964 // Logs other than the radio buffer may contain package/component names and potential PII.
1965 DoLogcat();
1966 // Too broad for connectivity problems.
1967 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001968 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1969 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001970 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001971 } else {
1972 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1973 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001974 }
1975
Jayachandran Ca94c7172017-06-10 15:08:12 -07001976 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001977 DumpIpAddrAndRules();
1978 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001979 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1980 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001981}
1982
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001983// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1984// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1985// for what can be included on user builds: all reported information MUST directly relate to
1986// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1987// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1988// names are not), and MUST NOT contain logs of user application traffic.
1989// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08001990static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08001991 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08001992
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07001993 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08001994
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001995 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001996
Rhed Jaob5685b32020-08-14 17:19:17 +08001997 DumpstateRadioAsRoot();
1998 if (!DropRootUser()) {
1999 return;
2000 }
2001
2002 // Starts thread pool after the root user is dropped, and two additional threads
2003 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002004 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002005 if (ds.dump_pool_) {
2006 ds.dump_pool_->start(/*thread_counts =*/2);
2007
2008 // DumpstateBoard takes long time, post it to the another thread in the pool,
2009 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002010 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2011 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002012 }
2013
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002014 DumpstateRadioCommon(include_sensitive_info);
2015
2016 if (include_sensitive_info) {
2017 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2018 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2019 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2020 // way.
2021 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2022 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002023
2024 printf("========================================================\n");
2025 printf("== Android Framework Services\n");
2026 printf("========================================================\n");
2027
Vishnu Nair652cc802017-11-30 15:18:30 -08002028 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2029 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002030 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2031 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002032 if (include_sensitive_info) {
2033 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2034 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2035 SEC_TO_MSEC(10));
2036 } else {
2037 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2038 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2039 // give a higher timeout as well.
2040 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2041 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2042 }
2043 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002044 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2045 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002046 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002047 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2048 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002049 if (include_sensitive_info) {
2050 // Contains raw IP addresses, omit from reports on user builds.
2051 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2052 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2053 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2054 SEC_TO_MSEC(10));
2055 // Contains package/component names, omit from reports on user builds.
2056 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2057 SEC_TO_MSEC(10));
2058 // Contains package names, but should be relatively simple to remove them (also contains
2059 // UIDs already), omit from reports on user builds.
2060 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2061 SEC_TO_MSEC(10));
2062 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002063
2064 printf("========================================================\n");
2065 printf("== Running Application Services\n");
2066 printf("========================================================\n");
2067
2068 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2069
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002070 if (include_sensitive_info) {
2071 printf("========================================================\n");
2072 printf("== Running Application Services (non-platform)\n");
2073 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002074
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002075 // Contains package/component names and potential PII, omit from reports on user builds.
2076 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2077 // carrier_config dumpsys instead.
2078 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2079 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002080
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002081 printf("========================================================\n");
2082 printf("== Checkins\n");
2083 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002084
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002085 // Contains package/component names, omit from reports on user builds.
2086 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2087 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002088
2089 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002090 printf("== dumpstate: done (id %d)\n", ds.id_);
2091 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002092
2093 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002094 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002095 } else {
2096 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2097 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002098}
2099
mukesh agrawal253dad42018-01-23 21:59:59 -08002100// This method collects dumpsys for wifi debugging only
2101static void DumpstateWifiOnly() {
2102 DurationReporter duration_reporter("DUMPSTATE");
2103
Rhed Jaob5685b32020-08-14 17:19:17 +08002104 DumpstateRadioAsRoot();
2105 if (!DropRootUser()) {
2106 return;
2107 }
2108
2109 // Starts thread pool after the root user is dropped. Only one additional
2110 // thread is needed for DumpHals in the DumpstateRadioCommon.
2111 if (ds.dump_pool_) {
2112 ds.dump_pool_->start(/*thread_counts =*/1);
2113 }
2114
mukesh agrawal253dad42018-01-23 21:59:59 -08002115 DumpstateRadioCommon();
2116
2117 printf("========================================================\n");
2118 printf("== Android Framework Services\n");
2119 printf("========================================================\n");
2120
2121 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2122 SEC_TO_MSEC(10));
2123 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2124 SEC_TO_MSEC(10));
2125
2126 printf("========================================================\n");
2127 printf("== dumpstate: done (id %d)\n", ds.id_);
2128 printf("========================================================\n");
2129}
2130
Nandana Duttcf419a72019-03-14 10:40:17 +00002131Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002132 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002133 const size_t buf_size = temp_file_pattern.length() + 1;
2134 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2135 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2136
2137 // Create a new, empty file to receive all trace dumps.
2138 //
2139 // TODO: This can be simplified once we remove support for the old style
2140 // dumps. We can have a file descriptor passed in to dump_traces instead
2141 // of creating a file, closing it and then reopening it again.
2142 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2143 if (fd < 0) {
2144 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002145 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002146 }
2147
2148 // Nobody should have access to this temporary file except dumpstate, but we
2149 // temporarily grant 'read' to 'others' here because this file is created
2150 // when tombstoned is still running as root, but dumped after dropping. This
2151 // can go away once support for old style dumping has.
2152 const int chmod_ret = fchmod(fd, 0666);
2153 if (chmod_ret < 0) {
2154 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002155 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002156 }
2157
2158 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2159 if (proc.get() == nullptr) {
2160 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002161 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002162 }
2163
2164 // Number of times process dumping has timed out. If we encounter too many
2165 // failures, we'll give up.
2166 int timeout_failures = 0;
2167 bool dalvik_found = false;
2168
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002169 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002170
2171 struct dirent* d;
2172 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002173 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002174 int pid = atoi(d->d_name);
2175 if (pid <= 0) {
2176 continue;
2177 }
2178
2179 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2180 std::string exe;
2181 if (!android::base::Readlink(link_name, &exe)) {
2182 continue;
2183 }
2184
2185 bool is_java_process;
2186 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2187 // Don't bother dumping backtraces for the zygote.
2188 if (IsZygote(pid)) {
2189 continue;
2190 }
2191
2192 dalvik_found = true;
2193 is_java_process = true;
2194 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2195 is_java_process = false;
2196 } else {
2197 // Probably a native process we don't care about, continue.
2198 continue;
2199 }
2200
2201 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2202 if (timeout_failures == 3) {
2203 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2204 break;
2205 }
2206
2207 const uint64_t start = Nanotime();
2208 const int ret = dump_backtrace_to_file_timeout(
2209 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2210 is_java_process ? 5 : 20, fd);
2211
2212 if (ret == -1) {
2213 // For consistency, the header and footer to this message match those
2214 // dumped by debuggerd in the success case.
2215 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2216 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2217 dprintf(fd, "---- end %d ----", pid);
2218 timeout_failures++;
2219 continue;
2220 }
2221
2222 // We've successfully dumped stack traces, reset the failure count
2223 // and write a summary of the elapsed time to the file and continue with the
2224 // next process.
2225 timeout_failures = 0;
2226
2227 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2228 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2229 }
2230
2231 if (!dalvik_found) {
2232 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2233 }
2234
Nandana Duttcf419a72019-03-14 10:40:17 +00002235 *path = file_name_buf.release();
2236 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002237}
2238
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002239static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2240 const Dumpstate::BugreportMode bugreport_mode) {
2241 switch (bugreport_mode) {
2242 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2243 return dumpstate_hal_hidl::DumpstateMode::FULL;
2244 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2245 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2246 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2247 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2248 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2249 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2250 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2251 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2252 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2253 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2254 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2255 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2256 }
2257 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2258}
2259
2260static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2261 const Dumpstate::BugreportMode bugreport_mode) {
2262 switch (bugreport_mode) {
2263 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2264 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2265 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2266 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2267 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2268 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2269 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2270 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2271 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2272 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2273 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2274 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2275 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2276 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2277 }
2278 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2279}
2280
2281static void DoDumpstateBoardHidl(
2282 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2283 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2284 const Dumpstate::BugreportMode bugreport_mode,
2285 const size_t timeout_sec) {
2286
2287 using ScopedNativeHandle =
2288 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2289 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2290 [](native_handle_t* handle) {
2291 // we don't close file handle's here
2292 // via native_handle_close(handle)
2293 // instead we let dumpstate_fds close the file handles when
2294 // dumpstate_fds gets destroyed
2295 native_handle_delete(handle);
2296 });
2297 if (handle == nullptr) {
2298 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2299 return;
2300 }
2301
2302 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2303 handle.get()->data[i] = dumpstate_fds[i].get();
2304 }
2305
2306 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2307 // implement just 1.0.
2308 const char* descriptor_to_kill;
2309 using DumpstateBoardTask = std::packaged_task<bool()>;
2310 DumpstateBoardTask dumpstate_board_task;
2311 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2312 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2313 if (dumpstate_hal != nullptr) {
2314 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2315
2316 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2317 GetDumpstateHalModeHidl(bugreport_mode);
2318
2319 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2320 dumpstate_board_task =
2321 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2322 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2323 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2324 SEC_TO_MSEC(timeout_sec));
2325 if (!status.isOk()) {
2326 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2327 return false;
2328 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2329 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2330 dumpstate_hal_hidl::toString(status).c_str());
2331 return false;
2332 }
2333 return true;
2334 });
2335 } else {
2336 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2337
2338 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2339 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2340 ::android::hardware::Return<void> status =
2341 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2342 if (!status.isOk()) {
2343 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2344 return false;
2345 }
2346 return true;
2347 });
2348 }
2349 auto result = dumpstate_board_task.get_future();
2350 std::thread(std::move(dumpstate_board_task)).detach();
2351
2352 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2353 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2354 if (!android::base::SetProperty(
2355 "ctl.interface_restart",
2356 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2357 MYLOGE("Couldn't restart dumpstate HAL\n");
2358 }
2359 }
2360 // Wait some time for init to kill dumpstate vendor HAL
2361 constexpr size_t killing_timeout_sec = 10;
2362 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2363 MYLOGE(
2364 "killing dumpstateBoard timed out after %zus, continue and "
2365 "there might be racing in content\n",
2366 killing_timeout_sec);
2367 }
2368}
2369
2370static void DoDumpstateBoardAidl(
2371 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2372 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2373 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2374 MYLOGI("Using IDumpstateDevice AIDL HAL");
2375
2376 const char* descriptor_to_kill;
2377 using DumpstateBoardTask = std::packaged_task<bool()>;
2378 DumpstateBoardTask dumpstate_board_task;
2379 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2380 GetDumpstateHalModeAidl(bugreport_mode);
2381
2382 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2383 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2384 timeout_sec]() -> bool {
2385 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2386
2387 if (!status.isOk()) {
2388 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2389 return false;
2390 }
2391 return true;
2392 });
2393 auto result = dumpstate_board_task.get_future();
2394 std::thread(std::move(dumpstate_board_task)).detach();
2395
2396 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2397 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2398 if (!android::base::SetProperty(
2399 "ctl.interface_restart",
2400 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2401 MYLOGE("Couldn't restart dumpstate HAL\n");
2402 }
2403 }
2404 // Wait some time for init to kill dumpstate vendor HAL
2405 constexpr size_t killing_timeout_sec = 10;
2406 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2407 MYLOGE(
2408 "killing dumpstateBoard timed out after %zus, continue and "
2409 "there might be racing in content\n",
2410 killing_timeout_sec);
2411 }
2412}
2413
2414static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2415 const std::string aidl_instance_name =
2416 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2417
2418 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2419 return nullptr;
2420 }
2421
2422 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2423
2424 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2425}
2426
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002427void Dumpstate::DumpstateBoard(int out_fd) {
2428 dprintf(out_fd, "========================================================\n");
2429 dprintf(out_fd, "== Board\n");
2430 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002431
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002432 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002433 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002434 * set to true and unmount it after invoking dumpstateBoard_* methods.
2435 * This is to enable debug builds to not have debugfs mounted during runtime.
2436 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002437 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002438 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002439 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002440 if (mount_debugfs) {
2441 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2442 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002443 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002444 }
2445
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002446 std::vector<std::string> paths;
2447 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002448 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002449 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2450 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002451 remover.emplace_back(android::base::make_scope_guard(
2452 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002453 }
Jie Song9fbfad02017-06-20 16:29:42 -07002454
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002455 // get dumpstate HAL AIDL implementation
2456 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2457 GetDumpstateBoardAidlService());
2458 if (dumpstate_hal_handle_aidl == nullptr) {
2459 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2460 }
2461
2462 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2463 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2464 if (dumpstate_hal_handle_aidl == nullptr) {
2465 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2466 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2467 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2468 }
2469 }
2470
2471 // if neither HIDL nor AIDL implementation found, then return
2472 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2473 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002474 return;
2475 }
2476
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002477 // this is used to hold the file descriptors and when this variable goes out of scope
2478 // the file descriptors are closed
2479 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002480
Nandana Dutt5c390032019-03-12 10:52:56 +00002481 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002482 for (size_t i = 0; i < paths.size(); i++) {
2483 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2484
2485 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2486 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2487 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2488 if (fd < 0) {
2489 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2490 return;
2491 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002492
2493 dumpstate_fds.emplace_back(fd.release());
2494 // we call fd.release() here to make sure "fd" does not get closed
2495 // after "fd" goes out of scope after this block.
2496 // "fd" will be closed when "dumpstate_fds" goes out of scope
2497 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002498 }
2499
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002500 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2501 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2502 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002503 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002504
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002505 if (dumpstate_hal_handle_aidl != nullptr) {
2506 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2507 timeout_sec);
2508 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2509 // run HIDL HAL only if AIDL HAL not found
2510 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2511 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002512 }
2513
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002514 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002515 auto keep_debugfs_mounted =
2516 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2517 if (keep_debugfs_mounted.empty())
2518 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002519 }
2520
Wei Wang587eac92018-04-05 12:17:20 -07002521 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2522 for (size_t i = 0; i < paths.size(); i++) {
2523 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002524 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2525 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002526 file_sizes[i] = -1;
2527 continue;
2528 }
2529 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002530 }
2531
2532 for (size_t i = 0; i < paths.size(); i++) {
2533 if (file_sizes[i] == -1) {
2534 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002535 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002536 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002537 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002538 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002539 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002540 remover[i].Disable();
2541 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2542 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002543 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002544}
2545
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002546static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002547 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002548 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2549 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002550 " -h: display this help message\n"
2551 " -b: play sound file instead of vibrate, at beginning of job\n"
2552 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002553 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002554 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002555 " -s: write zipped file to control socket (for init)\n"
2556 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002557 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002558 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002559 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002560 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002561 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002562 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002563}
2564
Wei Liuf87959e2016-08-26 14:51:42 -07002565static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002566 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002567}
2568
Felipe Leme1d486fe2016-10-14 18:06:47 -07002569bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002570 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2571 if (zip_entry_tasks_) {
2572 zip_entry_tasks_->run(/* do_cancel = */false);
2573 }
2574
Felipe Leme9a523ae2016-10-20 15:10:33 -07002575 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002576 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002577 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002578 // Final timestamp
2579 char date[80];
2580 time_t the_real_now_please_stand_up = time(nullptr);
2581 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002582 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002583 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002584
Felipe Leme9a523ae2016-10-20 15:10:33 -07002585 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002586 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002587 return false;
2588 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002589 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002590 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002591 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002592 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002593
Felipe Leme0f3fb202016-06-10 17:10:53 -07002594 // Add log file (which contains stderr output) to zip...
2595 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002596 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002597 MYLOGE("Failed to add dumpstate log to .zip file\n");
2598 return false;
2599 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002600 // TODO: Should truncate the existing file.
2601 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002602 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2603 return false;
2604 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002605 fprintf(stderr, "\n");
2606
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002607 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002608 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002609 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002610 return false;
2611 }
2612
Felipe Leme1d486fe2016-10-14 18:06:47 -07002613 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2614 ds.zip_file.reset(nullptr);
2615
Felipe Lemee9d2c542016-11-15 11:48:26 -08002616 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002617 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002618
Felipe Leme1e9edc62015-12-21 16:02:13 -08002619 return true;
2620}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002621
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002622static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2623 // clang-format off
2624 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2625 "--receiver-foreground", "--receiver-include-background", "-a", action};
2626 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002627
2628 am.insert(am.end(), args.begin(), args.end());
2629
Felipe Leme8d2410e2017-02-08 09:46:08 -08002630 RunCommand("", am,
2631 CommandOptions::WithTimeout(20)
2632 .Log("Sending broadcast: '%s'\n")
2633 .Always()
2634 .DropRoot()
2635 .RedirectStderr()
2636 .Build());
2637}
2638
Felipe Leme35b8cf12017-02-10 15:47:29 -08002639static void Vibrate(int duration_ms) {
2640 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002641 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2642 "oneshot", std::to_string(duration_ms)};
2643 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002644 CommandOptions::WithTimeout(10)
2645 .Log("Vibrate: '%s'\n")
2646 .Always()
2647 .Build());
2648 // clang-format on
2649}
2650
Nandana Dutt979388e2018-11-30 16:48:55 +00002651static void MaybeResolveSymlink(std::string* path) {
2652 std::string resolved_path;
2653 if (android::base::Readlink(*path, &resolved_path)) {
2654 *path = resolved_path;
2655 }
2656}
2657
Nandana Dutt4be45d12018-09-26 15:04:23 +01002658/*
2659 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002660 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002661 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002662static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002663 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2664
Nandana Dutt4be45d12018-09-26 15:04:23 +01002665 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2666 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002667 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002668 char date[80];
2669 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2670 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002671
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002672 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002673 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002674 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002675 ds.base_name_ += "-wifi";
2676 }
2677
Paul Chang0d2aad72020-02-13 20:04:03 +08002678 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002679 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002680 }
2681 ds.tmp_path_ = ds.GetPath(".tmp");
2682 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2683
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002684 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002685 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002686 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002687 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002688 "Bugreport dir: [%s] "
2689 "Base name: [%s] "
2690 "Suffix: [%s] "
2691 "Log path: [%s] "
2692 "Temporary path: [%s] "
2693 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002694 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2695 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002696
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002697 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2698 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2699 create_parent_dirs(ds.path_.c_str());
2700 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2701 if (ds.zip_file == nullptr) {
2702 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2703 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002704 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002705 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2706 ds.AddTextZipEntry("version.txt", ds.version_);
2707 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002708}
2709
2710/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002711 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002712 * printing zipped file status, etc.
2713 */
2714static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002715 bool do_text_file = !ds.FinishZipFile();
2716 if (do_text_file) {
2717 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002718 }
mhasank2d75c442020-06-11 15:05:25 -07002719
2720 std::string final_path = ds.path_;
2721 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002722 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002723 android::os::CopyFileToFile(ds.path_, final_path);
2724 }
2725
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002726 if (ds.options_->stream_to_socket) {
2727 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2728 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002729 if (do_text_file) {
2730 dprintf(ds.control_socket_fd_,
2731 "FAIL:could not create zip file, check %s "
2732 "for more details\n",
2733 ds.log_path_.c_str());
2734 } else {
mhasank2d75c442020-06-11 15:05:25 -07002735 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002736 }
2737 }
2738}
2739
Nandana Dutt4be45d12018-09-26 15:04:23 +01002740
Nandana Dutt58d72e22018-11-16 10:30:48 +00002741static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2742 switch (mode) {
2743 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2744 return "BUGREPORT_FULL";
2745 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2746 return "BUGREPORT_INTERACTIVE";
2747 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2748 return "BUGREPORT_REMOTE";
2749 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2750 return "BUGREPORT_WEAR";
2751 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2752 return "BUGREPORT_TELEPHONY";
2753 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2754 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002755 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2756 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002757 }
2758}
2759
Paul Changf59c2b72020-03-10 02:08:55 +08002760static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2761 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002762 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2763 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002764 options->bugreport_mode = mode;
2765 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002766 switch (mode) {
2767 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002768 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002769 break;
2770 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002771 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002772 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002773 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002774 break;
2775 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002776 options->do_vibrate = false;
2777 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002778 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002779 break;
2780 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002781 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002782 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002783 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002784 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002785 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002786 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002787 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002788 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002789 break;
2790 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002791 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002792 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002793 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002794 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2795 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002796 }
2797}
2798
Nandana Dutt58d72e22018-11-16 10:30:48 +00002799static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002800 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002801 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002802 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002803 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002804 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002805 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002806 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002807 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002808 options.do_progress_updates, options.bugreport_fd.get(),
2809 options.bugreport_mode_string.c_str(),
2810 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002811}
2812
Nandana Dutt54dbd672019-01-11 12:58:05 +00002813void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002814 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002815 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002816 const android::base::unique_fd& screenshot_fd_in,
2817 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002818 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002819 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002820 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2821 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002822
Paul Changf59c2b72020-03-10 02:08:55 +08002823 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002824}
2825
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002826Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2827 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002828 int c;
mhasankd451a472020-05-26 18:02:39 -07002829 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002830 switch (c) {
2831 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002832 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002833 case 's': stream_to_socket = true; break;
2834 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002835 case 'v': show_header_only = true; break;
2836 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002837 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002838 case 'P': do_progress_updates = true; break;
2839 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002840 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002841 case 'V':
2842 case 'd':
2843 case 'z':
2844 // compatibility no-op
2845 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002846 case 'w':
2847 // This was already processed
2848 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002849 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002850 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002851 break;
2852 default:
2853 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002854 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002855 break;
2856 // clang-format on
2857 }
2858 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002859
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002860 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002861 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002862 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002863 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002864 }
2865 }
2866
2867 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2868 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002869
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002870 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002871}
2872
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002873bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002874 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002875 return false;
2876 }
2877
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002878 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002879 return false;
2880 }
2881
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002882 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002883 return false;
2884 }
2885 return true;
2886}
2887
Nandana Dutt197661d2018-11-16 16:40:21 +00002888void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2889 options_ = std::move(options);
2890}
2891
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002892void Dumpstate::Initialize() {
2893 /* gets the sequential id */
2894 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2895 id_ = ++last_id;
2896 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2897}
2898
Nandana Duttd2f5f082019-01-18 17:13:52 +00002899Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2900 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002901 if (listener_ != nullptr) {
2902 switch (status) {
2903 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002904 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002905 break;
2906 case Dumpstate::RunStatus::HELP:
2907 break;
2908 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002909 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002910 break;
2911 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002912 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2913 break;
2914 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2915 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2916 break;
2917 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2918 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002919 break;
2920 }
2921 }
2922 return status;
2923}
2924
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002925void Dumpstate::Cancel() {
2926 CleanupTmpFiles();
2927 android::os::UnlinkAndLogOnError(log_path_);
2928 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2929 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2930 kDumpstateBoardFiles[i]);
2931 }
2932 tombstone_data_.clear();
2933 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002934 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002935
2936 // Instead of shutdown the pool, we delete temporary files directly since
2937 // shutdown blocking the call.
2938 if (dump_pool_) {
2939 dump_pool_->deleteTempFiles();
2940 }
2941 if (zip_entry_tasks_) {
2942 zip_entry_tasks_->run(/*do_cancel =*/ true);
2943 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002944}
2945
Kean Mariotti306633e2022-09-05 16:30:47 +00002946void Dumpstate::PreDumpUiData() {
2947 MaybeSnapshotUiTraces();
2948}
2949
Nandana Dutt979388e2018-11-30 16:48:55 +00002950/*
2951 * Dumps relevant information to a bugreport based on the given options.
2952 *
2953 * The bugreport can be dumped to a file or streamed to a socket.
2954 *
2955 * How dumping to file works:
2956 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2957 * stderr is redirected a log file.
2958 *
2959 * The temporary bugreport is then populated via printfs, dumping contents of files and
2960 * output of commands to stdout.
2961 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002962 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002963 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002964 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002965 *
mhasank2d75c442020-06-11 15:05:25 -07002966 * Bugreports are first generated in a local directory and later copied to the caller's fd
2967 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002968 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002969Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2970 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002971 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002972 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002973 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002974 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002975 return RunStatus::INVALID_INPUT;
2976 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002977 /* set as high priority, and protect from OOM killer */
2978 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002979
Felipe Lemed071c682016-10-20 16:48:00 -07002980 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002981 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002982 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002983 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002984 } else {
2985 /* fallback to kernels <= 2.6.35 */
2986 oom_adj = fopen("/proc/self/oom_adj", "we");
2987 if (oom_adj) {
2988 fputs("-17", oom_adj);
2989 fclose(oom_adj);
2990 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002991 }
2992
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002993 if (version_ == VERSION_DEFAULT) {
2994 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002995 }
2996
Chris Morin5a50d482022-02-01 17:41:18 -08002997 if (version_ != VERSION_CURRENT) {
2998 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
2999 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003000 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003001 }
3002
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003003 if (options_->show_header_only) {
3004 PrintHeader();
3005 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003006 }
3007
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003008 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3009 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003010
Felipe Leme7447d7c2016-11-03 18:12:22 -07003011 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003012 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003013 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003014 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003015
Sahana Raof35ed432019-07-12 10:47:52 +01003016 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3017 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3018 } else {
3019 // Wake lock will be released automatically on process death
3020 MYLOGD("Wake lock acquired.\n");
3021 }
3022
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003023 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003024
Felipe Lemef0292972016-11-22 13:57:05 -08003025 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003026 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3027 }
3028
Nandana Dutt235c6672019-11-14 15:22:32 +00003029 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003030 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003031
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003032 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003033
Christopher Ferrised9354f2014-10-01 17:35:01 -07003034 // If we are going to use a socket, do it as early as possible
3035 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003036 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003037 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003038 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003039 if (control_socket_fd_ == -1) {
3040 return ERROR;
3041 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003042 if (options_->progress_updates_to_socket) {
3043 options_->do_progress_updates = 1;
3044 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003045 }
3046
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003047 if (!PrepareToWriteToFile()) {
3048 return ERROR;
3049 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003050
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003051 // Interactive, wear & telephony modes are default to true.
3052 // and may enable from cli option or when using control socket
3053 if (options_->do_progress_updates) {
3054 // clang-format off
3055 std::vector<std::string> am_args = {
3056 "--receiver-permission", "android.permission.DUMP",
3057 };
3058 // clang-format on
3059 // Send STARTED broadcast for apps that listen to bugreport generation events
3060 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3061 if (options_->progress_updates_to_socket) {
3062 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003063 }
3064 }
3065
Nick Kralevichf3599b32016-01-25 15:05:16 -08003066 /* read /proc/cmdline before dropping root */
3067 FILE *cmdline = fopen("/proc/cmdline", "re");
3068 if (cmdline) {
3069 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3070 fclose(cmdline);
3071 }
3072
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003073 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003074 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003075 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003076
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003077 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003078 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3079 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003080 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003081 }
3082 }
3083
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003084 int dup_stdout_fd;
3085 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003086 // Redirect stderr to log_path_ for debugging.
3087 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3088 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3089 return ERROR;
3090 }
3091 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3092 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3093 strerror(errno));
3094 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003095
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003096 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3097 // moved into zip file later, if zipping.
3098 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3099 // TODO: why not write to a file instead of stdout to overcome this problem?
3100 /* TODO: rather than generating a text file now and zipping it later,
3101 it would be more efficient to redirect stdout to the zip entry
3102 directly, but the libziparchive doesn't support that option yet. */
3103 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3104 return ERROR;
3105 }
3106 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3107 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3108 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003109 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003110
3111 // Don't buffer stdout
3112 setvbuf(stdout, nullptr, _IONBF, 0);
3113
Rhed Jao5377d792020-07-16 17:37:39 +08003114 // Enable the parallel run if the client requests to output to a file.
3115 EnableParallelRunIfNeeded();
3116 // Using scope guard to make sure the dump pool can be shut down correctly.
3117 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3118 ShutdownDumpPool();
3119 });
3120
Felipe Leme608385d2016-02-01 10:35:38 -08003121 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3122 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003123 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003124 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003125
Gavin Corkery6968f552020-11-22 18:09:05 +00003126 bool is_dumpstate_restricted = options_->telephony_only
3127 || options_->wifi_only
3128 || options_->limited_only;
3129 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003130 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003131 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003132 }
3133 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003134
3135 if (!is_dumpstate_restricted) {
3136 // Snapshot the system trace now (if running) to avoid that dumpstate's
3137 // own activity pushes out interesting data from the trace ring buffer.
3138 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3139 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003140
Kean Mariotti306633e2022-09-05 16:30:47 +00003141 // Snapshot the UI traces now (if running).
3142 // The trace files will be added to bugreport later.
3143 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003144 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003145 onUiIntensiveBugreportDumpsFinished(calling_uid);
3146 MaybeCheckUserConsent(calling_uid, calling_package);
3147 if (options_->telephony_only) {
3148 DumpstateTelephonyOnly(calling_package);
3149 } else if (options_->wifi_only) {
3150 DumpstateWifiOnly();
3151 } else if (options_->limited_only) {
3152 DumpstateLimitedOnly();
3153 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003154 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003155 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003156 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003157 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003158 HandleUserConsentDenied();
3159 }
3160 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003161 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003162 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003163
Felipe Leme55b42a62015-11-10 17:39:08 -08003164 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003165 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003166
Abhijeet Kaure370d682019-10-01 16:49:30 +01003167 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003168 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003169 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003170 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003171
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003172 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003173 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003174 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003175 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003176 if (status != Dumpstate::RunStatus::OK &&
3177 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3178 // Do an early return if there were errors. We make an exception for consent
3179 // timing out because it's possible the user got distracted. In this case the
3180 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003181 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003182 return status;
3183 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003184 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3185 MYLOGI(
3186 "Did not receive user consent yet."
3187 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003188 const String16 incidentcompanion("incidentcompanion");
3189 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3190 if (ics != nullptr) {
3191 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3192 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3193 consent_callback_.get());
3194 } else {
3195 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3196 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003197 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003198 }
3199
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003200 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003201 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003202 for (int i = 0; i < 3; i++) {
3203 Vibrate(75);
3204 usleep((75 + 50) * 1000);
3205 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003206 }
3207
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003208 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3209 progress_->GetInitialMax());
3210 progress_->Save();
3211 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003212
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003213 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003214
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003215 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003216 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003217 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003218 }
3219
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003220 tombstone_data_.clear();
3221 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003222 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003223
Nandana Duttd2f5f082019-01-18 17:13:52 +00003224 return (consent_callback_ != nullptr &&
3225 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3226 ? USER_CONSENT_TIMED_OUT
3227 : RunStatus::OK;
3228}
3229
Paul Chang0d2aad72020-02-13 20:04:03 +08003230void Dumpstate::MaybeTakeEarlyScreenshot() {
3231 if (!options_->do_screenshot || !do_early_screenshot_) {
3232 return;
3233 }
3234
3235 TakeScreenshot();
3236}
3237
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003238void Dumpstate::MaybeSnapshotSystemTrace() {
3239 // If a background system trace is happening and is marked as "suitable for
3240 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3241 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3242 // case that no trace is ongoing, this command is a no-op.
3243 // Note: this should not be enqueued as we need to freeze the trace before
3244 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3245 // the dumpstate's own activity which is irrelevant.
3246 int res = RunCommand(
3247 "SERIALIZE PERFETTO TRACE",
3248 {"perfetto", "--save-for-bugreport"},
3249 CommandOptions::WithTimeout(10)
3250 .DropRoot()
3251 .CloseAllFileDescriptorsOnExec()
3252 .Build());
3253 has_system_trace_ = res == 0;
3254 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3255 // file in the later stages.
3256}
3257
Kean Mariotti306633e2022-09-05 16:30:47 +00003258void Dumpstate::MaybeSnapshotUiTraces() {
3259 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3260 return;
3261 }
3262
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003263 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
Kean Mariotti306633e2022-09-05 16:30:47 +00003264 for (const auto& service : {"input_method", "window"}) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003265 RunCommand(
3266 // Empty name because it's not intended to be classified as a bugreport section.
3267 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3268 "", {"cmd", service, "tracing", "save-for-bugreport"},
3269 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3270 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003271
3272 static const auto SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES = std::vector<std::string> {
3273 "service", "call", "SurfaceFlinger", "1042"
3274 };
3275 // Empty name because it's not intended to be classified as a bugreport section.
3276 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3277 RunCommand(
3278 "", SURFACEFLINGER_COMMAND_SAVE_ALL_TRACES,
3279 CommandOptions::WithTimeout(10).Always().AsRoot().RedirectStderr().Build());
3280}
3281
3282void Dumpstate::MaybePostProcessUiTraces() {
3283 if (PropertiesHelper::IsUserBuild()) {
3284 return;
3285 }
3286
3287 RunCommand(
3288 // Empty name because it's not intended to be classified as a bugreport section.
3289 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3290 "", {
3291 "/system/xbin/su", "system",
3292 "/system/bin/layertracegenerator",
3293 "/data/misc/wmtrace/transactions_trace.winscope",
3294 "/data/misc/wmtrace/layers_trace_from_transactions.winscope"
3295 },
3296 CommandOptions::WithTimeout(120).Always().RedirectStderr().Build());
3297}
3298
3299void Dumpstate::MaybeAddUiTracesToZip() {
3300 if (PropertiesHelper::IsUserBuild()) {
3301 return;
3302 }
3303
3304 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003305}
3306
Paul Changeb4b4642020-05-28 22:05:47 +08003307void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003308 if (calling_uid == AID_SHELL || !CalledByApi()) {
3309 return;
3310 }
3311 if (listener_ != nullptr) {
3312 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3313 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003314 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003315 }
3316}
3317
Jichao Lie89d9c12019-11-21 19:02:51 -08003318void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3319 if (calling_uid == AID_SHELL || !CalledByApi()) {
3320 // No need to get consent for shell triggered dumpstates, or not through
3321 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003322 return;
3323 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003324 consent_callback_ = new ConsentCallback();
3325 const String16 incidentcompanion("incidentcompanion");
3326 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003327 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003328 if (ics != nullptr) {
3329 MYLOGD("Checking user consent via incidentcompanion service\n");
3330 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003331 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003332 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003333 } else {
3334 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3335 }
3336}
3337
Nandana Dutt5c390032019-03-12 10:52:56 +00003338bool Dumpstate::IsUserConsentDenied() const {
3339 return ds.consent_callback_ != nullptr &&
3340 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3341}
3342
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003343bool Dumpstate::CalledByApi() const {
3344 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3345}
3346
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003347void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003348 android::os::UnlinkAndLogOnError(tmp_path_);
3349 android::os::UnlinkAndLogOnError(screenshot_path_);
3350 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003351 if (dump_traces_path != nullptr) {
3352 android::os::UnlinkAndLogOnError(dump_traces_path);
3353 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003354}
3355
Rhed Jao5377d792020-07-16 17:37:39 +08003356void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003357 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003358 return;
3359 }
3360 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003361 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003362}
3363
3364void Dumpstate::ShutdownDumpPool() {
3365 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003366 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003367 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003368 if (zip_entry_tasks_) {
3369 zip_entry_tasks_->run(/* do_cancel = */true);
3370 zip_entry_tasks_ = nullptr;
3371 }
3372}
3373
3374void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3375 const std::string& entry_path) {
3376 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3377 if (!task_cancelled) {
3378 AddZipEntry(entry_name, entry_path);
3379 }
3380 android::os::UnlinkAndLogOnError(entry_path);
3381 };
3382 if (zip_entry_tasks_) {
3383 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3384 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3385 } else {
3386 // Invokes AddZipEntryAndCleanup immediately
3387 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3388 }
Rhed Jao5377d792020-07-16 17:37:39 +08003389}
3390
Nandana Duttd2f5f082019-01-18 17:13:52 +00003391Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3392 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003393 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003394 return USER_CONSENT_DENIED;
3395}
3396
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003397Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003398 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003399 // user consent (unless the caller is Shell).
3400 UserConsentResult consent_result;
3401 if (calling_uid == AID_SHELL) {
3402 consent_result = UserConsentResult::APPROVED;
3403 } else {
3404 consent_result = consent_callback_->getResult();
3405 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003406 if (consent_result == UserConsentResult::UNAVAILABLE) {
3407 // User has not responded yet.
3408 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003409 // Telephony is a fast report type, particularly on user builds where information may be
3410 // more aggressively limited. To give the user time to read the consent dialog, increase the
3411 // timeout.
3412 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3413 : USER_CONSENT_TIMEOUT_MS;
3414 if (elapsed_ms < timeout_ms) {
3415 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003416 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3417 sleep(delay_seconds);
3418 }
3419 consent_result = consent_callback_->getResult();
3420 }
3421 if (consent_result == UserConsentResult::DENIED) {
3422 // User has explicitly denied sharing with the app. To be safe delete the
3423 // internal bugreport & tmp files.
3424 return HandleUserConsentDenied();
3425 }
3426 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003427 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3428 if (copy_succeeded) {
3429 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003430 if (options_->do_screenshot &&
3431 options_->screenshot_fd.get() != -1 &&
3432 !options_->is_screenshot_copied) {
3433 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3434 options_->screenshot_fd.get());
3435 options_->is_screenshot_copied = copy_succeeded;
3436 if (copy_succeeded) {
3437 android::os::UnlinkAndLogOnError(screenshot_path_);
3438 }
3439 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003440 }
3441 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3442 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3443 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3444 // Since we do not have user consent to share the bugreport it does not get
3445 // copied over to the calling app but remains in the internal directory from
3446 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003447 std::string final_path = GetPath(".zip");
3448 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3449 if (copy_succeeded) {
3450 android::os::UnlinkAndLogOnError(path_);
3451 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003452 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3453 }
3454 // Unknown result; must be a programming error.
3455 MYLOGE("Unknown user consent result:%d\n", consent_result);
3456 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003457}
3458
Nandana Duttf02564e2019-02-15 15:24:24 +00003459Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003460 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3461 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3462 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003463 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003464 // When directly running dumpstate binary, the output is not expected to be written
3465 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003466 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003467
3468 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003469 // an app; they are irrelevant here because bugreport is triggered via command line.
3470 // Update Last ID before calling Run().
3471 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003472 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003473 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003474 return status;
3475}
3476
3477/* Main entry point for dumpstate binary. */
3478int run_main(int argc, char* argv[]) {
3479 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003480
3481 switch (status) {
3482 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003483 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003484 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003485 ShowUsage();
3486 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003487 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003488 fprintf(stderr, "Invalid combination of args\n");
3489 ShowUsage();
3490 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003491 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003492 FALLTHROUGH_INTENDED;
3493 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3494 FALLTHROUGH_INTENDED;
3495 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003496 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003497 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003498}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003499
3500// TODO(111441001): Default DumpOptions to sensible values.
3501Dumpstate::Dumpstate(const std::string& version)
3502 : pid_(getpid()),
3503 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003504 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003505 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003506 now_(time(nullptr)),
3507 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003508}
3509
3510Dumpstate& Dumpstate::GetInstance() {
3511 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3512 return singleton_;
3513}
3514
Rhed Jao5377d792020-07-16 17:37:39 +08003515DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3516 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3517 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003518 if (!title_.empty()) {
3519 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003520 if (title_.find("SHOW MAP") == std::string::npos) {
3521 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3522 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003523 }
3524}
3525
3526DurationReporter::~DurationReporter() {
3527 if (!title_.empty()) {
3528 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003529 if (elapsed >= .5f || verbose_) {
3530 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003531 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003532 if (!logcat_only_) {
3533 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003534 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3535 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003536 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003537 if (title_.find("SHOW MAP") == std::string::npos) {
3538 ATRACE_ASYNC_END(title_.c_str(), 0);
3539 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003540 }
3541}
3542
3543const int32_t Progress::kDefaultMax = 5000;
3544
3545Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3546}
3547
3548Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3549 : Progress(initial_max, growth_factor, "") {
3550 progress_ = progress;
3551}
3552
3553Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3554 : initial_max_(initial_max),
3555 progress_(0),
3556 max_(initial_max),
3557 growth_factor_(growth_factor),
3558 n_runs_(0),
3559 average_max_(0),
3560 path_(path) {
3561 if (!path_.empty()) {
3562 Load();
3563 }
3564}
3565
3566void Progress::Load() {
3567 MYLOGD("Loading stats from %s\n", path_.c_str());
3568 std::string content;
3569 if (!android::base::ReadFileToString(path_, &content)) {
3570 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3571 return;
3572 }
3573 if (content.empty()) {
3574 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3575 return;
3576 }
3577 std::vector<std::string> lines = android::base::Split(content, "\n");
3578
3579 if (lines.size() < 1) {
3580 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3581 (int)lines.size(), max_);
3582 return;
3583 }
3584 char* ptr;
3585 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3586 average_max_ = strtol(ptr, nullptr, 10);
3587 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3588 average_max_ > STATS_MAX_AVERAGE) {
3589 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3590 initial_max_ = Progress::kDefaultMax;
3591 } else {
3592 initial_max_ = average_max_;
3593 }
3594 max_ = initial_max_;
3595
3596 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3597}
3598
3599void Progress::Save() {
3600 int32_t total = n_runs_ * average_max_ + progress_;
3601 int32_t runs = n_runs_ + 1;
3602 int32_t average = floor(((float)total) / runs);
3603 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3604 path_.c_str());
3605 if (path_.empty()) {
3606 return;
3607 }
3608
3609 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3610 if (!android::base::WriteStringToFile(content, path_)) {
3611 MYLOGE("Could not save stats on %s\n", path_.c_str());
3612 }
3613}
3614
3615int32_t Progress::Get() const {
3616 return progress_;
3617}
3618
3619bool Progress::Inc(int32_t delta_sec) {
3620 bool changed = false;
3621 if (delta_sec >= 0) {
3622 progress_ += delta_sec;
3623 if (progress_ > max_) {
3624 int32_t old_max = max_;
3625 max_ = floor((float)progress_ * growth_factor_);
3626 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3627 changed = true;
3628 }
3629 }
3630 return changed;
3631}
3632
3633int32_t Progress::GetMax() const {
3634 return max_;
3635}
3636
3637int32_t Progress::GetInitialMax() const {
3638 return initial_max_;
3639}
3640
3641void Progress::Dump(int fd, const std::string& prefix) const {
3642 const char* pr = prefix.c_str();
3643 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3644 dprintf(fd, "%smax: %d\n", pr, max_);
3645 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3646 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3647 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3648 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3649 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3650}
3651
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003652std::string Dumpstate::GetPath(const std::string& suffix) const {
3653 return GetPath(bugreport_internal_dir_, suffix);
3654}
3655
3656std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3657 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3658 name_.c_str(), suffix.c_str());
3659}
3660
3661void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3662 progress_ = std::move(progress);
3663}
3664
3665void for_each_userid(void (*func)(int), const char *header) {
3666 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3667 "for_each_userid(%s)", header);
3668 DurationReporter duration_reporter(title);
3669 if (PropertiesHelper::IsDryRun()) return;
3670
3671 DIR *d;
3672 struct dirent *de;
3673
3674 if (header) printf("\n------ %s ------\n", header);
3675 func(0);
3676
3677 if (!(d = opendir("/data/system/users"))) {
3678 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3679 return;
3680 }
3681
3682 while ((de = readdir(d))) {
3683 int userid;
3684 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3685 continue;
3686 }
3687 func(userid);
3688 }
3689
3690 closedir(d);
3691}
3692
3693static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3694 DIR *d;
3695 struct dirent *de;
3696
3697 if (!(d = opendir("/proc"))) {
3698 printf("Failed to open /proc (%s)\n", strerror(errno));
3699 return;
3700 }
3701
3702 if (header) printf("\n------ %s ------\n", header);
3703 while ((de = readdir(d))) {
3704 if (ds.IsUserConsentDenied()) {
3705 MYLOGE(
3706 "Returning early because user denied consent to share bugreport with calling app.");
3707 closedir(d);
3708 return;
3709 }
3710 int pid;
3711 int fd;
3712 char cmdpath[255];
3713 char cmdline[255];
3714
3715 if (!(pid = atoi(de->d_name))) {
3716 continue;
3717 }
3718
3719 memset(cmdline, 0, sizeof(cmdline));
3720
3721 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3722 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3723 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3724 close(fd);
3725 if (cmdline[0]) {
3726 helper(pid, cmdline, arg);
3727 continue;
3728 }
3729 }
3730
3731 // if no cmdline, a kernel thread has comm
3732 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3733 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3734 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3735 close(fd);
3736 if (cmdline[1]) {
3737 cmdline[0] = '[';
3738 size_t len = strcspn(cmdline, "\f\b\r\n");
3739 cmdline[len] = ']';
3740 cmdline[len+1] = '\0';
3741 }
3742 }
3743 if (!cmdline[0]) {
3744 strcpy(cmdline, "N/A");
3745 }
3746 helper(pid, cmdline, arg);
3747 }
3748
3749 closedir(d);
3750}
3751
3752static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3753 for_each_pid_func *func = (for_each_pid_func*) arg;
3754 func(pid, cmdline);
3755}
3756
3757void for_each_pid(for_each_pid_func func, const char *header) {
3758 std::string title = header == nullptr ? "for_each_pid"
3759 : android::base::StringPrintf("for_each_pid(%s)", header);
3760 DurationReporter duration_reporter(title);
3761 if (PropertiesHelper::IsDryRun()) return;
3762
3763 __for_each_pid(for_each_pid_helper, header, (void *) func);
3764}
3765
3766static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3767 DIR *d;
3768 struct dirent *de;
3769 char taskpath[255];
3770 for_each_tid_func *func = (for_each_tid_func *) arg;
3771
3772 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3773
3774 if (!(d = opendir(taskpath))) {
3775 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3776 return;
3777 }
3778
3779 func(pid, pid, cmdline);
3780
3781 while ((de = readdir(d))) {
3782 if (ds.IsUserConsentDenied()) {
3783 MYLOGE(
3784 "Returning early because user denied consent to share bugreport with calling app.");
3785 closedir(d);
3786 return;
3787 }
3788 int tid;
3789 int fd;
3790 char commpath[255];
3791 char comm[255];
3792
3793 if (!(tid = atoi(de->d_name))) {
3794 continue;
3795 }
3796
3797 if (tid == pid)
3798 continue;
3799
3800 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3801 memset(comm, 0, sizeof(comm));
3802 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3803 strcpy(comm, "N/A");
3804 } else {
3805 char *c;
3806 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3807 close(fd);
3808
3809 c = strrchr(comm, '\n');
3810 if (c) {
3811 *c = '\0';
3812 }
3813 }
3814 func(pid, tid, comm);
3815 }
3816
3817 closedir(d);
3818}
3819
3820void for_each_tid(for_each_tid_func func, const char *header) {
3821 std::string title = header == nullptr ? "for_each_tid"
3822 : android::base::StringPrintf("for_each_tid(%s)", header);
3823 DurationReporter duration_reporter(title);
3824
3825 if (PropertiesHelper::IsDryRun()) return;
3826
3827 __for_each_pid(for_each_tid_helper, header, (void *) func);
3828}
3829
3830void show_wchan(int pid, int tid, const char *name) {
3831 if (PropertiesHelper::IsDryRun()) return;
3832
3833 char path[255];
3834 char buffer[255];
3835 int fd, ret, save_errno;
3836 char name_buffer[255];
3837
3838 memset(buffer, 0, sizeof(buffer));
3839
3840 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3841 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3842 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3843 return;
3844 }
3845
3846 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3847 save_errno = errno;
3848 close(fd);
3849
3850 if (ret < 0) {
3851 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3852 return;
3853 }
3854
3855 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3856 pid == tid ? 0 : 3, "", name);
3857
3858 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3859
3860 return;
3861}
3862
3863// print time in centiseconds
3864static void snprcent(char *buffer, size_t len, size_t spc,
3865 unsigned long long time) {
3866 static long hz; // cache discovered hz
3867
3868 if (hz <= 0) {
3869 hz = sysconf(_SC_CLK_TCK);
3870 if (hz <= 0) {
3871 hz = 1000;
3872 }
3873 }
3874
3875 // convert to centiseconds
3876 time = (time * 100 + (hz / 2)) / hz;
3877
3878 char str[16];
3879
3880 snprintf(str, sizeof(str), " %llu.%02u",
3881 time / 100, (unsigned)(time % 100));
3882 size_t offset = strlen(buffer);
3883 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3884 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3885}
3886
3887// print permille as a percent
3888static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3889 char str[16];
3890
3891 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3892 size_t offset = strlen(buffer);
3893 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3894 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3895}
3896
3897void show_showtime(int pid, const char *name) {
3898 if (PropertiesHelper::IsDryRun()) return;
3899
3900 char path[255];
3901 char buffer[1023];
3902 int fd, ret, save_errno;
3903
3904 memset(buffer, 0, sizeof(buffer));
3905
3906 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3907 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3908 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3909 return;
3910 }
3911
3912 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3913 save_errno = errno;
3914 close(fd);
3915
3916 if (ret < 0) {
3917 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3918 return;
3919 }
3920
3921 // field 14 is utime
3922 // field 15 is stime
3923 // field 42 is iotime
3924 unsigned long long utime = 0, stime = 0, iotime = 0;
3925 if (sscanf(buffer,
3926 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3927 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3928 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3929 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3930 &utime, &stime, &iotime) != 3) {
3931 return;
3932 }
3933
3934 unsigned long long total = utime + stime;
3935 if (!total) {
3936 return;
3937 }
3938
3939 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3940 if (permille > 1000) {
3941 permille = 1000;
3942 }
3943
3944 // try to beautify and stabilize columns at <80 characters
3945 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3946 if ((name[0] != '[') || utime) {
3947 snprcent(buffer, sizeof(buffer), 57, utime);
3948 }
3949 snprcent(buffer, sizeof(buffer), 65, stime);
3950 if ((name[0] != '[') || iotime) {
3951 snprcent(buffer, sizeof(buffer), 73, iotime);
3952 }
3953 if (iotime) {
3954 snprdec(buffer, sizeof(buffer), 79, permille);
3955 }
3956 puts(buffer); // adds a trailing newline
3957
3958 return;
3959}
3960
3961void do_dmesg() {
3962 const char *title = "KERNEL LOG (dmesg)";
3963 DurationReporter duration_reporter(title);
3964 printf("------ %s ------\n", title);
3965
3966 if (PropertiesHelper::IsDryRun()) return;
3967
3968 /* Get size of kernel buffer */
3969 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3970 if (size <= 0) {
3971 printf("Unexpected klogctl return value: %d\n\n", size);
3972 return;
3973 }
3974 char *buf = (char *) malloc(size + 1);
3975 if (buf == nullptr) {
3976 printf("memory allocation failed\n\n");
3977 return;
3978 }
3979 int retval = klogctl(KLOG_READ_ALL, buf, size);
3980 if (retval < 0) {
3981 printf("klogctl failure\n\n");
3982 free(buf);
3983 return;
3984 }
3985 buf[retval] = '\0';
3986 printf("%s\n\n", buf);
3987 free(buf);
3988 return;
3989}
3990
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003991int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3992 DurationReporter duration_reporter(title);
3993
3994 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3995
3996 UpdateProgress(WEIGHT_FILE);
3997
3998 return status;
3999}
4000
4001int read_file_as_long(const char *path, long int *output) {
4002 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4003 if (fd < 0) {
4004 int err = errno;
4005 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4006 return -1;
4007 }
4008 char buffer[50];
4009 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4010 if (bytes_read == -1) {
4011 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4012 return -2;
4013 }
4014 if (bytes_read == 0) {
4015 MYLOGE("File %s is empty\n", path);
4016 return -3;
4017 }
4018 *output = atoi(buffer);
4019 return 0;
4020}
4021
4022/* calls skip to gate calling dump_from_fd recursively
4023 * in the specified directory. dump_from_fd defaults to
4024 * dump_file_from_fd above when set to NULL. skip defaults
4025 * to false when set to NULL. dump_from_fd will always be
4026 * called with title NULL.
4027 */
4028int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4029 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4030 DurationReporter duration_reporter(title);
4031 DIR *dirp;
4032 struct dirent *d;
4033 char *newpath = nullptr;
4034 const char *slash = "/";
4035 int retval = 0;
4036
4037 if (!title.empty()) {
4038 printf("------ %s (%s) ------\n", title.c_str(), dir);
4039 }
4040 if (PropertiesHelper::IsDryRun()) return 0;
4041
4042 if (dir[strlen(dir) - 1] == '/') {
4043 ++slash;
4044 }
4045 dirp = opendir(dir);
4046 if (dirp == nullptr) {
4047 retval = -errno;
4048 MYLOGE("%s: %s\n", dir, strerror(errno));
4049 return retval;
4050 }
4051
4052 if (!dump_from_fd) {
4053 dump_from_fd = dump_file_from_fd;
4054 }
4055 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4056 if ((d->d_name[0] == '.')
4057 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4058 || (d->d_name[1] == '\0'))) {
4059 continue;
4060 }
4061 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4062 (d->d_type == DT_DIR) ? "/" : "");
4063 if (!newpath) {
4064 retval = -errno;
4065 continue;
4066 }
4067 if (skip && (*skip)(newpath)) {
4068 continue;
4069 }
4070 if (d->d_type == DT_DIR) {
4071 int ret = dump_files("", newpath, skip, dump_from_fd);
4072 if (ret < 0) {
4073 retval = ret;
4074 }
4075 continue;
4076 }
4077 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4078 if (fd.get() < 0) {
4079 retval = -1;
4080 printf("*** %s: %s\n", newpath, strerror(errno));
4081 continue;
4082 }
4083 (*dump_from_fd)(nullptr, newpath, fd.get());
4084 }
4085 closedir(dirp);
4086 if (!title.empty()) {
4087 printf("\n");
4088 }
4089 return retval;
4090}
4091
4092/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4093 * it's possible to avoid issues where opening the file itself can get
4094 * stuck.
4095 */
4096int dump_file_from_fd(const char *title, const char *path, int fd) {
4097 if (PropertiesHelper::IsDryRun()) return 0;
4098
4099 int flags = fcntl(fd, F_GETFL);
4100 if (flags == -1) {
4101 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4102 return -1;
4103 } else if (!(flags & O_NONBLOCK)) {
4104 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4105 return -1;
4106 }
4107 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4108}
4109
4110int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004111 const CommandOptions& options, bool verbose_duration, int out_fd) {
4112 DurationReporter duration_reporter(title, false /* logcat_only */,
4113 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004114
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004115 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004116
4117 /* TODO: for now we're simplifying the progress calculation by using the
4118 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4119 * where its weight should be much higher proportionally to its timeout.
4120 * Ideally, it should use a options.EstimatedDuration() instead...*/
4121 UpdateProgress(options.Timeout());
4122
4123 return status;
4124}
4125
4126void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004127 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004128 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4129 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4130 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004131 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004132}
4133
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004134static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004135 int s = android_get_control_socket(service);
4136 if (s < 0) {
4137 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4138 return -1;
4139 }
4140 fcntl(s, F_SETFD, FD_CLOEXEC);
4141
4142 // Set backlog to 0 to make sure that queue size will be minimum.
4143 // In Linux, because the minimum queue will be 1, connect() will be blocked
4144 // if the other clients already called connect() and the connection request was not accepted.
4145 if (listen(s, 0) < 0) {
4146 MYLOGE("listen(control socket): %s\n", strerror(errno));
4147 return -1;
4148 }
4149
4150 struct sockaddr addr;
4151 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004152 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004153
4154 // Close socket just after accept(), to make sure that connect() by client will get error
4155 // when the socket is used by the other services.
4156 // There is still a race condition possibility between accept and close, but there is no way
4157 // to close-on-accept atomically.
4158 // See detail; b/123306389#comment25
4159 close(s);
4160
4161 if (fd < 0) {
4162 MYLOGE("accept(control socket): %s\n", strerror(errno));
4163 return -1;
4164 }
4165
4166 return fd;
4167}
4168
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004169// TODO: should call is_valid_output_file and/or be merged into it.
4170void create_parent_dirs(const char *path) {
4171 char *chp = const_cast<char *> (path);
4172
4173 /* skip initial slash */
4174 if (chp[0] == '/')
4175 chp++;
4176
4177 /* create leading directories, if necessary */
4178 struct stat dir_stat;
4179 while (chp && chp[0]) {
4180 chp = strchr(chp, '/');
4181 if (chp) {
4182 *chp = 0;
4183 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4184 MYLOGI("Creating directory %s\n", path);
4185 if (mkdir(path, 0770)) { /* drwxrwx--- */
4186 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4187 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4188 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4189 }
4190 }
4191 *chp++ = '/';
4192 }
4193 }
4194}
4195
4196bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4197 create_parent_dirs(path);
4198
4199 int fd = TEMP_FAILURE_RETRY(open(path,
4200 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4201 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4202 if (fd < 0) {
4203 MYLOGE("%s: %s\n", path, strerror(errno));
4204 return false;
4205 }
4206
4207 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4208 close(fd);
4209 return true;
4210}
4211
4212bool redirect_to_file(FILE* redirect, char* path) {
4213 return _redirect_to_file(redirect, path, O_TRUNC);
4214}
4215
4216bool redirect_to_existing_file(FILE* redirect, char* path) {
4217 return _redirect_to_file(redirect, path, O_APPEND);
4218}
4219
4220void dump_route_tables() {
4221 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4222 if (PropertiesHelper::IsDryRun()) return;
4223 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4224 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4225 FILE* fp = fopen(RT_TABLES_PATH, "re");
4226 if (!fp) {
4227 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4228 return;
4229 }
4230 char table[16];
4231 // Each line has an integer (the table number), a space, and a string (the table name). We only
4232 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4233 // Add a fixed max limit so this doesn't go awry.
4234 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4235 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4236 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4237 }
4238 fclose(fp);
4239}
4240
Li Li830179f2022-01-04 12:53:29 -08004241void dump_frozen_cgroupfs(const char *dir, int level,
4242 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4243 DIR *dirp;
4244 struct dirent *d;
4245 char *newpath = nullptr;
4246
4247 dirp = opendir(dir);
4248 if (dirp == nullptr) {
4249 MYLOGE("%s: %s\n", dir, strerror(errno));
4250 return;
4251 }
4252
4253 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4254 if ((d->d_name[0] == '.')
4255 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4256 || (d->d_name[1] == '\0'))) {
4257 continue;
4258 }
4259 if (d->d_type == DT_DIR) {
4260 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4261 if (!newpath) {
4262 continue;
4263 }
4264 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4265 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4266 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4267 char *freezer = nullptr;
4268 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4269 if (freezer) {
4270 FILE* fp = fopen(freezer, "r");
4271 if (fp != NULL) {
4272 int frozen;
4273 fscanf(fp, "%d", &frozen);
4274 if (frozen > 0) {
4275 dump_files("", newpath, skip_none, dump_from_fd);
4276 }
4277 fclose(fp);
4278 }
4279 free(freezer);
4280 }
4281 }
4282 }
4283 }
4284 closedir(dirp);
4285}
4286
4287void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004288 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4289 DurationReporter duration_reporter("FROZEN CGROUPFS");
4290 if (PropertiesHelper::IsDryRun()) return;
4291 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4292}
4293
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004294void Dumpstate::UpdateProgress(int32_t delta_sec) {
4295 if (progress_ == nullptr) {
4296 MYLOGE("UpdateProgress: progress_ not set\n");
4297 return;
4298 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004299 // This function updates progress related members of the dumpstate and reports
4300 // progress percentage to the bugreport client. Since it could be called by
4301 // different dump tasks at the same time if the parallel run is enabled, a
4302 // mutex lock is necessary here to synchronize the call.
4303 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004304
4305 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004306 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004307
4308 // ...but only notifiy listeners when necessary.
4309 if (!options_->do_progress_updates) return;
4310
4311 int progress = progress_->Get();
4312 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004313 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004314
Nandana Dutt402a8392019-06-14 14:25:13 +01004315 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004316 return;
4317 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004318 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004319
4320 if (control_socket_fd_ >= 0) {
4321 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4322 fsync(control_socket_fd_);
4323 }
4324
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004325 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004326 if (percent % 10 == 0) {
4327 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004328 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004329 } else {
4330 // stderr is ignored on normal invocations, but useful when calling
4331 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004332 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004333 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004334
4335 listener_->onProgress(percent);
4336 }
4337}
4338
4339void Dumpstate::TakeScreenshot(const std::string& path) {
4340 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4341 int status =
4342 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4343 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4344 if (status == 0) {
4345 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4346 } else {
4347 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4348 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004349 if (listener_ != nullptr) {
4350 // Show a visual indication to indicate screenshot is taken via
4351 // IDumpstateListener.onScreenshotTaken()
4352 listener_->onScreenshotTaken(status == 0);
4353 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004354}
4355
4356bool is_dir(const char* pathname) {
4357 struct stat info;
4358 if (stat(pathname, &info) == -1) {
4359 return false;
4360 }
4361 return S_ISDIR(info.st_mode);
4362}
4363
4364time_t get_mtime(int fd, time_t default_mtime) {
4365 struct stat info;
4366 if (fstat(fd, &info) == -1) {
4367 return default_mtime;
4368 }
4369 return info.st_mtime;
4370}