blob: 54b138fea93c59899542e9ae0d077d9140e2616a [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080077#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070078#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010079#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000080#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000081#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000083#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010084#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080085#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010086#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070087#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070088#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070089#include <private/android_filesystem_config.h>
90#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080091#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070092#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000093#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080094#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070095#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070096#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080097
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000098namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
99namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
100namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
101
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using ::std::literals::chrono_literals::operator""ms;
103using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800104using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800105
Felipe Leme47e9be22016-12-21 15:37:07 -0800106// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800107using android::defaultServiceManager;
108using android::Dumpsys;
109using android::INVALID_OPERATION;
110using android::IServiceManager;
111using android::OK;
112using android::sp;
113using android::status_t;
114using android::String16;
115using android::String8;
116using android::TIMED_OUT;
117using android::UNKNOWN_ERROR;
118using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000119using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000120using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121using android::os::dumpstate::CommandOptions;
122using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800123using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800124using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800125using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800126using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800127
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100128// Keep in sync with
129// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
130static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
131
132/* Most simple commands have 10 as timeout, so 5 is a good estimate */
133static const int32_t WEIGHT_FILE = 5;
134
135// TODO: temporary variables and functions used during C++ refactoring
136static Dumpstate& ds = Dumpstate::GetInstance();
137static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100138 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800139 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
140 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100141}
142
143// Reasonable value for max stats.
144static const int STATS_MAX_N_RUNS = 1000;
145static const long STATS_MAX_AVERAGE = 100000;
146
147CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
148
Nandana Duttd2f5f082019-01-18 17:13:52 +0000149typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
150
Colin Crossf45fa6b2012-03-26 12:38:26 -0700151/* read before root is shed */
152static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700153static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000154static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800155// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
156// it's often the case that they time out far too quickly for consent with such a hefty dialog for
157// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
158// roughly match full reports' durations.
159static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700160
Felipe Leme1d486fe2016-10-14 18:06:47 -0700161// TODO: variables and functions below should be part of dumpstate object
162
Felipe Leme635ca312016-01-05 14:23:02 -0800163static std::set<std::string> mount_points;
164void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800165
Todd Poynor2a83daa2013-11-22 15:44:22 -0800166#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700167#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700168#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169
Felipe Lemee82a27d2016-01-05 13:35:44 -0800170#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700171#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700172#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700173#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700174#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800175#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100176#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
177#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800178#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900179#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800180#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700181#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800182#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900183#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700184#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000185#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700186#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200187#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700188#define DROPBOX_DIR "/data/system/dropbox"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700189
Narayan Kamath8f788292017-05-25 13:20:39 +0100190// TODO(narayan): Since this information has to be kept in sync
191// with tombstoned, we should just put it in a common header.
192//
193// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100194static const std::string TOMBSTONE_DIR = "/data/tombstones/";
195static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
196static const std::string ANR_DIR = "/data/anr/";
197static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800198static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
199static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000202
Nandana Dutt5c390032019-03-12 10:52:56 +0000203#define RETURN_IF_USER_DENIED_CONSENT() \
204 if (ds.IsUserConsentDenied()) { \
205 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
206 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
207 }
208
209// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
210// if consent is found to be denied.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 func_ptr(__VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao5377d792020-07-16 17:37:39 +0800216// Runs func_ptr, and logs a duration report after it's finished.
217#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
218 { \
219 DurationReporter duration_reporter_in_macro(log_title); \
220 func_ptr(__VA_ARGS__); \
221 }
222
223// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
224// is output after a slow function is finished.
225#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
226 RETURN_IF_USER_DENIED_CONSENT(); \
227 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
228 RETURN_IF_USER_DENIED_CONSENT();
229
Chris Morinbc223142022-02-04 14:17:11 -0800230#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800231 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800232 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800233 RETURN_IF_USER_DENIED_CONSENT();
234
Sahana Raof35ed432019-07-12 10:47:52 +0100235static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
236
Rhed Jao5377d792020-07-16 17:37:39 +0800237// Names of parallel tasks, they are used for the DumpPool to identify the dump
238// task and the log title of the duration report.
239static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800240static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800241static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800242static const std::string DUMP_HALS_TASK = "DUMP HALS";
243static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800244static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800245
Nandana Dutt979388e2018-11-30 16:48:55 +0000246namespace android {
247namespace os {
248namespace {
249
250static int Open(std::string path, int flags, mode_t mode = 0) {
251 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
252 if (fd == -1) {
253 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
254 }
255 return fd;
256}
257
mhasank2d75c442020-06-11 15:05:25 -0700258static int OpenForWrite(std::string path) {
259 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
260 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
261}
Nandana Dutt979388e2018-11-30 16:48:55 +0000262
263static int OpenForRead(std::string path) {
264 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
265}
266
267bool CopyFile(int in_fd, int out_fd) {
268 char buf[4096];
269 ssize_t byte_count;
270 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
271 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
272 return false;
273 }
274 }
275 return (byte_count != -1);
276}
277
278static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000279 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000280
281 // Obtain a handle to the source file.
282 android::base::unique_fd in_fd(OpenForRead(input_file));
283 if (out_fd != -1 && in_fd.get() != -1) {
284 if (CopyFile(in_fd.get(), out_fd)) {
285 return true;
286 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000287 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000288 }
289 return false;
290}
291
Nandana Duttd2f5f082019-01-18 17:13:52 +0000292static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000293 if (file.empty()) {
294 return false;
295 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000296 if (unlink(file.c_str())) {
297 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000298 return false;
299 }
300 return true;
301}
Nandana Dutt979388e2018-11-30 16:48:55 +0000302
Nikita Ioffea325a572019-05-16 19:49:47 +0100303int64_t GetModuleMetadataVersion() {
304 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
305 if (binder == nullptr) {
306 MYLOGE("Failed to retrieve package_native service");
307 return 0L;
308 }
309 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
310 std::string package_name;
311 auto status = package_service->getModuleMetadataPackageName(&package_name);
312 if (!status.isOk()) {
313 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
314 return 0L;
315 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100316 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100317 int64_t version_code;
318 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
319 &version_code);
320 if (!status.isOk()) {
321 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
322 return 0L;
323 }
324 return version_code;
325}
326
mhasank2d75c442020-06-11 15:05:25 -0700327static bool PathExists(const std::string& path) {
328 struct stat sb;
329 return stat(path.c_str(), &sb) == 0;
330}
331
332static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
333 if (input_file == output_file) {
334 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
335 output_file.c_str());
336 return false;
337 }
338 else if (PathExists(output_file)) {
339 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
340 return false;
341 }
342
343 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
344 android::base::unique_fd out_fd(OpenForWrite(output_file));
345 return CopyFileToFd(input_file, out_fd.get());
346}
347
Nandana Dutt979388e2018-11-30 16:48:55 +0000348} // namespace
349} // namespace os
350} // namespace android
351
Felipe Leme678727a2016-09-21 17:22:11 -0700352static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800353 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800354 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
355 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
356}
357static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
358 int out_fd) {
359 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700360}
361static int DumpFile(const std::string& title, const std::string& path) {
362 return ds.DumpFile(title, path);
363}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800364
Felipe Lemee844a9d2016-09-21 15:01:39 -0700365// Relative directory (inside the zip) for all files copied as-is into the bugreport.
366static const std::string ZIP_ROOT_DIR = "FS";
367
Vishnu Naire97d6122018-01-18 13:58:56 -0800368static const std::string kProtoPath = "proto/";
369static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700370static const std::string kDumpstateBoardFiles[] = {
371 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700372 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700373};
374static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
375
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700376static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700377static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700378
Felipe Lemef0292972016-11-22 13:57:05 -0800379static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
380
Narayan Kamath8f788292017-05-25 13:20:39 +0100381/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100382 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800383 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800384 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100385 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800387 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100388 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100389
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700390 if (dump_dir == nullptr) {
391 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700392 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700393 }
394
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700395 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 struct dirent* entry = nullptr;
397 while ((entry = readdir(dump_dir.get()))) {
398 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100399 continue;
400 }
401
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 const std::string base_name(entry->d_name);
403 if (base_name.find(file_prefix) != 0) {
404 continue;
405 }
406
407 const std::string abs_path = dir_path + base_name;
408 android::base::unique_fd fd(
409 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
410 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700411 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 break;
413 }
414
415 struct stat st = {};
416 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700417 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100418 continue;
419 }
420
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700421 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700422 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800423 if (!dump_data.empty()) {
424 std::sort(dump_data.begin(), dump_data.end(),
425 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
426 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100429}
430
Narayan Kamathbd863722017-06-01 18:50:12 +0100431static bool AddDumps(const std::vector<DumpData>::const_iterator start,
432 const std::vector<DumpData>::const_iterator end,
433 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100435 for (auto it = start; it != end; ++it) {
436 const std::string& name = it->name;
437 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100438 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100439
440 // Seek to the beginning of the file before dumping any data. A given
441 // DumpData entry might be dumped multiple times in the report.
442 //
443 // For example, the most recent ANR entry is dumped to the body of the
444 // main entry and it also shows up as a separate entry in the bugreport
445 // ZIP file.
446 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
447 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
448 strerror(errno));
449 }
450
Chris Morinc2cba7a2022-02-01 17:06:50 -0800451 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800452 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100453 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455 } else {
456 dump_file_from_fd(type_name, name.c_str(), fd);
457 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100458 }
459
460 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700461}
462
Felipe Leme635ca312016-01-05 14:23:02 -0800463// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700464void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char path[PATH_MAX];
466
467 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
468 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700469 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800470 char linkname[PATH_MAX];
471 ssize_t r = readlink(path, linkname, PATH_MAX);
472 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800473 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800474 return;
475 }
476 linkname[r] = '\0';
477
478 if (mount_points.find(linkname) == mount_points.end()) {
479 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700480 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700481 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800482 mount_points.insert(linkname);
483 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800484 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800485 }
486 }
487}
488
489void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700490 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800491 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800492 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700493 for_each_pid(do_mountinfo, nullptr);
494 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800495}
496
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700497static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
498{
499 DIR *d;
500 struct dirent *de;
501 char path[PATH_MAX];
502
503 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700504 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700505 return;
506 }
507
508 while ((de = readdir(d))) {
509 if (de->d_type != DT_LNK) {
510 continue;
511 }
512 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700513 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700514 }
515
516 closedir(d);
517}
518
Mark Salyzyn326842f2015-04-30 09:49:41 -0700519static bool skip_not_stat(const char *path) {
520 static const char stat[] = "/stat";
521 size_t len = strlen(path);
522 if (path[len - 1] == '/') { /* Directory? */
523 return false;
524 }
525 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
526}
527
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700528static bool skip_wtf_strictmode(const char *path) {
529 if (strstr(path, "_wtf")) {
530 return true;
531 } else if (strstr(path, "_strictmode")) {
532 return true;
533 }
534 return false;
535}
536
Felipe Leme4c2d6632016-09-28 14:32:00 -0700537static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800538 return false;
539}
540
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700541unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800543//
544// stat offsets
545// Name units description
546// ---- ----- -----------
547// read I/Os requests number of read I/Os processed
548#define __STAT_READ_IOS 0
549// read merges requests number of read I/Os merged with in-queue I/O
550#define __STAT_READ_MERGES 1
551// read sectors sectors number of sectors read
552#define __STAT_READ_SECTORS 2
553// read ticks milliseconds total wait time for read requests
554#define __STAT_READ_TICKS 3
555// write I/Os requests number of write I/Os processed
556#define __STAT_WRITE_IOS 4
557// write merges requests number of write I/Os merged with in-queue I/O
558#define __STAT_WRITE_MERGES 5
559// write sectors sectors number of sectors written
560#define __STAT_WRITE_SECTORS 6
561// write ticks milliseconds total wait time for write requests
562#define __STAT_WRITE_TICKS 7
563// in_flight requests number of I/Os currently in flight
564#define __STAT_IN_FLIGHT 8
565// io_ticks milliseconds total time this block device has been active
566#define __STAT_IO_TICKS 9
567// time_in_queue milliseconds total wait time for all requests
568#define __STAT_IN_QUEUE 10
569#define __STAT_NUMBER_FIELD 11
570//
571// read I/Os, write I/Os
572// =====================
573//
574// These values increment when an I/O request completes.
575//
576// read merges, write merges
577// =========================
578//
579// These values increment when an I/O request is merged with an
580// already-queued I/O request.
581//
582// read sectors, write sectors
583// ===========================
584//
585// These values count the number of sectors read from or written to this
586// block device. The "sectors" in question are the standard UNIX 512-byte
587// sectors, not any device- or filesystem-specific block size. The
588// counters are incremented when the I/O completes.
589#define SECTOR_SIZE 512
590//
591// read ticks, write ticks
592// =======================
593//
594// These values count the number of milliseconds that I/O requests have
595// waited on this block device. If there are multiple I/O requests waiting,
596// these values will increase at a rate greater than 1000/second; for
597// example, if 60 read requests wait for an average of 30 ms, the read_ticks
598// field will increase by 60*30 = 1800.
599//
600// in_flight
601// =========
602//
603// This value counts the number of I/O requests that have been issued to
604// the device driver but have not yet completed. It does not include I/O
605// requests that are in the queue but not yet issued to the device driver.
606//
607// io_ticks
608// ========
609//
610// This value counts the number of milliseconds during which the device has
611// had I/O requests queued.
612//
613// time_in_queue
614// =============
615//
616// This value counts the number of milliseconds that I/O requests have waited
617// on this block device. If there are multiple I/O requests waiting, this
618// value will increase as the product of the number of milliseconds times the
619// number of requests waiting (see "read ticks" above for an example).
620#define S_TO_MS 1000
621//
622
Mark Salyzyn326842f2015-04-30 09:49:41 -0700623static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800624 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700626 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700628 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 getline(&buffer, &i, fp);
630 fclose(fp);
631 if (!buffer) {
632 return -errno;
633 }
634 i = strlen(buffer);
635 while ((i > 0) && (buffer[i - 1] == '\n')) {
636 buffer[--i] = '\0';
637 }
638 if (!*buffer) {
639 free(buffer);
640 return 0;
641 }
642 z = true;
643 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800644 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700645 if (fields[i] != 0) {
646 z = false;
647 }
648 }
649 if (z) { /* never accessed */
650 free(buffer);
651 return 0;
652 }
653
Wei Wang509bb5d2017-06-09 14:42:12 -0700654 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
655 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700656 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700657
658 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
659 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
660 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700661 free(buffer);
662
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800663 if (fields[__STAT_IO_TICKS]) {
664 unsigned long read_perf = 0;
665 unsigned long read_ios = 0;
666 if (fields[__STAT_READ_TICKS]) {
667 unsigned long long divisor = fields[__STAT_READ_TICKS]
668 * fields[__STAT_IO_TICKS];
669 read_perf = ((unsigned long long)SECTOR_SIZE
670 * fields[__STAT_READ_SECTORS]
671 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
672 / divisor;
673 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
674 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
675 / divisor;
676 }
677
678 unsigned long write_perf = 0;
679 unsigned long write_ios = 0;
680 if (fields[__STAT_WRITE_TICKS]) {
681 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
682 * fields[__STAT_IO_TICKS];
683 write_perf = ((unsigned long long)SECTOR_SIZE
684 * fields[__STAT_WRITE_SECTORS]
685 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
686 / divisor;
687 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
688 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
689 / divisor;
690 }
691
692 unsigned queue = (fields[__STAT_IN_QUEUE]
693 + (fields[__STAT_IO_TICKS] >> 1))
694 / fields[__STAT_IO_TICKS];
695
696 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700697 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800698 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700699 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800700 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800701 }
702
703 /* bugreport timeout factor adjustment */
704 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
705 worst_write_perf = write_perf;
706 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700707 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700708 return 0;
709}
710
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
712
Tom Cherryf4472f32020-08-05 09:31:17 -0700713// Returns the actual readable size of the given buffer or -1 on error.
714static long logcat_buffer_readable_size(const std::string& buffer) {
715 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
716 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
717 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
718
719 return android_logger_get_log_readable_size(logger);
720}
721
722// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800723static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
724 unsigned long timeout_ms = 0;
725 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700726 long readable_size = logcat_buffer_readable_size(buffer);
727 if (readable_size > 0) {
728 // Engineering margin is ten-fold our guess.
729 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
730 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800731 }
732 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700733}
734
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800735// Opens a socket and returns its file descriptor.
736static int open_socket(const char* service);
737
Nandana Duttd2f5f082019-01-18 17:13:52 +0000738Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
739}
740
741android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
742 std::lock_guard<std::mutex> lock(lock_);
743 result_ = APPROVED;
744 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800745
746 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
747 // consent is granted.
748 if (ds.options_->is_screenshot_copied) {
749 return android::binder::Status::ok();
750 }
751
752 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
753 !ds.do_early_screenshot_) {
754 return android::binder::Status::ok();
755 }
756
757 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
758 ds.options_->screenshot_fd.get());
759 ds.options_->is_screenshot_copied = copy_succeeded;
760 if (copy_succeeded) {
761 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
762 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000763 return android::binder::Status::ok();
764}
765
766android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
767 std::lock_guard<std::mutex> lock(lock_);
768 result_ = DENIED;
769 MYLOGW("User denied consent to share bugreport\n");
770 return android::binder::Status::ok();
771}
772
773UserConsentResult Dumpstate::ConsentCallback::getResult() {
774 std::lock_guard<std::mutex> lock(lock_);
775 return result_;
776}
777
778uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800779 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000780}
781
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700782void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200783 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700784 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
787 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
789 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
790 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200791 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700792 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700793
Felipe Lemed8b94e52016-12-08 10:21:44 -0800794 printf("========================================================\n");
795 printf("== dumpstate: %s\n", date);
796 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700797
Felipe Lemed8b94e52016-12-08 10:21:44 -0800798 printf("\n");
799 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700800 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
802 printf("Bootloader: %s\n", bootloader.c_str());
803 printf("Radio: %s\n", radio.c_str());
804 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100805 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
806 if (module_metadata_version != 0) {
807 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
808 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200809 printf("Android SDK version: %s\n", sdkversion.c_str());
810 printf("SDK extensions: ");
811 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
812 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700813
Felipe Lemed8b94e52016-12-08 10:21:44 -0800814 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800815 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Felipe Leme7709f8a2017-12-05 09:30:09 -0800817 printf("Uptime: ");
818 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
819 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800820 printf("Bugreport format version: %s\n", version_.c_str());
Rhed Jao5377d792020-07-16 17:37:39 +0800821 printf("Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d args=%s bugreport_mode=%s\n",
822 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000823 options_->args.c_str(), options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800824 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800825}
826
Felipe Leme24b66ee2016-06-16 10:55:26 -0700827// List of file extensions that can cause a zip file attachment to be rejected by some email
828// service providers.
829static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
830 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
831 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
832 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
833};
834
Vishnu Naire97d6122018-01-18 13:58:56 -0800835status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
836 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700837 std::string valid_name = entry_name;
838
839 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700840 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700841 if (idx != std::string::npos) {
842 std::string extension = entry_name.substr(idx);
843 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
844 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
845 valid_name = entry_name + ".renamed";
846 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
847 }
848 }
849
Felipe Leme6fe9db62016-02-12 09:04:16 -0800850 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
851 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000852 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
853 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700854 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700855 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700856 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700857 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800858 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800859 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000860 bool finished_entry = false;
861 auto finish_entry = [this, &finished_entry] {
862 if (!finished_entry) {
863 // This should only be called when we're going to return an earlier error,
864 // which would've been logged. This may imply the file is already corrupt
865 // and any further logging from FinishEntry is more likely to mislead than
866 // not.
867 this->zip_writer_->FinishEntry();
868 }
869 };
870 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800871 auto start = std::chrono::steady_clock::now();
872 auto end = start + timeout;
873 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800874
Felipe Leme770410d2016-01-26 17:07:14 -0800875 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800876 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800877 if (timeout.count() > 0) {
878 // lambda to recalculate the timeout.
879 auto time_left_ms = [end]() {
880 auto now = std::chrono::steady_clock::now();
881 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
882 return std::max(diff.count(), 0LL);
883 };
884
885 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
886 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000887 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
888 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800889 return -errno;
890 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000891 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 entry_name.c_str(), strerror(errno), timeout.count());
893 return TIMED_OUT;
894 }
895 }
896
Zach Riggle22200402016-08-18 01:01:24 -0400897 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800898 if (bytes_read == 0) {
899 break;
900 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800901 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800902 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700904 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800905 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700906 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800907 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800908 }
909 }
910
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700911 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000912 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700913 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700914 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800915 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800916 }
917
Vishnu Naire97d6122018-01-18 13:58:56 -0800918 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800919}
920
Felipe Leme1d486fe2016-10-14 18:06:47 -0700921bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
922 android::base::unique_fd fd(
923 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700924 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800925 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800926 return false;
927 }
928
Vishnu Naire97d6122018-01-18 13:58:56 -0800929 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800930}
931
932/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700933static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800934 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800935}
936
Felipe Leme1d486fe2016-10-14 18:06:47 -0700937void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700938 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800939 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700940 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800941}
942
Felipe Leme1d486fe2016-10-14 18:06:47 -0700943bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800944 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000945 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
946 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700947 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700948 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800950 return false;
951 }
952
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700954 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700955 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700956 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800957 return false;
958 }
959
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700961 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700962 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800963 return false;
964 }
965
966 return true;
967}
968
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800969static void DoKmsg() {
970 struct stat st;
971 if (!stat(PSTORE_LAST_KMSG, &st)) {
972 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
973 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
974 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
975 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
976 } else {
977 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
978 DumpFile("LAST KMSG", "/proc/last_kmsg");
979 }
980}
981
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800982static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800983 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800984 RunCommand(
985 "KERNEL LOG",
986 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
987 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
988}
989
Nandana Duttdb379fa2019-10-09 16:54:41 +0100990static void DoSystemLogcat(time_t since) {
991 char since_str[80];
992 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
993
994 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
995 RunCommand("SYSTEM LOG",
996 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
997 since_str},
998 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
999}
1000
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001001static void DoRadioLogcat() {
1002 unsigned long timeout_ms = logcat_timeout({"radio"});
1003 RunCommand(
1004 "RADIO LOG",
1005 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1006 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1007}
1008
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001009static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001010 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001011 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1012 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001013 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001014 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001015 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1016 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001017 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001018 RunCommand(
1019 "EVENT LOG",
1020 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001021 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001022 timeout_ms = logcat_timeout({"stats"});
1023 RunCommand(
1024 "STATS LOG",
1025 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001026 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001027 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001028
1029 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1030
1031 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001032 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1033 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001034}
1035
Mike Ma5c267872019-08-21 11:31:34 -07001036static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001037 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1038 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1039 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1040 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1041 if (fd < 0) {
1042 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1043 return;
1044 }
Kevin Jeon774abde2022-09-28 18:20:43 +00001045 RunCommandToFd(fd, "", {"incident", "-u"}, CommandOptions::WithTimeout(20).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001046 bool empty = 0 == lseek(fd, 0, SEEK_END);
1047 if (!empty) {
1048 // Use a different name from "incident.proto"
1049 // /proto/incident.proto is reserved for incident service dump
1050 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001051 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1052 path);
1053 } else {
1054 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001055 }
Mike Ma5c267872019-08-21 11:31:34 -07001056}
1057
Aaron Huanga99452a2022-04-27 18:51:16 +08001058static void DumpNetstatsProto() {
1059 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1060 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1061 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1062 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1063 if (fd < 0) {
1064 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1065 return;
1066 }
1067 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1068 CommandOptions::WithTimeout(120).Build());
1069 bool empty = 0 == lseek(fd, 0, SEEK_END);
1070 if (!empty) {
1071 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1072 path);
1073 } else {
1074 unlink(path.c_str());
1075 }
1076}
1077
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001078static void MaybeAddSystemTraceToZip() {
1079 // This function copies into the .zip the system trace that was snapshotted
1080 // by the early call to MaybeSnapshotSystemTrace(), if any background
1081 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001082 if (!ds.has_system_trace_) {
1083 // No background trace was happening at the time dumpstate was invoked.
1084 return;
1085 }
1086 ds.AddZipEntry(
1087 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1088 SYSTEM_TRACE_SNAPSHOT);
1089 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1090}
1091
Sunny Goyal35949782019-11-19 15:54:36 -08001092static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001093 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1094 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1095 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1096 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1097 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1098 if (fd < 0) {
1099 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1100 return;
1101 }
1102 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001103 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001104 bool empty = 0 == lseek(fd, 0, SEEK_END);
1105 if (!empty) {
1106 ds.AddZipEntry("visible_windows.zip", path);
1107 } else {
1108 MYLOGW("Failed to dump visible windows\n");
1109 }
1110 unlink(path.c_str());
1111}
1112
Jayachandran Ca94c7172017-06-10 15:08:12 -07001113static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001114 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1115 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001116 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001117 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001118 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1119 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1120 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1121 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001122}
1123
Woody Lin20767a92022-11-29 15:50:24 +08001124static void DumpShutdownCheckpoints() {
1125 const bool shutdown_checkpoints_dumped = AddDumps(
1126 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1127 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1128 if (!shutdown_checkpoints_dumped) {
1129 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1130 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1131 }
1132}
1133
David Andersond9ba4752018-12-11 18:26:59 -08001134static void DumpDynamicPartitionInfo() {
1135 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1136 return;
1137 }
1138
1139 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001140 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001141}
1142
Chris Morin5a50d482022-02-01 17:41:18 -08001143static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001144 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1145 anr_traces_dir.c_str());
1146
1147 // If we're here, dump_traces_path will always be a temporary file
1148 // (created with mkostemp or similar) that contains dumps taken earlier
1149 // on in the process.
1150 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001151 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1152 dump_traces_path);
1153 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001154
1155 const int ret = unlink(dump_traces_path);
1156 if (ret == -1) {
1157 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1158 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001159 }
1160 }
1161
Narayan Kamathbd863722017-06-01 18:50:12 +01001162 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001163 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001164 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001165 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001166 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001167
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001168 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001169 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001170 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001171 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001172 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1173 }
1174}
1175
1176static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001177 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001178
Chris Morin5a50d482022-02-01 17:41:18 -08001179 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001180
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001181 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1182
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001183 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001184 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001185 int i = 0;
1186 while (true) {
1187 const std::string slow_trace_path =
1188 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1189 if (stat(slow_trace_path.c_str(), &st)) {
1190 // No traces file at this index, done with the files.
1191 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001192 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001193 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1194 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001195 }
1196}
1197
Wei Wang509bb5d2017-06-09 14:42:12 -07001198static void DumpBlockStatFiles() {
1199 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001200
Wei Wang1dc1ef52017-06-12 11:28:37 -07001201 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1202
1203 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001204 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1205 return;
1206 }
1207
1208 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001209 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001210 if ((d->d_name[0] == '.')
1211 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1212 || (d->d_name[1] == '\0'))) {
1213 continue;
1214 }
1215 const std::string new_path =
1216 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1217 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1218 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1219 printf("\n");
1220 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001221 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001222}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001223
1224static void DumpPacketStats() {
1225 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001226}
1227
1228static void DumpIpAddrAndRules() {
1229 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1230 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1231 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1232 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1233 RunCommand("IP RULES", {"ip", "rule", "show"});
1234 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1235}
1236
Nandana Dutt5c390032019-03-12 10:52:56 +00001237static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1238 std::chrono::milliseconds timeout,
1239 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001240 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001241 sp<android::IServiceManager> sm = defaultServiceManager();
1242 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001243 Vector<String16> args;
1244 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001245 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1246 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001247 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001248 std::string path(title);
1249 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001250 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001251 if (PropertiesHelper::IsDryRun()) {
1252 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1253 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1254 } else {
Devin Mooreae68df22023-02-24 20:59:51 +00001255 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID,
1256 service, args);
1257 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001258 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1259 std::chrono::duration<double> elapsed_seconds;
1260 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1261 service == String16("meminfo")) {
1262 // Use a longer timeout for meminfo, since 30s is not always enough.
1263 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1264 /* as_proto = */ false, elapsed_seconds,
1265 bytes_written);
1266 } else {
1267 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1268 /* as_proto = */ false, elapsed_seconds,
1269 bytes_written);
1270 }
1271 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1272 bool dump_complete = (status == OK);
1273 dumpsys.stopDumpThread(dump_complete);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001274 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001275 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001276
1277 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1278 std::chrono::steady_clock::now() - start);
1279 if (elapsed_duration > timeout) {
1280 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1281 elapsed_duration.count());
1282 break;
1283 }
1284 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001285 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001286}
1287
Vishnu Nair64afc022018-02-01 15:29:34 -08001288static void RunDumpsysText(const std::string& title, int priority,
1289 std::chrono::milliseconds timeout,
1290 std::chrono::milliseconds service_timeout) {
1291 DurationReporter duration_reporter(title);
1292 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1293 fsync(STDOUT_FILENO);
1294 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1295}
1296
1297/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001298static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1299 std::chrono::milliseconds timeout,
1300 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001301 DurationReporter duration_reporter(title);
1302 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1303 fsync(STDOUT_FILENO);
1304 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1305 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001306
1307 RETURN_IF_USER_DENIED_CONSENT();
1308
1309 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1310 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001311}
1312
Nandana Dutt5c390032019-03-12 10:52:56 +00001313static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1314 std::chrono::milliseconds timeout,
1315 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001316 sp<android::IServiceManager> sm = defaultServiceManager();
1317 Dumpsys dumpsys(sm.get());
1318 Vector<String16> args;
1319 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1320 DurationReporter duration_reporter(title);
1321
1322 auto start = std::chrono::steady_clock::now();
1323 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1324 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001325 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001326 std::string path(kProtoPath);
1327 path.append(String8(service).c_str());
1328 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1329 path.append("_CRITICAL");
1330 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1331 path.append("_HIGH");
1332 }
1333 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001334 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001335 if (status == OK) {
1336 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1337 bool dumpTerminated = (status == OK);
1338 dumpsys.stopDumpThread(dumpTerminated);
1339 }
1340 ZipWriter::FileEntry file_entry;
1341 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001342
1343 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1344 std::chrono::steady_clock::now() - start);
1345 if (elapsed_duration > timeout) {
1346 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1347 elapsed_duration.count());
1348 break;
1349 }
1350 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001351 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001352}
1353
Nandana Dutta7db6342018-11-21 14:53:34 +00001354// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001355static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001356 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1357 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001358
1359 RETURN_IF_USER_DENIED_CONSENT();
1360
1361 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1362 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001363}
1364
1365// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001366static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001367 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1368 // high priority. Reduce timeout once they are able to dump in a shorter time or
1369 // moved to a parallel task.
1370 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1371 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001372
1373 RETURN_IF_USER_DENIED_CONSENT();
1374
1375 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1376 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001377}
1378
1379// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001380static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001381 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001382
1383 RETURN_IF_USER_DENIED_CONSENT();
1384
1385 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1386 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001387}
1388
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001389/*
1390 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1391 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1392 * if it's not running in the parallel task.
1393 */
1394static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001395 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001396 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1397 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001398
Steven Moreland44cd9482018-01-04 16:24:13 -08001399 using android::hidl::manager::V1_0::IServiceManager;
1400 using android::hardware::defaultServiceManager;
1401
1402 sp<IServiceManager> sm = defaultServiceManager();
1403 if (sm == nullptr) {
1404 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1405 return;
1406 }
1407
1408 auto ret = sm->list([&](const auto& interfaces) {
1409 for (const std::string& interface : interfaces) {
1410 std::string cleanName = interface;
1411 std::replace_if(cleanName.begin(),
1412 cleanName.end(),
1413 [](char c) {
1414 return !isalnum(c) &&
1415 std::string("@-_:.").find(c) == std::string::npos;
1416 }, '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001417 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001418
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001419 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001420 {
1421 auto fd = android::base::unique_fd(
1422 TEMP_FAILURE_RETRY(open(path.c_str(),
1423 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1424 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1425 if (fd < 0) {
1426 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1427 continue;
1428 }
1429 RunCommandToFd(fd,
1430 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001431 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001432 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1433
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001434 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001435 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001436 if (!empty) {
1437 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1438 path);
1439 } else {
1440 unlink(path.c_str());
1441 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001442 }
1443 });
1444
1445 if (!ret.isOk()) {
1446 MYLOGE("Could not list hals from hwservicemanager.\n");
1447 }
1448}
1449
Devin Moore8df81bb2022-06-08 22:47:02 +00001450// Dump all of the files that make up the vendor interface.
1451// See the files listed in dumpFileList() for the latest list of files.
1452static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001453
1454 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1455 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001456 for (const auto vintfFile : vintfFiles) {
1457 struct stat st;
1458 if (stat(vintfFile.c_str(), &st) == 0) {
1459 if (S_ISDIR(st.st_mode)) {
1460 ds.AddDir(vintfFile, true /* recursive */);
1461 } else {
1462 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1463 vintfFile);
1464 }
1465 }
1466 }
1467}
1468
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001469static void DumpExternalFragmentationInfo() {
1470 struct stat st;
1471 if (stat("/proc/buddyinfo", &st) != 0) {
1472 MYLOGE("Unable to dump external fragmentation info\n");
1473 return;
1474 }
1475
1476 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1477 std::ifstream ifs("/proc/buddyinfo");
1478 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1479 for (std::string line; std::getline(ifs, line);) {
1480 std::smatch match_results;
1481 if (std::regex_match(line, match_results, unusable_index_regex)) {
1482 std::stringstream free_pages(std::string{match_results[3]});
1483 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1484 std::istream_iterator<int>());
1485
1486 int total_free_pages = 0;
1487 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1488 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1489 }
1490
1491 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1492 match_results[2].str().c_str());
1493
1494 int usable_free_pages = total_free_pages;
1495 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1496 auto unusable_index = (total_free_pages - usable_free_pages) /
1497 static_cast<double>(total_free_pages);
1498 printf(" %5.3f", unusable_index);
1499 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1500 }
1501
1502 printf("\n");
1503 }
1504 }
1505 printf("\n");
1506}
1507
mhasankd451a472020-05-26 18:02:39 -07001508static void DumpstateLimitedOnly() {
1509 // Trimmed-down version of dumpstate to only include a whitelisted
1510 // set of logs (system log, event log, and system server / system app
1511 // crashes, and networking logs). See b/136273873 and b/138459828
1512 // for context.
1513 DurationReporter duration_reporter("DUMPSTATE");
1514 unsigned long timeout_ms;
1515 // calculate timeout
1516 timeout_ms = logcat_timeout({"main", "system", "crash"});
1517 RunCommand("SYSTEM LOG",
1518 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1519 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1520 timeout_ms = logcat_timeout({"events"});
1521 RunCommand(
1522 "EVENT LOG",
1523 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1524 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1525
1526 printf("========================================================\n");
1527 printf("== Networking Service\n");
1528 printf("========================================================\n");
1529
1530 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1531 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001532 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1533 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001534
1535 printf("========================================================\n");
1536 printf("== Dropbox crashes\n");
1537 printf("========================================================\n");
1538
1539 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1540 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1541
1542 printf("========================================================\n");
1543 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1544 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1545 printf("========================================================\n");
1546 printf("== dumpstate: done (id %d)\n", ds.id_);
1547 printf("========================================================\n");
1548}
1549
Rhed Jaoe017f982020-07-21 17:58:41 +08001550/*
1551 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1552 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1553 * if it's not running in the parallel task.
1554 */
1555static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1556 dprintf(out_fd, "========================================================\n");
1557 dprintf(out_fd, "== Checkins\n");
1558 dprintf(out_fd, "========================================================\n");
1559
1560 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001561 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1562 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1563 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1564 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1565}
1566
1567/*
1568 * Runs dumpsys on activity service to dump all application activities, services
1569 * and providers in the device.
1570 *
1571 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1572 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1573 * if it's not running in the parallel task.
1574 */
1575static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1576 dprintf(out_fd, "========================================================\n");
1577 dprintf(out_fd, "== Running Application Activities\n");
1578 dprintf(out_fd, "========================================================\n");
1579
1580 // The following dumpsys internally collects output from running apps, so it can take a long
1581 // time. So let's extend the timeout.
1582
1583 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1584
1585 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1586
1587 dprintf(out_fd, "========================================================\n");
1588 dprintf(out_fd, "== Running Application Services (platform)\n");
1589 dprintf(out_fd, "========================================================\n");
1590
1591 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1592 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1593
1594 dprintf(out_fd, "========================================================\n");
1595 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1596 dprintf(out_fd, "========================================================\n");
1597
1598 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1599 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1600
1601 dprintf(out_fd, "========================================================\n");
1602 dprintf(out_fd, "== Running Application Providers (platform)\n");
1603 dprintf(out_fd, "========================================================\n");
1604
1605 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001606 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001607
1608 dprintf(out_fd, "========================================================\n");
1609 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1610 dprintf(out_fd, "========================================================\n");
1611
1612 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1613 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1614}
1615
Nandana Dutt5c390032019-03-12 10:52:56 +00001616// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1617// via the consent they are shown. Ignores other errors that occur while running various
1618// commands. The consent checking is currently done around long running tasks, which happen to
1619// be distributed fairly evenly throughout the function.
1620static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001621 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001622
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001623 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001624 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1625 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001626 if (ds.dump_pool_) {
1627 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1628 // drop root user. Restarts it with two threads for the parallel run.
1629 ds.dump_pool_->start(/* thread_counts = */2);
1630
Chris Morinbc223142022-02-04 14:17:11 -08001631 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1632 dump_incident_report = ds.dump_pool_->enqueueTask(
1633 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001634 dump_netstats_report = ds.dump_pool_->enqueueTask(
1635 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001636 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1637 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1638 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001639 }
1640
Nandana Dutt5c390032019-03-12 10:52:56 +00001641 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1642 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1643 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001644 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001645 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001646 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001647 DumpFile("MEMORY INFO", "/proc/meminfo");
1648 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001649 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001650
Kevin Jeon947922b2022-09-21 00:29:18 +00001651 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1652 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001653
Sunny Goyal35949782019-11-19 15:54:36 -08001654 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1655
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001656 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1657 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1658 DumpFile("SLAB INFO", "/proc/slabinfo");
1659 DumpFile("ZONEINFO", "/proc/zoneinfo");
1660 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1661 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001662 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001663
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001664 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001665
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001666 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001667 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001668
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001669 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001670 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001671 } else {
1672 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1673 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001674
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001675 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001676 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001677 struct stat s;
1678 if (stat("/proc/modules", &s) != 0) {
1679 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1680 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001681 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001682 RunCommand("MODULES INFO",
1683 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1684 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1685 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001686 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001687
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001688 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001689 DoKernelLogcat();
1690 } else {
1691 do_dmesg();
1692 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001693
Devin Moore8df81bb2022-06-08 22:47:02 +00001694 DumpVintf();
1695
Felipe Lemef0292972016-11-22 13:57:05 -08001696 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001697
Jeff Brown1dc94e32014-09-11 14:15:27 -07001698 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001699 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001700
Jack Yu5a6b2e22020-08-14 18:13:35 +08001701 /* Dump Nfc NCI logs */
1702 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001703
Paul Chang0d2aad72020-02-13 20:04:03 +08001704 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001705 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001706 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001707 }
1708
Felipe Lemee184f662016-10-27 10:04:47 -07001709 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001711 MaybeAddSystemTraceToZip();
1712
Narayan Kamath8f788292017-05-25 13:20:39 +01001713 // NOTE: tombstones are always added as separate entries in the zip archive
1714 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001715 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001716 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001717 if (!tombstones_dumped) {
1718 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001719 }
1720
Jayachandran Ca94c7172017-06-10 15:08:12 -07001721 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001722
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001723 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001724
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001725 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001726
Woody Lin20767a92022-11-29 15:50:24 +08001727 DumpShutdownCheckpoints();
1728
Jayachandran Ca94c7172017-06-10 15:08:12 -07001729 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001730
1731 dump_route_tables();
1732
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001733 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1734 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1735 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001736
Nandana Dutt5c390032019-03-12 10:52:56 +00001737 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001738
Chiachang Wang668ede42021-05-17 17:14:20 +08001739 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1740 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1741 // dump with priority parameters to dump high priority information.
1742 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1743 CommandOptions::WithTimeout(10).Build());
1744
Elliott Hughes23ccc622017-02-28 10:14:22 -08001745 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001746
Jin Qianf334d662017-10-10 14:41:37 -07001747 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001748
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001749 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001750
Colin Crossf45fa6b2012-03-26 12:38:26 -07001751 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001752 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1753 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1754
1755 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1756 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1757 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1758 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1759 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001760
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001761 /* Add window and surface trace files. */
1762 if (!PropertiesHelper::IsUserBuild()) {
1763 ds.AddDir(WMTRACE_DATA_DIR, false);
1764 }
1765
Yifan Hongd90cc652020-02-08 16:52:02 -08001766 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1767
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001768 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001769 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001770 } else {
1771 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1772 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001773
Steven Moreland7440ddb2016-12-15 16:13:39 -08001774 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001775 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1776 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001777 // su does not exist on user builds, so try running without it.
1778 // This way any implementations of vril-dump that do not require
1779 // root can run on user builds.
1780 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001781 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001782 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001783 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001784 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001785 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001786 }
1787
Felipe Lemed8b94e52016-12-08 10:21:44 -08001788 printf("========================================================\n");
1789 printf("== Android Framework Services\n");
1790 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001791
Nandana Dutt5c390032019-03-12 10:52:56 +00001792 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001793
Jack He91ff2fe2021-02-18 18:23:43 -08001794 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1795 ds.AddDir("/data/misc/bluetooth/logs", true);
1796
Rhed Jaoe017f982020-07-21 17:58:41 +08001797 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001798 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001799 } else {
1800 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1801 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001802
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001803 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001804
Adrian Roos8b397ab2017-04-04 16:35:44 -07001805 printf("========================================================\n");
1806 printf("== Dropbox crashes\n");
1807 printf("========================================================\n");
1808
1809 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1810 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1811
Felipe Lemed8b94e52016-12-08 10:21:44 -08001812 printf("========================================================\n");
1813 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1814 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1815 printf("========================================================\n");
1816 printf("== dumpstate: done (id %d)\n", ds.id_);
1817 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001818
1819 printf("========================================================\n");
1820 printf("== Obtaining statsd metadata\n");
1821 printf("========================================================\n");
1822 // This differs from the usual dumpsys stats, which is the stats report data.
1823 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001824
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001825 // Add linker configuration directory
1826 ds.AddDir(LINKERCONFIG_DIR, true);
1827
Li Li830179f2022-01-04 12:53:29 -08001828 /* Dump frozen cgroupfs */
1829 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001830
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001831 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001832 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1833 } else {
1834 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1835 DumpNetstatsProto);
1836 }
1837
1838 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001839 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001840 } else {
1841 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1842 DumpIncidentReport);
1843 }
Mike Ma5c267872019-08-21 11:31:34 -07001844
Nandana Dutt5c390032019-03-12 10:52:56 +00001845 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001846}
1847
Nandana Dutt5c390032019-03-12 10:52:56 +00001848/*
1849 * Dumps state for the default case; drops root after it's no longer necessary.
1850 *
1851 * Returns RunStatus::OK if everything went fine.
1852 * Returns RunStatus::ERROR if there was an error.
1853 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1854 * with the caller.
1855 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001856Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001857 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1858 // buffer.
1859 DoLogcat();
1860 // Capture timestamp after first logcat to use in next logcat
1861 time_t logcat_ts = time(nullptr);
1862
Nandana Dutt4be45d12018-09-26 15:04:23 +01001863 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001864 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001865 if (dump_pool_) {
1866 RETURN_IF_USER_DENIED_CONSENT();
1867 // One thread is enough since we only need to enqueue DumpTraces here.
1868 dump_pool_->start(/* thread_counts = */1);
1869
1870 // DumpTraces takes long time, post it to the another thread in the
1871 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001872 dump_traces = dump_pool_->enqueueTask(
1873 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001874 } else {
1875 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1876 &dump_traces_path);
1877 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001878
1879 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001880 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001881 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1882 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001883 ds.shutdown_checkpoints_ = GetDumpFds(
1884 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001885 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001886
1887 ds.AddDir(RECOVERY_DIR, true);
1888 ds.AddDir(RECOVERY_DATA_DIR, true);
1889 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001890 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001891 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1892 if (!PropertiesHelper::IsUserBuild()) {
1893 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1894 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001895 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001896 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001897 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001898 add_mountinfo();
1899 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001900 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001901 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001902 if (!PropertiesHelper::IsUserBuild()) {
1903 // Include dropbox entry files inside ZIP, but exclude
1904 // noisy WTF and StrictMode entries
1905 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1906 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001907
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001908 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001909 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1910
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001911 // Dump IPsec stats. No keys are exposed here.
1912 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1913
Nandana Dutt4be45d12018-09-26 15:04:23 +01001914 // Run ss as root so we can see socket marks.
1915 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1916
1917 // Run iotop as root to show top 100 IO threads
1918 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1919
Erick Reyese68df822019-02-11 14:46:36 -08001920 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001921 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1922 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001923
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001924 DumpFile("PSI cpu", "/proc/pressure/cpu");
1925 DumpFile("PSI memory", "/proc/pressure/memory");
1926 DumpFile("PSI io", "/proc/pressure/io");
1927
Mårten Kongstad60195a72022-09-20 14:14:20 +02001928 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1929 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1930
Rhed Jao5377d792020-07-16 17:37:39 +08001931 if (dump_pool_) {
1932 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001933 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001934
Chris Morinbc223142022-02-04 14:17:11 -08001935 // Current running thread in the pool is the root user also. Delete
1936 // the pool and make a new one later to ensure none of threads in the pool are root.
1937 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001938 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001939 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001940 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001941 }
1942
Nandana Dutt5c390032019-03-12 10:52:56 +00001943 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001944 Dumpstate::RunStatus status = dumpstate();
1945 // Capture logcat since the last time we did it.
1946 DoSystemLogcat(logcat_ts);
1947 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001948}
1949
Rhed Jaob5685b32020-08-14 17:19:17 +08001950// Common states for telephony and wifi which are needed to be collected before
1951// dumpstate drop the root user.
1952static void DumpstateRadioAsRoot() {
1953 DumpIpTablesAsRoot();
1954 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1955}
1956
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001957// This method collects common dumpsys for telephony and wifi. Typically, wifi
1958// reports are fine to include all information, but telephony reports on user
1959// builds need to strip some content (see DumpstateTelephonyOnly).
1960static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001961 // We need to be picky about some stuff for telephony reports on user builds.
1962 if (!include_sensitive_info) {
1963 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1964 DoRadioLogcat();
1965 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001966 // DumpHals takes long time, post it to the another thread in the pool,
1967 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001968 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001969 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001970 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001971 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001972 // Contains various system properties and process startup info.
1973 do_dmesg();
1974 // Logs other than the radio buffer may contain package/component names and potential PII.
1975 DoLogcat();
1976 // Too broad for connectivity problems.
1977 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08001978 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
1979 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001980 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08001981 } else {
1982 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
1983 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001984 }
1985
Jayachandran Ca94c7172017-06-10 15:08:12 -07001986 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001987 DumpIpAddrAndRules();
1988 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07001989 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
1990 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08001991}
1992
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001993// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
1994// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
1995// for what can be included on user builds: all reported information MUST directly relate to
1996// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
1997// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
1998// names are not), and MUST NOT contain logs of user application traffic.
1999// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002000static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002001 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002002
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002003 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002004
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002005 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002006
Rhed Jaob5685b32020-08-14 17:19:17 +08002007 DumpstateRadioAsRoot();
2008 if (!DropRootUser()) {
2009 return;
2010 }
2011
2012 // Starts thread pool after the root user is dropped, and two additional threads
2013 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002014 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002015 if (ds.dump_pool_) {
2016 ds.dump_pool_->start(/*thread_counts =*/2);
2017
2018 // DumpstateBoard takes long time, post it to the another thread in the pool,
2019 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002020 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2021 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002022 }
2023
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002024 DumpstateRadioCommon(include_sensitive_info);
2025
2026 if (include_sensitive_info) {
2027 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2028 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2029 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2030 // way.
2031 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2032 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002033
2034 printf("========================================================\n");
2035 printf("== Android Framework Services\n");
2036 printf("========================================================\n");
2037
Vishnu Nair652cc802017-11-30 15:18:30 -08002038 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2039 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002040 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2041 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002042 if (include_sensitive_info) {
2043 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2044 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2045 SEC_TO_MSEC(10));
2046 } else {
2047 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2048 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2049 // give a higher timeout as well.
2050 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2051 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2052 }
2053 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002054 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2055 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002056 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002057 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2058 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002059 if (include_sensitive_info) {
2060 // Contains raw IP addresses, omit from reports on user builds.
2061 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2062 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2063 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2064 SEC_TO_MSEC(10));
2065 // Contains package/component names, omit from reports on user builds.
2066 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2067 SEC_TO_MSEC(10));
2068 // Contains package names, but should be relatively simple to remove them (also contains
2069 // UIDs already), omit from reports on user builds.
2070 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2071 SEC_TO_MSEC(10));
2072 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002073
2074 printf("========================================================\n");
2075 printf("== Running Application Services\n");
2076 printf("========================================================\n");
2077
2078 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2079
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002080 if (include_sensitive_info) {
2081 printf("========================================================\n");
2082 printf("== Running Application Services (non-platform)\n");
2083 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002084
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002085 // Contains package/component names and potential PII, omit from reports on user builds.
2086 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2087 // carrier_config dumpsys instead.
2088 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2089 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002090
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002091 printf("========================================================\n");
2092 printf("== Checkins\n");
2093 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002094
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002095 // Contains package/component names, omit from reports on user builds.
2096 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2097 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002098
2099 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002100 printf("== dumpstate: done (id %d)\n", ds.id_);
2101 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002102
2103 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002104 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002105 } else {
2106 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2107 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002108}
2109
mukesh agrawal253dad42018-01-23 21:59:59 -08002110// This method collects dumpsys for wifi debugging only
2111static void DumpstateWifiOnly() {
2112 DurationReporter duration_reporter("DUMPSTATE");
2113
Rhed Jaob5685b32020-08-14 17:19:17 +08002114 DumpstateRadioAsRoot();
2115 if (!DropRootUser()) {
2116 return;
2117 }
2118
2119 // Starts thread pool after the root user is dropped. Only one additional
2120 // thread is needed for DumpHals in the DumpstateRadioCommon.
2121 if (ds.dump_pool_) {
2122 ds.dump_pool_->start(/*thread_counts =*/1);
2123 }
2124
mukesh agrawal253dad42018-01-23 21:59:59 -08002125 DumpstateRadioCommon();
2126
2127 printf("========================================================\n");
2128 printf("== Android Framework Services\n");
2129 printf("========================================================\n");
2130
2131 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2132 SEC_TO_MSEC(10));
2133 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2134 SEC_TO_MSEC(10));
2135
2136 printf("========================================================\n");
2137 printf("== dumpstate: done (id %d)\n", ds.id_);
2138 printf("========================================================\n");
2139}
2140
Nandana Duttcf419a72019-03-14 10:40:17 +00002141Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002142 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002143 const size_t buf_size = temp_file_pattern.length() + 1;
2144 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2145 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2146
2147 // Create a new, empty file to receive all trace dumps.
2148 //
2149 // TODO: This can be simplified once we remove support for the old style
2150 // dumps. We can have a file descriptor passed in to dump_traces instead
2151 // of creating a file, closing it and then reopening it again.
2152 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2153 if (fd < 0) {
2154 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002155 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002156 }
2157
2158 // Nobody should have access to this temporary file except dumpstate, but we
2159 // temporarily grant 'read' to 'others' here because this file is created
2160 // when tombstoned is still running as root, but dumped after dropping. This
2161 // can go away once support for old style dumping has.
2162 const int chmod_ret = fchmod(fd, 0666);
2163 if (chmod_ret < 0) {
2164 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002165 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002166 }
2167
2168 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2169 if (proc.get() == nullptr) {
2170 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002171 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002172 }
2173
2174 // Number of times process dumping has timed out. If we encounter too many
2175 // failures, we'll give up.
2176 int timeout_failures = 0;
2177 bool dalvik_found = false;
2178
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002179 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002180
2181 struct dirent* d;
2182 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002183 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002184 int pid = atoi(d->d_name);
2185 if (pid <= 0) {
2186 continue;
2187 }
2188
2189 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2190 std::string exe;
2191 if (!android::base::Readlink(link_name, &exe)) {
2192 continue;
2193 }
2194
2195 bool is_java_process;
2196 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2197 // Don't bother dumping backtraces for the zygote.
2198 if (IsZygote(pid)) {
2199 continue;
2200 }
2201
2202 dalvik_found = true;
2203 is_java_process = true;
2204 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2205 is_java_process = false;
2206 } else {
2207 // Probably a native process we don't care about, continue.
2208 continue;
2209 }
2210
2211 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2212 if (timeout_failures == 3) {
2213 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2214 break;
2215 }
2216
2217 const uint64_t start = Nanotime();
2218 const int ret = dump_backtrace_to_file_timeout(
2219 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace,
2220 is_java_process ? 5 : 20, fd);
2221
2222 if (ret == -1) {
2223 // For consistency, the header and footer to this message match those
2224 // dumped by debuggerd in the success case.
2225 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2226 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2227 dprintf(fd, "---- end %d ----", pid);
2228 timeout_failures++;
2229 continue;
2230 }
2231
2232 // We've successfully dumped stack traces, reset the failure count
2233 // and write a summary of the elapsed time to the file and continue with the
2234 // next process.
2235 timeout_failures = 0;
2236
2237 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2238 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2239 }
2240
2241 if (!dalvik_found) {
2242 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2243 }
2244
Nandana Duttcf419a72019-03-14 10:40:17 +00002245 *path = file_name_buf.release();
2246 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002247}
2248
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002249static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2250 const Dumpstate::BugreportMode bugreport_mode) {
2251 switch (bugreport_mode) {
2252 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2253 return dumpstate_hal_hidl::DumpstateMode::FULL;
2254 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2255 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2256 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2257 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2258 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2259 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2260 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2261 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2262 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2263 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2264 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2265 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2266 }
2267 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2268}
2269
2270static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2271 const Dumpstate::BugreportMode bugreport_mode) {
2272 switch (bugreport_mode) {
2273 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2274 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2275 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2276 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2277 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2278 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2279 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2280 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2281 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2282 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2283 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2284 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2285 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2286 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2287 }
2288 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2289}
2290
2291static void DoDumpstateBoardHidl(
2292 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2293 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2294 const Dumpstate::BugreportMode bugreport_mode,
2295 const size_t timeout_sec) {
2296
2297 using ScopedNativeHandle =
2298 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2299 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2300 [](native_handle_t* handle) {
2301 // we don't close file handle's here
2302 // via native_handle_close(handle)
2303 // instead we let dumpstate_fds close the file handles when
2304 // dumpstate_fds gets destroyed
2305 native_handle_delete(handle);
2306 });
2307 if (handle == nullptr) {
2308 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2309 return;
2310 }
2311
2312 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2313 handle.get()->data[i] = dumpstate_fds[i].get();
2314 }
2315
2316 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2317 // implement just 1.0.
2318 const char* descriptor_to_kill;
2319 using DumpstateBoardTask = std::packaged_task<bool()>;
2320 DumpstateBoardTask dumpstate_board_task;
2321 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2322 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2323 if (dumpstate_hal != nullptr) {
2324 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2325
2326 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2327 GetDumpstateHalModeHidl(bugreport_mode);
2328
2329 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2330 dumpstate_board_task =
2331 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2332 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2333 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2334 SEC_TO_MSEC(timeout_sec));
2335 if (!status.isOk()) {
2336 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2337 return false;
2338 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2339 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2340 dumpstate_hal_hidl::toString(status).c_str());
2341 return false;
2342 }
2343 return true;
2344 });
2345 } else {
2346 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2347
2348 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2349 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2350 ::android::hardware::Return<void> status =
2351 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2352 if (!status.isOk()) {
2353 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2354 return false;
2355 }
2356 return true;
2357 });
2358 }
2359 auto result = dumpstate_board_task.get_future();
2360 std::thread(std::move(dumpstate_board_task)).detach();
2361
2362 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2363 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2364 if (!android::base::SetProperty(
2365 "ctl.interface_restart",
2366 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2367 MYLOGE("Couldn't restart dumpstate HAL\n");
2368 }
2369 }
2370 // Wait some time for init to kill dumpstate vendor HAL
2371 constexpr size_t killing_timeout_sec = 10;
2372 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2373 MYLOGE(
2374 "killing dumpstateBoard timed out after %zus, continue and "
2375 "there might be racing in content\n",
2376 killing_timeout_sec);
2377 }
2378}
2379
2380static void DoDumpstateBoardAidl(
2381 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2382 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2383 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2384 MYLOGI("Using IDumpstateDevice AIDL HAL");
2385
2386 const char* descriptor_to_kill;
2387 using DumpstateBoardTask = std::packaged_task<bool()>;
2388 DumpstateBoardTask dumpstate_board_task;
2389 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2390 GetDumpstateHalModeAidl(bugreport_mode);
2391
2392 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2393 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2394 timeout_sec]() -> bool {
2395 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2396
2397 if (!status.isOk()) {
2398 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2399 return false;
2400 }
2401 return true;
2402 });
2403 auto result = dumpstate_board_task.get_future();
2404 std::thread(std::move(dumpstate_board_task)).detach();
2405
2406 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2407 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2408 if (!android::base::SetProperty(
2409 "ctl.interface_restart",
2410 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2411 MYLOGE("Couldn't restart dumpstate HAL\n");
2412 }
2413 }
2414 // Wait some time for init to kill dumpstate vendor HAL
2415 constexpr size_t killing_timeout_sec = 10;
2416 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2417 MYLOGE(
2418 "killing dumpstateBoard timed out after %zus, continue and "
2419 "there might be racing in content\n",
2420 killing_timeout_sec);
2421 }
2422}
2423
2424static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2425 const std::string aidl_instance_name =
2426 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2427
2428 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2429 return nullptr;
2430 }
2431
2432 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2433
2434 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2435}
2436
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002437void Dumpstate::DumpstateBoard(int out_fd) {
2438 dprintf(out_fd, "========================================================\n");
2439 dprintf(out_fd, "== Board\n");
2440 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002441
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002442 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002443 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002444 * set to true and unmount it after invoking dumpstateBoard_* methods.
2445 * This is to enable debug builds to not have debugfs mounted during runtime.
2446 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002447 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002448 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002449 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002450 if (mount_debugfs) {
2451 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2452 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002453 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002454 }
2455
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002456 std::vector<std::string> paths;
2457 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002458 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002459 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2460 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002461 remover.emplace_back(android::base::make_scope_guard(
2462 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002463 }
Jie Song9fbfad02017-06-20 16:29:42 -07002464
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002465 // get dumpstate HAL AIDL implementation
2466 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2467 GetDumpstateBoardAidlService());
2468 if (dumpstate_hal_handle_aidl == nullptr) {
2469 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2470 }
2471
2472 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2473 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2474 if (dumpstate_hal_handle_aidl == nullptr) {
2475 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2476 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2477 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2478 }
2479 }
2480
2481 // if neither HIDL nor AIDL implementation found, then return
2482 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2483 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002484 return;
2485 }
2486
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002487 // this is used to hold the file descriptors and when this variable goes out of scope
2488 // the file descriptors are closed
2489 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002490
Nandana Dutt5c390032019-03-12 10:52:56 +00002491 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002492 for (size_t i = 0; i < paths.size(); i++) {
2493 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2494
2495 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2496 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2497 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2498 if (fd < 0) {
2499 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2500 return;
2501 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002502
2503 dumpstate_fds.emplace_back(fd.release());
2504 // we call fd.release() here to make sure "fd" does not get closed
2505 // after "fd" goes out of scope after this block.
2506 // "fd" will be closed when "dumpstate_fds" goes out of scope
2507 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002508 }
2509
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002510 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2511 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2512 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002513 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002514
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002515 if (dumpstate_hal_handle_aidl != nullptr) {
2516 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2517 timeout_sec);
2518 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2519 // run HIDL HAL only if AIDL HAL not found
2520 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2521 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002522 }
2523
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002524 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002525 auto keep_debugfs_mounted =
2526 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2527 if (keep_debugfs_mounted.empty())
2528 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002529 }
2530
Wei Wang587eac92018-04-05 12:17:20 -07002531 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2532 for (size_t i = 0; i < paths.size(); i++) {
2533 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002534 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2535 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002536 file_sizes[i] = -1;
2537 continue;
2538 }
2539 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002540 }
2541
2542 for (size_t i = 0; i < paths.size(); i++) {
2543 if (file_sizes[i] == -1) {
2544 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002545 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002546 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002547 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002548 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002549 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002550 remover[i].Disable();
2551 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2552 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002553 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002554}
2555
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002556static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002557 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002558 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2559 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002560 " -h: display this help message\n"
2561 " -b: play sound file instead of vibrate, at beginning of job\n"
2562 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002563 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002564 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002565 " -s: write zipped file to control socket (for init)\n"
2566 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002567 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002568 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002569 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002570 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002571 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002572 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002573}
2574
Wei Liuf87959e2016-08-26 14:51:42 -07002575static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002576 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002577}
2578
Felipe Leme1d486fe2016-10-14 18:06:47 -07002579bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002580 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2581 if (zip_entry_tasks_) {
2582 zip_entry_tasks_->run(/* do_cancel = */false);
2583 }
2584
Felipe Leme9a523ae2016-10-20 15:10:33 -07002585 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002586 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002587 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002588 // Final timestamp
2589 char date[80];
2590 time_t the_real_now_please_stand_up = time(nullptr);
2591 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002592 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002593 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002594
Felipe Leme9a523ae2016-10-20 15:10:33 -07002595 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002596 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002597 return false;
2598 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002599 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002600 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002601 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002602 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002603
Felipe Leme0f3fb202016-06-10 17:10:53 -07002604 // Add log file (which contains stderr output) to zip...
2605 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002606 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002607 MYLOGE("Failed to add dumpstate log to .zip file\n");
2608 return false;
2609 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002610 // TODO: Should truncate the existing file.
2611 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002612 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2613 return false;
2614 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002615 fprintf(stderr, "\n");
2616
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002617 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002618 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002619 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002620 return false;
2621 }
2622
Felipe Leme1d486fe2016-10-14 18:06:47 -07002623 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2624 ds.zip_file.reset(nullptr);
2625
Felipe Lemee9d2c542016-11-15 11:48:26 -08002626 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002627 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002628
Felipe Leme1e9edc62015-12-21 16:02:13 -08002629 return true;
2630}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002631
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002632static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2633 // clang-format off
2634 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2635 "--receiver-foreground", "--receiver-include-background", "-a", action};
2636 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002637
2638 am.insert(am.end(), args.begin(), args.end());
2639
Felipe Leme8d2410e2017-02-08 09:46:08 -08002640 RunCommand("", am,
2641 CommandOptions::WithTimeout(20)
2642 .Log("Sending broadcast: '%s'\n")
2643 .Always()
2644 .DropRoot()
2645 .RedirectStderr()
2646 .Build());
2647}
2648
Felipe Leme35b8cf12017-02-10 15:47:29 -08002649static void Vibrate(int duration_ms) {
2650 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002651 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2652 "oneshot", std::to_string(duration_ms)};
2653 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002654 CommandOptions::WithTimeout(10)
2655 .Log("Vibrate: '%s'\n")
2656 .Always()
2657 .Build());
2658 // clang-format on
2659}
2660
Nandana Dutt979388e2018-11-30 16:48:55 +00002661static void MaybeResolveSymlink(std::string* path) {
2662 std::string resolved_path;
2663 if (android::base::Readlink(*path, &resolved_path)) {
2664 *path = resolved_path;
2665 }
2666}
2667
Nandana Dutt4be45d12018-09-26 15:04:23 +01002668/*
2669 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002670 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002671 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002672static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002673 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2674
Nandana Dutt4be45d12018-09-26 15:04:23 +01002675 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2676 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002677 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002678 char date[80];
2679 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2680 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002681
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002682 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002683 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002684 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002685 ds.base_name_ += "-wifi";
2686 }
2687
Paul Chang0d2aad72020-02-13 20:04:03 +08002688 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002689 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002690 }
2691 ds.tmp_path_ = ds.GetPath(".tmp");
2692 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2693
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002694 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002695 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002696 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002697 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002698 "Bugreport dir: [%s] "
2699 "Base name: [%s] "
2700 "Suffix: [%s] "
2701 "Log path: [%s] "
2702 "Temporary path: [%s] "
2703 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002704 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2705 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002706
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002707 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2708 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2709 create_parent_dirs(ds.path_.c_str());
2710 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2711 if (ds.zip_file == nullptr) {
2712 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2713 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002714 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002715 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2716 ds.AddTextZipEntry("version.txt", ds.version_);
2717 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002718}
2719
2720/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002721 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002722 * printing zipped file status, etc.
2723 */
2724static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002725 bool do_text_file = !ds.FinishZipFile();
2726 if (do_text_file) {
2727 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002728 }
mhasank2d75c442020-06-11 15:05:25 -07002729
2730 std::string final_path = ds.path_;
2731 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002732 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002733 android::os::CopyFileToFile(ds.path_, final_path);
2734 }
2735
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002736 if (ds.options_->stream_to_socket) {
2737 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2738 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002739 if (do_text_file) {
2740 dprintf(ds.control_socket_fd_,
2741 "FAIL:could not create zip file, check %s "
2742 "for more details\n",
2743 ds.log_path_.c_str());
2744 } else {
mhasank2d75c442020-06-11 15:05:25 -07002745 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002746 }
2747 }
2748}
2749
Nandana Dutt4be45d12018-09-26 15:04:23 +01002750
Nandana Dutt58d72e22018-11-16 10:30:48 +00002751static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2752 switch (mode) {
2753 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2754 return "BUGREPORT_FULL";
2755 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2756 return "BUGREPORT_INTERACTIVE";
2757 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2758 return "BUGREPORT_REMOTE";
2759 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2760 return "BUGREPORT_WEAR";
2761 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2762 return "BUGREPORT_TELEPHONY";
2763 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2764 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002765 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2766 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002767 }
2768}
2769
Paul Changf59c2b72020-03-10 02:08:55 +08002770static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2771 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002772 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2773 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002774 options->bugreport_mode = mode;
2775 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002776 switch (mode) {
2777 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002778 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002779 break;
2780 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002781 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002782 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002783 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002784 break;
2785 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002786 options->do_vibrate = false;
2787 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002788 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002789 break;
2790 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002791 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002792 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002793 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002794 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002795 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002796 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002797 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002798 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002799 break;
2800 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002801 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002802 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002803 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002804 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2805 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002806 }
2807}
2808
Nandana Dutt58d72e22018-11-16 10:30:48 +00002809static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002810 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002811 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002812 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002813 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002814 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002815 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002816 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002817 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002818 options.do_progress_updates, options.bugreport_fd.get(),
2819 options.bugreport_mode_string.c_str(),
2820 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002821}
2822
Nandana Dutt54dbd672019-01-11 12:58:05 +00002823void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2824 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002825 const android::base::unique_fd& screenshot_fd_in,
2826 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002827 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002828 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2829 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002830
Paul Changf59c2b72020-03-10 02:08:55 +08002831 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002832}
2833
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002834Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2835 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002836 int c;
mhasankd451a472020-05-26 18:02:39 -07002837 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002838 switch (c) {
2839 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002840 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002841 case 's': stream_to_socket = true; break;
2842 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002843 case 'v': show_header_only = true; break;
2844 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002845 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002846 case 'P': do_progress_updates = true; break;
2847 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002848 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002849 case 'V':
2850 case 'd':
2851 case 'z':
2852 // compatibility no-op
2853 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002854 case 'w':
2855 // This was already processed
2856 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002857 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002858 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002859 break;
2860 default:
2861 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002862 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002863 break;
2864 // clang-format on
2865 }
2866 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002867
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002868 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002869 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002870 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002871 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002872 }
2873 }
2874
2875 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2876 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002877
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002878 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002879}
2880
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002881bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002882 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002883 return false;
2884 }
2885
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002886 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002887 return false;
2888 }
2889
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002890 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002891 return false;
2892 }
2893 return true;
2894}
2895
Nandana Dutt197661d2018-11-16 16:40:21 +00002896void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2897 options_ = std::move(options);
2898}
2899
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002900void Dumpstate::Initialize() {
2901 /* gets the sequential id */
2902 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2903 id_ = ++last_id;
2904 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2905}
2906
Nandana Duttd2f5f082019-01-18 17:13:52 +00002907Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2908 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002909 if (listener_ != nullptr) {
2910 switch (status) {
2911 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002912 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002913 break;
2914 case Dumpstate::RunStatus::HELP:
2915 break;
2916 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002917 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002918 break;
2919 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002920 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2921 break;
2922 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2923 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2924 break;
2925 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2926 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002927 break;
2928 }
2929 }
2930 return status;
2931}
2932
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002933void Dumpstate::Cancel() {
2934 CleanupTmpFiles();
2935 android::os::UnlinkAndLogOnError(log_path_);
2936 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2937 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2938 kDumpstateBoardFiles[i]);
2939 }
2940 tombstone_data_.clear();
2941 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002942 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002943
2944 // Instead of shutdown the pool, we delete temporary files directly since
2945 // shutdown blocking the call.
2946 if (dump_pool_) {
2947 dump_pool_->deleteTempFiles();
2948 }
2949 if (zip_entry_tasks_) {
2950 zip_entry_tasks_->run(/*do_cancel =*/ true);
2951 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002952}
2953
Nandana Dutt979388e2018-11-30 16:48:55 +00002954/*
2955 * Dumps relevant information to a bugreport based on the given options.
2956 *
2957 * The bugreport can be dumped to a file or streamed to a socket.
2958 *
2959 * How dumping to file works:
2960 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
2961 * stderr is redirected a log file.
2962 *
2963 * The temporary bugreport is then populated via printfs, dumping contents of files and
2964 * output of commands to stdout.
2965 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002966 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002967 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002968 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00002969 *
mhasank2d75c442020-06-11 15:05:25 -07002970 * Bugreports are first generated in a local directory and later copied to the caller's fd
2971 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00002972 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00002973Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
2974 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08002975 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00002976 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00002977 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00002978 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002979 return RunStatus::INVALID_INPUT;
2980 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002981 /* set as high priority, and protect from OOM killer */
2982 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002983
Felipe Lemed071c682016-10-20 16:48:00 -07002984 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002985 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002986 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07002987 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07002988 } else {
2989 /* fallback to kernels <= 2.6.35 */
2990 oom_adj = fopen("/proc/self/oom_adj", "we");
2991 if (oom_adj) {
2992 fputs("-17", oom_adj);
2993 fclose(oom_adj);
2994 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07002995 }
2996
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002997 if (version_ == VERSION_DEFAULT) {
2998 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00002999 }
3000
Chris Morin5a50d482022-02-01 17:41:18 -08003001 if (version_ != VERSION_CURRENT) {
3002 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3003 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003004 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003005 }
3006
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003007 if (options_->show_header_only) {
3008 PrintHeader();
3009 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003010 }
3011
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003012 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3013 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003014
Felipe Leme7447d7c2016-11-03 18:12:22 -07003015 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003016 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003017 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003018 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003019
Sahana Raof35ed432019-07-12 10:47:52 +01003020 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3021 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3022 } else {
3023 // Wake lock will be released automatically on process death
3024 MYLOGD("Wake lock acquired.\n");
3025 }
3026
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003027 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003028
Felipe Lemef0292972016-11-22 13:57:05 -08003029 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003030 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3031 }
3032
Nandana Dutt235c6672019-11-14 15:22:32 +00003033 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003034 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003035
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003036 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003037
Christopher Ferrised9354f2014-10-01 17:35:01 -07003038 // If we are going to use a socket, do it as early as possible
3039 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003040 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003041 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003042 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003043 if (control_socket_fd_ == -1) {
3044 return ERROR;
3045 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003046 if (options_->progress_updates_to_socket) {
3047 options_->do_progress_updates = 1;
3048 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003049 }
3050
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003051 if (!PrepareToWriteToFile()) {
3052 return ERROR;
3053 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003054
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003055 // Interactive, wear & telephony modes are default to true.
3056 // and may enable from cli option or when using control socket
3057 if (options_->do_progress_updates) {
3058 // clang-format off
3059 std::vector<std::string> am_args = {
3060 "--receiver-permission", "android.permission.DUMP",
3061 };
3062 // clang-format on
3063 // Send STARTED broadcast for apps that listen to bugreport generation events
3064 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3065 if (options_->progress_updates_to_socket) {
3066 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003067 }
3068 }
3069
Nick Kralevichf3599b32016-01-25 15:05:16 -08003070 /* read /proc/cmdline before dropping root */
3071 FILE *cmdline = fopen("/proc/cmdline", "re");
3072 if (cmdline) {
3073 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3074 fclose(cmdline);
3075 }
3076
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003077 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003078 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003079 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003080
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003081 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003082 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3083 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003084 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003085 }
3086 }
3087
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003088 int dup_stdout_fd;
3089 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003090 // Redirect stderr to log_path_ for debugging.
3091 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3092 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3093 return ERROR;
3094 }
3095 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3096 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3097 strerror(errno));
3098 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003099
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003100 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3101 // moved into zip file later, if zipping.
3102 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3103 // TODO: why not write to a file instead of stdout to overcome this problem?
3104 /* TODO: rather than generating a text file now and zipping it later,
3105 it would be more efficient to redirect stdout to the zip entry
3106 directly, but the libziparchive doesn't support that option yet. */
3107 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3108 return ERROR;
3109 }
3110 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3111 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3112 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003113 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003114
3115 // Don't buffer stdout
3116 setvbuf(stdout, nullptr, _IONBF, 0);
3117
Rhed Jao5377d792020-07-16 17:37:39 +08003118 // Enable the parallel run if the client requests to output to a file.
3119 EnableParallelRunIfNeeded();
3120 // Using scope guard to make sure the dump pool can be shut down correctly.
3121 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3122 ShutdownDumpPool();
3123 });
3124
Felipe Leme608385d2016-02-01 10:35:38 -08003125 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3126 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003127 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003128 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003129
Gavin Corkery6968f552020-11-22 18:09:05 +00003130 bool is_dumpstate_restricted = options_->telephony_only
3131 || options_->wifi_only
3132 || options_->limited_only;
3133 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003134 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003135 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003136 }
3137 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003138
3139 if (!is_dumpstate_restricted) {
3140 // Snapshot the system trace now (if running) to avoid that dumpstate's
3141 // own activity pushes out interesting data from the trace ring buffer.
3142 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3143 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003144
3145 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3146 // from WMTRACE_DATA_DIR.
3147 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003148 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003149 onUiIntensiveBugreportDumpsFinished(calling_uid);
3150 MaybeCheckUserConsent(calling_uid, calling_package);
3151 if (options_->telephony_only) {
3152 DumpstateTelephonyOnly(calling_package);
3153 } else if (options_->wifi_only) {
3154 DumpstateWifiOnly();
3155 } else if (options_->limited_only) {
3156 DumpstateLimitedOnly();
3157 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003158 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003159 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003160 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003161 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003162 HandleUserConsentDenied();
3163 }
3164 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003165 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003166 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003167
Felipe Leme55b42a62015-11-10 17:39:08 -08003168 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003169 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003170
Abhijeet Kaure370d682019-10-01 16:49:30 +01003171 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003172 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003173 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003174 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003175
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003176 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003177 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003178 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003179 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003180 if (status != Dumpstate::RunStatus::OK &&
3181 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3182 // Do an early return if there were errors. We make an exception for consent
3183 // timing out because it's possible the user got distracted. In this case the
3184 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003185 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003186 return status;
3187 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003188 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3189 MYLOGI(
3190 "Did not receive user consent yet."
3191 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003192 const String16 incidentcompanion("incidentcompanion");
3193 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3194 if (ics != nullptr) {
3195 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3196 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3197 consent_callback_.get());
3198 } else {
3199 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3200 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003201 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003202 }
3203
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003204 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003205 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003206 for (int i = 0; i < 3; i++) {
3207 Vibrate(75);
3208 usleep((75 + 50) * 1000);
3209 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003210 }
3211
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003212 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3213 progress_->GetInitialMax());
3214 progress_->Save();
3215 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003216
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003217 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003218
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003219 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003220 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003221 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003222 }
3223
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003224 tombstone_data_.clear();
3225 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003226 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003227
Nandana Duttd2f5f082019-01-18 17:13:52 +00003228 return (consent_callback_ != nullptr &&
3229 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3230 ? USER_CONSENT_TIMED_OUT
3231 : RunStatus::OK;
3232}
3233
Paul Chang0d2aad72020-02-13 20:04:03 +08003234void Dumpstate::MaybeTakeEarlyScreenshot() {
3235 if (!options_->do_screenshot || !do_early_screenshot_) {
3236 return;
3237 }
3238
3239 TakeScreenshot();
3240}
3241
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003242void Dumpstate::MaybeSnapshotSystemTrace() {
3243 // If a background system trace is happening and is marked as "suitable for
3244 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3245 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3246 // case that no trace is ongoing, this command is a no-op.
3247 // Note: this should not be enqueued as we need to freeze the trace before
3248 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3249 // the dumpstate's own activity which is irrelevant.
3250 int res = RunCommand(
3251 "SERIALIZE PERFETTO TRACE",
3252 {"perfetto", "--save-for-bugreport"},
3253 CommandOptions::WithTimeout(10)
3254 .DropRoot()
3255 .CloseAllFileDescriptorsOnExec()
3256 .Build());
3257 has_system_trace_ = res == 0;
3258 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3259 // file in the later stages.
3260}
3261
Yohei Yukawa95305b32021-03-09 07:54:27 -08003262void Dumpstate::MaybeSnapshotWinTrace() {
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003263 // Include the proto logging from WMShell.
3264 RunCommand(
3265 // Empty name because it's not intended to be classified as a bugreport section.
3266 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3267 // in the bugreport.
3268 "", {"dumpsys", "activity", "service", "SystemUIService",
3269 "WMShell", "protolog", "save-for-bugreport"},
3270 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3271
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003272 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3273 for (const auto& service : {"window", "input_method"}) {
3274 RunCommand(
3275 // Empty name because it's not intended to be classified as a bugreport section.
3276 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3277 "", {"cmd", service, "tracing", "save-for-bugreport"},
3278 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3279 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003280}
3281
Paul Changeb4b4642020-05-28 22:05:47 +08003282void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003283 if (calling_uid == AID_SHELL || !CalledByApi()) {
3284 return;
3285 }
3286 if (listener_ != nullptr) {
3287 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3288 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003289 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003290 }
3291}
3292
Jichao Lie89d9c12019-11-21 19:02:51 -08003293void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3294 if (calling_uid == AID_SHELL || !CalledByApi()) {
3295 // No need to get consent for shell triggered dumpstates, or not through
3296 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003297 return;
3298 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003299 consent_callback_ = new ConsentCallback();
3300 const String16 incidentcompanion("incidentcompanion");
3301 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003302 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003303 if (ics != nullptr) {
3304 MYLOGD("Checking user consent via incidentcompanion service\n");
3305 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003306 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003307 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003308 } else {
3309 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3310 }
3311}
3312
Nandana Dutt5c390032019-03-12 10:52:56 +00003313bool Dumpstate::IsUserConsentDenied() const {
3314 return ds.consent_callback_ != nullptr &&
3315 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3316}
3317
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003318bool Dumpstate::CalledByApi() const {
3319 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3320}
3321
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003322void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003323 android::os::UnlinkAndLogOnError(tmp_path_);
3324 android::os::UnlinkAndLogOnError(screenshot_path_);
3325 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003326 if (dump_traces_path != nullptr) {
3327 android::os::UnlinkAndLogOnError(dump_traces_path);
3328 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003329}
3330
Rhed Jao5377d792020-07-16 17:37:39 +08003331void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003332 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003333 return;
3334 }
3335 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003336 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003337}
3338
3339void Dumpstate::ShutdownDumpPool() {
3340 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003341 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003342 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003343 if (zip_entry_tasks_) {
3344 zip_entry_tasks_->run(/* do_cancel = */true);
3345 zip_entry_tasks_ = nullptr;
3346 }
3347}
3348
3349void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3350 const std::string& entry_path) {
3351 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3352 if (!task_cancelled) {
3353 AddZipEntry(entry_name, entry_path);
3354 }
3355 android::os::UnlinkAndLogOnError(entry_path);
3356 };
3357 if (zip_entry_tasks_) {
3358 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3359 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3360 } else {
3361 // Invokes AddZipEntryAndCleanup immediately
3362 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3363 }
Rhed Jao5377d792020-07-16 17:37:39 +08003364}
3365
Nandana Duttd2f5f082019-01-18 17:13:52 +00003366Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3367 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003368 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003369 return USER_CONSENT_DENIED;
3370}
3371
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003372Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003373 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003374 // user consent (unless the caller is Shell).
3375 UserConsentResult consent_result;
3376 if (calling_uid == AID_SHELL) {
3377 consent_result = UserConsentResult::APPROVED;
3378 } else {
3379 consent_result = consent_callback_->getResult();
3380 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003381 if (consent_result == UserConsentResult::UNAVAILABLE) {
3382 // User has not responded yet.
3383 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003384 // Telephony is a fast report type, particularly on user builds where information may be
3385 // more aggressively limited. To give the user time to read the consent dialog, increase the
3386 // timeout.
3387 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3388 : USER_CONSENT_TIMEOUT_MS;
3389 if (elapsed_ms < timeout_ms) {
3390 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003391 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3392 sleep(delay_seconds);
3393 }
3394 consent_result = consent_callback_->getResult();
3395 }
3396 if (consent_result == UserConsentResult::DENIED) {
3397 // User has explicitly denied sharing with the app. To be safe delete the
3398 // internal bugreport & tmp files.
3399 return HandleUserConsentDenied();
3400 }
3401 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003402 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3403 if (copy_succeeded) {
3404 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003405 if (options_->do_screenshot &&
3406 options_->screenshot_fd.get() != -1 &&
3407 !options_->is_screenshot_copied) {
3408 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3409 options_->screenshot_fd.get());
3410 options_->is_screenshot_copied = copy_succeeded;
3411 if (copy_succeeded) {
3412 android::os::UnlinkAndLogOnError(screenshot_path_);
3413 }
3414 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003415 }
3416 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3417 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3418 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3419 // Since we do not have user consent to share the bugreport it does not get
3420 // copied over to the calling app but remains in the internal directory from
3421 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003422 std::string final_path = GetPath(".zip");
3423 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3424 if (copy_succeeded) {
3425 android::os::UnlinkAndLogOnError(path_);
3426 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003427 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3428 }
3429 // Unknown result; must be a programming error.
3430 MYLOGE("Unknown user consent result:%d\n", consent_result);
3431 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003432}
3433
Nandana Duttf02564e2019-02-15 15:24:24 +00003434Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003435 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3436 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3437 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003438 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003439 // When directly running dumpstate binary, the output is not expected to be written
3440 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003441 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003442
3443 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003444 // an app; they are irrelevant here because bugreport is triggered via command line.
3445 // Update Last ID before calling Run().
3446 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003447 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003448 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003449 return status;
3450}
3451
3452/* Main entry point for dumpstate binary. */
3453int run_main(int argc, char* argv[]) {
3454 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003455
3456 switch (status) {
3457 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003458 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003459 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003460 ShowUsage();
3461 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003462 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003463 fprintf(stderr, "Invalid combination of args\n");
3464 ShowUsage();
3465 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003466 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003467 FALLTHROUGH_INTENDED;
3468 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3469 FALLTHROUGH_INTENDED;
3470 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003471 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003472 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003473}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003474
3475// TODO(111441001): Default DumpOptions to sensible values.
3476Dumpstate::Dumpstate(const std::string& version)
3477 : pid_(getpid()),
3478 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003479 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003480 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003481 now_(time(nullptr)),
3482 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003483}
3484
3485Dumpstate& Dumpstate::GetInstance() {
3486 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3487 return singleton_;
3488}
3489
Rhed Jao5377d792020-07-16 17:37:39 +08003490DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3491 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3492 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003493 if (!title_.empty()) {
3494 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003495 if (title_.find("SHOW MAP") == std::string::npos) {
3496 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3497 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003498 }
3499}
3500
3501DurationReporter::~DurationReporter() {
3502 if (!title_.empty()) {
3503 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003504 if (elapsed >= .5f || verbose_) {
3505 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003506 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003507 if (!logcat_only_) {
3508 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003509 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3510 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003511 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003512 if (title_.find("SHOW MAP") == std::string::npos) {
3513 ATRACE_ASYNC_END(title_.c_str(), 0);
3514 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003515 }
3516}
3517
3518const int32_t Progress::kDefaultMax = 5000;
3519
3520Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3521}
3522
3523Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3524 : Progress(initial_max, growth_factor, "") {
3525 progress_ = progress;
3526}
3527
3528Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3529 : initial_max_(initial_max),
3530 progress_(0),
3531 max_(initial_max),
3532 growth_factor_(growth_factor),
3533 n_runs_(0),
3534 average_max_(0),
3535 path_(path) {
3536 if (!path_.empty()) {
3537 Load();
3538 }
3539}
3540
3541void Progress::Load() {
3542 MYLOGD("Loading stats from %s\n", path_.c_str());
3543 std::string content;
3544 if (!android::base::ReadFileToString(path_, &content)) {
3545 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3546 return;
3547 }
3548 if (content.empty()) {
3549 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3550 return;
3551 }
3552 std::vector<std::string> lines = android::base::Split(content, "\n");
3553
3554 if (lines.size() < 1) {
3555 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3556 (int)lines.size(), max_);
3557 return;
3558 }
3559 char* ptr;
3560 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3561 average_max_ = strtol(ptr, nullptr, 10);
3562 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3563 average_max_ > STATS_MAX_AVERAGE) {
3564 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3565 initial_max_ = Progress::kDefaultMax;
3566 } else {
3567 initial_max_ = average_max_;
3568 }
3569 max_ = initial_max_;
3570
3571 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3572}
3573
3574void Progress::Save() {
3575 int32_t total = n_runs_ * average_max_ + progress_;
3576 int32_t runs = n_runs_ + 1;
3577 int32_t average = floor(((float)total) / runs);
3578 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3579 path_.c_str());
3580 if (path_.empty()) {
3581 return;
3582 }
3583
3584 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3585 if (!android::base::WriteStringToFile(content, path_)) {
3586 MYLOGE("Could not save stats on %s\n", path_.c_str());
3587 }
3588}
3589
3590int32_t Progress::Get() const {
3591 return progress_;
3592}
3593
3594bool Progress::Inc(int32_t delta_sec) {
3595 bool changed = false;
3596 if (delta_sec >= 0) {
3597 progress_ += delta_sec;
3598 if (progress_ > max_) {
3599 int32_t old_max = max_;
3600 max_ = floor((float)progress_ * growth_factor_);
3601 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3602 changed = true;
3603 }
3604 }
3605 return changed;
3606}
3607
3608int32_t Progress::GetMax() const {
3609 return max_;
3610}
3611
3612int32_t Progress::GetInitialMax() const {
3613 return initial_max_;
3614}
3615
3616void Progress::Dump(int fd, const std::string& prefix) const {
3617 const char* pr = prefix.c_str();
3618 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3619 dprintf(fd, "%smax: %d\n", pr, max_);
3620 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3621 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3622 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3623 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3624 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3625}
3626
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003627std::string Dumpstate::GetPath(const std::string& suffix) const {
3628 return GetPath(bugreport_internal_dir_, suffix);
3629}
3630
3631std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3632 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3633 name_.c_str(), suffix.c_str());
3634}
3635
3636void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3637 progress_ = std::move(progress);
3638}
3639
3640void for_each_userid(void (*func)(int), const char *header) {
3641 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3642 "for_each_userid(%s)", header);
3643 DurationReporter duration_reporter(title);
3644 if (PropertiesHelper::IsDryRun()) return;
3645
3646 DIR *d;
3647 struct dirent *de;
3648
3649 if (header) printf("\n------ %s ------\n", header);
3650 func(0);
3651
3652 if (!(d = opendir("/data/system/users"))) {
3653 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3654 return;
3655 }
3656
3657 while ((de = readdir(d))) {
3658 int userid;
3659 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3660 continue;
3661 }
3662 func(userid);
3663 }
3664
3665 closedir(d);
3666}
3667
3668static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3669 DIR *d;
3670 struct dirent *de;
3671
3672 if (!(d = opendir("/proc"))) {
3673 printf("Failed to open /proc (%s)\n", strerror(errno));
3674 return;
3675 }
3676
3677 if (header) printf("\n------ %s ------\n", header);
3678 while ((de = readdir(d))) {
3679 if (ds.IsUserConsentDenied()) {
3680 MYLOGE(
3681 "Returning early because user denied consent to share bugreport with calling app.");
3682 closedir(d);
3683 return;
3684 }
3685 int pid;
3686 int fd;
3687 char cmdpath[255];
3688 char cmdline[255];
3689
3690 if (!(pid = atoi(de->d_name))) {
3691 continue;
3692 }
3693
3694 memset(cmdline, 0, sizeof(cmdline));
3695
3696 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3697 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3698 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3699 close(fd);
3700 if (cmdline[0]) {
3701 helper(pid, cmdline, arg);
3702 continue;
3703 }
3704 }
3705
3706 // if no cmdline, a kernel thread has comm
3707 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3708 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3709 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3710 close(fd);
3711 if (cmdline[1]) {
3712 cmdline[0] = '[';
3713 size_t len = strcspn(cmdline, "\f\b\r\n");
3714 cmdline[len] = ']';
3715 cmdline[len+1] = '\0';
3716 }
3717 }
3718 if (!cmdline[0]) {
3719 strcpy(cmdline, "N/A");
3720 }
3721 helper(pid, cmdline, arg);
3722 }
3723
3724 closedir(d);
3725}
3726
3727static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3728 for_each_pid_func *func = (for_each_pid_func*) arg;
3729 func(pid, cmdline);
3730}
3731
3732void for_each_pid(for_each_pid_func func, const char *header) {
3733 std::string title = header == nullptr ? "for_each_pid"
3734 : android::base::StringPrintf("for_each_pid(%s)", header);
3735 DurationReporter duration_reporter(title);
3736 if (PropertiesHelper::IsDryRun()) return;
3737
3738 __for_each_pid(for_each_pid_helper, header, (void *) func);
3739}
3740
3741static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3742 DIR *d;
3743 struct dirent *de;
3744 char taskpath[255];
3745 for_each_tid_func *func = (for_each_tid_func *) arg;
3746
3747 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3748
3749 if (!(d = opendir(taskpath))) {
3750 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3751 return;
3752 }
3753
3754 func(pid, pid, cmdline);
3755
3756 while ((de = readdir(d))) {
3757 if (ds.IsUserConsentDenied()) {
3758 MYLOGE(
3759 "Returning early because user denied consent to share bugreport with calling app.");
3760 closedir(d);
3761 return;
3762 }
3763 int tid;
3764 int fd;
3765 char commpath[255];
3766 char comm[255];
3767
3768 if (!(tid = atoi(de->d_name))) {
3769 continue;
3770 }
3771
3772 if (tid == pid)
3773 continue;
3774
3775 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3776 memset(comm, 0, sizeof(comm));
3777 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3778 strcpy(comm, "N/A");
3779 } else {
3780 char *c;
3781 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3782 close(fd);
3783
3784 c = strrchr(comm, '\n');
3785 if (c) {
3786 *c = '\0';
3787 }
3788 }
3789 func(pid, tid, comm);
3790 }
3791
3792 closedir(d);
3793}
3794
3795void for_each_tid(for_each_tid_func func, const char *header) {
3796 std::string title = header == nullptr ? "for_each_tid"
3797 : android::base::StringPrintf("for_each_tid(%s)", header);
3798 DurationReporter duration_reporter(title);
3799
3800 if (PropertiesHelper::IsDryRun()) return;
3801
3802 __for_each_pid(for_each_tid_helper, header, (void *) func);
3803}
3804
3805void show_wchan(int pid, int tid, const char *name) {
3806 if (PropertiesHelper::IsDryRun()) return;
3807
3808 char path[255];
3809 char buffer[255];
3810 int fd, ret, save_errno;
3811 char name_buffer[255];
3812
3813 memset(buffer, 0, sizeof(buffer));
3814
3815 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3816 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3817 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3818 return;
3819 }
3820
3821 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3822 save_errno = errno;
3823 close(fd);
3824
3825 if (ret < 0) {
3826 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3827 return;
3828 }
3829
3830 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3831 pid == tid ? 0 : 3, "", name);
3832
3833 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3834
3835 return;
3836}
3837
3838// print time in centiseconds
3839static void snprcent(char *buffer, size_t len, size_t spc,
3840 unsigned long long time) {
3841 static long hz; // cache discovered hz
3842
3843 if (hz <= 0) {
3844 hz = sysconf(_SC_CLK_TCK);
3845 if (hz <= 0) {
3846 hz = 1000;
3847 }
3848 }
3849
3850 // convert to centiseconds
3851 time = (time * 100 + (hz / 2)) / hz;
3852
3853 char str[16];
3854
3855 snprintf(str, sizeof(str), " %llu.%02u",
3856 time / 100, (unsigned)(time % 100));
3857 size_t offset = strlen(buffer);
3858 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3859 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3860}
3861
3862// print permille as a percent
3863static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3864 char str[16];
3865
3866 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3867 size_t offset = strlen(buffer);
3868 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3869 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3870}
3871
3872void show_showtime(int pid, const char *name) {
3873 if (PropertiesHelper::IsDryRun()) return;
3874
3875 char path[255];
3876 char buffer[1023];
3877 int fd, ret, save_errno;
3878
3879 memset(buffer, 0, sizeof(buffer));
3880
3881 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3882 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3883 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3884 return;
3885 }
3886
3887 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3888 save_errno = errno;
3889 close(fd);
3890
3891 if (ret < 0) {
3892 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3893 return;
3894 }
3895
3896 // field 14 is utime
3897 // field 15 is stime
3898 // field 42 is iotime
3899 unsigned long long utime = 0, stime = 0, iotime = 0;
3900 if (sscanf(buffer,
3901 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3902 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3903 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3904 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3905 &utime, &stime, &iotime) != 3) {
3906 return;
3907 }
3908
3909 unsigned long long total = utime + stime;
3910 if (!total) {
3911 return;
3912 }
3913
3914 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3915 if (permille > 1000) {
3916 permille = 1000;
3917 }
3918
3919 // try to beautify and stabilize columns at <80 characters
3920 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3921 if ((name[0] != '[') || utime) {
3922 snprcent(buffer, sizeof(buffer), 57, utime);
3923 }
3924 snprcent(buffer, sizeof(buffer), 65, stime);
3925 if ((name[0] != '[') || iotime) {
3926 snprcent(buffer, sizeof(buffer), 73, iotime);
3927 }
3928 if (iotime) {
3929 snprdec(buffer, sizeof(buffer), 79, permille);
3930 }
3931 puts(buffer); // adds a trailing newline
3932
3933 return;
3934}
3935
3936void do_dmesg() {
3937 const char *title = "KERNEL LOG (dmesg)";
3938 DurationReporter duration_reporter(title);
3939 printf("------ %s ------\n", title);
3940
3941 if (PropertiesHelper::IsDryRun()) return;
3942
3943 /* Get size of kernel buffer */
3944 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3945 if (size <= 0) {
3946 printf("Unexpected klogctl return value: %d\n\n", size);
3947 return;
3948 }
3949 char *buf = (char *) malloc(size + 1);
3950 if (buf == nullptr) {
3951 printf("memory allocation failed\n\n");
3952 return;
3953 }
3954 int retval = klogctl(KLOG_READ_ALL, buf, size);
3955 if (retval < 0) {
3956 printf("klogctl failure\n\n");
3957 free(buf);
3958 return;
3959 }
3960 buf[retval] = '\0';
3961 printf("%s\n\n", buf);
3962 free(buf);
3963 return;
3964}
3965
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003966int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
3967 DurationReporter duration_reporter(title);
3968
3969 int status = DumpFileToFd(STDOUT_FILENO, title, path);
3970
3971 UpdateProgress(WEIGHT_FILE);
3972
3973 return status;
3974}
3975
3976int read_file_as_long(const char *path, long int *output) {
3977 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
3978 if (fd < 0) {
3979 int err = errno;
3980 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
3981 return -1;
3982 }
3983 char buffer[50];
3984 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3985 if (bytes_read == -1) {
3986 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
3987 return -2;
3988 }
3989 if (bytes_read == 0) {
3990 MYLOGE("File %s is empty\n", path);
3991 return -3;
3992 }
3993 *output = atoi(buffer);
3994 return 0;
3995}
3996
3997/* calls skip to gate calling dump_from_fd recursively
3998 * in the specified directory. dump_from_fd defaults to
3999 * dump_file_from_fd above when set to NULL. skip defaults
4000 * to false when set to NULL. dump_from_fd will always be
4001 * called with title NULL.
4002 */
4003int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4004 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4005 DurationReporter duration_reporter(title);
4006 DIR *dirp;
4007 struct dirent *d;
4008 char *newpath = nullptr;
4009 const char *slash = "/";
4010 int retval = 0;
4011
4012 if (!title.empty()) {
4013 printf("------ %s (%s) ------\n", title.c_str(), dir);
4014 }
4015 if (PropertiesHelper::IsDryRun()) return 0;
4016
4017 if (dir[strlen(dir) - 1] == '/') {
4018 ++slash;
4019 }
4020 dirp = opendir(dir);
4021 if (dirp == nullptr) {
4022 retval = -errno;
4023 MYLOGE("%s: %s\n", dir, strerror(errno));
4024 return retval;
4025 }
4026
4027 if (!dump_from_fd) {
4028 dump_from_fd = dump_file_from_fd;
4029 }
4030 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4031 if ((d->d_name[0] == '.')
4032 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4033 || (d->d_name[1] == '\0'))) {
4034 continue;
4035 }
4036 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4037 (d->d_type == DT_DIR) ? "/" : "");
4038 if (!newpath) {
4039 retval = -errno;
4040 continue;
4041 }
4042 if (skip && (*skip)(newpath)) {
4043 continue;
4044 }
4045 if (d->d_type == DT_DIR) {
4046 int ret = dump_files("", newpath, skip, dump_from_fd);
4047 if (ret < 0) {
4048 retval = ret;
4049 }
4050 continue;
4051 }
4052 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4053 if (fd.get() < 0) {
4054 retval = -1;
4055 printf("*** %s: %s\n", newpath, strerror(errno));
4056 continue;
4057 }
4058 (*dump_from_fd)(nullptr, newpath, fd.get());
4059 }
4060 closedir(dirp);
4061 if (!title.empty()) {
4062 printf("\n");
4063 }
4064 return retval;
4065}
4066
4067/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4068 * it's possible to avoid issues where opening the file itself can get
4069 * stuck.
4070 */
4071int dump_file_from_fd(const char *title, const char *path, int fd) {
4072 if (PropertiesHelper::IsDryRun()) return 0;
4073
4074 int flags = fcntl(fd, F_GETFL);
4075 if (flags == -1) {
4076 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4077 return -1;
4078 } else if (!(flags & O_NONBLOCK)) {
4079 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4080 return -1;
4081 }
4082 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4083}
4084
4085int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004086 const CommandOptions& options, bool verbose_duration, int out_fd) {
4087 DurationReporter duration_reporter(title, false /* logcat_only */,
4088 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004089
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004090 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004091
4092 /* TODO: for now we're simplifying the progress calculation by using the
4093 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4094 * where its weight should be much higher proportionally to its timeout.
4095 * Ideally, it should use a options.EstimatedDuration() instead...*/
4096 UpdateProgress(options.Timeout());
4097
4098 return status;
4099}
4100
4101void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004102 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004103 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4104 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4105 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004106 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004107}
4108
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004109static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004110 int s = android_get_control_socket(service);
4111 if (s < 0) {
4112 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4113 return -1;
4114 }
4115 fcntl(s, F_SETFD, FD_CLOEXEC);
4116
4117 // Set backlog to 0 to make sure that queue size will be minimum.
4118 // In Linux, because the minimum queue will be 1, connect() will be blocked
4119 // if the other clients already called connect() and the connection request was not accepted.
4120 if (listen(s, 0) < 0) {
4121 MYLOGE("listen(control socket): %s\n", strerror(errno));
4122 return -1;
4123 }
4124
4125 struct sockaddr addr;
4126 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004127 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004128
4129 // Close socket just after accept(), to make sure that connect() by client will get error
4130 // when the socket is used by the other services.
4131 // There is still a race condition possibility between accept and close, but there is no way
4132 // to close-on-accept atomically.
4133 // See detail; b/123306389#comment25
4134 close(s);
4135
4136 if (fd < 0) {
4137 MYLOGE("accept(control socket): %s\n", strerror(errno));
4138 return -1;
4139 }
4140
4141 return fd;
4142}
4143
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004144// TODO: should call is_valid_output_file and/or be merged into it.
4145void create_parent_dirs(const char *path) {
4146 char *chp = const_cast<char *> (path);
4147
4148 /* skip initial slash */
4149 if (chp[0] == '/')
4150 chp++;
4151
4152 /* create leading directories, if necessary */
4153 struct stat dir_stat;
4154 while (chp && chp[0]) {
4155 chp = strchr(chp, '/');
4156 if (chp) {
4157 *chp = 0;
4158 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4159 MYLOGI("Creating directory %s\n", path);
4160 if (mkdir(path, 0770)) { /* drwxrwx--- */
4161 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4162 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4163 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4164 }
4165 }
4166 *chp++ = '/';
4167 }
4168 }
4169}
4170
4171bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4172 create_parent_dirs(path);
4173
4174 int fd = TEMP_FAILURE_RETRY(open(path,
4175 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4176 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4177 if (fd < 0) {
4178 MYLOGE("%s: %s\n", path, strerror(errno));
4179 return false;
4180 }
4181
4182 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4183 close(fd);
4184 return true;
4185}
4186
4187bool redirect_to_file(FILE* redirect, char* path) {
4188 return _redirect_to_file(redirect, path, O_TRUNC);
4189}
4190
4191bool redirect_to_existing_file(FILE* redirect, char* path) {
4192 return _redirect_to_file(redirect, path, O_APPEND);
4193}
4194
4195void dump_route_tables() {
4196 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4197 if (PropertiesHelper::IsDryRun()) return;
4198 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4199 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4200 FILE* fp = fopen(RT_TABLES_PATH, "re");
4201 if (!fp) {
4202 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4203 return;
4204 }
4205 char table[16];
4206 // Each line has an integer (the table number), a space, and a string (the table name). We only
4207 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4208 // Add a fixed max limit so this doesn't go awry.
4209 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4210 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4211 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4212 }
4213 fclose(fp);
4214}
4215
Li Li830179f2022-01-04 12:53:29 -08004216void dump_frozen_cgroupfs(const char *dir, int level,
4217 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4218 DIR *dirp;
4219 struct dirent *d;
4220 char *newpath = nullptr;
4221
4222 dirp = opendir(dir);
4223 if (dirp == nullptr) {
4224 MYLOGE("%s: %s\n", dir, strerror(errno));
4225 return;
4226 }
4227
4228 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4229 if ((d->d_name[0] == '.')
4230 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4231 || (d->d_name[1] == '\0'))) {
4232 continue;
4233 }
4234 if (d->d_type == DT_DIR) {
4235 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4236 if (!newpath) {
4237 continue;
4238 }
4239 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4240 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4241 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4242 char *freezer = nullptr;
4243 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4244 if (freezer) {
4245 FILE* fp = fopen(freezer, "r");
4246 if (fp != NULL) {
4247 int frozen;
4248 fscanf(fp, "%d", &frozen);
4249 if (frozen > 0) {
4250 dump_files("", newpath, skip_none, dump_from_fd);
4251 }
4252 fclose(fp);
4253 }
4254 free(freezer);
4255 }
4256 }
4257 }
4258 }
4259 closedir(dirp);
4260}
4261
4262void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004263 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4264 DurationReporter duration_reporter("FROZEN CGROUPFS");
4265 if (PropertiesHelper::IsDryRun()) return;
4266 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4267}
4268
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004269void Dumpstate::UpdateProgress(int32_t delta_sec) {
4270 if (progress_ == nullptr) {
4271 MYLOGE("UpdateProgress: progress_ not set\n");
4272 return;
4273 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004274 // This function updates progress related members of the dumpstate and reports
4275 // progress percentage to the bugreport client. Since it could be called by
4276 // different dump tasks at the same time if the parallel run is enabled, a
4277 // mutex lock is necessary here to synchronize the call.
4278 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004279
4280 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004281 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004282
4283 // ...but only notifiy listeners when necessary.
4284 if (!options_->do_progress_updates) return;
4285
4286 int progress = progress_->Get();
4287 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004288 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004289
Nandana Dutt402a8392019-06-14 14:25:13 +01004290 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004291 return;
4292 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004293 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004294
4295 if (control_socket_fd_ >= 0) {
4296 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4297 fsync(control_socket_fd_);
4298 }
4299
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004300 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004301 if (percent % 10 == 0) {
4302 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004303 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004304 } else {
4305 // stderr is ignored on normal invocations, but useful when calling
4306 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004307 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004308 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004309
4310 listener_->onProgress(percent);
4311 }
4312}
4313
4314void Dumpstate::TakeScreenshot(const std::string& path) {
4315 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4316 int status =
4317 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4318 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4319 if (status == 0) {
4320 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4321 } else {
4322 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4323 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004324 if (listener_ != nullptr) {
4325 // Show a visual indication to indicate screenshot is taken via
4326 // IDumpstateListener.onScreenshotTaken()
4327 listener_->onScreenshotTaken(status == 0);
4328 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004329}
4330
4331bool is_dir(const char* pathname) {
4332 struct stat info;
4333 if (stat(pathname, &info) == -1) {
4334 return false;
4335 }
4336 return S_ISDIR(info.st_mode);
4337}
4338
4339time_t get_mtime(int fd, time_t default_mtime) {
4340 struct stat info;
4341 if (fstat(fd, &info) == -1) {
4342 return default_mtime;
4343 }
4344 return info.st_mtime;
4345}