blob: 9444729a6c7f954c7de0f3894f520479fae3e9cf [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -070020#include <dirent.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070021#include <errno.h>
22#include <fcntl.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010023#include <inttypes.h>
Felipe Lemead5f6c42015-11-30 14:26:46 -080024#include <libgen.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070025#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010026#include <math.h>
27#include <poll.h>
Mark Salyzyn8f37aa52015-06-12 12:28:24 -070028#include <stdbool.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -070032#include <sys/mount.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080033#include <sys/poll.h>
Christopher Ferris7dc7f322014-07-22 16:08:19 -070034#include <sys/prctl.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070035#include <sys/resource.h>
36#include <sys/stat.h>
37#include <sys/time.h>
38#include <sys/wait.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010039#include <signal.h>
40#include <stdarg.h>
41#include <string.h>
42#include <sys/capability.h>
43#include <sys/inotify.h>
44#include <sys/klog.h>
45#include <time.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070046#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070047
48#include <chrono>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070049#include <cmath>
Abhijeet Kaurd3cca0d2019-03-25 12:04:16 +000050#include <fstream>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070051#include <functional>
52#include <future>
Narayan Kamath8f788292017-05-25 13:20:39 +010053#include <memory>
Hridya Valsarajuac582cd2019-08-05 15:39:54 -070054#include <numeric>
Narayan Kamath8f788292017-05-25 13:20:39 +010055#include <regex>
56#include <set>
57#include <string>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070058#include <utility>
Narayan Kamath8f788292017-05-25 13:20:39 +010059#include <vector>
Colin Crossf45fa6b2012-03-26 12:38:26 -070060
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000061#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070062#include <android-base/file.h>
63#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070064#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080065#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070066#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070067#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000068#include <android/binder_manager.h>
69#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010070#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080071#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080072#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
73#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080074#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000075#include <android/os/IIncidentCompanion.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010076#include <binder/IServiceManager.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080077#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070078#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010079#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000080#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000081#include <debuggerd/client.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080082#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000083#include <dumputils/dump_utils.h>
Sahana Raof35ed432019-07-12 10:47:52 +010084#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080085#include <hidl/ServiceManagement.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010086#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070087#include <log/log_read.h>
Felipe Leme75876a22016-10-27 16:31:27 -070088#include <openssl/sha.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070089#include <private/android_filesystem_config.h>
90#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080091#include <serviceutils/PriorityDumper.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070092#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000093#include <vintf/VintfObject.h>
Felipe Lemef0292972016-11-22 13:57:05 -080094#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070095#include "DumpstateService.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070096#include "dumpstate.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -080097
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000098namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
99namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
100namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
101
Vishnu Naire97d6122018-01-18 13:58:56 -0800102using ::std::literals::chrono_literals::operator""ms;
103using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800104using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800105
Felipe Leme47e9be22016-12-21 15:37:07 -0800106// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800107using android::defaultServiceManager;
108using android::Dumpsys;
109using android::INVALID_OPERATION;
110using android::IServiceManager;
111using android::OK;
112using android::sp;
113using android::status_t;
114using android::String16;
115using android::String8;
116using android::TIMED_OUT;
117using android::UNKNOWN_ERROR;
118using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000119using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000120using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800121using android::os::dumpstate::CommandOptions;
122using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800123using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800124using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800125using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800126using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800127
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100128// Keep in sync with
129// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
130static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
131
132/* Most simple commands have 10 as timeout, so 5 is a good estimate */
133static const int32_t WEIGHT_FILE = 5;
134
135// TODO: temporary variables and functions used during C++ refactoring
136static Dumpstate& ds = Dumpstate::GetInstance();
137static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100138 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800139 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
140 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100141}
142
143// Reasonable value for max stats.
144static const int STATS_MAX_N_RUNS = 1000;
145static const long STATS_MAX_AVERAGE = 100000;
146
147CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
148
Nandana Duttd2f5f082019-01-18 17:13:52 +0000149typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
150
Colin Crossf45fa6b2012-03-26 12:38:26 -0700151/* read before root is shed */
152static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700153static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000154static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800155// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
156// it's often the case that they time out far too quickly for consent with such a hefty dialog for
157// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
158// roughly match full reports' durations.
159static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700160
Felipe Leme1d486fe2016-10-14 18:06:47 -0700161// TODO: variables and functions below should be part of dumpstate object
162
Felipe Leme635ca312016-01-05 14:23:02 -0800163static std::set<std::string> mount_points;
164void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800165
Todd Poynor2a83daa2013-11-22 15:44:22 -0800166#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700167#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700168#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169
Felipe Lemee82a27d2016-01-05 13:35:44 -0800170#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700171#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700172#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700173#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700174#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800175#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100176#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
177#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800178#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Erik Kline08165202016-05-30 11:55:44 +0900179#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800180#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700181#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800182#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900183#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700184#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000185#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700186#define CGROUPFS_DIR "/sys/fs/cgroup"
Mårten Kongstad60195a72022-09-20 14:14:20 +0200187#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700188#define DROPBOX_DIR "/data/system/dropbox"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700189
Narayan Kamath8f788292017-05-25 13:20:39 +0100190// TODO(narayan): Since this information has to be kept in sync
191// with tombstoned, we should just put it in a common header.
192//
193// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100194static const std::string TOMBSTONE_DIR = "/data/tombstones/";
195static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
196static const std::string ANR_DIR = "/data/anr/";
197static const std::string ANR_FILE_PREFIX = "anr_";
Woody Lin20767a92022-11-29 15:50:24 +0800198static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
199static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700200
Felipe Lemee844a9d2016-09-21 15:01:39 -0700201// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000202
Nandana Dutt5c390032019-03-12 10:52:56 +0000203#define RETURN_IF_USER_DENIED_CONSENT() \
204 if (ds.IsUserConsentDenied()) { \
205 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
206 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
207 }
208
209// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
210// if consent is found to be denied.
211#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
212 RETURN_IF_USER_DENIED_CONSENT(); \
213 func_ptr(__VA_ARGS__); \
214 RETURN_IF_USER_DENIED_CONSENT();
215
Rhed Jao5377d792020-07-16 17:37:39 +0800216// Runs func_ptr, and logs a duration report after it's finished.
217#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
218 { \
219 DurationReporter duration_reporter_in_macro(log_title); \
220 func_ptr(__VA_ARGS__); \
221 }
222
223// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
224// is output after a slow function is finished.
225#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
226 RETURN_IF_USER_DENIED_CONSENT(); \
227 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
228 RETURN_IF_USER_DENIED_CONSENT();
229
Chris Morinbc223142022-02-04 14:17:11 -0800230#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800231 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800232 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800233 RETURN_IF_USER_DENIED_CONSENT();
234
Sahana Raof35ed432019-07-12 10:47:52 +0100235static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
236
Rhed Jao5377d792020-07-16 17:37:39 +0800237// Names of parallel tasks, they are used for the DumpPool to identify the dump
238// task and the log title of the duration report.
239static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800240static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huanga99452a2022-04-27 18:51:16 +0800241static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800242static const std::string DUMP_HALS_TASK = "DUMP HALS";
243static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800244static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Rhed Jao5377d792020-07-16 17:37:39 +0800245
Nandana Dutt979388e2018-11-30 16:48:55 +0000246namespace android {
247namespace os {
248namespace {
249
250static int Open(std::string path, int flags, mode_t mode = 0) {
251 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
252 if (fd == -1) {
253 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
254 }
255 return fd;
256}
257
mhasank2d75c442020-06-11 15:05:25 -0700258static int OpenForWrite(std::string path) {
259 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
260 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
261}
Nandana Dutt979388e2018-11-30 16:48:55 +0000262
263static int OpenForRead(std::string path) {
264 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
265}
266
267bool CopyFile(int in_fd, int out_fd) {
268 char buf[4096];
269 ssize_t byte_count;
270 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
271 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
272 return false;
273 }
274 }
275 return (byte_count != -1);
276}
277
278static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000279 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000280
281 // Obtain a handle to the source file.
282 android::base::unique_fd in_fd(OpenForRead(input_file));
283 if (out_fd != -1 && in_fd.get() != -1) {
284 if (CopyFile(in_fd.get(), out_fd)) {
285 return true;
286 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000287 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000288 }
289 return false;
290}
291
Nandana Duttd2f5f082019-01-18 17:13:52 +0000292static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000293 if (file.empty()) {
294 return false;
295 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000296 if (unlink(file.c_str())) {
297 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000298 return false;
299 }
300 return true;
301}
Nandana Dutt979388e2018-11-30 16:48:55 +0000302
Nikita Ioffea325a572019-05-16 19:49:47 +0100303int64_t GetModuleMetadataVersion() {
304 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
305 if (binder == nullptr) {
306 MYLOGE("Failed to retrieve package_native service");
307 return 0L;
308 }
309 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
310 std::string package_name;
311 auto status = package_service->getModuleMetadataPackageName(&package_name);
312 if (!status.isOk()) {
313 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
314 return 0L;
315 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100316 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100317 int64_t version_code;
318 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
319 &version_code);
320 if (!status.isOk()) {
321 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
322 return 0L;
323 }
324 return version_code;
325}
326
mhasank2d75c442020-06-11 15:05:25 -0700327static bool PathExists(const std::string& path) {
328 struct stat sb;
329 return stat(path.c_str(), &sb) == 0;
330}
331
332static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
333 if (input_file == output_file) {
334 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
335 output_file.c_str());
336 return false;
337 }
338 else if (PathExists(output_file)) {
339 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
340 return false;
341 }
342
343 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
344 android::base::unique_fd out_fd(OpenForWrite(output_file));
345 return CopyFileToFd(input_file, out_fd.get());
346}
347
Nandana Dutt979388e2018-11-30 16:48:55 +0000348} // namespace
349} // namespace os
350} // namespace android
351
Felipe Leme678727a2016-09-21 17:22:11 -0700352static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800353 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800354 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
355 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
356}
357static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
358 int out_fd) {
359 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700360}
361static int DumpFile(const std::string& title, const std::string& path) {
362 return ds.DumpFile(title, path);
363}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800364
Felipe Lemee844a9d2016-09-21 15:01:39 -0700365// Relative directory (inside the zip) for all files copied as-is into the bugreport.
366static const std::string ZIP_ROOT_DIR = "FS";
367
Vishnu Naire97d6122018-01-18 13:58:56 -0800368static const std::string kProtoPath = "proto/";
369static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700370static const std::string kDumpstateBoardFiles[] = {
371 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700372 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700373};
374static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
375
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700376static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700377static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700378
Felipe Lemef0292972016-11-22 13:57:05 -0800379static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
380
Narayan Kamath8f788292017-05-25 13:20:39 +0100381/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100382 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800383 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800384 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100385 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700386static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800387 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100388 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100389
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700390 if (dump_dir == nullptr) {
391 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700392 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700393 }
394
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700395 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 struct dirent* entry = nullptr;
397 while ((entry = readdir(dump_dir.get()))) {
398 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100399 continue;
400 }
401
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 const std::string base_name(entry->d_name);
403 if (base_name.find(file_prefix) != 0) {
404 continue;
405 }
406
407 const std::string abs_path = dir_path + base_name;
408 android::base::unique_fd fd(
409 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
410 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700411 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100412 break;
413 }
414
415 struct stat st = {};
416 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700417 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100418 continue;
419 }
420
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700421 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700422 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800423 if (!dump_data.empty()) {
424 std::sort(dump_data.begin(), dump_data.end(),
425 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
426 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100429}
430
Narayan Kamathbd863722017-06-01 18:50:12 +0100431static bool AddDumps(const std::vector<DumpData>::const_iterator start,
432 const std::vector<DumpData>::const_iterator end,
433 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100434 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100435 for (auto it = start; it != end; ++it) {
436 const std::string& name = it->name;
437 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100438 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100439
440 // Seek to the beginning of the file before dumping any data. A given
441 // DumpData entry might be dumped multiple times in the report.
442 //
443 // For example, the most recent ANR entry is dumped to the body of the
444 // main entry and it also shows up as a separate entry in the bugreport
445 // ZIP file.
446 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
447 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
448 strerror(errno));
449 }
450
Chris Morinc2cba7a2022-02-01 17:06:50 -0800451 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800452 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100453 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100454 }
455 } else {
456 dump_file_from_fd(type_name, name.c_str(), fd);
457 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100458 }
459
460 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700461}
462
Felipe Leme635ca312016-01-05 14:23:02 -0800463// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700464void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800465 char path[PATH_MAX];
466
467 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
468 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700469 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800470 char linkname[PATH_MAX];
471 ssize_t r = readlink(path, linkname, PATH_MAX);
472 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800473 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800474 return;
475 }
476 linkname[r] = '\0';
477
478 if (mount_points.find(linkname) == mount_points.end()) {
479 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700480 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700481 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800482 mount_points.insert(linkname);
483 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800484 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800485 }
486 }
487}
488
489void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700490 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800491 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800492 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700493 for_each_pid(do_mountinfo, nullptr);
494 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800495}
496
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700497static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
498{
499 DIR *d;
500 struct dirent *de;
501 char path[PATH_MAX];
502
503 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700504 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700505 return;
506 }
507
508 while ((de = readdir(d))) {
509 if (de->d_type != DT_LNK) {
510 continue;
511 }
512 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700513 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700514 }
515
516 closedir(d);
517}
518
Mark Salyzyn326842f2015-04-30 09:49:41 -0700519static bool skip_not_stat(const char *path) {
520 static const char stat[] = "/stat";
521 size_t len = strlen(path);
522 if (path[len - 1] == '/') { /* Directory? */
523 return false;
524 }
525 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
526}
527
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700528static bool skip_wtf_strictmode(const char *path) {
529 if (strstr(path, "_wtf")) {
530 return true;
531 } else if (strstr(path, "_strictmode")) {
532 return true;
533 }
534 return false;
535}
536
Felipe Leme4c2d6632016-09-28 14:32:00 -0700537static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800538 return false;
539}
540
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700541unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700542
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800543//
544// stat offsets
545// Name units description
546// ---- ----- -----------
547// read I/Os requests number of read I/Os processed
548#define __STAT_READ_IOS 0
549// read merges requests number of read I/Os merged with in-queue I/O
550#define __STAT_READ_MERGES 1
551// read sectors sectors number of sectors read
552#define __STAT_READ_SECTORS 2
553// read ticks milliseconds total wait time for read requests
554#define __STAT_READ_TICKS 3
555// write I/Os requests number of write I/Os processed
556#define __STAT_WRITE_IOS 4
557// write merges requests number of write I/Os merged with in-queue I/O
558#define __STAT_WRITE_MERGES 5
559// write sectors sectors number of sectors written
560#define __STAT_WRITE_SECTORS 6
561// write ticks milliseconds total wait time for write requests
562#define __STAT_WRITE_TICKS 7
563// in_flight requests number of I/Os currently in flight
564#define __STAT_IN_FLIGHT 8
565// io_ticks milliseconds total time this block device has been active
566#define __STAT_IO_TICKS 9
567// time_in_queue milliseconds total wait time for all requests
568#define __STAT_IN_QUEUE 10
569#define __STAT_NUMBER_FIELD 11
570//
571// read I/Os, write I/Os
572// =====================
573//
574// These values increment when an I/O request completes.
575//
576// read merges, write merges
577// =========================
578//
579// These values increment when an I/O request is merged with an
580// already-queued I/O request.
581//
582// read sectors, write sectors
583// ===========================
584//
585// These values count the number of sectors read from or written to this
586// block device. The "sectors" in question are the standard UNIX 512-byte
587// sectors, not any device- or filesystem-specific block size. The
588// counters are incremented when the I/O completes.
589#define SECTOR_SIZE 512
590//
591// read ticks, write ticks
592// =======================
593//
594// These values count the number of milliseconds that I/O requests have
595// waited on this block device. If there are multiple I/O requests waiting,
596// these values will increase at a rate greater than 1000/second; for
597// example, if 60 read requests wait for an average of 30 ms, the read_ticks
598// field will increase by 60*30 = 1800.
599//
600// in_flight
601// =========
602//
603// This value counts the number of I/O requests that have been issued to
604// the device driver but have not yet completed. It does not include I/O
605// requests that are in the queue but not yet issued to the device driver.
606//
607// io_ticks
608// ========
609//
610// This value counts the number of milliseconds during which the device has
611// had I/O requests queued.
612//
613// time_in_queue
614// =============
615//
616// This value counts the number of milliseconds that I/O requests have waited
617// on this block device. If there are multiple I/O requests waiting, this
618// value will increase as the product of the number of milliseconds times the
619// number of requests waiting (see "read ticks" above for an example).
620#define S_TO_MS 1000
621//
622
Mark Salyzyn326842f2015-04-30 09:49:41 -0700623static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800624 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700625 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700626 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700627 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700628 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700629 getline(&buffer, &i, fp);
630 fclose(fp);
631 if (!buffer) {
632 return -errno;
633 }
634 i = strlen(buffer);
635 while ((i > 0) && (buffer[i - 1] == '\n')) {
636 buffer[--i] = '\0';
637 }
638 if (!*buffer) {
639 free(buffer);
640 return 0;
641 }
642 z = true;
643 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800644 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700645 if (fields[i] != 0) {
646 z = false;
647 }
648 }
649 if (z) { /* never accessed */
650 free(buffer);
651 return 0;
652 }
653
Wei Wang509bb5d2017-06-09 14:42:12 -0700654 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
655 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700656 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700657
658 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
659 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
660 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700661 free(buffer);
662
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800663 if (fields[__STAT_IO_TICKS]) {
664 unsigned long read_perf = 0;
665 unsigned long read_ios = 0;
666 if (fields[__STAT_READ_TICKS]) {
667 unsigned long long divisor = fields[__STAT_READ_TICKS]
668 * fields[__STAT_IO_TICKS];
669 read_perf = ((unsigned long long)SECTOR_SIZE
670 * fields[__STAT_READ_SECTORS]
671 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
672 / divisor;
673 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
674 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
675 / divisor;
676 }
677
678 unsigned long write_perf = 0;
679 unsigned long write_ios = 0;
680 if (fields[__STAT_WRITE_TICKS]) {
681 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
682 * fields[__STAT_IO_TICKS];
683 write_perf = ((unsigned long long)SECTOR_SIZE
684 * fields[__STAT_WRITE_SECTORS]
685 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
686 / divisor;
687 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
688 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
689 / divisor;
690 }
691
692 unsigned queue = (fields[__STAT_IN_QUEUE]
693 + (fields[__STAT_IO_TICKS] >> 1))
694 / fields[__STAT_IO_TICKS];
695
696 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700697 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) q: %u\n", path, read_perf, read_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800698 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700699 printf("%-30s: perf(ios) rd: %luKB/s(%lu/s) wr: %luKB/s(%lu/s) q: %u\n", path, read_perf,
Felipe Lemed8b94e52016-12-08 10:21:44 -0800700 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800701 }
702
703 /* bugreport timeout factor adjustment */
704 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
705 worst_write_perf = write_perf;
706 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700707 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700708 return 0;
709}
710
Yao Chenbe3bbc12018-01-17 16:31:10 -0800711static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
712
Tom Cherryf4472f32020-08-05 09:31:17 -0700713// Returns the actual readable size of the given buffer or -1 on error.
714static long logcat_buffer_readable_size(const std::string& buffer) {
715 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
716 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
717 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
718
719 return android_logger_get_log_readable_size(logger);
720}
721
722// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800723static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
724 unsigned long timeout_ms = 0;
725 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700726 long readable_size = logcat_buffer_readable_size(buffer);
727 if (readable_size > 0) {
728 // Engineering margin is ten-fold our guess.
729 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
730 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800731 }
732 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700733}
734
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800735// Opens a socket and returns its file descriptor.
736static int open_socket(const char* service);
737
Nandana Duttd2f5f082019-01-18 17:13:52 +0000738Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
739}
740
741android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
742 std::lock_guard<std::mutex> lock(lock_);
743 result_ = APPROVED;
744 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800745
746 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
747 // consent is granted.
748 if (ds.options_->is_screenshot_copied) {
749 return android::binder::Status::ok();
750 }
751
752 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
753 !ds.do_early_screenshot_) {
754 return android::binder::Status::ok();
755 }
756
757 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
758 ds.options_->screenshot_fd.get());
759 ds.options_->is_screenshot_copied = copy_succeeded;
760 if (copy_succeeded) {
761 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
762 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000763 return android::binder::Status::ok();
764}
765
766android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
767 std::lock_guard<std::mutex> lock(lock_);
768 result_ = DENIED;
769 MYLOGW("User denied consent to share bugreport\n");
770 return android::binder::Status::ok();
771}
772
773UserConsentResult Dumpstate::ConsentCallback::getResult() {
774 std::lock_guard<std::mutex> lock(lock_);
775 return result_;
776}
777
778uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800779 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000780}
781
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700782void Dumpstate::PrintHeader() const {
Mårten Kongstad60195a72022-09-20 14:14:20 +0200783 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700784 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700785
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700786 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
787 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700788 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
789 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
790 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
Mårten Kongstad60195a72022-09-20 14:14:20 +0200791 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700792 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700793
Felipe Lemed8b94e52016-12-08 10:21:44 -0800794 printf("========================================================\n");
795 printf("== dumpstate: %s\n", date);
796 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700797
Felipe Lemed8b94e52016-12-08 10:21:44 -0800798 printf("\n");
799 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700800 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
802 printf("Bootloader: %s\n", bootloader.c_str());
803 printf("Radio: %s\n", radio.c_str());
804 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100805 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
806 if (module_metadata_version != 0) {
807 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
808 }
Mårten Kongstad60195a72022-09-20 14:14:20 +0200809 printf("Android SDK version: %s\n", sdkversion.c_str());
810 printf("SDK extensions: ");
811 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
812 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700813
Felipe Lemed8b94e52016-12-08 10:21:44 -0800814 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800815 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000817 printf("Bootconfig: ");
818 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800819 printf("Uptime: ");
820 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
821 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800822 printf("Bugreport format version: %s\n", version_.c_str());
Kevin Jeonfa64e642023-07-27 11:36:41 -0400823 printf(
824 "Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d strict_run=%d args=%s "
825 "bugreport_mode=%s\n",
826 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
827 PropertiesHelper::IsStrictRun(), options_->args.c_str(),
828 options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800829 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800830}
831
Felipe Leme24b66ee2016-06-16 10:55:26 -0700832// List of file extensions that can cause a zip file attachment to be rejected by some email
833// service providers.
834static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
835 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
836 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
837 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
838};
839
Vishnu Naire97d6122018-01-18 13:58:56 -0800840status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
841 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700842 std::string valid_name = entry_name;
843
844 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700845 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700846 if (idx != std::string::npos) {
847 std::string extension = entry_name.substr(idx);
848 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
849 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
850 valid_name = entry_name + ".renamed";
851 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
852 }
853 }
854
Felipe Leme6fe9db62016-02-12 09:04:16 -0800855 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
856 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000857 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
858 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700859 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700860 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700861 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700862 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800863 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800864 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000865 bool finished_entry = false;
866 auto finish_entry = [this, &finished_entry] {
867 if (!finished_entry) {
868 // This should only be called when we're going to return an earlier error,
869 // which would've been logged. This may imply the file is already corrupt
870 // and any further logging from FinishEntry is more likely to mislead than
871 // not.
872 this->zip_writer_->FinishEntry();
873 }
874 };
875 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800876 auto start = std::chrono::steady_clock::now();
877 auto end = start + timeout;
878 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800879
Felipe Leme770410d2016-01-26 17:07:14 -0800880 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800881 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800882 if (timeout.count() > 0) {
883 // lambda to recalculate the timeout.
884 auto time_left_ms = [end]() {
885 auto now = std::chrono::steady_clock::now();
886 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
887 return std::max(diff.count(), 0LL);
888 };
889
890 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
891 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000892 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
893 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 return -errno;
895 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000896 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800897 entry_name.c_str(), strerror(errno), timeout.count());
898 return TIMED_OUT;
899 }
900 }
901
Zach Riggle22200402016-08-18 01:01:24 -0400902 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800903 if (bytes_read == 0) {
904 break;
905 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800906 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800907 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800908 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700909 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700911 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800912 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800913 }
914 }
915
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700916 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000917 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700918 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700919 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800920 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921 }
922
Vishnu Naire97d6122018-01-18 13:58:56 -0800923 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800924}
925
Felipe Leme1d486fe2016-10-14 18:06:47 -0700926bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
927 android::base::unique_fd fd(
928 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700929 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800930 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800931 return false;
932 }
933
Vishnu Naire97d6122018-01-18 13:58:56 -0800934 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800935}
936
937/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700938static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800939 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800940}
941
Felipe Leme1d486fe2016-10-14 18:06:47 -0700942void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700943 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800944 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700945 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800946}
947
Felipe Leme1d486fe2016-10-14 18:06:47 -0700948bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800949 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000950 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
951 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700952 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700953 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700954 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800955 return false;
956 }
957
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700958 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700959 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700961 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800962 return false;
963 }
964
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700965 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700966 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700967 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800968 return false;
969 }
970
971 return true;
972}
973
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800974static void DoKmsg() {
975 struct stat st;
976 if (!stat(PSTORE_LAST_KMSG, &st)) {
977 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
978 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
979 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
980 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
981 } else {
982 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
983 DumpFile("LAST KMSG", "/proc/last_kmsg");
984 }
985}
986
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800987static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800988 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800989 RunCommand(
990 "KERNEL LOG",
991 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
992 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
993}
994
Nandana Duttdb379fa2019-10-09 16:54:41 +0100995static void DoSystemLogcat(time_t since) {
996 char since_str[80];
997 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
998
999 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
1000 RunCommand("SYSTEM LOG",
1001 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1002 since_str},
1003 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1004}
1005
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001006static void DoRadioLogcat() {
1007 unsigned long timeout_ms = logcat_timeout({"radio"});
1008 RunCommand(
1009 "RADIO LOG",
1010 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1011 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1012}
1013
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001014static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001015 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001016 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1017 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001018 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001019 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001020 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1021 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001022 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001023 RunCommand(
1024 "EVENT LOG",
1025 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001026 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001027 timeout_ms = logcat_timeout({"stats"});
1028 RunCommand(
1029 "STATS LOG",
1030 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001031 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001032 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001033
1034 RunCommand("LOG STATISTICS", {"logcat", "-b", "all", "-S"});
1035
1036 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001037 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1038 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001039}
1040
Mike Ma5c267872019-08-21 11:31:34 -07001041static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001042 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1043 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1044 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1045 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1046 if (fd < 0) {
1047 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1048 return;
1049 }
Kevin Jeonfa64e642023-07-27 11:36:41 -04001050 RunCommandToFd(fd, "", {"incident", "-u"},
1051 CommandOptions::WithTimeout(PropertiesHelper::IsStrictRun() ? 20 : 120).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001052 bool empty = 0 == lseek(fd, 0, SEEK_END);
1053 if (!empty) {
1054 // Use a different name from "incident.proto"
1055 // /proto/incident.proto is reserved for incident service dump
1056 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001057 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1058 path);
1059 } else {
1060 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001061 }
Mike Ma5c267872019-08-21 11:31:34 -07001062}
1063
Aaron Huanga99452a2022-04-27 18:51:16 +08001064static void DumpNetstatsProto() {
1065 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1066 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1067 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1068 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1069 if (fd < 0) {
1070 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1071 return;
1072 }
1073 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
1074 CommandOptions::WithTimeout(120).Build());
1075 bool empty = 0 == lseek(fd, 0, SEEK_END);
1076 if (!empty) {
1077 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1078 path);
1079 } else {
1080 unlink(path.c_str());
1081 }
1082}
1083
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001084static void MaybeAddSystemTraceToZip() {
1085 // This function copies into the .zip the system trace that was snapshotted
1086 // by the early call to MaybeSnapshotSystemTrace(), if any background
1087 // tracing was happening.
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001088 if (!ds.has_system_trace_) {
1089 // No background trace was happening at the time dumpstate was invoked.
1090 return;
1091 }
1092 ds.AddZipEntry(
1093 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1094 SYSTEM_TRACE_SNAPSHOT);
1095 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1096}
1097
Sunny Goyal35949782019-11-19 15:54:36 -08001098static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001099 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1100 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1101 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1102 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1103 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1104 if (fd < 0) {
1105 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1106 return;
1107 }
1108 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001109 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001110 bool empty = 0 == lseek(fd, 0, SEEK_END);
1111 if (!empty) {
1112 ds.AddZipEntry("visible_windows.zip", path);
1113 } else {
1114 MYLOGW("Failed to dump visible windows\n");
1115 }
1116 unlink(path.c_str());
1117}
1118
Jayachandran Ca94c7172017-06-10 15:08:12 -07001119static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001120 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1121 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001122 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001123 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001124 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1125 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1126 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1127 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001128}
1129
Woody Lin20767a92022-11-29 15:50:24 +08001130static void DumpShutdownCheckpoints() {
1131 const bool shutdown_checkpoints_dumped = AddDumps(
1132 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1133 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1134 if (!shutdown_checkpoints_dumped) {
1135 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1136 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1137 }
1138}
1139
David Andersond9ba4752018-12-11 18:26:59 -08001140static void DumpDynamicPartitionInfo() {
1141 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1142 return;
1143 }
1144
1145 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001146 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001147}
1148
Chris Morin5a50d482022-02-01 17:41:18 -08001149static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001150 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1151 anr_traces_dir.c_str());
1152
1153 // If we're here, dump_traces_path will always be a temporary file
1154 // (created with mkostemp or similar) that contains dumps taken earlier
1155 // on in the process.
1156 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001157 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1158 dump_traces_path);
1159 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001160
1161 const int ret = unlink(dump_traces_path);
1162 if (ret == -1) {
1163 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1164 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001165 }
1166 }
1167
Narayan Kamathbd863722017-06-01 18:50:12 +01001168 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001169 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001170 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001171 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001172 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001173
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001174 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001175 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001176 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001177 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001178 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1179 }
1180}
1181
1182static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001183 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001184
Chris Morin5a50d482022-02-01 17:41:18 -08001185 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001186
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001187 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1188
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001189 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001190 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001191 int i = 0;
1192 while (true) {
1193 const std::string slow_trace_path =
1194 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1195 if (stat(slow_trace_path.c_str(), &st)) {
1196 // No traces file at this index, done with the files.
1197 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001198 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001199 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1200 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001201 }
1202}
1203
Wei Wang509bb5d2017-06-09 14:42:12 -07001204static void DumpBlockStatFiles() {
1205 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001206
Wei Wang1dc1ef52017-06-12 11:28:37 -07001207 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1208
1209 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001210 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1211 return;
1212 }
1213
1214 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001215 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001216 if ((d->d_name[0] == '.')
1217 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1218 || (d->d_name[1] == '\0'))) {
1219 continue;
1220 }
1221 const std::string new_path =
1222 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1223 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1224 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1225 printf("\n");
1226 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001227 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001228}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001229
1230static void DumpPacketStats() {
1231 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001232}
1233
1234static void DumpIpAddrAndRules() {
1235 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
1236 RunCommand("NETWORK INTERFACES", {"ip", "link"});
1237 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1238 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1239 RunCommand("IP RULES", {"ip", "rule", "show"});
1240 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1241}
1242
Nandana Dutt5c390032019-03-12 10:52:56 +00001243static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1244 std::chrono::milliseconds timeout,
1245 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001246 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001247 sp<android::IServiceManager> sm = defaultServiceManager();
1248 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001249 Vector<String16> args;
1250 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001251 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1252 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001253 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001254 std::string path(title);
1255 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001256 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001257 if (PropertiesHelper::IsDryRun()) {
1258 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1259 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1260 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001261 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1262 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001263 service, args);
1264 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001265 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1266 std::chrono::duration<double> elapsed_seconds;
1267 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1268 service == String16("meminfo")) {
1269 // Use a longer timeout for meminfo, since 30s is not always enough.
1270 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1271 /* as_proto = */ false, elapsed_seconds,
1272 bytes_written);
1273 } else {
1274 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1275 /* as_proto = */ false, elapsed_seconds,
1276 bytes_written);
1277 }
1278 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1279 bool dump_complete = (status == OK);
1280 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001281 } else {
1282 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1283 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001284 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001285 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001286
1287 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1288 std::chrono::steady_clock::now() - start);
1289 if (elapsed_duration > timeout) {
1290 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1291 elapsed_duration.count());
1292 break;
1293 }
1294 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001295 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001296}
1297
Vishnu Nair64afc022018-02-01 15:29:34 -08001298static void RunDumpsysText(const std::string& title, int priority,
1299 std::chrono::milliseconds timeout,
1300 std::chrono::milliseconds service_timeout) {
1301 DurationReporter duration_reporter(title);
1302 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1303 fsync(STDOUT_FILENO);
1304 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1305}
1306
1307/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001308static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1309 std::chrono::milliseconds timeout,
1310 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001311 DurationReporter duration_reporter(title);
1312 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1313 fsync(STDOUT_FILENO);
1314 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1315 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001316
1317 RETURN_IF_USER_DENIED_CONSENT();
1318
1319 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1320 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001321}
1322
Nandana Dutt5c390032019-03-12 10:52:56 +00001323static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1324 std::chrono::milliseconds timeout,
1325 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001326 sp<android::IServiceManager> sm = defaultServiceManager();
1327 Dumpsys dumpsys(sm.get());
1328 Vector<String16> args;
1329 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1330 DurationReporter duration_reporter(title);
1331
1332 auto start = std::chrono::steady_clock::now();
1333 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1334 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001335 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001336 std::string path(kProtoPath);
1337 path.append(String8(service).c_str());
1338 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1339 path.append("_CRITICAL");
1340 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1341 path.append("_HIGH");
1342 }
1343 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001344 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001345 if (status == OK) {
1346 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1347 bool dumpTerminated = (status == OK);
1348 dumpsys.stopDumpThread(dumpTerminated);
1349 }
1350 ZipWriter::FileEntry file_entry;
1351 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001352
1353 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1354 std::chrono::steady_clock::now() - start);
1355 if (elapsed_duration > timeout) {
1356 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1357 elapsed_duration.count());
1358 break;
1359 }
1360 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001361 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001362}
1363
Nandana Dutta7db6342018-11-21 14:53:34 +00001364// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001365static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001366 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1367 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001368
1369 RETURN_IF_USER_DENIED_CONSENT();
1370
1371 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1372 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001373}
1374
1375// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001376static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001377 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1378 // high priority. Reduce timeout once they are able to dump in a shorter time or
1379 // moved to a parallel task.
1380 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1381 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001382
1383 RETURN_IF_USER_DENIED_CONSENT();
1384
1385 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1386 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001387}
1388
1389// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001390static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001391 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001392
1393 RETURN_IF_USER_DENIED_CONSENT();
1394
1395 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1396 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001397}
1398
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001399/*
1400 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1401 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1402 * if it's not running in the parallel task.
1403 */
1404static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001405 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001406 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1407 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001408
Steven Moreland44cd9482018-01-04 16:24:13 -08001409 using android::hidl::manager::V1_0::IServiceManager;
1410 using android::hardware::defaultServiceManager;
1411
1412 sp<IServiceManager> sm = defaultServiceManager();
1413 if (sm == nullptr) {
1414 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1415 return;
1416 }
1417
1418 auto ret = sm->list([&](const auto& interfaces) {
1419 for (const std::string& interface : interfaces) {
1420 std::string cleanName = interface;
Steven Morelandc6b1fc22023-07-26 23:53:58 +00001421 std::replace_if(
1422 cleanName.begin(), cleanName.end(),
1423 [](char c) {
1424 return !isalnum(c) && std::string("@-_.").find(c) == std::string::npos;
1425 },
1426 '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001427 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001428
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001429 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001430 {
1431 auto fd = android::base::unique_fd(
1432 TEMP_FAILURE_RETRY(open(path.c_str(),
1433 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1434 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1435 if (fd < 0) {
1436 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1437 continue;
1438 }
1439 RunCommandToFd(fd,
1440 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001441 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001442 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1443
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001444 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001445 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001446 if (!empty) {
1447 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1448 path);
1449 } else {
1450 unlink(path.c_str());
1451 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001452 }
1453 });
1454
1455 if (!ret.isOk()) {
1456 MYLOGE("Could not list hals from hwservicemanager.\n");
1457 }
1458}
1459
Devin Moore8df81bb2022-06-08 22:47:02 +00001460// Dump all of the files that make up the vendor interface.
1461// See the files listed in dumpFileList() for the latest list of files.
1462static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001463
1464 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1465 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001466 for (const auto vintfFile : vintfFiles) {
1467 struct stat st;
1468 if (stat(vintfFile.c_str(), &st) == 0) {
1469 if (S_ISDIR(st.st_mode)) {
1470 ds.AddDir(vintfFile, true /* recursive */);
1471 } else {
1472 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1473 vintfFile);
1474 }
1475 }
1476 }
1477}
1478
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001479static void DumpExternalFragmentationInfo() {
1480 struct stat st;
1481 if (stat("/proc/buddyinfo", &st) != 0) {
1482 MYLOGE("Unable to dump external fragmentation info\n");
1483 return;
1484 }
1485
1486 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1487 std::ifstream ifs("/proc/buddyinfo");
1488 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1489 for (std::string line; std::getline(ifs, line);) {
1490 std::smatch match_results;
1491 if (std::regex_match(line, match_results, unusable_index_regex)) {
1492 std::stringstream free_pages(std::string{match_results[3]});
1493 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1494 std::istream_iterator<int>());
1495
1496 int total_free_pages = 0;
1497 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1498 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1499 }
1500
1501 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1502 match_results[2].str().c_str());
1503
1504 int usable_free_pages = total_free_pages;
1505 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1506 auto unusable_index = (total_free_pages - usable_free_pages) /
1507 static_cast<double>(total_free_pages);
1508 printf(" %5.3f", unusable_index);
1509 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1510 }
1511
1512 printf("\n");
1513 }
1514 }
1515 printf("\n");
1516}
1517
mhasankd451a472020-05-26 18:02:39 -07001518static void DumpstateLimitedOnly() {
1519 // Trimmed-down version of dumpstate to only include a whitelisted
1520 // set of logs (system log, event log, and system server / system app
1521 // crashes, and networking logs). See b/136273873 and b/138459828
1522 // for context.
1523 DurationReporter duration_reporter("DUMPSTATE");
1524 unsigned long timeout_ms;
1525 // calculate timeout
1526 timeout_ms = logcat_timeout({"main", "system", "crash"});
1527 RunCommand("SYSTEM LOG",
1528 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1529 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1530 timeout_ms = logcat_timeout({"events"});
1531 RunCommand(
1532 "EVENT LOG",
1533 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1534 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1535
1536 printf("========================================================\n");
1537 printf("== Networking Service\n");
1538 printf("========================================================\n");
1539
1540 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1541 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001542 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1543 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001544
1545 printf("========================================================\n");
1546 printf("== Dropbox crashes\n");
1547 printf("========================================================\n");
1548
1549 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1550 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1551
1552 printf("========================================================\n");
1553 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1554 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1555 printf("========================================================\n");
1556 printf("== dumpstate: done (id %d)\n", ds.id_);
1557 printf("========================================================\n");
1558}
1559
Rhed Jaoe017f982020-07-21 17:58:41 +08001560/*
1561 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1562 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1563 * if it's not running in the parallel task.
1564 */
1565static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1566 dprintf(out_fd, "========================================================\n");
1567 dprintf(out_fd, "== Checkins\n");
1568 dprintf(out_fd, "========================================================\n");
1569
1570 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001571 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1572 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1573 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1574 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1575}
1576
1577/*
1578 * Runs dumpsys on activity service to dump all application activities, services
1579 * and providers in the device.
1580 *
1581 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1582 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1583 * if it's not running in the parallel task.
1584 */
1585static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1586 dprintf(out_fd, "========================================================\n");
1587 dprintf(out_fd, "== Running Application Activities\n");
1588 dprintf(out_fd, "========================================================\n");
1589
1590 // The following dumpsys internally collects output from running apps, so it can take a long
1591 // time. So let's extend the timeout.
1592
1593 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1594
1595 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1596
1597 dprintf(out_fd, "========================================================\n");
1598 dprintf(out_fd, "== Running Application Services (platform)\n");
1599 dprintf(out_fd, "========================================================\n");
1600
1601 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1602 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1603
1604 dprintf(out_fd, "========================================================\n");
1605 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1606 dprintf(out_fd, "========================================================\n");
1607
1608 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1609 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1610
1611 dprintf(out_fd, "========================================================\n");
1612 dprintf(out_fd, "== Running Application Providers (platform)\n");
1613 dprintf(out_fd, "========================================================\n");
1614
1615 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001616 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001617
1618 dprintf(out_fd, "========================================================\n");
1619 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1620 dprintf(out_fd, "========================================================\n");
1621
1622 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1623 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1624}
1625
Nandana Dutt5c390032019-03-12 10:52:56 +00001626// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1627// via the consent they are shown. Ignores other errors that occur while running various
1628// commands. The consent checking is currently done around long running tasks, which happen to
1629// be distributed fairly evenly throughout the function.
1630static Dumpstate::RunStatus dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001631 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001632
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001633 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huanga99452a2022-04-27 18:51:16 +08001634 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
1635 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001636 if (ds.dump_pool_) {
1637 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
1638 // drop root user. Restarts it with two threads for the parallel run.
1639 ds.dump_pool_->start(/* thread_counts = */2);
1640
Chris Morinbc223142022-02-04 14:17:11 -08001641 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1642 dump_incident_report = ds.dump_pool_->enqueueTask(
1643 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huanga99452a2022-04-27 18:51:16 +08001644 dump_netstats_report = ds.dump_pool_->enqueueTask(
1645 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001646 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1647 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1648 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001649 }
1650
Nandana Dutt5c390032019-03-12 10:52:56 +00001651 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1652 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1653 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001654 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001655 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001656 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001657 DumpFile("MEMORY INFO", "/proc/meminfo");
1658 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001659 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001660
Kevin Jeon947922b2022-09-21 00:29:18 +00001661 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1662 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001663
Sunny Goyal35949782019-11-19 15:54:36 -08001664 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1665
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001666 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1667 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1668 DumpFile("SLAB INFO", "/proc/slabinfo");
1669 DumpFile("ZONEINFO", "/proc/zoneinfo");
1670 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1671 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001672 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001673
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001674 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001675
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001676 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001677 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001678
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001679 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001680 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001681 } else {
1682 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1683 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001684
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001685 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001686 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001687 struct stat s;
1688 if (stat("/proc/modules", &s) != 0) {
1689 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1690 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001691 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001692 RunCommand("MODULES INFO",
1693 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1694 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1695 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001696 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001697
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001698 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001699 DoKernelLogcat();
1700 } else {
1701 do_dmesg();
1702 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001703
Devin Moore8df81bb2022-06-08 22:47:02 +00001704 DumpVintf();
1705
Felipe Lemef0292972016-11-22 13:57:05 -08001706 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001707
Jeff Brown1dc94e32014-09-11 14:15:27 -07001708 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001709 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001710
Jack Yu5a6b2e22020-08-14 18:13:35 +08001711 /* Dump Nfc NCI logs */
1712 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001713
Paul Chang0d2aad72020-02-13 20:04:03 +08001714 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001715 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001716 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001717 }
1718
Felipe Lemee184f662016-10-27 10:04:47 -07001719 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001720
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001721 MaybeAddSystemTraceToZip();
1722
Narayan Kamath8f788292017-05-25 13:20:39 +01001723 // NOTE: tombstones are always added as separate entries in the zip archive
1724 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001725 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001726 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001727 if (!tombstones_dumped) {
1728 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001729 }
1730
Jayachandran Ca94c7172017-06-10 15:08:12 -07001731 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001732
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001733 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001734
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001735 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001736
Woody Lin20767a92022-11-29 15:50:24 +08001737 DumpShutdownCheckpoints();
1738
Jayachandran Ca94c7172017-06-10 15:08:12 -07001739 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001740
1741 dump_route_tables();
1742
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001743 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1744 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1745 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001746
Nandana Dutt5c390032019-03-12 10:52:56 +00001747 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001748
Chiachang Wang668ede42021-05-17 17:14:20 +08001749 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1750 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1751 // dump with priority parameters to dump high priority information.
1752 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1753 CommandOptions::WithTimeout(10).Build());
1754
Elliott Hughes23ccc622017-02-28 10:14:22 -08001755 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001756
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001757 DumpFile("SYSTEM BUILD-TIME RELEASE FLAGS", "/system/etc/build_flags.json");
1758 DumpFile("SYSTEM_EXT BUILD-TIME RELEASE FLAGS", "/system_ext/etc/build_flags.json");
1759 DumpFile("PRODUCT BUILD-TIME RELEASE FLAGS", "/product/etc/build_flags.json");
1760 DumpFile("VENDOR BUILD-TIME RELEASE FLAGS", "/vendor/etc/build_flags.json");
1761
1762 DumpFile("SYSTEM BUILD-TIME ACONFIG FLAGS (check dumpstate build_config for runtime values)",
1763 "/system/etc/aconfig_flags.textproto");
1764 DumpFile("SYSTEM_EXT BUILD-TIME ACONFIG FLAGS (check dumpstate build_config for runtime"
1765 " values)", "/system_ext/etc/aconfig_flags.textproto");
1766 DumpFile("PRODUCT BUILD-TIME ACONFIG FLAGS (check dumpstate build_config for runtime values)",
1767 "/product/etc/aconfig_flags.textproto");
1768 DumpFile("VENDOR BUILD-TIME ACONFIG FLAGS (check dumpstate build_config for runtime values)",
1769 "/vendor/etc/aconfig_flags.textproto");
1770
Jin Qianf334d662017-10-10 14:41:37 -07001771 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001772
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001773 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001774
Colin Crossf45fa6b2012-03-26 12:38:26 -07001775 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001776 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1777 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1778
1779 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1780 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1781 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1782 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1783 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001784
Vishnu Nair36b4cdb2017-11-17 10:27:05 -08001785 /* Add window and surface trace files. */
1786 if (!PropertiesHelper::IsUserBuild()) {
1787 ds.AddDir(WMTRACE_DATA_DIR, false);
1788 }
1789
Yifan Hongd90cc652020-02-08 16:52:02 -08001790 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1791
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001792 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001793 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001794 } else {
1795 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1796 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001797
Steven Moreland7440ddb2016-12-15 16:13:39 -08001798 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001799 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1800 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001801 // su does not exist on user builds, so try running without it.
1802 // This way any implementations of vril-dump that do not require
1803 // root can run on user builds.
1804 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001805 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001806 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001807 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001808 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001809 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001810 }
1811
Felipe Lemed8b94e52016-12-08 10:21:44 -08001812 printf("========================================================\n");
1813 printf("== Android Framework Services\n");
1814 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001815
Nandana Dutt5c390032019-03-12 10:52:56 +00001816 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001817
Jack He91ff2fe2021-02-18 18:23:43 -08001818 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1819 ds.AddDir("/data/misc/bluetooth/logs", true);
1820
Rhed Jaoe017f982020-07-21 17:58:41 +08001821 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001822 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001823 } else {
1824 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1825 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001826
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001827 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001828
Adrian Roos8b397ab2017-04-04 16:35:44 -07001829 printf("========================================================\n");
1830 printf("== Dropbox crashes\n");
1831 printf("========================================================\n");
1832
1833 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1834 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1835
Felipe Lemed8b94e52016-12-08 10:21:44 -08001836 printf("========================================================\n");
1837 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1838 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1839 printf("========================================================\n");
1840 printf("== dumpstate: done (id %d)\n", ds.id_);
1841 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001842
1843 printf("========================================================\n");
1844 printf("== Obtaining statsd metadata\n");
1845 printf("========================================================\n");
1846 // This differs from the usual dumpsys stats, which is the stats report data.
1847 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001848
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001849 // Add linker configuration directory
1850 ds.AddDir(LINKERCONFIG_DIR, true);
1851
Li Li830179f2022-01-04 12:53:29 -08001852 /* Dump frozen cgroupfs */
1853 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001854
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001855 if (ds.dump_pool_) {
Aaron Huanga99452a2022-04-27 18:51:16 +08001856 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1857 } else {
1858 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1859 DumpNetstatsProto);
1860 }
1861
1862 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001863 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001864 } else {
1865 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1866 DumpIncidentReport);
1867 }
Mike Ma5c267872019-08-21 11:31:34 -07001868
Nandana Dutt5c390032019-03-12 10:52:56 +00001869 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001870}
1871
Nandana Dutt5c390032019-03-12 10:52:56 +00001872/*
1873 * Dumps state for the default case; drops root after it's no longer necessary.
1874 *
1875 * Returns RunStatus::OK if everything went fine.
1876 * Returns RunStatus::ERROR if there was an error.
1877 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1878 * with the caller.
1879 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001880Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001881 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1882 // buffer.
1883 DoLogcat();
1884 // Capture timestamp after first logcat to use in next logcat
1885 time_t logcat_ts = time(nullptr);
1886
Nandana Dutt4be45d12018-09-26 15:04:23 +01001887 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001888 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001889 if (dump_pool_) {
1890 RETURN_IF_USER_DENIED_CONSENT();
1891 // One thread is enough since we only need to enqueue DumpTraces here.
1892 dump_pool_->start(/* thread_counts = */1);
1893
1894 // DumpTraces takes long time, post it to the another thread in the
1895 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001896 dump_traces = dump_pool_->enqueueTask(
1897 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001898 } else {
1899 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1900 &dump_traces_path);
1901 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001902
1903 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001904 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001905 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1906 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001907 ds.shutdown_checkpoints_ = GetDumpFds(
1908 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001909 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001910
1911 ds.AddDir(RECOVERY_DIR, true);
1912 ds.AddDir(RECOVERY_DATA_DIR, true);
1913 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001914 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001915 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1916 if (!PropertiesHelper::IsUserBuild()) {
1917 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1918 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001919 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001920 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001921 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001922 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001923 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1924 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1925 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001926 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001927 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001928 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001929 if (!PropertiesHelper::IsUserBuild()) {
1930 // Include dropbox entry files inside ZIP, but exclude
1931 // noisy WTF and StrictMode entries
1932 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1933 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001934
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001935 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001936 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1937
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001938 // Dump IPsec stats. No keys are exposed here.
1939 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1940
Nandana Dutt4be45d12018-09-26 15:04:23 +01001941 // Run ss as root so we can see socket marks.
1942 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1943
1944 // Run iotop as root to show top 100 IO threads
1945 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1946
Erick Reyese68df822019-02-11 14:46:36 -08001947 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001948 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1949 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001950
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001951 DumpFile("PSI cpu", "/proc/pressure/cpu");
1952 DumpFile("PSI memory", "/proc/pressure/memory");
1953 DumpFile("PSI io", "/proc/pressure/io");
1954
Mårten Kongstad60195a72022-09-20 14:14:20 +02001955 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1956 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1957
Rhed Jao5377d792020-07-16 17:37:39 +08001958 if (dump_pool_) {
1959 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001960 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001961
Chris Morinbc223142022-02-04 14:17:11 -08001962 // Current running thread in the pool is the root user also. Delete
1963 // the pool and make a new one later to ensure none of threads in the pool are root.
1964 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001965 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001966 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001967 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001968 }
1969
Nandana Dutt5c390032019-03-12 10:52:56 +00001970 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001971 Dumpstate::RunStatus status = dumpstate();
1972 // Capture logcat since the last time we did it.
1973 DoSystemLogcat(logcat_ts);
1974 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001975}
1976
Rhed Jaob5685b32020-08-14 17:19:17 +08001977// Common states for telephony and wifi which are needed to be collected before
1978// dumpstate drop the root user.
1979static void DumpstateRadioAsRoot() {
1980 DumpIpTablesAsRoot();
1981 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1982}
1983
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001984// This method collects common dumpsys for telephony and wifi. Typically, wifi
1985// reports are fine to include all information, but telephony reports on user
1986// builds need to strip some content (see DumpstateTelephonyOnly).
1987static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001988 // We need to be picky about some stuff for telephony reports on user builds.
1989 if (!include_sensitive_info) {
1990 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
1991 DoRadioLogcat();
1992 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08001993 // DumpHals takes long time, post it to the another thread in the pool,
1994 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08001995 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08001996 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001997 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08001998 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001999 // Contains various system properties and process startup info.
2000 do_dmesg();
2001 // Logs other than the radio buffer may contain package/component names and potential PII.
2002 DoLogcat();
2003 // Too broad for connectivity problems.
2004 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08002005 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
2006 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002007 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08002008 } else {
2009 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
2010 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002011 }
2012
Jayachandran Ca94c7172017-06-10 15:08:12 -07002013 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002014 DumpIpAddrAndRules();
2015 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002016 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2017 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002018}
2019
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002020// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2021// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2022// for what can be included on user builds: all reported information MUST directly relate to
2023// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2024// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2025// names are not), and MUST NOT contain logs of user application traffic.
2026// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002027static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002028 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002029
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002030 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002031
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002032 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002033
Rhed Jaob5685b32020-08-14 17:19:17 +08002034 DumpstateRadioAsRoot();
2035 if (!DropRootUser()) {
2036 return;
2037 }
2038
2039 // Starts thread pool after the root user is dropped, and two additional threads
2040 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002041 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002042 if (ds.dump_pool_) {
2043 ds.dump_pool_->start(/*thread_counts =*/2);
2044
2045 // DumpstateBoard takes long time, post it to the another thread in the pool,
2046 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002047 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2048 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002049 }
2050
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002051 DumpstateRadioCommon(include_sensitive_info);
2052
2053 if (include_sensitive_info) {
2054 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2055 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2056 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2057 // way.
2058 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2059 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002060
2061 printf("========================================================\n");
2062 printf("== Android Framework Services\n");
2063 printf("========================================================\n");
2064
Vishnu Nair652cc802017-11-30 15:18:30 -08002065 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2066 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002067 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2068 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002069 if (include_sensitive_info) {
2070 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2071 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2072 SEC_TO_MSEC(10));
2073 } else {
2074 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2075 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2076 // give a higher timeout as well.
2077 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2078 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2079 }
2080 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002081 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2082 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002083 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002084 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2085 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002086 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2087 SEC_TO_MSEC(10));
Grant Menke9bf3b2b2023-02-24 13:11:07 -08002088 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2089 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002090 if (include_sensitive_info) {
2091 // Contains raw IP addresses, omit from reports on user builds.
2092 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2093 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2094 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2095 SEC_TO_MSEC(10));
2096 // Contains package/component names, omit from reports on user builds.
2097 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2098 SEC_TO_MSEC(10));
2099 // Contains package names, but should be relatively simple to remove them (also contains
2100 // UIDs already), omit from reports on user builds.
2101 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2102 SEC_TO_MSEC(10));
2103 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002104
2105 printf("========================================================\n");
2106 printf("== Running Application Services\n");
2107 printf("========================================================\n");
2108
2109 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2110
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002111 if (include_sensitive_info) {
2112 printf("========================================================\n");
2113 printf("== Running Application Services (non-platform)\n");
2114 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002115
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002116 // Contains package/component names and potential PII, omit from reports on user builds.
2117 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2118 // carrier_config dumpsys instead.
2119 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2120 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002121
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002122 printf("========================================================\n");
2123 printf("== Checkins\n");
2124 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002125
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002126 // Contains package/component names, omit from reports on user builds.
2127 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2128 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002129
2130 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002131 printf("== dumpstate: done (id %d)\n", ds.id_);
2132 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002133
2134 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002135 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002136 } else {
2137 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2138 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002139}
2140
mukesh agrawal253dad42018-01-23 21:59:59 -08002141// This method collects dumpsys for wifi debugging only
2142static void DumpstateWifiOnly() {
2143 DurationReporter duration_reporter("DUMPSTATE");
2144
Rhed Jaob5685b32020-08-14 17:19:17 +08002145 DumpstateRadioAsRoot();
2146 if (!DropRootUser()) {
2147 return;
2148 }
2149
2150 // Starts thread pool after the root user is dropped. Only one additional
2151 // thread is needed for DumpHals in the DumpstateRadioCommon.
2152 if (ds.dump_pool_) {
2153 ds.dump_pool_->start(/*thread_counts =*/1);
2154 }
2155
mukesh agrawal253dad42018-01-23 21:59:59 -08002156 DumpstateRadioCommon();
2157
2158 printf("========================================================\n");
2159 printf("== Android Framework Services\n");
2160 printf("========================================================\n");
2161
2162 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2163 SEC_TO_MSEC(10));
2164 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2165 SEC_TO_MSEC(10));
2166
2167 printf("========================================================\n");
2168 printf("== dumpstate: done (id %d)\n", ds.id_);
2169 printf("========================================================\n");
2170}
2171
Nandana Duttcf419a72019-03-14 10:40:17 +00002172Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002173 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002174 const size_t buf_size = temp_file_pattern.length() + 1;
2175 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2176 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2177
2178 // Create a new, empty file to receive all trace dumps.
2179 //
2180 // TODO: This can be simplified once we remove support for the old style
2181 // dumps. We can have a file descriptor passed in to dump_traces instead
2182 // of creating a file, closing it and then reopening it again.
2183 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2184 if (fd < 0) {
2185 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002186 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002187 }
2188
2189 // Nobody should have access to this temporary file except dumpstate, but we
2190 // temporarily grant 'read' to 'others' here because this file is created
2191 // when tombstoned is still running as root, but dumped after dropping. This
2192 // can go away once support for old style dumping has.
2193 const int chmod_ret = fchmod(fd, 0666);
2194 if (chmod_ret < 0) {
2195 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002196 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002197 }
2198
2199 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2200 if (proc.get() == nullptr) {
2201 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002202 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002203 }
2204
2205 // Number of times process dumping has timed out. If we encounter too many
2206 // failures, we'll give up.
2207 int timeout_failures = 0;
2208 bool dalvik_found = false;
2209
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002210 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002211
2212 struct dirent* d;
2213 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002214 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002215 int pid = atoi(d->d_name);
2216 if (pid <= 0) {
2217 continue;
2218 }
2219
Kevin Jeond0f8a982023-04-07 14:27:11 -04002220 // Skip cached processes.
2221 if (IsCached(pid)) {
2222 // For consistency, the header and footer to this message match those
2223 // dumped by debuggerd in the success case.
2224 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2225 dprintf(fd, "Dump skipped for cached process.\n");
2226 dprintf(fd, "---- end %d ----", pid);
2227 continue;
2228 }
2229
Nandana Duttfaafd522019-03-11 09:23:09 +00002230 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2231 std::string exe;
2232 if (!android::base::Readlink(link_name, &exe)) {
2233 continue;
2234 }
2235
2236 bool is_java_process;
2237 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2238 // Don't bother dumping backtraces for the zygote.
2239 if (IsZygote(pid)) {
2240 continue;
2241 }
2242
2243 dalvik_found = true;
2244 is_java_process = true;
2245 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2246 is_java_process = false;
2247 } else {
2248 // Probably a native process we don't care about, continue.
2249 continue;
2250 }
2251
2252 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2253 if (timeout_failures == 3) {
2254 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2255 break;
2256 }
2257
2258 const uint64_t start = Nanotime();
2259 const int ret = dump_backtrace_to_file_timeout(
Kevin Jeonb8a39362023-04-04 15:00:34 -04002260 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
Nandana Duttfaafd522019-03-11 09:23:09 +00002261
2262 if (ret == -1) {
2263 // For consistency, the header and footer to this message match those
2264 // dumped by debuggerd in the success case.
2265 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2266 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2267 dprintf(fd, "---- end %d ----", pid);
2268 timeout_failures++;
2269 continue;
2270 }
2271
2272 // We've successfully dumped stack traces, reset the failure count
2273 // and write a summary of the elapsed time to the file and continue with the
2274 // next process.
2275 timeout_failures = 0;
2276
2277 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2278 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2279 }
2280
2281 if (!dalvik_found) {
2282 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2283 }
2284
Nandana Duttcf419a72019-03-14 10:40:17 +00002285 *path = file_name_buf.release();
2286 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002287}
2288
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002289static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2290 const Dumpstate::BugreportMode bugreport_mode) {
2291 switch (bugreport_mode) {
2292 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2293 return dumpstate_hal_hidl::DumpstateMode::FULL;
2294 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2295 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2296 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2297 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2298 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2299 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2300 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2301 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2302 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2303 return dumpstate_hal_hidl::DumpstateMode::WIFI;
2304 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2305 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2306 }
2307 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2308}
2309
2310static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2311 const Dumpstate::BugreportMode bugreport_mode) {
2312 switch (bugreport_mode) {
2313 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2314 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2315 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2316 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2317 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2318 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2319 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2320 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2321 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2322 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2323 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2324 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
2325 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2326 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2327 }
2328 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2329}
2330
2331static void DoDumpstateBoardHidl(
2332 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2333 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2334 const Dumpstate::BugreportMode bugreport_mode,
2335 const size_t timeout_sec) {
2336
2337 using ScopedNativeHandle =
2338 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2339 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2340 [](native_handle_t* handle) {
2341 // we don't close file handle's here
2342 // via native_handle_close(handle)
2343 // instead we let dumpstate_fds close the file handles when
2344 // dumpstate_fds gets destroyed
2345 native_handle_delete(handle);
2346 });
2347 if (handle == nullptr) {
2348 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2349 return;
2350 }
2351
2352 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2353 handle.get()->data[i] = dumpstate_fds[i].get();
2354 }
2355
2356 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2357 // implement just 1.0.
2358 const char* descriptor_to_kill;
2359 using DumpstateBoardTask = std::packaged_task<bool()>;
2360 DumpstateBoardTask dumpstate_board_task;
2361 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2362 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2363 if (dumpstate_hal != nullptr) {
2364 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2365
2366 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2367 GetDumpstateHalModeHidl(bugreport_mode);
2368
2369 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2370 dumpstate_board_task =
2371 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2372 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2373 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2374 SEC_TO_MSEC(timeout_sec));
2375 if (!status.isOk()) {
2376 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2377 return false;
2378 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2379 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2380 dumpstate_hal_hidl::toString(status).c_str());
2381 return false;
2382 }
2383 return true;
2384 });
2385 } else {
2386 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2387
2388 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2389 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2390 ::android::hardware::Return<void> status =
2391 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2392 if (!status.isOk()) {
2393 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2394 return false;
2395 }
2396 return true;
2397 });
2398 }
2399 auto result = dumpstate_board_task.get_future();
2400 std::thread(std::move(dumpstate_board_task)).detach();
2401
2402 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2403 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2404 if (!android::base::SetProperty(
2405 "ctl.interface_restart",
2406 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2407 MYLOGE("Couldn't restart dumpstate HAL\n");
2408 }
2409 }
2410 // Wait some time for init to kill dumpstate vendor HAL
2411 constexpr size_t killing_timeout_sec = 10;
2412 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2413 MYLOGE(
2414 "killing dumpstateBoard timed out after %zus, continue and "
2415 "there might be racing in content\n",
2416 killing_timeout_sec);
2417 }
2418}
2419
2420static void DoDumpstateBoardAidl(
2421 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2422 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2423 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2424 MYLOGI("Using IDumpstateDevice AIDL HAL");
2425
2426 const char* descriptor_to_kill;
2427 using DumpstateBoardTask = std::packaged_task<bool()>;
2428 DumpstateBoardTask dumpstate_board_task;
2429 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2430 GetDumpstateHalModeAidl(bugreport_mode);
2431
2432 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2433 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2434 timeout_sec]() -> bool {
2435 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2436
2437 if (!status.isOk()) {
2438 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2439 return false;
2440 }
2441 return true;
2442 });
2443 auto result = dumpstate_board_task.get_future();
2444 std::thread(std::move(dumpstate_board_task)).detach();
2445
2446 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2447 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2448 if (!android::base::SetProperty(
2449 "ctl.interface_restart",
2450 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2451 MYLOGE("Couldn't restart dumpstate HAL\n");
2452 }
2453 }
2454 // Wait some time for init to kill dumpstate vendor HAL
2455 constexpr size_t killing_timeout_sec = 10;
2456 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2457 MYLOGE(
2458 "killing dumpstateBoard timed out after %zus, continue and "
2459 "there might be racing in content\n",
2460 killing_timeout_sec);
2461 }
2462}
2463
2464static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2465 const std::string aidl_instance_name =
2466 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2467
2468 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2469 return nullptr;
2470 }
2471
2472 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2473
2474 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2475}
2476
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002477void Dumpstate::DumpstateBoard(int out_fd) {
2478 dprintf(out_fd, "========================================================\n");
2479 dprintf(out_fd, "== Board\n");
2480 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002481
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002482 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002483 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002484 * set to true and unmount it after invoking dumpstateBoard_* methods.
2485 * This is to enable debug builds to not have debugfs mounted during runtime.
2486 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002487 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002488 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002489 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002490 if (mount_debugfs) {
2491 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2492 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002493 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002494 }
2495
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002496 std::vector<std::string> paths;
2497 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002498 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002499 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2500 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002501 remover.emplace_back(android::base::make_scope_guard(
2502 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002503 }
Jie Song9fbfad02017-06-20 16:29:42 -07002504
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002505 // get dumpstate HAL AIDL implementation
2506 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2507 GetDumpstateBoardAidlService());
2508 if (dumpstate_hal_handle_aidl == nullptr) {
2509 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2510 }
2511
2512 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2513 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2514 if (dumpstate_hal_handle_aidl == nullptr) {
2515 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2516 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2517 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2518 }
2519 }
2520
2521 // if neither HIDL nor AIDL implementation found, then return
2522 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2523 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002524 return;
2525 }
2526
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002527 // this is used to hold the file descriptors and when this variable goes out of scope
2528 // the file descriptors are closed
2529 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002530
Nandana Dutt5c390032019-03-12 10:52:56 +00002531 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002532 for (size_t i = 0; i < paths.size(); i++) {
2533 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2534
2535 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2536 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2537 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2538 if (fd < 0) {
2539 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2540 return;
2541 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002542
2543 dumpstate_fds.emplace_back(fd.release());
2544 // we call fd.release() here to make sure "fd" does not get closed
2545 // after "fd" goes out of scope after this block.
2546 // "fd" will be closed when "dumpstate_fds" goes out of scope
2547 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002548 }
2549
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002550 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2551 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2552 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002553 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002554
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002555 if (dumpstate_hal_handle_aidl != nullptr) {
2556 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2557 timeout_sec);
2558 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2559 // run HIDL HAL only if AIDL HAL not found
2560 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2561 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002562 }
2563
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002564 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002565 auto keep_debugfs_mounted =
2566 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2567 if (keep_debugfs_mounted.empty())
2568 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002569 }
2570
Wei Wang587eac92018-04-05 12:17:20 -07002571 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2572 for (size_t i = 0; i < paths.size(); i++) {
2573 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002574 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2575 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002576 file_sizes[i] = -1;
2577 continue;
2578 }
2579 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002580 }
2581
2582 for (size_t i = 0; i < paths.size(); i++) {
2583 if (file_sizes[i] == -1) {
2584 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002585 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002586 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002587 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002588 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002589 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002590 remover[i].Disable();
2591 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2592 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002593 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002594}
2595
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002596static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002597 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002598 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2599 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002600 " -h: display this help message\n"
2601 " -b: play sound file instead of vibrate, at beginning of job\n"
2602 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002603 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002604 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002605 " -s: write zipped file to control socket (for init)\n"
2606 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002607 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002608 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002609 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002610 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002611 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002612 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002613}
2614
Wei Liuf87959e2016-08-26 14:51:42 -07002615static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002616 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002617}
2618
Felipe Leme1d486fe2016-10-14 18:06:47 -07002619bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002620 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2621 if (zip_entry_tasks_) {
2622 zip_entry_tasks_->run(/* do_cancel = */false);
2623 }
2624
Felipe Leme9a523ae2016-10-20 15:10:33 -07002625 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002626 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002627 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002628 // Final timestamp
2629 char date[80];
2630 time_t the_real_now_please_stand_up = time(nullptr);
2631 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002632 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002633 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002634
Felipe Leme9a523ae2016-10-20 15:10:33 -07002635 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002636 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002637 return false;
2638 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002639 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002640 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002641 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002642 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002643
Felipe Leme0f3fb202016-06-10 17:10:53 -07002644 // Add log file (which contains stderr output) to zip...
2645 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002646 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002647 MYLOGE("Failed to add dumpstate log to .zip file\n");
2648 return false;
2649 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002650 // TODO: Should truncate the existing file.
2651 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002652 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2653 return false;
2654 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002655 fprintf(stderr, "\n");
2656
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002657 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002658 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002659 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002660 return false;
2661 }
2662
Felipe Leme1d486fe2016-10-14 18:06:47 -07002663 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2664 ds.zip_file.reset(nullptr);
2665
Felipe Lemee9d2c542016-11-15 11:48:26 -08002666 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002667 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002668
Felipe Leme1e9edc62015-12-21 16:02:13 -08002669 return true;
2670}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002671
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002672static void SendBroadcast(const std::string& action, const std::vector<std::string>& args) {
2673 // clang-format off
2674 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user", "0",
2675 "--receiver-foreground", "--receiver-include-background", "-a", action};
2676 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002677
2678 am.insert(am.end(), args.begin(), args.end());
2679
Felipe Leme8d2410e2017-02-08 09:46:08 -08002680 RunCommand("", am,
2681 CommandOptions::WithTimeout(20)
2682 .Log("Sending broadcast: '%s'\n")
2683 .Always()
2684 .DropRoot()
2685 .RedirectStderr()
2686 .Build());
2687}
2688
Felipe Leme35b8cf12017-02-10 15:47:29 -08002689static void Vibrate(int duration_ms) {
2690 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002691 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2692 "oneshot", std::to_string(duration_ms)};
2693 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002694 CommandOptions::WithTimeout(10)
2695 .Log("Vibrate: '%s'\n")
2696 .Always()
2697 .Build());
2698 // clang-format on
2699}
2700
Nandana Dutt979388e2018-11-30 16:48:55 +00002701static void MaybeResolveSymlink(std::string* path) {
2702 std::string resolved_path;
2703 if (android::base::Readlink(*path, &resolved_path)) {
2704 *path = resolved_path;
2705 }
2706}
2707
Nandana Dutt4be45d12018-09-26 15:04:23 +01002708/*
2709 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002710 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002711 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002712static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002713 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2714
Nandana Dutt4be45d12018-09-26 15:04:23 +01002715 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2716 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002717 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002718 char date[80];
2719 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2720 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002721
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002722 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002723 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002724 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002725 ds.base_name_ += "-wifi";
2726 }
2727
Paul Chang0d2aad72020-02-13 20:04:03 +08002728 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002729 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002730 }
2731 ds.tmp_path_ = ds.GetPath(".tmp");
2732 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2733
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002734 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002735 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002736 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002737 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002738 "Bugreport dir: [%s] "
2739 "Base name: [%s] "
2740 "Suffix: [%s] "
2741 "Log path: [%s] "
2742 "Temporary path: [%s] "
2743 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002744 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2745 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002746
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002747 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2748 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2749 create_parent_dirs(ds.path_.c_str());
2750 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2751 if (ds.zip_file == nullptr) {
2752 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2753 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002754 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002755 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2756 ds.AddTextZipEntry("version.txt", ds.version_);
2757 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002758}
2759
2760/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002761 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002762 * printing zipped file status, etc.
2763 */
2764static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002765 bool do_text_file = !ds.FinishZipFile();
2766 if (do_text_file) {
2767 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002768 }
mhasank2d75c442020-06-11 15:05:25 -07002769
2770 std::string final_path = ds.path_;
2771 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002772 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002773 android::os::CopyFileToFile(ds.path_, final_path);
2774 }
2775
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002776 if (ds.options_->stream_to_socket) {
2777 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2778 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002779 if (do_text_file) {
2780 dprintf(ds.control_socket_fd_,
2781 "FAIL:could not create zip file, check %s "
2782 "for more details\n",
2783 ds.log_path_.c_str());
2784 } else {
mhasank2d75c442020-06-11 15:05:25 -07002785 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002786 }
2787 }
2788}
2789
Nandana Dutt4be45d12018-09-26 15:04:23 +01002790
Nandana Dutt58d72e22018-11-16 10:30:48 +00002791static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2792 switch (mode) {
2793 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2794 return "BUGREPORT_FULL";
2795 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2796 return "BUGREPORT_INTERACTIVE";
2797 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2798 return "BUGREPORT_REMOTE";
2799 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2800 return "BUGREPORT_WEAR";
2801 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2802 return "BUGREPORT_TELEPHONY";
2803 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2804 return "BUGREPORT_WIFI";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002805 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2806 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002807 }
2808}
2809
Paul Changf59c2b72020-03-10 02:08:55 +08002810static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2811 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002812 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2813 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002814 options->bugreport_mode = mode;
2815 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002816 switch (mode) {
2817 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002818 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002819 break;
2820 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002821 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002822 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002823 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002824 break;
2825 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002826 options->do_vibrate = false;
2827 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002828 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002829 break;
2830 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002831 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002832 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002833 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002834 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002835 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002836 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002837 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002838 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002839 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002840 break;
2841 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002842 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002843 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002844 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002845 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2846 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002847 }
2848}
2849
Nandana Dutt58d72e22018-11-16 10:30:48 +00002850static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002851 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002852 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002853 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002854 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002855 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002856 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002857 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002858 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002859 options.do_progress_updates, options.bugreport_fd.get(),
2860 options.bugreport_mode_string.c_str(),
2861 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002862}
2863
Nandana Dutt54dbd672019-01-11 12:58:05 +00002864void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
2865 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002866 const android::base::unique_fd& screenshot_fd_in,
2867 bool is_screenshot_requested) {
Nandana Dutt54dbd672019-01-11 12:58:05 +00002868 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002869 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2870 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002871
Paul Changf59c2b72020-03-10 02:08:55 +08002872 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002873}
2874
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002875Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2876 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002877 int c;
mhasankd451a472020-05-26 18:02:39 -07002878 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002879 switch (c) {
2880 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002881 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002882 case 's': stream_to_socket = true; break;
2883 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002884 case 'v': show_header_only = true; break;
2885 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002886 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002887 case 'P': do_progress_updates = true; break;
2888 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002889 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002890 case 'V':
2891 case 'd':
2892 case 'z':
2893 // compatibility no-op
2894 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002895 case 'w':
2896 // This was already processed
2897 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002898 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002899 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002900 break;
2901 default:
2902 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002903 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002904 break;
2905 // clang-format on
2906 }
2907 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002908
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002909 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002910 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002911 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002912 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002913 }
2914 }
2915
2916 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2917 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002918
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002919 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002920}
2921
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002922bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002923 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002924 return false;
2925 }
2926
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002927 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002928 return false;
2929 }
2930
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002931 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002932 return false;
2933 }
2934 return true;
2935}
2936
Nandana Dutt197661d2018-11-16 16:40:21 +00002937void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2938 options_ = std::move(options);
2939}
2940
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002941void Dumpstate::Initialize() {
2942 /* gets the sequential id */
2943 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2944 id_ = ++last_id;
2945 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2946}
2947
Nandana Duttd2f5f082019-01-18 17:13:52 +00002948Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2949 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002950 if (listener_ != nullptr) {
2951 switch (status) {
2952 case Dumpstate::RunStatus::OK:
Nandana Duttcc4ead82019-01-23 08:29:23 +00002953 listener_->onFinished();
Nandana Duttbabf6c72019-01-15 14:11:12 +00002954 break;
2955 case Dumpstate::RunStatus::HELP:
2956 break;
2957 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002958 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002959 break;
2960 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00002961 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
2962 break;
2963 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
2964 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
2965 break;
2966 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
2967 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00002968 break;
2969 }
2970 }
2971 return status;
2972}
2973
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002974void Dumpstate::Cancel() {
2975 CleanupTmpFiles();
2976 android::os::UnlinkAndLogOnError(log_path_);
2977 for (int i = 0; i < NUM_OF_DUMPS; i++) {
2978 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
2979 kDumpstateBoardFiles[i]);
2980 }
2981 tombstone_data_.clear();
2982 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08002983 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08002984
2985 // Instead of shutdown the pool, we delete temporary files directly since
2986 // shutdown blocking the call.
2987 if (dump_pool_) {
2988 dump_pool_->deleteTempFiles();
2989 }
2990 if (zip_entry_tasks_) {
2991 zip_entry_tasks_->run(/*do_cancel =*/ true);
2992 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00002993}
2994
Nandana Dutt979388e2018-11-30 16:48:55 +00002995/*
2996 * Dumps relevant information to a bugreport based on the given options.
2997 *
2998 * The bugreport can be dumped to a file or streamed to a socket.
2999 *
3000 * How dumping to file works:
3001 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3002 * stderr is redirected a log file.
3003 *
3004 * The temporary bugreport is then populated via printfs, dumping contents of files and
3005 * output of commands to stdout.
3006 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003007 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003008 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003009 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003010 *
mhasank2d75c442020-06-11 15:05:25 -07003011 * Bugreports are first generated in a local directory and later copied to the caller's fd
3012 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003013 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003014Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3015 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003016 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003017 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003018 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003019 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003020 return RunStatus::INVALID_INPUT;
3021 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003022 /* set as high priority, and protect from OOM killer */
3023 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003024
Felipe Lemed071c682016-10-20 16:48:00 -07003025 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003026 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003027 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003028 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003029 } else {
3030 /* fallback to kernels <= 2.6.35 */
3031 oom_adj = fopen("/proc/self/oom_adj", "we");
3032 if (oom_adj) {
3033 fputs("-17", oom_adj);
3034 fclose(oom_adj);
3035 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003036 }
3037
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003038 if (version_ == VERSION_DEFAULT) {
3039 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003040 }
3041
Chris Morin5a50d482022-02-01 17:41:18 -08003042 if (version_ != VERSION_CURRENT) {
3043 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3044 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003045 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003046 }
3047
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003048 if (options_->show_header_only) {
3049 PrintHeader();
3050 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003051 }
3052
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003053 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3054 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003055
Felipe Leme7447d7c2016-11-03 18:12:22 -07003056 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003057 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003058 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003059 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003060
Sahana Raof35ed432019-07-12 10:47:52 +01003061 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3062 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3063 } else {
3064 // Wake lock will be released automatically on process death
3065 MYLOGD("Wake lock acquired.\n");
3066 }
3067
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003068 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003069
Felipe Lemef0292972016-11-22 13:57:05 -08003070 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003071 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3072 }
3073
Kevin Jeonfa64e642023-07-27 11:36:41 -04003074 if (PropertiesHelper::IsStrictRun()) {
3075 MYLOGI(
3076 "Running on strict-run mode, which has shorter timeouts "
3077 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3078 }
3079
Nandana Dutt235c6672019-11-14 15:22:32 +00003080 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003081 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003082
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003083 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003084
Christopher Ferrised9354f2014-10-01 17:35:01 -07003085 // If we are going to use a socket, do it as early as possible
3086 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003087 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003088 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003089 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003090 if (control_socket_fd_ == -1) {
3091 return ERROR;
3092 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003093 if (options_->progress_updates_to_socket) {
3094 options_->do_progress_updates = 1;
3095 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003096 }
3097
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003098 if (!PrepareToWriteToFile()) {
3099 return ERROR;
3100 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003101
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003102 // Interactive, wear & telephony modes are default to true.
3103 // and may enable from cli option or when using control socket
3104 if (options_->do_progress_updates) {
3105 // clang-format off
3106 std::vector<std::string> am_args = {
3107 "--receiver-permission", "android.permission.DUMP",
3108 };
3109 // clang-format on
3110 // Send STARTED broadcast for apps that listen to bugreport generation events
3111 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED", am_args);
3112 if (options_->progress_updates_to_socket) {
3113 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003114 }
3115 }
3116
Nick Kralevichf3599b32016-01-25 15:05:16 -08003117 /* read /proc/cmdline before dropping root */
3118 FILE *cmdline = fopen("/proc/cmdline", "re");
3119 if (cmdline) {
3120 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3121 fclose(cmdline);
3122 }
3123
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003124 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003125 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003126 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003127
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003128 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003129 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3130 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003131 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003132 }
3133 }
3134
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003135 int dup_stdout_fd;
3136 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003137 // Redirect stderr to log_path_ for debugging.
3138 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3139 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3140 return ERROR;
3141 }
3142 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3143 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3144 strerror(errno));
3145 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003146
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003147 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3148 // moved into zip file later, if zipping.
3149 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3150 // TODO: why not write to a file instead of stdout to overcome this problem?
3151 /* TODO: rather than generating a text file now and zipping it later,
3152 it would be more efficient to redirect stdout to the zip entry
3153 directly, but the libziparchive doesn't support that option yet. */
3154 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3155 return ERROR;
3156 }
3157 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3158 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3159 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003160 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003161
3162 // Don't buffer stdout
3163 setvbuf(stdout, nullptr, _IONBF, 0);
3164
Rhed Jao5377d792020-07-16 17:37:39 +08003165 // Enable the parallel run if the client requests to output to a file.
3166 EnableParallelRunIfNeeded();
3167 // Using scope guard to make sure the dump pool can be shut down correctly.
3168 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3169 ShutdownDumpPool();
3170 });
3171
Felipe Leme608385d2016-02-01 10:35:38 -08003172 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3173 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003174 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003175 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003176
Gavin Corkery6968f552020-11-22 18:09:05 +00003177 bool is_dumpstate_restricted = options_->telephony_only
3178 || options_->wifi_only
3179 || options_->limited_only;
3180 if (!is_dumpstate_restricted) {
Paul Chang0d2aad72020-02-13 20:04:03 +08003181 // Invoke critical dumpsys first to preserve system state, before doing anything else.
Jichao Lie89d9c12019-11-21 19:02:51 -08003182 RunDumpsysCritical();
Gavin Corkery6968f552020-11-22 18:09:05 +00003183 }
3184 MaybeTakeEarlyScreenshot();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003185
3186 if (!is_dumpstate_restricted) {
3187 // Snapshot the system trace now (if running) to avoid that dumpstate's
3188 // own activity pushes out interesting data from the trace ring buffer.
3189 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
3190 MaybeSnapshotSystemTrace();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003191
3192 // If a winscope trace is running, snapshot it now. It will be pulled into bugreport later
3193 // from WMTRACE_DATA_DIR.
3194 MaybeSnapshotWinTrace();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003195 }
Gavin Corkery6968f552020-11-22 18:09:05 +00003196 onUiIntensiveBugreportDumpsFinished(calling_uid);
3197 MaybeCheckUserConsent(calling_uid, calling_package);
3198 if (options_->telephony_only) {
3199 DumpstateTelephonyOnly(calling_package);
3200 } else if (options_->wifi_only) {
3201 DumpstateWifiOnly();
3202 } else if (options_->limited_only) {
3203 DumpstateLimitedOnly();
3204 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003205 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003206 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003207 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003208 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003209 HandleUserConsentDenied();
3210 }
3211 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003212 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003213 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003214
Felipe Leme55b42a62015-11-10 17:39:08 -08003215 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003216 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003217
Abhijeet Kaure370d682019-10-01 16:49:30 +01003218 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003219 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003220 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003221 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003222
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003223 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003224 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Abhijeet Kaure370d682019-10-01 16:49:30 +01003225 if (CalledByApi()) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003226 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003227 if (status != Dumpstate::RunStatus::OK &&
3228 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3229 // Do an early return if there were errors. We make an exception for consent
3230 // timing out because it's possible the user got distracted. In this case the
3231 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003232 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003233 return status;
3234 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003235 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3236 MYLOGI(
3237 "Did not receive user consent yet."
3238 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003239 const String16 incidentcompanion("incidentcompanion");
3240 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3241 if (ics != nullptr) {
3242 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3243 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3244 consent_callback_.get());
3245 } else {
3246 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3247 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003248 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003249 }
3250
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003251 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003252 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003253 for (int i = 0; i < 3; i++) {
3254 Vibrate(75);
3255 usleep((75 + 50) * 1000);
3256 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003257 }
3258
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003259 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3260 progress_->GetInitialMax());
3261 progress_->Save();
3262 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003263
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003264 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003265
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003266 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003267 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003268 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003269 }
3270
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003271 tombstone_data_.clear();
3272 anr_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003273 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003274
Nandana Duttd2f5f082019-01-18 17:13:52 +00003275 return (consent_callback_ != nullptr &&
3276 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3277 ? USER_CONSENT_TIMED_OUT
3278 : RunStatus::OK;
3279}
3280
Paul Chang0d2aad72020-02-13 20:04:03 +08003281void Dumpstate::MaybeTakeEarlyScreenshot() {
3282 if (!options_->do_screenshot || !do_early_screenshot_) {
3283 return;
3284 }
3285
3286 TakeScreenshot();
3287}
3288
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003289void Dumpstate::MaybeSnapshotSystemTrace() {
3290 // If a background system trace is happening and is marked as "suitable for
3291 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3292 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3293 // case that no trace is ongoing, this command is a no-op.
3294 // Note: this should not be enqueued as we need to freeze the trace before
3295 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3296 // the dumpstate's own activity which is irrelevant.
3297 int res = RunCommand(
3298 "SERIALIZE PERFETTO TRACE",
3299 {"perfetto", "--save-for-bugreport"},
3300 CommandOptions::WithTimeout(10)
3301 .DropRoot()
3302 .CloseAllFileDescriptorsOnExec()
3303 .Build());
3304 has_system_trace_ = res == 0;
3305 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3306 // file in the later stages.
3307}
3308
Yohei Yukawa95305b32021-03-09 07:54:27 -08003309void Dumpstate::MaybeSnapshotWinTrace() {
Hongwei Wang9ec5c252023-01-24 15:09:59 -08003310 // Include the proto logging from WMShell.
3311 RunCommand(
3312 // Empty name because it's not intended to be classified as a bugreport section.
3313 // Actual logging files can be found as "/data/misc/wmtrace/shell_log.winscope"
3314 // in the bugreport.
3315 "", {"dumpsys", "activity", "service", "SystemUIService",
3316 "WMShell", "protolog", "save-for-bugreport"},
3317 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3318
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003319 // Currently WindowManagerService and InputMethodManagerSerivice support WinScope protocol.
3320 for (const auto& service : {"window", "input_method"}) {
3321 RunCommand(
3322 // Empty name because it's not intended to be classified as a bugreport section.
3323 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
3324 "", {"cmd", service, "tracing", "save-for-bugreport"},
3325 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3326 }
Yohei Yukawa95305b32021-03-09 07:54:27 -08003327}
3328
Paul Changeb4b4642020-05-28 22:05:47 +08003329void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Paul Changc490e662020-04-11 18:14:09 +08003330 if (calling_uid == AID_SHELL || !CalledByApi()) {
3331 return;
3332 }
3333 if (listener_ != nullptr) {
3334 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3335 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003336 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003337 }
3338}
3339
Jichao Lie89d9c12019-11-21 19:02:51 -08003340void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
3341 if (calling_uid == AID_SHELL || !CalledByApi()) {
3342 // No need to get consent for shell triggered dumpstates, or not through
3343 // bugreporting API (i.e. no fd to copy back).
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003344 return;
3345 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003346 consent_callback_ = new ConsentCallback();
3347 const String16 incidentcompanion("incidentcompanion");
3348 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003349 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003350 if (ics != nullptr) {
3351 MYLOGD("Checking user consent via incidentcompanion service\n");
3352 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Jichao Lie89d9c12019-11-21 19:02:51 -08003353 calling_uid, package, String16(), String16(),
Joe Onorato1c36d752019-03-17 18:26:43 -07003354 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003355 } else {
3356 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3357 }
3358}
3359
Nandana Dutt5c390032019-03-12 10:52:56 +00003360bool Dumpstate::IsUserConsentDenied() const {
3361 return ds.consent_callback_ != nullptr &&
3362 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3363}
3364
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003365bool Dumpstate::CalledByApi() const {
3366 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3367}
3368
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003369void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003370 android::os::UnlinkAndLogOnError(tmp_path_);
3371 android::os::UnlinkAndLogOnError(screenshot_path_);
3372 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003373 if (dump_traces_path != nullptr) {
3374 android::os::UnlinkAndLogOnError(dump_traces_path);
3375 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003376}
3377
Rhed Jao5377d792020-07-16 17:37:39 +08003378void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003379 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003380 return;
3381 }
3382 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003383 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003384}
3385
3386void Dumpstate::ShutdownDumpPool() {
3387 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003388 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003389 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003390 if (zip_entry_tasks_) {
3391 zip_entry_tasks_->run(/* do_cancel = */true);
3392 zip_entry_tasks_ = nullptr;
3393 }
3394}
3395
3396void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3397 const std::string& entry_path) {
3398 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3399 if (!task_cancelled) {
3400 AddZipEntry(entry_name, entry_path);
3401 }
3402 android::os::UnlinkAndLogOnError(entry_path);
3403 };
3404 if (zip_entry_tasks_) {
3405 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3406 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3407 } else {
3408 // Invokes AddZipEntryAndCleanup immediately
3409 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3410 }
Rhed Jao5377d792020-07-16 17:37:39 +08003411}
3412
Nandana Duttd2f5f082019-01-18 17:13:52 +00003413Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3414 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003415 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003416 return USER_CONSENT_DENIED;
3417}
3418
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003419Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003420 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003421 // user consent (unless the caller is Shell).
3422 UserConsentResult consent_result;
3423 if (calling_uid == AID_SHELL) {
3424 consent_result = UserConsentResult::APPROVED;
3425 } else {
3426 consent_result = consent_callback_->getResult();
3427 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003428 if (consent_result == UserConsentResult::UNAVAILABLE) {
3429 // User has not responded yet.
3430 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003431 // Telephony is a fast report type, particularly on user builds where information may be
3432 // more aggressively limited. To give the user time to read the consent dialog, increase the
3433 // timeout.
3434 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3435 : USER_CONSENT_TIMEOUT_MS;
3436 if (elapsed_ms < timeout_ms) {
3437 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003438 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3439 sleep(delay_seconds);
3440 }
3441 consent_result = consent_callback_->getResult();
3442 }
3443 if (consent_result == UserConsentResult::DENIED) {
3444 // User has explicitly denied sharing with the app. To be safe delete the
3445 // internal bugreport & tmp files.
3446 return HandleUserConsentDenied();
3447 }
3448 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003449 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3450 if (copy_succeeded) {
3451 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003452 if (options_->do_screenshot &&
3453 options_->screenshot_fd.get() != -1 &&
3454 !options_->is_screenshot_copied) {
3455 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3456 options_->screenshot_fd.get());
3457 options_->is_screenshot_copied = copy_succeeded;
3458 if (copy_succeeded) {
3459 android::os::UnlinkAndLogOnError(screenshot_path_);
3460 }
3461 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003462 }
3463 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3464 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3465 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3466 // Since we do not have user consent to share the bugreport it does not get
3467 // copied over to the calling app but remains in the internal directory from
3468 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003469 std::string final_path = GetPath(".zip");
3470 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3471 if (copy_succeeded) {
3472 android::os::UnlinkAndLogOnError(path_);
3473 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003474 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3475 }
3476 // Unknown result; must be a programming error.
3477 MYLOGE("Unknown user consent result:%d\n", consent_result);
3478 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003479}
3480
Nandana Duttf02564e2019-02-15 15:24:24 +00003481Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003482 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3483 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3484 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003485 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003486 // When directly running dumpstate binary, the output is not expected to be written
3487 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003488 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003489
3490 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003491 // an app; they are irrelevant here because bugreport is triggered via command line.
3492 // Update Last ID before calling Run().
3493 Initialize();
Nandana Duttf02564e2019-02-15 15:24:24 +00003494 status = Run(-1 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003495 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003496 return status;
3497}
3498
3499/* Main entry point for dumpstate binary. */
3500int run_main(int argc, char* argv[]) {
3501 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003502
3503 switch (status) {
3504 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003505 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003506 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003507 ShowUsage();
3508 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003509 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003510 fprintf(stderr, "Invalid combination of args\n");
3511 ShowUsage();
3512 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003513 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003514 FALLTHROUGH_INTENDED;
3515 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3516 FALLTHROUGH_INTENDED;
3517 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003518 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003519 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003520}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003521
3522// TODO(111441001): Default DumpOptions to sensible values.
3523Dumpstate::Dumpstate(const std::string& version)
3524 : pid_(getpid()),
3525 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003526 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003527 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003528 now_(time(nullptr)),
3529 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003530}
3531
3532Dumpstate& Dumpstate::GetInstance() {
3533 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3534 return singleton_;
3535}
3536
Rhed Jao5377d792020-07-16 17:37:39 +08003537DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3538 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3539 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003540 if (!title_.empty()) {
3541 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003542 if (title_.find("SHOW MAP") == std::string::npos) {
3543 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3544 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003545 }
3546}
3547
3548DurationReporter::~DurationReporter() {
3549 if (!title_.empty()) {
3550 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003551 if (elapsed >= .5f || verbose_) {
3552 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003553 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003554 if (!logcat_only_) {
3555 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003556 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3557 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003558 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003559 if (title_.find("SHOW MAP") == std::string::npos) {
3560 ATRACE_ASYNC_END(title_.c_str(), 0);
3561 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003562 }
3563}
3564
3565const int32_t Progress::kDefaultMax = 5000;
3566
3567Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3568}
3569
3570Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3571 : Progress(initial_max, growth_factor, "") {
3572 progress_ = progress;
3573}
3574
3575Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3576 : initial_max_(initial_max),
3577 progress_(0),
3578 max_(initial_max),
3579 growth_factor_(growth_factor),
3580 n_runs_(0),
3581 average_max_(0),
3582 path_(path) {
3583 if (!path_.empty()) {
3584 Load();
3585 }
3586}
3587
3588void Progress::Load() {
3589 MYLOGD("Loading stats from %s\n", path_.c_str());
3590 std::string content;
3591 if (!android::base::ReadFileToString(path_, &content)) {
3592 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3593 return;
3594 }
3595 if (content.empty()) {
3596 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3597 return;
3598 }
3599 std::vector<std::string> lines = android::base::Split(content, "\n");
3600
3601 if (lines.size() < 1) {
3602 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3603 (int)lines.size(), max_);
3604 return;
3605 }
3606 char* ptr;
3607 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3608 average_max_ = strtol(ptr, nullptr, 10);
3609 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3610 average_max_ > STATS_MAX_AVERAGE) {
3611 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3612 initial_max_ = Progress::kDefaultMax;
3613 } else {
3614 initial_max_ = average_max_;
3615 }
3616 max_ = initial_max_;
3617
3618 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3619}
3620
3621void Progress::Save() {
3622 int32_t total = n_runs_ * average_max_ + progress_;
3623 int32_t runs = n_runs_ + 1;
3624 int32_t average = floor(((float)total) / runs);
3625 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3626 path_.c_str());
3627 if (path_.empty()) {
3628 return;
3629 }
3630
3631 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3632 if (!android::base::WriteStringToFile(content, path_)) {
3633 MYLOGE("Could not save stats on %s\n", path_.c_str());
3634 }
3635}
3636
3637int32_t Progress::Get() const {
3638 return progress_;
3639}
3640
3641bool Progress::Inc(int32_t delta_sec) {
3642 bool changed = false;
3643 if (delta_sec >= 0) {
3644 progress_ += delta_sec;
3645 if (progress_ > max_) {
3646 int32_t old_max = max_;
3647 max_ = floor((float)progress_ * growth_factor_);
3648 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3649 changed = true;
3650 }
3651 }
3652 return changed;
3653}
3654
3655int32_t Progress::GetMax() const {
3656 return max_;
3657}
3658
3659int32_t Progress::GetInitialMax() const {
3660 return initial_max_;
3661}
3662
3663void Progress::Dump(int fd, const std::string& prefix) const {
3664 const char* pr = prefix.c_str();
3665 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3666 dprintf(fd, "%smax: %d\n", pr, max_);
3667 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3668 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3669 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3670 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3671 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3672}
3673
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003674std::string Dumpstate::GetPath(const std::string& suffix) const {
3675 return GetPath(bugreport_internal_dir_, suffix);
3676}
3677
3678std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3679 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3680 name_.c_str(), suffix.c_str());
3681}
3682
3683void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3684 progress_ = std::move(progress);
3685}
3686
3687void for_each_userid(void (*func)(int), const char *header) {
3688 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3689 "for_each_userid(%s)", header);
3690 DurationReporter duration_reporter(title);
3691 if (PropertiesHelper::IsDryRun()) return;
3692
3693 DIR *d;
3694 struct dirent *de;
3695
3696 if (header) printf("\n------ %s ------\n", header);
3697 func(0);
3698
3699 if (!(d = opendir("/data/system/users"))) {
3700 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3701 return;
3702 }
3703
3704 while ((de = readdir(d))) {
3705 int userid;
3706 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3707 continue;
3708 }
3709 func(userid);
3710 }
3711
3712 closedir(d);
3713}
3714
3715static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3716 DIR *d;
3717 struct dirent *de;
3718
3719 if (!(d = opendir("/proc"))) {
3720 printf("Failed to open /proc (%s)\n", strerror(errno));
3721 return;
3722 }
3723
3724 if (header) printf("\n------ %s ------\n", header);
3725 while ((de = readdir(d))) {
3726 if (ds.IsUserConsentDenied()) {
3727 MYLOGE(
3728 "Returning early because user denied consent to share bugreport with calling app.");
3729 closedir(d);
3730 return;
3731 }
3732 int pid;
3733 int fd;
3734 char cmdpath[255];
3735 char cmdline[255];
3736
3737 if (!(pid = atoi(de->d_name))) {
3738 continue;
3739 }
3740
3741 memset(cmdline, 0, sizeof(cmdline));
3742
3743 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3744 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3745 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3746 close(fd);
3747 if (cmdline[0]) {
3748 helper(pid, cmdline, arg);
3749 continue;
3750 }
3751 }
3752
3753 // if no cmdline, a kernel thread has comm
3754 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3755 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3756 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3757 close(fd);
3758 if (cmdline[1]) {
3759 cmdline[0] = '[';
3760 size_t len = strcspn(cmdline, "\f\b\r\n");
3761 cmdline[len] = ']';
3762 cmdline[len+1] = '\0';
3763 }
3764 }
3765 if (!cmdline[0]) {
3766 strcpy(cmdline, "N/A");
3767 }
3768 helper(pid, cmdline, arg);
3769 }
3770
3771 closedir(d);
3772}
3773
3774static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3775 for_each_pid_func *func = (for_each_pid_func*) arg;
3776 func(pid, cmdline);
3777}
3778
3779void for_each_pid(for_each_pid_func func, const char *header) {
3780 std::string title = header == nullptr ? "for_each_pid"
3781 : android::base::StringPrintf("for_each_pid(%s)", header);
3782 DurationReporter duration_reporter(title);
3783 if (PropertiesHelper::IsDryRun()) return;
3784
3785 __for_each_pid(for_each_pid_helper, header, (void *) func);
3786}
3787
3788static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3789 DIR *d;
3790 struct dirent *de;
3791 char taskpath[255];
3792 for_each_tid_func *func = (for_each_tid_func *) arg;
3793
3794 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3795
3796 if (!(d = opendir(taskpath))) {
3797 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3798 return;
3799 }
3800
3801 func(pid, pid, cmdline);
3802
3803 while ((de = readdir(d))) {
3804 if (ds.IsUserConsentDenied()) {
3805 MYLOGE(
3806 "Returning early because user denied consent to share bugreport with calling app.");
3807 closedir(d);
3808 return;
3809 }
3810 int tid;
3811 int fd;
3812 char commpath[255];
3813 char comm[255];
3814
3815 if (!(tid = atoi(de->d_name))) {
3816 continue;
3817 }
3818
3819 if (tid == pid)
3820 continue;
3821
3822 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
3823 memset(comm, 0, sizeof(comm));
3824 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
3825 strcpy(comm, "N/A");
3826 } else {
3827 char *c;
3828 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
3829 close(fd);
3830
3831 c = strrchr(comm, '\n');
3832 if (c) {
3833 *c = '\0';
3834 }
3835 }
3836 func(pid, tid, comm);
3837 }
3838
3839 closedir(d);
3840}
3841
3842void for_each_tid(for_each_tid_func func, const char *header) {
3843 std::string title = header == nullptr ? "for_each_tid"
3844 : android::base::StringPrintf("for_each_tid(%s)", header);
3845 DurationReporter duration_reporter(title);
3846
3847 if (PropertiesHelper::IsDryRun()) return;
3848
3849 __for_each_pid(for_each_tid_helper, header, (void *) func);
3850}
3851
3852void show_wchan(int pid, int tid, const char *name) {
3853 if (PropertiesHelper::IsDryRun()) return;
3854
3855 char path[255];
3856 char buffer[255];
3857 int fd, ret, save_errno;
3858 char name_buffer[255];
3859
3860 memset(buffer, 0, sizeof(buffer));
3861
3862 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
3863 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3864 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3865 return;
3866 }
3867
3868 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3869 save_errno = errno;
3870 close(fd);
3871
3872 if (ret < 0) {
3873 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3874 return;
3875 }
3876
3877 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
3878 pid == tid ? 0 : 3, "", name);
3879
3880 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
3881
3882 return;
3883}
3884
3885// print time in centiseconds
3886static void snprcent(char *buffer, size_t len, size_t spc,
3887 unsigned long long time) {
3888 static long hz; // cache discovered hz
3889
3890 if (hz <= 0) {
3891 hz = sysconf(_SC_CLK_TCK);
3892 if (hz <= 0) {
3893 hz = 1000;
3894 }
3895 }
3896
3897 // convert to centiseconds
3898 time = (time * 100 + (hz / 2)) / hz;
3899
3900 char str[16];
3901
3902 snprintf(str, sizeof(str), " %llu.%02u",
3903 time / 100, (unsigned)(time % 100));
3904 size_t offset = strlen(buffer);
3905 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3906 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3907}
3908
3909// print permille as a percent
3910static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
3911 char str[16];
3912
3913 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
3914 size_t offset = strlen(buffer);
3915 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
3916 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
3917}
3918
3919void show_showtime(int pid, const char *name) {
3920 if (PropertiesHelper::IsDryRun()) return;
3921
3922 char path[255];
3923 char buffer[1023];
3924 int fd, ret, save_errno;
3925
3926 memset(buffer, 0, sizeof(buffer));
3927
3928 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
3929 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
3930 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
3931 return;
3932 }
3933
3934 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
3935 save_errno = errno;
3936 close(fd);
3937
3938 if (ret < 0) {
3939 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
3940 return;
3941 }
3942
3943 // field 14 is utime
3944 // field 15 is stime
3945 // field 42 is iotime
3946 unsigned long long utime = 0, stime = 0, iotime = 0;
3947 if (sscanf(buffer,
3948 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
3949 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
3950 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
3951 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
3952 &utime, &stime, &iotime) != 3) {
3953 return;
3954 }
3955
3956 unsigned long long total = utime + stime;
3957 if (!total) {
3958 return;
3959 }
3960
3961 unsigned permille = (iotime * 1000 + (total / 2)) / total;
3962 if (permille > 1000) {
3963 permille = 1000;
3964 }
3965
3966 // try to beautify and stabilize columns at <80 characters
3967 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
3968 if ((name[0] != '[') || utime) {
3969 snprcent(buffer, sizeof(buffer), 57, utime);
3970 }
3971 snprcent(buffer, sizeof(buffer), 65, stime);
3972 if ((name[0] != '[') || iotime) {
3973 snprcent(buffer, sizeof(buffer), 73, iotime);
3974 }
3975 if (iotime) {
3976 snprdec(buffer, sizeof(buffer), 79, permille);
3977 }
3978 puts(buffer); // adds a trailing newline
3979
3980 return;
3981}
3982
3983void do_dmesg() {
3984 const char *title = "KERNEL LOG (dmesg)";
3985 DurationReporter duration_reporter(title);
3986 printf("------ %s ------\n", title);
3987
3988 if (PropertiesHelper::IsDryRun()) return;
3989
3990 /* Get size of kernel buffer */
3991 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
3992 if (size <= 0) {
3993 printf("Unexpected klogctl return value: %d\n\n", size);
3994 return;
3995 }
3996 char *buf = (char *) malloc(size + 1);
3997 if (buf == nullptr) {
3998 printf("memory allocation failed\n\n");
3999 return;
4000 }
4001 int retval = klogctl(KLOG_READ_ALL, buf, size);
4002 if (retval < 0) {
4003 printf("klogctl failure\n\n");
4004 free(buf);
4005 return;
4006 }
4007 buf[retval] = '\0';
4008 printf("%s\n\n", buf);
4009 free(buf);
4010 return;
4011}
4012
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004013int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4014 DurationReporter duration_reporter(title);
4015
4016 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4017
4018 UpdateProgress(WEIGHT_FILE);
4019
4020 return status;
4021}
4022
4023int read_file_as_long(const char *path, long int *output) {
4024 int fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC));
4025 if (fd < 0) {
4026 int err = errno;
4027 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4028 return -1;
4029 }
4030 char buffer[50];
4031 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4032 if (bytes_read == -1) {
4033 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4034 return -2;
4035 }
4036 if (bytes_read == 0) {
4037 MYLOGE("File %s is empty\n", path);
4038 return -3;
4039 }
4040 *output = atoi(buffer);
4041 return 0;
4042}
4043
4044/* calls skip to gate calling dump_from_fd recursively
4045 * in the specified directory. dump_from_fd defaults to
4046 * dump_file_from_fd above when set to NULL. skip defaults
4047 * to false when set to NULL. dump_from_fd will always be
4048 * called with title NULL.
4049 */
4050int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4051 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4052 DurationReporter duration_reporter(title);
4053 DIR *dirp;
4054 struct dirent *d;
4055 char *newpath = nullptr;
4056 const char *slash = "/";
4057 int retval = 0;
4058
4059 if (!title.empty()) {
4060 printf("------ %s (%s) ------\n", title.c_str(), dir);
4061 }
4062 if (PropertiesHelper::IsDryRun()) return 0;
4063
4064 if (dir[strlen(dir) - 1] == '/') {
4065 ++slash;
4066 }
4067 dirp = opendir(dir);
4068 if (dirp == nullptr) {
4069 retval = -errno;
4070 MYLOGE("%s: %s\n", dir, strerror(errno));
4071 return retval;
4072 }
4073
4074 if (!dump_from_fd) {
4075 dump_from_fd = dump_file_from_fd;
4076 }
4077 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4078 if ((d->d_name[0] == '.')
4079 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4080 || (d->d_name[1] == '\0'))) {
4081 continue;
4082 }
4083 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4084 (d->d_type == DT_DIR) ? "/" : "");
4085 if (!newpath) {
4086 retval = -errno;
4087 continue;
4088 }
4089 if (skip && (*skip)(newpath)) {
4090 continue;
4091 }
4092 if (d->d_type == DT_DIR) {
4093 int ret = dump_files("", newpath, skip, dump_from_fd);
4094 if (ret < 0) {
4095 retval = ret;
4096 }
4097 continue;
4098 }
4099 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4100 if (fd.get() < 0) {
4101 retval = -1;
4102 printf("*** %s: %s\n", newpath, strerror(errno));
4103 continue;
4104 }
4105 (*dump_from_fd)(nullptr, newpath, fd.get());
4106 }
4107 closedir(dirp);
4108 if (!title.empty()) {
4109 printf("\n");
4110 }
4111 return retval;
4112}
4113
4114/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4115 * it's possible to avoid issues where opening the file itself can get
4116 * stuck.
4117 */
4118int dump_file_from_fd(const char *title, const char *path, int fd) {
4119 if (PropertiesHelper::IsDryRun()) return 0;
4120
4121 int flags = fcntl(fd, F_GETFL);
4122 if (flags == -1) {
4123 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4124 return -1;
4125 } else if (!(flags & O_NONBLOCK)) {
4126 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4127 return -1;
4128 }
4129 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4130}
4131
4132int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004133 const CommandOptions& options, bool verbose_duration, int out_fd) {
4134 DurationReporter duration_reporter(title, false /* logcat_only */,
4135 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004136
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004137 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004138
4139 /* TODO: for now we're simplifying the progress calculation by using the
4140 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4141 * where its weight should be much higher proportionally to its timeout.
4142 * Ideally, it should use a options.EstimatedDuration() instead...*/
4143 UpdateProgress(options.Timeout());
4144
4145 return status;
4146}
4147
4148void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004149 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004150 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4151 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4152 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004153 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004154}
4155
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004156static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004157 int s = android_get_control_socket(service);
4158 if (s < 0) {
4159 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4160 return -1;
4161 }
4162 fcntl(s, F_SETFD, FD_CLOEXEC);
4163
4164 // Set backlog to 0 to make sure that queue size will be minimum.
4165 // In Linux, because the minimum queue will be 1, connect() will be blocked
4166 // if the other clients already called connect() and the connection request was not accepted.
4167 if (listen(s, 0) < 0) {
4168 MYLOGE("listen(control socket): %s\n", strerror(errno));
4169 return -1;
4170 }
4171
4172 struct sockaddr addr;
4173 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004174 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004175
4176 // Close socket just after accept(), to make sure that connect() by client will get error
4177 // when the socket is used by the other services.
4178 // There is still a race condition possibility between accept and close, but there is no way
4179 // to close-on-accept atomically.
4180 // See detail; b/123306389#comment25
4181 close(s);
4182
4183 if (fd < 0) {
4184 MYLOGE("accept(control socket): %s\n", strerror(errno));
4185 return -1;
4186 }
4187
4188 return fd;
4189}
4190
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004191// TODO: should call is_valid_output_file and/or be merged into it.
4192void create_parent_dirs(const char *path) {
4193 char *chp = const_cast<char *> (path);
4194
4195 /* skip initial slash */
4196 if (chp[0] == '/')
4197 chp++;
4198
4199 /* create leading directories, if necessary */
4200 struct stat dir_stat;
4201 while (chp && chp[0]) {
4202 chp = strchr(chp, '/');
4203 if (chp) {
4204 *chp = 0;
4205 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4206 MYLOGI("Creating directory %s\n", path);
4207 if (mkdir(path, 0770)) { /* drwxrwx--- */
4208 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4209 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4210 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4211 }
4212 }
4213 *chp++ = '/';
4214 }
4215 }
4216}
4217
4218bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4219 create_parent_dirs(path);
4220
4221 int fd = TEMP_FAILURE_RETRY(open(path,
4222 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4223 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4224 if (fd < 0) {
4225 MYLOGE("%s: %s\n", path, strerror(errno));
4226 return false;
4227 }
4228
4229 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4230 close(fd);
4231 return true;
4232}
4233
4234bool redirect_to_file(FILE* redirect, char* path) {
4235 return _redirect_to_file(redirect, path, O_TRUNC);
4236}
4237
4238bool redirect_to_existing_file(FILE* redirect, char* path) {
4239 return _redirect_to_file(redirect, path, O_APPEND);
4240}
4241
4242void dump_route_tables() {
4243 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4244 if (PropertiesHelper::IsDryRun()) return;
4245 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4246 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4247 FILE* fp = fopen(RT_TABLES_PATH, "re");
4248 if (!fp) {
4249 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4250 return;
4251 }
4252 char table[16];
4253 // Each line has an integer (the table number), a space, and a string (the table name). We only
4254 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4255 // Add a fixed max limit so this doesn't go awry.
4256 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4257 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4258 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4259 }
4260 fclose(fp);
4261}
4262
Li Li830179f2022-01-04 12:53:29 -08004263void dump_frozen_cgroupfs(const char *dir, int level,
4264 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4265 DIR *dirp;
4266 struct dirent *d;
4267 char *newpath = nullptr;
4268
4269 dirp = opendir(dir);
4270 if (dirp == nullptr) {
4271 MYLOGE("%s: %s\n", dir, strerror(errno));
4272 return;
4273 }
4274
4275 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4276 if ((d->d_name[0] == '.')
4277 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4278 || (d->d_name[1] == '\0'))) {
4279 continue;
4280 }
4281 if (d->d_type == DT_DIR) {
4282 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4283 if (!newpath) {
4284 continue;
4285 }
4286 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4287 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4288 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4289 char *freezer = nullptr;
4290 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4291 if (freezer) {
4292 FILE* fp = fopen(freezer, "r");
4293 if (fp != NULL) {
4294 int frozen;
4295 fscanf(fp, "%d", &frozen);
4296 if (frozen > 0) {
4297 dump_files("", newpath, skip_none, dump_from_fd);
4298 }
4299 fclose(fp);
4300 }
4301 free(freezer);
4302 }
4303 }
4304 }
4305 }
4306 closedir(dirp);
4307}
4308
4309void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004310 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4311 DurationReporter duration_reporter("FROZEN CGROUPFS");
4312 if (PropertiesHelper::IsDryRun()) return;
4313 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4314}
4315
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004316void Dumpstate::UpdateProgress(int32_t delta_sec) {
4317 if (progress_ == nullptr) {
4318 MYLOGE("UpdateProgress: progress_ not set\n");
4319 return;
4320 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004321 // This function updates progress related members of the dumpstate and reports
4322 // progress percentage to the bugreport client. Since it could be called by
4323 // different dump tasks at the same time if the parallel run is enabled, a
4324 // mutex lock is necessary here to synchronize the call.
4325 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004326
4327 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004328 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004329
4330 // ...but only notifiy listeners when necessary.
4331 if (!options_->do_progress_updates) return;
4332
4333 int progress = progress_->Get();
4334 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004335 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004336
Nandana Dutt402a8392019-06-14 14:25:13 +01004337 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004338 return;
4339 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004340 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004341
4342 if (control_socket_fd_ >= 0) {
4343 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4344 fsync(control_socket_fd_);
4345 }
4346
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004347 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004348 if (percent % 10 == 0) {
4349 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004350 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004351 } else {
4352 // stderr is ignored on normal invocations, but useful when calling
4353 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004354 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004355 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004356
4357 listener_->onProgress(percent);
4358 }
4359}
4360
4361void Dumpstate::TakeScreenshot(const std::string& path) {
4362 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4363 int status =
4364 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4365 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4366 if (status == 0) {
4367 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4368 } else {
4369 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4370 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004371 if (listener_ != nullptr) {
4372 // Show a visual indication to indicate screenshot is taken via
4373 // IDumpstateListener.onScreenshotTaken()
4374 listener_->onScreenshotTaken(status == 0);
4375 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004376}
4377
4378bool is_dir(const char* pathname) {
4379 struct stat info;
4380 if (stat(pathname, &info) == -1) {
4381 return false;
4382 }
4383 return S_ISDIR(info.st_mode);
4384}
4385
4386time_t get_mtime(int fd, time_t default_mtime) {
4387 struct stat info;
4388 if (fstat(fd, &info) == -1) {
4389 return default_mtime;
4390 }
4391 return info.st_mtime;
4392}