blob: 47586071223efd8a728c9e70b3473c5507e8fa1c [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
Pablo Gamito654831c2024-02-16 16:47:48 +000020#include "dumpstate.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070021
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000022#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070023#include <android-base/file.h>
24#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070025#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080026#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070027#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070028#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000029#include <android/binder_manager.h>
30#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010031#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080032#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080033#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
34#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080035#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000036#include <android/os/IIncidentCompanion.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000037#include <android_app_admin_flags.h>
38#include <android_tracing.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010039#include <binder/IServiceManager.h>
Nikhil Kumar28ce35e2023-01-10 14:32:44 +000040#include <cutils/multiuser.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080041#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070042#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010043#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000044#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000045#include <debuggerd/client.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000046#include <dirent.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080047#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000048#include <dumputils/dump_utils.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000049#include <errno.h>
50#include <fcntl.h>
Sahana Raof35ed432019-07-12 10:47:52 +010051#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080052#include <hidl/ServiceManagement.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000053#include <inttypes.h>
54#include <libgen.h>
55#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010056#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070057#include <log/log_read.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000058#include <math.h>
Felipe Leme75876a22016-10-27 16:31:27 -070059#include <openssl/sha.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000060#include <poll.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070061#include <private/android_filesystem_config.h>
62#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080063#include <serviceutils/PriorityDumper.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000064#include <signal.h>
65#include <stdarg.h>
66#include <stdbool.h>
67#include <stdio.h>
68#include <stdlib.h>
69#include <string.h>
70#include <sys/capability.h>
71#include <sys/inotify.h>
72#include <sys/klog.h>
73#include <sys/mount.h>
74#include <sys/poll.h>
75#include <sys/prctl.h>
76#include <sys/resource.h>
77#include <sys/stat.h>
78#include <sys/time.h>
79#include <sys/wait.h>
80#include <time.h>
81#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070082#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000083#include <vintf/VintfObject.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000084
85#include <chrono>
86#include <cmath>
87#include <fstream>
88#include <functional>
89#include <future>
90#include <memory>
91#include <numeric>
92#include <regex>
93#include <set>
94#include <string>
95#include <utility>
96#include <vector>
97
Felipe Lemef0292972016-11-22 13:57:05 -080098#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070099#include "DumpstateService.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -0800100
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000101namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
102namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
103namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
104
Vishnu Naire97d6122018-01-18 13:58:56 -0800105using ::std::literals::chrono_literals::operator""ms;
106using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800107using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800108
Felipe Leme47e9be22016-12-21 15:37:07 -0800109// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800110using android::defaultServiceManager;
111using android::Dumpsys;
112using android::INVALID_OPERATION;
113using android::IServiceManager;
114using android::OK;
115using android::sp;
116using android::status_t;
117using android::String16;
118using android::String8;
119using android::TIMED_OUT;
120using android::UNKNOWN_ERROR;
121using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000122using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000123using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800124using android::os::dumpstate::CommandOptions;
125using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800126using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800127using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800128using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800129using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800130
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100131// Keep in sync with
132// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
133static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
134
135/* Most simple commands have 10 as timeout, so 5 is a good estimate */
136static const int32_t WEIGHT_FILE = 5;
137
138// TODO: temporary variables and functions used during C++ refactoring
139static Dumpstate& ds = Dumpstate::GetInstance();
140static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100141 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800142 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
143 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100144}
145
146// Reasonable value for max stats.
147static const int STATS_MAX_N_RUNS = 1000;
148static const long STATS_MAX_AVERAGE = 100000;
149
150CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
151
Nandana Duttd2f5f082019-01-18 17:13:52 +0000152typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
153
Colin Crossf45fa6b2012-03-26 12:38:26 -0700154/* read before root is shed */
155static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700156static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000157static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800158// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
159// it's often the case that they time out far too quickly for consent with such a hefty dialog for
160// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
161// roughly match full reports' durations.
162static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700163
Felipe Leme1d486fe2016-10-14 18:06:47 -0700164// TODO: variables and functions below should be part of dumpstate object
165
Felipe Leme635ca312016-01-05 14:23:02 -0800166static std::set<std::string> mount_points;
167void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800168
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700170#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700171#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800172
Ted Bauerf6d61b82024-09-13 19:57:19 +0000173#define AFLAGS "/system/bin/aflags"
Felipe Lemee82a27d2016-01-05 13:35:44 -0800174#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700175#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700176#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700177#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700178#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800179#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100180#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
181#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800182#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Steven Moreland9379c462023-12-21 02:04:27 +0000183#define KERNEL_CONFIG "/proc/config.gz"
Erik Kline08165202016-05-30 11:55:44 +0900184#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800185#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700186#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800187#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900188#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700189#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000190#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700191#define CGROUPFS_DIR "/sys/fs/cgroup"
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200192#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700193#define DROPBOX_DIR "/data/system/dropbox"
MÃ¥rten Kongstad5ad813f2023-09-28 10:09:18 +0200194#define PRINT_FLAGS "/system/bin/printflags"
Nattharat Jariyanuntanaetb250cae2024-05-15 07:48:19 +0000195#define UWB_LOG_DIR "/data/misc/apexdata/com.android.uwb/log"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700196
Narayan Kamath8f788292017-05-25 13:20:39 +0100197// TODO(narayan): Since this information has to be kept in sync
198// with tombstoned, we should just put it in a common header.
199//
200// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100201static const std::string TOMBSTONE_DIR = "/data/tombstones/";
202static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
203static const std::string ANR_DIR = "/data/anr/";
204static const std::string ANR_FILE_PREFIX = "anr_";
Andy Hungd62f7e62024-01-11 15:47:52 -0800205static const std::string ANR_TRACE_FILE_PREFIX = "trace_";
Woody Lin20767a92022-11-29 15:50:24 +0800206static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
207static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700208
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +0000209// File path to default screenshot image, that used when failed to capture the real screenshot.
210static const std::string DEFAULT_SCREENSHOT_PATH = "/system/etc/default_screenshot.png";
211
Felipe Lemee844a9d2016-09-21 15:01:39 -0700212// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000213
Nandana Dutt5c390032019-03-12 10:52:56 +0000214#define RETURN_IF_USER_DENIED_CONSENT() \
215 if (ds.IsUserConsentDenied()) { \
216 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
217 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
218 }
219
220// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
221// if consent is found to be denied.
222#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
223 RETURN_IF_USER_DENIED_CONSENT(); \
224 func_ptr(__VA_ARGS__); \
225 RETURN_IF_USER_DENIED_CONSENT();
226
Rhed Jao5377d792020-07-16 17:37:39 +0800227// Runs func_ptr, and logs a duration report after it's finished.
228#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
229 { \
230 DurationReporter duration_reporter_in_macro(log_title); \
231 func_ptr(__VA_ARGS__); \
232 }
233
234// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
235// is output after a slow function is finished.
236#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
237 RETURN_IF_USER_DENIED_CONSENT(); \
238 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
239 RETURN_IF_USER_DENIED_CONSENT();
240
Chris Morinbc223142022-02-04 14:17:11 -0800241#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800242 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800243 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800244 RETURN_IF_USER_DENIED_CONSENT();
245
Sahana Raof35ed432019-07-12 10:47:52 +0100246static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
247
Rhed Jao5377d792020-07-16 17:37:39 +0800248// Names of parallel tasks, they are used for the DumpPool to identify the dump
249// task and the log title of the duration report.
250static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800251static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huang24d215d2022-04-27 18:51:16 +0800252static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800253static const std::string DUMP_HALS_TASK = "DUMP HALS";
254static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800255static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariottica20f2d2023-12-15 09:34:25 +0000256static const std::string SERIALIZE_PERFETTO_TRACE_TASK = "SERIALIZE PERFETTO TRACE";
Rhed Jao5377d792020-07-16 17:37:39 +0800257
Nandana Dutt979388e2018-11-30 16:48:55 +0000258namespace android {
259namespace os {
260namespace {
261
262static int Open(std::string path, int flags, mode_t mode = 0) {
263 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
264 if (fd == -1) {
265 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
266 }
267 return fd;
268}
269
mhasank2d75c442020-06-11 15:05:25 -0700270static int OpenForWrite(std::string path) {
271 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
272 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
273}
Nandana Dutt979388e2018-11-30 16:48:55 +0000274
275static int OpenForRead(std::string path) {
276 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
277}
278
279bool CopyFile(int in_fd, int out_fd) {
280 char buf[4096];
281 ssize_t byte_count;
282 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
283 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
284 return false;
285 }
286 }
287 return (byte_count != -1);
288}
289
290static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000291 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000292
293 // Obtain a handle to the source file.
294 android::base::unique_fd in_fd(OpenForRead(input_file));
295 if (out_fd != -1 && in_fd.get() != -1) {
296 if (CopyFile(in_fd.get(), out_fd)) {
297 return true;
298 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000299 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000300 }
301 return false;
302}
303
Nandana Duttd2f5f082019-01-18 17:13:52 +0000304static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000305 if (file.empty()) {
306 return false;
307 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000308 if (unlink(file.c_str())) {
309 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000310 return false;
311 }
312 return true;
313}
Nandana Dutt979388e2018-11-30 16:48:55 +0000314
Nikita Ioffea325a572019-05-16 19:49:47 +0100315int64_t GetModuleMetadataVersion() {
316 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
317 if (binder == nullptr) {
318 MYLOGE("Failed to retrieve package_native service");
319 return 0L;
320 }
321 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
322 std::string package_name;
323 auto status = package_service->getModuleMetadataPackageName(&package_name);
324 if (!status.isOk()) {
325 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
326 return 0L;
327 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100328 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100329 int64_t version_code;
330 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
331 &version_code);
332 if (!status.isOk()) {
333 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
334 return 0L;
335 }
336 return version_code;
337}
338
mhasank2d75c442020-06-11 15:05:25 -0700339static bool PathExists(const std::string& path) {
340 struct stat sb;
341 return stat(path.c_str(), &sb) == 0;
342}
343
344static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
345 if (input_file == output_file) {
346 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
347 output_file.c_str());
348 return false;
349 }
350 else if (PathExists(output_file)) {
351 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
352 return false;
353 }
354
355 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
356 android::base::unique_fd out_fd(OpenForWrite(output_file));
357 return CopyFileToFd(input_file, out_fd.get());
358}
359
Nandana Dutt979388e2018-11-30 16:48:55 +0000360} // namespace
361} // namespace os
362} // namespace android
363
Felipe Leme678727a2016-09-21 17:22:11 -0700364static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800365 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800366 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
367 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
368}
369static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
370 int out_fd) {
371 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700372}
373static int DumpFile(const std::string& title, const std::string& path) {
374 return ds.DumpFile(title, path);
375}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800376
Felipe Lemee844a9d2016-09-21 15:01:39 -0700377// Relative directory (inside the zip) for all files copied as-is into the bugreport.
378static const std::string ZIP_ROOT_DIR = "FS";
379
Vishnu Naire97d6122018-01-18 13:58:56 -0800380static const std::string kProtoPath = "proto/";
381static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700382static const std::string kDumpstateBoardFiles[] = {
383 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700384 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700385};
386static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
387
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700388static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700389static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700390
Felipe Lemef0292972016-11-22 13:57:05 -0800391static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
392
Narayan Kamath8f788292017-05-25 13:20:39 +0100393/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100394 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800395 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800396 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100397 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700398static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800399 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100400 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100401
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700402 if (dump_dir == nullptr) {
403 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700404 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700405 }
406
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700407 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100408 struct dirent* entry = nullptr;
409 while ((entry = readdir(dump_dir.get()))) {
410 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100411 continue;
412 }
413
Narayan Kamathbd863722017-06-01 18:50:12 +0100414 const std::string base_name(entry->d_name);
415 if (base_name.find(file_prefix) != 0) {
416 continue;
417 }
418
419 const std::string abs_path = dir_path + base_name;
420 android::base::unique_fd fd(
421 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
422 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700423 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100424 break;
425 }
426
427 struct stat st = {};
428 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700429 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100430 continue;
431 }
432
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700433 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700434 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800435 if (!dump_data.empty()) {
436 std::sort(dump_data.begin(), dump_data.end(),
437 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
438 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100439
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700440 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100441}
442
Narayan Kamathbd863722017-06-01 18:50:12 +0100443static bool AddDumps(const std::vector<DumpData>::const_iterator start,
444 const std::vector<DumpData>::const_iterator end,
445 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100446 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100447 for (auto it = start; it != end; ++it) {
448 const std::string& name = it->name;
449 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100450 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100451
452 // Seek to the beginning of the file before dumping any data. A given
453 // DumpData entry might be dumped multiple times in the report.
454 //
455 // For example, the most recent ANR entry is dumped to the body of the
456 // main entry and it also shows up as a separate entry in the bugreport
457 // ZIP file.
458 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
459 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
460 strerror(errno));
461 }
462
Chris Morinc2cba7a2022-02-01 17:06:50 -0800463 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800464 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100465 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100466 }
467 } else {
468 dump_file_from_fd(type_name, name.c_str(), fd);
469 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100470 }
471
472 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700473}
474
Felipe Leme635ca312016-01-05 14:23:02 -0800475// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700476void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800477 char path[PATH_MAX];
478
479 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
480 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700481 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800482 char linkname[PATH_MAX];
483 ssize_t r = readlink(path, linkname, PATH_MAX);
484 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800485 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800486 return;
487 }
488 linkname[r] = '\0';
489
490 if (mount_points.find(linkname) == mount_points.end()) {
491 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700492 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700493 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800494 mount_points.insert(linkname);
495 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800496 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800497 }
498 }
499}
500
501void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700502 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800503 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800504 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700505 for_each_pid(do_mountinfo, nullptr);
506 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800507}
508
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700509static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
510{
511 DIR *d;
512 struct dirent *de;
513 char path[PATH_MAX];
514
515 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700516 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700517 return;
518 }
519
520 while ((de = readdir(d))) {
521 if (de->d_type != DT_LNK) {
522 continue;
523 }
524 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700525 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700526 }
527
528 closedir(d);
529}
530
Mark Salyzyn326842f2015-04-30 09:49:41 -0700531static bool skip_not_stat(const char *path) {
532 static const char stat[] = "/stat";
533 size_t len = strlen(path);
534 if (path[len - 1] == '/') { /* Directory? */
535 return false;
536 }
537 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
538}
539
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700540static bool skip_wtf_strictmode(const char *path) {
541 if (strstr(path, "_wtf")) {
542 return true;
543 } else if (strstr(path, "_strictmode")) {
544 return true;
545 }
546 return false;
547}
548
Felipe Leme4c2d6632016-09-28 14:32:00 -0700549static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800550 return false;
551}
552
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700553unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700554
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800555//
556// stat offsets
557// Name units description
558// ---- ----- -----------
559// read I/Os requests number of read I/Os processed
560#define __STAT_READ_IOS 0
561// read merges requests number of read I/Os merged with in-queue I/O
562#define __STAT_READ_MERGES 1
563// read sectors sectors number of sectors read
564#define __STAT_READ_SECTORS 2
565// read ticks milliseconds total wait time for read requests
566#define __STAT_READ_TICKS 3
567// write I/Os requests number of write I/Os processed
568#define __STAT_WRITE_IOS 4
569// write merges requests number of write I/Os merged with in-queue I/O
570#define __STAT_WRITE_MERGES 5
571// write sectors sectors number of sectors written
572#define __STAT_WRITE_SECTORS 6
573// write ticks milliseconds total wait time for write requests
574#define __STAT_WRITE_TICKS 7
575// in_flight requests number of I/Os currently in flight
576#define __STAT_IN_FLIGHT 8
577// io_ticks milliseconds total time this block device has been active
578#define __STAT_IO_TICKS 9
579// time_in_queue milliseconds total wait time for all requests
580#define __STAT_IN_QUEUE 10
581#define __STAT_NUMBER_FIELD 11
582//
583// read I/Os, write I/Os
584// =====================
585//
586// These values increment when an I/O request completes.
587//
588// read merges, write merges
589// =========================
590//
591// These values increment when an I/O request is merged with an
592// already-queued I/O request.
593//
594// read sectors, write sectors
595// ===========================
596//
597// These values count the number of sectors read from or written to this
598// block device. The "sectors" in question are the standard UNIX 512-byte
599// sectors, not any device- or filesystem-specific block size. The
600// counters are incremented when the I/O completes.
601#define SECTOR_SIZE 512
602//
603// read ticks, write ticks
604// =======================
605//
606// These values count the number of milliseconds that I/O requests have
607// waited on this block device. If there are multiple I/O requests waiting,
608// these values will increase at a rate greater than 1000/second; for
609// example, if 60 read requests wait for an average of 30 ms, the read_ticks
610// field will increase by 60*30 = 1800.
611//
612// in_flight
613// =========
614//
615// This value counts the number of I/O requests that have been issued to
616// the device driver but have not yet completed. It does not include I/O
617// requests that are in the queue but not yet issued to the device driver.
618//
619// io_ticks
620// ========
621//
622// This value counts the number of milliseconds during which the device has
623// had I/O requests queued.
624//
625// time_in_queue
626// =============
627//
628// This value counts the number of milliseconds that I/O requests have waited
629// on this block device. If there are multiple I/O requests waiting, this
630// value will increase as the product of the number of milliseconds times the
631// number of requests waiting (see "read ticks" above for an example).
632#define S_TO_MS 1000
633//
634
Mark Salyzyn326842f2015-04-30 09:49:41 -0700635static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800636 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700637 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700638 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700639 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700640 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700641 getline(&buffer, &i, fp);
642 fclose(fp);
643 if (!buffer) {
644 return -errno;
645 }
646 i = strlen(buffer);
647 while ((i > 0) && (buffer[i - 1] == '\n')) {
648 buffer[--i] = '\0';
649 }
650 if (!*buffer) {
651 free(buffer);
652 return 0;
653 }
654 z = true;
655 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800656 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700657 if (fields[i] != 0) {
658 z = false;
659 }
660 }
661 if (z) { /* never accessed */
662 free(buffer);
663 return 0;
664 }
665
Wei Wang509bb5d2017-06-09 14:42:12 -0700666 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
667 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700668 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700669
670 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
671 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
672 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700673 free(buffer);
674
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800675 if (fields[__STAT_IO_TICKS]) {
676 unsigned long read_perf = 0;
677 unsigned long read_ios = 0;
678 if (fields[__STAT_READ_TICKS]) {
679 unsigned long long divisor = fields[__STAT_READ_TICKS]
680 * fields[__STAT_IO_TICKS];
681 read_perf = ((unsigned long long)SECTOR_SIZE
682 * fields[__STAT_READ_SECTORS]
683 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
684 / divisor;
685 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
686 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
687 / divisor;
688 }
689
690 unsigned long write_perf = 0;
691 unsigned long write_ios = 0;
692 if (fields[__STAT_WRITE_TICKS]) {
693 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
694 * fields[__STAT_IO_TICKS];
695 write_perf = ((unsigned long long)SECTOR_SIZE
696 * fields[__STAT_WRITE_SECTORS]
697 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
698 / divisor;
699 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
700 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
701 / divisor;
702 }
703
704 unsigned queue = (fields[__STAT_IN_QUEUE]
705 + (fields[__STAT_IO_TICKS] >> 1))
706 / fields[__STAT_IO_TICKS];
707
708 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700709 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 -0800710 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700711 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 -0800712 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800713 }
714
715 /* bugreport timeout factor adjustment */
716 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
717 worst_write_perf = write_perf;
718 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700719 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700720 return 0;
721}
722
Yao Chenbe3bbc12018-01-17 16:31:10 -0800723static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
724
Tom Cherryf4472f32020-08-05 09:31:17 -0700725// Returns the actual readable size of the given buffer or -1 on error.
726static long logcat_buffer_readable_size(const std::string& buffer) {
727 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
728 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
729 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
730
731 return android_logger_get_log_readable_size(logger);
732}
733
734// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800735static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
736 unsigned long timeout_ms = 0;
737 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700738 long readable_size = logcat_buffer_readable_size(buffer);
739 if (readable_size > 0) {
740 // Engineering margin is ten-fold our guess.
741 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
742 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800743 }
744 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700745}
746
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800747// Opens a socket and returns its file descriptor.
748static int open_socket(const char* service);
749
Nandana Duttd2f5f082019-01-18 17:13:52 +0000750Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
751}
752
753android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
754 std::lock_guard<std::mutex> lock(lock_);
755 result_ = APPROVED;
756 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800757
758 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
759 // consent is granted.
760 if (ds.options_->is_screenshot_copied) {
761 return android::binder::Status::ok();
762 }
763
764 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
765 !ds.do_early_screenshot_) {
766 return android::binder::Status::ok();
767 }
768
769 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
770 ds.options_->screenshot_fd.get());
Paul Chang0d2aad72020-02-13 20:04:03 +0800771 if (copy_succeeded) {
772 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +0000773 } else {
774 MYLOGE("Failed to copy screenshot to a permanent file.\n");
775 copy_succeeded = android::os::CopyFileToFd(DEFAULT_SCREENSHOT_PATH,
776 ds.options_->screenshot_fd.get());
Paul Chang0d2aad72020-02-13 20:04:03 +0800777 }
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +0000778 ds.options_->is_screenshot_copied = copy_succeeded;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000779 return android::binder::Status::ok();
780}
781
782android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
783 std::lock_guard<std::mutex> lock(lock_);
784 result_ = DENIED;
785 MYLOGW("User denied consent to share bugreport\n");
786 return android::binder::Status::ok();
787}
788
789UserConsentResult Dumpstate::ConsentCallback::getResult() {
790 std::lock_guard<std::mutex> lock(lock_);
791 return result_;
792}
793
794uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800795 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000796}
797
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700798void Dumpstate::PrintHeader() const {
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200799 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700800 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700801
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700802 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
803 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700804 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
805 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
806 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200807 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700808 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700809
Felipe Lemed8b94e52016-12-08 10:21:44 -0800810 printf("========================================================\n");
811 printf("== dumpstate: %s\n", date);
812 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700813
Felipe Lemed8b94e52016-12-08 10:21:44 -0800814 printf("\n");
815 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700816 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800817 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
818 printf("Bootloader: %s\n", bootloader.c_str());
819 printf("Radio: %s\n", radio.c_str());
820 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100821 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
822 if (module_metadata_version != 0) {
823 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
824 }
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200825 printf("Android SDK version: %s\n", sdkversion.c_str());
826 printf("SDK extensions: ");
827 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
828 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700829
Felipe Lemed8b94e52016-12-08 10:21:44 -0800830 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800831 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800832 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000833 printf("Bootconfig: ");
834 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800835 printf("Uptime: ");
836 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
837 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800838 printf("Bugreport format version: %s\n", version_.c_str());
Kevin Jeonfa64e642023-07-27 11:36:41 -0400839 printf(
840 "Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d strict_run=%d args=%s "
841 "bugreport_mode=%s\n",
842 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
843 PropertiesHelper::IsStrictRun(), options_->args.c_str(),
844 options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800845 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800846}
847
Felipe Leme24b66ee2016-06-16 10:55:26 -0700848// List of file extensions that can cause a zip file attachment to be rejected by some email
849// service providers.
850static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
851 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
852 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
853 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
854};
855
Vishnu Naire97d6122018-01-18 13:58:56 -0800856status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
857 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700858 std::string valid_name = entry_name;
859
860 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700861 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700862 if (idx != std::string::npos) {
863 std::string extension = entry_name.substr(idx);
864 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
865 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
866 valid_name = entry_name + ".renamed";
867 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
868 }
869 }
870
Felipe Leme6fe9db62016-02-12 09:04:16 -0800871 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
872 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000873 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
874 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700875 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700876 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700877 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700878 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800879 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800880 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000881 bool finished_entry = false;
882 auto finish_entry = [this, &finished_entry] {
883 if (!finished_entry) {
884 // This should only be called when we're going to return an earlier error,
885 // which would've been logged. This may imply the file is already corrupt
886 // and any further logging from FinishEntry is more likely to mislead than
887 // not.
888 this->zip_writer_->FinishEntry();
889 }
890 };
891 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800892 auto start = std::chrono::steady_clock::now();
893 auto end = start + timeout;
894 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800895
Felipe Leme770410d2016-01-26 17:07:14 -0800896 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800897 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800898 if (timeout.count() > 0) {
899 // lambda to recalculate the timeout.
900 auto time_left_ms = [end]() {
901 auto now = std::chrono::steady_clock::now();
902 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
903 return std::max(diff.count(), 0LL);
904 };
905
906 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
907 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000908 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
909 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800910 return -errno;
911 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000912 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800913 entry_name.c_str(), strerror(errno), timeout.count());
914 return TIMED_OUT;
915 }
916 }
917
Zach Riggle22200402016-08-18 01:01:24 -0400918 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800919 if (bytes_read == 0) {
920 break;
921 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800922 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800923 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800924 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700925 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800926 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700927 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800928 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800929 }
930 }
931
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700932 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000933 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700934 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700935 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800936 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800937 }
938
Vishnu Naire97d6122018-01-18 13:58:56 -0800939 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800940}
941
Felipe Leme1d486fe2016-10-14 18:06:47 -0700942bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
943 android::base::unique_fd fd(
944 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700945 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800946 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800947 return false;
948 }
949
Vishnu Naire97d6122018-01-18 13:58:56 -0800950 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800951}
952
953/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700954static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800955 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800956}
957
Felipe Leme1d486fe2016-10-14 18:06:47 -0700958void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700959 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800960 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700961 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800962}
963
Felipe Leme1d486fe2016-10-14 18:06:47 -0700964bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800965 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000966 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
967 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700968 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700969 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700970 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800971 return false;
972 }
973
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700974 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700975 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700976 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700977 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800978 return false;
979 }
980
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700981 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700982 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700983 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800984 return false;
985 }
986
987 return true;
988}
989
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800990static void DoKmsg() {
991 struct stat st;
992 if (!stat(PSTORE_LAST_KMSG, &st)) {
993 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
994 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
995 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
996 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
997 } else {
998 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
999 DumpFile("LAST KMSG", "/proc/last_kmsg");
1000 }
1001}
1002
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001003static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -08001004 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001005 RunCommand(
1006 "KERNEL LOG",
1007 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1008 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1009}
1010
Nandana Duttdb379fa2019-10-09 16:54:41 +01001011static void DoSystemLogcat(time_t since) {
1012 char since_str[80];
1013 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
1014
1015 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
1016 RunCommand("SYSTEM LOG",
1017 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1018 since_str},
1019 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1020}
1021
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001022static void DoRadioLogcat() {
1023 unsigned long timeout_ms = logcat_timeout({"radio"});
1024 RunCommand(
1025 "RADIO LOG",
1026 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1027 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1028}
1029
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001030static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001031 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001032 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1033 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001034 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001035 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001036 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1037 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001038 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001039 RunCommand(
1040 "EVENT LOG",
1041 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001042 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001043 timeout_ms = logcat_timeout({"stats"});
1044 RunCommand(
1045 "STATS LOG",
1046 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001047 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001048 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001049
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001050 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001051 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1052 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001053}
1054
Mike Ma5c267872019-08-21 11:31:34 -07001055static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001056 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1057 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1058 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1059 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1060 if (fd < 0) {
1061 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1062 return;
1063 }
Kevin Jeonfa64e642023-07-27 11:36:41 -04001064 RunCommandToFd(fd, "", {"incident", "-u"},
1065 CommandOptions::WithTimeout(PropertiesHelper::IsStrictRun() ? 20 : 120).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001066 bool empty = 0 == lseek(fd, 0, SEEK_END);
1067 if (!empty) {
1068 // Use a different name from "incident.proto"
1069 // /proto/incident.proto is reserved for incident service dump
1070 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001071 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1072 path);
1073 } else {
1074 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001075 }
Mike Ma5c267872019-08-21 11:31:34 -07001076}
1077
Aaron Huang24d215d2022-04-27 18:51:16 +08001078static void DumpNetstatsProto() {
1079 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1080 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1081 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1082 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1083 if (fd < 0) {
1084 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1085 return;
1086 }
1087 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001088 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001089 bool empty = 0 == lseek(fd, 0, SEEK_END);
1090 if (!empty) {
1091 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1092 path);
1093 } else {
1094 unlink(path.c_str());
1095 }
1096}
1097
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001098static void MaybeAddSystemTraceToZip() {
1099 // This function copies into the .zip the system trace that was snapshotted
Kean Mariottica20f2d2023-12-15 09:34:25 +00001100 // by the early call to MaybeSnapshotSystemTraceAsync(), if any background
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001101 // tracing was happening.
Kean Mariotti853b73a2023-07-27 12:40:30 +00001102 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
1103 if (!system_trace_exists) {
Kean Mariottica20f2d2023-12-15 09:34:25 +00001104 // No background trace was happening at the time MaybeSnapshotSystemTraceAsync() was invoked
Kean Mariotti853b73a2023-07-27 12:40:30 +00001105 if (!PropertiesHelper::IsUserBuild()) {
1106 MYLOGI(
1107 "No system traces found. Check for previously uploaded traces by looking for "
1108 "go/trace-uuid in logcat")
1109 }
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001110 return;
1111 }
1112 ds.AddZipEntry(
1113 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1114 SYSTEM_TRACE_SNAPSHOT);
1115 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1116}
1117
Sunny Goyal35949782019-11-19 15:54:36 -08001118static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001119 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1120 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1121 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1122 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1123 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1124 if (fd < 0) {
1125 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1126 return;
1127 }
1128 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001129 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001130 bool empty = 0 == lseek(fd, 0, SEEK_END);
1131 if (!empty) {
1132 ds.AddZipEntry("visible_windows.zip", path);
1133 } else {
1134 MYLOGW("Failed to dump visible windows\n");
1135 }
1136 unlink(path.c_str());
1137}
1138
Jayachandran Ca94c7172017-06-10 15:08:12 -07001139static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001140 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1141 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001142 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001143 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001144 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1145 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1146 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1147 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001148}
1149
Woody Lin20767a92022-11-29 15:50:24 +08001150static void DumpShutdownCheckpoints() {
1151 const bool shutdown_checkpoints_dumped = AddDumps(
1152 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1153 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1154 if (!shutdown_checkpoints_dumped) {
1155 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1156 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1157 }
1158}
1159
David Andersond9ba4752018-12-11 18:26:59 -08001160static void DumpDynamicPartitionInfo() {
1161 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1162 return;
1163 }
1164
1165 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001166 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001167}
1168
Chris Morin5a50d482022-02-01 17:41:18 -08001169static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001170 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1171 anr_traces_dir.c_str());
1172
1173 // If we're here, dump_traces_path will always be a temporary file
1174 // (created with mkostemp or similar) that contains dumps taken earlier
1175 // on in the process.
1176 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001177 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1178 dump_traces_path);
1179 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001180
1181 const int ret = unlink(dump_traces_path);
1182 if (ret == -1) {
1183 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1184 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001185 }
1186 }
1187
Narayan Kamathbd863722017-06-01 18:50:12 +01001188 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001189 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001190 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001191 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001192 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001193
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001194 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001195 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001196 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001197 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001198 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1199 }
Andy Hungd62f7e62024-01-11 15:47:52 -08001200
1201 // Add Java anr traces (such as generated by the Finalizer Watchdog).
1202 AddDumps(ds.anr_trace_data_.begin(), ds.anr_trace_data_.end(), "JAVA ANR TRACES",
1203 true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001204}
1205
1206static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001207 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001208
Chris Morin5a50d482022-02-01 17:41:18 -08001209 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001210
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001211 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1212
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001213 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001214 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001215 int i = 0;
1216 while (true) {
1217 const std::string slow_trace_path =
1218 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1219 if (stat(slow_trace_path.c_str(), &st)) {
1220 // No traces file at this index, done with the files.
1221 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001222 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001223 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1224 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001225 }
1226}
1227
Wei Wang509bb5d2017-06-09 14:42:12 -07001228static void DumpBlockStatFiles() {
1229 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001230
Wei Wang1dc1ef52017-06-12 11:28:37 -07001231 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1232
1233 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001234 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1235 return;
1236 }
1237
1238 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001239 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001240 if ((d->d_name[0] == '.')
1241 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1242 || (d->d_name[1] == '\0'))) {
1243 continue;
1244 }
1245 const std::string new_path =
1246 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1247 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1248 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1249 printf("\n");
1250 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001251 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001252}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001253
1254static void DumpPacketStats() {
1255 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001256}
1257
1258static void DumpIpAddrAndRules() {
1259 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
Ray Chencbf278a2023-11-20 07:49:45 +00001260 RunCommand("NETWORK INTERFACES", {"ip", "-s", "link"});
Jayachandran Ca94c7172017-06-10 15:08:12 -07001261 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1262 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1263 RunCommand("IP RULES", {"ip", "rule", "show"});
1264 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1265}
1266
Nandana Dutt5c390032019-03-12 10:52:56 +00001267static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1268 std::chrono::milliseconds timeout,
1269 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001270 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001271 sp<android::IServiceManager> sm = defaultServiceManager();
1272 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001273 Vector<String16> args;
1274 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001275 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1276 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001277 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001278 std::string path(title);
1279 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001280 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001281 if (PropertiesHelper::IsDryRun()) {
1282 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1283 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1284 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001285 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1286 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001287 service, args);
1288 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001289 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1290 std::chrono::duration<double> elapsed_seconds;
1291 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1292 service == String16("meminfo")) {
1293 // Use a longer timeout for meminfo, since 30s is not always enough.
1294 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1295 /* as_proto = */ false, elapsed_seconds,
1296 bytes_written);
1297 } else {
1298 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1299 /* as_proto = */ false, elapsed_seconds,
1300 bytes_written);
1301 }
1302 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1303 bool dump_complete = (status == OK);
1304 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001305 } else {
1306 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1307 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001308 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001309 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001310
1311 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1312 std::chrono::steady_clock::now() - start);
1313 if (elapsed_duration > timeout) {
1314 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1315 elapsed_duration.count());
1316 break;
1317 }
1318 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001319 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001320}
1321
Vishnu Nair64afc022018-02-01 15:29:34 -08001322static void RunDumpsysText(const std::string& title, int priority,
1323 std::chrono::milliseconds timeout,
1324 std::chrono::milliseconds service_timeout) {
1325 DurationReporter duration_reporter(title);
1326 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1327 fsync(STDOUT_FILENO);
1328 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1329}
1330
1331/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001332static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1333 std::chrono::milliseconds timeout,
1334 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001335 DurationReporter duration_reporter(title);
1336 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1337 fsync(STDOUT_FILENO);
1338 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1339 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001340
1341 RETURN_IF_USER_DENIED_CONSENT();
1342
1343 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1344 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001345}
1346
Nandana Dutt5c390032019-03-12 10:52:56 +00001347static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1348 std::chrono::milliseconds timeout,
1349 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001350 sp<android::IServiceManager> sm = defaultServiceManager();
1351 Dumpsys dumpsys(sm.get());
1352 Vector<String16> args;
1353 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1354 DurationReporter duration_reporter(title);
1355
1356 auto start = std::chrono::steady_clock::now();
1357 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1358 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001359 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001360 std::string path(kProtoPath);
1361 path.append(String8(service).c_str());
1362 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1363 path.append("_CRITICAL");
1364 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1365 path.append("_HIGH");
1366 }
1367 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001368 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001369 if (status == OK) {
1370 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1371 bool dumpTerminated = (status == OK);
1372 dumpsys.stopDumpThread(dumpTerminated);
1373 }
1374 ZipWriter::FileEntry file_entry;
1375 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001376
1377 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1378 std::chrono::steady_clock::now() - start);
1379 if (elapsed_duration > timeout) {
1380 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1381 elapsed_duration.count());
1382 break;
1383 }
1384 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001385 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001386}
1387
Nandana Dutta7db6342018-11-21 14:53:34 +00001388// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001389static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001390 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1391 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001392
1393 RETURN_IF_USER_DENIED_CONSENT();
1394
1395 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1396 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001397}
1398
1399// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001400static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001401 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1402 // high priority. Reduce timeout once they are able to dump in a shorter time or
1403 // moved to a parallel task.
1404 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1405 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001406
1407 RETURN_IF_USER_DENIED_CONSENT();
1408
1409 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1410 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001411}
1412
1413// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001414static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001415 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001416
1417 RETURN_IF_USER_DENIED_CONSENT();
1418
1419 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1420 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001421}
1422
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001423/*
1424 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1425 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1426 * if it's not running in the parallel task.
1427 */
1428static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001429 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001430 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1431 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001432
Steven Moreland44cd9482018-01-04 16:24:13 -08001433 using android::hidl::manager::V1_0::IServiceManager;
1434 using android::hardware::defaultServiceManager;
1435
1436 sp<IServiceManager> sm = defaultServiceManager();
1437 if (sm == nullptr) {
1438 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1439 return;
1440 }
1441
1442 auto ret = sm->list([&](const auto& interfaces) {
1443 for (const std::string& interface : interfaces) {
1444 std::string cleanName = interface;
Steven Morelandc6b1fc22023-07-26 23:53:58 +00001445 std::replace_if(
1446 cleanName.begin(), cleanName.end(),
1447 [](char c) {
1448 return !isalnum(c) && std::string("@-_.").find(c) == std::string::npos;
1449 },
1450 '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001451 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001452
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001453 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001454 {
1455 auto fd = android::base::unique_fd(
1456 TEMP_FAILURE_RETRY(open(path.c_str(),
1457 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1458 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1459 if (fd < 0) {
1460 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1461 continue;
1462 }
1463 RunCommandToFd(fd,
1464 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001465 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001466 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1467
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001468 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001469 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001470 if (!empty) {
1471 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1472 path);
1473 } else {
1474 unlink(path.c_str());
1475 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001476 }
1477 });
1478
1479 if (!ret.isOk()) {
1480 MYLOGE("Could not list hals from hwservicemanager.\n");
1481 }
1482}
1483
Devin Moore8df81bb2022-06-08 22:47:02 +00001484// Dump all of the files that make up the vendor interface.
1485// See the files listed in dumpFileList() for the latest list of files.
1486static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001487
1488 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1489 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001490 for (const auto vintfFile : vintfFiles) {
1491 struct stat st;
1492 if (stat(vintfFile.c_str(), &st) == 0) {
1493 if (S_ISDIR(st.st_mode)) {
1494 ds.AddDir(vintfFile, true /* recursive */);
1495 } else {
1496 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1497 vintfFile);
1498 }
1499 }
1500 }
1501}
1502
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001503static void DumpExternalFragmentationInfo() {
1504 struct stat st;
1505 if (stat("/proc/buddyinfo", &st) != 0) {
1506 MYLOGE("Unable to dump external fragmentation info\n");
1507 return;
1508 }
1509
1510 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1511 std::ifstream ifs("/proc/buddyinfo");
1512 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1513 for (std::string line; std::getline(ifs, line);) {
1514 std::smatch match_results;
1515 if (std::regex_match(line, match_results, unusable_index_regex)) {
1516 std::stringstream free_pages(std::string{match_results[3]});
1517 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1518 std::istream_iterator<int>());
1519
1520 int total_free_pages = 0;
1521 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1522 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1523 }
1524
1525 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1526 match_results[2].str().c_str());
1527
1528 int usable_free_pages = total_free_pages;
1529 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1530 auto unusable_index = (total_free_pages - usable_free_pages) /
1531 static_cast<double>(total_free_pages);
1532 printf(" %5.3f", unusable_index);
1533 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1534 }
1535
1536 printf("\n");
1537 }
1538 }
1539 printf("\n");
1540}
1541
mhasankd451a472020-05-26 18:02:39 -07001542static void DumpstateLimitedOnly() {
EdenSue8fe4522023-11-20 15:37:23 +08001543 // Trimmed-down version of dumpstate to only include a allowlisted
mhasankd451a472020-05-26 18:02:39 -07001544 // set of logs (system log, event log, and system server / system app
1545 // crashes, and networking logs). See b/136273873 and b/138459828
1546 // for context.
1547 DurationReporter duration_reporter("DUMPSTATE");
1548 unsigned long timeout_ms;
1549 // calculate timeout
1550 timeout_ms = logcat_timeout({"main", "system", "crash"});
1551 RunCommand("SYSTEM LOG",
1552 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1553 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1554 timeout_ms = logcat_timeout({"events"});
1555 RunCommand(
1556 "EVENT LOG",
1557 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1558 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1559
1560 printf("========================================================\n");
1561 printf("== Networking Service\n");
1562 printf("========================================================\n");
1563
1564 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1565 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001566 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1567 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001568
1569 printf("========================================================\n");
Chuwei Hecc54a252024-07-25 15:18:36 +09001570 printf("== Networking Policy\n");
1571 printf("========================================================\n");
1572
1573 RunDumpsys("DUMPSYS NETWORK POLICY", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(),
1574 SEC_TO_MSEC(10));
1575
1576 printf("========================================================\n");
mhasankd451a472020-05-26 18:02:39 -07001577 printf("== Dropbox crashes\n");
1578 printf("========================================================\n");
1579
1580 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1581 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1582
Bryan Yuefb85d92024-02-02 13:37:06 +00001583
1584 printf("========================================================\n");
1585 printf("== ANR Traces\n");
1586 printf("========================================================\n");
1587
Bryan Yucf038cf2024-05-08 09:25:25 +00001588 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Bryan Yuefb85d92024-02-02 13:37:06 +00001589 AddAnrTraceFiles();
1590
mhasankd451a472020-05-26 18:02:39 -07001591 printf("========================================================\n");
1592 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1593 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1594 printf("========================================================\n");
1595 printf("== dumpstate: done (id %d)\n", ds.id_);
1596 printf("========================================================\n");
1597}
1598
Rhed Jaoe017f982020-07-21 17:58:41 +08001599/*
1600 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1601 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1602 * if it's not running in the parallel task.
1603 */
1604static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1605 dprintf(out_fd, "========================================================\n");
1606 dprintf(out_fd, "== Checkins\n");
1607 dprintf(out_fd, "========================================================\n");
1608
1609 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001610 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1611 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1612 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1613 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1614}
1615
1616/*
1617 * Runs dumpsys on activity service to dump all application activities, services
1618 * and providers in the device.
1619 *
1620 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1621 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1622 * if it's not running in the parallel task.
1623 */
1624static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1625 dprintf(out_fd, "========================================================\n");
1626 dprintf(out_fd, "== Running Application Activities\n");
1627 dprintf(out_fd, "========================================================\n");
1628
1629 // The following dumpsys internally collects output from running apps, so it can take a long
1630 // time. So let's extend the timeout.
1631
1632 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1633
1634 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1635
1636 dprintf(out_fd, "========================================================\n");
1637 dprintf(out_fd, "== Running Application Services (platform)\n");
1638 dprintf(out_fd, "========================================================\n");
1639
1640 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1641 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1642
1643 dprintf(out_fd, "========================================================\n");
1644 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1645 dprintf(out_fd, "========================================================\n");
1646
1647 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1648 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1649
1650 dprintf(out_fd, "========================================================\n");
1651 dprintf(out_fd, "== Running Application Providers (platform)\n");
1652 dprintf(out_fd, "========================================================\n");
1653
1654 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001655 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001656
1657 dprintf(out_fd, "========================================================\n");
1658 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1659 dprintf(out_fd, "========================================================\n");
1660
1661 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1662 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1663}
1664
Nandana Dutt5c390032019-03-12 10:52:56 +00001665// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1666// via the consent they are shown. Ignores other errors that occur while running various
1667// commands. The consent checking is currently done around long running tasks, which happen to
1668// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001669Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001670 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001671
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001672 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001673 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariottica20f2d2023-12-15 09:34:25 +00001674 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001675 if (ds.dump_pool_) {
1676 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001677 // drop root user. Restarts it.
1678 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001679
Chris Morinbc223142022-02-04 14:17:11 -08001680 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1681 dump_incident_report = ds.dump_pool_->enqueueTask(
1682 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001683 dump_netstats_report = ds.dump_pool_->enqueueTask(
1684 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001685 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1686 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1687 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001688 }
1689
Nandana Dutt5c390032019-03-12 10:52:56 +00001690 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1691 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1692 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001693 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001694 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001695 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001696 DumpFile("MEMORY INFO", "/proc/meminfo");
1697 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001698 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001699
Kevin Jeon947922b2022-09-21 00:29:18 +00001700 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1701 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001702
Sunny Goyal35949782019-11-19 15:54:36 -08001703 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1704
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001705 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1706 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1707 DumpFile("SLAB INFO", "/proc/slabinfo");
1708 DumpFile("ZONEINFO", "/proc/zoneinfo");
1709 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1710 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001711 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001712
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001713 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001714
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001715 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001716 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001717
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001718 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001719 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001720 } else {
1721 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1722 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001723
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001724 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001725 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001726 struct stat s;
1727 if (stat("/proc/modules", &s) != 0) {
1728 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1729 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001730 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001731 RunCommand("MODULES INFO",
1732 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1733 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1734 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001735 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001736
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001737 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001738 DoKernelLogcat();
1739 } else {
1740 do_dmesg();
1741 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001742
Devin Moore8df81bb2022-06-08 22:47:02 +00001743 DumpVintf();
1744
Felipe Lemef0292972016-11-22 13:57:05 -08001745 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001746
Jeff Brown1dc94e32014-09-11 14:15:27 -07001747 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001748 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001749
Jack Yu5a6b2e22020-08-14 18:13:35 +08001750 /* Dump Nfc NCI logs */
1751 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001752
Paul Chang0d2aad72020-02-13 20:04:03 +08001753 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001754 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001755 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001756 }
1757
Felipe Lemee184f662016-10-27 10:04:47 -07001758 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001759
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001760 MaybeAddSystemTraceToZip();
1761
Narayan Kamath8f788292017-05-25 13:20:39 +01001762 // NOTE: tombstones are always added as separate entries in the zip archive
1763 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001764 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001765 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001766 if (!tombstones_dumped) {
1767 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001768 }
1769
Jayachandran Ca94c7172017-06-10 15:08:12 -07001770 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001771
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001772 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001773
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001774 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001775
Woody Lin20767a92022-11-29 15:50:24 +08001776 DumpShutdownCheckpoints();
1777
Jayachandran Ca94c7172017-06-10 15:08:12 -07001778 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001779
1780 dump_route_tables();
1781
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001782 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1783 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1784 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001785
Nandana Dutt5c390032019-03-12 10:52:56 +00001786 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001787
Chiachang Wang668ede42021-05-17 17:14:20 +08001788 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1789 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1790 // dump with priority parameters to dump high priority information.
1791 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1792 CommandOptions::WithTimeout(10).Build());
1793
Elliott Hughes23ccc622017-02-28 10:14:22 -08001794 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001795
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001796 DumpFile("SYSTEM BUILD-TIME RELEASE FLAGS", "/system/etc/build_flags.json");
1797 DumpFile("SYSTEM_EXT BUILD-TIME RELEASE FLAGS", "/system_ext/etc/build_flags.json");
1798 DumpFile("PRODUCT BUILD-TIME RELEASE FLAGS", "/product/etc/build_flags.json");
1799 DumpFile("VENDOR BUILD-TIME RELEASE FLAGS", "/vendor/etc/build_flags.json");
1800
MÃ¥rten Kongstad5ad813f2023-09-28 10:09:18 +02001801 RunCommand("ACONFIG FLAGS", {PRINT_FLAGS},
1802 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
Ted Bauerf6d61b82024-09-13 19:57:19 +00001803 RunCommand("ACONFIG FLAGS DUMP", {AFLAGS, "list"},
1804 CommandOptions::WithTimeout(10).Always().AsRootIfAvailable().Build());
1805 RunCommand("WHICH ACONFIG FLAG STORAGE", {AFLAGS, "which-backing"},
1806 CommandOptions::WithTimeout(10).Always().AsRootIfAvailable().Build());
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001807
Jin Qianf334d662017-10-10 14:41:37 -07001808 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001809
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001810 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001811
Colin Crossf45fa6b2012-03-26 12:38:26 -07001812 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001813 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1814 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1815
1816 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1817 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1818 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1819 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1820 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001821
Yifan Hongd90cc652020-02-08 16:52:02 -08001822 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1823
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001824 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001825 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001826 } else {
1827 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1828 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001829
Steven Moreland7440ddb2016-12-15 16:13:39 -08001830 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001831 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1832 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001833 // su does not exist on user builds, so try running without it.
1834 // This way any implementations of vril-dump that do not require
1835 // root can run on user builds.
1836 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001837 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001838 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001839 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001840 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001841 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001842 }
1843
Radud0776152024-10-29 12:08:54 +00001844 /* Dump USB information */
1845 RunCommand("typec_connector_class", {"typec_connector_class"},
1846 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1847 RunCommand("lsusb", {"lsusb"}, CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1848
Felipe Lemed8b94e52016-12-08 10:21:44 -08001849 printf("========================================================\n");
1850 printf("== Android Framework Services\n");
1851 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001852
Nandana Dutt5c390032019-03-12 10:52:56 +00001853 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001854
Jack He91ff2fe2021-02-18 18:23:43 -08001855 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1856 ds.AddDir("/data/misc/bluetooth/logs", true);
1857
Rhed Jaoe017f982020-07-21 17:58:41 +08001858 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001859 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001860 } else {
1861 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1862 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001863
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001864 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001865
Adrian Roos8b397ab2017-04-04 16:35:44 -07001866 printf("========================================================\n");
1867 printf("== Dropbox crashes\n");
1868 printf("========================================================\n");
1869
1870 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1871 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1872
Felipe Lemed8b94e52016-12-08 10:21:44 -08001873 printf("========================================================\n");
1874 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1875 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1876 printf("========================================================\n");
1877 printf("== dumpstate: done (id %d)\n", ds.id_);
1878 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001879
1880 printf("========================================================\n");
1881 printf("== Obtaining statsd metadata\n");
1882 printf("========================================================\n");
1883 // This differs from the usual dumpsys stats, which is the stats report data.
1884 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001885
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001886 // Add linker configuration directory
1887 ds.AddDir(LINKERCONFIG_DIR, true);
1888
Li Li830179f2022-01-04 12:53:29 -08001889 /* Dump frozen cgroupfs */
1890 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001891
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001892 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001893 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1894 } else {
1895 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1896 DumpNetstatsProto);
1897 }
1898
1899 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001900 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001901 } else {
1902 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1903 DumpIncidentReport);
1904 }
Mike Ma5c267872019-08-21 11:31:34 -07001905
Kean Mariotti306633e2022-09-05 16:30:47 +00001906 MaybeAddUiTracesToZip();
1907
Nandana Dutt5c390032019-03-12 10:52:56 +00001908 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001909}
1910
Nandana Dutt5c390032019-03-12 10:52:56 +00001911/*
1912 * Dumps state for the default case; drops root after it's no longer necessary.
1913 *
1914 * Returns RunStatus::OK if everything went fine.
1915 * Returns RunStatus::ERROR if there was an error.
1916 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1917 * with the caller.
1918 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001919Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001920 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1921 // buffer.
1922 DoLogcat();
1923 // Capture timestamp after first logcat to use in next logcat
1924 time_t logcat_ts = time(nullptr);
1925
Nandana Dutt4be45d12018-09-26 15:04:23 +01001926 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001927 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001928 if (dump_pool_) {
1929 RETURN_IF_USER_DENIED_CONSENT();
1930 // One thread is enough since we only need to enqueue DumpTraces here.
1931 dump_pool_->start(/* thread_counts = */1);
1932
1933 // DumpTraces takes long time, post it to the another thread in the
1934 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001935 dump_traces = dump_pool_->enqueueTask(
1936 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001937 } else {
1938 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1939 &dump_traces_path);
1940 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001941
1942 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001943 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001944 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1945 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Andy Hungd62f7e62024-01-11 15:47:52 -08001946 ds.anr_trace_data_ = GetDumpFds(ANR_DIR, ANR_TRACE_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001947 ds.shutdown_checkpoints_ = GetDumpFds(
1948 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001949 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001950
1951 ds.AddDir(RECOVERY_DIR, true);
1952 ds.AddDir(RECOVERY_DATA_DIR, true);
1953 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001954 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001955 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1956 if (!PropertiesHelper::IsUserBuild()) {
1957 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1958 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001959 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001960 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001961 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001962 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001963 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1964 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1965 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001966 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001967 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001968 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001969 if (!PropertiesHelper::IsUserBuild()) {
1970 // Include dropbox entry files inside ZIP, but exclude
1971 // noisy WTF and StrictMode entries
1972 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1973 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001974
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001975 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001976 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1977
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001978 // Dump IPsec stats. No keys are exposed here.
1979 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1980
Nandana Dutt4be45d12018-09-26 15:04:23 +01001981 // Run ss as root so we can see socket marks.
1982 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1983
1984 // Run iotop as root to show top 100 IO threads
1985 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1986
Erick Reyese68df822019-02-11 14:46:36 -08001987 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001988 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1989 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001990
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001991 DumpFile("PSI cpu", "/proc/pressure/cpu");
1992 DumpFile("PSI memory", "/proc/pressure/memory");
1993 DumpFile("PSI io", "/proc/pressure/io");
1994
Steven Moreland9379c462023-12-21 02:04:27 +00001995 ds.AddZipEntry(ZIP_ROOT_DIR + KERNEL_CONFIG, KERNEL_CONFIG);
1996
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +02001997 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1998 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1999
Nattharat Jariyanuntanaetb250cae2024-05-15 07:48:19 +00002000 // Dump UWB UCI logs here because apexdata requires root access
2001 ds.AddDir(UWB_LOG_DIR, true);
2002
Rhed Jao5377d792020-07-16 17:37:39 +08002003 if (dump_pool_) {
2004 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08002005 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08002006
Chris Morinbc223142022-02-04 14:17:11 -08002007 // Current running thread in the pool is the root user also. Delete
2008 // the pool and make a new one later to ensure none of threads in the pool are root.
2009 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08002010 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002011 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002012 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002013 }
2014
Nandana Dutt5c390032019-03-12 10:52:56 +00002015 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01002016 Dumpstate::RunStatus status = dumpstate();
2017 // Capture logcat since the last time we did it.
2018 DoSystemLogcat(logcat_ts);
2019 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002020}
2021
Rhed Jaob5685b32020-08-14 17:19:17 +08002022// Common states for telephony and wifi which are needed to be collected before
2023// dumpstate drop the root user.
2024static void DumpstateRadioAsRoot() {
2025 DumpIpTablesAsRoot();
2026 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2027}
2028
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002029// This method collects common dumpsys for telephony and wifi. Typically, wifi
2030// reports are fine to include all information, but telephony reports on user
2031// builds need to strip some content (see DumpstateTelephonyOnly).
2032static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002033 // We need to be picky about some stuff for telephony reports on user builds.
2034 if (!include_sensitive_info) {
2035 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
2036 DoRadioLogcat();
2037 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08002038 // DumpHals takes long time, post it to the another thread in the pool,
2039 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002040 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08002041 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002042 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002043 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002044 // Contains various system properties and process startup info.
2045 do_dmesg();
2046 // Logs other than the radio buffer may contain package/component names and potential PII.
2047 DoLogcat();
2048 // Too broad for connectivity problems.
2049 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08002050 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
2051 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002052 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08002053 } else {
2054 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
2055 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002056 }
2057
Jayachandran Ca94c7172017-06-10 15:08:12 -07002058 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002059 DumpIpAddrAndRules();
2060 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002061 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2062 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002063}
2064
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002065// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2066// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2067// for what can be included on user builds: all reported information MUST directly relate to
2068// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2069// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2070// names are not), and MUST NOT contain logs of user application traffic.
2071// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002072static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002073 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002074
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002075 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002076
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002077 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002078
Rhed Jaob5685b32020-08-14 17:19:17 +08002079 DumpstateRadioAsRoot();
2080 if (!DropRootUser()) {
2081 return;
2082 }
2083
2084 // Starts thread pool after the root user is dropped, and two additional threads
2085 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002086 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002087 if (ds.dump_pool_) {
2088 ds.dump_pool_->start(/*thread_counts =*/2);
2089
2090 // DumpstateBoard takes long time, post it to the another thread in the pool,
2091 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002092 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2093 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002094 }
2095
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002096 DumpstateRadioCommon(include_sensitive_info);
2097
2098 if (include_sensitive_info) {
2099 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2100 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2101 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2102 // way.
2103 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2104 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002105
2106 printf("========================================================\n");
2107 printf("== Android Framework Services\n");
2108 printf("========================================================\n");
2109
Vishnu Nair652cc802017-11-30 15:18:30 -08002110 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2111 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002112 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2113 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002114 if (include_sensitive_info) {
2115 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2116 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2117 SEC_TO_MSEC(10));
2118 } else {
2119 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2120 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2121 // give a higher timeout as well.
2122 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2123 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2124 }
2125 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002126 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2127 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002128 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002129 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2130 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002131 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2132 SEC_TO_MSEC(10));
Grant Menke56698972023-02-24 13:11:07 -08002133 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2134 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002135 if (include_sensitive_info) {
2136 // Contains raw IP addresses, omit from reports on user builds.
2137 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2138 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2139 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2140 SEC_TO_MSEC(10));
2141 // Contains package/component names, omit from reports on user builds.
2142 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2143 SEC_TO_MSEC(10));
2144 // Contains package names, but should be relatively simple to remove them (also contains
2145 // UIDs already), omit from reports on user builds.
2146 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2147 SEC_TO_MSEC(10));
2148 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002149
2150 printf("========================================================\n");
2151 printf("== Running Application Services\n");
2152 printf("========================================================\n");
2153
2154 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2155
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002156 if (include_sensitive_info) {
2157 printf("========================================================\n");
2158 printf("== Running Application Services (non-platform)\n");
2159 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002160
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002161 // Contains package/component names and potential PII, omit from reports on user builds.
2162 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2163 // carrier_config dumpsys instead.
2164 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2165 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002166
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002167 printf("========================================================\n");
2168 printf("== Checkins\n");
2169 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002170
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002171 // Contains package/component names, omit from reports on user builds.
2172 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2173 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002174
2175 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002176 printf("== dumpstate: done (id %d)\n", ds.id_);
2177 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002178
2179 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002180 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002181 } else {
2182 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2183 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002184}
2185
mukesh agrawal253dad42018-01-23 21:59:59 -08002186// This method collects dumpsys for wifi debugging only
2187static void DumpstateWifiOnly() {
2188 DurationReporter duration_reporter("DUMPSTATE");
2189
Rhed Jaob5685b32020-08-14 17:19:17 +08002190 DumpstateRadioAsRoot();
2191 if (!DropRootUser()) {
2192 return;
2193 }
2194
2195 // Starts thread pool after the root user is dropped. Only one additional
2196 // thread is needed for DumpHals in the DumpstateRadioCommon.
2197 if (ds.dump_pool_) {
2198 ds.dump_pool_->start(/*thread_counts =*/1);
2199 }
2200
mukesh agrawal253dad42018-01-23 21:59:59 -08002201 DumpstateRadioCommon();
2202
2203 printf("========================================================\n");
2204 printf("== Android Framework Services\n");
2205 printf("========================================================\n");
2206
2207 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2208 SEC_TO_MSEC(10));
2209 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2210 SEC_TO_MSEC(10));
2211
2212 printf("========================================================\n");
2213 printf("== dumpstate: done (id %d)\n", ds.id_);
2214 printf("========================================================\n");
2215}
2216
Elis Elliott8e401ad2023-08-08 11:18:59 +00002217// Collects a lightweight dumpstate to be used for debugging onboarding related flows.
2218static void DumpstateOnboardingOnly() {
2219 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2220}
2221
Christopher Ferris83e0e842024-05-31 13:13:34 -07002222static std::string GetTimestamp(const timespec& ts) {
2223 tm tm;
2224 localtime_r(&ts.tv_sec, &tm);
2225
2226 // Reserve enough space for the entire time string, includes the space
2227 // for the '\0' to make the calculations below easier by using size for
2228 // the total string size.
2229 std::string str(sizeof("1970-01-01 00:00:00.123456789+0830"), '\0');
2230 size_t n = strftime(str.data(), str.size(), "%F %H:%M", &tm);
2231 if (n == 0) {
2232 return "TIMESTAMP FAILURE";
2233 }
2234 int num_chars = snprintf(&str[n], str.size() - n, ":%02d.%09ld", tm.tm_sec, ts.tv_nsec);
2235 if (num_chars > str.size() - n) {
2236 return "TIMESTAMP FAILURE";
2237 }
2238 n += static_cast<size_t>(num_chars);
2239 if (strftime(&str[n], str.size() - n, "%z", &tm) == 0) {
2240 return "TIMESTAMP FAILURE";
2241 }
2242 return str;
2243}
2244
2245static std::string GetCmdline(pid_t pid) {
2246 std::string cmdline;
2247 if (!android::base::ReadFileToString(android::base::StringPrintf("/proc/%d/cmdline", pid),
2248 &cmdline)) {
2249 return "UNKNOWN";
2250 }
2251 // There are '\0' terminators between arguments, convert them to spaces.
2252 // But start by skipping all trailing '\0' values.
2253 size_t cur = cmdline.size() - 1;
2254 while (cur != 0 && cmdline[cur] == '\0') {
2255 cur--;
2256 }
2257 if (cur == 0) {
2258 return "UNKNOWN";
2259 }
2260 while ((cur = cmdline.rfind('\0', cur)) != std::string::npos) {
2261 cmdline[cur] = ' ';
2262 }
2263 return cmdline;
2264}
2265
2266static void DumpPidHeader(int fd, pid_t pid, const timespec& ts) {
2267 // For consistency, the header to this message matches the one
2268 // dumped by debuggerd.
2269 dprintf(fd, "\n----- pid %d at %s -----\n", pid, GetTimestamp(ts).c_str());
2270 dprintf(fd, "Cmd line: %s\n", GetCmdline(pid).c_str());
2271}
2272
2273static void DumpPidFooter(int fd, pid_t pid) {
2274 // For consistency, the footer to this message matches the one
2275 // dumped by debuggerd.
2276 dprintf(fd, "----- end %d -----\n", pid);
2277}
2278
2279static bool DumpBacktrace(int fd, pid_t pid, bool is_java_process) {
2280 int ret = dump_backtrace_to_file_timeout(
2281 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
2282 if (ret == -1 && is_java_process) {
2283 // Tried to unwind as a java process, try a native unwind.
2284 dprintf(fd, "Java unwind failed for pid %d, trying a native unwind.\n", pid);
2285 ret = dump_backtrace_to_file_timeout(pid, kDebuggerdNativeBacktrace, 3, fd);
2286 }
2287 return ret != -1;
2288}
2289
Nandana Duttcf419a72019-03-14 10:40:17 +00002290Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002291 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002292 const size_t buf_size = temp_file_pattern.length() + 1;
2293 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2294 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2295
2296 // Create a new, empty file to receive all trace dumps.
2297 //
2298 // TODO: This can be simplified once we remove support for the old style
2299 // dumps. We can have a file descriptor passed in to dump_traces instead
2300 // of creating a file, closing it and then reopening it again.
2301 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2302 if (fd < 0) {
2303 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002304 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002305 }
2306
2307 // Nobody should have access to this temporary file except dumpstate, but we
2308 // temporarily grant 'read' to 'others' here because this file is created
2309 // when tombstoned is still running as root, but dumped after dropping. This
2310 // can go away once support for old style dumping has.
2311 const int chmod_ret = fchmod(fd, 0666);
2312 if (chmod_ret < 0) {
2313 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002314 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002315 }
2316
2317 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2318 if (proc.get() == nullptr) {
2319 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002320 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002321 }
2322
2323 // Number of times process dumping has timed out. If we encounter too many
2324 // failures, we'll give up.
2325 int timeout_failures = 0;
2326 bool dalvik_found = false;
2327
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002328 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002329
2330 struct dirent* d;
2331 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002332 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002333 int pid = atoi(d->d_name);
2334 if (pid <= 0) {
2335 continue;
2336 }
2337
2338 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2339 std::string exe;
2340 if (!android::base::Readlink(link_name, &exe)) {
2341 continue;
2342 }
2343
2344 bool is_java_process;
2345 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2346 // Don't bother dumping backtraces for the zygote.
2347 if (IsZygote(pid)) {
2348 continue;
2349 }
2350
2351 dalvik_found = true;
2352 is_java_process = true;
2353 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2354 is_java_process = false;
2355 } else {
2356 // Probably a native process we don't care about, continue.
2357 continue;
2358 }
2359
2360 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2361 if (timeout_failures == 3) {
2362 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2363 break;
2364 }
2365
Christopher Ferris83e0e842024-05-31 13:13:34 -07002366 timespec start_timespec;
2367 clock_gettime(CLOCK_REALTIME, &start_timespec);
2368 if (IsCached(pid)) {
2369 DumpPidHeader(fd, pid, start_timespec);
2370 dprintf(fd, "Process is cached, skipping backtrace due to high chance of timeout.\n");
2371 DumpPidFooter(fd, pid);
2372 continue;
2373 }
Nandana Duttfaafd522019-03-11 09:23:09 +00002374
Christopher Ferris83e0e842024-05-31 13:13:34 -07002375 const uint64_t start = Nanotime();
2376 if (!DumpBacktrace(fd, pid, is_java_process)) {
2377 if (IsCached(pid)) {
2378 DumpPidHeader(fd, pid, start_timespec);
2379 dprintf(fd, "Backtrace failed, but process has become cached.\n");
2380 DumpPidFooter(fd, pid);
2381 continue;
2382 }
2383
2384 DumpPidHeader(fd, pid, start_timespec);
2385 dprintf(fd, "Backtrace gathering failed, likely due to a timeout.\n");
2386 DumpPidFooter(fd, pid);
2387
2388 dprintf(fd, "\n[dump %s stack %d: %.3fs elapsed]\n",
2389 is_java_process ? "dalvik" : "native", pid,
2390 (float)(Nanotime() - start) / NANOS_PER_SEC);
Nandana Duttfaafd522019-03-11 09:23:09 +00002391 timeout_failures++;
2392 continue;
2393 }
2394
2395 // We've successfully dumped stack traces, reset the failure count
2396 // and write a summary of the elapsed time to the file and continue with the
2397 // next process.
2398 timeout_failures = 0;
2399
2400 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2401 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2402 }
2403
2404 if (!dalvik_found) {
2405 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2406 }
2407
Nandana Duttcf419a72019-03-14 10:40:17 +00002408 *path = file_name_buf.release();
2409 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002410}
2411
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002412static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2413 const Dumpstate::BugreportMode bugreport_mode) {
2414 switch (bugreport_mode) {
2415 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2416 return dumpstate_hal_hidl::DumpstateMode::FULL;
2417 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2418 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2419 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2420 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2421 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2422 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2423 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2424 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2425 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2426 return dumpstate_hal_hidl::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002427 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002428 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2429 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2430 }
2431 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2432}
2433
2434static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2435 const Dumpstate::BugreportMode bugreport_mode) {
2436 switch (bugreport_mode) {
2437 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2438 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2439 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2440 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2441 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2442 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2443 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2444 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2445 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2446 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2447 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2448 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002449 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002450 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2451 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2452 }
2453 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2454}
2455
2456static void DoDumpstateBoardHidl(
2457 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2458 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2459 const Dumpstate::BugreportMode bugreport_mode,
2460 const size_t timeout_sec) {
2461
2462 using ScopedNativeHandle =
2463 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2464 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2465 [](native_handle_t* handle) {
2466 // we don't close file handle's here
2467 // via native_handle_close(handle)
2468 // instead we let dumpstate_fds close the file handles when
2469 // dumpstate_fds gets destroyed
2470 native_handle_delete(handle);
2471 });
2472 if (handle == nullptr) {
2473 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2474 return;
2475 }
2476
2477 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2478 handle.get()->data[i] = dumpstate_fds[i].get();
2479 }
2480
2481 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2482 // implement just 1.0.
2483 const char* descriptor_to_kill;
2484 using DumpstateBoardTask = std::packaged_task<bool()>;
2485 DumpstateBoardTask dumpstate_board_task;
2486 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2487 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2488 if (dumpstate_hal != nullptr) {
2489 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2490
2491 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2492 GetDumpstateHalModeHidl(bugreport_mode);
2493
2494 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2495 dumpstate_board_task =
2496 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2497 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2498 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2499 SEC_TO_MSEC(timeout_sec));
2500 if (!status.isOk()) {
2501 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2502 return false;
2503 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2504 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2505 dumpstate_hal_hidl::toString(status).c_str());
2506 return false;
2507 }
2508 return true;
2509 });
2510 } else {
2511 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2512
2513 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2514 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2515 ::android::hardware::Return<void> status =
2516 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2517 if (!status.isOk()) {
2518 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2519 return false;
2520 }
2521 return true;
2522 });
2523 }
2524 auto result = dumpstate_board_task.get_future();
2525 std::thread(std::move(dumpstate_board_task)).detach();
2526
2527 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2528 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2529 if (!android::base::SetProperty(
2530 "ctl.interface_restart",
2531 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2532 MYLOGE("Couldn't restart dumpstate HAL\n");
2533 }
2534 }
2535 // Wait some time for init to kill dumpstate vendor HAL
2536 constexpr size_t killing_timeout_sec = 10;
2537 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2538 MYLOGE(
2539 "killing dumpstateBoard timed out after %zus, continue and "
2540 "there might be racing in content\n",
2541 killing_timeout_sec);
2542 }
2543}
2544
2545static void DoDumpstateBoardAidl(
2546 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2547 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2548 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2549 MYLOGI("Using IDumpstateDevice AIDL HAL");
2550
2551 const char* descriptor_to_kill;
2552 using DumpstateBoardTask = std::packaged_task<bool()>;
2553 DumpstateBoardTask dumpstate_board_task;
2554 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2555 GetDumpstateHalModeAidl(bugreport_mode);
2556
2557 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2558 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2559 timeout_sec]() -> bool {
2560 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2561
2562 if (!status.isOk()) {
2563 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2564 return false;
2565 }
2566 return true;
2567 });
2568 auto result = dumpstate_board_task.get_future();
2569 std::thread(std::move(dumpstate_board_task)).detach();
2570
2571 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2572 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2573 if (!android::base::SetProperty(
2574 "ctl.interface_restart",
2575 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2576 MYLOGE("Couldn't restart dumpstate HAL\n");
2577 }
2578 }
2579 // Wait some time for init to kill dumpstate vendor HAL
2580 constexpr size_t killing_timeout_sec = 10;
2581 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2582 MYLOGE(
2583 "killing dumpstateBoard timed out after %zus, continue and "
2584 "there might be racing in content\n",
2585 killing_timeout_sec);
2586 }
2587}
2588
2589static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2590 const std::string aidl_instance_name =
2591 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2592
2593 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2594 return nullptr;
2595 }
2596
2597 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2598
2599 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2600}
2601
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002602void Dumpstate::DumpstateBoard(int out_fd) {
2603 dprintf(out_fd, "========================================================\n");
2604 dprintf(out_fd, "== Board\n");
2605 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002606
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002607 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002608 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002609 * set to true and unmount it after invoking dumpstateBoard_* methods.
2610 * This is to enable debug builds to not have debugfs mounted during runtime.
2611 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002612 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002613 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002614 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002615 if (mount_debugfs) {
2616 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2617 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002618 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002619 }
2620
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002621 std::vector<std::string> paths;
2622 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002623 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002624 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2625 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002626 remover.emplace_back(android::base::make_scope_guard(
2627 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002628 }
Jie Song9fbfad02017-06-20 16:29:42 -07002629
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002630 // get dumpstate HAL AIDL implementation
2631 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2632 GetDumpstateBoardAidlService());
2633 if (dumpstate_hal_handle_aidl == nullptr) {
2634 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2635 }
2636
2637 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2638 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2639 if (dumpstate_hal_handle_aidl == nullptr) {
2640 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2641 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2642 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2643 }
2644 }
2645
2646 // if neither HIDL nor AIDL implementation found, then return
2647 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2648 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002649 return;
2650 }
2651
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002652 // this is used to hold the file descriptors and when this variable goes out of scope
2653 // the file descriptors are closed
2654 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002655
Nandana Dutt5c390032019-03-12 10:52:56 +00002656 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002657 for (size_t i = 0; i < paths.size(); i++) {
2658 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2659
2660 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2661 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2662 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2663 if (fd < 0) {
2664 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2665 return;
2666 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002667
2668 dumpstate_fds.emplace_back(fd.release());
2669 // we call fd.release() here to make sure "fd" does not get closed
2670 // after "fd" goes out of scope after this block.
2671 // "fd" will be closed when "dumpstate_fds" goes out of scope
2672 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002673 }
2674
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002675 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2676 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2677 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002678 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002679
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002680 if (dumpstate_hal_handle_aidl != nullptr) {
2681 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2682 timeout_sec);
2683 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2684 // run HIDL HAL only if AIDL HAL not found
2685 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2686 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002687 }
2688
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002689 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002690 auto keep_debugfs_mounted =
2691 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2692 if (keep_debugfs_mounted.empty())
2693 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002694 }
2695
Wei Wang587eac92018-04-05 12:17:20 -07002696 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2697 for (size_t i = 0; i < paths.size(); i++) {
2698 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002699 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2700 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002701 file_sizes[i] = -1;
2702 continue;
2703 }
2704 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002705 }
2706
2707 for (size_t i = 0; i < paths.size(); i++) {
2708 if (file_sizes[i] == -1) {
2709 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002710 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002711 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002712 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002713 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002714 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002715 remover[i].Disable();
2716 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2717 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002718 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002719}
2720
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002721static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002722 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002723 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2724 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002725 " -h: display this help message\n"
2726 " -b: play sound file instead of vibrate, at beginning of job\n"
2727 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002728 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002729 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002730 " -s: write zipped file to control socket (for init)\n"
2731 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002732 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002733 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002734 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002735 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002736 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002737 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002738}
2739
Wei Liuf87959e2016-08-26 14:51:42 -07002740static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002741 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002742}
2743
Felipe Leme1d486fe2016-10-14 18:06:47 -07002744bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002745 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2746 if (zip_entry_tasks_) {
2747 zip_entry_tasks_->run(/* do_cancel = */false);
2748 }
2749
Felipe Leme9a523ae2016-10-20 15:10:33 -07002750 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002751 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002752 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002753 // Final timestamp
2754 char date[80];
2755 time_t the_real_now_please_stand_up = time(nullptr);
2756 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002757 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002758 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002759
Felipe Leme9a523ae2016-10-20 15:10:33 -07002760 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002761 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002762 return false;
2763 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002764 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002765 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002766 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002767 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002768
Felipe Leme0f3fb202016-06-10 17:10:53 -07002769 // Add log file (which contains stderr output) to zip...
2770 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002771 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002772 MYLOGE("Failed to add dumpstate log to .zip file\n");
2773 return false;
2774 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002775 // TODO: Should truncate the existing file.
2776 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002777 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2778 return false;
2779 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002780 fprintf(stderr, "\n");
2781
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002782 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002783 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002784 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002785 return false;
2786 }
2787
Felipe Leme1d486fe2016-10-14 18:06:47 -07002788 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2789 ds.zip_file.reset(nullptr);
2790
Felipe Lemee9d2c542016-11-15 11:48:26 -08002791 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002792 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002793
Felipe Leme1e9edc62015-12-21 16:02:13 -08002794 return true;
2795}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002796
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002797static void SendBroadcast(const std::string& action,
2798 const std::vector<std::string>& args,
2799 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002800 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002801 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2802 std::to_string(user_id), "--receiver-foreground",
2803 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002804 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002805
2806 am.insert(am.end(), args.begin(), args.end());
2807
Felipe Leme8d2410e2017-02-08 09:46:08 -08002808 RunCommand("", am,
2809 CommandOptions::WithTimeout(20)
2810 .Log("Sending broadcast: '%s'\n")
2811 .Always()
2812 .DropRoot()
2813 .RedirectStderr()
2814 .Build());
2815}
2816
Felipe Leme35b8cf12017-02-10 15:47:29 -08002817static void Vibrate(int duration_ms) {
2818 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002819 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2820 "oneshot", std::to_string(duration_ms)};
2821 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002822 CommandOptions::WithTimeout(10)
2823 .Log("Vibrate: '%s'\n")
2824 .Always()
2825 .Build());
2826 // clang-format on
2827}
2828
Nandana Dutt979388e2018-11-30 16:48:55 +00002829static void MaybeResolveSymlink(std::string* path) {
2830 std::string resolved_path;
2831 if (android::base::Readlink(*path, &resolved_path)) {
2832 *path = resolved_path;
2833 }
2834}
2835
Nandana Dutt4be45d12018-09-26 15:04:23 +01002836/*
2837 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002838 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002839 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002840static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002841 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2842
Nandana Dutt4be45d12018-09-26 15:04:23 +01002843 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2844 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002845 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002846 char date[80];
2847 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2848 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002849
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002850 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002851 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002852 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002853 ds.base_name_ += "-wifi";
2854 }
2855
Paul Chang0d2aad72020-02-13 20:04:03 +08002856 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002857 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002858 }
2859 ds.tmp_path_ = ds.GetPath(".tmp");
2860 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2861
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002862 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002863 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002864 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002865 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002866 "Bugreport dir: [%s] "
2867 "Base name: [%s] "
2868 "Suffix: [%s] "
2869 "Log path: [%s] "
2870 "Temporary path: [%s] "
2871 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002872 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2873 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002874
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002875 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2876 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2877 create_parent_dirs(ds.path_.c_str());
2878 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2879 if (ds.zip_file == nullptr) {
2880 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2881 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002882 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002883 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2884 ds.AddTextZipEntry("version.txt", ds.version_);
2885 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002886}
2887
2888/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002889 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002890 * printing zipped file status, etc.
2891 */
2892static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002893 bool do_text_file = !ds.FinishZipFile();
2894 if (do_text_file) {
2895 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002896 }
mhasank2d75c442020-06-11 15:05:25 -07002897
2898 std::string final_path = ds.path_;
2899 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002900 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002901 android::os::CopyFileToFile(ds.path_, final_path);
2902 }
2903
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002904 if (ds.options_->stream_to_socket) {
2905 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2906 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002907 if (do_text_file) {
2908 dprintf(ds.control_socket_fd_,
2909 "FAIL:could not create zip file, check %s "
2910 "for more details\n",
2911 ds.log_path_.c_str());
2912 } else {
mhasank2d75c442020-06-11 15:05:25 -07002913 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002914 }
2915 }
2916}
2917
Nandana Dutt4be45d12018-09-26 15:04:23 +01002918
Nandana Dutt58d72e22018-11-16 10:30:48 +00002919static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2920 switch (mode) {
2921 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2922 return "BUGREPORT_FULL";
2923 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2924 return "BUGREPORT_INTERACTIVE";
2925 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2926 return "BUGREPORT_REMOTE";
2927 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2928 return "BUGREPORT_WEAR";
2929 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2930 return "BUGREPORT_TELEPHONY";
2931 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2932 return "BUGREPORT_WIFI";
Elis Elliott8e401ad2023-08-08 11:18:59 +00002933 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2934 return "BUGREPORT_ONBOARDING";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002935 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2936 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002937 }
2938}
2939
Steven Leeb573eb82022-11-29 22:31:35 +08002940static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2941 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2942 return !options.telephony_only;
2943}
2944
Paul Changf59c2b72020-03-10 02:08:55 +08002945static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2946 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002947 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2948 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002949 options->bugreport_mode = mode;
2950 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002951 switch (mode) {
2952 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002953 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002954 break;
2955 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002956 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002957 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002958 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002959 break;
2960 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002961 options->do_vibrate = false;
2962 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002963 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002964 break;
2965 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002966 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002967 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002968 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002969 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002970 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002971 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002972 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002973 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002974 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002975 break;
2976 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002977 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002978 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002979 break;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002980 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2981 options->onboarding_only = true;
2982 options->do_screenshot = false;
2983 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002984 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2985 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002986 }
2987}
2988
Nandana Dutt58d72e22018-11-16 10:30:48 +00002989static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002990 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002991 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002992 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002993 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002994 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002995 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002996 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002997 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002998 options.do_progress_updates, options.bugreport_fd.get(),
2999 options.bugreport_mode_string.c_str(),
3000 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00003001}
3002
Nandana Dutt54dbd672019-01-11 12:58:05 +00003003void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00003004 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00003005 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08003006 const android::base::unique_fd& screenshot_fd_in,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003007 bool is_screenshot_requested,
3008 bool skip_user_consent) {
Kean Mariotti306633e2022-09-05 16:30:47 +00003009 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003010 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003011 this->skip_user_consent = skip_user_consent;
Nandana Dutt54dbd672019-01-11 12:58:05 +00003012 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00003013 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
3014 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00003015
Paul Changf59c2b72020-03-10 02:08:55 +08003016 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00003017}
3018
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003019Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
3020 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003021 int c;
mhasankd451a472020-05-26 18:02:39 -07003022 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003023 switch (c) {
3024 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07003025 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003026 case 's': stream_to_socket = true; break;
3027 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003028 case 'v': show_header_only = true; break;
3029 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08003030 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003031 case 'P': do_progress_updates = true; break;
3032 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07003033 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003034 case 'V':
3035 case 'd':
3036 case 'z':
3037 // compatibility no-op
3038 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00003039 case 'w':
3040 // This was already processed
3041 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003042 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003043 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003044 break;
3045 default:
3046 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003047 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003048 break;
3049 // clang-format on
3050 }
3051 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08003052
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003053 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003054 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003055 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003056 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003057 }
3058 }
3059
3060 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
3061 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003062
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003063 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003064}
3065
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003066bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003067 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00003068 return false;
3069 }
3070
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003071 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003072 return false;
3073 }
3074
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003075 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003076 return false;
3077 }
3078 return true;
3079}
3080
Nandana Dutt197661d2018-11-16 16:40:21 +00003081void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
3082 options_ = std::move(options);
3083}
3084
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003085void Dumpstate::Initialize() {
3086 /* gets the sequential id */
3087 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
3088 id_ = ++last_id;
3089 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
3090}
3091
Nandana Duttd2f5f082019-01-18 17:13:52 +00003092Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
3093 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003094 HandleRunStatus(status);
3095 return status;
3096}
3097
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003098Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003099 const bool keep_bugreport_on_retrieval,
3100 const bool skip_user_consent) {
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003101 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003102 keep_bugreport_on_retrieval,
3103 skip_user_consent);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003104 HandleRunStatus(status);
3105 return status;
3106}
3107
3108Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003109 const std::string& calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003110 const bool keep_bugreport_on_retrieval,
3111 const bool skip_user_consent) {
3112 if (!android::app::admin::flags::onboarding_consentless_bugreports() || !skip_user_consent) {
3113 consent_callback_ = new ConsentCallback();
3114 const String16 incidentcompanion("incidentcompanion");
3115 sp<android::IBinder> ics(
3116 defaultServiceManager()->checkService(incidentcompanion));
3117 android::String16 package(calling_package.c_str());
3118 if (ics != nullptr) {
3119 MYLOGD("Checking user consent via incidentcompanion service\n");
3120
3121 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
3122 calling_uid, package, String16(), String16(),
3123 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
3124 } else {
3125 MYLOGD(
3126 "Unable to check user consent; incidentcompanion service unavailable\n");
3127 return RunStatus::USER_CONSENT_TIMED_OUT;
3128 }
3129 UserConsentResult consent_result = consent_callback_->getResult();
3130 int timeout_ms = 30 * 1000;
3131 while (consent_result == UserConsentResult::UNAVAILABLE &&
3132 consent_callback_->getElapsedTimeMs() < timeout_ms) {
3133 sleep(1);
3134 consent_result = consent_callback_->getResult();
3135 }
3136 if (consent_result == UserConsentResult::DENIED) {
3137 return RunStatus::USER_CONSENT_DENIED;
3138 }
3139 if (consent_result == UserConsentResult::UNAVAILABLE) {
3140 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3141 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3142 consent_callback_.get());
3143 return RunStatus::USER_CONSENT_TIMED_OUT;
3144 }
Gavin Corkerya44686c2022-11-23 18:16:51 +00003145 }
3146
3147 bool copy_succeeded =
3148 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003149
3150 if (copy_succeeded && (!android::app::admin::flags::onboarding_bugreport_v2_enabled()
3151 || !keep_bugreport_on_retrieval)) {
3152 android::os::UnlinkAndLogOnError(path_);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003153 }
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003154
Gavin Corkerya44686c2022-11-23 18:16:51 +00003155 return copy_succeeded ? Dumpstate::RunStatus::OK
3156 : Dumpstate::RunStatus::ERROR;
3157}
3158
3159void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
3160 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00003161 switch (status) {
3162 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00003163 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00003164 break;
3165 case Dumpstate::RunStatus::HELP:
3166 break;
3167 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003168 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003169 break;
3170 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003171 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
3172 break;
3173 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3174 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
3175 break;
3176 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
3177 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003178 break;
3179 }
3180 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003181}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003182void Dumpstate::Cancel() {
3183 CleanupTmpFiles();
3184 android::os::UnlinkAndLogOnError(log_path_);
3185 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3186 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3187 kDumpstateBoardFiles[i]);
3188 }
3189 tombstone_data_.clear();
3190 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003191 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003192 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003193
3194 // Instead of shutdown the pool, we delete temporary files directly since
3195 // shutdown blocking the call.
3196 if (dump_pool_) {
3197 dump_pool_->deleteTempFiles();
3198 }
3199 if (zip_entry_tasks_) {
3200 zip_entry_tasks_->run(/*do_cancel =*/ true);
3201 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003202}
3203
Kean Mariotti306633e2022-09-05 16:30:47 +00003204void Dumpstate::PreDumpUiData() {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003205 auto snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Kean Mariotti306633e2022-09-05 16:30:47 +00003206 MaybeSnapshotUiTraces();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003207 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Kean Mariotti306633e2022-09-05 16:30:47 +00003208}
3209
Nandana Dutt979388e2018-11-30 16:48:55 +00003210/*
3211 * Dumps relevant information to a bugreport based on the given options.
3212 *
3213 * The bugreport can be dumped to a file or streamed to a socket.
3214 *
3215 * How dumping to file works:
3216 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3217 * stderr is redirected a log file.
3218 *
3219 * The temporary bugreport is then populated via printfs, dumping contents of files and
3220 * output of commands to stdout.
3221 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003222 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003223 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003224 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003225 *
mhasank2d75c442020-06-11 15:05:25 -07003226 * Bugreports are first generated in a local directory and later copied to the caller's fd
3227 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003228 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003229Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3230 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003231 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003232 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003233 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003234 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003235 return RunStatus::INVALID_INPUT;
3236 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003237 /* set as high priority, and protect from OOM killer */
3238 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003239
Felipe Lemed071c682016-10-20 16:48:00 -07003240 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003241 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003242 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003243 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003244 } else {
3245 /* fallback to kernels <= 2.6.35 */
3246 oom_adj = fopen("/proc/self/oom_adj", "we");
3247 if (oom_adj) {
3248 fputs("-17", oom_adj);
3249 fclose(oom_adj);
3250 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003251 }
3252
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003253 if (version_ == VERSION_DEFAULT) {
3254 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003255 }
3256
Chris Morin5a50d482022-02-01 17:41:18 -08003257 if (version_ != VERSION_CURRENT) {
3258 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3259 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003260 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003261 }
3262
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003263 if (options_->show_header_only) {
3264 PrintHeader();
3265 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003266 }
3267
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003268 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3269 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003270
Felipe Leme7447d7c2016-11-03 18:12:22 -07003271 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003272 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003273 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003274 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003275
Sahana Raof35ed432019-07-12 10:47:52 +01003276 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3277 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3278 } else {
3279 // Wake lock will be released automatically on process death
3280 MYLOGD("Wake lock acquired.\n");
3281 }
3282
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003283 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003284
Felipe Lemef0292972016-11-22 13:57:05 -08003285 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003286 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3287 }
3288
Kevin Jeonfa64e642023-07-27 11:36:41 -04003289 if (PropertiesHelper::IsStrictRun()) {
3290 MYLOGI(
3291 "Running on strict-run mode, which has shorter timeouts "
3292 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3293 }
3294
Nandana Dutt235c6672019-11-14 15:22:32 +00003295 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003296 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003297
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003298 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003299
Christopher Ferrised9354f2014-10-01 17:35:01 -07003300 // If we are going to use a socket, do it as early as possible
3301 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003302 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003303 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003304 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003305 if (control_socket_fd_ == -1) {
3306 return ERROR;
3307 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003308 if (options_->progress_updates_to_socket) {
3309 options_->do_progress_updates = 1;
3310 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003311 }
3312
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003313 if (!PrepareToWriteToFile()) {
3314 return ERROR;
3315 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003316
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003317 // Interactive, wear & telephony modes are default to true.
3318 // and may enable from cli option or when using control socket
3319 if (options_->do_progress_updates) {
3320 // clang-format off
3321 std::vector<std::string> am_args = {
3322 "--receiver-permission", "android.permission.DUMP",
3323 };
3324 // clang-format on
3325 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003326 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3327 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003328 if (options_->progress_updates_to_socket) {
3329 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003330 }
3331 }
3332
Nick Kralevichf3599b32016-01-25 15:05:16 -08003333 /* read /proc/cmdline before dropping root */
3334 FILE *cmdline = fopen("/proc/cmdline", "re");
3335 if (cmdline) {
3336 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3337 fclose(cmdline);
3338 }
3339
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003340 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003341 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003342 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003343
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003344 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003345 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3346 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003347 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003348 }
3349 }
3350
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003351 int dup_stdout_fd;
3352 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003353 // Redirect stderr to log_path_ for debugging.
3354 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3355 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3356 return ERROR;
3357 }
3358 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3359 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3360 strerror(errno));
3361 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003362
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003363 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3364 // moved into zip file later, if zipping.
3365 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3366 // TODO: why not write to a file instead of stdout to overcome this problem?
3367 /* TODO: rather than generating a text file now and zipping it later,
3368 it would be more efficient to redirect stdout to the zip entry
3369 directly, but the libziparchive doesn't support that option yet. */
3370 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3371 return ERROR;
3372 }
3373 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3374 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3375 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003376 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003377
3378 // Don't buffer stdout
3379 setvbuf(stdout, nullptr, _IONBF, 0);
3380
Rhed Jao5377d792020-07-16 17:37:39 +08003381 // Enable the parallel run if the client requests to output to a file.
3382 EnableParallelRunIfNeeded();
3383 // Using scope guard to make sure the dump pool can be shut down correctly.
3384 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3385 ShutdownDumpPool();
3386 });
3387
Felipe Leme608385d2016-02-01 10:35:38 -08003388 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3389 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003390 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003391 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003392
Kean Mariottic14cebc2024-03-04 10:55:28 +00003393 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
3394 if (options_->use_predumped_ui_data && !system_trace_exists) {
3395 MYLOGW("Ignoring 'use predumped data' flag because no predumped data is available");
3396 options_->use_predumped_ui_data = false;
3397 }
3398
Kean Mariottica20f2d2023-12-15 09:34:25 +00003399 std::future<std::string> snapshot_system_trace;
3400
Kean Mariotti853b73a2023-07-27 12:40:30 +00003401 bool is_dumpstate_restricted =
3402 options_->telephony_only || options_->wifi_only || options_->limited_only;
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003403 if (!is_dumpstate_restricted) {
3404 // Snapshot the system trace now (if running) to avoid that dumpstate's
3405 // own activity pushes out interesting data from the trace ring buffer.
3406 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
Kean Mariottica20f2d2023-12-15 09:34:25 +00003407 snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003408
Kean Mariotti853b73a2023-07-27 12:40:30 +00003409 // Invoke critical dumpsys to preserve system state, before doing anything else.
3410 RunDumpsysCritical();
3411
Kean Mariotti306633e2022-09-05 16:30:47 +00003412 // Snapshot the UI traces now (if running).
3413 // The trace files will be added to bugreport later.
3414 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003415 }
Kean Mariotti853b73a2023-07-27 12:40:30 +00003416
3417 MaybeTakeEarlyScreenshot();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003418 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Gavin Corkery6968f552020-11-22 18:09:05 +00003419 onUiIntensiveBugreportDumpsFinished(calling_uid);
3420 MaybeCheckUserConsent(calling_uid, calling_package);
3421 if (options_->telephony_only) {
3422 DumpstateTelephonyOnly(calling_package);
3423 } else if (options_->wifi_only) {
3424 DumpstateWifiOnly();
3425 } else if (options_->limited_only) {
3426 DumpstateLimitedOnly();
Elis Elliott8e401ad2023-08-08 11:18:59 +00003427 } else if (options_->onboarding_only) {
3428 DumpstateOnboardingOnly();
Gavin Corkery6968f552020-11-22 18:09:05 +00003429 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003430 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003431 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003432 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003433 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003434 HandleUserConsentDenied();
3435 }
3436 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003437 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003438 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003439
Felipe Leme55b42a62015-11-10 17:39:08 -08003440 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003441 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003442
Abhijeet Kaure370d682019-10-01 16:49:30 +01003443 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003444 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003445 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003446 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003447
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003448 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003449 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003450 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003451 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003452 if (status != Dumpstate::RunStatus::OK &&
3453 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3454 // Do an early return if there were errors. We make an exception for consent
3455 // timing out because it's possible the user got distracted. In this case the
3456 // bugreport is not shared but made available for manual retrieval.
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003457 MYLOGI("Bug report generation failed, this could have been due to"
3458 " several reasons such as BR copy failed, user consent was"
3459 " not grated etc. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003460 return status;
3461 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003462 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3463 MYLOGI(
3464 "Did not receive user consent yet."
3465 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003466 const String16 incidentcompanion("incidentcompanion");
3467 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3468 if (ics != nullptr) {
3469 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3470 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3471 consent_callback_.get());
3472 } else {
3473 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3474 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003475 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003476 }
3477
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003478 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003479 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003480 for (int i = 0; i < 3; i++) {
3481 Vibrate(75);
3482 usleep((75 + 50) * 1000);
3483 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003484 }
3485
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003486 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3487 progress_->GetInitialMax());
3488 progress_->Save();
3489 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003490
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003491 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003492
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003493 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003494 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003495 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003496 }
3497
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003498 tombstone_data_.clear();
3499 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003500 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003501 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003502
Nandana Duttd2f5f082019-01-18 17:13:52 +00003503 return (consent_callback_ != nullptr &&
3504 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3505 ? USER_CONSENT_TIMED_OUT
3506 : RunStatus::OK;
3507}
3508
Paul Chang0d2aad72020-02-13 20:04:03 +08003509void Dumpstate::MaybeTakeEarlyScreenshot() {
3510 if (!options_->do_screenshot || !do_early_screenshot_) {
3511 return;
3512 }
3513
3514 TakeScreenshot();
3515}
3516
Kean Mariottica20f2d2023-12-15 09:34:25 +00003517std::future<std::string> Dumpstate::MaybeSnapshotSystemTraceAsync() {
Kean Mariotti853b73a2023-07-27 12:40:30 +00003518 // When capturing traces via bugreport handler (BH), this function will be invoked twice:
3519 // 1) When BH invokes IDumpstate::PreDumpUiData()
3520 // 2) When BH invokes IDumpstate::startBugreport(flags = BUGREPORT_USE_PREDUMPED_UI_DATA)
3521 // In this case we don't want to re-invoke perfetto in step 2.
3522 // In all other standard invocation states, this function is invoked once
3523 // without the flag BUGREPORT_USE_PREDUMPED_UI_DATA.
Kean Mariottica20f2d2023-12-15 09:34:25 +00003524 // This function must run asynchronously to avoid delaying MaybeTakeEarlyScreenshot() in the
3525 // standard invocation states (b/316110955).
Kean Mariotti853b73a2023-07-27 12:40:30 +00003526 if (options_->use_predumped_ui_data) {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003527 return {};
3528 }
3529
3530 // Create temporary file for the command's output
3531 std::string outPath = ds.bugreport_internal_dir_ + "/tmp_serialize_perfetto_trace";
3532 auto outFd = android::base::unique_fd(TEMP_FAILURE_RETRY(
3533 open(outPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
3534 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
3535 if (outFd < 0) {
3536 MYLOGE("Could not open %s to serialize perfetto trace.\n", outPath.c_str());
3537 return {};
Kean Mariotti853b73a2023-07-27 12:40:30 +00003538 }
3539
3540 // If a stale file exists already, remove it.
3541 unlink(SYSTEM_TRACE_SNAPSHOT);
3542
Kean Mariottica20f2d2023-12-15 09:34:25 +00003543 MYLOGI("Launching async '%s'", SERIALIZE_PERFETTO_TRACE_TASK.c_str())
3544 return std::async(
3545 std::launch::async, [this, outPath = std::move(outPath), outFd = std::move(outFd)] {
3546 // If a background system trace is happening and is marked as "suitable for
3547 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3548 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3549 // case that no trace is ongoing, this command is a no-op.
3550 // Note: this should not be enqueued as we need to freeze the trace before
3551 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3552 // the dumpstate's own activity which is irrelevant.
3553 RunCommand(
3554 SERIALIZE_PERFETTO_TRACE_TASK, {"perfetto", "--save-for-bugreport"},
Kean Mariotti5aa8d152024-09-23 12:10:09 +00003555 CommandOptions::WithTimeout(30).DropRoot().CloseAllFileDescriptorsOnExec().Build(),
Kean Mariottica20f2d2023-12-15 09:34:25 +00003556 false, outFd);
3557 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3558 // file in the later stages.
3559
3560 return outPath;
3561 });
3562}
3563
3564void Dumpstate::MaybeWaitForSnapshotSystemTrace(std::future<std::string> task) {
3565 if (!task.valid()) {
3566 return;
3567 }
3568
3569 WaitForTask(std::move(task), SERIALIZE_PERFETTO_TRACE_TASK, STDOUT_FILENO);
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003570}
3571
Kean Mariotti306633e2022-09-05 16:30:47 +00003572void Dumpstate::MaybeSnapshotUiTraces() {
3573 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3574 return;
3575 }
3576
Pablo Gamito654831c2024-02-16 16:47:48 +00003577 std::vector<std::vector<std::string>> dumpTracesForBugReportCommands = {
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003578 {"cmd", "input_method", "tracing", "save-for-bugreport"},
3579 {"cmd", "window", "tracing", "save-for-bugreport"},
3580 {"cmd", "window", "shell", "tracing", "save-for-bugreport"},
3581 };
Hongwei Wang39229132023-01-24 15:09:59 -08003582
Pablo Gamito654831c2024-02-16 16:47:48 +00003583 if (!android_tracing_perfetto_transition_tracing()) {
3584 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3585 "SystemUIService", "WMShell", "transitions",
3586 "tracing", "save-for-bugreport"});
3587 }
3588
Pablo Gamito6929a0e2024-02-26 23:29:47 +00003589 if (!android_tracing_perfetto_protolog_tracing()) {
Pablo Gamito654831c2024-02-16 16:47:48 +00003590 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3591 "SystemUIService", "WMShell", "protolog",
3592 "save-for-bugreport"});
3593 }
3594
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003595 for (const auto& command : dumpTracesForBugReportCommands) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003596 RunCommand(
3597 // Empty name because it's not intended to be classified as a bugreport section.
3598 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003599 "", command,
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003600 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3601 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003602}
3603
3604void Dumpstate::MaybeAddUiTracesToZip() {
3605 if (PropertiesHelper::IsUserBuild()) {
3606 return;
3607 }
3608
3609 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003610}
3611
Paul Changeb4b4642020-05-28 22:05:47 +08003612void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003613 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003614 return;
3615 }
3616 if (listener_ != nullptr) {
3617 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3618 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003619 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003620 }
3621}
3622
Jichao Lie89d9c12019-11-21 19:02:51 -08003623void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003624 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003625 !CalledByApi() || options_->is_consent_deferred ||
3626 (android::app::admin::flags::onboarding_consentless_bugreports() &&
3627 options_->skip_user_consent)) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003628 // No need to get consent for shell triggered dumpstates, or not
3629 // through bugreporting API (i.e. no fd to copy back), or when consent
3630 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003631 return;
3632 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003633 consent_callback_ = new ConsentCallback();
3634 const String16 incidentcompanion("incidentcompanion");
3635 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003636 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003637 if (ics != nullptr) {
3638 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003639 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3640 if (IsConsentlessBugreportAllowed(*options_)) {
3641 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3642 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003643 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003644 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003645 } else {
3646 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3647 }
3648}
3649
Nandana Dutt5c390032019-03-12 10:52:56 +00003650bool Dumpstate::IsUserConsentDenied() const {
3651 return ds.consent_callback_ != nullptr &&
3652 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3653}
3654
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003655bool Dumpstate::CalledByApi() const {
3656 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3657}
3658
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003659void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003660 android::os::UnlinkAndLogOnError(tmp_path_);
3661 android::os::UnlinkAndLogOnError(screenshot_path_);
3662 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003663 if (dump_traces_path != nullptr) {
3664 android::os::UnlinkAndLogOnError(dump_traces_path);
3665 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003666}
3667
Rhed Jao5377d792020-07-16 17:37:39 +08003668void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003669 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003670 return;
3671 }
3672 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003673 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003674}
3675
3676void Dumpstate::ShutdownDumpPool() {
3677 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003678 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003679 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003680 if (zip_entry_tasks_) {
3681 zip_entry_tasks_->run(/* do_cancel = */true);
3682 zip_entry_tasks_ = nullptr;
3683 }
3684}
3685
3686void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3687 const std::string& entry_path) {
3688 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3689 if (!task_cancelled) {
3690 AddZipEntry(entry_name, entry_path);
3691 }
3692 android::os::UnlinkAndLogOnError(entry_path);
3693 };
3694 if (zip_entry_tasks_) {
3695 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3696 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3697 } else {
3698 // Invokes AddZipEntryAndCleanup immediately
3699 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3700 }
Rhed Jao5377d792020-07-16 17:37:39 +08003701}
3702
Nandana Duttd2f5f082019-01-18 17:13:52 +00003703Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3704 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003705 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003706 return USER_CONSENT_DENIED;
3707}
3708
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003709Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003710 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003711 // user consent (unless the caller is Shell).
3712 UserConsentResult consent_result;
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003713 if (multiuser_get_app_id(calling_uid) == AID_SHELL || (options_->skip_user_consent
3714 && android::app::admin::flags::onboarding_consentless_bugreports())) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003715 consent_result = UserConsentResult::APPROVED;
3716 } else {
3717 consent_result = consent_callback_->getResult();
3718 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003719 if (consent_result == UserConsentResult::UNAVAILABLE) {
3720 // User has not responded yet.
3721 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003722 // Telephony is a fast report type, particularly on user builds where information may be
3723 // more aggressively limited. To give the user time to read the consent dialog, increase the
3724 // timeout.
3725 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3726 : USER_CONSENT_TIMEOUT_MS;
3727 if (elapsed_ms < timeout_ms) {
3728 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003729 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3730 sleep(delay_seconds);
3731 }
3732 consent_result = consent_callback_->getResult();
3733 }
3734 if (consent_result == UserConsentResult::DENIED) {
3735 // User has explicitly denied sharing with the app. To be safe delete the
3736 // internal bugreport & tmp files.
3737 return HandleUserConsentDenied();
3738 }
3739 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003740 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3741 if (copy_succeeded) {
3742 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003743 if (options_->do_screenshot &&
3744 options_->screenshot_fd.get() != -1 &&
3745 !options_->is_screenshot_copied) {
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003746 bool is_screenshot_copied = android::os::CopyFileToFd(screenshot_path_,
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003747 options_->screenshot_fd.get());
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003748 if (is_screenshot_copied) {
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003749 android::os::UnlinkAndLogOnError(screenshot_path_);
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003750 } else {
3751 MYLOGE("Failed to copy screenshot to a permanent file.\n");
3752 is_screenshot_copied = android::os::CopyFileToFd(DEFAULT_SCREENSHOT_PATH,
3753 options_->screenshot_fd.get());
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003754 }
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003755 options_->is_screenshot_copied = is_screenshot_copied;
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003756 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003757 }
3758 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3759 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3760 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3761 // Since we do not have user consent to share the bugreport it does not get
3762 // copied over to the calling app but remains in the internal directory from
3763 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003764 std::string final_path = GetPath(".zip");
3765 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3766 if (copy_succeeded) {
3767 android::os::UnlinkAndLogOnError(path_);
3768 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003769 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3770 }
3771 // Unknown result; must be a programming error.
3772 MYLOGE("Unknown user consent result:%d\n", consent_result);
3773 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003774}
3775
Nandana Duttf02564e2019-02-15 15:24:24 +00003776Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003777 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3778 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3779 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003780 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003781 // When directly running dumpstate binary, the output is not expected to be written
3782 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003783 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003784
3785 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003786 // an app; they are irrelevant here because bugreport is triggered via command line.
3787 // Update Last ID before calling Run().
3788 Initialize();
Nikhil Kumarb70622a2023-06-15 15:37:19 +01003789 status = Run(0 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003790 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003791 return status;
3792}
3793
3794/* Main entry point for dumpstate binary. */
3795int run_main(int argc, char* argv[]) {
3796 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003797
3798 switch (status) {
3799 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003800 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003801 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003802 ShowUsage();
3803 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003804 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003805 fprintf(stderr, "Invalid combination of args\n");
3806 ShowUsage();
3807 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003808 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003809 FALLTHROUGH_INTENDED;
3810 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3811 FALLTHROUGH_INTENDED;
3812 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003813 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003814 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003815}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003816
3817// TODO(111441001): Default DumpOptions to sensible values.
3818Dumpstate::Dumpstate(const std::string& version)
3819 : pid_(getpid()),
3820 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003821 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003822 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003823 now_(time(nullptr)),
3824 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003825}
3826
3827Dumpstate& Dumpstate::GetInstance() {
3828 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3829 return singleton_;
3830}
3831
Rhed Jao5377d792020-07-16 17:37:39 +08003832DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3833 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3834 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003835 if (!title_.empty()) {
3836 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003837 if (title_.find("SHOW MAP") == std::string::npos) {
3838 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3839 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003840 }
3841}
3842
3843DurationReporter::~DurationReporter() {
3844 if (!title_.empty()) {
3845 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003846 if (elapsed >= 1.0f || verbose_) {
chenqiwuaf8b2d92019-12-12 18:53:51 +08003847 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003848 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003849 if (!logcat_only_) {
3850 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003851 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3852 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003853 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003854 if (title_.find("SHOW MAP") == std::string::npos) {
3855 ATRACE_ASYNC_END(title_.c_str(), 0);
3856 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003857 }
3858}
3859
3860const int32_t Progress::kDefaultMax = 5000;
3861
3862Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3863}
3864
3865Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3866 : Progress(initial_max, growth_factor, "") {
3867 progress_ = progress;
3868}
3869
3870Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3871 : initial_max_(initial_max),
3872 progress_(0),
3873 max_(initial_max),
3874 growth_factor_(growth_factor),
3875 n_runs_(0),
3876 average_max_(0),
3877 path_(path) {
3878 if (!path_.empty()) {
3879 Load();
3880 }
3881}
3882
3883void Progress::Load() {
3884 MYLOGD("Loading stats from %s\n", path_.c_str());
3885 std::string content;
3886 if (!android::base::ReadFileToString(path_, &content)) {
3887 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3888 return;
3889 }
3890 if (content.empty()) {
3891 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3892 return;
3893 }
3894 std::vector<std::string> lines = android::base::Split(content, "\n");
3895
3896 if (lines.size() < 1) {
3897 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3898 (int)lines.size(), max_);
3899 return;
3900 }
3901 char* ptr;
3902 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3903 average_max_ = strtol(ptr, nullptr, 10);
3904 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3905 average_max_ > STATS_MAX_AVERAGE) {
3906 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3907 initial_max_ = Progress::kDefaultMax;
3908 } else {
3909 initial_max_ = average_max_;
3910 }
3911 max_ = initial_max_;
3912
3913 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3914}
3915
3916void Progress::Save() {
3917 int32_t total = n_runs_ * average_max_ + progress_;
3918 int32_t runs = n_runs_ + 1;
3919 int32_t average = floor(((float)total) / runs);
3920 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3921 path_.c_str());
3922 if (path_.empty()) {
3923 return;
3924 }
3925
3926 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3927 if (!android::base::WriteStringToFile(content, path_)) {
3928 MYLOGE("Could not save stats on %s\n", path_.c_str());
3929 }
3930}
3931
3932int32_t Progress::Get() const {
3933 return progress_;
3934}
3935
3936bool Progress::Inc(int32_t delta_sec) {
3937 bool changed = false;
3938 if (delta_sec >= 0) {
3939 progress_ += delta_sec;
3940 if (progress_ > max_) {
3941 int32_t old_max = max_;
3942 max_ = floor((float)progress_ * growth_factor_);
3943 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3944 changed = true;
3945 }
3946 }
3947 return changed;
3948}
3949
3950int32_t Progress::GetMax() const {
3951 return max_;
3952}
3953
3954int32_t Progress::GetInitialMax() const {
3955 return initial_max_;
3956}
3957
3958void Progress::Dump(int fd, const std::string& prefix) const {
3959 const char* pr = prefix.c_str();
3960 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3961 dprintf(fd, "%smax: %d\n", pr, max_);
3962 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3963 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3964 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3965 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3966 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3967}
3968
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003969std::string Dumpstate::GetPath(const std::string& suffix) const {
3970 return GetPath(bugreport_internal_dir_, suffix);
3971}
3972
3973std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3974 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3975 name_.c_str(), suffix.c_str());
3976}
3977
3978void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3979 progress_ = std::move(progress);
3980}
3981
3982void for_each_userid(void (*func)(int), const char *header) {
3983 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3984 "for_each_userid(%s)", header);
3985 DurationReporter duration_reporter(title);
3986 if (PropertiesHelper::IsDryRun()) return;
3987
3988 DIR *d;
3989 struct dirent *de;
3990
3991 if (header) printf("\n------ %s ------\n", header);
3992 func(0);
3993
3994 if (!(d = opendir("/data/system/users"))) {
3995 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3996 return;
3997 }
3998
3999 while ((de = readdir(d))) {
4000 int userid;
4001 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
4002 continue;
4003 }
4004 func(userid);
4005 }
4006
4007 closedir(d);
4008}
4009
4010static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
4011 DIR *d;
4012 struct dirent *de;
4013
4014 if (!(d = opendir("/proc"))) {
4015 printf("Failed to open /proc (%s)\n", strerror(errno));
4016 return;
4017 }
4018
4019 if (header) printf("\n------ %s ------\n", header);
4020 while ((de = readdir(d))) {
4021 if (ds.IsUserConsentDenied()) {
4022 MYLOGE(
4023 "Returning early because user denied consent to share bugreport with calling app.");
4024 closedir(d);
4025 return;
4026 }
4027 int pid;
4028 int fd;
4029 char cmdpath[255];
4030 char cmdline[255];
4031
4032 if (!(pid = atoi(de->d_name))) {
4033 continue;
4034 }
4035
4036 memset(cmdline, 0, sizeof(cmdline));
4037
4038 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
4039 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
4040 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
4041 close(fd);
4042 if (cmdline[0]) {
4043 helper(pid, cmdline, arg);
4044 continue;
4045 }
4046 }
4047
4048 // if no cmdline, a kernel thread has comm
4049 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
4050 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
4051 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
4052 close(fd);
4053 if (cmdline[1]) {
4054 cmdline[0] = '[';
4055 size_t len = strcspn(cmdline, "\f\b\r\n");
4056 cmdline[len] = ']';
4057 cmdline[len+1] = '\0';
4058 }
4059 }
4060 if (!cmdline[0]) {
4061 strcpy(cmdline, "N/A");
4062 }
4063 helper(pid, cmdline, arg);
4064 }
4065
4066 closedir(d);
4067}
4068
4069static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
4070 for_each_pid_func *func = (for_each_pid_func*) arg;
4071 func(pid, cmdline);
4072}
4073
4074void for_each_pid(for_each_pid_func func, const char *header) {
4075 std::string title = header == nullptr ? "for_each_pid"
4076 : android::base::StringPrintf("for_each_pid(%s)", header);
4077 DurationReporter duration_reporter(title);
4078 if (PropertiesHelper::IsDryRun()) return;
4079
4080 __for_each_pid(for_each_pid_helper, header, (void *) func);
4081}
4082
4083static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
4084 DIR *d;
4085 struct dirent *de;
4086 char taskpath[255];
4087 for_each_tid_func *func = (for_each_tid_func *) arg;
4088
4089 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
4090
4091 if (!(d = opendir(taskpath))) {
4092 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
4093 return;
4094 }
4095
4096 func(pid, pid, cmdline);
4097
4098 while ((de = readdir(d))) {
4099 if (ds.IsUserConsentDenied()) {
4100 MYLOGE(
4101 "Returning early because user denied consent to share bugreport with calling app.");
4102 closedir(d);
4103 return;
4104 }
4105 int tid;
4106 int fd;
4107 char commpath[255];
4108 char comm[255];
4109
4110 if (!(tid = atoi(de->d_name))) {
4111 continue;
4112 }
4113
4114 if (tid == pid)
4115 continue;
4116
4117 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
4118 memset(comm, 0, sizeof(comm));
4119 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
4120 strcpy(comm, "N/A");
4121 } else {
4122 char *c;
4123 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
4124 close(fd);
4125
4126 c = strrchr(comm, '\n');
4127 if (c) {
4128 *c = '\0';
4129 }
4130 }
4131 func(pid, tid, comm);
4132 }
4133
4134 closedir(d);
4135}
4136
4137void for_each_tid(for_each_tid_func func, const char *header) {
4138 std::string title = header == nullptr ? "for_each_tid"
4139 : android::base::StringPrintf("for_each_tid(%s)", header);
4140 DurationReporter duration_reporter(title);
4141
4142 if (PropertiesHelper::IsDryRun()) return;
4143
4144 __for_each_pid(for_each_tid_helper, header, (void *) func);
4145}
4146
4147void show_wchan(int pid, int tid, const char *name) {
4148 if (PropertiesHelper::IsDryRun()) return;
4149
4150 char path[255];
4151 char buffer[255];
4152 int fd, ret, save_errno;
4153 char name_buffer[255];
4154
4155 memset(buffer, 0, sizeof(buffer));
4156
4157 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
4158 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4159 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4160 return;
4161 }
4162
4163 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4164 save_errno = errno;
4165 close(fd);
4166
4167 if (ret < 0) {
4168 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4169 return;
4170 }
4171
4172 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
4173 pid == tid ? 0 : 3, "", name);
4174
4175 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
4176
4177 return;
4178}
4179
4180// print time in centiseconds
4181static void snprcent(char *buffer, size_t len, size_t spc,
4182 unsigned long long time) {
4183 static long hz; // cache discovered hz
4184
4185 if (hz <= 0) {
4186 hz = sysconf(_SC_CLK_TCK);
4187 if (hz <= 0) {
4188 hz = 1000;
4189 }
4190 }
4191
4192 // convert to centiseconds
4193 time = (time * 100 + (hz / 2)) / hz;
4194
4195 char str[16];
4196
4197 snprintf(str, sizeof(str), " %llu.%02u",
4198 time / 100, (unsigned)(time % 100));
4199 size_t offset = strlen(buffer);
4200 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4201 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4202}
4203
4204// print permille as a percent
4205static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
4206 char str[16];
4207
4208 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
4209 size_t offset = strlen(buffer);
4210 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4211 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4212}
4213
4214void show_showtime(int pid, const char *name) {
4215 if (PropertiesHelper::IsDryRun()) return;
4216
4217 char path[255];
4218 char buffer[1023];
4219 int fd, ret, save_errno;
4220
4221 memset(buffer, 0, sizeof(buffer));
4222
4223 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4224 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4225 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4226 return;
4227 }
4228
4229 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4230 save_errno = errno;
4231 close(fd);
4232
4233 if (ret < 0) {
4234 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4235 return;
4236 }
4237
4238 // field 14 is utime
4239 // field 15 is stime
4240 // field 42 is iotime
4241 unsigned long long utime = 0, stime = 0, iotime = 0;
4242 if (sscanf(buffer,
4243 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4244 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4245 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4246 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4247 &utime, &stime, &iotime) != 3) {
4248 return;
4249 }
4250
4251 unsigned long long total = utime + stime;
4252 if (!total) {
4253 return;
4254 }
4255
4256 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4257 if (permille > 1000) {
4258 permille = 1000;
4259 }
4260
4261 // try to beautify and stabilize columns at <80 characters
4262 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4263 if ((name[0] != '[') || utime) {
4264 snprcent(buffer, sizeof(buffer), 57, utime);
4265 }
4266 snprcent(buffer, sizeof(buffer), 65, stime);
4267 if ((name[0] != '[') || iotime) {
4268 snprcent(buffer, sizeof(buffer), 73, iotime);
4269 }
4270 if (iotime) {
4271 snprdec(buffer, sizeof(buffer), 79, permille);
4272 }
4273 puts(buffer); // adds a trailing newline
4274
4275 return;
4276}
4277
4278void do_dmesg() {
4279 const char *title = "KERNEL LOG (dmesg)";
4280 DurationReporter duration_reporter(title);
4281 printf("------ %s ------\n", title);
4282
4283 if (PropertiesHelper::IsDryRun()) return;
4284
4285 /* Get size of kernel buffer */
4286 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4287 if (size <= 0) {
4288 printf("Unexpected klogctl return value: %d\n\n", size);
4289 return;
4290 }
4291 char *buf = (char *) malloc(size + 1);
4292 if (buf == nullptr) {
4293 printf("memory allocation failed\n\n");
4294 return;
4295 }
4296 int retval = klogctl(KLOG_READ_ALL, buf, size);
4297 if (retval < 0) {
4298 printf("klogctl failure\n\n");
4299 free(buf);
4300 return;
4301 }
4302 buf[retval] = '\0';
4303 printf("%s\n\n", buf);
4304 free(buf);
4305 return;
4306}
4307
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004308int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4309 DurationReporter duration_reporter(title);
4310
4311 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4312
4313 UpdateProgress(WEIGHT_FILE);
4314
4315 return status;
4316}
4317
4318int read_file_as_long(const char *path, long int *output) {
luoqiangwei15fcf2022024-03-07 15:29:20 +08004319 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4320 if (fd.get() < 0) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004321 int err = errno;
4322 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4323 return -1;
4324 }
4325 char buffer[50];
luoqiangwei15fcf2022024-03-07 15:29:20 +08004326 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer, sizeof(buffer)));
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004327 if (bytes_read == -1) {
4328 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4329 return -2;
4330 }
4331 if (bytes_read == 0) {
4332 MYLOGE("File %s is empty\n", path);
4333 return -3;
4334 }
4335 *output = atoi(buffer);
4336 return 0;
4337}
4338
4339/* calls skip to gate calling dump_from_fd recursively
4340 * in the specified directory. dump_from_fd defaults to
4341 * dump_file_from_fd above when set to NULL. skip defaults
4342 * to false when set to NULL. dump_from_fd will always be
4343 * called with title NULL.
4344 */
4345int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4346 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4347 DurationReporter duration_reporter(title);
4348 DIR *dirp;
4349 struct dirent *d;
4350 char *newpath = nullptr;
4351 const char *slash = "/";
4352 int retval = 0;
4353
4354 if (!title.empty()) {
4355 printf("------ %s (%s) ------\n", title.c_str(), dir);
4356 }
4357 if (PropertiesHelper::IsDryRun()) return 0;
4358
4359 if (dir[strlen(dir) - 1] == '/') {
4360 ++slash;
4361 }
4362 dirp = opendir(dir);
4363 if (dirp == nullptr) {
4364 retval = -errno;
4365 MYLOGE("%s: %s\n", dir, strerror(errno));
4366 return retval;
4367 }
4368
4369 if (!dump_from_fd) {
4370 dump_from_fd = dump_file_from_fd;
4371 }
4372 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4373 if ((d->d_name[0] == '.')
4374 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4375 || (d->d_name[1] == '\0'))) {
4376 continue;
4377 }
4378 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4379 (d->d_type == DT_DIR) ? "/" : "");
4380 if (!newpath) {
4381 retval = -errno;
4382 continue;
4383 }
4384 if (skip && (*skip)(newpath)) {
4385 continue;
4386 }
4387 if (d->d_type == DT_DIR) {
4388 int ret = dump_files("", newpath, skip, dump_from_fd);
4389 if (ret < 0) {
4390 retval = ret;
4391 }
4392 continue;
4393 }
4394 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4395 if (fd.get() < 0) {
4396 retval = -1;
4397 printf("*** %s: %s\n", newpath, strerror(errno));
4398 continue;
4399 }
4400 (*dump_from_fd)(nullptr, newpath, fd.get());
4401 }
4402 closedir(dirp);
4403 if (!title.empty()) {
4404 printf("\n");
4405 }
4406 return retval;
4407}
4408
4409/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4410 * it's possible to avoid issues where opening the file itself can get
4411 * stuck.
4412 */
4413int dump_file_from_fd(const char *title, const char *path, int fd) {
4414 if (PropertiesHelper::IsDryRun()) return 0;
4415
4416 int flags = fcntl(fd, F_GETFL);
4417 if (flags == -1) {
4418 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4419 return -1;
4420 } else if (!(flags & O_NONBLOCK)) {
4421 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4422 return -1;
4423 }
4424 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4425}
4426
4427int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004428 const CommandOptions& options, bool verbose_duration, int out_fd) {
4429 DurationReporter duration_reporter(title, false /* logcat_only */,
4430 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004431
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004432 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004433
4434 /* TODO: for now we're simplifying the progress calculation by using the
4435 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4436 * where its weight should be much higher proportionally to its timeout.
4437 * Ideally, it should use a options.EstimatedDuration() instead...*/
4438 UpdateProgress(options.Timeout());
4439
4440 return status;
4441}
4442
4443void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004444 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004445 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4446 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4447 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004448 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004449}
4450
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004451static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004452 int s = android_get_control_socket(service);
4453 if (s < 0) {
4454 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4455 return -1;
4456 }
4457 fcntl(s, F_SETFD, FD_CLOEXEC);
4458
4459 // Set backlog to 0 to make sure that queue size will be minimum.
4460 // In Linux, because the minimum queue will be 1, connect() will be blocked
4461 // if the other clients already called connect() and the connection request was not accepted.
4462 if (listen(s, 0) < 0) {
4463 MYLOGE("listen(control socket): %s\n", strerror(errno));
4464 return -1;
4465 }
4466
4467 struct sockaddr addr;
4468 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004469 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004470
4471 // Close socket just after accept(), to make sure that connect() by client will get error
4472 // when the socket is used by the other services.
4473 // There is still a race condition possibility between accept and close, but there is no way
4474 // to close-on-accept atomically.
4475 // See detail; b/123306389#comment25
4476 close(s);
4477
4478 if (fd < 0) {
4479 MYLOGE("accept(control socket): %s\n", strerror(errno));
4480 return -1;
4481 }
4482
4483 return fd;
4484}
4485
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004486// TODO: should call is_valid_output_file and/or be merged into it.
4487void create_parent_dirs(const char *path) {
4488 char *chp = const_cast<char *> (path);
4489
4490 /* skip initial slash */
4491 if (chp[0] == '/')
4492 chp++;
4493
4494 /* create leading directories, if necessary */
4495 struct stat dir_stat;
4496 while (chp && chp[0]) {
4497 chp = strchr(chp, '/');
4498 if (chp) {
4499 *chp = 0;
4500 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4501 MYLOGI("Creating directory %s\n", path);
4502 if (mkdir(path, 0770)) { /* drwxrwx--- */
4503 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4504 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4505 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4506 }
4507 }
4508 *chp++ = '/';
4509 }
4510 }
4511}
4512
4513bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4514 create_parent_dirs(path);
4515
4516 int fd = TEMP_FAILURE_RETRY(open(path,
4517 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4518 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4519 if (fd < 0) {
4520 MYLOGE("%s: %s\n", path, strerror(errno));
4521 return false;
4522 }
4523
4524 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4525 close(fd);
4526 return true;
4527}
4528
4529bool redirect_to_file(FILE* redirect, char* path) {
4530 return _redirect_to_file(redirect, path, O_TRUNC);
4531}
4532
4533bool redirect_to_existing_file(FILE* redirect, char* path) {
4534 return _redirect_to_file(redirect, path, O_APPEND);
4535}
4536
4537void dump_route_tables() {
4538 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4539 if (PropertiesHelper::IsDryRun()) return;
4540 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4541 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4542 FILE* fp = fopen(RT_TABLES_PATH, "re");
4543 if (!fp) {
4544 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4545 return;
4546 }
4547 char table[16];
4548 // Each line has an integer (the table number), a space, and a string (the table name). We only
4549 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4550 // Add a fixed max limit so this doesn't go awry.
4551 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4552 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4553 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4554 }
4555 fclose(fp);
4556}
4557
Li Li830179f2022-01-04 12:53:29 -08004558void dump_frozen_cgroupfs(const char *dir, int level,
4559 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4560 DIR *dirp;
4561 struct dirent *d;
4562 char *newpath = nullptr;
4563
4564 dirp = opendir(dir);
4565 if (dirp == nullptr) {
4566 MYLOGE("%s: %s\n", dir, strerror(errno));
4567 return;
4568 }
4569
4570 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4571 if ((d->d_name[0] == '.')
4572 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4573 || (d->d_name[1] == '\0'))) {
4574 continue;
4575 }
4576 if (d->d_type == DT_DIR) {
4577 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4578 if (!newpath) {
4579 continue;
4580 }
4581 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4582 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4583 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4584 char *freezer = nullptr;
4585 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4586 if (freezer) {
4587 FILE* fp = fopen(freezer, "r");
4588 if (fp != NULL) {
4589 int frozen;
4590 fscanf(fp, "%d", &frozen);
4591 if (frozen > 0) {
4592 dump_files("", newpath, skip_none, dump_from_fd);
4593 }
4594 fclose(fp);
4595 }
4596 free(freezer);
4597 }
4598 }
4599 }
4600 }
4601 closedir(dirp);
4602}
4603
4604void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004605 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4606 DurationReporter duration_reporter("FROZEN CGROUPFS");
4607 if (PropertiesHelper::IsDryRun()) return;
4608 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4609}
4610
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004611void Dumpstate::UpdateProgress(int32_t delta_sec) {
4612 if (progress_ == nullptr) {
4613 MYLOGE("UpdateProgress: progress_ not set\n");
4614 return;
4615 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004616 // This function updates progress related members of the dumpstate and reports
4617 // progress percentage to the bugreport client. Since it could be called by
4618 // different dump tasks at the same time if the parallel run is enabled, a
4619 // mutex lock is necessary here to synchronize the call.
4620 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004621
4622 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004623 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004624
4625 // ...but only notifiy listeners when necessary.
4626 if (!options_->do_progress_updates) return;
4627
4628 int progress = progress_->Get();
4629 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004630 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004631
Nandana Dutt402a8392019-06-14 14:25:13 +01004632 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004633 return;
4634 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004635 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004636
4637 if (control_socket_fd_ >= 0) {
4638 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4639 fsync(control_socket_fd_);
4640 }
4641
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004642 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004643 if (percent % 10 == 0) {
4644 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004645 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004646 } else {
4647 // stderr is ignored on normal invocations, but useful when calling
4648 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004649 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004650 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004651
4652 listener_->onProgress(percent);
4653 }
4654}
4655
4656void Dumpstate::TakeScreenshot(const std::string& path) {
4657 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4658 int status =
Abdelrahman Daim30e23602024-08-20 02:19:37 -07004659 RunCommand("", {"screencap", "-p", real_path},
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004660 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4661 if (status == 0) {
4662 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4663 } else {
4664 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4665 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004666 if (listener_ != nullptr) {
4667 // Show a visual indication to indicate screenshot is taken via
4668 // IDumpstateListener.onScreenshotTaken()
4669 listener_->onScreenshotTaken(status == 0);
4670 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004671}
4672
4673bool is_dir(const char* pathname) {
4674 struct stat info;
4675 if (stat(pathname, &info) == -1) {
4676 return false;
4677 }
4678 return S_ISDIR(info.st_mode);
4679}
4680
4681time_t get_mtime(int fd, time_t default_mtime) {
4682 struct stat info;
4683 if (fstat(fd, &info) == -1) {
4684 return default_mtime;
4685 }
4686 return info.st_mtime;
4687}