blob: d24edc4d82e518f7a1de290cbe46afea68a2d965 [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
Felipe Lemed8b94e52016-12-08 10:21:44 -08001844 printf("========================================================\n");
1845 printf("== Android Framework Services\n");
1846 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001847
Nandana Dutt5c390032019-03-12 10:52:56 +00001848 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001849
Jack He91ff2fe2021-02-18 18:23:43 -08001850 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1851 ds.AddDir("/data/misc/bluetooth/logs", true);
1852
Rhed Jaoe017f982020-07-21 17:58:41 +08001853 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001854 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001855 } else {
1856 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1857 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001858
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001859 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001860
Adrian Roos8b397ab2017-04-04 16:35:44 -07001861 printf("========================================================\n");
1862 printf("== Dropbox crashes\n");
1863 printf("========================================================\n");
1864
1865 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1866 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1867
Felipe Lemed8b94e52016-12-08 10:21:44 -08001868 printf("========================================================\n");
1869 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1870 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1871 printf("========================================================\n");
1872 printf("== dumpstate: done (id %d)\n", ds.id_);
1873 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001874
1875 printf("========================================================\n");
1876 printf("== Obtaining statsd metadata\n");
1877 printf("========================================================\n");
1878 // This differs from the usual dumpsys stats, which is the stats report data.
1879 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001880
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001881 // Add linker configuration directory
1882 ds.AddDir(LINKERCONFIG_DIR, true);
1883
Li Li830179f2022-01-04 12:53:29 -08001884 /* Dump frozen cgroupfs */
1885 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001886
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001887 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001888 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1889 } else {
1890 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1891 DumpNetstatsProto);
1892 }
1893
1894 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001895 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001896 } else {
1897 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1898 DumpIncidentReport);
1899 }
Mike Ma5c267872019-08-21 11:31:34 -07001900
Kean Mariotti306633e2022-09-05 16:30:47 +00001901 MaybeAddUiTracesToZip();
1902
Nandana Dutt5c390032019-03-12 10:52:56 +00001903 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001904}
1905
Nandana Dutt5c390032019-03-12 10:52:56 +00001906/*
1907 * Dumps state for the default case; drops root after it's no longer necessary.
1908 *
1909 * Returns RunStatus::OK if everything went fine.
1910 * Returns RunStatus::ERROR if there was an error.
1911 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1912 * with the caller.
1913 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001914Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001915 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1916 // buffer.
1917 DoLogcat();
1918 // Capture timestamp after first logcat to use in next logcat
1919 time_t logcat_ts = time(nullptr);
1920
Nandana Dutt4be45d12018-09-26 15:04:23 +01001921 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001922 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001923 if (dump_pool_) {
1924 RETURN_IF_USER_DENIED_CONSENT();
1925 // One thread is enough since we only need to enqueue DumpTraces here.
1926 dump_pool_->start(/* thread_counts = */1);
1927
1928 // DumpTraces takes long time, post it to the another thread in the
1929 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001930 dump_traces = dump_pool_->enqueueTask(
1931 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001932 } else {
1933 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1934 &dump_traces_path);
1935 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001936
1937 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001938 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001939 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1940 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Andy Hungd62f7e62024-01-11 15:47:52 -08001941 ds.anr_trace_data_ = GetDumpFds(ANR_DIR, ANR_TRACE_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001942 ds.shutdown_checkpoints_ = GetDumpFds(
1943 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001944 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001945
1946 ds.AddDir(RECOVERY_DIR, true);
1947 ds.AddDir(RECOVERY_DATA_DIR, true);
1948 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001949 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001950 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1951 if (!PropertiesHelper::IsUserBuild()) {
1952 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1953 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001954 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001955 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001956 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001957 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001958 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1959 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1960 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001961 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001962 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001963 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001964 if (!PropertiesHelper::IsUserBuild()) {
1965 // Include dropbox entry files inside ZIP, but exclude
1966 // noisy WTF and StrictMode entries
1967 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1968 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001969
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001970 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001971 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1972
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001973 // Dump IPsec stats. No keys are exposed here.
1974 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1975
Nandana Dutt4be45d12018-09-26 15:04:23 +01001976 // Run ss as root so we can see socket marks.
1977 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1978
1979 // Run iotop as root to show top 100 IO threads
1980 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1981
Erick Reyese68df822019-02-11 14:46:36 -08001982 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001983 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1984 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001985
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001986 DumpFile("PSI cpu", "/proc/pressure/cpu");
1987 DumpFile("PSI memory", "/proc/pressure/memory");
1988 DumpFile("PSI io", "/proc/pressure/io");
1989
Steven Moreland9379c462023-12-21 02:04:27 +00001990 ds.AddZipEntry(ZIP_ROOT_DIR + KERNEL_CONFIG, KERNEL_CONFIG);
1991
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +02001992 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1993 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1994
Nattharat Jariyanuntanaetb250cae2024-05-15 07:48:19 +00001995 // Dump UWB UCI logs here because apexdata requires root access
1996 ds.AddDir(UWB_LOG_DIR, true);
1997
Rhed Jao5377d792020-07-16 17:37:39 +08001998 if (dump_pool_) {
1999 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08002000 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08002001
Chris Morinbc223142022-02-04 14:17:11 -08002002 // Current running thread in the pool is the root user also. Delete
2003 // the pool and make a new one later to ensure none of threads in the pool are root.
2004 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08002005 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002006 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002007 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002008 }
2009
Nandana Dutt5c390032019-03-12 10:52:56 +00002010 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01002011 Dumpstate::RunStatus status = dumpstate();
2012 // Capture logcat since the last time we did it.
2013 DoSystemLogcat(logcat_ts);
2014 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002015}
2016
Rhed Jaob5685b32020-08-14 17:19:17 +08002017// Common states for telephony and wifi which are needed to be collected before
2018// dumpstate drop the root user.
2019static void DumpstateRadioAsRoot() {
2020 DumpIpTablesAsRoot();
2021 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2022}
2023
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002024// This method collects common dumpsys for telephony and wifi. Typically, wifi
2025// reports are fine to include all information, but telephony reports on user
2026// builds need to strip some content (see DumpstateTelephonyOnly).
2027static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002028 // We need to be picky about some stuff for telephony reports on user builds.
2029 if (!include_sensitive_info) {
2030 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
2031 DoRadioLogcat();
2032 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08002033 // DumpHals takes long time, post it to the another thread in the pool,
2034 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002035 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08002036 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002037 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002038 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002039 // Contains various system properties and process startup info.
2040 do_dmesg();
2041 // Logs other than the radio buffer may contain package/component names and potential PII.
2042 DoLogcat();
2043 // Too broad for connectivity problems.
2044 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08002045 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
2046 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002047 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08002048 } else {
2049 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
2050 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002051 }
2052
Jayachandran Ca94c7172017-06-10 15:08:12 -07002053 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002054 DumpIpAddrAndRules();
2055 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002056 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2057 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002058}
2059
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002060// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2061// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2062// for what can be included on user builds: all reported information MUST directly relate to
2063// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2064// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2065// names are not), and MUST NOT contain logs of user application traffic.
2066// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002067static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002068 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002069
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002070 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002071
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002072 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002073
Rhed Jaob5685b32020-08-14 17:19:17 +08002074 DumpstateRadioAsRoot();
2075 if (!DropRootUser()) {
2076 return;
2077 }
2078
2079 // Starts thread pool after the root user is dropped, and two additional threads
2080 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002081 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002082 if (ds.dump_pool_) {
2083 ds.dump_pool_->start(/*thread_counts =*/2);
2084
2085 // DumpstateBoard takes long time, post it to the another thread in the pool,
2086 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002087 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2088 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002089 }
2090
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002091 DumpstateRadioCommon(include_sensitive_info);
2092
2093 if (include_sensitive_info) {
2094 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2095 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2096 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2097 // way.
2098 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2099 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002100
2101 printf("========================================================\n");
2102 printf("== Android Framework Services\n");
2103 printf("========================================================\n");
2104
Vishnu Nair652cc802017-11-30 15:18:30 -08002105 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2106 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002107 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2108 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002109 if (include_sensitive_info) {
2110 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2111 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2112 SEC_TO_MSEC(10));
2113 } else {
2114 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2115 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2116 // give a higher timeout as well.
2117 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2118 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2119 }
2120 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002121 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2122 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002123 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002124 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2125 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002126 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2127 SEC_TO_MSEC(10));
Grant Menke56698972023-02-24 13:11:07 -08002128 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2129 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002130 if (include_sensitive_info) {
2131 // Contains raw IP addresses, omit from reports on user builds.
2132 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2133 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2134 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2135 SEC_TO_MSEC(10));
2136 // Contains package/component names, omit from reports on user builds.
2137 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2138 SEC_TO_MSEC(10));
2139 // Contains package names, but should be relatively simple to remove them (also contains
2140 // UIDs already), omit from reports on user builds.
2141 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2142 SEC_TO_MSEC(10));
2143 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002144
2145 printf("========================================================\n");
2146 printf("== Running Application Services\n");
2147 printf("========================================================\n");
2148
2149 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2150
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002151 if (include_sensitive_info) {
2152 printf("========================================================\n");
2153 printf("== Running Application Services (non-platform)\n");
2154 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002155
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002156 // Contains package/component names and potential PII, omit from reports on user builds.
2157 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2158 // carrier_config dumpsys instead.
2159 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2160 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002161
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002162 printf("========================================================\n");
2163 printf("== Checkins\n");
2164 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002165
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002166 // Contains package/component names, omit from reports on user builds.
2167 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2168 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002169
2170 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002171 printf("== dumpstate: done (id %d)\n", ds.id_);
2172 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002173
2174 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002175 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002176 } else {
2177 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2178 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002179}
2180
mukesh agrawal253dad42018-01-23 21:59:59 -08002181// This method collects dumpsys for wifi debugging only
2182static void DumpstateWifiOnly() {
2183 DurationReporter duration_reporter("DUMPSTATE");
2184
Rhed Jaob5685b32020-08-14 17:19:17 +08002185 DumpstateRadioAsRoot();
2186 if (!DropRootUser()) {
2187 return;
2188 }
2189
2190 // Starts thread pool after the root user is dropped. Only one additional
2191 // thread is needed for DumpHals in the DumpstateRadioCommon.
2192 if (ds.dump_pool_) {
2193 ds.dump_pool_->start(/*thread_counts =*/1);
2194 }
2195
mukesh agrawal253dad42018-01-23 21:59:59 -08002196 DumpstateRadioCommon();
2197
2198 printf("========================================================\n");
2199 printf("== Android Framework Services\n");
2200 printf("========================================================\n");
2201
2202 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2203 SEC_TO_MSEC(10));
2204 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2205 SEC_TO_MSEC(10));
2206
2207 printf("========================================================\n");
2208 printf("== dumpstate: done (id %d)\n", ds.id_);
2209 printf("========================================================\n");
2210}
2211
Elis Elliott8e401ad2023-08-08 11:18:59 +00002212// Collects a lightweight dumpstate to be used for debugging onboarding related flows.
2213static void DumpstateOnboardingOnly() {
2214 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2215}
2216
Christopher Ferris83e0e842024-05-31 13:13:34 -07002217static std::string GetTimestamp(const timespec& ts) {
2218 tm tm;
2219 localtime_r(&ts.tv_sec, &tm);
2220
2221 // Reserve enough space for the entire time string, includes the space
2222 // for the '\0' to make the calculations below easier by using size for
2223 // the total string size.
2224 std::string str(sizeof("1970-01-01 00:00:00.123456789+0830"), '\0');
2225 size_t n = strftime(str.data(), str.size(), "%F %H:%M", &tm);
2226 if (n == 0) {
2227 return "TIMESTAMP FAILURE";
2228 }
2229 int num_chars = snprintf(&str[n], str.size() - n, ":%02d.%09ld", tm.tm_sec, ts.tv_nsec);
2230 if (num_chars > str.size() - n) {
2231 return "TIMESTAMP FAILURE";
2232 }
2233 n += static_cast<size_t>(num_chars);
2234 if (strftime(&str[n], str.size() - n, "%z", &tm) == 0) {
2235 return "TIMESTAMP FAILURE";
2236 }
2237 return str;
2238}
2239
2240static std::string GetCmdline(pid_t pid) {
2241 std::string cmdline;
2242 if (!android::base::ReadFileToString(android::base::StringPrintf("/proc/%d/cmdline", pid),
2243 &cmdline)) {
2244 return "UNKNOWN";
2245 }
2246 // There are '\0' terminators between arguments, convert them to spaces.
2247 // But start by skipping all trailing '\0' values.
2248 size_t cur = cmdline.size() - 1;
2249 while (cur != 0 && cmdline[cur] == '\0') {
2250 cur--;
2251 }
2252 if (cur == 0) {
2253 return "UNKNOWN";
2254 }
2255 while ((cur = cmdline.rfind('\0', cur)) != std::string::npos) {
2256 cmdline[cur] = ' ';
2257 }
2258 return cmdline;
2259}
2260
2261static void DumpPidHeader(int fd, pid_t pid, const timespec& ts) {
2262 // For consistency, the header to this message matches the one
2263 // dumped by debuggerd.
2264 dprintf(fd, "\n----- pid %d at %s -----\n", pid, GetTimestamp(ts).c_str());
2265 dprintf(fd, "Cmd line: %s\n", GetCmdline(pid).c_str());
2266}
2267
2268static void DumpPidFooter(int fd, pid_t pid) {
2269 // For consistency, the footer to this message matches the one
2270 // dumped by debuggerd.
2271 dprintf(fd, "----- end %d -----\n", pid);
2272}
2273
2274static bool DumpBacktrace(int fd, pid_t pid, bool is_java_process) {
2275 int ret = dump_backtrace_to_file_timeout(
2276 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
2277 if (ret == -1 && is_java_process) {
2278 // Tried to unwind as a java process, try a native unwind.
2279 dprintf(fd, "Java unwind failed for pid %d, trying a native unwind.\n", pid);
2280 ret = dump_backtrace_to_file_timeout(pid, kDebuggerdNativeBacktrace, 3, fd);
2281 }
2282 return ret != -1;
2283}
2284
Nandana Duttcf419a72019-03-14 10:40:17 +00002285Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002286 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002287 const size_t buf_size = temp_file_pattern.length() + 1;
2288 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2289 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2290
2291 // Create a new, empty file to receive all trace dumps.
2292 //
2293 // TODO: This can be simplified once we remove support for the old style
2294 // dumps. We can have a file descriptor passed in to dump_traces instead
2295 // of creating a file, closing it and then reopening it again.
2296 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2297 if (fd < 0) {
2298 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002299 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002300 }
2301
2302 // Nobody should have access to this temporary file except dumpstate, but we
2303 // temporarily grant 'read' to 'others' here because this file is created
2304 // when tombstoned is still running as root, but dumped after dropping. This
2305 // can go away once support for old style dumping has.
2306 const int chmod_ret = fchmod(fd, 0666);
2307 if (chmod_ret < 0) {
2308 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002309 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002310 }
2311
2312 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2313 if (proc.get() == nullptr) {
2314 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002315 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002316 }
2317
2318 // Number of times process dumping has timed out. If we encounter too many
2319 // failures, we'll give up.
2320 int timeout_failures = 0;
2321 bool dalvik_found = false;
2322
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002323 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002324
2325 struct dirent* d;
2326 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002327 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002328 int pid = atoi(d->d_name);
2329 if (pid <= 0) {
2330 continue;
2331 }
2332
2333 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2334 std::string exe;
2335 if (!android::base::Readlink(link_name, &exe)) {
2336 continue;
2337 }
2338
2339 bool is_java_process;
2340 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2341 // Don't bother dumping backtraces for the zygote.
2342 if (IsZygote(pid)) {
2343 continue;
2344 }
2345
2346 dalvik_found = true;
2347 is_java_process = true;
2348 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2349 is_java_process = false;
2350 } else {
2351 // Probably a native process we don't care about, continue.
2352 continue;
2353 }
2354
2355 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2356 if (timeout_failures == 3) {
2357 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2358 break;
2359 }
2360
Christopher Ferris83e0e842024-05-31 13:13:34 -07002361 timespec start_timespec;
2362 clock_gettime(CLOCK_REALTIME, &start_timespec);
2363 if (IsCached(pid)) {
2364 DumpPidHeader(fd, pid, start_timespec);
2365 dprintf(fd, "Process is cached, skipping backtrace due to high chance of timeout.\n");
2366 DumpPidFooter(fd, pid);
2367 continue;
2368 }
Nandana Duttfaafd522019-03-11 09:23:09 +00002369
Christopher Ferris83e0e842024-05-31 13:13:34 -07002370 const uint64_t start = Nanotime();
2371 if (!DumpBacktrace(fd, pid, is_java_process)) {
2372 if (IsCached(pid)) {
2373 DumpPidHeader(fd, pid, start_timespec);
2374 dprintf(fd, "Backtrace failed, but process has become cached.\n");
2375 DumpPidFooter(fd, pid);
2376 continue;
2377 }
2378
2379 DumpPidHeader(fd, pid, start_timespec);
2380 dprintf(fd, "Backtrace gathering failed, likely due to a timeout.\n");
2381 DumpPidFooter(fd, pid);
2382
2383 dprintf(fd, "\n[dump %s stack %d: %.3fs elapsed]\n",
2384 is_java_process ? "dalvik" : "native", pid,
2385 (float)(Nanotime() - start) / NANOS_PER_SEC);
Nandana Duttfaafd522019-03-11 09:23:09 +00002386 timeout_failures++;
2387 continue;
2388 }
2389
2390 // We've successfully dumped stack traces, reset the failure count
2391 // and write a summary of the elapsed time to the file and continue with the
2392 // next process.
2393 timeout_failures = 0;
2394
2395 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2396 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2397 }
2398
2399 if (!dalvik_found) {
2400 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2401 }
2402
Nandana Duttcf419a72019-03-14 10:40:17 +00002403 *path = file_name_buf.release();
2404 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002405}
2406
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002407static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2408 const Dumpstate::BugreportMode bugreport_mode) {
2409 switch (bugreport_mode) {
2410 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2411 return dumpstate_hal_hidl::DumpstateMode::FULL;
2412 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2413 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2414 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2415 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2416 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2417 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2418 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2419 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2420 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2421 return dumpstate_hal_hidl::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002422 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002423 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2424 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2425 }
2426 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2427}
2428
2429static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2430 const Dumpstate::BugreportMode bugreport_mode) {
2431 switch (bugreport_mode) {
2432 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2433 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2434 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2435 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2436 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2437 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2438 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2439 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2440 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2441 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2442 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2443 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002444 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002445 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2446 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2447 }
2448 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2449}
2450
2451static void DoDumpstateBoardHidl(
2452 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2453 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2454 const Dumpstate::BugreportMode bugreport_mode,
2455 const size_t timeout_sec) {
2456
2457 using ScopedNativeHandle =
2458 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2459 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2460 [](native_handle_t* handle) {
2461 // we don't close file handle's here
2462 // via native_handle_close(handle)
2463 // instead we let dumpstate_fds close the file handles when
2464 // dumpstate_fds gets destroyed
2465 native_handle_delete(handle);
2466 });
2467 if (handle == nullptr) {
2468 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2469 return;
2470 }
2471
2472 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2473 handle.get()->data[i] = dumpstate_fds[i].get();
2474 }
2475
2476 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2477 // implement just 1.0.
2478 const char* descriptor_to_kill;
2479 using DumpstateBoardTask = std::packaged_task<bool()>;
2480 DumpstateBoardTask dumpstate_board_task;
2481 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2482 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2483 if (dumpstate_hal != nullptr) {
2484 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2485
2486 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2487 GetDumpstateHalModeHidl(bugreport_mode);
2488
2489 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2490 dumpstate_board_task =
2491 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2492 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2493 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2494 SEC_TO_MSEC(timeout_sec));
2495 if (!status.isOk()) {
2496 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2497 return false;
2498 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2499 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2500 dumpstate_hal_hidl::toString(status).c_str());
2501 return false;
2502 }
2503 return true;
2504 });
2505 } else {
2506 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2507
2508 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2509 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2510 ::android::hardware::Return<void> status =
2511 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2512 if (!status.isOk()) {
2513 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2514 return false;
2515 }
2516 return true;
2517 });
2518 }
2519 auto result = dumpstate_board_task.get_future();
2520 std::thread(std::move(dumpstate_board_task)).detach();
2521
2522 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2523 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2524 if (!android::base::SetProperty(
2525 "ctl.interface_restart",
2526 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2527 MYLOGE("Couldn't restart dumpstate HAL\n");
2528 }
2529 }
2530 // Wait some time for init to kill dumpstate vendor HAL
2531 constexpr size_t killing_timeout_sec = 10;
2532 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2533 MYLOGE(
2534 "killing dumpstateBoard timed out after %zus, continue and "
2535 "there might be racing in content\n",
2536 killing_timeout_sec);
2537 }
2538}
2539
2540static void DoDumpstateBoardAidl(
2541 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2542 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2543 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2544 MYLOGI("Using IDumpstateDevice AIDL HAL");
2545
2546 const char* descriptor_to_kill;
2547 using DumpstateBoardTask = std::packaged_task<bool()>;
2548 DumpstateBoardTask dumpstate_board_task;
2549 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2550 GetDumpstateHalModeAidl(bugreport_mode);
2551
2552 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2553 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2554 timeout_sec]() -> bool {
2555 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2556
2557 if (!status.isOk()) {
2558 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2559 return false;
2560 }
2561 return true;
2562 });
2563 auto result = dumpstate_board_task.get_future();
2564 std::thread(std::move(dumpstate_board_task)).detach();
2565
2566 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2567 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2568 if (!android::base::SetProperty(
2569 "ctl.interface_restart",
2570 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2571 MYLOGE("Couldn't restart dumpstate HAL\n");
2572 }
2573 }
2574 // Wait some time for init to kill dumpstate vendor HAL
2575 constexpr size_t killing_timeout_sec = 10;
2576 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2577 MYLOGE(
2578 "killing dumpstateBoard timed out after %zus, continue and "
2579 "there might be racing in content\n",
2580 killing_timeout_sec);
2581 }
2582}
2583
2584static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2585 const std::string aidl_instance_name =
2586 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2587
2588 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2589 return nullptr;
2590 }
2591
2592 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2593
2594 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2595}
2596
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002597void Dumpstate::DumpstateBoard(int out_fd) {
2598 dprintf(out_fd, "========================================================\n");
2599 dprintf(out_fd, "== Board\n");
2600 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002601
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002602 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002603 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002604 * set to true and unmount it after invoking dumpstateBoard_* methods.
2605 * This is to enable debug builds to not have debugfs mounted during runtime.
2606 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002607 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002608 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002609 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002610 if (mount_debugfs) {
2611 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2612 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002613 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002614 }
2615
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002616 std::vector<std::string> paths;
2617 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002618 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002619 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2620 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002621 remover.emplace_back(android::base::make_scope_guard(
2622 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002623 }
Jie Song9fbfad02017-06-20 16:29:42 -07002624
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002625 // get dumpstate HAL AIDL implementation
2626 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2627 GetDumpstateBoardAidlService());
2628 if (dumpstate_hal_handle_aidl == nullptr) {
2629 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2630 }
2631
2632 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2633 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2634 if (dumpstate_hal_handle_aidl == nullptr) {
2635 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2636 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2637 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2638 }
2639 }
2640
2641 // if neither HIDL nor AIDL implementation found, then return
2642 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2643 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002644 return;
2645 }
2646
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002647 // this is used to hold the file descriptors and when this variable goes out of scope
2648 // the file descriptors are closed
2649 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002650
Nandana Dutt5c390032019-03-12 10:52:56 +00002651 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002652 for (size_t i = 0; i < paths.size(); i++) {
2653 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2654
2655 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2656 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2657 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2658 if (fd < 0) {
2659 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2660 return;
2661 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002662
2663 dumpstate_fds.emplace_back(fd.release());
2664 // we call fd.release() here to make sure "fd" does not get closed
2665 // after "fd" goes out of scope after this block.
2666 // "fd" will be closed when "dumpstate_fds" goes out of scope
2667 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002668 }
2669
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002670 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2671 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2672 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002673 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002674
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002675 if (dumpstate_hal_handle_aidl != nullptr) {
2676 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2677 timeout_sec);
2678 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2679 // run HIDL HAL only if AIDL HAL not found
2680 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2681 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002682 }
2683
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002684 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002685 auto keep_debugfs_mounted =
2686 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2687 if (keep_debugfs_mounted.empty())
2688 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002689 }
2690
Wei Wang587eac92018-04-05 12:17:20 -07002691 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2692 for (size_t i = 0; i < paths.size(); i++) {
2693 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002694 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2695 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002696 file_sizes[i] = -1;
2697 continue;
2698 }
2699 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002700 }
2701
2702 for (size_t i = 0; i < paths.size(); i++) {
2703 if (file_sizes[i] == -1) {
2704 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002705 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002706 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002707 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002708 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002709 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002710 remover[i].Disable();
2711 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2712 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002713 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002714}
2715
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002716static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002717 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002718 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2719 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002720 " -h: display this help message\n"
2721 " -b: play sound file instead of vibrate, at beginning of job\n"
2722 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002723 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002724 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002725 " -s: write zipped file to control socket (for init)\n"
2726 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002727 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002728 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002729 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002730 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002731 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002732 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002733}
2734
Wei Liuf87959e2016-08-26 14:51:42 -07002735static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002736 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002737}
2738
Felipe Leme1d486fe2016-10-14 18:06:47 -07002739bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002740 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2741 if (zip_entry_tasks_) {
2742 zip_entry_tasks_->run(/* do_cancel = */false);
2743 }
2744
Felipe Leme9a523ae2016-10-20 15:10:33 -07002745 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002746 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002747 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002748 // Final timestamp
2749 char date[80];
2750 time_t the_real_now_please_stand_up = time(nullptr);
2751 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002752 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002753 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002754
Felipe Leme9a523ae2016-10-20 15:10:33 -07002755 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002756 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002757 return false;
2758 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002759 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002760 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002761 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002762 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002763
Felipe Leme0f3fb202016-06-10 17:10:53 -07002764 // Add log file (which contains stderr output) to zip...
2765 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002766 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002767 MYLOGE("Failed to add dumpstate log to .zip file\n");
2768 return false;
2769 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002770 // TODO: Should truncate the existing file.
2771 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002772 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2773 return false;
2774 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002775 fprintf(stderr, "\n");
2776
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002777 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002778 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002779 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002780 return false;
2781 }
2782
Felipe Leme1d486fe2016-10-14 18:06:47 -07002783 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2784 ds.zip_file.reset(nullptr);
2785
Felipe Lemee9d2c542016-11-15 11:48:26 -08002786 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002787 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002788
Felipe Leme1e9edc62015-12-21 16:02:13 -08002789 return true;
2790}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002791
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002792static void SendBroadcast(const std::string& action,
2793 const std::vector<std::string>& args,
2794 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002795 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002796 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2797 std::to_string(user_id), "--receiver-foreground",
2798 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002799 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002800
2801 am.insert(am.end(), args.begin(), args.end());
2802
Felipe Leme8d2410e2017-02-08 09:46:08 -08002803 RunCommand("", am,
2804 CommandOptions::WithTimeout(20)
2805 .Log("Sending broadcast: '%s'\n")
2806 .Always()
2807 .DropRoot()
2808 .RedirectStderr()
2809 .Build());
2810}
2811
Felipe Leme35b8cf12017-02-10 15:47:29 -08002812static void Vibrate(int duration_ms) {
2813 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002814 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2815 "oneshot", std::to_string(duration_ms)};
2816 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002817 CommandOptions::WithTimeout(10)
2818 .Log("Vibrate: '%s'\n")
2819 .Always()
2820 .Build());
2821 // clang-format on
2822}
2823
Nandana Dutt979388e2018-11-30 16:48:55 +00002824static void MaybeResolveSymlink(std::string* path) {
2825 std::string resolved_path;
2826 if (android::base::Readlink(*path, &resolved_path)) {
2827 *path = resolved_path;
2828 }
2829}
2830
Nandana Dutt4be45d12018-09-26 15:04:23 +01002831/*
2832 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002833 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002834 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002835static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002836 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2837
Nandana Dutt4be45d12018-09-26 15:04:23 +01002838 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2839 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002840 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002841 char date[80];
2842 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2843 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002844
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002845 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002846 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002847 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002848 ds.base_name_ += "-wifi";
2849 }
2850
Paul Chang0d2aad72020-02-13 20:04:03 +08002851 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002852 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002853 }
2854 ds.tmp_path_ = ds.GetPath(".tmp");
2855 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2856
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002857 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002858 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002859 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002860 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002861 "Bugreport dir: [%s] "
2862 "Base name: [%s] "
2863 "Suffix: [%s] "
2864 "Log path: [%s] "
2865 "Temporary path: [%s] "
2866 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002867 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2868 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002869
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002870 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2871 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2872 create_parent_dirs(ds.path_.c_str());
2873 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2874 if (ds.zip_file == nullptr) {
2875 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2876 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002877 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002878 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2879 ds.AddTextZipEntry("version.txt", ds.version_);
2880 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002881}
2882
2883/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002884 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002885 * printing zipped file status, etc.
2886 */
2887static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002888 bool do_text_file = !ds.FinishZipFile();
2889 if (do_text_file) {
2890 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002891 }
mhasank2d75c442020-06-11 15:05:25 -07002892
2893 std::string final_path = ds.path_;
2894 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002895 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002896 android::os::CopyFileToFile(ds.path_, final_path);
2897 }
2898
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002899 if (ds.options_->stream_to_socket) {
2900 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2901 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002902 if (do_text_file) {
2903 dprintf(ds.control_socket_fd_,
2904 "FAIL:could not create zip file, check %s "
2905 "for more details\n",
2906 ds.log_path_.c_str());
2907 } else {
mhasank2d75c442020-06-11 15:05:25 -07002908 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002909 }
2910 }
2911}
2912
Nandana Dutt4be45d12018-09-26 15:04:23 +01002913
Nandana Dutt58d72e22018-11-16 10:30:48 +00002914static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2915 switch (mode) {
2916 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2917 return "BUGREPORT_FULL";
2918 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2919 return "BUGREPORT_INTERACTIVE";
2920 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2921 return "BUGREPORT_REMOTE";
2922 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2923 return "BUGREPORT_WEAR";
2924 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2925 return "BUGREPORT_TELEPHONY";
2926 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2927 return "BUGREPORT_WIFI";
Elis Elliott8e401ad2023-08-08 11:18:59 +00002928 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2929 return "BUGREPORT_ONBOARDING";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002930 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2931 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002932 }
2933}
2934
Steven Leeb573eb82022-11-29 22:31:35 +08002935static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2936 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2937 return !options.telephony_only;
2938}
2939
Paul Changf59c2b72020-03-10 02:08:55 +08002940static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2941 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002942 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2943 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002944 options->bugreport_mode = mode;
2945 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002946 switch (mode) {
2947 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002948 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002949 break;
2950 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002951 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002952 options->do_progress_updates = true;
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_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002956 options->do_vibrate = false;
2957 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002958 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002959 break;
2960 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002961 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002962 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002963 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002964 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002965 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002966 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002967 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002968 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002969 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002970 break;
2971 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002972 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002973 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002974 break;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002975 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2976 options->onboarding_only = true;
2977 options->do_screenshot = false;
2978 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002979 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2980 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002981 }
2982}
2983
Nandana Dutt58d72e22018-11-16 10:30:48 +00002984static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002985 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002986 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002987 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002988 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002989 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002990 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002991 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002992 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002993 options.do_progress_updates, options.bugreport_fd.get(),
2994 options.bugreport_mode_string.c_str(),
2995 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002996}
2997
Nandana Dutt54dbd672019-01-11 12:58:05 +00002998void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002999 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00003000 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08003001 const android::base::unique_fd& screenshot_fd_in,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003002 bool is_screenshot_requested,
3003 bool skip_user_consent) {
Kean Mariotti306633e2022-09-05 16:30:47 +00003004 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003005 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003006 this->skip_user_consent = skip_user_consent;
Nandana Dutt54dbd672019-01-11 12:58:05 +00003007 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00003008 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
3009 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00003010
Paul Changf59c2b72020-03-10 02:08:55 +08003011 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00003012}
3013
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003014Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
3015 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003016 int c;
mhasankd451a472020-05-26 18:02:39 -07003017 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003018 switch (c) {
3019 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07003020 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003021 case 's': stream_to_socket = true; break;
3022 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003023 case 'v': show_header_only = true; break;
3024 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08003025 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003026 case 'P': do_progress_updates = true; break;
3027 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07003028 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003029 case 'V':
3030 case 'd':
3031 case 'z':
3032 // compatibility no-op
3033 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00003034 case 'w':
3035 // This was already processed
3036 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003037 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003038 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003039 break;
3040 default:
3041 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003042 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003043 break;
3044 // clang-format on
3045 }
3046 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08003047
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003048 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003049 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003050 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003051 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003052 }
3053 }
3054
3055 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
3056 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003057
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003058 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003059}
3060
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003061bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003062 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00003063 return false;
3064 }
3065
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003066 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003067 return false;
3068 }
3069
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003070 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003071 return false;
3072 }
3073 return true;
3074}
3075
Nandana Dutt197661d2018-11-16 16:40:21 +00003076void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
3077 options_ = std::move(options);
3078}
3079
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003080void Dumpstate::Initialize() {
3081 /* gets the sequential id */
3082 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
3083 id_ = ++last_id;
3084 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
3085}
3086
Nandana Duttd2f5f082019-01-18 17:13:52 +00003087Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
3088 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003089 HandleRunStatus(status);
3090 return status;
3091}
3092
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003093Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003094 const bool keep_bugreport_on_retrieval,
3095 const bool skip_user_consent) {
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003096 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003097 keep_bugreport_on_retrieval,
3098 skip_user_consent);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003099 HandleRunStatus(status);
3100 return status;
3101}
3102
3103Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003104 const std::string& calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003105 const bool keep_bugreport_on_retrieval,
3106 const bool skip_user_consent) {
3107 if (!android::app::admin::flags::onboarding_consentless_bugreports() || !skip_user_consent) {
3108 consent_callback_ = new ConsentCallback();
3109 const String16 incidentcompanion("incidentcompanion");
3110 sp<android::IBinder> ics(
3111 defaultServiceManager()->checkService(incidentcompanion));
3112 android::String16 package(calling_package.c_str());
3113 if (ics != nullptr) {
3114 MYLOGD("Checking user consent via incidentcompanion service\n");
3115
3116 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
3117 calling_uid, package, String16(), String16(),
3118 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
3119 } else {
3120 MYLOGD(
3121 "Unable to check user consent; incidentcompanion service unavailable\n");
3122 return RunStatus::USER_CONSENT_TIMED_OUT;
3123 }
3124 UserConsentResult consent_result = consent_callback_->getResult();
3125 int timeout_ms = 30 * 1000;
3126 while (consent_result == UserConsentResult::UNAVAILABLE &&
3127 consent_callback_->getElapsedTimeMs() < timeout_ms) {
3128 sleep(1);
3129 consent_result = consent_callback_->getResult();
3130 }
3131 if (consent_result == UserConsentResult::DENIED) {
3132 return RunStatus::USER_CONSENT_DENIED;
3133 }
3134 if (consent_result == UserConsentResult::UNAVAILABLE) {
3135 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3136 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3137 consent_callback_.get());
3138 return RunStatus::USER_CONSENT_TIMED_OUT;
3139 }
Gavin Corkerya44686c2022-11-23 18:16:51 +00003140 }
3141
3142 bool copy_succeeded =
3143 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003144
3145 if (copy_succeeded && (!android::app::admin::flags::onboarding_bugreport_v2_enabled()
3146 || !keep_bugreport_on_retrieval)) {
3147 android::os::UnlinkAndLogOnError(path_);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003148 }
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003149
Gavin Corkerya44686c2022-11-23 18:16:51 +00003150 return copy_succeeded ? Dumpstate::RunStatus::OK
3151 : Dumpstate::RunStatus::ERROR;
3152}
3153
3154void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
3155 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00003156 switch (status) {
3157 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00003158 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00003159 break;
3160 case Dumpstate::RunStatus::HELP:
3161 break;
3162 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003163 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003164 break;
3165 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003166 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
3167 break;
3168 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3169 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
3170 break;
3171 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
3172 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003173 break;
3174 }
3175 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003176}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003177void Dumpstate::Cancel() {
3178 CleanupTmpFiles();
3179 android::os::UnlinkAndLogOnError(log_path_);
3180 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3181 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3182 kDumpstateBoardFiles[i]);
3183 }
3184 tombstone_data_.clear();
3185 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003186 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003187 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003188
3189 // Instead of shutdown the pool, we delete temporary files directly since
3190 // shutdown blocking the call.
3191 if (dump_pool_) {
3192 dump_pool_->deleteTempFiles();
3193 }
3194 if (zip_entry_tasks_) {
3195 zip_entry_tasks_->run(/*do_cancel =*/ true);
3196 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003197}
3198
Kean Mariotti306633e2022-09-05 16:30:47 +00003199void Dumpstate::PreDumpUiData() {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003200 auto snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Kean Mariotti306633e2022-09-05 16:30:47 +00003201 MaybeSnapshotUiTraces();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003202 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Kean Mariotti306633e2022-09-05 16:30:47 +00003203}
3204
Nandana Dutt979388e2018-11-30 16:48:55 +00003205/*
3206 * Dumps relevant information to a bugreport based on the given options.
3207 *
3208 * The bugreport can be dumped to a file or streamed to a socket.
3209 *
3210 * How dumping to file works:
3211 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3212 * stderr is redirected a log file.
3213 *
3214 * The temporary bugreport is then populated via printfs, dumping contents of files and
3215 * output of commands to stdout.
3216 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003217 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003218 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003219 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003220 *
mhasank2d75c442020-06-11 15:05:25 -07003221 * Bugreports are first generated in a local directory and later copied to the caller's fd
3222 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003223 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003224Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3225 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003226 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003227 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003228 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003229 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003230 return RunStatus::INVALID_INPUT;
3231 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003232 /* set as high priority, and protect from OOM killer */
3233 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003234
Felipe Lemed071c682016-10-20 16:48:00 -07003235 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003236 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003237 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003238 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003239 } else {
3240 /* fallback to kernels <= 2.6.35 */
3241 oom_adj = fopen("/proc/self/oom_adj", "we");
3242 if (oom_adj) {
3243 fputs("-17", oom_adj);
3244 fclose(oom_adj);
3245 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003246 }
3247
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003248 if (version_ == VERSION_DEFAULT) {
3249 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003250 }
3251
Chris Morin5a50d482022-02-01 17:41:18 -08003252 if (version_ != VERSION_CURRENT) {
3253 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3254 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003255 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003256 }
3257
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003258 if (options_->show_header_only) {
3259 PrintHeader();
3260 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003261 }
3262
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003263 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3264 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003265
Felipe Leme7447d7c2016-11-03 18:12:22 -07003266 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003267 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003268 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003269 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003270
Sahana Raof35ed432019-07-12 10:47:52 +01003271 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3272 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3273 } else {
3274 // Wake lock will be released automatically on process death
3275 MYLOGD("Wake lock acquired.\n");
3276 }
3277
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003278 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003279
Felipe Lemef0292972016-11-22 13:57:05 -08003280 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003281 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3282 }
3283
Kevin Jeonfa64e642023-07-27 11:36:41 -04003284 if (PropertiesHelper::IsStrictRun()) {
3285 MYLOGI(
3286 "Running on strict-run mode, which has shorter timeouts "
3287 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3288 }
3289
Nandana Dutt235c6672019-11-14 15:22:32 +00003290 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003291 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003292
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003293 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003294
Christopher Ferrised9354f2014-10-01 17:35:01 -07003295 // If we are going to use a socket, do it as early as possible
3296 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003297 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003298 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003299 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003300 if (control_socket_fd_ == -1) {
3301 return ERROR;
3302 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003303 if (options_->progress_updates_to_socket) {
3304 options_->do_progress_updates = 1;
3305 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003306 }
3307
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003308 if (!PrepareToWriteToFile()) {
3309 return ERROR;
3310 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003311
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003312 // Interactive, wear & telephony modes are default to true.
3313 // and may enable from cli option or when using control socket
3314 if (options_->do_progress_updates) {
3315 // clang-format off
3316 std::vector<std::string> am_args = {
3317 "--receiver-permission", "android.permission.DUMP",
3318 };
3319 // clang-format on
3320 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003321 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3322 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003323 if (options_->progress_updates_to_socket) {
3324 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003325 }
3326 }
3327
Nick Kralevichf3599b32016-01-25 15:05:16 -08003328 /* read /proc/cmdline before dropping root */
3329 FILE *cmdline = fopen("/proc/cmdline", "re");
3330 if (cmdline) {
3331 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3332 fclose(cmdline);
3333 }
3334
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003335 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003336 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003337 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003338
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003339 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003340 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3341 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003342 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003343 }
3344 }
3345
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003346 int dup_stdout_fd;
3347 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003348 // Redirect stderr to log_path_ for debugging.
3349 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3350 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3351 return ERROR;
3352 }
3353 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3354 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3355 strerror(errno));
3356 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003357
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003358 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3359 // moved into zip file later, if zipping.
3360 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3361 // TODO: why not write to a file instead of stdout to overcome this problem?
3362 /* TODO: rather than generating a text file now and zipping it later,
3363 it would be more efficient to redirect stdout to the zip entry
3364 directly, but the libziparchive doesn't support that option yet. */
3365 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3366 return ERROR;
3367 }
3368 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3369 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3370 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003371 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003372
3373 // Don't buffer stdout
3374 setvbuf(stdout, nullptr, _IONBF, 0);
3375
Rhed Jao5377d792020-07-16 17:37:39 +08003376 // Enable the parallel run if the client requests to output to a file.
3377 EnableParallelRunIfNeeded();
3378 // Using scope guard to make sure the dump pool can be shut down correctly.
3379 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3380 ShutdownDumpPool();
3381 });
3382
Felipe Leme608385d2016-02-01 10:35:38 -08003383 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3384 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003385 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003386 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003387
Kean Mariottic14cebc2024-03-04 10:55:28 +00003388 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
3389 if (options_->use_predumped_ui_data && !system_trace_exists) {
3390 MYLOGW("Ignoring 'use predumped data' flag because no predumped data is available");
3391 options_->use_predumped_ui_data = false;
3392 }
3393
Kean Mariottica20f2d2023-12-15 09:34:25 +00003394 std::future<std::string> snapshot_system_trace;
3395
Kean Mariotti853b73a2023-07-27 12:40:30 +00003396 bool is_dumpstate_restricted =
3397 options_->telephony_only || options_->wifi_only || options_->limited_only;
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003398 if (!is_dumpstate_restricted) {
3399 // Snapshot the system trace now (if running) to avoid that dumpstate's
3400 // own activity pushes out interesting data from the trace ring buffer.
3401 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
Kean Mariottica20f2d2023-12-15 09:34:25 +00003402 snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003403
Kean Mariotti853b73a2023-07-27 12:40:30 +00003404 // Invoke critical dumpsys to preserve system state, before doing anything else.
3405 RunDumpsysCritical();
3406
Kean Mariotti306633e2022-09-05 16:30:47 +00003407 // Snapshot the UI traces now (if running).
3408 // The trace files will be added to bugreport later.
3409 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003410 }
Kean Mariotti853b73a2023-07-27 12:40:30 +00003411
3412 MaybeTakeEarlyScreenshot();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003413 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Gavin Corkery6968f552020-11-22 18:09:05 +00003414 onUiIntensiveBugreportDumpsFinished(calling_uid);
3415 MaybeCheckUserConsent(calling_uid, calling_package);
3416 if (options_->telephony_only) {
3417 DumpstateTelephonyOnly(calling_package);
3418 } else if (options_->wifi_only) {
3419 DumpstateWifiOnly();
3420 } else if (options_->limited_only) {
3421 DumpstateLimitedOnly();
Elis Elliott8e401ad2023-08-08 11:18:59 +00003422 } else if (options_->onboarding_only) {
3423 DumpstateOnboardingOnly();
Gavin Corkery6968f552020-11-22 18:09:05 +00003424 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003425 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003426 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003427 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003428 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003429 HandleUserConsentDenied();
3430 }
3431 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003432 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003433 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003434
Felipe Leme55b42a62015-11-10 17:39:08 -08003435 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003436 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003437
Abhijeet Kaure370d682019-10-01 16:49:30 +01003438 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003439 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003440 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003441 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003442
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003443 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003444 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003445 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003446 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003447 if (status != Dumpstate::RunStatus::OK &&
3448 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3449 // Do an early return if there were errors. We make an exception for consent
3450 // timing out because it's possible the user got distracted. In this case the
3451 // bugreport is not shared but made available for manual retrieval.
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003452 MYLOGI("Bug report generation failed, this could have been due to"
3453 " several reasons such as BR copy failed, user consent was"
3454 " not grated etc. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003455 return status;
3456 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003457 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3458 MYLOGI(
3459 "Did not receive user consent yet."
3460 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003461 const String16 incidentcompanion("incidentcompanion");
3462 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3463 if (ics != nullptr) {
3464 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3465 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3466 consent_callback_.get());
3467 } else {
3468 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3469 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003470 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003471 }
3472
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003473 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003474 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003475 for (int i = 0; i < 3; i++) {
3476 Vibrate(75);
3477 usleep((75 + 50) * 1000);
3478 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003479 }
3480
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003481 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3482 progress_->GetInitialMax());
3483 progress_->Save();
3484 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003485
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003486 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003487
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003488 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003489 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003490 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003491 }
3492
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003493 tombstone_data_.clear();
3494 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003495 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003496 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003497
Nandana Duttd2f5f082019-01-18 17:13:52 +00003498 return (consent_callback_ != nullptr &&
3499 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3500 ? USER_CONSENT_TIMED_OUT
3501 : RunStatus::OK;
3502}
3503
Paul Chang0d2aad72020-02-13 20:04:03 +08003504void Dumpstate::MaybeTakeEarlyScreenshot() {
3505 if (!options_->do_screenshot || !do_early_screenshot_) {
3506 return;
3507 }
3508
3509 TakeScreenshot();
3510}
3511
Kean Mariottica20f2d2023-12-15 09:34:25 +00003512std::future<std::string> Dumpstate::MaybeSnapshotSystemTraceAsync() {
Kean Mariotti853b73a2023-07-27 12:40:30 +00003513 // When capturing traces via bugreport handler (BH), this function will be invoked twice:
3514 // 1) When BH invokes IDumpstate::PreDumpUiData()
3515 // 2) When BH invokes IDumpstate::startBugreport(flags = BUGREPORT_USE_PREDUMPED_UI_DATA)
3516 // In this case we don't want to re-invoke perfetto in step 2.
3517 // In all other standard invocation states, this function is invoked once
3518 // without the flag BUGREPORT_USE_PREDUMPED_UI_DATA.
Kean Mariottica20f2d2023-12-15 09:34:25 +00003519 // This function must run asynchronously to avoid delaying MaybeTakeEarlyScreenshot() in the
3520 // standard invocation states (b/316110955).
Kean Mariotti853b73a2023-07-27 12:40:30 +00003521 if (options_->use_predumped_ui_data) {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003522 return {};
3523 }
3524
3525 // Create temporary file for the command's output
3526 std::string outPath = ds.bugreport_internal_dir_ + "/tmp_serialize_perfetto_trace";
3527 auto outFd = android::base::unique_fd(TEMP_FAILURE_RETRY(
3528 open(outPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
3529 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
3530 if (outFd < 0) {
3531 MYLOGE("Could not open %s to serialize perfetto trace.\n", outPath.c_str());
3532 return {};
Kean Mariotti853b73a2023-07-27 12:40:30 +00003533 }
3534
3535 // If a stale file exists already, remove it.
3536 unlink(SYSTEM_TRACE_SNAPSHOT);
3537
Kean Mariottica20f2d2023-12-15 09:34:25 +00003538 MYLOGI("Launching async '%s'", SERIALIZE_PERFETTO_TRACE_TASK.c_str())
3539 return std::async(
3540 std::launch::async, [this, outPath = std::move(outPath), outFd = std::move(outFd)] {
3541 // If a background system trace is happening and is marked as "suitable for
3542 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3543 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3544 // case that no trace is ongoing, this command is a no-op.
3545 // Note: this should not be enqueued as we need to freeze the trace before
3546 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3547 // the dumpstate's own activity which is irrelevant.
3548 RunCommand(
3549 SERIALIZE_PERFETTO_TRACE_TASK, {"perfetto", "--save-for-bugreport"},
Kean Mariotti5aa8d152024-09-23 12:10:09 +00003550 CommandOptions::WithTimeout(30).DropRoot().CloseAllFileDescriptorsOnExec().Build(),
Kean Mariottica20f2d2023-12-15 09:34:25 +00003551 false, outFd);
3552 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3553 // file in the later stages.
3554
3555 return outPath;
3556 });
3557}
3558
3559void Dumpstate::MaybeWaitForSnapshotSystemTrace(std::future<std::string> task) {
3560 if (!task.valid()) {
3561 return;
3562 }
3563
3564 WaitForTask(std::move(task), SERIALIZE_PERFETTO_TRACE_TASK, STDOUT_FILENO);
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003565}
3566
Kean Mariotti306633e2022-09-05 16:30:47 +00003567void Dumpstate::MaybeSnapshotUiTraces() {
3568 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3569 return;
3570 }
3571
Pablo Gamito654831c2024-02-16 16:47:48 +00003572 std::vector<std::vector<std::string>> dumpTracesForBugReportCommands = {
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003573 {"cmd", "input_method", "tracing", "save-for-bugreport"},
3574 {"cmd", "window", "tracing", "save-for-bugreport"},
3575 {"cmd", "window", "shell", "tracing", "save-for-bugreport"},
3576 };
Hongwei Wang39229132023-01-24 15:09:59 -08003577
Pablo Gamito654831c2024-02-16 16:47:48 +00003578 if (!android_tracing_perfetto_transition_tracing()) {
3579 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3580 "SystemUIService", "WMShell", "transitions",
3581 "tracing", "save-for-bugreport"});
3582 }
3583
Pablo Gamito6929a0e2024-02-26 23:29:47 +00003584 if (!android_tracing_perfetto_protolog_tracing()) {
Pablo Gamito654831c2024-02-16 16:47:48 +00003585 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3586 "SystemUIService", "WMShell", "protolog",
3587 "save-for-bugreport"});
3588 }
3589
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003590 for (const auto& command : dumpTracesForBugReportCommands) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003591 RunCommand(
3592 // Empty name because it's not intended to be classified as a bugreport section.
3593 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003594 "", command,
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003595 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3596 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003597}
3598
3599void Dumpstate::MaybeAddUiTracesToZip() {
3600 if (PropertiesHelper::IsUserBuild()) {
3601 return;
3602 }
3603
3604 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003605}
3606
Paul Changeb4b4642020-05-28 22:05:47 +08003607void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003608 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003609 return;
3610 }
3611 if (listener_ != nullptr) {
3612 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3613 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003614 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003615 }
3616}
3617
Jichao Lie89d9c12019-11-21 19:02:51 -08003618void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003619 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003620 !CalledByApi() || options_->is_consent_deferred ||
3621 (android::app::admin::flags::onboarding_consentless_bugreports() &&
3622 options_->skip_user_consent)) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003623 // No need to get consent for shell triggered dumpstates, or not
3624 // through bugreporting API (i.e. no fd to copy back), or when consent
3625 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003626 return;
3627 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003628 consent_callback_ = new ConsentCallback();
3629 const String16 incidentcompanion("incidentcompanion");
3630 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003631 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003632 if (ics != nullptr) {
3633 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003634 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3635 if (IsConsentlessBugreportAllowed(*options_)) {
3636 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3637 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003638 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003639 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003640 } else {
3641 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3642 }
3643}
3644
Nandana Dutt5c390032019-03-12 10:52:56 +00003645bool Dumpstate::IsUserConsentDenied() const {
3646 return ds.consent_callback_ != nullptr &&
3647 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3648}
3649
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003650bool Dumpstate::CalledByApi() const {
3651 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3652}
3653
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003654void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003655 android::os::UnlinkAndLogOnError(tmp_path_);
3656 android::os::UnlinkAndLogOnError(screenshot_path_);
3657 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003658 if (dump_traces_path != nullptr) {
3659 android::os::UnlinkAndLogOnError(dump_traces_path);
3660 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003661}
3662
Rhed Jao5377d792020-07-16 17:37:39 +08003663void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003664 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003665 return;
3666 }
3667 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003668 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003669}
3670
3671void Dumpstate::ShutdownDumpPool() {
3672 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003673 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003674 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003675 if (zip_entry_tasks_) {
3676 zip_entry_tasks_->run(/* do_cancel = */true);
3677 zip_entry_tasks_ = nullptr;
3678 }
3679}
3680
3681void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3682 const std::string& entry_path) {
3683 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3684 if (!task_cancelled) {
3685 AddZipEntry(entry_name, entry_path);
3686 }
3687 android::os::UnlinkAndLogOnError(entry_path);
3688 };
3689 if (zip_entry_tasks_) {
3690 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3691 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3692 } else {
3693 // Invokes AddZipEntryAndCleanup immediately
3694 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3695 }
Rhed Jao5377d792020-07-16 17:37:39 +08003696}
3697
Nandana Duttd2f5f082019-01-18 17:13:52 +00003698Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3699 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003700 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003701 return USER_CONSENT_DENIED;
3702}
3703
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003704Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003705 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003706 // user consent (unless the caller is Shell).
3707 UserConsentResult consent_result;
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003708 if (multiuser_get_app_id(calling_uid) == AID_SHELL || (options_->skip_user_consent
3709 && android::app::admin::flags::onboarding_consentless_bugreports())) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003710 consent_result = UserConsentResult::APPROVED;
3711 } else {
3712 consent_result = consent_callback_->getResult();
3713 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003714 if (consent_result == UserConsentResult::UNAVAILABLE) {
3715 // User has not responded yet.
3716 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003717 // Telephony is a fast report type, particularly on user builds where information may be
3718 // more aggressively limited. To give the user time to read the consent dialog, increase the
3719 // timeout.
3720 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3721 : USER_CONSENT_TIMEOUT_MS;
3722 if (elapsed_ms < timeout_ms) {
3723 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003724 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3725 sleep(delay_seconds);
3726 }
3727 consent_result = consent_callback_->getResult();
3728 }
3729 if (consent_result == UserConsentResult::DENIED) {
3730 // User has explicitly denied sharing with the app. To be safe delete the
3731 // internal bugreport & tmp files.
3732 return HandleUserConsentDenied();
3733 }
3734 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003735 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3736 if (copy_succeeded) {
3737 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003738 if (options_->do_screenshot &&
3739 options_->screenshot_fd.get() != -1 &&
3740 !options_->is_screenshot_copied) {
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003741 bool is_screenshot_copied = android::os::CopyFileToFd(screenshot_path_,
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003742 options_->screenshot_fd.get());
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003743 if (is_screenshot_copied) {
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003744 android::os::UnlinkAndLogOnError(screenshot_path_);
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003745 } else {
3746 MYLOGE("Failed to copy screenshot to a permanent file.\n");
3747 is_screenshot_copied = android::os::CopyFileToFd(DEFAULT_SCREENSHOT_PATH,
3748 options_->screenshot_fd.get());
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003749 }
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003750 options_->is_screenshot_copied = is_screenshot_copied;
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003751 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003752 }
3753 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3754 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3755 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3756 // Since we do not have user consent to share the bugreport it does not get
3757 // copied over to the calling app but remains in the internal directory from
3758 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003759 std::string final_path = GetPath(".zip");
3760 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3761 if (copy_succeeded) {
3762 android::os::UnlinkAndLogOnError(path_);
3763 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003764 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3765 }
3766 // Unknown result; must be a programming error.
3767 MYLOGE("Unknown user consent result:%d\n", consent_result);
3768 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003769}
3770
Nandana Duttf02564e2019-02-15 15:24:24 +00003771Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003772 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3773 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3774 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003775 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003776 // When directly running dumpstate binary, the output is not expected to be written
3777 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003778 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003779
3780 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003781 // an app; they are irrelevant here because bugreport is triggered via command line.
3782 // Update Last ID before calling Run().
3783 Initialize();
Nikhil Kumarb70622a2023-06-15 15:37:19 +01003784 status = Run(0 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003785 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003786 return status;
3787}
3788
3789/* Main entry point for dumpstate binary. */
3790int run_main(int argc, char* argv[]) {
3791 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003792
3793 switch (status) {
3794 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003795 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003796 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003797 ShowUsage();
3798 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003799 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003800 fprintf(stderr, "Invalid combination of args\n");
3801 ShowUsage();
3802 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003803 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003804 FALLTHROUGH_INTENDED;
3805 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3806 FALLTHROUGH_INTENDED;
3807 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003808 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003809 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003810}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003811
3812// TODO(111441001): Default DumpOptions to sensible values.
3813Dumpstate::Dumpstate(const std::string& version)
3814 : pid_(getpid()),
3815 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003816 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003817 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003818 now_(time(nullptr)),
3819 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003820}
3821
3822Dumpstate& Dumpstate::GetInstance() {
3823 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3824 return singleton_;
3825}
3826
Rhed Jao5377d792020-07-16 17:37:39 +08003827DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3828 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3829 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003830 if (!title_.empty()) {
3831 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003832 if (title_.find("SHOW MAP") == std::string::npos) {
3833 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3834 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003835 }
3836}
3837
3838DurationReporter::~DurationReporter() {
3839 if (!title_.empty()) {
3840 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003841 if (elapsed >= 1.0f || verbose_) {
chenqiwuaf8b2d92019-12-12 18:53:51 +08003842 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003843 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003844 if (!logcat_only_) {
3845 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003846 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3847 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003848 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003849 if (title_.find("SHOW MAP") == std::string::npos) {
3850 ATRACE_ASYNC_END(title_.c_str(), 0);
3851 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003852 }
3853}
3854
3855const int32_t Progress::kDefaultMax = 5000;
3856
3857Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3858}
3859
3860Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3861 : Progress(initial_max, growth_factor, "") {
3862 progress_ = progress;
3863}
3864
3865Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3866 : initial_max_(initial_max),
3867 progress_(0),
3868 max_(initial_max),
3869 growth_factor_(growth_factor),
3870 n_runs_(0),
3871 average_max_(0),
3872 path_(path) {
3873 if (!path_.empty()) {
3874 Load();
3875 }
3876}
3877
3878void Progress::Load() {
3879 MYLOGD("Loading stats from %s\n", path_.c_str());
3880 std::string content;
3881 if (!android::base::ReadFileToString(path_, &content)) {
3882 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3883 return;
3884 }
3885 if (content.empty()) {
3886 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3887 return;
3888 }
3889 std::vector<std::string> lines = android::base::Split(content, "\n");
3890
3891 if (lines.size() < 1) {
3892 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3893 (int)lines.size(), max_);
3894 return;
3895 }
3896 char* ptr;
3897 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3898 average_max_ = strtol(ptr, nullptr, 10);
3899 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3900 average_max_ > STATS_MAX_AVERAGE) {
3901 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3902 initial_max_ = Progress::kDefaultMax;
3903 } else {
3904 initial_max_ = average_max_;
3905 }
3906 max_ = initial_max_;
3907
3908 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3909}
3910
3911void Progress::Save() {
3912 int32_t total = n_runs_ * average_max_ + progress_;
3913 int32_t runs = n_runs_ + 1;
3914 int32_t average = floor(((float)total) / runs);
3915 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3916 path_.c_str());
3917 if (path_.empty()) {
3918 return;
3919 }
3920
3921 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3922 if (!android::base::WriteStringToFile(content, path_)) {
3923 MYLOGE("Could not save stats on %s\n", path_.c_str());
3924 }
3925}
3926
3927int32_t Progress::Get() const {
3928 return progress_;
3929}
3930
3931bool Progress::Inc(int32_t delta_sec) {
3932 bool changed = false;
3933 if (delta_sec >= 0) {
3934 progress_ += delta_sec;
3935 if (progress_ > max_) {
3936 int32_t old_max = max_;
3937 max_ = floor((float)progress_ * growth_factor_);
3938 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3939 changed = true;
3940 }
3941 }
3942 return changed;
3943}
3944
3945int32_t Progress::GetMax() const {
3946 return max_;
3947}
3948
3949int32_t Progress::GetInitialMax() const {
3950 return initial_max_;
3951}
3952
3953void Progress::Dump(int fd, const std::string& prefix) const {
3954 const char* pr = prefix.c_str();
3955 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3956 dprintf(fd, "%smax: %d\n", pr, max_);
3957 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3958 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3959 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3960 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3961 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3962}
3963
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003964std::string Dumpstate::GetPath(const std::string& suffix) const {
3965 return GetPath(bugreport_internal_dir_, suffix);
3966}
3967
3968std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3969 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3970 name_.c_str(), suffix.c_str());
3971}
3972
3973void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3974 progress_ = std::move(progress);
3975}
3976
3977void for_each_userid(void (*func)(int), const char *header) {
3978 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3979 "for_each_userid(%s)", header);
3980 DurationReporter duration_reporter(title);
3981 if (PropertiesHelper::IsDryRun()) return;
3982
3983 DIR *d;
3984 struct dirent *de;
3985
3986 if (header) printf("\n------ %s ------\n", header);
3987 func(0);
3988
3989 if (!(d = opendir("/data/system/users"))) {
3990 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3991 return;
3992 }
3993
3994 while ((de = readdir(d))) {
3995 int userid;
3996 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3997 continue;
3998 }
3999 func(userid);
4000 }
4001
4002 closedir(d);
4003}
4004
4005static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
4006 DIR *d;
4007 struct dirent *de;
4008
4009 if (!(d = opendir("/proc"))) {
4010 printf("Failed to open /proc (%s)\n", strerror(errno));
4011 return;
4012 }
4013
4014 if (header) printf("\n------ %s ------\n", header);
4015 while ((de = readdir(d))) {
4016 if (ds.IsUserConsentDenied()) {
4017 MYLOGE(
4018 "Returning early because user denied consent to share bugreport with calling app.");
4019 closedir(d);
4020 return;
4021 }
4022 int pid;
4023 int fd;
4024 char cmdpath[255];
4025 char cmdline[255];
4026
4027 if (!(pid = atoi(de->d_name))) {
4028 continue;
4029 }
4030
4031 memset(cmdline, 0, sizeof(cmdline));
4032
4033 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
4034 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
4035 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
4036 close(fd);
4037 if (cmdline[0]) {
4038 helper(pid, cmdline, arg);
4039 continue;
4040 }
4041 }
4042
4043 // if no cmdline, a kernel thread has comm
4044 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
4045 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
4046 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
4047 close(fd);
4048 if (cmdline[1]) {
4049 cmdline[0] = '[';
4050 size_t len = strcspn(cmdline, "\f\b\r\n");
4051 cmdline[len] = ']';
4052 cmdline[len+1] = '\0';
4053 }
4054 }
4055 if (!cmdline[0]) {
4056 strcpy(cmdline, "N/A");
4057 }
4058 helper(pid, cmdline, arg);
4059 }
4060
4061 closedir(d);
4062}
4063
4064static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
4065 for_each_pid_func *func = (for_each_pid_func*) arg;
4066 func(pid, cmdline);
4067}
4068
4069void for_each_pid(for_each_pid_func func, const char *header) {
4070 std::string title = header == nullptr ? "for_each_pid"
4071 : android::base::StringPrintf("for_each_pid(%s)", header);
4072 DurationReporter duration_reporter(title);
4073 if (PropertiesHelper::IsDryRun()) return;
4074
4075 __for_each_pid(for_each_pid_helper, header, (void *) func);
4076}
4077
4078static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
4079 DIR *d;
4080 struct dirent *de;
4081 char taskpath[255];
4082 for_each_tid_func *func = (for_each_tid_func *) arg;
4083
4084 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
4085
4086 if (!(d = opendir(taskpath))) {
4087 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
4088 return;
4089 }
4090
4091 func(pid, pid, cmdline);
4092
4093 while ((de = readdir(d))) {
4094 if (ds.IsUserConsentDenied()) {
4095 MYLOGE(
4096 "Returning early because user denied consent to share bugreport with calling app.");
4097 closedir(d);
4098 return;
4099 }
4100 int tid;
4101 int fd;
4102 char commpath[255];
4103 char comm[255];
4104
4105 if (!(tid = atoi(de->d_name))) {
4106 continue;
4107 }
4108
4109 if (tid == pid)
4110 continue;
4111
4112 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
4113 memset(comm, 0, sizeof(comm));
4114 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
4115 strcpy(comm, "N/A");
4116 } else {
4117 char *c;
4118 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
4119 close(fd);
4120
4121 c = strrchr(comm, '\n');
4122 if (c) {
4123 *c = '\0';
4124 }
4125 }
4126 func(pid, tid, comm);
4127 }
4128
4129 closedir(d);
4130}
4131
4132void for_each_tid(for_each_tid_func func, const char *header) {
4133 std::string title = header == nullptr ? "for_each_tid"
4134 : android::base::StringPrintf("for_each_tid(%s)", header);
4135 DurationReporter duration_reporter(title);
4136
4137 if (PropertiesHelper::IsDryRun()) return;
4138
4139 __for_each_pid(for_each_tid_helper, header, (void *) func);
4140}
4141
4142void show_wchan(int pid, int tid, const char *name) {
4143 if (PropertiesHelper::IsDryRun()) return;
4144
4145 char path[255];
4146 char buffer[255];
4147 int fd, ret, save_errno;
4148 char name_buffer[255];
4149
4150 memset(buffer, 0, sizeof(buffer));
4151
4152 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
4153 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4154 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4155 return;
4156 }
4157
4158 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4159 save_errno = errno;
4160 close(fd);
4161
4162 if (ret < 0) {
4163 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4164 return;
4165 }
4166
4167 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
4168 pid == tid ? 0 : 3, "", name);
4169
4170 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
4171
4172 return;
4173}
4174
4175// print time in centiseconds
4176static void snprcent(char *buffer, size_t len, size_t spc,
4177 unsigned long long time) {
4178 static long hz; // cache discovered hz
4179
4180 if (hz <= 0) {
4181 hz = sysconf(_SC_CLK_TCK);
4182 if (hz <= 0) {
4183 hz = 1000;
4184 }
4185 }
4186
4187 // convert to centiseconds
4188 time = (time * 100 + (hz / 2)) / hz;
4189
4190 char str[16];
4191
4192 snprintf(str, sizeof(str), " %llu.%02u",
4193 time / 100, (unsigned)(time % 100));
4194 size_t offset = strlen(buffer);
4195 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4196 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4197}
4198
4199// print permille as a percent
4200static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
4201 char str[16];
4202
4203 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
4204 size_t offset = strlen(buffer);
4205 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4206 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4207}
4208
4209void show_showtime(int pid, const char *name) {
4210 if (PropertiesHelper::IsDryRun()) return;
4211
4212 char path[255];
4213 char buffer[1023];
4214 int fd, ret, save_errno;
4215
4216 memset(buffer, 0, sizeof(buffer));
4217
4218 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4219 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4220 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4221 return;
4222 }
4223
4224 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4225 save_errno = errno;
4226 close(fd);
4227
4228 if (ret < 0) {
4229 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4230 return;
4231 }
4232
4233 // field 14 is utime
4234 // field 15 is stime
4235 // field 42 is iotime
4236 unsigned long long utime = 0, stime = 0, iotime = 0;
4237 if (sscanf(buffer,
4238 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4239 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4240 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4241 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4242 &utime, &stime, &iotime) != 3) {
4243 return;
4244 }
4245
4246 unsigned long long total = utime + stime;
4247 if (!total) {
4248 return;
4249 }
4250
4251 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4252 if (permille > 1000) {
4253 permille = 1000;
4254 }
4255
4256 // try to beautify and stabilize columns at <80 characters
4257 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4258 if ((name[0] != '[') || utime) {
4259 snprcent(buffer, sizeof(buffer), 57, utime);
4260 }
4261 snprcent(buffer, sizeof(buffer), 65, stime);
4262 if ((name[0] != '[') || iotime) {
4263 snprcent(buffer, sizeof(buffer), 73, iotime);
4264 }
4265 if (iotime) {
4266 snprdec(buffer, sizeof(buffer), 79, permille);
4267 }
4268 puts(buffer); // adds a trailing newline
4269
4270 return;
4271}
4272
4273void do_dmesg() {
4274 const char *title = "KERNEL LOG (dmesg)";
4275 DurationReporter duration_reporter(title);
4276 printf("------ %s ------\n", title);
4277
4278 if (PropertiesHelper::IsDryRun()) return;
4279
4280 /* Get size of kernel buffer */
4281 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4282 if (size <= 0) {
4283 printf("Unexpected klogctl return value: %d\n\n", size);
4284 return;
4285 }
4286 char *buf = (char *) malloc(size + 1);
4287 if (buf == nullptr) {
4288 printf("memory allocation failed\n\n");
4289 return;
4290 }
4291 int retval = klogctl(KLOG_READ_ALL, buf, size);
4292 if (retval < 0) {
4293 printf("klogctl failure\n\n");
4294 free(buf);
4295 return;
4296 }
4297 buf[retval] = '\0';
4298 printf("%s\n\n", buf);
4299 free(buf);
4300 return;
4301}
4302
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004303int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4304 DurationReporter duration_reporter(title);
4305
4306 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4307
4308 UpdateProgress(WEIGHT_FILE);
4309
4310 return status;
4311}
4312
4313int read_file_as_long(const char *path, long int *output) {
luoqiangwei15fcf2022024-03-07 15:29:20 +08004314 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4315 if (fd.get() < 0) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004316 int err = errno;
4317 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4318 return -1;
4319 }
4320 char buffer[50];
luoqiangwei15fcf2022024-03-07 15:29:20 +08004321 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer, sizeof(buffer)));
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004322 if (bytes_read == -1) {
4323 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4324 return -2;
4325 }
4326 if (bytes_read == 0) {
4327 MYLOGE("File %s is empty\n", path);
4328 return -3;
4329 }
4330 *output = atoi(buffer);
4331 return 0;
4332}
4333
4334/* calls skip to gate calling dump_from_fd recursively
4335 * in the specified directory. dump_from_fd defaults to
4336 * dump_file_from_fd above when set to NULL. skip defaults
4337 * to false when set to NULL. dump_from_fd will always be
4338 * called with title NULL.
4339 */
4340int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4341 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4342 DurationReporter duration_reporter(title);
4343 DIR *dirp;
4344 struct dirent *d;
4345 char *newpath = nullptr;
4346 const char *slash = "/";
4347 int retval = 0;
4348
4349 if (!title.empty()) {
4350 printf("------ %s (%s) ------\n", title.c_str(), dir);
4351 }
4352 if (PropertiesHelper::IsDryRun()) return 0;
4353
4354 if (dir[strlen(dir) - 1] == '/') {
4355 ++slash;
4356 }
4357 dirp = opendir(dir);
4358 if (dirp == nullptr) {
4359 retval = -errno;
4360 MYLOGE("%s: %s\n", dir, strerror(errno));
4361 return retval;
4362 }
4363
4364 if (!dump_from_fd) {
4365 dump_from_fd = dump_file_from_fd;
4366 }
4367 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4368 if ((d->d_name[0] == '.')
4369 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4370 || (d->d_name[1] == '\0'))) {
4371 continue;
4372 }
4373 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4374 (d->d_type == DT_DIR) ? "/" : "");
4375 if (!newpath) {
4376 retval = -errno;
4377 continue;
4378 }
4379 if (skip && (*skip)(newpath)) {
4380 continue;
4381 }
4382 if (d->d_type == DT_DIR) {
4383 int ret = dump_files("", newpath, skip, dump_from_fd);
4384 if (ret < 0) {
4385 retval = ret;
4386 }
4387 continue;
4388 }
4389 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4390 if (fd.get() < 0) {
4391 retval = -1;
4392 printf("*** %s: %s\n", newpath, strerror(errno));
4393 continue;
4394 }
4395 (*dump_from_fd)(nullptr, newpath, fd.get());
4396 }
4397 closedir(dirp);
4398 if (!title.empty()) {
4399 printf("\n");
4400 }
4401 return retval;
4402}
4403
4404/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4405 * it's possible to avoid issues where opening the file itself can get
4406 * stuck.
4407 */
4408int dump_file_from_fd(const char *title, const char *path, int fd) {
4409 if (PropertiesHelper::IsDryRun()) return 0;
4410
4411 int flags = fcntl(fd, F_GETFL);
4412 if (flags == -1) {
4413 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4414 return -1;
4415 } else if (!(flags & O_NONBLOCK)) {
4416 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4417 return -1;
4418 }
4419 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4420}
4421
4422int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004423 const CommandOptions& options, bool verbose_duration, int out_fd) {
4424 DurationReporter duration_reporter(title, false /* logcat_only */,
4425 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004426
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004427 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004428
4429 /* TODO: for now we're simplifying the progress calculation by using the
4430 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4431 * where its weight should be much higher proportionally to its timeout.
4432 * Ideally, it should use a options.EstimatedDuration() instead...*/
4433 UpdateProgress(options.Timeout());
4434
4435 return status;
4436}
4437
4438void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004439 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004440 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4441 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4442 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004443 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004444}
4445
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004446static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004447 int s = android_get_control_socket(service);
4448 if (s < 0) {
4449 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4450 return -1;
4451 }
4452 fcntl(s, F_SETFD, FD_CLOEXEC);
4453
4454 // Set backlog to 0 to make sure that queue size will be minimum.
4455 // In Linux, because the minimum queue will be 1, connect() will be blocked
4456 // if the other clients already called connect() and the connection request was not accepted.
4457 if (listen(s, 0) < 0) {
4458 MYLOGE("listen(control socket): %s\n", strerror(errno));
4459 return -1;
4460 }
4461
4462 struct sockaddr addr;
4463 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004464 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004465
4466 // Close socket just after accept(), to make sure that connect() by client will get error
4467 // when the socket is used by the other services.
4468 // There is still a race condition possibility between accept and close, but there is no way
4469 // to close-on-accept atomically.
4470 // See detail; b/123306389#comment25
4471 close(s);
4472
4473 if (fd < 0) {
4474 MYLOGE("accept(control socket): %s\n", strerror(errno));
4475 return -1;
4476 }
4477
4478 return fd;
4479}
4480
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004481// TODO: should call is_valid_output_file and/or be merged into it.
4482void create_parent_dirs(const char *path) {
4483 char *chp = const_cast<char *> (path);
4484
4485 /* skip initial slash */
4486 if (chp[0] == '/')
4487 chp++;
4488
4489 /* create leading directories, if necessary */
4490 struct stat dir_stat;
4491 while (chp && chp[0]) {
4492 chp = strchr(chp, '/');
4493 if (chp) {
4494 *chp = 0;
4495 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4496 MYLOGI("Creating directory %s\n", path);
4497 if (mkdir(path, 0770)) { /* drwxrwx--- */
4498 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4499 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4500 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4501 }
4502 }
4503 *chp++ = '/';
4504 }
4505 }
4506}
4507
4508bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4509 create_parent_dirs(path);
4510
4511 int fd = TEMP_FAILURE_RETRY(open(path,
4512 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4513 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4514 if (fd < 0) {
4515 MYLOGE("%s: %s\n", path, strerror(errno));
4516 return false;
4517 }
4518
4519 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4520 close(fd);
4521 return true;
4522}
4523
4524bool redirect_to_file(FILE* redirect, char* path) {
4525 return _redirect_to_file(redirect, path, O_TRUNC);
4526}
4527
4528bool redirect_to_existing_file(FILE* redirect, char* path) {
4529 return _redirect_to_file(redirect, path, O_APPEND);
4530}
4531
4532void dump_route_tables() {
4533 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4534 if (PropertiesHelper::IsDryRun()) return;
4535 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4536 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4537 FILE* fp = fopen(RT_TABLES_PATH, "re");
4538 if (!fp) {
4539 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4540 return;
4541 }
4542 char table[16];
4543 // Each line has an integer (the table number), a space, and a string (the table name). We only
4544 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4545 // Add a fixed max limit so this doesn't go awry.
4546 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4547 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4548 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4549 }
4550 fclose(fp);
4551}
4552
Li Li830179f2022-01-04 12:53:29 -08004553void dump_frozen_cgroupfs(const char *dir, int level,
4554 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4555 DIR *dirp;
4556 struct dirent *d;
4557 char *newpath = nullptr;
4558
4559 dirp = opendir(dir);
4560 if (dirp == nullptr) {
4561 MYLOGE("%s: %s\n", dir, strerror(errno));
4562 return;
4563 }
4564
4565 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4566 if ((d->d_name[0] == '.')
4567 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4568 || (d->d_name[1] == '\0'))) {
4569 continue;
4570 }
4571 if (d->d_type == DT_DIR) {
4572 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4573 if (!newpath) {
4574 continue;
4575 }
4576 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4577 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4578 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4579 char *freezer = nullptr;
4580 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4581 if (freezer) {
4582 FILE* fp = fopen(freezer, "r");
4583 if (fp != NULL) {
4584 int frozen;
4585 fscanf(fp, "%d", &frozen);
4586 if (frozen > 0) {
4587 dump_files("", newpath, skip_none, dump_from_fd);
4588 }
4589 fclose(fp);
4590 }
4591 free(freezer);
4592 }
4593 }
4594 }
4595 }
4596 closedir(dirp);
4597}
4598
4599void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004600 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4601 DurationReporter duration_reporter("FROZEN CGROUPFS");
4602 if (PropertiesHelper::IsDryRun()) return;
4603 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4604}
4605
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004606void Dumpstate::UpdateProgress(int32_t delta_sec) {
4607 if (progress_ == nullptr) {
4608 MYLOGE("UpdateProgress: progress_ not set\n");
4609 return;
4610 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004611 // This function updates progress related members of the dumpstate and reports
4612 // progress percentage to the bugreport client. Since it could be called by
4613 // different dump tasks at the same time if the parallel run is enabled, a
4614 // mutex lock is necessary here to synchronize the call.
4615 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004616
4617 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004618 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004619
4620 // ...but only notifiy listeners when necessary.
4621 if (!options_->do_progress_updates) return;
4622
4623 int progress = progress_->Get();
4624 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004625 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004626
Nandana Dutt402a8392019-06-14 14:25:13 +01004627 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004628 return;
4629 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004630 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004631
4632 if (control_socket_fd_ >= 0) {
4633 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4634 fsync(control_socket_fd_);
4635 }
4636
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004637 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004638 if (percent % 10 == 0) {
4639 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004640 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004641 } else {
4642 // stderr is ignored on normal invocations, but useful when calling
4643 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004644 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004645 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004646
4647 listener_->onProgress(percent);
4648 }
4649}
4650
4651void Dumpstate::TakeScreenshot(const std::string& path) {
4652 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4653 int status =
4654 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4655 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4656 if (status == 0) {
4657 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4658 } else {
4659 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4660 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004661 if (listener_ != nullptr) {
4662 // Show a visual indication to indicate screenshot is taken via
4663 // IDumpstateListener.onScreenshotTaken()
4664 listener_->onScreenshotTaken(status == 0);
4665 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004666}
4667
4668bool is_dir(const char* pathname) {
4669 struct stat info;
4670 if (stat(pathname, &info) == -1) {
4671 return false;
4672 }
4673 return S_ISDIR(info.st_mode);
4674}
4675
4676time_t get_mtime(int fd, time_t default_mtime) {
4677 struct stat info;
4678 if (fstat(fd, &info) == -1) {
4679 return default_mtime;
4680 }
4681 return info.st_mtime;
4682}