blob: 6bd4dea5eceb4548b2869dc86a6a8e9bd24edc03 [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080077#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070078#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010079#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000080#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000081#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000083#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010084#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080085#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010086#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070087#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070088#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070089#include <private/android_filesystem_config.h>
90#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080091#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070092#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000093#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080094#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070095#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070096#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080097
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000098namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
99namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
100namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
101
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using ::std::literals::chrono_literals::operator""ms;
103using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800104using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800105
Felipe Leme47e9be22016-12-21 15:37:07 -0800106// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800107using android::defaultServiceManager;
108using android::Dumpsys;
109using android::INVALID_OPERATION;
110using android::IServiceManager;
111using android::OK;
112using android::sp;
113using android::status_t;
114using android::String16;
115using android::String8;
116using android::TIMED_OUT;
117using android::UNKNOWN_ERROR;
118using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000119using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000120using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121using android::os::dumpstate::CommandOptions;
122using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800123using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800124using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800125using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800126using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800127
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100128// Keep in sync with
129// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
130static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
131
132/* Most simple commands have 10 as timeout, so 5 is a good estimate */
133static const int32_t WEIGHT_FILE = 5;
134
135// TODO: temporary variables and functions used during C++ refactoring
136static Dumpstate& ds = Dumpstate::GetInstance();
137static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100138 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800139 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
140 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100141}
142
143// Reasonable value for max stats.
144static const int STATS_MAX_N_RUNS = 1000;
145static const long STATS_MAX_AVERAGE = 100000;
146
147CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
148
Nandana Duttd2f5f082019-01-18 17:13:52 +0000149typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
150
Colin Crossf45fa6b2012-03-26 12:38:26 -0700151/* read before root is shed */
152static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700153static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000154static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800155// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
156// it's often the case that they time out far too quickly for consent with such a hefty dialog for
157// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
158// roughly match full reports' durations.
159static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700160
Felipe Leme1d486fe2016-10-14 18:06:47 -0700161// TODO: variables and functions below should be part of dumpstate object
162
Felipe Leme635ca312016-01-05 14:23:02 -0800163static std::set<std::string> mount_points;
164void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800165
Todd Poynor2a83daa2013-11-22 15:44:22 -0800166#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700167#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700168#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169
Felipe Lemee82a27d2016-01-05 13:35:44 -0800170#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700171#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700172#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700173#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700174#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800175#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100176#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
177#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800178#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900179#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800180#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700181#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800182#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900183#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700184#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000185#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700186#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200187#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700188#define DROPBOX_DIR "/data/system/dropbox"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700189
Narayan Kamath8f788292017-05-25 13:20:39 +0100190// TODO(narayan): Since this information has to be kept in sync
191// with tombstoned, we should just put it in a common header.
192//
193// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100194static const std::string TOMBSTONE_DIR = "/data/tombstones/";
195static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
196static const std::string ANR_DIR = "/data/anr/";
197static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800198static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
199static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000202
Nandana Dutt5c390032019-03-12 10:52:56 +0000203#define RETURN_IF_USER_DENIED_CONSENT() \
204 if (ds.IsUserConsentDenied()) { \
205 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
206 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
207 }
208
209// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
210// if consent is found to be denied.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 func_ptr(__VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao5377d792020-07-16 17:37:39 +0800216// Runs func_ptr, and logs a duration report after it's finished.
217#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
218 { \
219 DurationReporter duration_reporter_in_macro(log_title); \
220 func_ptr(__VA_ARGS__); \
221 }
222
223// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
224// is output after a slow function is finished.
225#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
226 RETURN_IF_USER_DENIED_CONSENT(); \
227 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
228 RETURN_IF_USER_DENIED_CONSENT();
229
Chris Morinbc223142022-02-04 14:17:11 -0800230#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800231 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800232 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800233 RETURN_IF_USER_DENIED_CONSENT();
234
Sahana Raof35ed432019-07-12 10:47:52 +0100235static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
236
Rhed Jao5377d792020-07-16 17:37:39 +0800237// Names of parallel tasks, they are used for the DumpPool to identify the dump
238// task and the log title of the duration report.
239static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800240static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800241static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800242static const std::string DUMP_HALS_TASK = "DUMP HALS";
243static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800244static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800245
Nandana Dutt979388e2018-11-30 16:48:55 +0000246namespace android {
247namespace os {
248namespace {
249
250static int Open(std::string path, int flags, mode_t mode = 0) {
251 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
252 if (fd == -1) {
253 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
254 }
255 return fd;
256}
257
mhasank2d75c442020-06-11 15:05:25 -0700258static int OpenForWrite(std::string path) {
259 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
260 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
261}
Nandana Dutt979388e2018-11-30 16:48:55 +0000262
263static int OpenForRead(std::string path) {
264 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
265}
266
267bool CopyFile(int in_fd, int out_fd) {
268 char buf[4096];
269 ssize_t byte_count;
270 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
271 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
272 return false;
273 }
274 }
275 return (byte_count != -1);
276}
277
278static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000279 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000280
281 // Obtain a handle to the source file.
282 android::base::unique_fd in_fd(OpenForRead(input_file));
283 if (out_fd != -1 && in_fd.get() != -1) {
284 if (CopyFile(in_fd.get(), out_fd)) {
285 return true;
286 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000287 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000288 }
289 return false;
290}
291
Nandana Duttd2f5f082019-01-18 17:13:52 +0000292static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000293 if (file.empty()) {
294 return false;
295 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000296 if (unlink(file.c_str())) {
297 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000298 return false;
299 }
300 return true;
301}
Nandana Dutt979388e2018-11-30 16:48:55 +0000302
Nikita Ioffea325a572019-05-16 19:49:47 +0100303int64_t GetModuleMetadataVersion() {
304 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
305 if (binder == nullptr) {
306 MYLOGE("Failed to retrieve package_native service");
307 return 0L;
308 }
309 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
310 std::string package_name;
311 auto status = package_service->getModuleMetadataPackageName(&package_name);
312 if (!status.isOk()) {
313 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
314 return 0L;
315 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100316 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100317 int64_t version_code;
318 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
319 &version_code);
320 if (!status.isOk()) {
321 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
322 return 0L;
323 }
324 return version_code;
325}
326
mhasank2d75c442020-06-11 15:05:25 -0700327static bool PathExists(const std::string& path) {
328 struct stat sb;
329 return stat(path.c_str(), &sb) == 0;
330}
331
332static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
333 if (input_file == output_file) {
334 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
335 output_file.c_str());
336 return false;
337 }
338 else if (PathExists(output_file)) {
339 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
340 return false;
341 }
342
343 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
344 android::base::unique_fd out_fd(OpenForWrite(output_file));
345 return CopyFileToFd(input_file, out_fd.get());
346}
347
Nandana Dutt979388e2018-11-30 16:48:55 +0000348} // namespace
349} // namespace os
350} // namespace android
351
Felipe Leme678727a2016-09-21 17:22:11 -0700352static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800353 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800354 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
355 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
356}
357static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
358 int out_fd) {
359 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700360}
361static int DumpFile(const std::string& title, const std::string& path) {
362 return ds.DumpFile(title, path);
363}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800364
Felipe Lemee844a9d2016-09-21 15:01:39 -0700365// Relative directory (inside the zip) for all files copied as-is into the bugreport.
366static const std::string ZIP_ROOT_DIR = "FS";
367
Vishnu Naire97d6122018-01-18 13:58:56 -0800368static const std::string kProtoPath = "proto/";
369static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700370static const std::string kDumpstateBoardFiles[] = {
371 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700372 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700373};
374static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
375
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700376static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700377static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700378
Felipe Lemef0292972016-11-22 13:57:05 -0800379static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
380
Narayan Kamath8f788292017-05-25 13:20:39 +0100381/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100382 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800383 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800384 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100385 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800387 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100388 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100389
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700390 if (dump_dir == nullptr) {
391 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700392 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700393 }
394
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700395 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 struct dirent* entry = nullptr;
397 while ((entry = readdir(dump_dir.get()))) {
398 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100399 continue;
400 }
401
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 const std::string base_name(entry->d_name);
403 if (base_name.find(file_prefix) != 0) {
404 continue;
405 }
406
407 const std::string abs_path = dir_path + base_name;
408 android::base::unique_fd fd(
409 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
410 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700411 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 break;
413 }
414
415 struct stat st = {};
416 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700417 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100418 continue;
419 }
420
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700421 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700422 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800423 if (!dump_data.empty()) {
424 std::sort(dump_data.begin(), dump_data.end(),
425 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
426 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100429}
430
Narayan Kamathbd863722017-06-01 18:50:12 +0100431static bool AddDumps(const std::vector<DumpData>::const_iterator start,
432 const std::vector<DumpData>::const_iterator end,
433 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100435 for (auto it = start; it != end; ++it) {
436 const std::string& name = it->name;
437 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100438 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100439
440 // Seek to the beginning of the file before dumping any data. A given
441 // DumpData entry might be dumped multiple times in the report.
442 //
443 // For example, the most recent ANR entry is dumped to the body of the
444 // main entry and it also shows up as a separate entry in the bugreport
445 // ZIP file.
446 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
447 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
448 strerror(errno));
449 }
450
Chris Morinc2cba7a2022-02-01 17:06:50 -0800451 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800452 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100453 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455 } else {
456 dump_file_from_fd(type_name, name.c_str(), fd);
457 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100458 }
459
460 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700461}
462
Felipe Leme635ca312016-01-05 14:23:02 -0800463// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700464void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char path[PATH_MAX];
466
467 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
468 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700469 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800470 char linkname[PATH_MAX];
471 ssize_t r = readlink(path, linkname, PATH_MAX);
472 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800473 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800474 return;
475 }
476 linkname[r] = '\0';
477
478 if (mount_points.find(linkname) == mount_points.end()) {
479 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700480 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700481 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800482 mount_points.insert(linkname);
483 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800484 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800485 }
486 }
487}
488
489void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700490 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800491 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800492 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700493 for_each_pid(do_mountinfo, nullptr);
494 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800495}
496
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700497static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
498{
499 DIR *d;
500 struct dirent *de;
501 char path[PATH_MAX];
502
503 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700504 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700505 return;
506 }
507
508 while ((de = readdir(d))) {
509 if (de->d_type != DT_LNK) {
510 continue;
511 }
512 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700513 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700514 }
515
516 closedir(d);
517}
518
Mark Salyzyn326842f2015-04-30 09:49:41 -0700519static bool skip_not_stat(const char *path) {
520 static const char stat[] = "/stat";
521 size_t len = strlen(path);
522 if (path[len - 1] == '/') { /* Directory? */
523 return false;
524 }
525 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
526}
527
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700528static bool skip_wtf_strictmode(const char *path) {
529 if (strstr(path, "_wtf")) {
530 return true;
531 } else if (strstr(path, "_strictmode")) {
532 return true;
533 }
534 return false;
535}
536
Felipe Leme4c2d6632016-09-28 14:32:00 -0700537static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800538 return false;
539}
540
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700541unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800543//
544// stat offsets
545// Name units description
546// ---- ----- -----------
547// read I/Os requests number of read I/Os processed
548#define __STAT_READ_IOS 0
549// read merges requests number of read I/Os merged with in-queue I/O
550#define __STAT_READ_MERGES 1
551// read sectors sectors number of sectors read
552#define __STAT_READ_SECTORS 2
553// read ticks milliseconds total wait time for read requests
554#define __STAT_READ_TICKS 3
555// write I/Os requests number of write I/Os processed
556#define __STAT_WRITE_IOS 4
557// write merges requests number of write I/Os merged with in-queue I/O
558#define __STAT_WRITE_MERGES 5
559// write sectors sectors number of sectors written
560#define __STAT_WRITE_SECTORS 6
561// write ticks milliseconds total wait time for write requests
562#define __STAT_WRITE_TICKS 7
563// in_flight requests number of I/Os currently in flight
564#define __STAT_IN_FLIGHT 8
565// io_ticks milliseconds total time this block device has been active
566#define __STAT_IO_TICKS 9
567// time_in_queue milliseconds total wait time for all requests
568#define __STAT_IN_QUEUE 10
569#define __STAT_NUMBER_FIELD 11
570//
571// read I/Os, write I/Os
572// =====================
573//
574// These values increment when an I/O request completes.
575//
576// read merges, write merges
577// =========================
578//
579// These values increment when an I/O request is merged with an
580// already-queued I/O request.
581//
582// read sectors, write sectors
583// ===========================
584//
585// These values count the number of sectors read from or written to this
586// block device. The "sectors" in question are the standard UNIX 512-byte
587// sectors, not any device- or filesystem-specific block size. The
588// counters are incremented when the I/O completes.
589#define SECTOR_SIZE 512
590//
591// read ticks, write ticks
592// =======================
593//
594// These values count the number of milliseconds that I/O requests have
595// waited on this block device. If there are multiple I/O requests waiting,
596// these values will increase at a rate greater than 1000/second; for
597// example, if 60 read requests wait for an average of 30 ms, the read_ticks
598// field will increase by 60*30 = 1800.
599//
600// in_flight
601// =========
602//
603// This value counts the number of I/O requests that have been issued to
604// the device driver but have not yet completed. It does not include I/O
605// requests that are in the queue but not yet issued to the device driver.
606//
607// io_ticks
608// ========
609//
610// This value counts the number of milliseconds during which the device has
611// had I/O requests queued.
612//
613// time_in_queue
614// =============
615//
616// This value counts the number of milliseconds that I/O requests have waited
617// on this block device. If there are multiple I/O requests waiting, this
618// value will increase as the product of the number of milliseconds times the
619// number of requests waiting (see "read ticks" above for an example).
620#define S_TO_MS 1000
621//
622
Mark Salyzyn326842f2015-04-30 09:49:41 -0700623static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800624 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700626 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700628 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 getline(&buffer, &i, fp);
630 fclose(fp);
631 if (!buffer) {
632 return -errno;
633 }
634 i = strlen(buffer);
635 while ((i > 0) && (buffer[i - 1] == '\n')) {
636 buffer[--i] = '\0';
637 }
638 if (!*buffer) {
639 free(buffer);
640 return 0;
641 }
642 z = true;
643 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800644 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700645 if (fields[i] != 0) {
646 z = false;
647 }
648 }
649 if (z) { /* never accessed */
650 free(buffer);
651 return 0;
652 }
653
Wei Wang509bb5d2017-06-09 14:42:12 -0700654 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
655 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700656 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700657
658 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
659 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
660 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700661 free(buffer);
662
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800663 if (fields[__STAT_IO_TICKS]) {
664 unsigned long read_perf = 0;
665 unsigned long read_ios = 0;
666 if (fields[__STAT_READ_TICKS]) {
667 unsigned long long divisor = fields[__STAT_READ_TICKS]
668 * fields[__STAT_IO_TICKS];
669 read_perf = ((unsigned long long)SECTOR_SIZE
670 * fields[__STAT_READ_SECTORS]
671 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
672 / divisor;
673 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
674 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
675 / divisor;
676 }
677
678 unsigned long write_perf = 0;
679 unsigned long write_ios = 0;
680 if (fields[__STAT_WRITE_TICKS]) {
681 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
682 * fields[__STAT_IO_TICKS];
683 write_perf = ((unsigned long long)SECTOR_SIZE
684 * fields[__STAT_WRITE_SECTORS]
685 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
686 / divisor;
687 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
688 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
689 / divisor;
690 }
691
692 unsigned queue = (fields[__STAT_IN_QUEUE]
693 + (fields[__STAT_IO_TICKS] >> 1))
694 / fields[__STAT_IO_TICKS];
695
696 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700697 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800698 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700699 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800700 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800701 }
702
703 /* bugreport timeout factor adjustment */
704 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
705 worst_write_perf = write_perf;
706 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700707 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700708 return 0;
709}
710
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
712
Tom Cherryf4472f32020-08-05 09:31:17 -0700713// Returns the actual readable size of the given buffer or -1 on error.
714static long logcat_buffer_readable_size(const std::string& buffer) {
715 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
716 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
717 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
718
719 return android_logger_get_log_readable_size(logger);
720}
721
722// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800723static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
724 unsigned long timeout_ms = 0;
725 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700726 long readable_size = logcat_buffer_readable_size(buffer);
727 if (readable_size > 0) {
728 // Engineering margin is ten-fold our guess.
729 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
730 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800731 }
732 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700733}
734
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800735// Opens a socket and returns its file descriptor.
736static int open_socket(const char* service);
737
Nandana Duttd2f5f082019-01-18 17:13:52 +0000738Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
739}
740
741android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
742 std::lock_guard<std::mutex> lock(lock_);
743 result_ = APPROVED;
744 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800745
746 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
747 // consent is granted.
748 if (ds.options_->is_screenshot_copied) {
749 return android::binder::Status::ok();
750 }
751
752 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
753 !ds.do_early_screenshot_) {
754 return android::binder::Status::ok();
755 }
756
757 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
758 ds.options_->screenshot_fd.get());
759 ds.options_->is_screenshot_copied = copy_succeeded;
760 if (copy_succeeded) {
761 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
762 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000763 return android::binder::Status::ok();
764}
765
766android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
767 std::lock_guard<std::mutex> lock(lock_);
768 result_ = DENIED;
769 MYLOGW("User denied consent to share bugreport\n");
770 return android::binder::Status::ok();
771}
772
773UserConsentResult Dumpstate::ConsentCallback::getResult() {
774 std::lock_guard<std::mutex> lock(lock_);
775 return result_;
776}
777
778uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800779 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000780}
781
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700782void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200783 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700784 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
787 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
789 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
790 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200791 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700792 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700793
Felipe Lemed8b94e52016-12-08 10:21:44 -0800794 printf("========================================================\n");
795 printf("== dumpstate: %s\n", date);
796 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700797
Felipe Lemed8b94e52016-12-08 10:21:44 -0800798 printf("\n");
799 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700800 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
802 printf("Bootloader: %s\n", bootloader.c_str());
803 printf("Radio: %s\n", radio.c_str());
804 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100805 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
806 if (module_metadata_version != 0) {
807 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
808 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200809 printf("Android SDK version: %s\n", sdkversion.c_str());
810 printf("SDK extensions: ");
811 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
812 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700813
Felipe Lemed8b94e52016-12-08 10:21:44 -0800814 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800815 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800817 printf("Uptime: ");
818 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
819 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800820 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800821 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
822 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000823 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800824 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800825}
826
Felipe Leme24b66ee2016-06-16 10:55:26 -0700827// List of file extensions that can cause a zip file attachment to be rejected by some email
828// service providers.
829static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
830 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
831 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
832 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
833};
834
Vishnu Naire97d6122018-01-18 13:58:56 -0800835status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
836 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700837 std::string valid_name = entry_name;
838
839 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700840 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700841 if (idx != std::string::npos) {
842 std::string extension = entry_name.substr(idx);
843 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
844 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
845 valid_name = entry_name + ".renamed";
846 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
847 }
848 }
849
Felipe Leme6fe9db62016-02-12 09:04:16 -0800850 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
851 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000852 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
853 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700854 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700855 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700856 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700857 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800858 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800859 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000860 bool finished_entry = false;
861 auto finish_entry = [this, &finished_entry] {
862 if (!finished_entry) {
863 // This should only be called when we're going to return an earlier error,
864 // which would've been logged. This may imply the file is already corrupt
865 // and any further logging from FinishEntry is more likely to mislead than
866 // not.
867 this->zip_writer_->FinishEntry();
868 }
869 };
870 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800871 auto start = std::chrono::steady_clock::now();
872 auto end = start + timeout;
873 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800874
Felipe Leme770410d2016-01-26 17:07:14 -0800875 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800876 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800877 if (timeout.count() > 0) {
878 // lambda to recalculate the timeout.
879 auto time_left_ms = [end]() {
880 auto now = std::chrono::steady_clock::now();
881 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
882 return std::max(diff.count(), 0LL);
883 };
884
885 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
886 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000887 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
888 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800889 return -errno;
890 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000891 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 entry_name.c_str(), strerror(errno), timeout.count());
893 return TIMED_OUT;
894 }
895 }
896
Zach Riggle22200402016-08-18 01:01:24 -0400897 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800898 if (bytes_read == 0) {
899 break;
900 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800901 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800902 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700904 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700906 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800907 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800908 }
909 }
910
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700911 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000912 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700913 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700914 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800915 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916 }
917
Vishnu Naire97d6122018-01-18 13:58:56 -0800918 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800919}
920
Felipe Leme1d486fe2016-10-14 18:06:47 -0700921bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
922 android::base::unique_fd fd(
923 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700924 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800925 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800926 return false;
927 }
928
Vishnu Naire97d6122018-01-18 13:58:56 -0800929 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800930}
931
932/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700933static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800934 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800935}
936
Felipe Leme1d486fe2016-10-14 18:06:47 -0700937void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700938 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800939 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700940 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800941}
942
Felipe Leme1d486fe2016-10-14 18:06:47 -0700943bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800944 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000945 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
946 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700948 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800950 return false;
951 }
952
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700954 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700955 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700956 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800957 return false;
958 }
959
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700961 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700962 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800963 return false;
964 }
965
966 return true;
967}
968
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800969static void DoKmsg() {
970 struct stat st;
971 if (!stat(PSTORE_LAST_KMSG, &st)) {
972 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
973 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
974 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
975 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
976 } else {
977 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
978 DumpFile("LAST KMSG", "/proc/last_kmsg");
979 }
980}
981
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800982static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800983 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800984 RunCommand(
985 "KERNEL LOG",
986 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
987 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
988}
989
Nandana Duttdb379fa2019-10-09 16:54:41 +0100990static void DoSystemLogcat(time_t since) {
991 char since_str[80];
992 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
993
994 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
995 RunCommand("SYSTEM LOG",
996 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
997 since_str},
998 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
999}
1000
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001001static void DoRadioLogcat() {
1002 unsigned long timeout_ms = logcat_timeout({"radio"});
1003 RunCommand(
1004 "RADIO LOG",
1005 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1006 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1007}
1008
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001009static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001010 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001011 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1012 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001013 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001014 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001015 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1016 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001017 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001018 RunCommand(
1019 "EVENT LOG",
1020 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001021 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001022 timeout_ms = logcat_timeout({"stats"});
1023 RunCommand(
1024 "STATS LOG",
1025 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001026 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001027 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001028
1029 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1030
1031 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001032 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1033 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001034}
1035
Mike Ma5c267872019-08-21 11:31:34 -07001036static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001037 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1038 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1039 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1040 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1041 if (fd < 0) {
1042 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1043 return;
1044 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001045 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001046 bool empty = 0 == lseek(fd, 0, SEEK_END);
1047 if (!empty) {
1048 // Use a different name from "incident.proto"
1049 // /proto/incident.proto is reserved for incident service dump
1050 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001051 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1052 path);
1053 } else {
1054 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001055 }
Mike Ma5c267872019-08-21 11:31:34 -07001056}
1057
Aaron Huanga99452a2022-04-27 18:51:16 +08001058static void DumpNetstatsProto() {
1059 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1060 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1061 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1062 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1063 if (fd < 0) {
1064 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1065 return;
1066 }
1067 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1068 CommandOptions::WithTimeout(120).Build());
1069 bool empty = 0 == lseek(fd, 0, SEEK_END);
1070 if (!empty) {
1071 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1072 path);
1073 } else {
1074 unlink(path.c_str());
1075 }
1076}
1077
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001078static void MaybeAddSystemTraceToZip() {
1079 // This function copies into the .zip the system trace that was snapshotted
1080 // by the early call to MaybeSnapshotSystemTrace(), if any background
1081 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001082 if (!ds.has_system_trace_) {
1083 // No background trace was happening at the time dumpstate was invoked.
1084 return;
1085 }
1086 ds.AddZipEntry(
1087 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1088 SYSTEM_TRACE_SNAPSHOT);
1089 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1090}
1091
Sunny Goyal35949782019-11-19 15:54:36 -08001092static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001093 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1094 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1095 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1096 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1097 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1098 if (fd < 0) {
1099 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1100 return;
1101 }
1102 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001103 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001104 bool empty = 0 == lseek(fd, 0, SEEK_END);
1105 if (!empty) {
1106 ds.AddZipEntry("visible_windows.zip", path);
1107 } else {
1108 MYLOGW("Failed to dump visible windows\n");
1109 }
1110 unlink(path.c_str());
1111}
1112
Jayachandran Ca94c7172017-06-10 15:08:12 -07001113static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001114 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1115 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001116 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001117 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001118 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1119 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1120 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1121 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001122}
1123
Woody Lin20767a92022-11-29 15:50:24 +08001124static void DumpShutdownCheckpoints() {
1125 const bool shutdown_checkpoints_dumped = AddDumps(
1126 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1127 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1128 if (!shutdown_checkpoints_dumped) {
1129 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1130 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1131 }
1132}
1133
David Andersond9ba4752018-12-11 18:26:59 -08001134static void DumpDynamicPartitionInfo() {
1135 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1136 return;
1137 }
1138
1139 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001140 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001141}
1142
Chris Morin5a50d482022-02-01 17:41:18 -08001143static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001144 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1145 anr_traces_dir.c_str());
1146
1147 // If we're here, dump_traces_path will always be a temporary file
1148 // (created with mkostemp or similar) that contains dumps taken earlier
1149 // on in the process.
1150 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001151 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1152 dump_traces_path);
1153 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001154
1155 const int ret = unlink(dump_traces_path);
1156 if (ret == -1) {
1157 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1158 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001159 }
1160 }
1161
Narayan Kamathbd863722017-06-01 18:50:12 +01001162 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001163 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001164 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001165 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001166 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001167
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001168 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001169 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001170 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001171 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001172 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1173 }
1174}
1175
1176static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001177 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001178
Chris Morin5a50d482022-02-01 17:41:18 -08001179 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001180
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001181 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1182
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001183 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001184 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001185 int i = 0;
1186 while (true) {
1187 const std::string slow_trace_path =
1188 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1189 if (stat(slow_trace_path.c_str(), &st)) {
1190 // No traces file at this index, done with the files.
1191 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001192 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001193 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1194 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001195 }
1196}
1197
Wei Wang509bb5d2017-06-09 14:42:12 -07001198static void DumpBlockStatFiles() {
1199 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001200
Wei Wang1dc1ef52017-06-12 11:28:37 -07001201 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1202
1203 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001204 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1205 return;
1206 }
1207
1208 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001209 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001210 if ((d->d_name[0] == '.')
1211 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1212 || (d->d_name[1] == '\0'))) {
1213 continue;
1214 }
1215 const std::string new_path =
1216 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1217 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1218 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1219 printf("\n");
1220 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001221 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001222}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001223
1224static void DumpPacketStats() {
1225 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001226}
1227
1228static void DumpIpAddrAndRules() {
1229 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1230 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1231 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1232 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1233 RunCommand("IP RULES", {"ip", "rule", "show"});
1234 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1235}
1236
Nandana Dutt5c390032019-03-12 10:52:56 +00001237static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1238 std::chrono::milliseconds timeout,
1239 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001240 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001241 sp<android::IServiceManager> sm = defaultServiceManager();
1242 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001243 Vector<String16> args;
1244 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1246 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001247 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001248 std::string path(title);
1249 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001250 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001251 if (PropertiesHelper::IsDryRun()) {
1252 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1253 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1254 } else {
1255 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
1256 if (status == OK) {
1257 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1258 std::chrono::duration<double> elapsed_seconds;
1259 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1260 service == String16("meminfo")) {
1261 // Use a longer timeout for meminfo, since 30s is not always enough.
1262 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1263 /* as_proto = */ false, elapsed_seconds,
1264 bytes_written);
1265 } else {
1266 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1267 /* as_proto = */ false, elapsed_seconds,
1268 bytes_written);
1269 }
1270 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1271 bool dump_complete = (status == OK);
1272 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001273 } else {
1274 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1275 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001276 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001277 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001278
1279 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1280 std::chrono::steady_clock::now() - start);
1281 if (elapsed_duration > timeout) {
1282 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1283 elapsed_duration.count());
1284 break;
1285 }
1286 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001287 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001288}
1289
Vishnu Nair64afc022018-02-01 15:29:34 -08001290static void RunDumpsysText(const std::string& title, int priority,
1291 std::chrono::milliseconds timeout,
1292 std::chrono::milliseconds service_timeout) {
1293 DurationReporter duration_reporter(title);
1294 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1295 fsync(STDOUT_FILENO);
1296 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1297}
1298
1299/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001300static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1301 std::chrono::milliseconds timeout,
1302 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001303 DurationReporter duration_reporter(title);
1304 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1305 fsync(STDOUT_FILENO);
1306 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1307 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001308
1309 RETURN_IF_USER_DENIED_CONSENT();
1310
1311 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1312 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001313}
1314
Nandana Dutt5c390032019-03-12 10:52:56 +00001315static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1316 std::chrono::milliseconds timeout,
1317 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001318 sp<android::IServiceManager> sm = defaultServiceManager();
1319 Dumpsys dumpsys(sm.get());
1320 Vector<String16> args;
1321 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1322 DurationReporter duration_reporter(title);
1323
1324 auto start = std::chrono::steady_clock::now();
1325 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1326 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001327 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001328 std::string path(kProtoPath);
1329 path.append(String8(service).c_str());
1330 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1331 path.append("_CRITICAL");
1332 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1333 path.append("_HIGH");
1334 }
1335 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001336 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001337 if (status == OK) {
1338 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1339 bool dumpTerminated = (status == OK);
1340 dumpsys.stopDumpThread(dumpTerminated);
1341 }
1342 ZipWriter::FileEntry file_entry;
1343 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001344
1345 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1346 std::chrono::steady_clock::now() - start);
1347 if (elapsed_duration > timeout) {
1348 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1349 elapsed_duration.count());
1350 break;
1351 }
1352 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001353 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001354}
1355
Nandana Dutta7db6342018-11-21 14:53:34 +00001356// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001357static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001358 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1359 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001360
1361 RETURN_IF_USER_DENIED_CONSENT();
1362
1363 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1364 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001365}
1366
1367// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001368static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001369 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1370 // high priority. Reduce timeout once they are able to dump in a shorter time or
1371 // moved to a parallel task.
1372 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1373 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001374
1375 RETURN_IF_USER_DENIED_CONSENT();
1376
1377 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1378 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001379}
1380
1381// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001382static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001383 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001384
1385 RETURN_IF_USER_DENIED_CONSENT();
1386
1387 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1388 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001389}
1390
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001391/*
1392 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1393 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1394 * if it's not running in the parallel task.
1395 */
1396static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001397 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001398 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1399 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001400
Steven Moreland44cd9482018-01-04 16:24:13 -08001401 using android::hidl::manager::V1_0::IServiceManager;
1402 using android::hardware::defaultServiceManager;
1403
1404 sp<IServiceManager> sm = defaultServiceManager();
1405 if (sm == nullptr) {
1406 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1407 return;
1408 }
1409
1410 auto ret = sm->list([&](const auto& interfaces) {
1411 for (const std::string& interface : interfaces) {
1412 std::string cleanName = interface;
1413 std::replace_if(cleanName.begin(),
1414 cleanName.end(),
1415 [](char c) {
1416 return !isalnum(c) &&
1417 std::string("@-_:.").find(c) == std::string::npos;
1418 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001419 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001420
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001421 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001422 {
1423 auto fd = android::base::unique_fd(
1424 TEMP_FAILURE_RETRY(open(path.c_str(),
1425 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1426 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1427 if (fd < 0) {
1428 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1429 continue;
1430 }
1431 RunCommandToFd(fd,
1432 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001433 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001434 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1435
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001436 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001437 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001438 if (!empty) {
1439 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1440 path);
1441 } else {
1442 unlink(path.c_str());
1443 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001444 }
1445 });
1446
1447 if (!ret.isOk()) {
1448 MYLOGE("Could not list hals from hwservicemanager.\n");
1449 }
1450}
1451
Devin Moore8df81bb2022-06-08 22:47:02 +00001452// Dump all of the files that make up the vendor interface.
1453// See the files listed in dumpFileList() for the latest list of files.
1454static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001455
1456 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1457 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001458 for (const auto vintfFile : vintfFiles) {
1459 struct stat st;
1460 if (stat(vintfFile.c_str(), &st) == 0) {
1461 if (S_ISDIR(st.st_mode)) {
1462 ds.AddDir(vintfFile, true /* recursive */);
1463 } else {
1464 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1465 vintfFile);
1466 }
1467 }
1468 }
1469}
1470
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001471static void DumpExternalFragmentationInfo() {
1472 struct stat st;
1473 if (stat("/proc/buddyinfo", &st) != 0) {
1474 MYLOGE("Unable to dump external fragmentation info\n");
1475 return;
1476 }
1477
1478 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1479 std::ifstream ifs("/proc/buddyinfo");
1480 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1481 for (std::string line; std::getline(ifs, line);) {
1482 std::smatch match_results;
1483 if (std::regex_match(line, match_results, unusable_index_regex)) {
1484 std::stringstream free_pages(std::string{match_results[3]});
1485 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1486 std::istream_iterator<int>());
1487
1488 int total_free_pages = 0;
1489 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1490 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1491 }
1492
1493 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1494 match_results[2].str().c_str());
1495
1496 int usable_free_pages = total_free_pages;
1497 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1498 auto unusable_index = (total_free_pages - usable_free_pages) /
1499 static_cast<double>(total_free_pages);
1500 printf(" %5.3f", unusable_index);
1501 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1502 }
1503
1504 printf("\n");
1505 }
1506 }
1507 printf("\n");
1508}
1509
mhasankd451a472020-05-26 18:02:39 -07001510static void DumpstateLimitedOnly() {
1511 // Trimmed-down version of dumpstate to only include a whitelisted
1512 // set of logs (system log, event log, and system server / system app
1513 // crashes, and networking logs). See b/136273873 and b/138459828
1514 // for context.
1515 DurationReporter duration_reporter("DUMPSTATE");
1516 unsigned long timeout_ms;
1517 // calculate timeout
1518 timeout_ms = logcat_timeout({"main", "system", "crash"});
1519 RunCommand("SYSTEM LOG",
1520 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1521 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1522 timeout_ms = logcat_timeout({"events"});
1523 RunCommand(
1524 "EVENT LOG",
1525 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1526 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1527
1528 printf("========================================================\n");
1529 printf("== Networking Service\n");
1530 printf("========================================================\n");
1531
1532 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1533 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001534 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1535 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001536
1537 printf("========================================================\n");
1538 printf("== Dropbox crashes\n");
1539 printf("========================================================\n");
1540
1541 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1542 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1543
1544 printf("========================================================\n");
1545 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1546 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1547 printf("========================================================\n");
1548 printf("== dumpstate: done (id %d)\n", ds.id_);
1549 printf("========================================================\n");
1550}
1551
Rhed Jaoe017f982020-07-21 17:58:41 +08001552/*
1553 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1554 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1555 * if it's not running in the parallel task.
1556 */
1557static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1558 dprintf(out_fd, "========================================================\n");
1559 dprintf(out_fd, "== Checkins\n");
1560 dprintf(out_fd, "========================================================\n");
1561
1562 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001563 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1564 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1565 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1566 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1567}
1568
1569/*
1570 * Runs dumpsys on activity service to dump all application activities, services
1571 * and providers in the device.
1572 *
1573 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1574 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1575 * if it's not running in the parallel task.
1576 */
1577static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1578 dprintf(out_fd, "========================================================\n");
1579 dprintf(out_fd, "== Running Application Activities\n");
1580 dprintf(out_fd, "========================================================\n");
1581
1582 // The following dumpsys internally collects output from running apps, so it can take a long
1583 // time. So let's extend the timeout.
1584
1585 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1586
1587 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1588
1589 dprintf(out_fd, "========================================================\n");
1590 dprintf(out_fd, "== Running Application Services (platform)\n");
1591 dprintf(out_fd, "========================================================\n");
1592
1593 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1594 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1595
1596 dprintf(out_fd, "========================================================\n");
1597 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1598 dprintf(out_fd, "========================================================\n");
1599
1600 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1601 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1602
1603 dprintf(out_fd, "========================================================\n");
1604 dprintf(out_fd, "== Running Application Providers (platform)\n");
1605 dprintf(out_fd, "========================================================\n");
1606
1607 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001608 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001609
1610 dprintf(out_fd, "========================================================\n");
1611 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1612 dprintf(out_fd, "========================================================\n");
1613
1614 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1615 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1616}
1617
Nandana Dutt5c390032019-03-12 10:52:56 +00001618// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1619// via the consent they are shown. Ignores other errors that occur while running various
1620// commands. The consent checking is currently done around long running tasks, which happen to
1621// be distributed fairly evenly throughout the function.
1622static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001623 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001624
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001625 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001626 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1627 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001628 if (ds.dump_pool_) {
1629 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1630 // drop root user. Restarts it with two threads for the parallel run.
1631 ds.dump_pool_->start(/* thread_counts = */2);
1632
Chris Morinbc223142022-02-04 14:17:11 -08001633 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1634 dump_incident_report = ds.dump_pool_->enqueueTask(
1635 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001636 dump_netstats_report = ds.dump_pool_->enqueueTask(
1637 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001638 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1639 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1640 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001641 }
1642
Nandana Dutt5c390032019-03-12 10:52:56 +00001643 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1644 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1645 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001646 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001647 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001648 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001649 DumpFile("MEMORY INFO", "/proc/meminfo");
1650 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001651 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001652
Kevin Jeon947922b2022-09-21 00:29:18 +00001653 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1654 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001655
Sunny Goyal35949782019-11-19 15:54:36 -08001656 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1657
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001658 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1659 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1660 DumpFile("SLAB INFO", "/proc/slabinfo");
1661 DumpFile("ZONEINFO", "/proc/zoneinfo");
1662 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1663 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001664 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001665
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001666 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001667
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001668 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001669 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001670
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001671 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001672 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001673 } else {
1674 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1675 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001676
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001677 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001678 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001679 struct stat s;
1680 if (stat("/proc/modules", &s) != 0) {
1681 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1682 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001683 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001684 RunCommand("MODULES INFO",
1685 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1686 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1687 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001688 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001689
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001690 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001691 DoKernelLogcat();
1692 } else {
1693 do_dmesg();
1694 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001695
Devin Moore8df81bb2022-06-08 22:47:02 +00001696 DumpVintf();
1697
Felipe Lemef0292972016-11-22 13:57:05 -08001698 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001699
Jeff Brown1dc94e32014-09-11 14:15:27 -07001700 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001701 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001702
Jack Yu5a6b2e22020-08-14 18:13:35 +08001703 /* Dump Nfc NCI logs */
1704 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001705
Paul Chang0d2aad72020-02-13 20:04:03 +08001706 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001707 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001708 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001709 }
1710
Felipe Lemee184f662016-10-27 10:04:47 -07001711 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001712
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001713 MaybeAddSystemTraceToZip();
1714
Narayan Kamath8f788292017-05-25 13:20:39 +01001715 // NOTE: tombstones are always added as separate entries in the zip archive
1716 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001717 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001718 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001719 if (!tombstones_dumped) {
1720 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001721 }
1722
Jayachandran Ca94c7172017-06-10 15:08:12 -07001723 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001724
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001725 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001726
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001727 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001728
Woody Lin20767a92022-11-29 15:50:24 +08001729 DumpShutdownCheckpoints();
1730
Jayachandran Ca94c7172017-06-10 15:08:12 -07001731 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001732
1733 dump_route_tables();
1734
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001735 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1736 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1737 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001738
Nandana Dutt5c390032019-03-12 10:52:56 +00001739 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001740
Chiachang Wang668ede42021-05-17 17:14:20 +08001741 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1742 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1743 // dump with priority parameters to dump high priority information.
1744 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1745 CommandOptions::WithTimeout(10).Build());
1746
Elliott Hughes23ccc622017-02-28 10:14:22 -08001747 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001748
Jin Qianf334d662017-10-10 14:41:37 -07001749 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001750
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001751 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001752
Colin Crossf45fa6b2012-03-26 12:38:26 -07001753 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001754 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1755 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1756
1757 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1758 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1759 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1760 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1761 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001762
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001763 /* Add window and surface trace files. */
1764 if (!PropertiesHelper::IsUserBuild()) {
1765 ds.AddDir(WMTRACE_DATA_DIR, false);
1766 }
1767
Yifan Hongd90cc652020-02-08 16:52:02 -08001768 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1769
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001770 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001771 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001772 } else {
1773 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1774 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001775
Steven Moreland7440ddb2016-12-15 16:13:39 -08001776 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001777 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1778 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001779 // su does not exist on user builds, so try running without it.
1780 // This way any implementations of vril-dump that do not require
1781 // root can run on user builds.
1782 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001783 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001784 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001785 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001786 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001787 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001788 }
1789
Felipe Lemed8b94e52016-12-08 10:21:44 -08001790 printf("========================================================\n");
1791 printf("== Android Framework Services\n");
1792 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001793
Nandana Dutt5c390032019-03-12 10:52:56 +00001794 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001795
Jack He91ff2fe2021-02-18 18:23:43 -08001796 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1797 ds.AddDir("/data/misc/bluetooth/logs", true);
1798
Rhed Jaoe017f982020-07-21 17:58:41 +08001799 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001800 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001801 } else {
1802 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1803 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001804
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001805 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001806
Adrian Roos8b397ab2017-04-04 16:35:44 -07001807 printf("========================================================\n");
1808 printf("== Dropbox crashes\n");
1809 printf("========================================================\n");
1810
1811 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1812 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1813
Felipe Lemed8b94e52016-12-08 10:21:44 -08001814 printf("========================================================\n");
1815 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1816 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1817 printf("========================================================\n");
1818 printf("== dumpstate: done (id %d)\n", ds.id_);
1819 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001820
1821 printf("========================================================\n");
1822 printf("== Obtaining statsd metadata\n");
1823 printf("========================================================\n");
1824 // This differs from the usual dumpsys stats, which is the stats report data.
1825 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001826
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001827 // Add linker configuration directory
1828 ds.AddDir(LINKERCONFIG_DIR, true);
1829
Li Li830179f2022-01-04 12:53:29 -08001830 /* Dump frozen cgroupfs */
1831 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001832
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001833 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001834 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1835 } else {
1836 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1837 DumpNetstatsProto);
1838 }
1839
1840 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001841 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001842 } else {
1843 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1844 DumpIncidentReport);
1845 }
Mike Ma5c267872019-08-21 11:31:34 -07001846
Nandana Dutt5c390032019-03-12 10:52:56 +00001847 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001848}
1849
Nandana Dutt5c390032019-03-12 10:52:56 +00001850/*
1851 * Dumps state for the default case; drops root after it's no longer necessary.
1852 *
1853 * Returns RunStatus::OK if everything went fine.
1854 * Returns RunStatus::ERROR if there was an error.
1855 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1856 * with the caller.
1857 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001858Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001859 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1860 // buffer.
1861 DoLogcat();
1862 // Capture timestamp after first logcat to use in next logcat
1863 time_t logcat_ts = time(nullptr);
1864
Nandana Dutt4be45d12018-09-26 15:04:23 +01001865 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001866 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001867 if (dump_pool_) {
1868 RETURN_IF_USER_DENIED_CONSENT();
1869 // One thread is enough since we only need to enqueue DumpTraces here.
1870 dump_pool_->start(/* thread_counts = */1);
1871
1872 // DumpTraces takes long time, post it to the another thread in the
1873 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001874 dump_traces = dump_pool_->enqueueTask(
1875 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001876 } else {
1877 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1878 &dump_traces_path);
1879 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001880
1881 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001882 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001883 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1884 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001885 ds.shutdown_checkpoints_ = GetDumpFds(
1886 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001887 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001888
1889 ds.AddDir(RECOVERY_DIR, true);
1890 ds.AddDir(RECOVERY_DATA_DIR, true);
1891 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001892 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001893 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1894 if (!PropertiesHelper::IsUserBuild()) {
1895 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1896 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001897 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001898 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001899 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001900 add_mountinfo();
1901 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001902 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001903 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001904 if (!PropertiesHelper::IsUserBuild()) {
1905 // Include dropbox entry files inside ZIP, but exclude
1906 // noisy WTF and StrictMode entries
1907 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1908 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001909
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001910 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001911 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1912
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001913 // Dump IPsec stats. No keys are exposed here.
1914 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1915
Nandana Dutt4be45d12018-09-26 15:04:23 +01001916 // Run ss as root so we can see socket marks.
1917 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1918
1919 // Run iotop as root to show top 100 IO threads
1920 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1921
Erick Reyese68df822019-02-11 14:46:36 -08001922 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001923 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1924 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001925
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001926 DumpFile("PSI cpu", "/proc/pressure/cpu");
1927 DumpFile("PSI memory", "/proc/pressure/memory");
1928 DumpFile("PSI io", "/proc/pressure/io");
1929
Mårten Kongstad60195a72022-09-20 14:14:20 +02001930 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1931 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1932
Rhed Jao5377d792020-07-16 17:37:39 +08001933 if (dump_pool_) {
1934 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001935 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001936
Chris Morinbc223142022-02-04 14:17:11 -08001937 // Current running thread in the pool is the root user also. Delete
1938 // the pool and make a new one later to ensure none of threads in the pool are root.
1939 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001940 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001941 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001942 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001943 }
1944
Nandana Dutt5c390032019-03-12 10:52:56 +00001945 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001946 Dumpstate::RunStatus status = dumpstate();
1947 // Capture logcat since the last time we did it.
1948 DoSystemLogcat(logcat_ts);
1949 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001950}
1951
Rhed Jaob5685b32020-08-14 17:19:17 +08001952// Common states for telephony and wifi which are needed to be collected before
1953// dumpstate drop the root user.
1954static void DumpstateRadioAsRoot() {
1955 DumpIpTablesAsRoot();
1956 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1957}
1958
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001959// This method collects common dumpsys for telephony and wifi. Typically, wifi
1960// reports are fine to include all information, but telephony reports on user
1961// builds need to strip some content (see DumpstateTelephonyOnly).
1962static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001963 // We need to be picky about some stuff for telephony reports on user builds.
1964 if (!include_sensitive_info) {
1965 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1966 DoRadioLogcat();
1967 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001968 // DumpHals takes long time, post it to the another thread in the pool,
1969 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001970 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001971 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001972 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001973 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001974 // Contains various system properties and process startup info.
1975 do_dmesg();
1976 // Logs other than the radio buffer may contain package/component names and potential PII.
1977 DoLogcat();
1978 // Too broad for connectivity problems.
1979 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001980 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1981 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001982 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001983 } else {
1984 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1985 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001986 }
1987
Jayachandran Ca94c7172017-06-10 15:08:12 -07001988 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001989 DumpIpAddrAndRules();
1990 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001991 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1992 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001993}
1994
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001995// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1996// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1997// for what can be included on user builds: all reported information MUST directly relate to
1998// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1999// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2000// names are not), and MUST NOT contain logs of user application traffic.
2001// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002002static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002003 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002004
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002005 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002006
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002007 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002008
Rhed Jaob5685b32020-08-14 17:19:17 +08002009 DumpstateRadioAsRoot();
2010 if (!DropRootUser()) {
2011 return;
2012 }
2013
2014 // Starts thread pool after the root user is dropped, and two additional threads
2015 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002016 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002017 if (ds.dump_pool_) {
2018 ds.dump_pool_->start(/*thread_counts =*/2);
2019
2020 // DumpstateBoard takes long time, post it to the another thread in the pool,
2021 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002022 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2023 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002024 }
2025
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002026 DumpstateRadioCommon(include_sensitive_info);
2027
2028 if (include_sensitive_info) {
2029 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2030 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2031 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2032 // way.
2033 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2034 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002035
2036 printf("========================================================\n");
2037 printf("== Android Framework Services\n");
2038 printf("========================================================\n");
2039
Vishnu Nair652cc802017-11-30 15:18:30 -08002040 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2041 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002042 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2043 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002044 if (include_sensitive_info) {
2045 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2046 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2047 SEC_TO_MSEC(10));
2048 } else {
2049 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2050 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2051 // give a higher timeout as well.
2052 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2053 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2054 }
2055 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002056 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2057 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002058 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002059 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2060 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002061 if (include_sensitive_info) {
2062 // Contains raw IP addresses, omit from reports on user builds.
2063 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2064 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2065 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2066 SEC_TO_MSEC(10));
2067 // Contains package/component names, omit from reports on user builds.
2068 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2069 SEC_TO_MSEC(10));
2070 // Contains package names, but should be relatively simple to remove them (also contains
2071 // UIDs already), omit from reports on user builds.
2072 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2073 SEC_TO_MSEC(10));
2074 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002075
2076 printf("========================================================\n");
2077 printf("== Running Application Services\n");
2078 printf("========================================================\n");
2079
2080 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2081
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002082 if (include_sensitive_info) {
2083 printf("========================================================\n");
2084 printf("== Running Application Services (non-platform)\n");
2085 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002086
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002087 // Contains package/component names and potential PII, omit from reports on user builds.
2088 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2089 // carrier_config dumpsys instead.
2090 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2091 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002092
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002093 printf("========================================================\n");
2094 printf("== Checkins\n");
2095 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002096
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002097 // Contains package/component names, omit from reports on user builds.
2098 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2099 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002100
2101 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002102 printf("== dumpstate: done (id %d)\n", ds.id_);
2103 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002104
2105 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002106 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002107 } else {
2108 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2109 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002110}
2111
mukesh agrawal253dad42018-01-23 21:59:59 -08002112// This method collects dumpsys for wifi debugging only
2113static void DumpstateWifiOnly() {
2114 DurationReporter duration_reporter("DUMPSTATE");
2115
Rhed Jaob5685b32020-08-14 17:19:17 +08002116 DumpstateRadioAsRoot();
2117 if (!DropRootUser()) {
2118 return;
2119 }
2120
2121 // Starts thread pool after the root user is dropped. Only one additional
2122 // thread is needed for DumpHals in the DumpstateRadioCommon.
2123 if (ds.dump_pool_) {
2124 ds.dump_pool_->start(/*thread_counts =*/1);
2125 }
2126
mukesh agrawal253dad42018-01-23 21:59:59 -08002127 DumpstateRadioCommon();
2128
2129 printf("========================================================\n");
2130 printf("== Android Framework Services\n");
2131 printf("========================================================\n");
2132
2133 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2134 SEC_TO_MSEC(10));
2135 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2136 SEC_TO_MSEC(10));
2137
2138 printf("========================================================\n");
2139 printf("== dumpstate: done (id %d)\n", ds.id_);
2140 printf("========================================================\n");
2141}
2142
Nandana Duttcf419a72019-03-14 10:40:17 +00002143Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002144 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002145 const size_t buf_size = temp_file_pattern.length() + 1;
2146 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2147 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2148
2149 // Create a new, empty file to receive all trace dumps.
2150 //
2151 // TODO: This can be simplified once we remove support for the old style
2152 // dumps. We can have a file descriptor passed in to dump_traces instead
2153 // of creating a file, closing it and then reopening it again.
2154 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2155 if (fd < 0) {
2156 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002157 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002158 }
2159
2160 // Nobody should have access to this temporary file except dumpstate, but we
2161 // temporarily grant 'read' to 'others' here because this file is created
2162 // when tombstoned is still running as root, but dumped after dropping. This
2163 // can go away once support for old style dumping has.
2164 const int chmod_ret = fchmod(fd, 0666);
2165 if (chmod_ret < 0) {
2166 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002167 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002168 }
2169
2170 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2171 if (proc.get() == nullptr) {
2172 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002173 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002174 }
2175
2176 // Number of times process dumping has timed out. If we encounter too many
2177 // failures, we'll give up.
2178 int timeout_failures = 0;
2179 bool dalvik_found = false;
2180
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002181 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002182
2183 struct dirent* d;
2184 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002185 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002186 int pid = atoi(d->d_name);
2187 if (pid <= 0) {
2188 continue;
2189 }
2190
2191 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2192 std::string exe;
2193 if (!android::base::Readlink(link_name, &exe)) {
2194 continue;
2195 }
2196
2197 bool is_java_process;
2198 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2199 // Don't bother dumping backtraces for the zygote.
2200 if (IsZygote(pid)) {
2201 continue;
2202 }
2203
2204 dalvik_found = true;
2205 is_java_process = true;
2206 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2207 is_java_process = false;
2208 } else {
2209 // Probably a native process we don't care about, continue.
2210 continue;
2211 }
2212
2213 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2214 if (timeout_failures == 3) {
2215 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2216 break;
2217 }
2218
2219 const uint64_t start = Nanotime();
2220 const int ret = dump_backtrace_to_file_timeout(
2221 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2222 is_java_process ? 5 : 20, fd);
2223
2224 if (ret == -1) {
2225 // For consistency, the header and footer to this message match those
2226 // dumped by debuggerd in the success case.
2227 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2228 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2229 dprintf(fd, "---- end %d ----", pid);
2230 timeout_failures++;
2231 continue;
2232 }
2233
2234 // We've successfully dumped stack traces, reset the failure count
2235 // and write a summary of the elapsed time to the file and continue with the
2236 // next process.
2237 timeout_failures = 0;
2238
2239 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2240 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2241 }
2242
2243 if (!dalvik_found) {
2244 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2245 }
2246
Nandana Duttcf419a72019-03-14 10:40:17 +00002247 *path = file_name_buf.release();
2248 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002249}
2250
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002251static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2252 const Dumpstate::BugreportMode bugreport_mode) {
2253 switch (bugreport_mode) {
2254 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2255 return dumpstate_hal_hidl::DumpstateMode::FULL;
2256 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2257 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2258 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2259 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2260 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2261 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2262 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2263 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2264 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2265 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2266 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2267 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2268 }
2269 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2270}
2271
2272static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2273 const Dumpstate::BugreportMode bugreport_mode) {
2274 switch (bugreport_mode) {
2275 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2276 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2277 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2278 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2279 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2280 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2281 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2282 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2283 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2284 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2285 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2286 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2287 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2288 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2289 }
2290 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2291}
2292
2293static void DoDumpstateBoardHidl(
2294 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2295 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2296 const Dumpstate::BugreportMode bugreport_mode,
2297 const size_t timeout_sec) {
2298
2299 using ScopedNativeHandle =
2300 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2301 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2302 [](native_handle_t* handle) {
2303 // we don't close file handle's here
2304 // via native_handle_close(handle)
2305 // instead we let dumpstate_fds close the file handles when
2306 // dumpstate_fds gets destroyed
2307 native_handle_delete(handle);
2308 });
2309 if (handle == nullptr) {
2310 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2311 return;
2312 }
2313
2314 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2315 handle.get()->data[i] = dumpstate_fds[i].get();
2316 }
2317
2318 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2319 // implement just 1.0.
2320 const char* descriptor_to_kill;
2321 using DumpstateBoardTask = std::packaged_task<bool()>;
2322 DumpstateBoardTask dumpstate_board_task;
2323 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2324 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2325 if (dumpstate_hal != nullptr) {
2326 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2327
2328 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2329 GetDumpstateHalModeHidl(bugreport_mode);
2330
2331 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2332 dumpstate_board_task =
2333 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2334 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2335 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2336 SEC_TO_MSEC(timeout_sec));
2337 if (!status.isOk()) {
2338 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2339 return false;
2340 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2341 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2342 dumpstate_hal_hidl::toString(status).c_str());
2343 return false;
2344 }
2345 return true;
2346 });
2347 } else {
2348 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2349
2350 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2351 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2352 ::android::hardware::Return<void> status =
2353 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2354 if (!status.isOk()) {
2355 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2356 return false;
2357 }
2358 return true;
2359 });
2360 }
2361 auto result = dumpstate_board_task.get_future();
2362 std::thread(std::move(dumpstate_board_task)).detach();
2363
2364 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2365 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2366 if (!android::base::SetProperty(
2367 "ctl.interface_restart",
2368 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2369 MYLOGE("Couldn't restart dumpstate HAL\n");
2370 }
2371 }
2372 // Wait some time for init to kill dumpstate vendor HAL
2373 constexpr size_t killing_timeout_sec = 10;
2374 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2375 MYLOGE(
2376 "killing dumpstateBoard timed out after %zus, continue and "
2377 "there might be racing in content\n",
2378 killing_timeout_sec);
2379 }
2380}
2381
2382static void DoDumpstateBoardAidl(
2383 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2384 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2385 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2386 MYLOGI("Using IDumpstateDevice AIDL HAL");
2387
2388 const char* descriptor_to_kill;
2389 using DumpstateBoardTask = std::packaged_task<bool()>;
2390 DumpstateBoardTask dumpstate_board_task;
2391 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2392 GetDumpstateHalModeAidl(bugreport_mode);
2393
2394 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2395 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2396 timeout_sec]() -> bool {
2397 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2398
2399 if (!status.isOk()) {
2400 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2401 return false;
2402 }
2403 return true;
2404 });
2405 auto result = dumpstate_board_task.get_future();
2406 std::thread(std::move(dumpstate_board_task)).detach();
2407
2408 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2409 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2410 if (!android::base::SetProperty(
2411 "ctl.interface_restart",
2412 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2413 MYLOGE("Couldn't restart dumpstate HAL\n");
2414 }
2415 }
2416 // Wait some time for init to kill dumpstate vendor HAL
2417 constexpr size_t killing_timeout_sec = 10;
2418 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2419 MYLOGE(
2420 "killing dumpstateBoard timed out after %zus, continue and "
2421 "there might be racing in content\n",
2422 killing_timeout_sec);
2423 }
2424}
2425
2426static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2427 const std::string aidl_instance_name =
2428 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2429
2430 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2431 return nullptr;
2432 }
2433
2434 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2435
2436 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2437}
2438
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002439void Dumpstate::DumpstateBoard(int out_fd) {
2440 dprintf(out_fd, "========================================================\n");
2441 dprintf(out_fd, "== Board\n");
2442 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002443
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002444 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002445 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002446 * set to true and unmount it after invoking dumpstateBoard_* methods.
2447 * This is to enable debug builds to not have debugfs mounted during runtime.
2448 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002449 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002450 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002451 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002452 if (mount_debugfs) {
2453 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2454 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002455 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002456 }
2457
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002458 std::vector<std::string> paths;
2459 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002460 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002461 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2462 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002463 remover.emplace_back(android::base::make_scope_guard(
2464 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002465 }
Jie Song9fbfad02017-06-20 16:29:42 -07002466
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002467 // get dumpstate HAL AIDL implementation
2468 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2469 GetDumpstateBoardAidlService());
2470 if (dumpstate_hal_handle_aidl == nullptr) {
2471 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2472 }
2473
2474 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2475 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2476 if (dumpstate_hal_handle_aidl == nullptr) {
2477 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2478 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2479 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2480 }
2481 }
2482
2483 // if neither HIDL nor AIDL implementation found, then return
2484 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2485 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002486 return;
2487 }
2488
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002489 // this is used to hold the file descriptors and when this variable goes out of scope
2490 // the file descriptors are closed
2491 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002492
Nandana Dutt5c390032019-03-12 10:52:56 +00002493 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002494 for (size_t i = 0; i < paths.size(); i++) {
2495 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2496
2497 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2498 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2499 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2500 if (fd < 0) {
2501 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2502 return;
2503 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002504
2505 dumpstate_fds.emplace_back(fd.release());
2506 // we call fd.release() here to make sure "fd" does not get closed
2507 // after "fd" goes out of scope after this block.
2508 // "fd" will be closed when "dumpstate_fds" goes out of scope
2509 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002510 }
2511
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002512 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2513 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2514 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002515 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002516
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002517 if (dumpstate_hal_handle_aidl != nullptr) {
2518 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2519 timeout_sec);
2520 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2521 // run HIDL HAL only if AIDL HAL not found
2522 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2523 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002524 }
2525
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002526 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002527 auto keep_debugfs_mounted =
2528 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2529 if (keep_debugfs_mounted.empty())
2530 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002531 }
2532
Wei Wang587eac92018-04-05 12:17:20 -07002533 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2534 for (size_t i = 0; i < paths.size(); i++) {
2535 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002536 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2537 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002538 file_sizes[i] = -1;
2539 continue;
2540 }
2541 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002542 }
2543
2544 for (size_t i = 0; i < paths.size(); i++) {
2545 if (file_sizes[i] == -1) {
2546 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002547 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002548 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002549 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002550 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002551 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002552 remover[i].Disable();
2553 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2554 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002555 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002556}
2557
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002558static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002559 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002560 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2561 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002562 " -h: display this help message\n"
2563 " -b: play sound file instead of vibrate, at beginning of job\n"
2564 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002565 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002566 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002567 " -s: write zipped file to control socket (for init)\n"
2568 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002569 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002570 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002571 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002572 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002573 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002574 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002575}
2576
Wei Liuf87959e2016-08-26 14:51:42 -07002577static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002578 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002579}
2580
Felipe Leme1d486fe2016-10-14 18:06:47 -07002581bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002582 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2583 if (zip_entry_tasks_) {
2584 zip_entry_tasks_->run(/* do_cancel = */false);
2585 }
2586
Felipe Leme9a523ae2016-10-20 15:10:33 -07002587 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002588 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002589 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002590 // Final timestamp
2591 char date[80];
2592 time_t the_real_now_please_stand_up = time(nullptr);
2593 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002594 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002595 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002596
Felipe Leme9a523ae2016-10-20 15:10:33 -07002597 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002598 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002599 return false;
2600 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002601 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002602 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002603 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002604 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002605
Felipe Leme0f3fb202016-06-10 17:10:53 -07002606 // Add log file (which contains stderr output) to zip...
2607 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002608 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002609 MYLOGE("Failed to add dumpstate log to .zip file\n");
2610 return false;
2611 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002612 // TODO: Should truncate the existing file.
2613 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002614 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2615 return false;
2616 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002617 fprintf(stderr, "\n");
2618
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002619 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002620 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002621 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002622 return false;
2623 }
2624
Felipe Leme1d486fe2016-10-14 18:06:47 -07002625 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2626 ds.zip_file.reset(nullptr);
2627
Felipe Lemee9d2c542016-11-15 11:48:26 -08002628 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002629 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002630
Felipe Leme1e9edc62015-12-21 16:02:13 -08002631 return true;
2632}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002633
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002634static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2635 // clang-format off
2636 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2637 "--receiver-foreground", "--receiver-include-background", "-a", action};
2638 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002639
2640 am.insert(am.end(), args.begin(), args.end());
2641
Felipe Leme8d2410e2017-02-08 09:46:08 -08002642 RunCommand("", am,
2643 CommandOptions::WithTimeout(20)
2644 .Log("Sending broadcast: '%s'\n")
2645 .Always()
2646 .DropRoot()
2647 .RedirectStderr()
2648 .Build());
2649}
2650
Felipe Leme35b8cf12017-02-10 15:47:29 -08002651static void Vibrate(int duration_ms) {
2652 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002653 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2654 "oneshot", std::to_string(duration_ms)};
2655 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002656 CommandOptions::WithTimeout(10)
2657 .Log("Vibrate: '%s'\n")
2658 .Always()
2659 .Build());
2660 // clang-format on
2661}
2662
Nandana Dutt979388e2018-11-30 16:48:55 +00002663static void MaybeResolveSymlink(std::string* path) {
2664 std::string resolved_path;
2665 if (android::base::Readlink(*path, &resolved_path)) {
2666 *path = resolved_path;
2667 }
2668}
2669
Nandana Dutt4be45d12018-09-26 15:04:23 +01002670/*
2671 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002672 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002673 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002674static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002675 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2676
Nandana Dutt4be45d12018-09-26 15:04:23 +01002677 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2678 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002679 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002680 char date[80];
2681 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2682 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002683
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002684 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002685 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002686 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002687 ds.base_name_ += "-wifi";
2688 }
2689
Paul Chang0d2aad72020-02-13 20:04:03 +08002690 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002691 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002692 }
2693 ds.tmp_path_ = ds.GetPath(".tmp");
2694 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2695
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002696 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002697 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002698 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002699 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002700 "Bugreport dir: [%s] "
2701 "Base name: [%s] "
2702 "Suffix: [%s] "
2703 "Log path: [%s] "
2704 "Temporary path: [%s] "
2705 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002706 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2707 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002708
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002709 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2710 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2711 create_parent_dirs(ds.path_.c_str());
2712 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2713 if (ds.zip_file == nullptr) {
2714 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2715 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002716 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002717 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2718 ds.AddTextZipEntry("version.txt", ds.version_);
2719 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002720}
2721
2722/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002723 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002724 * printing zipped file status, etc.
2725 */
2726static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002727 bool do_text_file = !ds.FinishZipFile();
2728 if (do_text_file) {
2729 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002730 }
mhasank2d75c442020-06-11 15:05:25 -07002731
2732 std::string final_path = ds.path_;
2733 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002734 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002735 android::os::CopyFileToFile(ds.path_, final_path);
2736 }
2737
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002738 if (ds.options_->stream_to_socket) {
2739 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2740 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002741 if (do_text_file) {
2742 dprintf(ds.control_socket_fd_,
2743 "FAIL:could not create zip file, check %s "
2744 "for more details\n",
2745 ds.log_path_.c_str());
2746 } else {
mhasank2d75c442020-06-11 15:05:25 -07002747 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002748 }
2749 }
2750}
2751
Nandana Dutt4be45d12018-09-26 15:04:23 +01002752
Nandana Dutt58d72e22018-11-16 10:30:48 +00002753static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2754 switch (mode) {
2755 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2756 return "BUGREPORT_FULL";
2757 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2758 return "BUGREPORT_INTERACTIVE";
2759 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2760 return "BUGREPORT_REMOTE";
2761 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2762 return "BUGREPORT_WEAR";
2763 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2764 return "BUGREPORT_TELEPHONY";
2765 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2766 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002767 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2768 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002769 }
2770}
2771
Paul Changf59c2b72020-03-10 02:08:55 +08002772static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2773 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002774 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2775 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002776 options->bugreport_mode = mode;
2777 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002778 switch (mode) {
2779 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002780 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002781 break;
2782 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002783 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002784 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002785 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002786 break;
2787 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002788 options->do_vibrate = false;
2789 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002790 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002791 break;
2792 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002793 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002794 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002795 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002796 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002797 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002798 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002799 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002800 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002801 break;
2802 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002803 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002804 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002805 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002806 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2807 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002808 }
2809}
2810
Nandana Dutt58d72e22018-11-16 10:30:48 +00002811static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002812 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002813 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002814 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002815 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002816 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002817 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002818 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002819 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002820 options.do_progress_updates, options.bugreport_fd.get(),
2821 options.bugreport_mode_string.c_str(),
2822 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002823}
2824
Nandana Dutt54dbd672019-01-11 12:58:05 +00002825void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2826 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002827 const android::base::unique_fd& screenshot_fd_in,
2828 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002829 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002830 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2831 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002832
Paul Changf59c2b72020-03-10 02:08:55 +08002833 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002834}
2835
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002836Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2837 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002838 int c;
mhasankd451a472020-05-26 18:02:39 -07002839 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002840 switch (c) {
2841 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002842 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002843 case 's': stream_to_socket = true; break;
2844 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002845 case 'v': show_header_only = true; break;
2846 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002847 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002848 case 'P': do_progress_updates = true; break;
2849 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002850 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002851 case 'V':
2852 case 'd':
2853 case 'z':
2854 // compatibility no-op
2855 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002856 case 'w':
2857 // This was already processed
2858 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002859 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002860 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002861 break;
2862 default:
2863 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002864 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002865 break;
2866 // clang-format on
2867 }
2868 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002869
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002870 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002871 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002872 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002873 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002874 }
2875 }
2876
2877 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2878 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002879
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002880 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002881}
2882
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002883bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002884 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002885 return false;
2886 }
2887
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002888 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002889 return false;
2890 }
2891
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002892 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002893 return false;
2894 }
2895 return true;
2896}
2897
Nandana Dutt197661d2018-11-16 16:40:21 +00002898void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2899 options_ = std::move(options);
2900}
2901
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002902void Dumpstate::Initialize() {
2903 /* gets the sequential id */
2904 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2905 id_ = ++last_id;
2906 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2907}
2908
Nandana Duttd2f5f082019-01-18 17:13:52 +00002909Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2910 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002911 if (listener_ != nullptr) {
2912 switch (status) {
2913 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002914 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002915 break;
2916 case Dumpstate::RunStatus::HELP:
2917 break;
2918 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002919 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002920 break;
2921 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002922 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2923 break;
2924 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2925 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2926 break;
2927 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2928 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002929 break;
2930 }
2931 }
2932 return status;
2933}
2934
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002935void Dumpstate::Cancel() {
2936 CleanupTmpFiles();
2937 android::os::UnlinkAndLogOnError(log_path_);
2938 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2939 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2940 kDumpstateBoardFiles[i]);
2941 }
2942 tombstone_data_.clear();
2943 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002944 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002945
2946 // Instead of shutdown the pool, we delete temporary files directly since
2947 // shutdown blocking the call.
2948 if (dump_pool_) {
2949 dump_pool_->deleteTempFiles();
2950 }
2951 if (zip_entry_tasks_) {
2952 zip_entry_tasks_->run(/*do_cancel =*/ true);
2953 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002954}
2955
Nandana Dutt979388e2018-11-30 16:48:55 +00002956/*
2957 * Dumps relevant information to a bugreport based on the given options.
2958 *
2959 * The bugreport can be dumped to a file or streamed to a socket.
2960 *
2961 * How dumping to file works:
2962 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2963 * stderr is redirected a log file.
2964 *
2965 * The temporary bugreport is then populated via printfs, dumping contents of files and
2966 * output of commands to stdout.
2967 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002968 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002969 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002970 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002971 *
mhasank2d75c442020-06-11 15:05:25 -07002972 * Bugreports are first generated in a local directory and later copied to the caller's fd
2973 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002974 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002975Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2976 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002977 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002978 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002979 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002980 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002981 return RunStatus::INVALID_INPUT;
2982 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002983 /* set as high priority, and protect from OOM killer */
2984 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002985
Felipe Lemed071c682016-10-20 16:48:00 -07002986 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002987 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002988 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002989 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002990 } else {
2991 /* fallback to kernels <= 2.6.35 */
2992 oom_adj = fopen("/proc/self/oom_adj", "we");
2993 if (oom_adj) {
2994 fputs("-17", oom_adj);
2995 fclose(oom_adj);
2996 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002997 }
2998
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002999 if (version_ == VERSION_DEFAULT) {
3000 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003001 }
3002
Chris Morin5a50d482022-02-01 17:41:18 -08003003 if (version_ != VERSION_CURRENT) {
3004 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3005 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003006 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003007 }
3008
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003009 if (options_->show_header_only) {
3010 PrintHeader();
3011 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003012 }
3013
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003014 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3015 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003016
Felipe Leme7447d7c2016-11-03 18:12:22 -07003017 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003018 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003019 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003020 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003021
Sahana Raof35ed432019-07-12 10:47:52 +01003022 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3023 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3024 } else {
3025 // Wake lock will be released automatically on process death
3026 MYLOGD("Wake lock acquired.\n");
3027 }
3028
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003029 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003030
Felipe Lemef0292972016-11-22 13:57:05 -08003031 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003032 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3033 }
3034
Nandana Dutt235c6672019-11-14 15:22:32 +00003035 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003036 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003037
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003038 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003039
Christopher Ferrised9354f2014-10-01 17:35:01 -07003040 // If we are going to use a socket, do it as early as possible
3041 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003042 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003043 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003044 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003045 if (control_socket_fd_ == -1) {
3046 return ERROR;
3047 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003048 if (options_->progress_updates_to_socket) {
3049 options_->do_progress_updates = 1;
3050 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003051 }
3052
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003053 if (!PrepareToWriteToFile()) {
3054 return ERROR;
3055 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003056
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003057 // Interactive, wear & telephony modes are default to true.
3058 // and may enable from cli option or when using control socket
3059 if (options_->do_progress_updates) {
3060 // clang-format off
3061 std::vector<std::string> am_args = {
3062 "--receiver-permission", "android.permission.DUMP",
3063 };
3064 // clang-format on
3065 // Send STARTED broadcast for apps that listen to bugreport generation events
3066 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3067 if (options_->progress_updates_to_socket) {
3068 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003069 }
3070 }
3071
Nick Kralevichf3599b32016-01-25 15:05:16 -08003072 /* read /proc/cmdline before dropping root */
3073 FILE *cmdline = fopen("/proc/cmdline", "re");
3074 if (cmdline) {
3075 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3076 fclose(cmdline);
3077 }
3078
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003079 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003080 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003081 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003082
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003083 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003084 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3085 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003086 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003087 }
3088 }
3089
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003090 int dup_stdout_fd;
3091 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003092 // Redirect stderr to log_path_ for debugging.
3093 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3094 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3095 return ERROR;
3096 }
3097 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3098 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3099 strerror(errno));
3100 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003101
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003102 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3103 // moved into zip file later, if zipping.
3104 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3105 // TODO: why not write to a file instead of stdout to overcome this problem?
3106 /* TODO: rather than generating a text file now and zipping it later,
3107 it would be more efficient to redirect stdout to the zip entry
3108 directly, but the libziparchive doesn't support that option yet. */
3109 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3110 return ERROR;
3111 }
3112 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3113 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3114 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003115 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003116
3117 // Don't buffer stdout
3118 setvbuf(stdout, nullptr, _IONBF, 0);
3119
Rhed Jao5377d792020-07-16 17:37:39 +08003120 // Enable the parallel run if the client requests to output to a file.
3121 EnableParallelRunIfNeeded();
3122 // Using scope guard to make sure the dump pool can be shut down correctly.
3123 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3124 ShutdownDumpPool();
3125 });
3126
Felipe Leme608385d2016-02-01 10:35:38 -08003127 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3128 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003129 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003130 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003131
Gavin Corkery6968f552020-11-22 18:09:05 +00003132 bool is_dumpstate_restricted = options_->telephony_only
3133 || options_->wifi_only
3134 || options_->limited_only;
3135 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003136 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003137 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003138 }
3139 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003140
3141 if (!is_dumpstate_restricted) {
3142 // Snapshot the system trace now (if running) to avoid that dumpstate's
3143 // own activity pushes out interesting data from the trace ring buffer.
3144 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3145 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003146
3147 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3148 // from WMTRACE_DATA_DIR.
3149 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003150 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003151 onUiIntensiveBugreportDumpsFinished(calling_uid);
3152 MaybeCheckUserConsent(calling_uid, calling_package);
3153 if (options_->telephony_only) {
3154 DumpstateTelephonyOnly(calling_package);
3155 } else if (options_->wifi_only) {
3156 DumpstateWifiOnly();
3157 } else if (options_->limited_only) {
3158 DumpstateLimitedOnly();
3159 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003160 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003161 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003162 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003163 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003164 HandleUserConsentDenied();
3165 }
3166 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003167 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003168 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003169
Felipe Leme55b42a62015-11-10 17:39:08 -08003170 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003171 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003172
Abhijeet Kaure370d682019-10-01 16:49:30 +01003173 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003174 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003175 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003176 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003177
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003178 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003179 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003180 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003181 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003182 if (status != Dumpstate::RunStatus::OK &&
3183 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3184 // Do an early return if there were errors. We make an exception for consent
3185 // timing out because it's possible the user got distracted. In this case the
3186 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003187 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003188 return status;
3189 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003190 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3191 MYLOGI(
3192 "Did not receive user consent yet."
3193 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003194 const String16 incidentcompanion("incidentcompanion");
3195 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3196 if (ics != nullptr) {
3197 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3198 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3199 consent_callback_.get());
3200 } else {
3201 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3202 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003203 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003204 }
3205
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003206 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003207 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003208 for (int i = 0; i < 3; i++) {
3209 Vibrate(75);
3210 usleep((75 + 50) * 1000);
3211 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003212 }
3213
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003214 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3215 progress_->GetInitialMax());
3216 progress_->Save();
3217 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003218
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003219 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003220
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003221 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003222 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003223 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003224 }
3225
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003226 tombstone_data_.clear();
3227 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003228 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003229
Nandana Duttd2f5f082019-01-18 17:13:52 +00003230 return (consent_callback_ != nullptr &&
3231 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3232 ? USER_CONSENT_TIMED_OUT
3233 : RunStatus::OK;
3234}
3235
Paul Chang0d2aad72020-02-13 20:04:03 +08003236void Dumpstate::MaybeTakeEarlyScreenshot() {
3237 if (!options_->do_screenshot || !do_early_screenshot_) {
3238 return;
3239 }
3240
3241 TakeScreenshot();
3242}
3243
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003244void Dumpstate::MaybeSnapshotSystemTrace() {
3245 // If a background system trace is happening and is marked as "suitable for
3246 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3247 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3248 // case that no trace is ongoing, this command is a no-op.
3249 // Note: this should not be enqueued as we need to freeze the trace before
3250 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3251 // the dumpstate's own activity which is irrelevant.
3252 int res = RunCommand(
3253 "SERIALIZE PERFETTO TRACE",
3254 {"perfetto", "--save-for-bugreport"},
3255 CommandOptions::WithTimeout(10)
3256 .DropRoot()
3257 .CloseAllFileDescriptorsOnExec()
3258 .Build());
3259 has_system_trace_ = res == 0;
3260 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3261 // file in the later stages.
3262}
3263
Yohei Yukawa95305b32021-03-09 07:54:27 -08003264void Dumpstate::MaybeSnapshotWinTrace() {
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003265 // Include the proto logging from WMShell.
3266 RunCommand(
3267 // Empty name because it's not intended to be classified as a bugreport section.
3268 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3269 // in the bugreport.
3270 "", {"dumpsys", "activity", "service", "SystemUIService",
3271 "WMShell", "protolog", "save-for-bugreport"},
3272 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3273
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003274 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3275 for (const auto& service : {"window", "input_method"}) {
3276 RunCommand(
3277 // Empty name because it's not intended to be classified as a bugreport section.
3278 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3279 "", {"cmd", service, "tracing", "save-for-bugreport"},
3280 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3281 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003282}
3283
Paul Changeb4b4642020-05-28 22:05:47 +08003284void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003285 if (calling_uid == AID_SHELL || !CalledByApi()) {
3286 return;
3287 }
3288 if (listener_ != nullptr) {
3289 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3290 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003291 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003292 }
3293}
3294
Jichao Lie89d9c12019-11-21 19:02:51 -08003295void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3296 if (calling_uid == AID_SHELL || !CalledByApi()) {
3297 // No need to get consent for shell triggered dumpstates, or not through
3298 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003299 return;
3300 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003301 consent_callback_ = new ConsentCallback();
3302 const String16 incidentcompanion("incidentcompanion");
3303 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003304 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003305 if (ics != nullptr) {
3306 MYLOGD("Checking user consent via incidentcompanion service\n");
3307 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003308 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003309 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003310 } else {
3311 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3312 }
3313}
3314
Nandana Dutt5c390032019-03-12 10:52:56 +00003315bool Dumpstate::IsUserConsentDenied() const {
3316 return ds.consent_callback_ != nullptr &&
3317 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3318}
3319
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003320bool Dumpstate::CalledByApi() const {
3321 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3322}
3323
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003324void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003325 android::os::UnlinkAndLogOnError(tmp_path_);
3326 android::os::UnlinkAndLogOnError(screenshot_path_);
3327 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003328 if (dump_traces_path != nullptr) {
3329 android::os::UnlinkAndLogOnError(dump_traces_path);
3330 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003331}
3332
Rhed Jao5377d792020-07-16 17:37:39 +08003333void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003334 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003335 return;
3336 }
3337 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003338 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003339}
3340
3341void Dumpstate::ShutdownDumpPool() {
3342 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003343 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003344 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003345 if (zip_entry_tasks_) {
3346 zip_entry_tasks_->run(/* do_cancel = */true);
3347 zip_entry_tasks_ = nullptr;
3348 }
3349}
3350
3351void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3352 const std::string& entry_path) {
3353 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3354 if (!task_cancelled) {
3355 AddZipEntry(entry_name, entry_path);
3356 }
3357 android::os::UnlinkAndLogOnError(entry_path);
3358 };
3359 if (zip_entry_tasks_) {
3360 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3361 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3362 } else {
3363 // Invokes AddZipEntryAndCleanup immediately
3364 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3365 }
Rhed Jao5377d792020-07-16 17:37:39 +08003366}
3367
Nandana Duttd2f5f082019-01-18 17:13:52 +00003368Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3369 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003370 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003371 return USER_CONSENT_DENIED;
3372}
3373
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003374Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003375 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003376 // user consent (unless the caller is Shell).
3377 UserConsentResult consent_result;
3378 if (calling_uid == AID_SHELL) {
3379 consent_result = UserConsentResult::APPROVED;
3380 } else {
3381 consent_result = consent_callback_->getResult();
3382 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003383 if (consent_result == UserConsentResult::UNAVAILABLE) {
3384 // User has not responded yet.
3385 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003386 // Telephony is a fast report type, particularly on user builds where information may be
3387 // more aggressively limited. To give the user time to read the consent dialog, increase the
3388 // timeout.
3389 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3390 : USER_CONSENT_TIMEOUT_MS;
3391 if (elapsed_ms < timeout_ms) {
3392 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003393 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3394 sleep(delay_seconds);
3395 }
3396 consent_result = consent_callback_->getResult();
3397 }
3398 if (consent_result == UserConsentResult::DENIED) {
3399 // User has explicitly denied sharing with the app. To be safe delete the
3400 // internal bugreport & tmp files.
3401 return HandleUserConsentDenied();
3402 }
3403 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003404 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3405 if (copy_succeeded) {
3406 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003407 if (options_->do_screenshot &&
3408 options_->screenshot_fd.get() != -1 &&
3409 !options_->is_screenshot_copied) {
3410 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3411 options_->screenshot_fd.get());
3412 options_->is_screenshot_copied = copy_succeeded;
3413 if (copy_succeeded) {
3414 android::os::UnlinkAndLogOnError(screenshot_path_);
3415 }
3416 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003417 }
3418 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3419 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3420 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3421 // Since we do not have user consent to share the bugreport it does not get
3422 // copied over to the calling app but remains in the internal directory from
3423 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003424 std::string final_path = GetPath(".zip");
3425 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3426 if (copy_succeeded) {
3427 android::os::UnlinkAndLogOnError(path_);
3428 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003429 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3430 }
3431 // Unknown result; must be a programming error.
3432 MYLOGE("Unknown user consent result:%d\n", consent_result);
3433 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003434}
3435
Nandana Duttf02564e2019-02-15 15:24:24 +00003436Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003437 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3438 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3439 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003440 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003441 // When directly running dumpstate binary, the output is not expected to be written
3442 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003443 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003444
3445 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003446 // an app; they are irrelevant here because bugreport is triggered via command line.
3447 // Update Last ID before calling Run().
3448 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003449 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003450 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003451 return status;
3452}
3453
3454/* Main entry point for dumpstate binary. */
3455int run_main(int argc, char* argv[]) {
3456 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003457
3458 switch (status) {
3459 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003460 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003461 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003462 ShowUsage();
3463 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003464 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003465 fprintf(stderr, "Invalid combination of args\n");
3466 ShowUsage();
3467 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003468 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003469 FALLTHROUGH_INTENDED;
3470 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3471 FALLTHROUGH_INTENDED;
3472 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003473 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003474 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003475}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003476
3477// TODO(111441001): Default DumpOptions to sensible values.
3478Dumpstate::Dumpstate(const std::string& version)
3479 : pid_(getpid()),
3480 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003481 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003482 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003483 now_(time(nullptr)),
3484 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003485}
3486
3487Dumpstate& Dumpstate::GetInstance() {
3488 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3489 return singleton_;
3490}
3491
Rhed Jao5377d792020-07-16 17:37:39 +08003492DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3493 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3494 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003495 if (!title_.empty()) {
3496 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003497 if (title_.find("SHOW MAP") == std::string::npos) {
3498 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3499 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003500 }
3501}
3502
3503DurationReporter::~DurationReporter() {
3504 if (!title_.empty()) {
3505 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003506 if (elapsed >= .5f || verbose_) {
3507 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003508 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003509 if (!logcat_only_) {
3510 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003511 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3512 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003513 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003514 if (title_.find("SHOW MAP") == std::string::npos) {
3515 ATRACE_ASYNC_END(title_.c_str(), 0);
3516 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003517 }
3518}
3519
3520const int32_t Progress::kDefaultMax = 5000;
3521
3522Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3523}
3524
3525Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3526 : Progress(initial_max, growth_factor, "") {
3527 progress_ = progress;
3528}
3529
3530Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3531 : initial_max_(initial_max),
3532 progress_(0),
3533 max_(initial_max),
3534 growth_factor_(growth_factor),
3535 n_runs_(0),
3536 average_max_(0),
3537 path_(path) {
3538 if (!path_.empty()) {
3539 Load();
3540 }
3541}
3542
3543void Progress::Load() {
3544 MYLOGD("Loading stats from %s\n", path_.c_str());
3545 std::string content;
3546 if (!android::base::ReadFileToString(path_, &content)) {
3547 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3548 return;
3549 }
3550 if (content.empty()) {
3551 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3552 return;
3553 }
3554 std::vector<std::string> lines = android::base::Split(content, "\n");
3555
3556 if (lines.size() < 1) {
3557 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3558 (int)lines.size(), max_);
3559 return;
3560 }
3561 char* ptr;
3562 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3563 average_max_ = strtol(ptr, nullptr, 10);
3564 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3565 average_max_ > STATS_MAX_AVERAGE) {
3566 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3567 initial_max_ = Progress::kDefaultMax;
3568 } else {
3569 initial_max_ = average_max_;
3570 }
3571 max_ = initial_max_;
3572
3573 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3574}
3575
3576void Progress::Save() {
3577 int32_t total = n_runs_ * average_max_ + progress_;
3578 int32_t runs = n_runs_ + 1;
3579 int32_t average = floor(((float)total) / runs);
3580 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3581 path_.c_str());
3582 if (path_.empty()) {
3583 return;
3584 }
3585
3586 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3587 if (!android::base::WriteStringToFile(content, path_)) {
3588 MYLOGE("Could not save stats on %s\n", path_.c_str());
3589 }
3590}
3591
3592int32_t Progress::Get() const {
3593 return progress_;
3594}
3595
3596bool Progress::Inc(int32_t delta_sec) {
3597 bool changed = false;
3598 if (delta_sec >= 0) {
3599 progress_ += delta_sec;
3600 if (progress_ > max_) {
3601 int32_t old_max = max_;
3602 max_ = floor((float)progress_ * growth_factor_);
3603 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3604 changed = true;
3605 }
3606 }
3607 return changed;
3608}
3609
3610int32_t Progress::GetMax() const {
3611 return max_;
3612}
3613
3614int32_t Progress::GetInitialMax() const {
3615 return initial_max_;
3616}
3617
3618void Progress::Dump(int fd, const std::string& prefix) const {
3619 const char* pr = prefix.c_str();
3620 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3621 dprintf(fd, "%smax: %d\n", pr, max_);
3622 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3623 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3624 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3625 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3626 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3627}
3628
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003629std::string Dumpstate::GetPath(const std::string& suffix) const {
3630 return GetPath(bugreport_internal_dir_, suffix);
3631}
3632
3633std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3634 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3635 name_.c_str(), suffix.c_str());
3636}
3637
3638void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3639 progress_ = std::move(progress);
3640}
3641
3642void for_each_userid(void (*func)(int), const char *header) {
3643 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3644 "for_each_userid(%s)", header);
3645 DurationReporter duration_reporter(title);
3646 if (PropertiesHelper::IsDryRun()) return;
3647
3648 DIR *d;
3649 struct dirent *de;
3650
3651 if (header) printf("\n------ %s ------\n", header);
3652 func(0);
3653
3654 if (!(d = opendir("/data/system/users"))) {
3655 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3656 return;
3657 }
3658
3659 while ((de = readdir(d))) {
3660 int userid;
3661 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3662 continue;
3663 }
3664 func(userid);
3665 }
3666
3667 closedir(d);
3668}
3669
3670static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3671 DIR *d;
3672 struct dirent *de;
3673
3674 if (!(d = opendir("/proc"))) {
3675 printf("Failed to open /proc (%s)\n", strerror(errno));
3676 return;
3677 }
3678
3679 if (header) printf("\n------ %s ------\n", header);
3680 while ((de = readdir(d))) {
3681 if (ds.IsUserConsentDenied()) {
3682 MYLOGE(
3683 "Returning early because user denied consent to share bugreport with calling app.");
3684 closedir(d);
3685 return;
3686 }
3687 int pid;
3688 int fd;
3689 char cmdpath[255];
3690 char cmdline[255];
3691
3692 if (!(pid = atoi(de->d_name))) {
3693 continue;
3694 }
3695
3696 memset(cmdline, 0, sizeof(cmdline));
3697
3698 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3699 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3700 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3701 close(fd);
3702 if (cmdline[0]) {
3703 helper(pid, cmdline, arg);
3704 continue;
3705 }
3706 }
3707
3708 // if no cmdline, a kernel thread has comm
3709 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3710 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3711 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3712 close(fd);
3713 if (cmdline[1]) {
3714 cmdline[0] = '[';
3715 size_t len = strcspn(cmdline, "\f\b\r\n");
3716 cmdline[len] = ']';
3717 cmdline[len+1] = '\0';
3718 }
3719 }
3720 if (!cmdline[0]) {
3721 strcpy(cmdline, "N/A");
3722 }
3723 helper(pid, cmdline, arg);
3724 }
3725
3726 closedir(d);
3727}
3728
3729static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3730 for_each_pid_func *func = (for_each_pid_func*) arg;
3731 func(pid, cmdline);
3732}
3733
3734void for_each_pid(for_each_pid_func func, const char *header) {
3735 std::string title = header == nullptr ? "for_each_pid"
3736 : android::base::StringPrintf("for_each_pid(%s)", header);
3737 DurationReporter duration_reporter(title);
3738 if (PropertiesHelper::IsDryRun()) return;
3739
3740 __for_each_pid(for_each_pid_helper, header, (void *) func);
3741}
3742
3743static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3744 DIR *d;
3745 struct dirent *de;
3746 char taskpath[255];
3747 for_each_tid_func *func = (for_each_tid_func *) arg;
3748
3749 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3750
3751 if (!(d = opendir(taskpath))) {
3752 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3753 return;
3754 }
3755
3756 func(pid, pid, cmdline);
3757
3758 while ((de = readdir(d))) {
3759 if (ds.IsUserConsentDenied()) {
3760 MYLOGE(
3761 "Returning early because user denied consent to share bugreport with calling app.");
3762 closedir(d);
3763 return;
3764 }
3765 int tid;
3766 int fd;
3767 char commpath[255];
3768 char comm[255];
3769
3770 if (!(tid = atoi(de->d_name))) {
3771 continue;
3772 }
3773
3774 if (tid == pid)
3775 continue;
3776
3777 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3778 memset(comm, 0, sizeof(comm));
3779 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3780 strcpy(comm, "N/A");
3781 } else {
3782 char *c;
3783 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3784 close(fd);
3785
3786 c = strrchr(comm, '\n');
3787 if (c) {
3788 *c = '\0';
3789 }
3790 }
3791 func(pid, tid, comm);
3792 }
3793
3794 closedir(d);
3795}
3796
3797void for_each_tid(for_each_tid_func func, const char *header) {
3798 std::string title = header == nullptr ? "for_each_tid"
3799 : android::base::StringPrintf("for_each_tid(%s)", header);
3800 DurationReporter duration_reporter(title);
3801
3802 if (PropertiesHelper::IsDryRun()) return;
3803
3804 __for_each_pid(for_each_tid_helper, header, (void *) func);
3805}
3806
3807void show_wchan(int pid, int tid, const char *name) {
3808 if (PropertiesHelper::IsDryRun()) return;
3809
3810 char path[255];
3811 char buffer[255];
3812 int fd, ret, save_errno;
3813 char name_buffer[255];
3814
3815 memset(buffer, 0, sizeof(buffer));
3816
3817 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3818 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3819 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3820 return;
3821 }
3822
3823 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3824 save_errno = errno;
3825 close(fd);
3826
3827 if (ret < 0) {
3828 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3829 return;
3830 }
3831
3832 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3833 pid == tid ? 0 : 3, "", name);
3834
3835 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3836
3837 return;
3838}
3839
3840// print time in centiseconds
3841static void snprcent(char *buffer, size_t len, size_t spc,
3842 unsigned long long time) {
3843 static long hz; // cache discovered hz
3844
3845 if (hz <= 0) {
3846 hz = sysconf(_SC_CLK_TCK);
3847 if (hz <= 0) {
3848 hz = 1000;
3849 }
3850 }
3851
3852 // convert to centiseconds
3853 time = (time * 100 + (hz / 2)) / hz;
3854
3855 char str[16];
3856
3857 snprintf(str, sizeof(str), " %llu.%02u",
3858 time / 100, (unsigned)(time % 100));
3859 size_t offset = strlen(buffer);
3860 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3861 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3862}
3863
3864// print permille as a percent
3865static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3866 char str[16];
3867
3868 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3869 size_t offset = strlen(buffer);
3870 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3871 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3872}
3873
3874void show_showtime(int pid, const char *name) {
3875 if (PropertiesHelper::IsDryRun()) return;
3876
3877 char path[255];
3878 char buffer[1023];
3879 int fd, ret, save_errno;
3880
3881 memset(buffer, 0, sizeof(buffer));
3882
3883 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3884 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3885 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3886 return;
3887 }
3888
3889 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3890 save_errno = errno;
3891 close(fd);
3892
3893 if (ret < 0) {
3894 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3895 return;
3896 }
3897
3898 // field 14 is utime
3899 // field 15 is stime
3900 // field 42 is iotime
3901 unsigned long long utime = 0, stime = 0, iotime = 0;
3902 if (sscanf(buffer,
3903 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3904 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3905 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3906 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3907 &utime, &stime, &iotime) != 3) {
3908 return;
3909 }
3910
3911 unsigned long long total = utime + stime;
3912 if (!total) {
3913 return;
3914 }
3915
3916 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3917 if (permille > 1000) {
3918 permille = 1000;
3919 }
3920
3921 // try to beautify and stabilize columns at <80 characters
3922 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3923 if ((name[0] != '[') || utime) {
3924 snprcent(buffer, sizeof(buffer), 57, utime);
3925 }
3926 snprcent(buffer, sizeof(buffer), 65, stime);
3927 if ((name[0] != '[') || iotime) {
3928 snprcent(buffer, sizeof(buffer), 73, iotime);
3929 }
3930 if (iotime) {
3931 snprdec(buffer, sizeof(buffer), 79, permille);
3932 }
3933 puts(buffer); // adds a trailing newline
3934
3935 return;
3936}
3937
3938void do_dmesg() {
3939 const char *title = "KERNEL LOG (dmesg)";
3940 DurationReporter duration_reporter(title);
3941 printf("------ %s ------\n", title);
3942
3943 if (PropertiesHelper::IsDryRun()) return;
3944
3945 /* Get size of kernel buffer */
3946 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3947 if (size <= 0) {
3948 printf("Unexpected klogctl return value: %d\n\n", size);
3949 return;
3950 }
3951 char *buf = (char *) malloc(size + 1);
3952 if (buf == nullptr) {
3953 printf("memory allocation failed\n\n");
3954 return;
3955 }
3956 int retval = klogctl(KLOG_READ_ALL, buf, size);
3957 if (retval < 0) {
3958 printf("klogctl failure\n\n");
3959 free(buf);
3960 return;
3961 }
3962 buf[retval] = '\0';
3963 printf("%s\n\n", buf);
3964 free(buf);
3965 return;
3966}
3967
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003968int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3969 DurationReporter duration_reporter(title);
3970
3971 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3972
3973 UpdateProgress(WEIGHT_FILE);
3974
3975 return status;
3976}
3977
3978int read_file_as_long(const char *path, long int *output) {
3979 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3980 if (fd < 0) {
3981 int err = errno;
3982 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3983 return -1;
3984 }
3985 char buffer[50];
3986 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3987 if (bytes_read == -1) {
3988 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3989 return -2;
3990 }
3991 if (bytes_read == 0) {
3992 MYLOGE("File %s is empty\n", path);
3993 return -3;
3994 }
3995 *output = atoi(buffer);
3996 return 0;
3997}
3998
3999/* calls skip to gate calling dump_from_fd recursively
4000 * in the specified directory. dump_from_fd defaults to
4001 * dump_file_from_fd above when set to NULL. skip defaults
4002 * to false when set to NULL. dump_from_fd will always be
4003 * called with title NULL.
4004 */
4005int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4006 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4007 DurationReporter duration_reporter(title);
4008 DIR *dirp;
4009 struct dirent *d;
4010 char *newpath = nullptr;
4011 const char *slash = "/";
4012 int retval = 0;
4013
4014 if (!title.empty()) {
4015 printf("------ %s (%s) ------\n", title.c_str(), dir);
4016 }
4017 if (PropertiesHelper::IsDryRun()) return 0;
4018
4019 if (dir[strlen(dir) - 1] == '/') {
4020 ++slash;
4021 }
4022 dirp = opendir(dir);
4023 if (dirp == nullptr) {
4024 retval = -errno;
4025 MYLOGE("%s: %s\n", dir, strerror(errno));
4026 return retval;
4027 }
4028
4029 if (!dump_from_fd) {
4030 dump_from_fd = dump_file_from_fd;
4031 }
4032 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4033 if ((d->d_name[0] == '.')
4034 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4035 || (d->d_name[1] == '\0'))) {
4036 continue;
4037 }
4038 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4039 (d->d_type == DT_DIR) ? "/" : "");
4040 if (!newpath) {
4041 retval = -errno;
4042 continue;
4043 }
4044 if (skip && (*skip)(newpath)) {
4045 continue;
4046 }
4047 if (d->d_type == DT_DIR) {
4048 int ret = dump_files("", newpath, skip, dump_from_fd);
4049 if (ret < 0) {
4050 retval = ret;
4051 }
4052 continue;
4053 }
4054 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4055 if (fd.get() < 0) {
4056 retval = -1;
4057 printf("*** %s: %s\n", newpath, strerror(errno));
4058 continue;
4059 }
4060 (*dump_from_fd)(nullptr, newpath, fd.get());
4061 }
4062 closedir(dirp);
4063 if (!title.empty()) {
4064 printf("\n");
4065 }
4066 return retval;
4067}
4068
4069/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4070 * it's possible to avoid issues where opening the file itself can get
4071 * stuck.
4072 */
4073int dump_file_from_fd(const char *title, const char *path, int fd) {
4074 if (PropertiesHelper::IsDryRun()) return 0;
4075
4076 int flags = fcntl(fd, F_GETFL);
4077 if (flags == -1) {
4078 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4079 return -1;
4080 } else if (!(flags & O_NONBLOCK)) {
4081 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4082 return -1;
4083 }
4084 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4085}
4086
4087int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004088 const CommandOptions& options, bool verbose_duration, int out_fd) {
4089 DurationReporter duration_reporter(title, false /* logcat_only */,
4090 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004091
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004092 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004093
4094 /* TODO: for now we're simplifying the progress calculation by using the
4095 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4096 * where its weight should be much higher proportionally to its timeout.
4097 * Ideally, it should use a options.EstimatedDuration() instead...*/
4098 UpdateProgress(options.Timeout());
4099
4100 return status;
4101}
4102
4103void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004104 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004105 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4106 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4107 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004108 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004109}
4110
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004111static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004112 int s = android_get_control_socket(service);
4113 if (s < 0) {
4114 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4115 return -1;
4116 }
4117 fcntl(s, F_SETFD, FD_CLOEXEC);
4118
4119 // Set backlog to 0 to make sure that queue size will be minimum.
4120 // In Linux, because the minimum queue will be 1, connect() will be blocked
4121 // if the other clients already called connect() and the connection request was not accepted.
4122 if (listen(s, 0) < 0) {
4123 MYLOGE("listen(control socket): %s\n", strerror(errno));
4124 return -1;
4125 }
4126
4127 struct sockaddr addr;
4128 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004129 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004130
4131 // Close socket just after accept(), to make sure that connect() by client will get error
4132 // when the socket is used by the other services.
4133 // There is still a race condition possibility between accept and close, but there is no way
4134 // to close-on-accept atomically.
4135 // See detail; b/123306389#comment25
4136 close(s);
4137
4138 if (fd < 0) {
4139 MYLOGE("accept(control socket): %s\n", strerror(errno));
4140 return -1;
4141 }
4142
4143 return fd;
4144}
4145
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004146// TODO: should call is_valid_output_file and/or be merged into it.
4147void create_parent_dirs(const char *path) {
4148 char *chp = const_cast<char *> (path);
4149
4150 /* skip initial slash */
4151 if (chp[0] == '/')
4152 chp++;
4153
4154 /* create leading directories, if necessary */
4155 struct stat dir_stat;
4156 while (chp && chp[0]) {
4157 chp = strchr(chp, '/');
4158 if (chp) {
4159 *chp = 0;
4160 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4161 MYLOGI("Creating directory %s\n", path);
4162 if (mkdir(path, 0770)) { /* drwxrwx--- */
4163 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4164 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4165 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4166 }
4167 }
4168 *chp++ = '/';
4169 }
4170 }
4171}
4172
4173bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4174 create_parent_dirs(path);
4175
4176 int fd = TEMP_FAILURE_RETRY(open(path,
4177 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4178 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4179 if (fd < 0) {
4180 MYLOGE("%s: %s\n", path, strerror(errno));
4181 return false;
4182 }
4183
4184 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4185 close(fd);
4186 return true;
4187}
4188
4189bool redirect_to_file(FILE* redirect, char* path) {
4190 return _redirect_to_file(redirect, path, O_TRUNC);
4191}
4192
4193bool redirect_to_existing_file(FILE* redirect, char* path) {
4194 return _redirect_to_file(redirect, path, O_APPEND);
4195}
4196
4197void dump_route_tables() {
4198 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4199 if (PropertiesHelper::IsDryRun()) return;
4200 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4201 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4202 FILE* fp = fopen(RT_TABLES_PATH, "re");
4203 if (!fp) {
4204 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4205 return;
4206 }
4207 char table[16];
4208 // Each line has an integer (the table number), a space, and a string (the table name). We only
4209 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4210 // Add a fixed max limit so this doesn't go awry.
4211 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4212 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4213 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4214 }
4215 fclose(fp);
4216}
4217
Li Li830179f2022-01-04 12:53:29 -08004218void dump_frozen_cgroupfs(const char *dir, int level,
4219 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4220 DIR *dirp;
4221 struct dirent *d;
4222 char *newpath = nullptr;
4223
4224 dirp = opendir(dir);
4225 if (dirp == nullptr) {
4226 MYLOGE("%s: %s\n", dir, strerror(errno));
4227 return;
4228 }
4229
4230 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4231 if ((d->d_name[0] == '.')
4232 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4233 || (d->d_name[1] == '\0'))) {
4234 continue;
4235 }
4236 if (d->d_type == DT_DIR) {
4237 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4238 if (!newpath) {
4239 continue;
4240 }
4241 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4242 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4243 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4244 char *freezer = nullptr;
4245 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4246 if (freezer) {
4247 FILE* fp = fopen(freezer, "r");
4248 if (fp != NULL) {
4249 int frozen;
4250 fscanf(fp, "%d", &frozen);
4251 if (frozen > 0) {
4252 dump_files("", newpath, skip_none, dump_from_fd);
4253 }
4254 fclose(fp);
4255 }
4256 free(freezer);
4257 }
4258 }
4259 }
4260 }
4261 closedir(dirp);
4262}
4263
4264void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004265 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4266 DurationReporter duration_reporter("FROZEN CGROUPFS");
4267 if (PropertiesHelper::IsDryRun()) return;
4268 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4269}
4270
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004271void Dumpstate::UpdateProgress(int32_t delta_sec) {
4272 if (progress_ == nullptr) {
4273 MYLOGE("UpdateProgress: progress_ not set\n");
4274 return;
4275 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004276 // This function updates progress related members of the dumpstate and reports
4277 // progress percentage to the bugreport client. Since it could be called by
4278 // different dump tasks at the same time if the parallel run is enabled, a
4279 // mutex lock is necessary here to synchronize the call.
4280 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004281
4282 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004283 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004284
4285 // ...but only notifiy listeners when necessary.
4286 if (!options_->do_progress_updates) return;
4287
4288 int progress = progress_->Get();
4289 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004290 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004291
Nandana Dutt402a8392019-06-14 14:25:13 +01004292 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004293 return;
4294 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004295 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004296
4297 if (control_socket_fd_ >= 0) {
4298 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4299 fsync(control_socket_fd_);
4300 }
4301
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004302 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004303 if (percent % 10 == 0) {
4304 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004305 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004306 } else {
4307 // stderr is ignored on normal invocations, but useful when calling
4308 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004309 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004310 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004311
4312 listener_->onProgress(percent);
4313 }
4314}
4315
4316void Dumpstate::TakeScreenshot(const std::string& path) {
4317 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4318 int status =
4319 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4320 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4321 if (status == 0) {
4322 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4323 } else {
4324 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4325 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004326 if (listener_ != nullptr) {
4327 // Show a visual indication to indicate screenshot is taken via
4328 // IDumpstateListener.onScreenshotTaken()
4329 listener_->onScreenshotTaken(status == 0);
4330 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004331}
4332
4333bool is_dir(const char* pathname) {
4334 struct stat info;
4335 if (stat(pathname, &info) == -1) {
4336 return false;
4337 }
4338 return S_ISDIR(info.st_mode);
4339}
4340
4341time_t get_mtime(int fd, time_t default_mtime) {
4342 struct stat info;
4343 if (fstat(fd, &info) == -1) {
4344 return default_mtime;
4345 }
4346 return info.st_mtime;
4347}