blob: 888fb67b31bcdf6a69d723b3302c97ca3e5ef938 [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
Steven Moreland0d564d52025-01-10 22:24:57 +0000131// BAD - See README.md: "Dumpstate philosophy: exec not link"
132// Do not add more complicated variables here, prefer to execute only. Don't link more code here.
133
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100134// Keep in sync with
135// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
136static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
137
138/* Most simple commands have 10 as timeout, so 5 is a good estimate */
139static const int32_t WEIGHT_FILE = 5;
140
141// TODO: temporary variables and functions used during C++ refactoring
142static Dumpstate& ds = Dumpstate::GetInstance();
143static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100144 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800145 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
146 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100147}
148
149// Reasonable value for max stats.
150static const int STATS_MAX_N_RUNS = 1000;
151static const long STATS_MAX_AVERAGE = 100000;
152
153CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
154
Nandana Duttd2f5f082019-01-18 17:13:52 +0000155typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
156
Colin Crossf45fa6b2012-03-26 12:38:26 -0700157/* read before root is shed */
158static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700159static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000160static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800161// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
162// it's often the case that they time out far too quickly for consent with such a hefty dialog for
163// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
164// roughly match full reports' durations.
165static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700166
Felipe Leme1d486fe2016-10-14 18:06:47 -0700167// TODO: variables and functions below should be part of dumpstate object
168
Felipe Leme635ca312016-01-05 14:23:02 -0800169static std::set<std::string> mount_points;
170void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800171
Todd Poynor2a83daa2013-11-22 15:44:22 -0800172#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700173#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700174#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800175
Ted Bauerf6d61b82024-09-13 19:57:19 +0000176#define AFLAGS "/system/bin/aflags"
Felipe Lemee82a27d2016-01-05 13:35:44 -0800177#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700178#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700179#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700180#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700181#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800182#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100183#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
184#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800185#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Steven Moreland9379c462023-12-21 02:04:27 +0000186#define KERNEL_CONFIG "/proc/config.gz"
Erik Kline08165202016-05-30 11:55:44 +0900187#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800188#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700189#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800190#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900191#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700192#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000193#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700194#define CGROUPFS_DIR "/sys/fs/cgroup"
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200195#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700196#define DROPBOX_DIR "/data/system/dropbox"
Nattharat Jariyanuntanaetb250cae2024-05-15 07:48:19 +0000197#define UWB_LOG_DIR "/data/misc/apexdata/com.android.uwb/log"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700198
Narayan Kamath8f788292017-05-25 13:20:39 +0100199// TODO(narayan): Since this information has to be kept in sync
200// with tombstoned, we should just put it in a common header.
201//
202// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100203static const std::string TOMBSTONE_DIR = "/data/tombstones/";
204static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
205static const std::string ANR_DIR = "/data/anr/";
206static const std::string ANR_FILE_PREFIX = "anr_";
Andy Hungd62f7e62024-01-11 15:47:52 -0800207static const std::string ANR_TRACE_FILE_PREFIX = "trace_";
Woody Lin20767a92022-11-29 15:50:24 +0800208static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
209static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700210
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +0000211// File path to default screenshot image, that used when failed to capture the real screenshot.
212static const std::string DEFAULT_SCREENSHOT_PATH = "/system/etc/default_screenshot.png";
213
Felipe Lemee844a9d2016-09-21 15:01:39 -0700214// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000215
Nandana Dutt5c390032019-03-12 10:52:56 +0000216#define RETURN_IF_USER_DENIED_CONSENT() \
217 if (ds.IsUserConsentDenied()) { \
218 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
219 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
220 }
221
222// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
223// if consent is found to be denied.
224#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
225 RETURN_IF_USER_DENIED_CONSENT(); \
226 func_ptr(__VA_ARGS__); \
227 RETURN_IF_USER_DENIED_CONSENT();
228
Rhed Jao5377d792020-07-16 17:37:39 +0800229// Runs func_ptr, and logs a duration report after it's finished.
230#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
231 { \
232 DurationReporter duration_reporter_in_macro(log_title); \
233 func_ptr(__VA_ARGS__); \
234 }
235
236// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
237// is output after a slow function is finished.
238#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
239 RETURN_IF_USER_DENIED_CONSENT(); \
240 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
241 RETURN_IF_USER_DENIED_CONSENT();
242
Chris Morinbc223142022-02-04 14:17:11 -0800243#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800244 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800245 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800246 RETURN_IF_USER_DENIED_CONSENT();
247
Sahana Raof35ed432019-07-12 10:47:52 +0100248static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
249
Rhed Jao5377d792020-07-16 17:37:39 +0800250// Names of parallel tasks, they are used for the DumpPool to identify the dump
251// task and the log title of the duration report.
252static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800253static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huang24d215d2022-04-27 18:51:16 +0800254static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800255static const std::string DUMP_HALS_TASK = "DUMP HALS";
256static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800257static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariottica20f2d2023-12-15 09:34:25 +0000258static const std::string SERIALIZE_PERFETTO_TRACE_TASK = "SERIALIZE PERFETTO TRACE";
Rhed Jao5377d792020-07-16 17:37:39 +0800259
Nandana Dutt979388e2018-11-30 16:48:55 +0000260namespace android {
261namespace os {
262namespace {
263
264static int Open(std::string path, int flags, mode_t mode = 0) {
265 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
266 if (fd == -1) {
267 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
268 }
269 return fd;
270}
271
mhasank2d75c442020-06-11 15:05:25 -0700272static int OpenForWrite(std::string path) {
273 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
274 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
275}
Nandana Dutt979388e2018-11-30 16:48:55 +0000276
277static int OpenForRead(std::string path) {
278 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
279}
280
281bool CopyFile(int in_fd, int out_fd) {
282 char buf[4096];
283 ssize_t byte_count;
284 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
285 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
286 return false;
287 }
288 }
289 return (byte_count != -1);
290}
291
292static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000293 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000294
295 // Obtain a handle to the source file.
296 android::base::unique_fd in_fd(OpenForRead(input_file));
297 if (out_fd != -1 && in_fd.get() != -1) {
298 if (CopyFile(in_fd.get(), out_fd)) {
299 return true;
300 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000301 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000302 }
303 return false;
304}
305
Nandana Duttd2f5f082019-01-18 17:13:52 +0000306static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000307 if (file.empty()) {
308 return false;
309 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000310 if (unlink(file.c_str())) {
311 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000312 return false;
313 }
314 return true;
315}
Nandana Dutt979388e2018-11-30 16:48:55 +0000316
Nikita Ioffea325a572019-05-16 19:49:47 +0100317int64_t GetModuleMetadataVersion() {
318 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
319 if (binder == nullptr) {
320 MYLOGE("Failed to retrieve package_native service");
321 return 0L;
322 }
323 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
324 std::string package_name;
325 auto status = package_service->getModuleMetadataPackageName(&package_name);
326 if (!status.isOk()) {
327 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
328 return 0L;
329 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100330 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100331 int64_t version_code;
332 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
333 &version_code);
334 if (!status.isOk()) {
335 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
336 return 0L;
337 }
338 return version_code;
339}
340
mhasank2d75c442020-06-11 15:05:25 -0700341static bool PathExists(const std::string& path) {
342 struct stat sb;
343 return stat(path.c_str(), &sb) == 0;
344}
345
346static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
347 if (input_file == output_file) {
348 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
349 output_file.c_str());
350 return false;
351 }
352 else if (PathExists(output_file)) {
353 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
354 return false;
355 }
356
357 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
358 android::base::unique_fd out_fd(OpenForWrite(output_file));
359 return CopyFileToFd(input_file, out_fd.get());
360}
361
Nandana Dutt979388e2018-11-30 16:48:55 +0000362} // namespace
363} // namespace os
364} // namespace android
365
Felipe Leme678727a2016-09-21 17:22:11 -0700366static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800367 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800368 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
369 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
370}
371static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
372 int out_fd) {
373 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700374}
375static int DumpFile(const std::string& title, const std::string& path) {
376 return ds.DumpFile(title, path);
377}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800378
Felipe Lemee844a9d2016-09-21 15:01:39 -0700379// Relative directory (inside the zip) for all files copied as-is into the bugreport.
380static const std::string ZIP_ROOT_DIR = "FS";
381
Vishnu Naire97d6122018-01-18 13:58:56 -0800382static const std::string kProtoPath = "proto/";
383static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700384static const std::string kDumpstateBoardFiles[] = {
385 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700386 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700387};
388static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
389
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700390static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700391static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700392
Felipe Lemef0292972016-11-22 13:57:05 -0800393static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
394
Narayan Kamath8f788292017-05-25 13:20:39 +0100395/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100396 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800397 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800398 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100399 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700400static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800401 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100402 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100403
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700404 if (dump_dir == nullptr) {
405 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700406 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700407 }
408
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700409 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100410 struct dirent* entry = nullptr;
411 while ((entry = readdir(dump_dir.get()))) {
412 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100413 continue;
414 }
415
Narayan Kamathbd863722017-06-01 18:50:12 +0100416 const std::string base_name(entry->d_name);
417 if (base_name.find(file_prefix) != 0) {
418 continue;
419 }
420
421 const std::string abs_path = dir_path + base_name;
422 android::base::unique_fd fd(
423 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
424 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700425 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100426 break;
427 }
428
429 struct stat st = {};
430 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700431 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100432 continue;
433 }
434
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700435 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700436 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800437 if (!dump_data.empty()) {
438 std::sort(dump_data.begin(), dump_data.end(),
439 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
440 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100441
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700442 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100443}
444
Narayan Kamathbd863722017-06-01 18:50:12 +0100445static bool AddDumps(const std::vector<DumpData>::const_iterator start,
446 const std::vector<DumpData>::const_iterator end,
447 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100448 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100449 for (auto it = start; it != end; ++it) {
450 const std::string& name = it->name;
451 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100452 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100453
454 // Seek to the beginning of the file before dumping any data. A given
455 // DumpData entry might be dumped multiple times in the report.
456 //
457 // For example, the most recent ANR entry is dumped to the body of the
458 // main entry and it also shows up as a separate entry in the bugreport
459 // ZIP file.
460 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
461 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
462 strerror(errno));
463 }
464
Chris Morinc2cba7a2022-02-01 17:06:50 -0800465 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800466 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100467 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100468 }
469 } else {
470 dump_file_from_fd(type_name, name.c_str(), fd);
471 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100472 }
473
474 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700475}
476
Felipe Leme635ca312016-01-05 14:23:02 -0800477// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700478void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800479 char path[PATH_MAX];
480
481 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
482 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700483 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800484 char linkname[PATH_MAX];
485 ssize_t r = readlink(path, linkname, PATH_MAX);
486 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800487 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800488 return;
489 }
490 linkname[r] = '\0';
491
492 if (mount_points.find(linkname) == mount_points.end()) {
493 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700494 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700495 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800496 mount_points.insert(linkname);
497 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800498 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800499 }
500 }
501}
502
503void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700504 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800505 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800506 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700507 for_each_pid(do_mountinfo, nullptr);
508 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800509}
510
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700511static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
512{
513 DIR *d;
514 struct dirent *de;
515 char path[PATH_MAX];
516
517 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700518 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700519 return;
520 }
521
522 while ((de = readdir(d))) {
523 if (de->d_type != DT_LNK) {
524 continue;
525 }
526 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700527 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700528 }
529
530 closedir(d);
531}
532
Mark Salyzyn326842f2015-04-30 09:49:41 -0700533static bool skip_not_stat(const char *path) {
534 static const char stat[] = "/stat";
535 size_t len = strlen(path);
536 if (path[len - 1] == '/') { /* Directory? */
537 return false;
538 }
539 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
540}
541
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700542static bool skip_wtf_strictmode(const char *path) {
543 if (strstr(path, "_wtf")) {
544 return true;
545 } else if (strstr(path, "_strictmode")) {
546 return true;
547 }
548 return false;
549}
550
Felipe Leme4c2d6632016-09-28 14:32:00 -0700551static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800552 return false;
553}
554
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700555unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700556
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800557//
558// stat offsets
559// Name units description
560// ---- ----- -----------
561// read I/Os requests number of read I/Os processed
562#define __STAT_READ_IOS 0
563// read merges requests number of read I/Os merged with in-queue I/O
564#define __STAT_READ_MERGES 1
565// read sectors sectors number of sectors read
566#define __STAT_READ_SECTORS 2
567// read ticks milliseconds total wait time for read requests
568#define __STAT_READ_TICKS 3
569// write I/Os requests number of write I/Os processed
570#define __STAT_WRITE_IOS 4
571// write merges requests number of write I/Os merged with in-queue I/O
572#define __STAT_WRITE_MERGES 5
573// write sectors sectors number of sectors written
574#define __STAT_WRITE_SECTORS 6
575// write ticks milliseconds total wait time for write requests
576#define __STAT_WRITE_TICKS 7
577// in_flight requests number of I/Os currently in flight
578#define __STAT_IN_FLIGHT 8
579// io_ticks milliseconds total time this block device has been active
580#define __STAT_IO_TICKS 9
581// time_in_queue milliseconds total wait time for all requests
582#define __STAT_IN_QUEUE 10
583#define __STAT_NUMBER_FIELD 11
584//
585// read I/Os, write I/Os
586// =====================
587//
588// These values increment when an I/O request completes.
589//
590// read merges, write merges
591// =========================
592//
593// These values increment when an I/O request is merged with an
594// already-queued I/O request.
595//
596// read sectors, write sectors
597// ===========================
598//
599// These values count the number of sectors read from or written to this
600// block device. The "sectors" in question are the standard UNIX 512-byte
601// sectors, not any device- or filesystem-specific block size. The
602// counters are incremented when the I/O completes.
603#define SECTOR_SIZE 512
604//
605// read ticks, write ticks
606// =======================
607//
608// These values count the number of milliseconds that I/O requests have
609// waited on this block device. If there are multiple I/O requests waiting,
610// these values will increase at a rate greater than 1000/second; for
611// example, if 60 read requests wait for an average of 30 ms, the read_ticks
612// field will increase by 60*30 = 1800.
613//
614// in_flight
615// =========
616//
617// This value counts the number of I/O requests that have been issued to
618// the device driver but have not yet completed. It does not include I/O
619// requests that are in the queue but not yet issued to the device driver.
620//
621// io_ticks
622// ========
623//
624// This value counts the number of milliseconds during which the device has
625// had I/O requests queued.
626//
627// time_in_queue
628// =============
629//
630// This value counts the number of milliseconds that I/O requests have waited
631// on this block device. If there are multiple I/O requests waiting, this
632// value will increase as the product of the number of milliseconds times the
633// number of requests waiting (see "read ticks" above for an example).
634#define S_TO_MS 1000
635//
636
Mark Salyzyn326842f2015-04-30 09:49:41 -0700637static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800638 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700639 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700640 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700641 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700642 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700643 getline(&buffer, &i, fp);
644 fclose(fp);
645 if (!buffer) {
646 return -errno;
647 }
648 i = strlen(buffer);
649 while ((i > 0) && (buffer[i - 1] == '\n')) {
650 buffer[--i] = '\0';
651 }
652 if (!*buffer) {
653 free(buffer);
654 return 0;
655 }
656 z = true;
657 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800658 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700659 if (fields[i] != 0) {
660 z = false;
661 }
662 }
663 if (z) { /* never accessed */
664 free(buffer);
665 return 0;
666 }
667
Wei Wang509bb5d2017-06-09 14:42:12 -0700668 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
669 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700670 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700671
672 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
673 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
674 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700675 free(buffer);
676
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800677 if (fields[__STAT_IO_TICKS]) {
678 unsigned long read_perf = 0;
679 unsigned long read_ios = 0;
680 if (fields[__STAT_READ_TICKS]) {
681 unsigned long long divisor = fields[__STAT_READ_TICKS]
682 * fields[__STAT_IO_TICKS];
683 read_perf = ((unsigned long long)SECTOR_SIZE
684 * fields[__STAT_READ_SECTORS]
685 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
686 / divisor;
687 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
688 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
689 / divisor;
690 }
691
692 unsigned long write_perf = 0;
693 unsigned long write_ios = 0;
694 if (fields[__STAT_WRITE_TICKS]) {
695 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
696 * fields[__STAT_IO_TICKS];
697 write_perf = ((unsigned long long)SECTOR_SIZE
698 * fields[__STAT_WRITE_SECTORS]
699 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
700 / divisor;
701 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
702 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
703 / divisor;
704 }
705
706 unsigned queue = (fields[__STAT_IN_QUEUE]
707 + (fields[__STAT_IO_TICKS] >> 1))
708 / fields[__STAT_IO_TICKS];
709
710 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700711 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 -0800712 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700713 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 -0800714 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800715 }
716
717 /* bugreport timeout factor adjustment */
718 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
719 worst_write_perf = write_perf;
720 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700721 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700722 return 0;
723}
724
Yao Chenbe3bbc12018-01-17 16:31:10 -0800725static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
726
Tom Cherryf4472f32020-08-05 09:31:17 -0700727// Returns the actual readable size of the given buffer or -1 on error.
728static long logcat_buffer_readable_size(const std::string& buffer) {
729 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
730 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
731 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
732
733 return android_logger_get_log_readable_size(logger);
734}
735
736// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800737static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
738 unsigned long timeout_ms = 0;
739 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700740 long readable_size = logcat_buffer_readable_size(buffer);
741 if (readable_size > 0) {
742 // Engineering margin is ten-fold our guess.
743 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
744 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800745 }
746 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700747}
748
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800749// Opens a socket and returns its file descriptor.
750static int open_socket(const char* service);
751
Nandana Duttd2f5f082019-01-18 17:13:52 +0000752Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
753}
754
755android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
756 std::lock_guard<std::mutex> lock(lock_);
757 result_ = APPROVED;
758 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800759
760 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
761 // consent is granted.
762 if (ds.options_->is_screenshot_copied) {
763 return android::binder::Status::ok();
764 }
765
766 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
767 !ds.do_early_screenshot_) {
768 return android::binder::Status::ok();
769 }
770
771 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
772 ds.options_->screenshot_fd.get());
Paul Chang0d2aad72020-02-13 20:04:03 +0800773 if (copy_succeeded) {
774 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +0000775 } else {
776 MYLOGE("Failed to copy screenshot to a permanent file.\n");
777 copy_succeeded = android::os::CopyFileToFd(DEFAULT_SCREENSHOT_PATH,
778 ds.options_->screenshot_fd.get());
Paul Chang0d2aad72020-02-13 20:04:03 +0800779 }
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +0000780 ds.options_->is_screenshot_copied = copy_succeeded;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000781 return android::binder::Status::ok();
782}
783
784android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
785 std::lock_guard<std::mutex> lock(lock_);
786 result_ = DENIED;
787 MYLOGW("User denied consent to share bugreport\n");
788 return android::binder::Status::ok();
789}
790
791UserConsentResult Dumpstate::ConsentCallback::getResult() {
792 std::lock_guard<std::mutex> lock(lock_);
793 return result_;
794}
795
796uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800797 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000798}
799
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700800void Dumpstate::PrintHeader() const {
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200801 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700802 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700803
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700804 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
805 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700806 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
807 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
808 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200809 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700810 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700811
Felipe Lemed8b94e52016-12-08 10:21:44 -0800812 printf("========================================================\n");
813 printf("== dumpstate: %s\n", date);
814 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700815
Felipe Lemed8b94e52016-12-08 10:21:44 -0800816 printf("\n");
817 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700818 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800819 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
820 printf("Bootloader: %s\n", bootloader.c_str());
821 printf("Radio: %s\n", radio.c_str());
822 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100823 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
824 if (module_metadata_version != 0) {
825 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
826 }
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200827 printf("Android SDK version: %s\n", sdkversion.c_str());
828 printf("SDK extensions: ");
829 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
830 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700831
Felipe Lemed8b94e52016-12-08 10:21:44 -0800832 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800833 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800834 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000835 printf("Bootconfig: ");
836 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800837 printf("Uptime: ");
838 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
839 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800840 printf("Bugreport format version: %s\n", version_.c_str());
Kevin Jeonfa64e642023-07-27 11:36:41 -0400841 printf(
842 "Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d strict_run=%d args=%s "
843 "bugreport_mode=%s\n",
844 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
845 PropertiesHelper::IsStrictRun(), options_->args.c_str(),
846 options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800847 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800848}
849
Felipe Leme24b66ee2016-06-16 10:55:26 -0700850// List of file extensions that can cause a zip file attachment to be rejected by some email
851// service providers.
852static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
853 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
854 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
855 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
856};
857
Vishnu Naire97d6122018-01-18 13:58:56 -0800858status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
859 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700860 std::string valid_name = entry_name;
861
862 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700863 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700864 if (idx != std::string::npos) {
865 std::string extension = entry_name.substr(idx);
866 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
867 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
868 valid_name = entry_name + ".renamed";
869 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
870 }
871 }
872
Felipe Leme6fe9db62016-02-12 09:04:16 -0800873 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
874 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000875 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
876 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700877 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700878 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700879 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700880 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800881 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800882 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000883 bool finished_entry = false;
884 auto finish_entry = [this, &finished_entry] {
885 if (!finished_entry) {
886 // This should only be called when we're going to return an earlier error,
887 // which would've been logged. This may imply the file is already corrupt
888 // and any further logging from FinishEntry is more likely to mislead than
889 // not.
890 this->zip_writer_->FinishEntry();
891 }
892 };
893 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800894 auto start = std::chrono::steady_clock::now();
895 auto end = start + timeout;
896 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800897
Felipe Leme770410d2016-01-26 17:07:14 -0800898 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800899 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800900 if (timeout.count() > 0) {
901 // lambda to recalculate the timeout.
902 auto time_left_ms = [end]() {
903 auto now = std::chrono::steady_clock::now();
904 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
905 return std::max(diff.count(), 0LL);
906 };
907
908 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
909 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000910 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
911 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800912 return -errno;
913 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000914 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800915 entry_name.c_str(), strerror(errno), timeout.count());
916 return TIMED_OUT;
917 }
918 }
919
Zach Riggle22200402016-08-18 01:01:24 -0400920 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800921 if (bytes_read == 0) {
922 break;
923 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800924 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800925 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800926 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700927 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700929 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800930 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800931 }
932 }
933
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700934 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000935 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700936 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700937 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800938 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800939 }
940
Vishnu Naire97d6122018-01-18 13:58:56 -0800941 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800942}
943
Felipe Leme1d486fe2016-10-14 18:06:47 -0700944bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
945 android::base::unique_fd fd(
946 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700947 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800948 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800949 return false;
950 }
951
Vishnu Naire97d6122018-01-18 13:58:56 -0800952 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800953}
954
955/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700956static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800957 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800958}
959
Felipe Leme1d486fe2016-10-14 18:06:47 -0700960void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700961 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800962 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700963 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800964}
965
Felipe Leme1d486fe2016-10-14 18:06:47 -0700966bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800967 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000968 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
969 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700970 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700971 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700972 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800973 return false;
974 }
975
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700976 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700977 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700978 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700979 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800980 return false;
981 }
982
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700983 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700984 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700985 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800986 return false;
987 }
988
989 return true;
990}
991
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800992static void DoKmsg() {
993 struct stat st;
994 if (!stat(PSTORE_LAST_KMSG, &st)) {
995 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
996 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
997 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
998 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
999 } else {
1000 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
1001 DumpFile("LAST KMSG", "/proc/last_kmsg");
1002 }
1003}
1004
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001005static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -08001006 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001007 RunCommand(
1008 "KERNEL LOG",
1009 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1010 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1011}
1012
Nandana Duttdb379fa2019-10-09 16:54:41 +01001013static void DoSystemLogcat(time_t since) {
1014 char since_str[80];
1015 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
1016
1017 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
1018 RunCommand("SYSTEM LOG",
1019 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1020 since_str},
1021 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1022}
1023
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001024static void DoRadioLogcat() {
1025 unsigned long timeout_ms = logcat_timeout({"radio"});
1026 RunCommand(
1027 "RADIO LOG",
1028 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1029 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1030}
1031
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001032static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001033 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001034 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1035 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001036 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001037 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001038 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1039 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001040 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001041 RunCommand(
1042 "EVENT LOG",
1043 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001044 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001045 timeout_ms = logcat_timeout({"stats"});
1046 RunCommand(
1047 "STATS LOG",
1048 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001049 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001050 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001051
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001052 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001053 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1054 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001055}
1056
Mike Ma5c267872019-08-21 11:31:34 -07001057static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001058 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1059 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1060 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1061 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1062 if (fd < 0) {
1063 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1064 return;
1065 }
Kevin Jeonfa64e642023-07-27 11:36:41 -04001066 RunCommandToFd(fd, "", {"incident", "-u"},
1067 CommandOptions::WithTimeout(PropertiesHelper::IsStrictRun() ? 20 : 120).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001068 bool empty = 0 == lseek(fd, 0, SEEK_END);
1069 if (!empty) {
1070 // Use a different name from "incident.proto"
1071 // /proto/incident.proto is reserved for incident service dump
1072 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001073 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1074 path);
1075 } else {
1076 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001077 }
Mike Ma5c267872019-08-21 11:31:34 -07001078}
1079
Aaron Huang24d215d2022-04-27 18:51:16 +08001080static void DumpNetstatsProto() {
1081 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1082 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1083 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1084 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1085 if (fd < 0) {
1086 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1087 return;
1088 }
1089 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001090 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001091 bool empty = 0 == lseek(fd, 0, SEEK_END);
1092 if (!empty) {
1093 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1094 path);
1095 } else {
1096 unlink(path.c_str());
1097 }
1098}
1099
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001100static void MaybeAddSystemTraceToZip() {
1101 // This function copies into the .zip the system trace that was snapshotted
Kean Mariottica20f2d2023-12-15 09:34:25 +00001102 // by the early call to MaybeSnapshotSystemTraceAsync(), if any background
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001103 // tracing was happening.
Kean Mariotti853b73a2023-07-27 12:40:30 +00001104 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
1105 if (!system_trace_exists) {
Kean Mariottica20f2d2023-12-15 09:34:25 +00001106 // No background trace was happening at the time MaybeSnapshotSystemTraceAsync() was invoked
Kean Mariotti853b73a2023-07-27 12:40:30 +00001107 if (!PropertiesHelper::IsUserBuild()) {
1108 MYLOGI(
1109 "No system traces found. Check for previously uploaded traces by looking for "
1110 "go/trace-uuid in logcat")
1111 }
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001112 return;
1113 }
1114 ds.AddZipEntry(
1115 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1116 SYSTEM_TRACE_SNAPSHOT);
1117 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1118}
1119
Sunny Goyal35949782019-11-19 15:54:36 -08001120static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001121 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1122 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1123 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1124 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1125 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1126 if (fd < 0) {
1127 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1128 return;
1129 }
1130 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001131 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001132 bool empty = 0 == lseek(fd, 0, SEEK_END);
1133 if (!empty) {
1134 ds.AddZipEntry("visible_windows.zip", path);
1135 } else {
1136 MYLOGW("Failed to dump visible windows\n");
1137 }
1138 unlink(path.c_str());
1139}
1140
Jayachandran Ca94c7172017-06-10 15:08:12 -07001141static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001142 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1143 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001144 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001145 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001146 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1147 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1148 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1149 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001150}
1151
Woody Lin20767a92022-11-29 15:50:24 +08001152static void DumpShutdownCheckpoints() {
1153 const bool shutdown_checkpoints_dumped = AddDumps(
1154 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1155 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1156 if (!shutdown_checkpoints_dumped) {
1157 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1158 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1159 }
1160}
1161
David Andersond9ba4752018-12-11 18:26:59 -08001162static void DumpDynamicPartitionInfo() {
1163 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1164 return;
1165 }
1166
1167 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001168 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001169}
1170
Chris Morin5a50d482022-02-01 17:41:18 -08001171static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001172 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1173 anr_traces_dir.c_str());
1174
1175 // If we're here, dump_traces_path will always be a temporary file
1176 // (created with mkostemp or similar) that contains dumps taken earlier
1177 // on in the process.
1178 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001179 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1180 dump_traces_path);
1181 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001182
1183 const int ret = unlink(dump_traces_path);
1184 if (ret == -1) {
1185 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1186 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001187 }
1188 }
1189
Narayan Kamathbd863722017-06-01 18:50:12 +01001190 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001191 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001192 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001193 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001194 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001195
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001196 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001197 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001198 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001199 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001200 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1201 }
Andy Hungd62f7e62024-01-11 15:47:52 -08001202
1203 // Add Java anr traces (such as generated by the Finalizer Watchdog).
1204 AddDumps(ds.anr_trace_data_.begin(), ds.anr_trace_data_.end(), "JAVA ANR TRACES",
1205 true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001206}
1207
1208static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001209 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001210
Chris Morin5a50d482022-02-01 17:41:18 -08001211 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001212
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001213 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1214
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001215 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001216 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001217 int i = 0;
1218 while (true) {
1219 const std::string slow_trace_path =
1220 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1221 if (stat(slow_trace_path.c_str(), &st)) {
1222 // No traces file at this index, done with the files.
1223 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001224 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001225 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1226 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001227 }
1228}
1229
Wei Wang509bb5d2017-06-09 14:42:12 -07001230static void DumpBlockStatFiles() {
1231 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001232
Wei Wang1dc1ef52017-06-12 11:28:37 -07001233 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1234
1235 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001236 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1237 return;
1238 }
1239
1240 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001241 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001242 if ((d->d_name[0] == '.')
1243 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1244 || (d->d_name[1] == '\0'))) {
1245 continue;
1246 }
1247 const std::string new_path =
1248 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1249 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1250 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1251 printf("\n");
1252 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001253 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001254}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001255
1256static void DumpPacketStats() {
1257 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001258}
1259
1260static void DumpIpAddrAndRules() {
1261 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
Ray Chencbf278a2023-11-20 07:49:45 +00001262 RunCommand("NETWORK INTERFACES", {"ip", "-s", "link"});
Jayachandran Ca94c7172017-06-10 15:08:12 -07001263 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1264 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1265 RunCommand("IP RULES", {"ip", "rule", "show"});
1266 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1267}
1268
Alessio Balsini9e332a72024-12-10 15:31:57 +00001269static void DumpKernelMemoryAllocations() {
1270 if (!access("/proc/allocinfo", F_OK)) {
1271 // Print the top 100 biggest memory allocations of at least one byte.
1272 // The output is sorted by size, descending.
1273 RunCommand("KERNEL MEMORY ALLOCATIONS",
1274 {"alloctop", "--once", "--sort", "s", "--min", "1", "--lines", "100"});
1275 }
1276}
1277
Steven Moreland0d564d52025-01-10 22:24:57 +00001278// BAD - See README.md: "Dumpstate philosophy: exec not link"
1279// This should all be moved into a separate binary rather than have complex logic here.
Nandana Dutt5c390032019-03-12 10:52:56 +00001280static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1281 std::chrono::milliseconds timeout,
1282 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001283 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001284 sp<android::IServiceManager> sm = defaultServiceManager();
1285 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001286 Vector<String16> args;
1287 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001288 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1289 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001290 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001291 std::string path(title);
1292 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001293 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001294 if (PropertiesHelper::IsDryRun()) {
1295 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1296 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1297 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001298 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1299 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001300 service, args);
1301 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001302 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1303 std::chrono::duration<double> elapsed_seconds;
1304 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1305 service == String16("meminfo")) {
1306 // Use a longer timeout for meminfo, since 30s is not always enough.
1307 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1308 /* as_proto = */ false, elapsed_seconds,
1309 bytes_written);
1310 } else {
1311 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1312 /* as_proto = */ false, elapsed_seconds,
1313 bytes_written);
1314 }
1315 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1316 bool dump_complete = (status == OK);
1317 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001318 } else {
1319 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1320 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001321 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001322 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001323
1324 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1325 std::chrono::steady_clock::now() - start);
1326 if (elapsed_duration > timeout) {
1327 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1328 elapsed_duration.count());
1329 break;
1330 }
1331 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001332 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001333}
1334
Vishnu Nair64afc022018-02-01 15:29:34 -08001335static void RunDumpsysText(const std::string& title, int priority,
1336 std::chrono::milliseconds timeout,
1337 std::chrono::milliseconds service_timeout) {
1338 DurationReporter duration_reporter(title);
1339 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1340 fsync(STDOUT_FILENO);
1341 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1342}
1343
1344/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001345static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1346 std::chrono::milliseconds timeout,
1347 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001348 DurationReporter duration_reporter(title);
1349 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1350 fsync(STDOUT_FILENO);
1351 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1352 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001353
1354 RETURN_IF_USER_DENIED_CONSENT();
1355
1356 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1357 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001358}
1359
Steven Moreland0d564d52025-01-10 22:24:57 +00001360// BAD - See README.md: "Dumpstate philosophy: exec not link"
1361// This should all be moved into a separate binary rather than have complex logic here.
Nandana Dutt5c390032019-03-12 10:52:56 +00001362static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1363 std::chrono::milliseconds timeout,
1364 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001365 sp<android::IServiceManager> sm = defaultServiceManager();
1366 Dumpsys dumpsys(sm.get());
1367 Vector<String16> args;
1368 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1369 DurationReporter duration_reporter(title);
1370
1371 auto start = std::chrono::steady_clock::now();
1372 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1373 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001374 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001375 std::string path(kProtoPath);
1376 path.append(String8(service).c_str());
1377 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1378 path.append("_CRITICAL");
1379 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1380 path.append("_HIGH");
1381 }
1382 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001383 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001384 if (status == OK) {
1385 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1386 bool dumpTerminated = (status == OK);
1387 dumpsys.stopDumpThread(dumpTerminated);
1388 }
1389 ZipWriter::FileEntry file_entry;
1390 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001391
1392 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1393 std::chrono::steady_clock::now() - start);
1394 if (elapsed_duration > timeout) {
1395 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1396 elapsed_duration.count());
1397 break;
1398 }
1399 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001400 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001401}
1402
Nandana Dutta7db6342018-11-21 14:53:34 +00001403// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001404static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001405 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1406 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001407
1408 RETURN_IF_USER_DENIED_CONSENT();
1409
1410 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1411 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001412}
1413
1414// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001415static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001416 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1417 // high priority. Reduce timeout once they are able to dump in a shorter time or
1418 // moved to a parallel task.
1419 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1420 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001421
1422 RETURN_IF_USER_DENIED_CONSENT();
1423
1424 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1425 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001426}
1427
1428// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001429static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001430 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001431
1432 RETURN_IF_USER_DENIED_CONSENT();
1433
1434 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1435 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001436}
1437
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001438/*
1439 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1440 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1441 * if it's not running in the parallel task.
1442 */
Steven Moreland0d564d52025-01-10 22:24:57 +00001443// BAD - See README.md: "Dumpstate philosophy: exec not link"
1444// This should all be moved into a separate binary rather than have complex logic here.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001445static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001446 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001447 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1448 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001449
Steven Moreland44cd9482018-01-04 16:24:13 -08001450 using android::hidl::manager::V1_0::IServiceManager;
1451 using android::hardware::defaultServiceManager;
1452
1453 sp<IServiceManager> sm = defaultServiceManager();
1454 if (sm == nullptr) {
1455 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1456 return;
1457 }
1458
1459 auto ret = sm->list([&](const auto& interfaces) {
1460 for (const std::string& interface : interfaces) {
1461 std::string cleanName = interface;
Steven Morelandc6b1fc22023-07-26 23:53:58 +00001462 std::replace_if(
1463 cleanName.begin(), cleanName.end(),
1464 [](char c) {
1465 return !isalnum(c) && std::string("@-_.").find(c) == std::string::npos;
1466 },
1467 '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001468 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001469
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001470 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001471 {
1472 auto fd = android::base::unique_fd(
1473 TEMP_FAILURE_RETRY(open(path.c_str(),
1474 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1475 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1476 if (fd < 0) {
1477 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1478 continue;
1479 }
1480 RunCommandToFd(fd,
1481 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001482 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001483 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1484
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001485 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001486 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001487 if (!empty) {
1488 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1489 path);
1490 } else {
1491 unlink(path.c_str());
1492 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001493 }
1494 });
1495
1496 if (!ret.isOk()) {
1497 MYLOGE("Could not list hals from hwservicemanager.\n");
1498 }
1499}
1500
Steven Moreland0d564d52025-01-10 22:24:57 +00001501// BAD - See README.md: "Dumpstate philosophy: exec not link"
1502// This should all be moved into a separate binary rather than have complex logic here.
1503//
Devin Moore8df81bb2022-06-08 22:47:02 +00001504// Dump all of the files that make up the vendor interface.
1505// See the files listed in dumpFileList() for the latest list of files.
1506static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001507
1508 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1509 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001510 for (const auto vintfFile : vintfFiles) {
1511 struct stat st;
1512 if (stat(vintfFile.c_str(), &st) == 0) {
1513 if (S_ISDIR(st.st_mode)) {
1514 ds.AddDir(vintfFile, true /* recursive */);
1515 } else {
1516 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1517 vintfFile);
1518 }
1519 }
1520 }
1521}
1522
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001523static void DumpExternalFragmentationInfo() {
1524 struct stat st;
1525 if (stat("/proc/buddyinfo", &st) != 0) {
1526 MYLOGE("Unable to dump external fragmentation info\n");
1527 return;
1528 }
1529
1530 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1531 std::ifstream ifs("/proc/buddyinfo");
1532 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
Steven Moreland0d564d52025-01-10 22:24:57 +00001533 // BAD - See README.md: "Dumpstate philosophy: exec not link"
1534 // This should all be moved into a separate binary rather than have complex logic here.
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001535 for (std::string line; std::getline(ifs, line);) {
1536 std::smatch match_results;
1537 if (std::regex_match(line, match_results, unusable_index_regex)) {
1538 std::stringstream free_pages(std::string{match_results[3]});
1539 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1540 std::istream_iterator<int>());
1541
1542 int total_free_pages = 0;
1543 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1544 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1545 }
1546
1547 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1548 match_results[2].str().c_str());
1549
1550 int usable_free_pages = total_free_pages;
1551 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1552 auto unusable_index = (total_free_pages - usable_free_pages) /
1553 static_cast<double>(total_free_pages);
1554 printf(" %5.3f", unusable_index);
1555 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1556 }
1557
1558 printf("\n");
1559 }
1560 }
1561 printf("\n");
1562}
1563
mhasankd451a472020-05-26 18:02:39 -07001564static void DumpstateLimitedOnly() {
EdenSue8fe4522023-11-20 15:37:23 +08001565 // Trimmed-down version of dumpstate to only include a allowlisted
mhasankd451a472020-05-26 18:02:39 -07001566 // set of logs (system log, event log, and system server / system app
1567 // crashes, and networking logs). See b/136273873 and b/138459828
1568 // for context.
1569 DurationReporter duration_reporter("DUMPSTATE");
1570 unsigned long timeout_ms;
1571 // calculate timeout
1572 timeout_ms = logcat_timeout({"main", "system", "crash"});
1573 RunCommand("SYSTEM LOG",
1574 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1575 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1576 timeout_ms = logcat_timeout({"events"});
1577 RunCommand(
1578 "EVENT LOG",
1579 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1580 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1581
1582 printf("========================================================\n");
1583 printf("== Networking Service\n");
1584 printf("========================================================\n");
1585
1586 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1587 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001588 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1589 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001590
1591 printf("========================================================\n");
Chuwei Hecc54a252024-07-25 15:18:36 +09001592 printf("== Networking Policy\n");
1593 printf("========================================================\n");
1594
1595 RunDumpsys("DUMPSYS NETWORK POLICY", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(),
1596 SEC_TO_MSEC(10));
1597
1598 printf("========================================================\n");
mhasankd451a472020-05-26 18:02:39 -07001599 printf("== Dropbox crashes\n");
1600 printf("========================================================\n");
1601
1602 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1603 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1604
Bryan Yuefb85d92024-02-02 13:37:06 +00001605
1606 printf("========================================================\n");
1607 printf("== ANR Traces\n");
1608 printf("========================================================\n");
1609
Bryan Yucf038cf2024-05-08 09:25:25 +00001610 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Bryan Yuefb85d92024-02-02 13:37:06 +00001611 AddAnrTraceFiles();
1612
mhasankd451a472020-05-26 18:02:39 -07001613 printf("========================================================\n");
1614 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1615 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1616 printf("========================================================\n");
1617 printf("== dumpstate: done (id %d)\n", ds.id_);
1618 printf("========================================================\n");
1619}
1620
Rhed Jaoe017f982020-07-21 17:58:41 +08001621/*
1622 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1623 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1624 * if it's not running in the parallel task.
1625 */
1626static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1627 dprintf(out_fd, "========================================================\n");
1628 dprintf(out_fd, "== Checkins\n");
1629 dprintf(out_fd, "========================================================\n");
1630
1631 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001632 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1633 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1634 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1635 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1636}
1637
1638/*
1639 * Runs dumpsys on activity service to dump all application activities, services
1640 * and providers in the device.
1641 *
1642 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1643 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1644 * if it's not running in the parallel task.
1645 */
1646static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1647 dprintf(out_fd, "========================================================\n");
1648 dprintf(out_fd, "== Running Application Activities\n");
1649 dprintf(out_fd, "========================================================\n");
1650
1651 // The following dumpsys internally collects output from running apps, so it can take a long
1652 // time. So let's extend the timeout.
1653
1654 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1655
1656 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1657
1658 dprintf(out_fd, "========================================================\n");
1659 dprintf(out_fd, "== Running Application Services (platform)\n");
1660 dprintf(out_fd, "========================================================\n");
1661
1662 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1663 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1664
1665 dprintf(out_fd, "========================================================\n");
1666 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1667 dprintf(out_fd, "========================================================\n");
1668
1669 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1670 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1671
1672 dprintf(out_fd, "========================================================\n");
1673 dprintf(out_fd, "== Running Application Providers (platform)\n");
1674 dprintf(out_fd, "========================================================\n");
1675
1676 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001677 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001678
1679 dprintf(out_fd, "========================================================\n");
1680 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1681 dprintf(out_fd, "========================================================\n");
1682
1683 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1684 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1685}
1686
Nandana Dutt5c390032019-03-12 10:52:56 +00001687// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1688// via the consent they are shown. Ignores other errors that occur while running various
1689// commands. The consent checking is currently done around long running tasks, which happen to
1690// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001691Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001692 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001693
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001694 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001695 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariottica20f2d2023-12-15 09:34:25 +00001696 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001697 if (ds.dump_pool_) {
1698 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001699 // drop root user. Restarts it.
1700 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001701
Chris Morinbc223142022-02-04 14:17:11 -08001702 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1703 dump_incident_report = ds.dump_pool_->enqueueTask(
1704 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001705 dump_netstats_report = ds.dump_pool_->enqueueTask(
1706 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001707 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1708 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1709 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001710 }
1711
Nandana Dutt5c390032019-03-12 10:52:56 +00001712 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1713 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1714 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001715 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001716 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001717 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001718 DumpFile("MEMORY INFO", "/proc/meminfo");
1719 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001720 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001721
Kevin Jeon947922b2022-09-21 00:29:18 +00001722 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1723 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001724
Sunny Goyal35949782019-11-19 15:54:36 -08001725 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1726
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001727 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1728 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1729 DumpFile("SLAB INFO", "/proc/slabinfo");
1730 DumpFile("ZONEINFO", "/proc/zoneinfo");
1731 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1732 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001733 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001734
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001735 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001736
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001737 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001738 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001739
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001740 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001741 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001742 } else {
1743 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1744 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001745
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001746 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001747 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001748 struct stat s;
1749 if (stat("/proc/modules", &s) != 0) {
1750 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1751 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001752 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001753 RunCommand("MODULES INFO",
1754 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1755 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1756 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001757 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001758
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001759 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001760 DoKernelLogcat();
1761 } else {
1762 do_dmesg();
1763 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001764
Devin Moore8df81bb2022-06-08 22:47:02 +00001765 DumpVintf();
1766
Felipe Lemef0292972016-11-22 13:57:05 -08001767 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001768
Jeff Brown1dc94e32014-09-11 14:15:27 -07001769 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001770 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001771
Jack Yu5a6b2e22020-08-14 18:13:35 +08001772 /* Dump Nfc NCI logs */
1773 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001774
Paul Chang0d2aad72020-02-13 20:04:03 +08001775 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001776 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001777 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001778 }
1779
Felipe Lemee184f662016-10-27 10:04:47 -07001780 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001781
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001782 MaybeAddSystemTraceToZip();
1783
Narayan Kamath8f788292017-05-25 13:20:39 +01001784 // NOTE: tombstones are always added as separate entries in the zip archive
1785 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001786 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001787 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001788 if (!tombstones_dumped) {
1789 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001790 }
1791
Jayachandran Ca94c7172017-06-10 15:08:12 -07001792 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001793
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001794 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001795
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001796 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001797
Alessio Balsini9e332a72024-12-10 15:31:57 +00001798 DumpKernelMemoryAllocations();
1799
Woody Lin20767a92022-11-29 15:50:24 +08001800 DumpShutdownCheckpoints();
1801
Jayachandran Ca94c7172017-06-10 15:08:12 -07001802 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001803
1804 dump_route_tables();
1805
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001806 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1807 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1808 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001809
Nandana Dutt5c390032019-03-12 10:52:56 +00001810 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001811
Chiachang Wang668ede42021-05-17 17:14:20 +08001812 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1813 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1814 // dump with priority parameters to dump high priority information.
1815 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1816 CommandOptions::WithTimeout(10).Build());
1817
Elliott Hughes23ccc622017-02-28 10:14:22 -08001818 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001819
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001820 DumpFile("SYSTEM BUILD-TIME RELEASE FLAGS", "/system/etc/build_flags.json");
1821 DumpFile("SYSTEM_EXT BUILD-TIME RELEASE FLAGS", "/system_ext/etc/build_flags.json");
1822 DumpFile("PRODUCT BUILD-TIME RELEASE FLAGS", "/product/etc/build_flags.json");
1823 DumpFile("VENDOR BUILD-TIME RELEASE FLAGS", "/vendor/etc/build_flags.json");
1824
Ted Bauerf6d61b82024-09-13 19:57:19 +00001825 RunCommand("ACONFIG FLAGS DUMP", {AFLAGS, "list"},
1826 CommandOptions::WithTimeout(10).Always().AsRootIfAvailable().Build());
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001827
Jin Qianf334d662017-10-10 14:41:37 -07001828 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001829
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001830 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001831
Colin Crossf45fa6b2012-03-26 12:38:26 -07001832 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001833 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1834 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1835
1836 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1837 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1838 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1839 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1840 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001841
Yifan Hongd90cc652020-02-08 16:52:02 -08001842 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1843
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001844 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001845 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001846 } else {
1847 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1848 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001849
Steven Moreland7440ddb2016-12-15 16:13:39 -08001850 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001851 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1852 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001853 // su does not exist on user builds, so try running without it.
1854 // This way any implementations of vril-dump that do not require
1855 // root can run on user builds.
1856 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001857 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001858 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001859 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001860 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001861 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001862 }
1863
Radud0776152024-10-29 12:08:54 +00001864 /* Dump USB information */
1865 RunCommand("typec_connector_class", {"typec_connector_class"},
1866 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1867 RunCommand("lsusb", {"lsusb"}, CommandOptions::WithTimeout(10).AsRootIfAvailable().Build());
1868
Felipe Lemed8b94e52016-12-08 10:21:44 -08001869 printf("========================================================\n");
1870 printf("== Android Framework Services\n");
1871 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001872
Nandana Dutt5c390032019-03-12 10:52:56 +00001873 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001874
Jack He91ff2fe2021-02-18 18:23:43 -08001875 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1876 ds.AddDir("/data/misc/bluetooth/logs", true);
1877
Rhed Jaoe017f982020-07-21 17:58:41 +08001878 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001879 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001880 } else {
1881 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1882 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001883
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001884 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001885
Adrian Roos8b397ab2017-04-04 16:35:44 -07001886 printf("========================================================\n");
1887 printf("== Dropbox crashes\n");
1888 printf("========================================================\n");
1889
1890 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1891 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1892
Felipe Lemed8b94e52016-12-08 10:21:44 -08001893 printf("========================================================\n");
1894 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1895 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1896 printf("========================================================\n");
1897 printf("== dumpstate: done (id %d)\n", ds.id_);
1898 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001899
1900 printf("========================================================\n");
1901 printf("== Obtaining statsd metadata\n");
1902 printf("========================================================\n");
1903 // This differs from the usual dumpsys stats, which is the stats report data.
1904 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001905
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001906 // Add linker configuration directory
1907 ds.AddDir(LINKERCONFIG_DIR, true);
1908
Li Li830179f2022-01-04 12:53:29 -08001909 /* Dump frozen cgroupfs */
1910 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001911
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001912 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001913 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1914 } else {
1915 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1916 DumpNetstatsProto);
1917 }
1918
1919 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001920 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001921 } else {
1922 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1923 DumpIncidentReport);
1924 }
Mike Ma5c267872019-08-21 11:31:34 -07001925
Kean Mariotti306633e2022-09-05 16:30:47 +00001926 MaybeAddUiTracesToZip();
1927
Nandana Dutt5c390032019-03-12 10:52:56 +00001928 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001929}
1930
Nandana Dutt5c390032019-03-12 10:52:56 +00001931/*
1932 * Dumps state for the default case; drops root after it's no longer necessary.
1933 *
1934 * Returns RunStatus::OK if everything went fine.
1935 * Returns RunStatus::ERROR if there was an error.
1936 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1937 * with the caller.
1938 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001939Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001940 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1941 // buffer.
1942 DoLogcat();
1943 // Capture timestamp after first logcat to use in next logcat
1944 time_t logcat_ts = time(nullptr);
1945
Nandana Dutt4be45d12018-09-26 15:04:23 +01001946 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001947 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001948 if (dump_pool_) {
1949 RETURN_IF_USER_DENIED_CONSENT();
1950 // One thread is enough since we only need to enqueue DumpTraces here.
1951 dump_pool_->start(/* thread_counts = */1);
1952
1953 // DumpTraces takes long time, post it to the another thread in the
1954 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001955 dump_traces = dump_pool_->enqueueTask(
1956 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001957 } else {
1958 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1959 &dump_traces_path);
1960 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001961
1962 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001963 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001964 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1965 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Andy Hungd62f7e62024-01-11 15:47:52 -08001966 ds.anr_trace_data_ = GetDumpFds(ANR_DIR, ANR_TRACE_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001967 ds.shutdown_checkpoints_ = GetDumpFds(
1968 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001969 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001970
1971 ds.AddDir(RECOVERY_DIR, true);
1972 ds.AddDir(RECOVERY_DATA_DIR, true);
1973 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001974 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001975 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1976 if (!PropertiesHelper::IsUserBuild()) {
1977 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1978 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001979 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001980 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001981 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001982 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001983 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1984 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1985 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001986 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001987 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001988 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001989 if (!PropertiesHelper::IsUserBuild()) {
1990 // Include dropbox entry files inside ZIP, but exclude
1991 // noisy WTF and StrictMode entries
1992 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1993 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001994
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001995 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001996 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1997
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001998 // Dump IPsec stats. No keys are exposed here.
1999 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
2000
Nandana Dutt4be45d12018-09-26 15:04:23 +01002001 // Run ss as root so we can see socket marks.
2002 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
2003
2004 // Run iotop as root to show top 100 IO threads
2005 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
2006
Erick Reyese68df822019-02-11 14:46:36 -08002007 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08002008 RunCommand("Dmabuf dump", {"dmabuf_dump"});
2009 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08002010
Minchan Kim22c6a1e2019-09-30 15:58:10 -07002011 DumpFile("PSI cpu", "/proc/pressure/cpu");
2012 DumpFile("PSI memory", "/proc/pressure/memory");
2013 DumpFile("PSI io", "/proc/pressure/io");
2014
Steven Moreland9379c462023-12-21 02:04:27 +00002015 ds.AddZipEntry(ZIP_ROOT_DIR + KERNEL_CONFIG, KERNEL_CONFIG);
2016
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +02002017 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
2018 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
2019
Nattharat Jariyanuntanaetb250cae2024-05-15 07:48:19 +00002020 // Dump UWB UCI logs here because apexdata requires root access
2021 ds.AddDir(UWB_LOG_DIR, true);
2022
Rhed Jao5377d792020-07-16 17:37:39 +08002023 if (dump_pool_) {
2024 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08002025 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08002026
Chris Morinbc223142022-02-04 14:17:11 -08002027 // Current running thread in the pool is the root user also. Delete
2028 // the pool and make a new one later to ensure none of threads in the pool are root.
2029 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08002030 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01002031 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00002032 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002033 }
2034
Nandana Dutt5c390032019-03-12 10:52:56 +00002035 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01002036 Dumpstate::RunStatus status = dumpstate();
2037 // Capture logcat since the last time we did it.
2038 DoSystemLogcat(logcat_ts);
2039 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002040}
2041
Rhed Jaob5685b32020-08-14 17:19:17 +08002042// Common states for telephony and wifi which are needed to be collected before
2043// dumpstate drop the root user.
2044static void DumpstateRadioAsRoot() {
2045 DumpIpTablesAsRoot();
2046 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2047}
2048
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002049// This method collects common dumpsys for telephony and wifi. Typically, wifi
2050// reports are fine to include all information, but telephony reports on user
2051// builds need to strip some content (see DumpstateTelephonyOnly).
2052static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002053 // We need to be picky about some stuff for telephony reports on user builds.
2054 if (!include_sensitive_info) {
2055 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
2056 DoRadioLogcat();
2057 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08002058 // DumpHals takes long time, post it to the another thread in the pool,
2059 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002060 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08002061 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002062 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002063 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002064 // Contains various system properties and process startup info.
2065 do_dmesg();
2066 // Logs other than the radio buffer may contain package/component names and potential PII.
2067 DoLogcat();
2068 // Too broad for connectivity problems.
2069 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08002070 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
2071 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002072 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08002073 } else {
2074 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
2075 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002076 }
2077
Jayachandran Ca94c7172017-06-10 15:08:12 -07002078 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002079 DumpIpAddrAndRules();
2080 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002081 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2082 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002083}
2084
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002085// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2086// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2087// for what can be included on user builds: all reported information MUST directly relate to
2088// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2089// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2090// names are not), and MUST NOT contain logs of user application traffic.
2091// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002092static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002093 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002094
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002095 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002096
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002097 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002098
Rhed Jaob5685b32020-08-14 17:19:17 +08002099 DumpstateRadioAsRoot();
2100 if (!DropRootUser()) {
2101 return;
2102 }
2103
2104 // Starts thread pool after the root user is dropped, and two additional threads
2105 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002106 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002107 if (ds.dump_pool_) {
2108 ds.dump_pool_->start(/*thread_counts =*/2);
2109
2110 // DumpstateBoard takes long time, post it to the another thread in the pool,
2111 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002112 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2113 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002114 }
2115
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002116 DumpstateRadioCommon(include_sensitive_info);
2117
2118 if (include_sensitive_info) {
2119 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2120 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2121 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2122 // way.
2123 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2124 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002125
2126 printf("========================================================\n");
2127 printf("== Android Framework Services\n");
2128 printf("========================================================\n");
2129
Vishnu Nair652cc802017-11-30 15:18:30 -08002130 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2131 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002132 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2133 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002134 if (include_sensitive_info) {
2135 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2136 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2137 SEC_TO_MSEC(10));
2138 } else {
2139 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2140 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2141 // give a higher timeout as well.
2142 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2143 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2144 }
2145 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002146 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2147 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002148 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002149 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2150 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002151 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2152 SEC_TO_MSEC(10));
Grant Menke56698972023-02-24 13:11:07 -08002153 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2154 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002155 if (include_sensitive_info) {
2156 // Contains raw IP addresses, omit from reports on user builds.
2157 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2158 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2159 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2160 SEC_TO_MSEC(10));
2161 // Contains package/component names, omit from reports on user builds.
2162 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2163 SEC_TO_MSEC(10));
2164 // Contains package names, but should be relatively simple to remove them (also contains
2165 // UIDs already), omit from reports on user builds.
2166 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2167 SEC_TO_MSEC(10));
2168 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002169
2170 printf("========================================================\n");
2171 printf("== Running Application Services\n");
2172 printf("========================================================\n");
2173
2174 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2175
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002176 if (include_sensitive_info) {
2177 printf("========================================================\n");
2178 printf("== Running Application Services (non-platform)\n");
2179 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002180
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002181 // Contains package/component names and potential PII, omit from reports on user builds.
2182 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2183 // carrier_config dumpsys instead.
2184 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2185 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002186
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002187 printf("========================================================\n");
2188 printf("== Checkins\n");
2189 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002190
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002191 // Contains package/component names, omit from reports on user builds.
2192 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2193 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002194
2195 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002196 printf("== dumpstate: done (id %d)\n", ds.id_);
2197 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002198
2199 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002200 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002201 } else {
2202 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2203 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002204}
2205
mukesh agrawal253dad42018-01-23 21:59:59 -08002206// This method collects dumpsys for wifi debugging only
2207static void DumpstateWifiOnly() {
2208 DurationReporter duration_reporter("DUMPSTATE");
2209
Rhed Jaob5685b32020-08-14 17:19:17 +08002210 DumpstateRadioAsRoot();
2211 if (!DropRootUser()) {
2212 return;
2213 }
2214
2215 // Starts thread pool after the root user is dropped. Only one additional
2216 // thread is needed for DumpHals in the DumpstateRadioCommon.
2217 if (ds.dump_pool_) {
2218 ds.dump_pool_->start(/*thread_counts =*/1);
2219 }
2220
mukesh agrawal253dad42018-01-23 21:59:59 -08002221 DumpstateRadioCommon();
2222
2223 printf("========================================================\n");
2224 printf("== Android Framework Services\n");
2225 printf("========================================================\n");
2226
2227 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2228 SEC_TO_MSEC(10));
2229 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2230 SEC_TO_MSEC(10));
2231
2232 printf("========================================================\n");
2233 printf("== dumpstate: done (id %d)\n", ds.id_);
2234 printf("========================================================\n");
2235}
2236
Elis Elliott8e401ad2023-08-08 11:18:59 +00002237// Collects a lightweight dumpstate to be used for debugging onboarding related flows.
2238static void DumpstateOnboardingOnly() {
2239 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2240}
2241
Christopher Ferris83e0e842024-05-31 13:13:34 -07002242static std::string GetTimestamp(const timespec& ts) {
2243 tm tm;
2244 localtime_r(&ts.tv_sec, &tm);
2245
2246 // Reserve enough space for the entire time string, includes the space
2247 // for the '\0' to make the calculations below easier by using size for
2248 // the total string size.
2249 std::string str(sizeof("1970-01-01 00:00:00.123456789+0830"), '\0');
2250 size_t n = strftime(str.data(), str.size(), "%F %H:%M", &tm);
2251 if (n == 0) {
2252 return "TIMESTAMP FAILURE";
2253 }
2254 int num_chars = snprintf(&str[n], str.size() - n, ":%02d.%09ld", tm.tm_sec, ts.tv_nsec);
2255 if (num_chars > str.size() - n) {
2256 return "TIMESTAMP FAILURE";
2257 }
2258 n += static_cast<size_t>(num_chars);
2259 if (strftime(&str[n], str.size() - n, "%z", &tm) == 0) {
2260 return "TIMESTAMP FAILURE";
2261 }
2262 return str;
2263}
2264
2265static std::string GetCmdline(pid_t pid) {
2266 std::string cmdline;
2267 if (!android::base::ReadFileToString(android::base::StringPrintf("/proc/%d/cmdline", pid),
2268 &cmdline)) {
2269 return "UNKNOWN";
2270 }
2271 // There are '\0' terminators between arguments, convert them to spaces.
2272 // But start by skipping all trailing '\0' values.
2273 size_t cur = cmdline.size() - 1;
2274 while (cur != 0 && cmdline[cur] == '\0') {
2275 cur--;
2276 }
2277 if (cur == 0) {
2278 return "UNKNOWN";
2279 }
2280 while ((cur = cmdline.rfind('\0', cur)) != std::string::npos) {
2281 cmdline[cur] = ' ';
2282 }
2283 return cmdline;
2284}
2285
2286static void DumpPidHeader(int fd, pid_t pid, const timespec& ts) {
2287 // For consistency, the header to this message matches the one
2288 // dumped by debuggerd.
2289 dprintf(fd, "\n----- pid %d at %s -----\n", pid, GetTimestamp(ts).c_str());
2290 dprintf(fd, "Cmd line: %s\n", GetCmdline(pid).c_str());
2291}
2292
2293static void DumpPidFooter(int fd, pid_t pid) {
2294 // For consistency, the footer to this message matches the one
2295 // dumped by debuggerd.
2296 dprintf(fd, "----- end %d -----\n", pid);
2297}
2298
2299static bool DumpBacktrace(int fd, pid_t pid, bool is_java_process) {
2300 int ret = dump_backtrace_to_file_timeout(
2301 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
2302 if (ret == -1 && is_java_process) {
2303 // Tried to unwind as a java process, try a native unwind.
2304 dprintf(fd, "Java unwind failed for pid %d, trying a native unwind.\n", pid);
2305 ret = dump_backtrace_to_file_timeout(pid, kDebuggerdNativeBacktrace, 3, fd);
2306 }
2307 return ret != -1;
2308}
2309
Nandana Duttcf419a72019-03-14 10:40:17 +00002310Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002311 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002312 const size_t buf_size = temp_file_pattern.length() + 1;
2313 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2314 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2315
2316 // Create a new, empty file to receive all trace dumps.
2317 //
2318 // TODO: This can be simplified once we remove support for the old style
2319 // dumps. We can have a file descriptor passed in to dump_traces instead
2320 // of creating a file, closing it and then reopening it again.
2321 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2322 if (fd < 0) {
2323 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002324 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002325 }
2326
2327 // Nobody should have access to this temporary file except dumpstate, but we
2328 // temporarily grant 'read' to 'others' here because this file is created
2329 // when tombstoned is still running as root, but dumped after dropping. This
2330 // can go away once support for old style dumping has.
2331 const int chmod_ret = fchmod(fd, 0666);
2332 if (chmod_ret < 0) {
2333 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002334 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002335 }
2336
2337 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2338 if (proc.get() == nullptr) {
2339 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002340 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002341 }
2342
2343 // Number of times process dumping has timed out. If we encounter too many
2344 // failures, we'll give up.
2345 int timeout_failures = 0;
2346 bool dalvik_found = false;
2347
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002348 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002349
2350 struct dirent* d;
2351 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002352 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002353 int pid = atoi(d->d_name);
2354 if (pid <= 0) {
2355 continue;
2356 }
2357
2358 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2359 std::string exe;
2360 if (!android::base::Readlink(link_name, &exe)) {
2361 continue;
2362 }
2363
2364 bool is_java_process;
2365 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2366 // Don't bother dumping backtraces for the zygote.
2367 if (IsZygote(pid)) {
2368 continue;
2369 }
2370
2371 dalvik_found = true;
2372 is_java_process = true;
2373 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2374 is_java_process = false;
2375 } else {
2376 // Probably a native process we don't care about, continue.
2377 continue;
2378 }
2379
2380 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2381 if (timeout_failures == 3) {
2382 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2383 break;
2384 }
2385
Christopher Ferris83e0e842024-05-31 13:13:34 -07002386 timespec start_timespec;
2387 clock_gettime(CLOCK_REALTIME, &start_timespec);
2388 if (IsCached(pid)) {
2389 DumpPidHeader(fd, pid, start_timespec);
2390 dprintf(fd, "Process is cached, skipping backtrace due to high chance of timeout.\n");
2391 DumpPidFooter(fd, pid);
2392 continue;
2393 }
Nandana Duttfaafd522019-03-11 09:23:09 +00002394
Christopher Ferris83e0e842024-05-31 13:13:34 -07002395 const uint64_t start = Nanotime();
2396 if (!DumpBacktrace(fd, pid, is_java_process)) {
2397 if (IsCached(pid)) {
2398 DumpPidHeader(fd, pid, start_timespec);
2399 dprintf(fd, "Backtrace failed, but process has become cached.\n");
2400 DumpPidFooter(fd, pid);
2401 continue;
2402 }
2403
2404 DumpPidHeader(fd, pid, start_timespec);
2405 dprintf(fd, "Backtrace gathering failed, likely due to a timeout.\n");
2406 DumpPidFooter(fd, pid);
2407
2408 dprintf(fd, "\n[dump %s stack %d: %.3fs elapsed]\n",
2409 is_java_process ? "dalvik" : "native", pid,
2410 (float)(Nanotime() - start) / NANOS_PER_SEC);
Nandana Duttfaafd522019-03-11 09:23:09 +00002411 timeout_failures++;
2412 continue;
2413 }
2414
2415 // We've successfully dumped stack traces, reset the failure count
2416 // and write a summary of the elapsed time to the file and continue with the
2417 // next process.
2418 timeout_failures = 0;
2419
2420 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2421 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2422 }
2423
2424 if (!dalvik_found) {
2425 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2426 }
2427
Nandana Duttcf419a72019-03-14 10:40:17 +00002428 *path = file_name_buf.release();
2429 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002430}
2431
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002432static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2433 const Dumpstate::BugreportMode bugreport_mode) {
2434 switch (bugreport_mode) {
2435 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2436 return dumpstate_hal_hidl::DumpstateMode::FULL;
2437 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2438 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2439 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2440 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2441 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2442 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2443 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2444 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2445 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2446 return dumpstate_hal_hidl::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002447 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002448 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2449 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2450 }
2451 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2452}
2453
2454static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2455 const Dumpstate::BugreportMode bugreport_mode) {
2456 switch (bugreport_mode) {
2457 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2458 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2459 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2460 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2461 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2462 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2463 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2464 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2465 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2466 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2467 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2468 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002469 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002470 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2471 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2472 }
2473 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2474}
2475
Steven Moreland0d564d52025-01-10 22:24:57 +00002476// BAD - See README.md: "Dumpstate philosophy: exec not link"
2477// This should all be moved into a separate binary rather than have complex logic here.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002478static void DoDumpstateBoardHidl(
2479 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2480 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2481 const Dumpstate::BugreportMode bugreport_mode,
2482 const size_t timeout_sec) {
2483
2484 using ScopedNativeHandle =
2485 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2486 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2487 [](native_handle_t* handle) {
2488 // we don't close file handle's here
2489 // via native_handle_close(handle)
2490 // instead we let dumpstate_fds close the file handles when
2491 // dumpstate_fds gets destroyed
2492 native_handle_delete(handle);
2493 });
2494 if (handle == nullptr) {
2495 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2496 return;
2497 }
2498
2499 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2500 handle.get()->data[i] = dumpstate_fds[i].get();
2501 }
2502
2503 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2504 // implement just 1.0.
2505 const char* descriptor_to_kill;
2506 using DumpstateBoardTask = std::packaged_task<bool()>;
2507 DumpstateBoardTask dumpstate_board_task;
2508 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2509 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2510 if (dumpstate_hal != nullptr) {
2511 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2512
2513 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2514 GetDumpstateHalModeHidl(bugreport_mode);
2515
2516 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2517 dumpstate_board_task =
2518 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2519 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2520 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2521 SEC_TO_MSEC(timeout_sec));
2522 if (!status.isOk()) {
2523 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2524 return false;
2525 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2526 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2527 dumpstate_hal_hidl::toString(status).c_str());
2528 return false;
2529 }
2530 return true;
2531 });
2532 } else {
2533 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2534
2535 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2536 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2537 ::android::hardware::Return<void> status =
2538 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2539 if (!status.isOk()) {
2540 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2541 return false;
2542 }
2543 return true;
2544 });
2545 }
2546 auto result = dumpstate_board_task.get_future();
2547 std::thread(std::move(dumpstate_board_task)).detach();
2548
2549 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2550 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2551 if (!android::base::SetProperty(
2552 "ctl.interface_restart",
2553 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2554 MYLOGE("Couldn't restart dumpstate HAL\n");
2555 }
2556 }
2557 // Wait some time for init to kill dumpstate vendor HAL
2558 constexpr size_t killing_timeout_sec = 10;
2559 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2560 MYLOGE(
2561 "killing dumpstateBoard timed out after %zus, continue and "
2562 "there might be racing in content\n",
2563 killing_timeout_sec);
2564 }
2565}
2566
2567static void DoDumpstateBoardAidl(
2568 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2569 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2570 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2571 MYLOGI("Using IDumpstateDevice AIDL HAL");
2572
2573 const char* descriptor_to_kill;
2574 using DumpstateBoardTask = std::packaged_task<bool()>;
2575 DumpstateBoardTask dumpstate_board_task;
2576 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2577 GetDumpstateHalModeAidl(bugreport_mode);
2578
2579 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2580 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2581 timeout_sec]() -> bool {
2582 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2583
2584 if (!status.isOk()) {
2585 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2586 return false;
2587 }
2588 return true;
2589 });
2590 auto result = dumpstate_board_task.get_future();
2591 std::thread(std::move(dumpstate_board_task)).detach();
2592
2593 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2594 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2595 if (!android::base::SetProperty(
2596 "ctl.interface_restart",
2597 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2598 MYLOGE("Couldn't restart dumpstate HAL\n");
2599 }
2600 }
2601 // Wait some time for init to kill dumpstate vendor HAL
2602 constexpr size_t killing_timeout_sec = 10;
2603 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2604 MYLOGE(
2605 "killing dumpstateBoard timed out after %zus, continue and "
2606 "there might be racing in content\n",
2607 killing_timeout_sec);
2608 }
2609}
2610
2611static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2612 const std::string aidl_instance_name =
2613 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2614
2615 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2616 return nullptr;
2617 }
2618
2619 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2620
2621 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2622}
2623
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002624void Dumpstate::DumpstateBoard(int out_fd) {
2625 dprintf(out_fd, "========================================================\n");
2626 dprintf(out_fd, "== Board\n");
2627 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002628
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002629 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002630 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002631 * set to true and unmount it after invoking dumpstateBoard_* methods.
2632 * This is to enable debug builds to not have debugfs mounted during runtime.
2633 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002634 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002635 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002636 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002637 if (mount_debugfs) {
2638 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2639 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002640 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002641 }
2642
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002643 std::vector<std::string> paths;
2644 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002645 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002646 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2647 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002648 remover.emplace_back(android::base::make_scope_guard(
2649 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002650 }
Jie Song9fbfad02017-06-20 16:29:42 -07002651
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002652 // get dumpstate HAL AIDL implementation
2653 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2654 GetDumpstateBoardAidlService());
2655 if (dumpstate_hal_handle_aidl == nullptr) {
2656 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2657 }
2658
2659 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2660 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2661 if (dumpstate_hal_handle_aidl == nullptr) {
2662 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2663 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2664 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2665 }
2666 }
2667
2668 // if neither HIDL nor AIDL implementation found, then return
2669 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2670 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002671 return;
2672 }
2673
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002674 // this is used to hold the file descriptors and when this variable goes out of scope
2675 // the file descriptors are closed
2676 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002677
Nandana Dutt5c390032019-03-12 10:52:56 +00002678 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002679 for (size_t i = 0; i < paths.size(); i++) {
2680 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2681
2682 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2683 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2684 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2685 if (fd < 0) {
2686 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2687 return;
2688 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002689
2690 dumpstate_fds.emplace_back(fd.release());
2691 // we call fd.release() here to make sure "fd" does not get closed
2692 // after "fd" goes out of scope after this block.
2693 // "fd" will be closed when "dumpstate_fds" goes out of scope
2694 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002695 }
2696
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002697 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2698 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2699 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002700 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002701
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002702 if (dumpstate_hal_handle_aidl != nullptr) {
2703 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2704 timeout_sec);
2705 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2706 // run HIDL HAL only if AIDL HAL not found
2707 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2708 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002709 }
2710
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002711 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002712 auto keep_debugfs_mounted =
2713 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2714 if (keep_debugfs_mounted.empty())
2715 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002716 }
2717
Wei Wang587eac92018-04-05 12:17:20 -07002718 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2719 for (size_t i = 0; i < paths.size(); i++) {
2720 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002721 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2722 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002723 file_sizes[i] = -1;
2724 continue;
2725 }
2726 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002727 }
2728
2729 for (size_t i = 0; i < paths.size(); i++) {
2730 if (file_sizes[i] == -1) {
2731 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002732 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002733 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002734 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002735 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002736 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002737 remover[i].Disable();
2738 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2739 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002740 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002741}
2742
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002743static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002744 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002745 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2746 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002747 " -h: display this help message\n"
2748 " -b: play sound file instead of vibrate, at beginning of job\n"
2749 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002750 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002751 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002752 " -s: write zipped file to control socket (for init)\n"
2753 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002754 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002755 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002756 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002757 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002758 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002759 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002760}
2761
Wei Liuf87959e2016-08-26 14:51:42 -07002762static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002763 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002764}
2765
Felipe Leme1d486fe2016-10-14 18:06:47 -07002766bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002767 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2768 if (zip_entry_tasks_) {
2769 zip_entry_tasks_->run(/* do_cancel = */false);
2770 }
2771
Felipe Leme9a523ae2016-10-20 15:10:33 -07002772 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002773 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002774 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002775 // Final timestamp
2776 char date[80];
2777 time_t the_real_now_please_stand_up = time(nullptr);
2778 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002779 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002780 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002781
Felipe Leme9a523ae2016-10-20 15:10:33 -07002782 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002783 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002784 return false;
2785 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002786 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002787 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002788 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002789 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002790
Felipe Leme0f3fb202016-06-10 17:10:53 -07002791 // Add log file (which contains stderr output) to zip...
2792 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002793 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002794 MYLOGE("Failed to add dumpstate log to .zip file\n");
2795 return false;
2796 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002797 // TODO: Should truncate the existing file.
2798 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002799 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2800 return false;
2801 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002802 fprintf(stderr, "\n");
2803
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002804 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002805 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002806 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002807 return false;
2808 }
2809
Felipe Leme1d486fe2016-10-14 18:06:47 -07002810 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2811 ds.zip_file.reset(nullptr);
2812
Felipe Lemee9d2c542016-11-15 11:48:26 -08002813 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002814 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002815
Felipe Leme1e9edc62015-12-21 16:02:13 -08002816 return true;
2817}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002818
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002819static void SendBroadcast(const std::string& action,
2820 const std::vector<std::string>& args,
2821 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002822 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002823 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2824 std::to_string(user_id), "--receiver-foreground",
2825 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002826 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002827
2828 am.insert(am.end(), args.begin(), args.end());
2829
Felipe Leme8d2410e2017-02-08 09:46:08 -08002830 RunCommand("", am,
2831 CommandOptions::WithTimeout(20)
2832 .Log("Sending broadcast: '%s'\n")
2833 .Always()
2834 .DropRoot()
2835 .RedirectStderr()
2836 .Build());
2837}
2838
Felipe Leme35b8cf12017-02-10 15:47:29 -08002839static void Vibrate(int duration_ms) {
2840 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002841 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2842 "oneshot", std::to_string(duration_ms)};
2843 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002844 CommandOptions::WithTimeout(10)
2845 .Log("Vibrate: '%s'\n")
2846 .Always()
2847 .Build());
2848 // clang-format on
2849}
2850
Nandana Dutt979388e2018-11-30 16:48:55 +00002851static void MaybeResolveSymlink(std::string* path) {
2852 std::string resolved_path;
2853 if (android::base::Readlink(*path, &resolved_path)) {
2854 *path = resolved_path;
2855 }
2856}
2857
Nandana Dutt4be45d12018-09-26 15:04:23 +01002858/*
2859 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002860 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002861 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002862static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002863 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2864
Nandana Dutt4be45d12018-09-26 15:04:23 +01002865 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2866 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002867 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002868 char date[80];
2869 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2870 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002871
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002872 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002873 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002874 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002875 ds.base_name_ += "-wifi";
2876 }
2877
Paul Chang0d2aad72020-02-13 20:04:03 +08002878 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002879 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002880 }
2881 ds.tmp_path_ = ds.GetPath(".tmp");
2882 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2883
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002884 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002885 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002886 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002887 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002888 "Bugreport dir: [%s] "
2889 "Base name: [%s] "
2890 "Suffix: [%s] "
2891 "Log path: [%s] "
2892 "Temporary path: [%s] "
2893 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002894 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2895 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002896
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002897 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2898 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2899 create_parent_dirs(ds.path_.c_str());
2900 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2901 if (ds.zip_file == nullptr) {
2902 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2903 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002904 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002905 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2906 ds.AddTextZipEntry("version.txt", ds.version_);
2907 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002908}
2909
2910/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002911 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002912 * printing zipped file status, etc.
2913 */
2914static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002915 bool do_text_file = !ds.FinishZipFile();
2916 if (do_text_file) {
2917 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002918 }
mhasank2d75c442020-06-11 15:05:25 -07002919
2920 std::string final_path = ds.path_;
2921 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002922 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002923 android::os::CopyFileToFile(ds.path_, final_path);
2924 }
2925
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002926 if (ds.options_->stream_to_socket) {
2927 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2928 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002929 if (do_text_file) {
2930 dprintf(ds.control_socket_fd_,
2931 "FAIL:could not create zip file, check %s "
2932 "for more details\n",
2933 ds.log_path_.c_str());
2934 } else {
mhasank2d75c442020-06-11 15:05:25 -07002935 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002936 }
2937 }
2938}
2939
Nandana Dutt4be45d12018-09-26 15:04:23 +01002940
Nandana Dutt58d72e22018-11-16 10:30:48 +00002941static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2942 switch (mode) {
2943 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2944 return "BUGREPORT_FULL";
2945 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2946 return "BUGREPORT_INTERACTIVE";
2947 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2948 return "BUGREPORT_REMOTE";
2949 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2950 return "BUGREPORT_WEAR";
2951 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2952 return "BUGREPORT_TELEPHONY";
2953 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2954 return "BUGREPORT_WIFI";
Elis Elliott8e401ad2023-08-08 11:18:59 +00002955 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2956 return "BUGREPORT_ONBOARDING";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002957 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2958 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002959 }
2960}
2961
Steven Leeb573eb82022-11-29 22:31:35 +08002962static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2963 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2964 return !options.telephony_only;
2965}
2966
Paul Changf59c2b72020-03-10 02:08:55 +08002967static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2968 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002969 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2970 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002971 options->bugreport_mode = mode;
2972 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002973 switch (mode) {
2974 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002975 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002976 break;
2977 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002978 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002979 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002980 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002981 break;
2982 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002983 options->do_vibrate = false;
2984 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002985 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002986 break;
2987 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002988 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002989 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002990 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002991 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002992 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002993 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002994 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002995 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002996 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002997 break;
2998 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002999 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08003000 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00003001 break;
Elis Elliott8e401ad2023-08-08 11:18:59 +00003002 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
3003 options->onboarding_only = true;
3004 options->do_screenshot = false;
3005 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00003006 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
3007 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00003008 }
3009}
3010
Nandana Dutt58d72e22018-11-16 10:30:48 +00003011static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00003012 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003013 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08003014 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003015 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07003016 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003017 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08003018 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08003019 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003020 options.do_progress_updates, options.bugreport_fd.get(),
3021 options.bugreport_mode_string.c_str(),
3022 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00003023}
3024
Nandana Dutt54dbd672019-01-11 12:58:05 +00003025void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00003026 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00003027 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08003028 const android::base::unique_fd& screenshot_fd_in,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003029 bool is_screenshot_requested,
3030 bool skip_user_consent) {
Kean Mariotti306633e2022-09-05 16:30:47 +00003031 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003032 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003033 this->skip_user_consent = skip_user_consent;
Nandana Dutt54dbd672019-01-11 12:58:05 +00003034 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00003035 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
3036 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00003037
Paul Changf59c2b72020-03-10 02:08:55 +08003038 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00003039}
3040
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003041Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
3042 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003043 int c;
mhasankd451a472020-05-26 18:02:39 -07003044 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003045 switch (c) {
3046 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07003047 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003048 case 's': stream_to_socket = true; break;
3049 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003050 case 'v': show_header_only = true; break;
3051 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08003052 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003053 case 'P': do_progress_updates = true; break;
3054 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07003055 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003056 case 'V':
3057 case 'd':
3058 case 'z':
3059 // compatibility no-op
3060 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00003061 case 'w':
3062 // This was already processed
3063 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003064 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003065 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003066 break;
3067 default:
3068 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003069 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003070 break;
3071 // clang-format on
3072 }
3073 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08003074
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003075 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003076 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003077 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003078 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003079 }
3080 }
3081
3082 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
3083 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003084
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003085 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003086}
3087
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003088bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003089 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00003090 return false;
3091 }
3092
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003093 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003094 return false;
3095 }
3096
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003097 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003098 return false;
3099 }
3100 return true;
3101}
3102
Nandana Dutt197661d2018-11-16 16:40:21 +00003103void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
3104 options_ = std::move(options);
3105}
3106
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003107void Dumpstate::Initialize() {
3108 /* gets the sequential id */
3109 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
3110 id_ = ++last_id;
3111 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
3112}
3113
Nandana Duttd2f5f082019-01-18 17:13:52 +00003114Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
3115 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003116 HandleRunStatus(status);
3117 return status;
3118}
3119
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003120Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003121 const bool keep_bugreport_on_retrieval,
3122 const bool skip_user_consent) {
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003123 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003124 keep_bugreport_on_retrieval,
3125 skip_user_consent);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003126 HandleRunStatus(status);
3127 return status;
3128}
3129
3130Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003131 const std::string& calling_package,
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003132 const bool keep_bugreport_on_retrieval,
3133 const bool skip_user_consent) {
3134 if (!android::app::admin::flags::onboarding_consentless_bugreports() || !skip_user_consent) {
3135 consent_callback_ = new ConsentCallback();
3136 const String16 incidentcompanion("incidentcompanion");
3137 sp<android::IBinder> ics(
3138 defaultServiceManager()->checkService(incidentcompanion));
3139 android::String16 package(calling_package.c_str());
3140 if (ics != nullptr) {
3141 MYLOGD("Checking user consent via incidentcompanion service\n");
3142
3143 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
3144 calling_uid, package, String16(), String16(),
3145 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
3146 } else {
3147 MYLOGD(
3148 "Unable to check user consent; incidentcompanion service unavailable\n");
3149 return RunStatus::USER_CONSENT_TIMED_OUT;
3150 }
3151 UserConsentResult consent_result = consent_callback_->getResult();
3152 int timeout_ms = 30 * 1000;
3153 while (consent_result == UserConsentResult::UNAVAILABLE &&
3154 consent_callback_->getElapsedTimeMs() < timeout_ms) {
3155 sleep(1);
3156 consent_result = consent_callback_->getResult();
3157 }
3158 if (consent_result == UserConsentResult::DENIED) {
3159 return RunStatus::USER_CONSENT_DENIED;
3160 }
3161 if (consent_result == UserConsentResult::UNAVAILABLE) {
3162 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3163 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3164 consent_callback_.get());
3165 return RunStatus::USER_CONSENT_TIMED_OUT;
3166 }
Gavin Corkerya44686c2022-11-23 18:16:51 +00003167 }
3168
3169 bool copy_succeeded =
3170 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003171
3172 if (copy_succeeded && (!android::app::admin::flags::onboarding_bugreport_v2_enabled()
3173 || !keep_bugreport_on_retrieval)) {
3174 android::os::UnlinkAndLogOnError(path_);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003175 }
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003176
Gavin Corkerya44686c2022-11-23 18:16:51 +00003177 return copy_succeeded ? Dumpstate::RunStatus::OK
3178 : Dumpstate::RunStatus::ERROR;
3179}
3180
3181void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
3182 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00003183 switch (status) {
3184 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00003185 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00003186 break;
3187 case Dumpstate::RunStatus::HELP:
3188 break;
3189 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003190 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003191 break;
3192 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003193 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
3194 break;
3195 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3196 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
3197 break;
3198 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
3199 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003200 break;
3201 }
3202 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003203}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003204void Dumpstate::Cancel() {
3205 CleanupTmpFiles();
3206 android::os::UnlinkAndLogOnError(log_path_);
3207 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3208 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3209 kDumpstateBoardFiles[i]);
3210 }
3211 tombstone_data_.clear();
3212 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003213 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003214 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003215
3216 // Instead of shutdown the pool, we delete temporary files directly since
3217 // shutdown blocking the call.
3218 if (dump_pool_) {
3219 dump_pool_->deleteTempFiles();
3220 }
3221 if (zip_entry_tasks_) {
3222 zip_entry_tasks_->run(/*do_cancel =*/ true);
3223 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003224}
3225
Kean Mariotti306633e2022-09-05 16:30:47 +00003226void Dumpstate::PreDumpUiData() {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003227 auto snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Kean Mariotti306633e2022-09-05 16:30:47 +00003228 MaybeSnapshotUiTraces();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003229 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Kean Mariotti306633e2022-09-05 16:30:47 +00003230}
3231
Nandana Dutt979388e2018-11-30 16:48:55 +00003232/*
3233 * Dumps relevant information to a bugreport based on the given options.
3234 *
3235 * The bugreport can be dumped to a file or streamed to a socket.
3236 *
3237 * How dumping to file works:
3238 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3239 * stderr is redirected a log file.
3240 *
3241 * The temporary bugreport is then populated via printfs, dumping contents of files and
3242 * output of commands to stdout.
3243 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003244 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003245 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003246 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003247 *
mhasank2d75c442020-06-11 15:05:25 -07003248 * Bugreports are first generated in a local directory and later copied to the caller's fd
3249 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003250 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003251Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3252 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003253 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003254 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003255 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003256 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003257 return RunStatus::INVALID_INPUT;
3258 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003259 /* set as high priority, and protect from OOM killer */
3260 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003261
Felipe Lemed071c682016-10-20 16:48:00 -07003262 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003263 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003264 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003265 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003266 } else {
3267 /* fallback to kernels <= 2.6.35 */
3268 oom_adj = fopen("/proc/self/oom_adj", "we");
3269 if (oom_adj) {
3270 fputs("-17", oom_adj);
3271 fclose(oom_adj);
3272 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003273 }
3274
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003275 if (version_ == VERSION_DEFAULT) {
3276 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003277 }
3278
Chris Morin5a50d482022-02-01 17:41:18 -08003279 if (version_ != VERSION_CURRENT) {
3280 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3281 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003282 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003283 }
3284
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003285 if (options_->show_header_only) {
3286 PrintHeader();
3287 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003288 }
3289
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003290 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3291 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003292
Felipe Leme7447d7c2016-11-03 18:12:22 -07003293 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003294 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003295 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003296 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003297
Sahana Raof35ed432019-07-12 10:47:52 +01003298 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3299 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3300 } else {
3301 // Wake lock will be released automatically on process death
3302 MYLOGD("Wake lock acquired.\n");
3303 }
3304
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003305 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003306
Felipe Lemef0292972016-11-22 13:57:05 -08003307 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003308 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3309 }
3310
Kevin Jeonfa64e642023-07-27 11:36:41 -04003311 if (PropertiesHelper::IsStrictRun()) {
3312 MYLOGI(
3313 "Running on strict-run mode, which has shorter timeouts "
3314 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3315 }
3316
Nandana Dutt235c6672019-11-14 15:22:32 +00003317 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003318 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003319
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003320 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003321
Christopher Ferrised9354f2014-10-01 17:35:01 -07003322 // If we are going to use a socket, do it as early as possible
3323 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003324 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003325 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003326 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003327 if (control_socket_fd_ == -1) {
3328 return ERROR;
3329 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003330 if (options_->progress_updates_to_socket) {
3331 options_->do_progress_updates = 1;
3332 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003333 }
3334
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003335 if (!PrepareToWriteToFile()) {
3336 return ERROR;
3337 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003338
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003339 // Interactive, wear & telephony modes are default to true.
3340 // and may enable from cli option or when using control socket
3341 if (options_->do_progress_updates) {
3342 // clang-format off
3343 std::vector<std::string> am_args = {
3344 "--receiver-permission", "android.permission.DUMP",
3345 };
3346 // clang-format on
3347 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003348 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3349 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003350 if (options_->progress_updates_to_socket) {
3351 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003352 }
3353 }
3354
Nick Kralevichf3599b32016-01-25 15:05:16 -08003355 /* read /proc/cmdline before dropping root */
3356 FILE *cmdline = fopen("/proc/cmdline", "re");
3357 if (cmdline) {
3358 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3359 fclose(cmdline);
3360 }
3361
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003362 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003363 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003364 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003365
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003366 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003367 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3368 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003369 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003370 }
3371 }
3372
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003373 int dup_stdout_fd;
3374 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003375 // Redirect stderr to log_path_ for debugging.
3376 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3377 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3378 return ERROR;
3379 }
3380 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3381 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3382 strerror(errno));
3383 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003384
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003385 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3386 // moved into zip file later, if zipping.
3387 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3388 // TODO: why not write to a file instead of stdout to overcome this problem?
3389 /* TODO: rather than generating a text file now and zipping it later,
3390 it would be more efficient to redirect stdout to the zip entry
3391 directly, but the libziparchive doesn't support that option yet. */
3392 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3393 return ERROR;
3394 }
3395 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3396 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3397 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003398 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003399
3400 // Don't buffer stdout
3401 setvbuf(stdout, nullptr, _IONBF, 0);
3402
Rhed Jao5377d792020-07-16 17:37:39 +08003403 // Enable the parallel run if the client requests to output to a file.
3404 EnableParallelRunIfNeeded();
3405 // Using scope guard to make sure the dump pool can be shut down correctly.
3406 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3407 ShutdownDumpPool();
3408 });
3409
Felipe Leme608385d2016-02-01 10:35:38 -08003410 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3411 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003412 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003413 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003414
Kean Mariottic14cebc2024-03-04 10:55:28 +00003415 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
3416 if (options_->use_predumped_ui_data && !system_trace_exists) {
3417 MYLOGW("Ignoring 'use predumped data' flag because no predumped data is available");
3418 options_->use_predumped_ui_data = false;
3419 }
3420
Kean Mariottica20f2d2023-12-15 09:34:25 +00003421 std::future<std::string> snapshot_system_trace;
3422
Kean Mariotti853b73a2023-07-27 12:40:30 +00003423 bool is_dumpstate_restricted =
3424 options_->telephony_only || options_->wifi_only || options_->limited_only;
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003425 if (!is_dumpstate_restricted) {
3426 // Snapshot the system trace now (if running) to avoid that dumpstate's
3427 // own activity pushes out interesting data from the trace ring buffer.
3428 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
Kean Mariottica20f2d2023-12-15 09:34:25 +00003429 snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003430
Kean Mariotti853b73a2023-07-27 12:40:30 +00003431 // Invoke critical dumpsys to preserve system state, before doing anything else.
3432 RunDumpsysCritical();
3433
Kean Mariotti306633e2022-09-05 16:30:47 +00003434 // Snapshot the UI traces now (if running).
3435 // The trace files will be added to bugreport later.
3436 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003437 }
Kean Mariotti853b73a2023-07-27 12:40:30 +00003438
3439 MaybeTakeEarlyScreenshot();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003440 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Gavin Corkery6968f552020-11-22 18:09:05 +00003441 onUiIntensiveBugreportDumpsFinished(calling_uid);
3442 MaybeCheckUserConsent(calling_uid, calling_package);
3443 if (options_->telephony_only) {
3444 DumpstateTelephonyOnly(calling_package);
3445 } else if (options_->wifi_only) {
3446 DumpstateWifiOnly();
3447 } else if (options_->limited_only) {
3448 DumpstateLimitedOnly();
Elis Elliott8e401ad2023-08-08 11:18:59 +00003449 } else if (options_->onboarding_only) {
3450 DumpstateOnboardingOnly();
Gavin Corkery6968f552020-11-22 18:09:05 +00003451 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003452 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003453 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003454 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003455 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003456 HandleUserConsentDenied();
3457 }
3458 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003459 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003460 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003461
Felipe Leme55b42a62015-11-10 17:39:08 -08003462 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003463 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003464
Abhijeet Kaure370d682019-10-01 16:49:30 +01003465 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003466 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003467 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003468 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003469
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003470 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003471 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003472 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003473 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003474 if (status != Dumpstate::RunStatus::OK &&
3475 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3476 // Do an early return if there were errors. We make an exception for consent
3477 // timing out because it's possible the user got distracted. In this case the
3478 // bugreport is not shared but made available for manual retrieval.
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003479 MYLOGI("Bug report generation failed, this could have been due to"
3480 " several reasons such as BR copy failed, user consent was"
3481 " not grated etc. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003482 return status;
3483 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003484 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3485 MYLOGI(
3486 "Did not receive user consent yet."
3487 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003488 const String16 incidentcompanion("incidentcompanion");
3489 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3490 if (ics != nullptr) {
3491 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3492 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3493 consent_callback_.get());
3494 } else {
3495 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3496 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003497 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003498 }
3499
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003500 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003501 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003502 for (int i = 0; i < 3; i++) {
3503 Vibrate(75);
3504 usleep((75 + 50) * 1000);
3505 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003506 }
3507
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003508 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3509 progress_->GetInitialMax());
3510 progress_->Save();
3511 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003512
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003513 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003514
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003515 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003516 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003517 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003518 }
3519
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003520 tombstone_data_.clear();
3521 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003522 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003523 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003524
Nandana Duttd2f5f082019-01-18 17:13:52 +00003525 return (consent_callback_ != nullptr &&
3526 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3527 ? USER_CONSENT_TIMED_OUT
3528 : RunStatus::OK;
3529}
3530
Paul Chang0d2aad72020-02-13 20:04:03 +08003531void Dumpstate::MaybeTakeEarlyScreenshot() {
3532 if (!options_->do_screenshot || !do_early_screenshot_) {
3533 return;
3534 }
3535
3536 TakeScreenshot();
3537}
3538
Kean Mariottica20f2d2023-12-15 09:34:25 +00003539std::future<std::string> Dumpstate::MaybeSnapshotSystemTraceAsync() {
Kean Mariotti853b73a2023-07-27 12:40:30 +00003540 // When capturing traces via bugreport handler (BH), this function will be invoked twice:
3541 // 1) When BH invokes IDumpstate::PreDumpUiData()
3542 // 2) When BH invokes IDumpstate::startBugreport(flags = BUGREPORT_USE_PREDUMPED_UI_DATA)
3543 // In this case we don't want to re-invoke perfetto in step 2.
3544 // In all other standard invocation states, this function is invoked once
3545 // without the flag BUGREPORT_USE_PREDUMPED_UI_DATA.
Kean Mariottica20f2d2023-12-15 09:34:25 +00003546 // This function must run asynchronously to avoid delaying MaybeTakeEarlyScreenshot() in the
3547 // standard invocation states (b/316110955).
Kean Mariotti853b73a2023-07-27 12:40:30 +00003548 if (options_->use_predumped_ui_data) {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003549 return {};
3550 }
3551
3552 // Create temporary file for the command's output
3553 std::string outPath = ds.bugreport_internal_dir_ + "/tmp_serialize_perfetto_trace";
3554 auto outFd = android::base::unique_fd(TEMP_FAILURE_RETRY(
3555 open(outPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
3556 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
3557 if (outFd < 0) {
3558 MYLOGE("Could not open %s to serialize perfetto trace.\n", outPath.c_str());
3559 return {};
Kean Mariotti853b73a2023-07-27 12:40:30 +00003560 }
3561
3562 // If a stale file exists already, remove it.
3563 unlink(SYSTEM_TRACE_SNAPSHOT);
3564
Kean Mariottica20f2d2023-12-15 09:34:25 +00003565 MYLOGI("Launching async '%s'", SERIALIZE_PERFETTO_TRACE_TASK.c_str())
3566 return std::async(
3567 std::launch::async, [this, outPath = std::move(outPath), outFd = std::move(outFd)] {
3568 // If a background system trace is happening and is marked as "suitable for
3569 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3570 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3571 // case that no trace is ongoing, this command is a no-op.
3572 // Note: this should not be enqueued as we need to freeze the trace before
3573 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3574 // the dumpstate's own activity which is irrelevant.
3575 RunCommand(
3576 SERIALIZE_PERFETTO_TRACE_TASK, {"perfetto", "--save-for-bugreport"},
Kean Mariotti5aa8d152024-09-23 12:10:09 +00003577 CommandOptions::WithTimeout(30).DropRoot().CloseAllFileDescriptorsOnExec().Build(),
Kean Mariottica20f2d2023-12-15 09:34:25 +00003578 false, outFd);
3579 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3580 // file in the later stages.
3581
3582 return outPath;
3583 });
3584}
3585
3586void Dumpstate::MaybeWaitForSnapshotSystemTrace(std::future<std::string> task) {
3587 if (!task.valid()) {
3588 return;
3589 }
3590
3591 WaitForTask(std::move(task), SERIALIZE_PERFETTO_TRACE_TASK, STDOUT_FILENO);
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003592}
3593
Kean Mariotti306633e2022-09-05 16:30:47 +00003594void Dumpstate::MaybeSnapshotUiTraces() {
3595 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3596 return;
3597 }
3598
Pablo Gamito654831c2024-02-16 16:47:48 +00003599 std::vector<std::vector<std::string>> dumpTracesForBugReportCommands = {
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003600 {"cmd", "input_method", "tracing", "save-for-bugreport"},
3601 {"cmd", "window", "tracing", "save-for-bugreport"},
3602 {"cmd", "window", "shell", "tracing", "save-for-bugreport"},
3603 };
Hongwei Wang39229132023-01-24 15:09:59 -08003604
Pablo Gamito654831c2024-02-16 16:47:48 +00003605 if (!android_tracing_perfetto_transition_tracing()) {
3606 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3607 "SystemUIService", "WMShell", "transitions",
3608 "tracing", "save-for-bugreport"});
3609 }
3610
Pablo Gamito6929a0e2024-02-26 23:29:47 +00003611 if (!android_tracing_perfetto_protolog_tracing()) {
Pablo Gamito654831c2024-02-16 16:47:48 +00003612 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3613 "SystemUIService", "WMShell", "protolog",
3614 "save-for-bugreport"});
3615 }
3616
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003617 for (const auto& command : dumpTracesForBugReportCommands) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003618 RunCommand(
3619 // Empty name because it's not intended to be classified as a bugreport section.
3620 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003621 "", command,
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003622 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3623 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003624}
3625
3626void Dumpstate::MaybeAddUiTracesToZip() {
3627 if (PropertiesHelper::IsUserBuild()) {
3628 return;
3629 }
3630
3631 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003632}
3633
Paul Changeb4b4642020-05-28 22:05:47 +08003634void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003635 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003636 return;
3637 }
3638 if (listener_ != nullptr) {
3639 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3640 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003641 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003642 }
3643}
3644
Jichao Lie89d9c12019-11-21 19:02:51 -08003645void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003646 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003647 !CalledByApi() || options_->is_consent_deferred ||
3648 (android::app::admin::flags::onboarding_consentless_bugreports() &&
3649 options_->skip_user_consent)) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003650 // No need to get consent for shell triggered dumpstates, or not
3651 // through bugreporting API (i.e. no fd to copy back), or when consent
3652 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003653 return;
3654 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003655 consent_callback_ = new ConsentCallback();
3656 const String16 incidentcompanion("incidentcompanion");
3657 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003658 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003659 if (ics != nullptr) {
3660 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003661 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3662 if (IsConsentlessBugreportAllowed(*options_)) {
3663 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3664 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003665 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003666 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003667 } else {
3668 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3669 }
3670}
3671
Nandana Dutt5c390032019-03-12 10:52:56 +00003672bool Dumpstate::IsUserConsentDenied() const {
3673 return ds.consent_callback_ != nullptr &&
3674 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3675}
3676
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003677bool Dumpstate::CalledByApi() const {
3678 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3679}
3680
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003681void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003682 android::os::UnlinkAndLogOnError(tmp_path_);
3683 android::os::UnlinkAndLogOnError(screenshot_path_);
3684 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003685 if (dump_traces_path != nullptr) {
3686 android::os::UnlinkAndLogOnError(dump_traces_path);
3687 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003688}
3689
Rhed Jao5377d792020-07-16 17:37:39 +08003690void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003691 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003692 return;
3693 }
3694 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003695 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003696}
3697
3698void Dumpstate::ShutdownDumpPool() {
3699 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003700 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003701 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003702 if (zip_entry_tasks_) {
3703 zip_entry_tasks_->run(/* do_cancel = */true);
3704 zip_entry_tasks_ = nullptr;
3705 }
3706}
3707
3708void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3709 const std::string& entry_path) {
3710 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3711 if (!task_cancelled) {
3712 AddZipEntry(entry_name, entry_path);
3713 }
3714 android::os::UnlinkAndLogOnError(entry_path);
3715 };
3716 if (zip_entry_tasks_) {
3717 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3718 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3719 } else {
3720 // Invokes AddZipEntryAndCleanup immediately
3721 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3722 }
Rhed Jao5377d792020-07-16 17:37:39 +08003723}
3724
Nandana Duttd2f5f082019-01-18 17:13:52 +00003725Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3726 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003727 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003728 return USER_CONSENT_DENIED;
3729}
3730
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003731Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003732 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003733 // user consent (unless the caller is Shell).
3734 UserConsentResult consent_result;
Kholoud Mohameddef4e432024-05-15 12:47:46 +00003735 if (multiuser_get_app_id(calling_uid) == AID_SHELL || (options_->skip_user_consent
3736 && android::app::admin::flags::onboarding_consentless_bugreports())) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003737 consent_result = UserConsentResult::APPROVED;
3738 } else {
3739 consent_result = consent_callback_->getResult();
3740 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003741 if (consent_result == UserConsentResult::UNAVAILABLE) {
3742 // User has not responded yet.
3743 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003744 // Telephony is a fast report type, particularly on user builds where information may be
3745 // more aggressively limited. To give the user time to read the consent dialog, increase the
3746 // timeout.
3747 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3748 : USER_CONSENT_TIMEOUT_MS;
3749 if (elapsed_ms < timeout_ms) {
3750 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003751 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3752 sleep(delay_seconds);
3753 }
3754 consent_result = consent_callback_->getResult();
3755 }
3756 if (consent_result == UserConsentResult::DENIED) {
3757 // User has explicitly denied sharing with the app. To be safe delete the
3758 // internal bugreport & tmp files.
3759 return HandleUserConsentDenied();
3760 }
3761 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003762 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3763 if (copy_succeeded) {
3764 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003765 if (options_->do_screenshot &&
3766 options_->screenshot_fd.get() != -1 &&
3767 !options_->is_screenshot_copied) {
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003768 bool is_screenshot_copied = android::os::CopyFileToFd(screenshot_path_,
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003769 options_->screenshot_fd.get());
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003770 if (is_screenshot_copied) {
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003771 android::os::UnlinkAndLogOnError(screenshot_path_);
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003772 } else {
3773 MYLOGE("Failed to copy screenshot to a permanent file.\n");
3774 is_screenshot_copied = android::os::CopyFileToFd(DEFAULT_SCREENSHOT_PATH,
3775 options_->screenshot_fd.get());
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003776 }
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003777 options_->is_screenshot_copied = is_screenshot_copied;
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003778 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003779 }
3780 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3781 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3782 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3783 // Since we do not have user consent to share the bugreport it does not get
3784 // copied over to the calling app but remains in the internal directory from
3785 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003786 std::string final_path = GetPath(".zip");
3787 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3788 if (copy_succeeded) {
3789 android::os::UnlinkAndLogOnError(path_);
3790 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003791 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3792 }
3793 // Unknown result; must be a programming error.
3794 MYLOGE("Unknown user consent result:%d\n", consent_result);
3795 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003796}
3797
Nandana Duttf02564e2019-02-15 15:24:24 +00003798Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003799 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3800 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3801 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003802 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003803 // When directly running dumpstate binary, the output is not expected to be written
3804 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003805 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003806
3807 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003808 // an app; they are irrelevant here because bugreport is triggered via command line.
3809 // Update Last ID before calling Run().
3810 Initialize();
Nikhil Kumarb70622a2023-06-15 15:37:19 +01003811 status = Run(0 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003812 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003813 return status;
3814}
3815
3816/* Main entry point for dumpstate binary. */
3817int run_main(int argc, char* argv[]) {
3818 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003819
3820 switch (status) {
3821 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003822 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003823 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003824 ShowUsage();
3825 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003826 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003827 fprintf(stderr, "Invalid combination of args\n");
3828 ShowUsage();
3829 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003830 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003831 FALLTHROUGH_INTENDED;
3832 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3833 FALLTHROUGH_INTENDED;
3834 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003835 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003836 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003837}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003838
3839// TODO(111441001): Default DumpOptions to sensible values.
3840Dumpstate::Dumpstate(const std::string& version)
3841 : pid_(getpid()),
3842 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003843 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003844 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003845 now_(time(nullptr)),
3846 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003847}
3848
3849Dumpstate& Dumpstate::GetInstance() {
3850 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3851 return singleton_;
3852}
3853
Rhed Jao5377d792020-07-16 17:37:39 +08003854DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3855 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3856 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003857 if (!title_.empty()) {
3858 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003859 if (title_.find("SHOW MAP") == std::string::npos) {
3860 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3861 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003862 }
3863}
3864
3865DurationReporter::~DurationReporter() {
3866 if (!title_.empty()) {
3867 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
Kunduz Baryktabasova3a5b65a2024-10-07 11:53:48 +00003868 if (elapsed >= 1.0f || verbose_) {
chenqiwuaf8b2d92019-12-12 18:53:51 +08003869 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003870 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003871 if (!logcat_only_) {
3872 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003873 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3874 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003875 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003876 if (title_.find("SHOW MAP") == std::string::npos) {
3877 ATRACE_ASYNC_END(title_.c_str(), 0);
3878 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003879 }
3880}
3881
3882const int32_t Progress::kDefaultMax = 5000;
3883
3884Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3885}
3886
3887Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3888 : Progress(initial_max, growth_factor, "") {
3889 progress_ = progress;
3890}
3891
3892Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3893 : initial_max_(initial_max),
3894 progress_(0),
3895 max_(initial_max),
3896 growth_factor_(growth_factor),
3897 n_runs_(0),
3898 average_max_(0),
3899 path_(path) {
3900 if (!path_.empty()) {
3901 Load();
3902 }
3903}
3904
3905void Progress::Load() {
3906 MYLOGD("Loading stats from %s\n", path_.c_str());
3907 std::string content;
3908 if (!android::base::ReadFileToString(path_, &content)) {
3909 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3910 return;
3911 }
3912 if (content.empty()) {
3913 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3914 return;
3915 }
3916 std::vector<std::string> lines = android::base::Split(content, "\n");
3917
3918 if (lines.size() < 1) {
3919 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3920 (int)lines.size(), max_);
3921 return;
3922 }
3923 char* ptr;
3924 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3925 average_max_ = strtol(ptr, nullptr, 10);
3926 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3927 average_max_ > STATS_MAX_AVERAGE) {
3928 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3929 initial_max_ = Progress::kDefaultMax;
3930 } else {
3931 initial_max_ = average_max_;
3932 }
3933 max_ = initial_max_;
3934
3935 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3936}
3937
3938void Progress::Save() {
3939 int32_t total = n_runs_ * average_max_ + progress_;
3940 int32_t runs = n_runs_ + 1;
3941 int32_t average = floor(((float)total) / runs);
3942 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3943 path_.c_str());
3944 if (path_.empty()) {
3945 return;
3946 }
3947
3948 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3949 if (!android::base::WriteStringToFile(content, path_)) {
3950 MYLOGE("Could not save stats on %s\n", path_.c_str());
3951 }
3952}
3953
3954int32_t Progress::Get() const {
3955 return progress_;
3956}
3957
3958bool Progress::Inc(int32_t delta_sec) {
3959 bool changed = false;
3960 if (delta_sec >= 0) {
3961 progress_ += delta_sec;
3962 if (progress_ > max_) {
3963 int32_t old_max = max_;
3964 max_ = floor((float)progress_ * growth_factor_);
3965 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3966 changed = true;
3967 }
3968 }
3969 return changed;
3970}
3971
3972int32_t Progress::GetMax() const {
3973 return max_;
3974}
3975
3976int32_t Progress::GetInitialMax() const {
3977 return initial_max_;
3978}
3979
3980void Progress::Dump(int fd, const std::string& prefix) const {
3981 const char* pr = prefix.c_str();
3982 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3983 dprintf(fd, "%smax: %d\n", pr, max_);
3984 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3985 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3986 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3987 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3988 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3989}
3990
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003991std::string Dumpstate::GetPath(const std::string& suffix) const {
3992 return GetPath(bugreport_internal_dir_, suffix);
3993}
3994
3995std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3996 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3997 name_.c_str(), suffix.c_str());
3998}
3999
4000void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
4001 progress_ = std::move(progress);
4002}
4003
4004void for_each_userid(void (*func)(int), const char *header) {
4005 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
4006 "for_each_userid(%s)", header);
4007 DurationReporter duration_reporter(title);
4008 if (PropertiesHelper::IsDryRun()) return;
4009
4010 DIR *d;
4011 struct dirent *de;
4012
4013 if (header) printf("\n------ %s ------\n", header);
4014 func(0);
4015
4016 if (!(d = opendir("/data/system/users"))) {
4017 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
4018 return;
4019 }
4020
4021 while ((de = readdir(d))) {
4022 int userid;
4023 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
4024 continue;
4025 }
4026 func(userid);
4027 }
4028
4029 closedir(d);
4030}
4031
4032static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
4033 DIR *d;
4034 struct dirent *de;
4035
4036 if (!(d = opendir("/proc"))) {
4037 printf("Failed to open /proc (%s)\n", strerror(errno));
4038 return;
4039 }
4040
4041 if (header) printf("\n------ %s ------\n", header);
4042 while ((de = readdir(d))) {
4043 if (ds.IsUserConsentDenied()) {
4044 MYLOGE(
4045 "Returning early because user denied consent to share bugreport with calling app.");
4046 closedir(d);
4047 return;
4048 }
4049 int pid;
4050 int fd;
4051 char cmdpath[255];
4052 char cmdline[255];
4053
4054 if (!(pid = atoi(de->d_name))) {
4055 continue;
4056 }
4057
4058 memset(cmdline, 0, sizeof(cmdline));
4059
4060 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
4061 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
4062 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
4063 close(fd);
4064 if (cmdline[0]) {
4065 helper(pid, cmdline, arg);
4066 continue;
4067 }
4068 }
4069
4070 // if no cmdline, a kernel thread has comm
4071 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
4072 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
4073 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
4074 close(fd);
4075 if (cmdline[1]) {
4076 cmdline[0] = '[';
4077 size_t len = strcspn(cmdline, "\f\b\r\n");
4078 cmdline[len] = ']';
4079 cmdline[len+1] = '\0';
4080 }
4081 }
4082 if (!cmdline[0]) {
4083 strcpy(cmdline, "N/A");
4084 }
4085 helper(pid, cmdline, arg);
4086 }
4087
4088 closedir(d);
4089}
4090
4091static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
4092 for_each_pid_func *func = (for_each_pid_func*) arg;
4093 func(pid, cmdline);
4094}
4095
4096void for_each_pid(for_each_pid_func func, const char *header) {
4097 std::string title = header == nullptr ? "for_each_pid"
4098 : android::base::StringPrintf("for_each_pid(%s)", header);
4099 DurationReporter duration_reporter(title);
4100 if (PropertiesHelper::IsDryRun()) return;
4101
4102 __for_each_pid(for_each_pid_helper, header, (void *) func);
4103}
4104
4105static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
4106 DIR *d;
4107 struct dirent *de;
4108 char taskpath[255];
4109 for_each_tid_func *func = (for_each_tid_func *) arg;
4110
4111 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
4112
4113 if (!(d = opendir(taskpath))) {
4114 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
4115 return;
4116 }
4117
4118 func(pid, pid, cmdline);
4119
4120 while ((de = readdir(d))) {
4121 if (ds.IsUserConsentDenied()) {
4122 MYLOGE(
4123 "Returning early because user denied consent to share bugreport with calling app.");
4124 closedir(d);
4125 return;
4126 }
4127 int tid;
4128 int fd;
4129 char commpath[255];
4130 char comm[255];
4131
4132 if (!(tid = atoi(de->d_name))) {
4133 continue;
4134 }
4135
4136 if (tid == pid)
4137 continue;
4138
4139 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
4140 memset(comm, 0, sizeof(comm));
4141 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
4142 strcpy(comm, "N/A");
4143 } else {
4144 char *c;
4145 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
4146 close(fd);
4147
4148 c = strrchr(comm, '\n');
4149 if (c) {
4150 *c = '\0';
4151 }
4152 }
4153 func(pid, tid, comm);
4154 }
4155
4156 closedir(d);
4157}
4158
4159void for_each_tid(for_each_tid_func func, const char *header) {
4160 std::string title = header == nullptr ? "for_each_tid"
4161 : android::base::StringPrintf("for_each_tid(%s)", header);
4162 DurationReporter duration_reporter(title);
4163
4164 if (PropertiesHelper::IsDryRun()) return;
4165
4166 __for_each_pid(for_each_tid_helper, header, (void *) func);
4167}
4168
4169void show_wchan(int pid, int tid, const char *name) {
4170 if (PropertiesHelper::IsDryRun()) return;
4171
4172 char path[255];
4173 char buffer[255];
4174 int fd, ret, save_errno;
4175 char name_buffer[255];
4176
4177 memset(buffer, 0, sizeof(buffer));
4178
4179 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
4180 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4181 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4182 return;
4183 }
4184
4185 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4186 save_errno = errno;
4187 close(fd);
4188
4189 if (ret < 0) {
4190 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4191 return;
4192 }
4193
4194 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
4195 pid == tid ? 0 : 3, "", name);
4196
4197 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
4198
4199 return;
4200}
4201
4202// print time in centiseconds
4203static void snprcent(char *buffer, size_t len, size_t spc,
4204 unsigned long long time) {
4205 static long hz; // cache discovered hz
4206
4207 if (hz <= 0) {
4208 hz = sysconf(_SC_CLK_TCK);
4209 if (hz <= 0) {
4210 hz = 1000;
4211 }
4212 }
4213
4214 // convert to centiseconds
4215 time = (time * 100 + (hz / 2)) / hz;
4216
4217 char str[16];
4218
4219 snprintf(str, sizeof(str), " %llu.%02u",
4220 time / 100, (unsigned)(time % 100));
4221 size_t offset = strlen(buffer);
4222 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4223 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4224}
4225
4226// print permille as a percent
4227static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
4228 char str[16];
4229
4230 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
4231 size_t offset = strlen(buffer);
4232 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4233 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4234}
4235
4236void show_showtime(int pid, const char *name) {
4237 if (PropertiesHelper::IsDryRun()) return;
4238
4239 char path[255];
4240 char buffer[1023];
4241 int fd, ret, save_errno;
4242
4243 memset(buffer, 0, sizeof(buffer));
4244
4245 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4246 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4247 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4248 return;
4249 }
4250
4251 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4252 save_errno = errno;
4253 close(fd);
4254
4255 if (ret < 0) {
4256 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4257 return;
4258 }
4259
4260 // field 14 is utime
4261 // field 15 is stime
4262 // field 42 is iotime
4263 unsigned long long utime = 0, stime = 0, iotime = 0;
4264 if (sscanf(buffer,
4265 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4266 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4267 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4268 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4269 &utime, &stime, &iotime) != 3) {
4270 return;
4271 }
4272
4273 unsigned long long total = utime + stime;
4274 if (!total) {
4275 return;
4276 }
4277
4278 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4279 if (permille > 1000) {
4280 permille = 1000;
4281 }
4282
4283 // try to beautify and stabilize columns at <80 characters
4284 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4285 if ((name[0] != '[') || utime) {
4286 snprcent(buffer, sizeof(buffer), 57, utime);
4287 }
4288 snprcent(buffer, sizeof(buffer), 65, stime);
4289 if ((name[0] != '[') || iotime) {
4290 snprcent(buffer, sizeof(buffer), 73, iotime);
4291 }
4292 if (iotime) {
4293 snprdec(buffer, sizeof(buffer), 79, permille);
4294 }
4295 puts(buffer); // adds a trailing newline
4296
4297 return;
4298}
4299
4300void do_dmesg() {
4301 const char *title = "KERNEL LOG (dmesg)";
4302 DurationReporter duration_reporter(title);
4303 printf("------ %s ------\n", title);
4304
4305 if (PropertiesHelper::IsDryRun()) return;
4306
4307 /* Get size of kernel buffer */
4308 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4309 if (size <= 0) {
4310 printf("Unexpected klogctl return value: %d\n\n", size);
4311 return;
4312 }
4313 char *buf = (char *) malloc(size + 1);
4314 if (buf == nullptr) {
4315 printf("memory allocation failed\n\n");
4316 return;
4317 }
4318 int retval = klogctl(KLOG_READ_ALL, buf, size);
4319 if (retval < 0) {
4320 printf("klogctl failure\n\n");
4321 free(buf);
4322 return;
4323 }
4324 buf[retval] = '\0';
4325 printf("%s\n\n", buf);
4326 free(buf);
4327 return;
4328}
4329
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004330int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4331 DurationReporter duration_reporter(title);
4332
4333 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4334
4335 UpdateProgress(WEIGHT_FILE);
4336
4337 return status;
4338}
4339
4340int read_file_as_long(const char *path, long int *output) {
luoqiangwei15fcf2022024-03-07 15:29:20 +08004341 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4342 if (fd.get() < 0) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004343 int err = errno;
4344 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4345 return -1;
4346 }
4347 char buffer[50];
luoqiangwei15fcf2022024-03-07 15:29:20 +08004348 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer, sizeof(buffer)));
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004349 if (bytes_read == -1) {
4350 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4351 return -2;
4352 }
4353 if (bytes_read == 0) {
4354 MYLOGE("File %s is empty\n", path);
4355 return -3;
4356 }
4357 *output = atoi(buffer);
4358 return 0;
4359}
4360
4361/* calls skip to gate calling dump_from_fd recursively
4362 * in the specified directory. dump_from_fd defaults to
4363 * dump_file_from_fd above when set to NULL. skip defaults
4364 * to false when set to NULL. dump_from_fd will always be
4365 * called with title NULL.
4366 */
4367int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4368 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4369 DurationReporter duration_reporter(title);
4370 DIR *dirp;
4371 struct dirent *d;
4372 char *newpath = nullptr;
4373 const char *slash = "/";
4374 int retval = 0;
4375
4376 if (!title.empty()) {
4377 printf("------ %s (%s) ------\n", title.c_str(), dir);
4378 }
4379 if (PropertiesHelper::IsDryRun()) return 0;
4380
4381 if (dir[strlen(dir) - 1] == '/') {
4382 ++slash;
4383 }
4384 dirp = opendir(dir);
4385 if (dirp == nullptr) {
4386 retval = -errno;
4387 MYLOGE("%s: %s\n", dir, strerror(errno));
4388 return retval;
4389 }
4390
4391 if (!dump_from_fd) {
4392 dump_from_fd = dump_file_from_fd;
4393 }
4394 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4395 if ((d->d_name[0] == '.')
4396 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4397 || (d->d_name[1] == '\0'))) {
4398 continue;
4399 }
4400 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4401 (d->d_type == DT_DIR) ? "/" : "");
4402 if (!newpath) {
4403 retval = -errno;
4404 continue;
4405 }
4406 if (skip && (*skip)(newpath)) {
4407 continue;
4408 }
4409 if (d->d_type == DT_DIR) {
4410 int ret = dump_files("", newpath, skip, dump_from_fd);
4411 if (ret < 0) {
4412 retval = ret;
4413 }
4414 continue;
4415 }
4416 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4417 if (fd.get() < 0) {
4418 retval = -1;
4419 printf("*** %s: %s\n", newpath, strerror(errno));
4420 continue;
4421 }
4422 (*dump_from_fd)(nullptr, newpath, fd.get());
4423 }
4424 closedir(dirp);
4425 if (!title.empty()) {
4426 printf("\n");
4427 }
4428 return retval;
4429}
4430
4431/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4432 * it's possible to avoid issues where opening the file itself can get
4433 * stuck.
4434 */
4435int dump_file_from_fd(const char *title, const char *path, int fd) {
4436 if (PropertiesHelper::IsDryRun()) return 0;
4437
4438 int flags = fcntl(fd, F_GETFL);
4439 if (flags == -1) {
4440 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4441 return -1;
4442 } else if (!(flags & O_NONBLOCK)) {
4443 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4444 return -1;
4445 }
4446 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4447}
4448
4449int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004450 const CommandOptions& options, bool verbose_duration, int out_fd) {
4451 DurationReporter duration_reporter(title, false /* logcat_only */,
4452 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004453
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004454 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004455
4456 /* TODO: for now we're simplifying the progress calculation by using the
4457 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4458 * where its weight should be much higher proportionally to its timeout.
4459 * Ideally, it should use a options.EstimatedDuration() instead...*/
4460 UpdateProgress(options.Timeout());
4461
4462 return status;
4463}
4464
4465void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004466 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004467 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4468 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4469 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004470 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004471}
4472
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004473static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004474 int s = android_get_control_socket(service);
4475 if (s < 0) {
4476 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4477 return -1;
4478 }
4479 fcntl(s, F_SETFD, FD_CLOEXEC);
4480
4481 // Set backlog to 0 to make sure that queue size will be minimum.
4482 // In Linux, because the minimum queue will be 1, connect() will be blocked
4483 // if the other clients already called connect() and the connection request was not accepted.
4484 if (listen(s, 0) < 0) {
4485 MYLOGE("listen(control socket): %s\n", strerror(errno));
4486 return -1;
4487 }
4488
4489 struct sockaddr addr;
4490 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004491 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004492
4493 // Close socket just after accept(), to make sure that connect() by client will get error
4494 // when the socket is used by the other services.
4495 // There is still a race condition possibility between accept and close, but there is no way
4496 // to close-on-accept atomically.
4497 // See detail; b/123306389#comment25
4498 close(s);
4499
4500 if (fd < 0) {
4501 MYLOGE("accept(control socket): %s\n", strerror(errno));
4502 return -1;
4503 }
4504
4505 return fd;
4506}
4507
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004508// TODO: should call is_valid_output_file and/or be merged into it.
4509void create_parent_dirs(const char *path) {
4510 char *chp = const_cast<char *> (path);
4511
4512 /* skip initial slash */
4513 if (chp[0] == '/')
4514 chp++;
4515
4516 /* create leading directories, if necessary */
4517 struct stat dir_stat;
4518 while (chp && chp[0]) {
4519 chp = strchr(chp, '/');
4520 if (chp) {
4521 *chp = 0;
4522 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4523 MYLOGI("Creating directory %s\n", path);
4524 if (mkdir(path, 0770)) { /* drwxrwx--- */
4525 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4526 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4527 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4528 }
4529 }
4530 *chp++ = '/';
4531 }
4532 }
4533}
4534
4535bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4536 create_parent_dirs(path);
4537
4538 int fd = TEMP_FAILURE_RETRY(open(path,
4539 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4540 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4541 if (fd < 0) {
4542 MYLOGE("%s: %s\n", path, strerror(errno));
4543 return false;
4544 }
4545
4546 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4547 close(fd);
4548 return true;
4549}
4550
4551bool redirect_to_file(FILE* redirect, char* path) {
4552 return _redirect_to_file(redirect, path, O_TRUNC);
4553}
4554
4555bool redirect_to_existing_file(FILE* redirect, char* path) {
4556 return _redirect_to_file(redirect, path, O_APPEND);
4557}
4558
4559void dump_route_tables() {
4560 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4561 if (PropertiesHelper::IsDryRun()) return;
4562 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4563 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4564 FILE* fp = fopen(RT_TABLES_PATH, "re");
4565 if (!fp) {
4566 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4567 return;
4568 }
4569 char table[16];
4570 // Each line has an integer (the table number), a space, and a string (the table name). We only
4571 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4572 // Add a fixed max limit so this doesn't go awry.
4573 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4574 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4575 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4576 }
4577 fclose(fp);
4578}
4579
Li Li830179f2022-01-04 12:53:29 -08004580void dump_frozen_cgroupfs(const char *dir, int level,
4581 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4582 DIR *dirp;
4583 struct dirent *d;
4584 char *newpath = nullptr;
4585
4586 dirp = opendir(dir);
4587 if (dirp == nullptr) {
4588 MYLOGE("%s: %s\n", dir, strerror(errno));
4589 return;
4590 }
4591
4592 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4593 if ((d->d_name[0] == '.')
4594 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4595 || (d->d_name[1] == '\0'))) {
4596 continue;
4597 }
4598 if (d->d_type == DT_DIR) {
4599 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4600 if (!newpath) {
4601 continue;
4602 }
4603 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4604 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4605 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4606 char *freezer = nullptr;
4607 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4608 if (freezer) {
4609 FILE* fp = fopen(freezer, "r");
4610 if (fp != NULL) {
4611 int frozen;
4612 fscanf(fp, "%d", &frozen);
4613 if (frozen > 0) {
4614 dump_files("", newpath, skip_none, dump_from_fd);
4615 }
4616 fclose(fp);
4617 }
4618 free(freezer);
4619 }
4620 }
4621 }
4622 }
4623 closedir(dirp);
4624}
4625
4626void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004627 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4628 DurationReporter duration_reporter("FROZEN CGROUPFS");
4629 if (PropertiesHelper::IsDryRun()) return;
4630 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4631}
4632
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004633void Dumpstate::UpdateProgress(int32_t delta_sec) {
4634 if (progress_ == nullptr) {
4635 MYLOGE("UpdateProgress: progress_ not set\n");
4636 return;
4637 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004638 // This function updates progress related members of the dumpstate and reports
4639 // progress percentage to the bugreport client. Since it could be called by
4640 // different dump tasks at the same time if the parallel run is enabled, a
4641 // mutex lock is necessary here to synchronize the call.
4642 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004643
4644 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004645 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004646
4647 // ...but only notifiy listeners when necessary.
4648 if (!options_->do_progress_updates) return;
4649
4650 int progress = progress_->Get();
4651 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004652 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004653
Nandana Dutt402a8392019-06-14 14:25:13 +01004654 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004655 return;
4656 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004657 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004658
4659 if (control_socket_fd_ >= 0) {
4660 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4661 fsync(control_socket_fd_);
4662 }
4663
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004664 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004665 if (percent % 10 == 0) {
4666 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004667 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004668 } else {
4669 // stderr is ignored on normal invocations, but useful when calling
4670 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004671 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004672 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004673
4674 listener_->onProgress(percent);
4675 }
4676}
4677
4678void Dumpstate::TakeScreenshot(const std::string& path) {
4679 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4680 int status =
Abdelrahman Daim30e23602024-08-20 02:19:37 -07004681 RunCommand("", {"screencap", "-p", real_path},
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004682 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4683 if (status == 0) {
4684 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4685 } else {
4686 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4687 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004688 if (listener_ != nullptr) {
4689 // Show a visual indication to indicate screenshot is taken via
4690 // IDumpstateListener.onScreenshotTaken()
4691 listener_->onScreenshotTaken(status == 0);
4692 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004693}
4694
4695bool is_dir(const char* pathname) {
4696 struct stat info;
4697 if (stat(pathname, &info) == -1) {
4698 return false;
4699 }
4700 return S_ISDIR(info.st_mode);
4701}
4702
4703time_t get_mtime(int fd, time_t default_mtime) {
4704 struct stat info;
4705 if (fstat(fd, &info) == -1) {
4706 return default_mtime;
4707 }
4708 return info.st_mtime;
4709}