blob: 1f5da39528cba7d21a3be8a0021ea3cefc85656d [file] [log] [blame]
Colin Crossf45fa6b2012-03-26 12:38:26 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Felipe Lemef0292972016-11-22 13:57:05 -080016
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070017#define LOG_TAG "dumpstate"
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000018#define ATRACE_TAG ATRACE_TAG_ALWAYS
Colin Crossf45fa6b2012-03-26 12:38:26 -070019
Pablo Gamito654831c2024-02-16 16:47:48 +000020#include "dumpstate.h"
Colin Crossf45fa6b2012-03-26 12:38:26 -070021
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000022#include <aidl/android/hardware/dumpstate/IDumpstateDevice.h>
Felipe Leme96c2bbb2016-09-26 09:21:21 -070023#include <android-base/file.h>
24#include <android-base/properties.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070025#include <android-base/scopeguard.h>
Elliott Hughes9dc117c2015-12-07 14:21:50 -080026#include <android-base/stringprintf.h>
Naveen Kalla058e1e82016-10-19 21:38:44 -070027#include <android-base/strings.h>
Andreas Gampeaff68432016-07-18 18:01:27 -070028#include <android-base/unique_fd.h>
Kedar Chitnis9fd8c052021-11-16 09:09:22 +000029#include <android/binder_manager.h>
30#include <android/binder_process.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010031#include <android/content/pm/IPackageManagerNative.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080032#include <android/hardware/dumpstate/1.0/IDumpstateDevice.h>
Hunter Knepshield8540faf2020-02-04 19:47:20 -080033#include <android/hardware/dumpstate/1.1/IDumpstateDevice.h>
34#include <android/hardware/dumpstate/1.1/types.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080035#include <android/hidl/manager/1.0/IServiceManager.h>
Nandana Duttd2f5f082019-01-18 17:13:52 +000036#include <android/os/IIncidentCompanion.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000037#include <android_app_admin_flags.h>
38#include <android_tracing.h>
Nikita Ioffea325a572019-05-16 19:49:47 +010039#include <binder/IServiceManager.h>
Nikhil Kumar28ce35e2023-01-10 14:32:44 +000040#include <cutils/multiuser.h>
Felipe Leme6f674ae2016-11-18 17:10:33 -080041#include <cutils/native_handle.h>
Colin Crossf45fa6b2012-03-26 12:38:26 -070042#include <cutils/properties.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010043#include <cutils/sockets.h>
Kevin Jeon2c02e8e2022-07-07 21:45:17 +000044#include <cutils/trace.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000045#include <debuggerd/client.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000046#include <dirent.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080047#include <dumpsys.h>
Nandana Duttfaafd522019-03-11 09:23:09 +000048#include <dumputils/dump_utils.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000049#include <errno.h>
50#include <fcntl.h>
Sahana Raof35ed432019-07-12 10:47:52 +010051#include <hardware_legacy/power.h>
Steven Moreland44cd9482018-01-04 16:24:13 -080052#include <hidl/ServiceManagement.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000053#include <inttypes.h>
54#include <libgen.h>
55#include <limits.h>
Abhijeet Kaurcf234e82019-07-01 14:53:55 +010056#include <log/log.h>
Tom Cherryf4472f32020-08-05 09:31:17 -070057#include <log/log_read.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000058#include <math.h>
Felipe Leme75876a22016-10-27 16:31:27 -070059#include <openssl/sha.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000060#include <poll.h>
Mark Salyzyn6c3d90f2016-09-27 14:55:27 -070061#include <private/android_filesystem_config.h>
62#include <private/android_logger.h>
Vishnu Naire97d6122018-01-18 13:58:56 -080063#include <serviceutils/PriorityDumper.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000064#include <signal.h>
65#include <stdarg.h>
66#include <stdbool.h>
67#include <stdio.h>
68#include <stdlib.h>
69#include <string.h>
70#include <sys/capability.h>
71#include <sys/inotify.h>
72#include <sys/klog.h>
73#include <sys/mount.h>
74#include <sys/poll.h>
75#include <sys/prctl.h>
76#include <sys/resource.h>
77#include <sys/stat.h>
78#include <sys/time.h>
79#include <sys/wait.h>
80#include <time.h>
81#include <unistd.h>
Luis Hector Chavez7aecd382018-03-19 11:16:59 -070082#include <utils/StrongPointer.h>
Devin Moore8df81bb2022-06-08 22:47:02 +000083#include <vintf/VintfObject.h>
Pablo Gamito654831c2024-02-16 16:47:48 +000084
85#include <chrono>
86#include <cmath>
87#include <fstream>
88#include <functional>
89#include <future>
90#include <memory>
91#include <numeric>
92#include <regex>
93#include <set>
94#include <string>
95#include <utility>
96#include <vector>
97
Felipe Lemef0292972016-11-22 13:57:05 -080098#include "DumpstateInternal.h"
Felipe Leme75876a22016-10-27 16:31:27 -070099#include "DumpstateService.h"
Felipe Leme6e01fa62015-11-11 19:35:14 -0800100
Kedar Chitnis9fd8c052021-11-16 09:09:22 +0000101namespace dumpstate_hal_hidl_1_0 = android::hardware::dumpstate::V1_0;
102namespace dumpstate_hal_hidl = android::hardware::dumpstate::V1_1;
103namespace dumpstate_hal_aidl = aidl::android::hardware::dumpstate;
104
Vishnu Naire97d6122018-01-18 13:58:56 -0800105using ::std::literals::chrono_literals::operator""ms;
106using ::std::literals::chrono_literals::operator""s;
Rhed Jao5377d792020-07-16 17:37:39 +0800107using ::std::placeholders::_1;
Steven Morelandcb7ef822016-11-29 13:20:37 -0800108
Felipe Leme47e9be22016-12-21 15:37:07 -0800109// TODO: remove once moved to namespace
Vishnu Naire97d6122018-01-18 13:58:56 -0800110using android::defaultServiceManager;
111using android::Dumpsys;
112using android::INVALID_OPERATION;
113using android::IServiceManager;
114using android::OK;
115using android::sp;
116using android::status_t;
117using android::String16;
118using android::String8;
119using android::TIMED_OUT;
120using android::UNKNOWN_ERROR;
121using android::Vector;
Nandana Dutt979388e2018-11-30 16:48:55 +0000122using android::base::StringPrintf;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000123using android::os::IDumpstateListener;
Felipe Leme47e9be22016-12-21 15:37:07 -0800124using android::os::dumpstate::CommandOptions;
125using android::os::dumpstate::DumpFileToFd;
Rhed Jao5377d792020-07-16 17:37:39 +0800126using android::os::dumpstate::DumpPool;
Vishnu Naire97d6122018-01-18 13:58:56 -0800127using android::os::dumpstate::PropertiesHelper;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800128using android::os::dumpstate::TaskQueue;
Chris Morinbc223142022-02-04 14:17:11 -0800129using android::os::dumpstate::WaitForTask;
Felipe Leme47e9be22016-12-21 15:37:07 -0800130
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100131// Keep in sync with
132// frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
133static const int TRACE_DUMP_TIMEOUT_MS = 10000; // 10 seconds
134
135/* Most simple commands have 10 as timeout, so 5 is a good estimate */
136static const int32_t WEIGHT_FILE = 5;
137
138// TODO: temporary variables and functions used during C++ refactoring
139static Dumpstate& ds = Dumpstate::GetInstance();
140static int RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Nandana Dutt8d945c02019-08-14 13:30:07 +0100141 const CommandOptions& options = CommandOptions::DEFAULT,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800142 bool verbose_duration = false, int out_fd = STDOUT_FILENO) {
143 return ds.RunCommand(title, full_command, options, verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +0100144}
145
146// Reasonable value for max stats.
147static const int STATS_MAX_N_RUNS = 1000;
148static const long STATS_MAX_AVERAGE = 100000;
149
150CommandOptions Dumpstate::DEFAULT_DUMPSYS = CommandOptions::WithTimeout(30).Build();
151
Nandana Duttd2f5f082019-01-18 17:13:52 +0000152typedef Dumpstate::ConsentCallback::ConsentResult UserConsentResult;
153
Colin Crossf45fa6b2012-03-26 12:38:26 -0700154/* read before root is shed */
155static char cmdline_buf[16384] = "(unknown)";
Yi Kong19d5c002018-07-20 13:39:55 -0700156static const char *dump_traces_path = nullptr;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000157static const uint64_t USER_CONSENT_TIMEOUT_MS = 30 * 1000;
Hunter Knepshield70610fa2020-01-03 15:27:33 -0800158// Because telephony reports are significantly faster to collect (< 10 seconds vs. > 2 minutes),
159// it's often the case that they time out far too quickly for consent with such a hefty dialog for
160// the user to read. For telephony reports only, we increase the default timeout to 2 minutes to
161// roughly match full reports' durations.
162static const uint64_t TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS = 2 * 60 * 1000;
Colin Crossf45fa6b2012-03-26 12:38:26 -0700163
Felipe Leme1d486fe2016-10-14 18:06:47 -0700164// TODO: variables and functions below should be part of dumpstate object
165
Felipe Leme635ca312016-01-05 14:23:02 -0800166static std::set<std::string> mount_points;
167void add_mountinfo();
Felipe Leme78f2c862015-12-21 09:55:22 -0800168
Todd Poynor2a83daa2013-11-22 15:44:22 -0800169#define PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops"
Mark Salyzyn7d0a7622016-06-24 14:06:15 -0700170#define ALT_PSTORE_LAST_KMSG "/sys/fs/pstore/console-ramoops-0"
Wei Wang509bb5d2017-06-09 14:42:12 -0700171#define BLK_DEV_SYS_DIR "/sys/block"
Todd Poynor2a83daa2013-11-22 15:44:22 -0800172
Felipe Lemee82a27d2016-01-05 13:35:44 -0800173#define RECOVERY_DIR "/cache/recovery"
Mark Salyzynd6ab0112016-03-25 12:56:39 -0700174#define RECOVERY_DATA_DIR "/data/misc/recovery"
Tianjie Xu75d53362018-04-11 16:42:28 -0700175#define UPDATE_ENGINE_LOG_DIR "/data/misc/update_engine_log"
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -0700176#define UPDATE_ENGINE_PREF_DIR "/data/misc/update_engine/prefs"
Mark Salyzyn4d42dea2016-04-01 10:03:14 -0700177#define LOGPERSIST_DATA_DIR "/data/misc/logd"
Jerry Changa1df8a92020-01-02 16:03:39 +0800178#define PREREBOOT_DATA_DIR "/data/misc/prereboot"
David Brazdild2991962016-06-03 14:40:44 +0100179#define PROFILE_DATA_DIR_CUR "/data/misc/profiles/cur"
180#define PROFILE_DATA_DIR_REF "/data/misc/profiles/ref"
Benedict Wong8f9d8a42019-01-03 16:19:38 -0800181#define XFRM_STAT_PROC_FILE "/proc/net/xfrm_stat"
Steven Moreland9379c462023-12-21 02:04:27 +0000182#define KERNEL_CONFIG "/proc/config.gz"
Erik Kline08165202016-05-30 11:55:44 +0900183#define WLUTIL "/vendor/xbin/wlutil"
Vishnu Nair36b4cdb2017-11-17 10:27:05 -0800184#define WMTRACE_DATA_DIR "/data/misc/wmtrace"
Yifan Hong3945e1b2019-10-29 12:59:23 -0700185#define OTA_METADATA_DIR "/metadata/ota"
Yifan Hong0efa7972020-02-03 16:45:02 -0800186#define SNAPSHOTCTL_LOG_DIR "/data/misc/snapshotctl_log"
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +0900187#define LINKERCONFIG_DIR "/linkerconfig"
Calin Juravlef84d3692020-04-28 15:31:12 -0700188#define PACKAGE_DEX_USE_LIST "/data/system/package-dex-usage.list"
Primiano Tuccifaaaafb2021-01-14 12:26:29 +0000189#define SYSTEM_TRACE_SNAPSHOT "/data/misc/perfetto-traces/bugreport/systrace.pftrace"
Li Li2eedd412021-06-30 15:11:53 -0700190#define CGROUPFS_DIR "/sys/fs/cgroup"
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200191#define SDK_EXT_INFO "/apex/com.android.sdkext/bin/derive_sdk"
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700192#define DROPBOX_DIR "/data/system/dropbox"
MÃ¥rten Kongstad5ad813f2023-09-28 10:09:18 +0200193#define PRINT_FLAGS "/system/bin/printflags"
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700194
Narayan Kamath8f788292017-05-25 13:20:39 +0100195// TODO(narayan): Since this information has to be kept in sync
196// with tombstoned, we should just put it in a common header.
197//
198// File: system/core/debuggerd/tombstoned/tombstoned.cpp
Narayan Kamathbd863722017-06-01 18:50:12 +0100199static const std::string TOMBSTONE_DIR = "/data/tombstones/";
200static const std::string TOMBSTONE_FILE_PREFIX = "tombstone_";
201static const std::string ANR_DIR = "/data/anr/";
202static const std::string ANR_FILE_PREFIX = "anr_";
Andy Hungd62f7e62024-01-11 15:47:52 -0800203static const std::string ANR_TRACE_FILE_PREFIX = "trace_";
Woody Lin20767a92022-11-29 15:50:24 +0800204static const std::string SHUTDOWN_CHECKPOINTS_DIR = "/data/system/shutdown-checkpoints/";
205static const std::string SHUTDOWN_CHECKPOINTS_FILE_PREFIX = "checkpoints-";
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700206
Felipe Lemee844a9d2016-09-21 15:01:39 -0700207// TODO: temporary variables and functions used during C++ refactoring
Nandana Dutt979388e2018-11-30 16:48:55 +0000208
Nandana Dutt5c390032019-03-12 10:52:56 +0000209#define RETURN_IF_USER_DENIED_CONSENT() \
210 if (ds.IsUserConsentDenied()) { \
211 MYLOGE("Returning early as user denied consent to share bugreport with calling app."); \
212 return Dumpstate::RunStatus::USER_CONSENT_DENIED; \
213 }
214
215// Runs func_ptr, but checks user consent before and after running it. Returns USER_CONSENT_DENIED
216// if consent is found to be denied.
217#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(func_ptr, ...) \
218 RETURN_IF_USER_DENIED_CONSENT(); \
219 func_ptr(__VA_ARGS__); \
220 RETURN_IF_USER_DENIED_CONSENT();
221
Rhed Jao5377d792020-07-16 17:37:39 +0800222// Runs func_ptr, and logs a duration report after it's finished.
223#define RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, ...) \
224 { \
225 DurationReporter duration_reporter_in_macro(log_title); \
226 func_ptr(__VA_ARGS__); \
227 }
228
229// Similar with RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK, an additional duration report
230// is output after a slow function is finished.
231#define RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(log_title, func_ptr, ...) \
232 RETURN_IF_USER_DENIED_CONSENT(); \
233 RUN_SLOW_FUNCTION_AND_LOG(log_title, func_ptr, __VA_ARGS__); \
234 RETURN_IF_USER_DENIED_CONSENT();
235
Chris Morinbc223142022-02-04 14:17:11 -0800236#define WAIT_TASK_WITH_CONSENT_CHECK(future) \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800237 RETURN_IF_USER_DENIED_CONSENT(); \
Chris Morinbc223142022-02-04 14:17:11 -0800238 WaitForTask(future); \
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800239 RETURN_IF_USER_DENIED_CONSENT();
240
Sahana Raof35ed432019-07-12 10:47:52 +0100241static const char* WAKE_LOCK_NAME = "dumpstate_wakelock";
242
Rhed Jao5377d792020-07-16 17:37:39 +0800243// Names of parallel tasks, they are used for the DumpPool to identify the dump
244// task and the log title of the duration report.
245static const std::string DUMP_TRACES_TASK = "DUMP TRACES";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800246static const std::string DUMP_INCIDENT_REPORT_TASK = "INCIDENT REPORT";
Aaron Huang24d215d2022-04-27 18:51:16 +0800247static const std::string DUMP_NETSTATS_PROTO_TASK = "DUMP NETSTATS PROTO";
Rhed Jao3c2fdbd2020-07-20 17:46:29 +0800248static const std::string DUMP_HALS_TASK = "DUMP HALS";
249static const std::string DUMP_BOARD_TASK = "dumpstate_board()";
Rhed Jaoe017f982020-07-21 17:58:41 +0800250static const std::string DUMP_CHECKINS_TASK = "DUMP CHECKINS";
Kean Mariottica20f2d2023-12-15 09:34:25 +0000251static const std::string SERIALIZE_PERFETTO_TRACE_TASK = "SERIALIZE PERFETTO TRACE";
Rhed Jao5377d792020-07-16 17:37:39 +0800252
Nandana Dutt979388e2018-11-30 16:48:55 +0000253namespace android {
254namespace os {
255namespace {
256
257static int Open(std::string path, int flags, mode_t mode = 0) {
258 int fd = TEMP_FAILURE_RETRY(open(path.c_str(), flags, mode));
259 if (fd == -1) {
260 MYLOGE("open(%s, %s)\n", path.c_str(), strerror(errno));
261 }
262 return fd;
263}
264
mhasank2d75c442020-06-11 15:05:25 -0700265static int OpenForWrite(std::string path) {
266 return Open(path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
267 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
268}
Nandana Dutt979388e2018-11-30 16:48:55 +0000269
270static int OpenForRead(std::string path) {
271 return Open(path, O_RDONLY | O_CLOEXEC | O_NOFOLLOW);
272}
273
274bool CopyFile(int in_fd, int out_fd) {
275 char buf[4096];
276 ssize_t byte_count;
277 while ((byte_count = TEMP_FAILURE_RETRY(read(in_fd, buf, sizeof(buf)))) > 0) {
278 if (!android::base::WriteFully(out_fd, buf, byte_count)) {
279 return false;
280 }
281 }
282 return (byte_count != -1);
283}
284
285static bool CopyFileToFd(const std::string& input_file, int out_fd) {
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000286 MYLOGD("Going to copy file (%s) to %d\n", input_file.c_str(), out_fd);
Nandana Dutt979388e2018-11-30 16:48:55 +0000287
288 // Obtain a handle to the source file.
289 android::base::unique_fd in_fd(OpenForRead(input_file));
290 if (out_fd != -1 && in_fd.get() != -1) {
291 if (CopyFile(in_fd.get(), out_fd)) {
292 return true;
293 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000294 MYLOGE("Failed to copy file: %s\n", strerror(errno));
Nandana Dutt979388e2018-11-30 16:48:55 +0000295 }
296 return false;
297}
298
Nandana Duttd2f5f082019-01-18 17:13:52 +0000299static bool UnlinkAndLogOnError(const std::string& file) {
Nandana Dutt8ae16e62020-03-27 10:20:22 +0000300 if (file.empty()) {
301 return false;
302 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +0000303 if (unlink(file.c_str())) {
304 MYLOGE("Failed to unlink file (%s): %s\n", file.c_str(), strerror(errno));
Nandana Duttd2f5f082019-01-18 17:13:52 +0000305 return false;
306 }
307 return true;
308}
Nandana Dutt979388e2018-11-30 16:48:55 +0000309
Nikita Ioffea325a572019-05-16 19:49:47 +0100310int64_t GetModuleMetadataVersion() {
311 auto binder = defaultServiceManager()->getService(android::String16("package_native"));
312 if (binder == nullptr) {
313 MYLOGE("Failed to retrieve package_native service");
314 return 0L;
315 }
316 auto package_service = android::interface_cast<content::pm::IPackageManagerNative>(binder);
317 std::string package_name;
318 auto status = package_service->getModuleMetadataPackageName(&package_name);
319 if (!status.isOk()) {
320 MYLOGE("Failed to retrieve module metadata package name: %s", status.toString8().c_str());
321 return 0L;
322 }
Nandana Duttdb379fa2019-10-09 16:54:41 +0100323 MYLOGD("Module metadata package name: %s\n", package_name.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100324 int64_t version_code;
325 status = package_service->getVersionCodeForPackage(android::String16(package_name.c_str()),
326 &version_code);
327 if (!status.isOk()) {
328 MYLOGE("Failed to retrieve module metadata version: %s", status.toString8().c_str());
329 return 0L;
330 }
331 return version_code;
332}
333
mhasank2d75c442020-06-11 15:05:25 -0700334static bool PathExists(const std::string& path) {
335 struct stat sb;
336 return stat(path.c_str(), &sb) == 0;
337}
338
339static bool CopyFileToFile(const std::string& input_file, const std::string& output_file) {
340 if (input_file == output_file) {
341 MYLOGD("Skipping copying bugreport file since the destination is the same (%s)\n",
342 output_file.c_str());
343 return false;
344 }
345 else if (PathExists(output_file)) {
346 MYLOGD("Cannot overwrite an existing file (%s)\n", output_file.c_str());
347 return false;
348 }
349
350 MYLOGD("Going to copy bugreport file (%s) to %s\n", input_file.c_str(), output_file.c_str());
351 android::base::unique_fd out_fd(OpenForWrite(output_file));
352 return CopyFileToFd(input_file, out_fd.get());
353}
354
Nandana Dutt979388e2018-11-30 16:48:55 +0000355} // namespace
356} // namespace os
357} // namespace android
358
Felipe Leme678727a2016-09-21 17:22:11 -0700359static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
Felipe Lemebda15a02016-11-16 17:48:25 -0800360 const CommandOptions& options = Dumpstate::DEFAULT_DUMPSYS,
Rhed Jaoe017f982020-07-21 17:58:41 +0800361 long dumpsysTimeoutMs = 0, int out_fd = STDOUT_FILENO) {
362 return ds.RunDumpsys(title, dumpsysArgs, options, dumpsysTimeoutMs, out_fd);
363}
364static void RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsysArgs,
365 int out_fd) {
366 return ds.RunDumpsys(title, dumpsysArgs, Dumpstate::DEFAULT_DUMPSYS, 0, out_fd);
Felipe Leme678727a2016-09-21 17:22:11 -0700367}
368static int DumpFile(const std::string& title, const std::string& path) {
369 return ds.DumpFile(title, path);
370}
Felipe Lemee82a27d2016-01-05 13:35:44 -0800371
Felipe Lemee844a9d2016-09-21 15:01:39 -0700372// Relative directory (inside the zip) for all files copied as-is into the bugreport.
373static const std::string ZIP_ROOT_DIR = "FS";
374
Vishnu Naire97d6122018-01-18 13:58:56 -0800375static const std::string kProtoPath = "proto/";
376static const std::string kProtoExt = ".proto";
Jie Song9fbfad02017-06-20 16:29:42 -0700377static const std::string kDumpstateBoardFiles[] = {
378 "dumpstate_board.txt",
Felipe Leme95d6ca52017-08-01 16:35:56 -0700379 "dumpstate_board.bin"
Jie Song9fbfad02017-06-20 16:29:42 -0700380};
381static const int NUM_OF_DUMPS = arraysize(kDumpstateBoardFiles);
382
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700383static constexpr char PROPERTY_LAST_ID[] = "dumpstate.last_id";
Felipe Lemed071c682016-10-20 16:48:00 -0700384static constexpr char PROPERTY_VERSION[] = "dumpstate.version";
Felipe Leme9ce6aa42016-09-21 10:02:25 -0700385
Felipe Lemef0292972016-11-22 13:57:05 -0800386static const CommandOptions AS_ROOT_20 = CommandOptions::WithTimeout(20).AsRoot().Build();
387
Narayan Kamath8f788292017-05-25 13:20:39 +0100388/*
Narayan Kamathbd863722017-06-01 18:50:12 +0100389 * Returns a vector of dump fds under |dir_path| with a given |file_prefix|.
Rhed Jao01dc0c62020-06-03 17:13:30 +0800390 * The returned vector is sorted by the mtimes of the dumps with descending
Chris Morinc2cba7a2022-02-01 17:06:50 -0800391 * order.
Narayan Kamath8f788292017-05-25 13:20:39 +0100392 */
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700393static std::vector<DumpData> GetDumpFds(const std::string& dir_path,
Chris Morinc2cba7a2022-02-01 17:06:50 -0800394 const std::string& file_prefix) {
Narayan Kamathbd863722017-06-01 18:50:12 +0100395 std::unique_ptr<DIR, decltype(&closedir)> dump_dir(opendir(dir_path.c_str()), closedir);
Narayan Kamath8f788292017-05-25 13:20:39 +0100396
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700397 if (dump_dir == nullptr) {
398 MYLOGW("Unable to open directory %s: %s\n", dir_path.c_str(), strerror(errno));
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700399 return std::vector<DumpData>();
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700400 }
401
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700402 std::vector<DumpData> dump_data;
Narayan Kamathbd863722017-06-01 18:50:12 +0100403 struct dirent* entry = nullptr;
404 while ((entry = readdir(dump_dir.get()))) {
405 if (entry->d_type != DT_REG) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100406 continue;
407 }
408
Narayan Kamathbd863722017-06-01 18:50:12 +0100409 const std::string base_name(entry->d_name);
410 if (base_name.find(file_prefix) != 0) {
411 continue;
412 }
413
414 const std::string abs_path = dir_path + base_name;
415 android::base::unique_fd fd(
416 TEMP_FAILURE_RETRY(open(abs_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW | O_NONBLOCK)));
417 if (fd == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700418 MYLOGW("Unable to open dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamathbd863722017-06-01 18:50:12 +0100419 break;
420 }
421
422 struct stat st = {};
423 if (fstat(fd, &st) == -1) {
Luis Hector Chavezd0512712018-03-14 12:15:56 -0700424 MYLOGW("Unable to stat dump file %s: %s\n", abs_path.c_str(), strerror(errno));
Narayan Kamath8f788292017-05-25 13:20:39 +0100425 continue;
426 }
427
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700428 dump_data.emplace_back(DumpData{abs_path, std::move(fd), st.st_mtime});
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700429 }
Rhed Jao01dc0c62020-06-03 17:13:30 +0800430 if (!dump_data.empty()) {
431 std::sort(dump_data.begin(), dump_data.end(),
432 [](const auto& a, const auto& b) { return a.mtime > b.mtime; });
433 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100434
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -0700435 return dump_data;
Narayan Kamath8f788292017-05-25 13:20:39 +0100436}
437
Narayan Kamathbd863722017-06-01 18:50:12 +0100438static bool AddDumps(const std::vector<DumpData>::const_iterator start,
439 const std::vector<DumpData>::const_iterator end,
440 const char* type_name, const bool add_to_zip) {
Narayan Kamath8f788292017-05-25 13:20:39 +0100441 bool dumped = false;
Narayan Kamathbd863722017-06-01 18:50:12 +0100442 for (auto it = start; it != end; ++it) {
443 const std::string& name = it->name;
444 const int fd = it->fd;
Narayan Kamath8f788292017-05-25 13:20:39 +0100445 dumped = true;
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100446
447 // Seek to the beginning of the file before dumping any data. A given
448 // DumpData entry might be dumped multiple times in the report.
449 //
450 // For example, the most recent ANR entry is dumped to the body of the
451 // main entry and it also shows up as a separate entry in the bugreport
452 // ZIP file.
453 if (lseek(fd, 0, SEEK_SET) != static_cast<off_t>(0)) {
454 MYLOGE("Unable to add %s to zip file, lseek failed: %s\n", name.c_str(),
455 strerror(errno));
456 }
457
Chris Morinc2cba7a2022-02-01 17:06:50 -0800458 if (add_to_zip) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800459 if (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + name, fd, /* timeout = */ 0ms) != OK) {
Narayan Kamath6b9516c2017-10-27 11:15:51 +0100460 MYLOGE("Unable to add %s to zip file, addZipEntryFromFd failed\n", name.c_str());
Narayan Kamath8f788292017-05-25 13:20:39 +0100461 }
462 } else {
463 dump_file_from_fd(type_name, name.c_str(), fd);
464 }
Narayan Kamath8f788292017-05-25 13:20:39 +0100465 }
466
467 return dumped;
Christopher Ferris7dc7f322014-07-22 16:08:19 -0700468}
469
Felipe Leme635ca312016-01-05 14:23:02 -0800470// for_each_pid() callback to get mount info about a process.
Felipe Leme4c2d6632016-09-28 14:32:00 -0700471void do_mountinfo(int pid, const char* name __attribute__((unused))) {
Felipe Leme635ca312016-01-05 14:23:02 -0800472 char path[PATH_MAX];
473
474 // Gets the the content of the /proc/PID/ns/mnt link, so only unique mount points
475 // are added.
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700476 snprintf(path, sizeof(path), "/proc/%d/ns/mnt", pid);
Felipe Leme635ca312016-01-05 14:23:02 -0800477 char linkname[PATH_MAX];
478 ssize_t r = readlink(path, linkname, PATH_MAX);
479 if (r == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800480 MYLOGE("Unable to read link for %s: %s\n", path, strerror(errno));
Felipe Leme635ca312016-01-05 14:23:02 -0800481 return;
482 }
483 linkname[r] = '\0';
484
485 if (mount_points.find(linkname) == mount_points.end()) {
486 // First time this mount point was found: add it
Nick Kralevichf0922cc2016-05-14 16:47:44 -0700487 snprintf(path, sizeof(path), "/proc/%d/mountinfo", pid);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700488 if (ds.AddZipEntry(ZIP_ROOT_DIR + path, path)) {
Felipe Leme635ca312016-01-05 14:23:02 -0800489 mount_points.insert(linkname);
490 } else {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800491 MYLOGE("Unable to add mountinfo %s to zip file\n", path);
Felipe Leme635ca312016-01-05 14:23:02 -0800492 }
493 }
494}
495
496void add_mountinfo() {
Felipe Leme678727a2016-09-21 17:22:11 -0700497 std::string title = "MOUNT INFO";
Felipe Leme635ca312016-01-05 14:23:02 -0800498 mount_points.clear();
Felipe Leme46b85da2016-11-21 17:40:45 -0800499 DurationReporter duration_reporter(title, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700500 for_each_pid(do_mountinfo, nullptr);
501 MYLOGD("%s: %d entries added to zip file\n", title.c_str(), (int)mount_points.size());
Felipe Leme635ca312016-01-05 14:23:02 -0800502}
503
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700504static void dump_dev_files(const char *title, const char *driverpath, const char *filename)
505{
506 DIR *d;
507 struct dirent *de;
508 char path[PATH_MAX];
509
510 d = opendir(driverpath);
Yi Kong19d5c002018-07-20 13:39:55 -0700511 if (d == nullptr) {
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700512 return;
513 }
514
515 while ((de = readdir(d))) {
516 if (de->d_type != DT_LNK) {
517 continue;
518 }
519 snprintf(path, sizeof(path), "%s/%s/%s", driverpath, de->d_name, filename);
Felipe Lemeb0f669d2016-09-26 18:26:11 -0700520 DumpFile(title, path);
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -0700521 }
522
523 closedir(d);
524}
525
Mark Salyzyn326842f2015-04-30 09:49:41 -0700526static bool skip_not_stat(const char *path) {
527 static const char stat[] = "/stat";
528 size_t len = strlen(path);
529 if (path[len - 1] == '/') { /* Directory? */
530 return false;
531 }
532 return strcmp(path + len - sizeof(stat) + 1, stat); /* .../stat? */
533}
534
Jeff Sharkey9df29d52023-02-06 14:26:30 -0700535static bool skip_wtf_strictmode(const char *path) {
536 if (strstr(path, "_wtf")) {
537 return true;
538 } else if (strstr(path, "_strictmode")) {
539 return true;
540 }
541 return false;
542}
543
Felipe Leme4c2d6632016-09-28 14:32:00 -0700544static bool skip_none(const char* path __attribute__((unused))) {
Felipe Lemee82a27d2016-01-05 13:35:44 -0800545 return false;
546}
547
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700548unsigned long worst_write_perf = 20000; /* in KB/s */
Mark Salyzyn326842f2015-04-30 09:49:41 -0700549
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800550//
551// stat offsets
552// Name units description
553// ---- ----- -----------
554// read I/Os requests number of read I/Os processed
555#define __STAT_READ_IOS 0
556// read merges requests number of read I/Os merged with in-queue I/O
557#define __STAT_READ_MERGES 1
558// read sectors sectors number of sectors read
559#define __STAT_READ_SECTORS 2
560// read ticks milliseconds total wait time for read requests
561#define __STAT_READ_TICKS 3
562// write I/Os requests number of write I/Os processed
563#define __STAT_WRITE_IOS 4
564// write merges requests number of write I/Os merged with in-queue I/O
565#define __STAT_WRITE_MERGES 5
566// write sectors sectors number of sectors written
567#define __STAT_WRITE_SECTORS 6
568// write ticks milliseconds total wait time for write requests
569#define __STAT_WRITE_TICKS 7
570// in_flight requests number of I/Os currently in flight
571#define __STAT_IN_FLIGHT 8
572// io_ticks milliseconds total time this block device has been active
573#define __STAT_IO_TICKS 9
574// time_in_queue milliseconds total wait time for all requests
575#define __STAT_IN_QUEUE 10
576#define __STAT_NUMBER_FIELD 11
577//
578// read I/Os, write I/Os
579// =====================
580//
581// These values increment when an I/O request completes.
582//
583// read merges, write merges
584// =========================
585//
586// These values increment when an I/O request is merged with an
587// already-queued I/O request.
588//
589// read sectors, write sectors
590// ===========================
591//
592// These values count the number of sectors read from or written to this
593// block device. The "sectors" in question are the standard UNIX 512-byte
594// sectors, not any device- or filesystem-specific block size. The
595// counters are incremented when the I/O completes.
596#define SECTOR_SIZE 512
597//
598// read ticks, write ticks
599// =======================
600//
601// These values count the number of milliseconds that I/O requests have
602// waited on this block device. If there are multiple I/O requests waiting,
603// these values will increase at a rate greater than 1000/second; for
604// example, if 60 read requests wait for an average of 30 ms, the read_ticks
605// field will increase by 60*30 = 1800.
606//
607// in_flight
608// =========
609//
610// This value counts the number of I/O requests that have been issued to
611// the device driver but have not yet completed. It does not include I/O
612// requests that are in the queue but not yet issued to the device driver.
613//
614// io_ticks
615// ========
616//
617// This value counts the number of milliseconds during which the device has
618// had I/O requests queued.
619//
620// time_in_queue
621// =============
622//
623// This value counts the number of milliseconds that I/O requests have waited
624// on this block device. If there are multiple I/O requests waiting, this
625// value will increase as the product of the number of milliseconds times the
626// number of requests waiting (see "read ticks" above for an example).
627#define S_TO_MS 1000
628//
629
Mark Salyzyn326842f2015-04-30 09:49:41 -0700630static int dump_stat_from_fd(const char *title __unused, const char *path, int fd) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800631 unsigned long long fields[__STAT_NUMBER_FIELD];
Mark Salyzyn326842f2015-04-30 09:49:41 -0700632 bool z;
Yi Kong19d5c002018-07-20 13:39:55 -0700633 char *cp, *buffer = nullptr;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700634 size_t i = 0;
Josh Gao7c4258c2018-06-25 13:40:08 -0700635 FILE *fp = fdopen(dup(fd), "rb");
Mark Salyzyn326842f2015-04-30 09:49:41 -0700636 getline(&buffer, &i, fp);
637 fclose(fp);
638 if (!buffer) {
639 return -errno;
640 }
641 i = strlen(buffer);
642 while ((i > 0) && (buffer[i - 1] == '\n')) {
643 buffer[--i] = '\0';
644 }
645 if (!*buffer) {
646 free(buffer);
647 return 0;
648 }
649 z = true;
650 for (cp = buffer, i = 0; i < (sizeof(fields) / sizeof(fields[0])); ++i) {
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800651 fields[i] = strtoull(cp, &cp, 10);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700652 if (fields[i] != 0) {
653 z = false;
654 }
655 }
656 if (z) { /* never accessed */
657 free(buffer);
658 return 0;
659 }
660
Wei Wang509bb5d2017-06-09 14:42:12 -0700661 if (!strncmp(path, BLK_DEV_SYS_DIR, sizeof(BLK_DEV_SYS_DIR) - 1)) {
662 path += sizeof(BLK_DEV_SYS_DIR) - 1;
Mark Salyzyn326842f2015-04-30 09:49:41 -0700663 }
Wei Wang1dc1ef52017-06-12 11:28:37 -0700664
665 printf("%-30s:%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s%9s\n%-30s:\t%s\n", "Block-Dev",
666 "R-IOs", "R-merg", "R-sect", "R-wait", "W-IOs", "W-merg", "W-sect",
667 "W-wait", "in-fli", "activ", "T-wait", path, buffer);
Mark Salyzyn326842f2015-04-30 09:49:41 -0700668 free(buffer);
669
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800670 if (fields[__STAT_IO_TICKS]) {
671 unsigned long read_perf = 0;
672 unsigned long read_ios = 0;
673 if (fields[__STAT_READ_TICKS]) {
674 unsigned long long divisor = fields[__STAT_READ_TICKS]
675 * fields[__STAT_IO_TICKS];
676 read_perf = ((unsigned long long)SECTOR_SIZE
677 * fields[__STAT_READ_SECTORS]
678 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
679 / divisor;
680 read_ios = ((unsigned long long)S_TO_MS * fields[__STAT_READ_IOS]
681 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
682 / divisor;
683 }
684
685 unsigned long write_perf = 0;
686 unsigned long write_ios = 0;
687 if (fields[__STAT_WRITE_TICKS]) {
688 unsigned long long divisor = fields[__STAT_WRITE_TICKS]
689 * fields[__STAT_IO_TICKS];
690 write_perf = ((unsigned long long)SECTOR_SIZE
691 * fields[__STAT_WRITE_SECTORS]
692 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
693 / divisor;
694 write_ios = ((unsigned long long)S_TO_MS * fields[__STAT_WRITE_IOS]
695 * fields[__STAT_IN_QUEUE] + (divisor >> 1))
696 / divisor;
697 }
698
699 unsigned queue = (fields[__STAT_IN_QUEUE]
700 + (fields[__STAT_IO_TICKS] >> 1))
701 / fields[__STAT_IO_TICKS];
702
703 if (!write_perf && !write_ios) {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700704 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 -0800705 } else {
Wei Wang1dc1ef52017-06-12 11:28:37 -0700706 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 -0800707 read_ios, write_perf, write_ios, queue);
Mark Salyzyn01d6c392016-02-04 09:20:44 -0800708 }
709
710 /* bugreport timeout factor adjustment */
711 if ((write_perf > 1) && (write_perf < worst_write_perf)) {
712 worst_write_perf = write_perf;
713 }
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700714 }
Mark Salyzyn326842f2015-04-30 09:49:41 -0700715 return 0;
716}
717
Yao Chenbe3bbc12018-01-17 16:31:10 -0800718static const long MINIMUM_LOGCAT_TIMEOUT_MS = 50000;
719
Tom Cherryf4472f32020-08-05 09:31:17 -0700720// Returns the actual readable size of the given buffer or -1 on error.
721static long logcat_buffer_readable_size(const std::string& buffer) {
722 std::unique_ptr<logger_list, decltype(&android_logger_list_free)> logger_list{
723 android_logger_list_alloc(0, 0, 0), &android_logger_list_free};
724 auto logger = android_logger_open(logger_list.get(), android_name_to_log_id(buffer.c_str()));
725
726 return android_logger_get_log_readable_size(logger);
727}
728
729// Returns timeout in ms to read a list of buffers.
Yao Chenbe3bbc12018-01-17 16:31:10 -0800730static unsigned long logcat_timeout(const std::vector<std::string>& buffers) {
731 unsigned long timeout_ms = 0;
732 for (const auto& buffer : buffers) {
Tom Cherryf4472f32020-08-05 09:31:17 -0700733 long readable_size = logcat_buffer_readable_size(buffer);
734 if (readable_size > 0) {
735 // Engineering margin is ten-fold our guess.
736 timeout_ms += 10 * (readable_size + worst_write_perf) / worst_write_perf;
737 }
Yao Chenbe3bbc12018-01-17 16:31:10 -0800738 }
739 return timeout_ms > MINIMUM_LOGCAT_TIMEOUT_MS ? timeout_ms : MINIMUM_LOGCAT_TIMEOUT_MS;
Mark Salyzyn8f37aa52015-06-12 12:28:24 -0700740}
741
Dieter Hsu105ad0c2020-09-29 15:23:33 +0800742// Opens a socket and returns its file descriptor.
743static int open_socket(const char* service);
744
Nandana Duttd2f5f082019-01-18 17:13:52 +0000745Dumpstate::ConsentCallback::ConsentCallback() : result_(UNAVAILABLE), start_time_(Nanotime()) {
746}
747
748android::binder::Status Dumpstate::ConsentCallback::onReportApproved() {
749 std::lock_guard<std::mutex> lock(lock_);
750 result_ = APPROVED;
751 MYLOGD("User approved consent to share bugreport\n");
Paul Chang0d2aad72020-02-13 20:04:03 +0800752
753 // Maybe copy screenshot so calling app can display the screenshot to the user as soon as
754 // consent is granted.
755 if (ds.options_->is_screenshot_copied) {
756 return android::binder::Status::ok();
757 }
758
759 if (!ds.options_->do_screenshot || ds.options_->screenshot_fd.get() == -1 ||
760 !ds.do_early_screenshot_) {
761 return android::binder::Status::ok();
762 }
763
764 bool copy_succeeded = android::os::CopyFileToFd(ds.screenshot_path_,
765 ds.options_->screenshot_fd.get());
766 ds.options_->is_screenshot_copied = copy_succeeded;
767 if (copy_succeeded) {
768 android::os::UnlinkAndLogOnError(ds.screenshot_path_);
769 }
Nandana Duttd2f5f082019-01-18 17:13:52 +0000770 return android::binder::Status::ok();
771}
772
773android::binder::Status Dumpstate::ConsentCallback::onReportDenied() {
774 std::lock_guard<std::mutex> lock(lock_);
775 result_ = DENIED;
776 MYLOGW("User denied consent to share bugreport\n");
777 return android::binder::Status::ok();
778}
779
780UserConsentResult Dumpstate::ConsentCallback::getResult() {
781 std::lock_guard<std::mutex> lock(lock_);
782 return result_;
783}
784
785uint64_t Dumpstate::ConsentCallback::getElapsedTimeMs() const {
Hunter Knepshieldf0a39052020-01-03 14:53:04 -0800786 return (Nanotime() - start_time_) / NANOS_PER_MILLI;
Nandana Duttd2f5f082019-01-18 17:13:52 +0000787}
788
Felipe Leme2b9b06c2016-10-14 09:13:06 -0700789void Dumpstate::PrintHeader() const {
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200790 std::string build, fingerprint, radio, bootloader, network, sdkversion;
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700791 char date[80];
Colin Crossf45fa6b2012-03-26 12:38:26 -0700792
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700793 build = android::base::GetProperty("ro.build.display.id", "(unknown)");
794 fingerprint = android::base::GetProperty("ro.build.fingerprint", "(unknown)");
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700795 radio = android::base::GetProperty("gsm.version.baseband", "(unknown)");
796 bootloader = android::base::GetProperty("ro.bootloader", "(unknown)");
797 network = android::base::GetProperty("gsm.operator.alpha", "(unknown)");
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200798 sdkversion = android::base::GetProperty("ro.build.version.sdk", "(unknown)");
Felipe Lemebbaf3c12016-10-11 14:32:25 -0700799 strftime(date, sizeof(date), "%Y-%m-%d %H:%M:%S", localtime(&now_));
Colin Crossf45fa6b2012-03-26 12:38:26 -0700800
Felipe Lemed8b94e52016-12-08 10:21:44 -0800801 printf("========================================================\n");
802 printf("== dumpstate: %s\n", date);
803 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -0700804
Felipe Lemed8b94e52016-12-08 10:21:44 -0800805 printf("\n");
806 printf("Build: %s\n", build.c_str());
Felipe Leme96c2bbb2016-09-26 09:21:21 -0700807 // NOTE: fingerprint entry format is important for other tools.
Felipe Lemed8b94e52016-12-08 10:21:44 -0800808 printf("Build fingerprint: '%s'\n", fingerprint.c_str());
809 printf("Bootloader: %s\n", bootloader.c_str());
810 printf("Radio: %s\n", radio.c_str());
811 printf("Network: %s\n", network.c_str());
Nikita Ioffea325a572019-05-16 19:49:47 +0100812 int64_t module_metadata_version = android::os::GetModuleMetadataVersion();
813 if (module_metadata_version != 0) {
814 printf("Module Metadata version: %" PRId64 "\n", module_metadata_version);
815 }
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +0200816 printf("Android SDK version: %s\n", sdkversion.c_str());
817 printf("SDK extensions: ");
818 RunCommandToFd(STDOUT_FILENO, "", {SDK_EXT_INFO, "--header"},
819 CommandOptions::WithTimeout(1).Always().DropRoot().Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -0700820
Felipe Lemed8b94e52016-12-08 10:21:44 -0800821 printf("Kernel: ");
Felipe Lemef0292972016-11-22 13:57:05 -0800822 DumpFileToFd(STDOUT_FILENO, "", "/proc/version");
Felipe Lemed8b94e52016-12-08 10:21:44 -0800823 printf("Command line: %s\n", strtok(cmdline_buf, "\n"));
Devin Moore09fde8d2023-03-21 16:28:22 +0000824 printf("Bootconfig: ");
825 DumpFileToFd(STDOUT_FILENO, "", "/proc/bootconfig");
Felipe Leme7709f8a2017-12-05 09:30:09 -0800826 printf("Uptime: ");
827 RunCommandToFd(STDOUT_FILENO, "", {"uptime", "-p"},
828 CommandOptions::WithTimeout(1).Always().Build());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800829 printf("Bugreport format version: %s\n", version_.c_str());
Kevin Jeonfa64e642023-07-27 11:36:41 -0400830 printf(
831 "Dumpstate info: id=%d pid=%d dry_run=%d parallel_run=%d strict_run=%d args=%s "
832 "bugreport_mode=%s\n",
833 id_, pid_, PropertiesHelper::IsDryRun(), PropertiesHelper::IsParallelRun(),
834 PropertiesHelper::IsStrictRun(), options_->args.c_str(),
835 options_->bugreport_mode_string.c_str());
Felipe Lemed8b94e52016-12-08 10:21:44 -0800836 printf("\n");
Felipe Leme78f2c862015-12-21 09:55:22 -0800837}
838
Felipe Leme24b66ee2016-06-16 10:55:26 -0700839// List of file extensions that can cause a zip file attachment to be rejected by some email
840// service providers.
841static const std::set<std::string> PROBLEMATIC_FILE_EXTENSIONS = {
842 ".ade", ".adp", ".bat", ".chm", ".cmd", ".com", ".cpl", ".exe", ".hta", ".ins", ".isp",
843 ".jar", ".jse", ".lib", ".lnk", ".mde", ".msc", ".msp", ".mst", ".pif", ".scr", ".sct",
844 ".shb", ".sys", ".vb", ".vbe", ".vbs", ".vxd", ".wsc", ".wsf", ".wsh"
845};
846
Vishnu Naire97d6122018-01-18 13:58:56 -0800847status_t Dumpstate::AddZipEntryFromFd(const std::string& entry_name, int fd,
848 std::chrono::milliseconds timeout = 0ms) {
Felipe Leme24b66ee2016-06-16 10:55:26 -0700849 std::string valid_name = entry_name;
850
851 // Rename extension if necessary.
Chih-Hung Hsiehcb057c22017-08-03 15:48:25 -0700852 size_t idx = entry_name.rfind('.');
Felipe Leme24b66ee2016-06-16 10:55:26 -0700853 if (idx != std::string::npos) {
854 std::string extension = entry_name.substr(idx);
855 std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
856 if (PROBLEMATIC_FILE_EXTENSIONS.count(extension) != 0) {
857 valid_name = entry_name + ".renamed";
858 MYLOGI("Renaming entry %s to %s\n", entry_name.c_str(), valid_name.c_str());
859 }
860 }
861
Felipe Leme6fe9db62016-02-12 09:04:16 -0800862 // Logging statement below is useful to time how long each entry takes, but it's too verbose.
863 // MYLOGD("Adding zip entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000864 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
865 int32_t err = zip_writer_->StartEntryWithTime(valid_name.c_str(), flags,
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700866 get_mtime(fd, ds.now_));
Felipe Leme1d486fe2016-10-14 18:06:47 -0700867 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700868 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", valid_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700869 ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800870 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800871 }
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000872 bool finished_entry = false;
873 auto finish_entry = [this, &finished_entry] {
874 if (!finished_entry) {
875 // This should only be called when we're going to return an earlier error,
876 // which would've been logged. This may imply the file is already corrupt
877 // and any further logging from FinishEntry is more likely to mislead than
878 // not.
879 this->zip_writer_->FinishEntry();
880 }
881 };
882 auto scope_guard = android::base::make_scope_guard(finish_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -0800883 auto start = std::chrono::steady_clock::now();
884 auto end = start + timeout;
885 struct pollfd pfd = {fd, POLLIN};
Felipe Lemee82a27d2016-01-05 13:35:44 -0800886
Felipe Leme770410d2016-01-26 17:07:14 -0800887 std::vector<uint8_t> buffer(65536);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800888 while (1) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800889 if (timeout.count() > 0) {
890 // lambda to recalculate the timeout.
891 auto time_left_ms = [end]() {
892 auto now = std::chrono::steady_clock::now();
893 auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(end - now);
894 return std::max(diff.count(), 0LL);
895 };
896
897 int rc = TEMP_FAILURE_RETRY(poll(&pfd, 1, time_left_ms()));
898 if (rc < 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000899 MYLOGE("Error in poll while adding from fd to zip entry %s:%s\n",
900 entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800901 return -errno;
902 } else if (rc == 0) {
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000903 MYLOGE("Timed out adding from fd to zip entry %s:%s Timeout:%lldms\n",
Vishnu Naire97d6122018-01-18 13:58:56 -0800904 entry_name.c_str(), strerror(errno), timeout.count());
905 return TIMED_OUT;
906 }
907 }
908
Zach Riggle22200402016-08-18 01:01:24 -0400909 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800910 if (bytes_read == 0) {
911 break;
912 } else if (bytes_read == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800913 MYLOGE("read(%s): %s\n", entry_name.c_str(), strerror(errno));
Vishnu Naire97d6122018-01-18 13:58:56 -0800914 return -errno;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800915 }
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700916 err = zip_writer_->WriteBytes(buffer.data(), bytes_read);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800917 if (err) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700918 MYLOGE("zip_writer_->WriteBytes(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800919 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800920 }
921 }
922
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700923 err = zip_writer_->FinishEntry();
Narayan Kamath895f8fc2019-02-08 18:18:08 +0000924 finished_entry = true;
Felipe Leme1d486fe2016-10-14 18:06:47 -0700925 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700926 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Vishnu Naire97d6122018-01-18 13:58:56 -0800927 return UNKNOWN_ERROR;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800928 }
929
Vishnu Naire97d6122018-01-18 13:58:56 -0800930 return OK;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800931}
932
Felipe Leme1d486fe2016-10-14 18:06:47 -0700933bool Dumpstate::AddZipEntry(const std::string& entry_name, const std::string& entry_path) {
934 android::base::unique_fd fd(
935 TEMP_FAILURE_RETRY(open(entry_path.c_str(), O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
Andreas Gampeaff68432016-07-18 18:01:27 -0700936 if (fd == -1) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800937 MYLOGE("open(%s): %s\n", entry_path.c_str(), strerror(errno));
Felipe Lemee82a27d2016-01-05 13:35:44 -0800938 return false;
939 }
940
Vishnu Naire97d6122018-01-18 13:58:56 -0800941 return (AddZipEntryFromFd(entry_name, fd.get()) == OK);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800942}
943
944/* adds a file to the existing zipped bugreport */
Felipe Leme4c2d6632016-09-28 14:32:00 -0700945static int _add_file_from_fd(const char* title __attribute__((unused)), const char* path, int fd) {
Vishnu Naire97d6122018-01-18 13:58:56 -0800946 return (ds.AddZipEntryFromFd(ZIP_ROOT_DIR + path, fd) == OK) ? 0 : 1;
Felipe Lemee82a27d2016-01-05 13:35:44 -0800947}
948
Felipe Leme1d486fe2016-10-14 18:06:47 -0700949void Dumpstate::AddDir(const std::string& dir, bool recursive) {
Felipe Leme678727a2016-09-21 17:22:11 -0700950 MYLOGD("Adding dir %s (recursive: %d)\n", dir.c_str(), recursive);
Felipe Leme46b85da2016-11-21 17:40:45 -0800951 DurationReporter duration_reporter(dir, true);
Felipe Leme678727a2016-09-21 17:22:11 -0700952 dump_files("", dir.c_str(), recursive ? skip_none : is_dir, _add_file_from_fd);
Felipe Lemee82a27d2016-01-05 13:35:44 -0800953}
954
Felipe Leme1d486fe2016-10-14 18:06:47 -0700955bool Dumpstate::AddTextZipEntry(const std::string& entry_name, const std::string& content) {
Felipe Lemecbce55d2016-02-08 09:53:18 -0800956 MYLOGD("Adding zip text entry %s\n", entry_name.c_str());
Kevin Jeon9bbe0ac2022-05-05 22:05:43 +0000957 size_t flags = ZipWriter::kCompress | ZipWriter::kDefaultCompression;
958 int32_t err = zip_writer_->StartEntryWithTime(entry_name.c_str(), flags, ds.now_);
Felipe Leme1d486fe2016-10-14 18:06:47 -0700959 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700960 MYLOGE("zip_writer_->StartEntryWithTime(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700961 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800962 return false;
963 }
964
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700965 err = zip_writer_->WriteBytes(content.c_str(), content.length());
Felipe Leme1d486fe2016-10-14 18:06:47 -0700966 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700967 MYLOGE("zip_writer_->WriteBytes(%s): %s\n", entry_name.c_str(),
Felipe Leme1d486fe2016-10-14 18:06:47 -0700968 ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800969 return false;
970 }
971
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700972 err = zip_writer_->FinishEntry();
Felipe Leme1d486fe2016-10-14 18:06:47 -0700973 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -0700974 MYLOGE("zip_writer_->FinishEntry(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme809d74e2016-02-02 12:57:00 -0800975 return false;
976 }
977
978 return true;
979}
980
Felipe Leme6ec6ac42017-01-10 15:29:53 -0800981static void DoKmsg() {
982 struct stat st;
983 if (!stat(PSTORE_LAST_KMSG, &st)) {
984 /* Also TODO: Make console-ramoops CAP_SYSLOG protected. */
985 DumpFile("LAST KMSG", PSTORE_LAST_KMSG);
986 } else if (!stat(ALT_PSTORE_LAST_KMSG, &st)) {
987 DumpFile("LAST KMSG", ALT_PSTORE_LAST_KMSG);
988 } else {
989 /* TODO: Make last_kmsg CAP_SYSLOG protected. b/5555691 */
990 DumpFile("LAST KMSG", "/proc/last_kmsg");
991 }
992}
993
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800994static void DoKernelLogcat() {
Yao Chenbe3bbc12018-01-17 16:31:10 -0800995 unsigned long timeout_ms = logcat_timeout({"kernel"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -0800996 RunCommand(
997 "KERNEL LOG",
998 {"logcat", "-b", "kernel", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
999 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1000}
1001
Nandana Duttdb379fa2019-10-09 16:54:41 +01001002static void DoSystemLogcat(time_t since) {
1003 char since_str[80];
1004 strftime(since_str, sizeof(since_str), "%Y-%m-%d %H:%M:%S.000", localtime(&since));
1005
1006 unsigned long timeout_ms = logcat_timeout({"main", "system", "crash"});
1007 RunCommand("SYSTEM LOG",
1008 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v", "-T",
1009 since_str},
1010 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1011}
1012
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001013static void DoRadioLogcat() {
1014 unsigned long timeout_ms = logcat_timeout({"radio"});
1015 RunCommand(
1016 "RADIO LOG",
1017 {"logcat", "-b", "radio", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1018 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
1019}
1020
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001021static void DoLogcat() {
Vishnu Nair6921f802017-11-22 09:17:23 -08001022 unsigned long timeout_ms;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001023 // DumpFile("EVENT LOG TAGS", "/etc/event-log-tags");
1024 // calculate timeout
Yao Chenbe3bbc12018-01-17 16:31:10 -08001025 timeout_ms = logcat_timeout({"main", "system", "crash"});
Tony Makae737652017-03-30 17:47:09 +01001026 RunCommand("SYSTEM LOG",
Vishnu Nair6921f802017-11-22 09:17:23 -08001027 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1028 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
Yao Chenbe3bbc12018-01-17 16:31:10 -08001029 timeout_ms = logcat_timeout({"events"});
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001030 RunCommand(
1031 "EVENT LOG",
1032 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001033 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Yao Chenbe3bbc12018-01-17 16:31:10 -08001034 timeout_ms = logcat_timeout({"stats"});
1035 RunCommand(
1036 "STATS LOG",
1037 {"logcat", "-b", "stats", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
Nandana Dutt8d945c02019-08-14 13:30:07 +01001038 CommandOptions::WithTimeoutInMs(timeout_ms).Build(), true /* verbose_duration */);
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08001039 DoRadioLogcat();
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001040
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001041 /* kernels must set CONFIG_PSTORE_PMSG, slice up pstore with device tree */
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001042 RunCommand("LAST LOGCAT", {"logcat", "-L", "-b", "all", "-v", "threadtime", "-v", "printable",
1043 "-v", "uid", "-d", "*:v"});
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001044}
1045
Mike Ma5c267872019-08-21 11:31:34 -07001046static void DumpIncidentReport() {
Mike Ma5c267872019-08-21 11:31:34 -07001047 const std::string path = ds.bugreport_internal_dir_ + "/tmp_incident_report";
1048 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1049 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1050 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1051 if (fd < 0) {
1052 MYLOGE("Could not open %s to dump incident report.\n", path.c_str());
1053 return;
1054 }
Kevin Jeonfa64e642023-07-27 11:36:41 -04001055 RunCommandToFd(fd, "", {"incident", "-u"},
1056 CommandOptions::WithTimeout(PropertiesHelper::IsStrictRun() ? 20 : 120).Build());
Mike Ma5c267872019-08-21 11:31:34 -07001057 bool empty = 0 == lseek(fd, 0, SEEK_END);
1058 if (!empty) {
1059 // Use a different name from "incident.proto"
1060 // /proto/incident.proto is reserved for incident service dump
1061 // i.e. metadata for debugging.
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001062 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "incident_report" + kProtoExt,
1063 path);
1064 } else {
1065 unlink(path.c_str());
Mike Ma5c267872019-08-21 11:31:34 -07001066 }
Mike Ma5c267872019-08-21 11:31:34 -07001067}
1068
Aaron Huang24d215d2022-04-27 18:51:16 +08001069static void DumpNetstatsProto() {
1070 const std::string path = ds.bugreport_internal_dir_ + "/tmp_netstats_proto";
1071 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1072 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1073 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1074 if (fd < 0) {
1075 MYLOGE("Could not open %s to dump netstats proto.\n", path.c_str());
1076 return;
1077 }
1078 RunCommandToFd(fd, "", {"dumpsys", "netstats", "--proto"},
Kevin Jeon2fb3dd62022-09-28 18:48:55 +00001079 CommandOptions::WithTimeout(5).Build());
Aaron Huang24d215d2022-04-27 18:51:16 +08001080 bool empty = 0 == lseek(fd, 0, SEEK_END);
1081 if (!empty) {
1082 ds.EnqueueAddZipEntryAndCleanupIfNeeded(kProtoPath + "netstats" + kProtoExt,
1083 path);
1084 } else {
1085 unlink(path.c_str());
1086 }
1087}
1088
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001089static void MaybeAddSystemTraceToZip() {
1090 // This function copies into the .zip the system trace that was snapshotted
Kean Mariottica20f2d2023-12-15 09:34:25 +00001091 // by the early call to MaybeSnapshotSystemTraceAsync(), if any background
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001092 // tracing was happening.
Kean Mariotti853b73a2023-07-27 12:40:30 +00001093 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
1094 if (!system_trace_exists) {
Kean Mariottica20f2d2023-12-15 09:34:25 +00001095 // No background trace was happening at the time MaybeSnapshotSystemTraceAsync() was invoked
Kean Mariotti853b73a2023-07-27 12:40:30 +00001096 if (!PropertiesHelper::IsUserBuild()) {
1097 MYLOGI(
1098 "No system traces found. Check for previously uploaded traces by looking for "
1099 "go/trace-uuid in logcat")
1100 }
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001101 return;
1102 }
1103 ds.AddZipEntry(
1104 ZIP_ROOT_DIR + SYSTEM_TRACE_SNAPSHOT,
1105 SYSTEM_TRACE_SNAPSHOT);
1106 android::os::UnlinkAndLogOnError(SYSTEM_TRACE_SNAPSHOT);
1107}
1108
Sunny Goyal35949782019-11-19 15:54:36 -08001109static void DumpVisibleWindowViews() {
Sunny Goyal35949782019-11-19 15:54:36 -08001110 DurationReporter duration_reporter("VISIBLE WINDOW VIEWS");
1111 const std::string path = ds.bugreport_internal_dir_ + "/tmp_visible_window_views";
1112 auto fd = android::base::unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(),
1113 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1114 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1115 if (fd < 0) {
1116 MYLOGE("Could not open %s to dump visible views.\n", path.c_str());
1117 return;
1118 }
1119 RunCommandToFd(fd, "", {"cmd", "window", "dump-visible-window-views"},
Kevin Jeon774abde2022-09-28 18:20:43 +00001120 CommandOptions::WithTimeout(10).Build());
Sunny Goyal35949782019-11-19 15:54:36 -08001121 bool empty = 0 == lseek(fd, 0, SEEK_END);
1122 if (!empty) {
1123 ds.AddZipEntry("visible_windows.zip", path);
1124 } else {
1125 MYLOGW("Failed to dump visible windows\n");
1126 }
1127 unlink(path.c_str());
1128}
1129
Jayachandran Ca94c7172017-06-10 15:08:12 -07001130static void DumpIpTablesAsRoot() {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001131 RunCommand("IPTABLES", {"iptables", "-L", "-nvx"});
1132 RunCommand("IP6TABLES", {"ip6tables", "-L", "-nvx"});
Erik Kline32af8c22016-09-28 17:26:26 +09001133 RunCommand("IPTABLES NAT", {"iptables", "-t", "nat", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001134 /* no ip6 nat */
Erik Kline32af8c22016-09-28 17:26:26 +09001135 RunCommand("IPTABLES MANGLE", {"iptables", "-t", "mangle", "-L", "-nvx"});
1136 RunCommand("IP6TABLES MANGLE", {"ip6tables", "-t", "mangle", "-L", "-nvx"});
1137 RunCommand("IPTABLES RAW", {"iptables", "-t", "raw", "-L", "-nvx"});
1138 RunCommand("IP6TABLES RAW", {"ip6tables", "-t", "raw", "-L", "-nvx"});
Felipe Lemec0808152016-06-17 17:37:13 -07001139}
1140
Woody Lin20767a92022-11-29 15:50:24 +08001141static void DumpShutdownCheckpoints() {
1142 const bool shutdown_checkpoints_dumped = AddDumps(
1143 ds.shutdown_checkpoints_.begin(), ds.shutdown_checkpoints_.end(),
1144 "SHUTDOWN CHECKPOINTS", false /* add_to_zip */);
1145 if (!shutdown_checkpoints_dumped) {
1146 printf("*** NO SHUTDOWN CHECKPOINTS to dump in %s\n\n",
1147 SHUTDOWN_CHECKPOINTS_DIR.c_str());
1148 }
1149}
1150
David Andersond9ba4752018-12-11 18:26:59 -08001151static void DumpDynamicPartitionInfo() {
1152 if (!::android::base::GetBoolProperty("ro.boot.dynamic_partitions", false)) {
1153 return;
1154 }
1155
1156 RunCommand("LPDUMP", {"lpdump", "--all"});
David Anderson6650ade2019-10-02 15:18:59 -07001157 RunCommand("DEVICE-MAPPER", {"gsid", "dump-device-mapper"});
David Andersond9ba4752018-12-11 18:26:59 -08001158}
1159
Chris Morin5a50d482022-02-01 17:41:18 -08001160static void AddAnrTraceDir(const std::string& anr_traces_dir) {
Narayan Kamath8f788292017-05-25 13:20:39 +01001161 MYLOGD("AddAnrTraceDir(): dump_traces_file=%s, anr_traces_dir=%s\n", dump_traces_path,
1162 anr_traces_dir.c_str());
1163
1164 // If we're here, dump_traces_path will always be a temporary file
1165 // (created with mkostemp or similar) that contains dumps taken earlier
1166 // on in the process.
1167 if (dump_traces_path != nullptr) {
Chris Morin5a50d482022-02-01 17:41:18 -08001168 MYLOGD("Dumping current ANR traces (%s) to the main bugreport entry\n",
1169 dump_traces_path);
1170 ds.DumpFile("VM TRACES JUST NOW", dump_traces_path);
Narayan Kamath8f788292017-05-25 13:20:39 +01001171
1172 const int ret = unlink(dump_traces_path);
1173 if (ret == -1) {
1174 MYLOGW("Error unlinking temporary trace path %s: %s\n", dump_traces_path,
1175 strerror(errno));
Felipe Lemee184f662016-10-27 10:04:47 -07001176 }
1177 }
1178
Narayan Kamathbd863722017-06-01 18:50:12 +01001179 // Add a specific message for the first ANR Dump.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001180 if (ds.anr_data_.size() > 0) {
Chris Morin5a50d482022-02-01 17:41:18 -08001181 // The "last" ANR will always be present in the body of the main entry.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001182 AddDumps(ds.anr_data_.begin(), ds.anr_data_.begin() + 1,
Chris Morin5a50d482022-02-01 17:41:18 -08001183 "VM TRACES AT LAST ANR", false /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001184
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001185 // Historical ANRs are always included as separate entries in the bugreport zip file.
Chris Morin5a50d482022-02-01 17:41:18 -08001186 AddDumps(ds.anr_data_.begin(), ds.anr_data_.end(),
Narayan Kamath6b9516c2017-10-27 11:15:51 +01001187 "HISTORICAL ANR", true /* add_to_zip */);
Narayan Kamathbd863722017-06-01 18:50:12 +01001188 } else {
Narayan Kamath8f788292017-05-25 13:20:39 +01001189 printf("*** NO ANRs to dump in %s\n\n", ANR_DIR.c_str());
1190 }
Andy Hungd62f7e62024-01-11 15:47:52 -08001191
1192 // Add Java anr traces (such as generated by the Finalizer Watchdog).
1193 AddDumps(ds.anr_trace_data_.begin(), ds.anr_trace_data_.end(), "JAVA ANR TRACES",
1194 true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001195}
1196
1197static void AddAnrTraceFiles() {
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001198 std::string anr_traces_dir = "/data/anr";
Narayan Kamath8f788292017-05-25 13:20:39 +01001199
Chris Morin5a50d482022-02-01 17:41:18 -08001200 AddAnrTraceDir(anr_traces_dir);
Narayan Kamath8f788292017-05-25 13:20:39 +01001201
Makoto Onuki83ec63f2019-01-31 17:08:59 -08001202 RunCommand("ANR FILES", {"ls", "-lt", ANR_DIR});
1203
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001204 // Slow traces for slow operations.
Felipe Lemee184f662016-10-27 10:04:47 -07001205 struct stat st;
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001206 int i = 0;
1207 while (true) {
1208 const std::string slow_trace_path =
1209 anr_traces_dir + android::base::StringPrintf("slow%02d.txt", i);
1210 if (stat(slow_trace_path.c_str(), &st)) {
1211 // No traces file at this index, done with the files.
1212 break;
Felipe Lemee184f662016-10-27 10:04:47 -07001213 }
Elliott Hughes69fe5ec2018-03-23 11:04:25 -07001214 ds.DumpFile("VM TRACES WHEN SLOW", slow_trace_path.c_str());
1215 i++;
Felipe Lemee184f662016-10-27 10:04:47 -07001216 }
1217}
1218
Wei Wang509bb5d2017-06-09 14:42:12 -07001219static void DumpBlockStatFiles() {
1220 DurationReporter duration_reporter("DUMP BLOCK STAT");
Wei Wang509bb5d2017-06-09 14:42:12 -07001221
Wei Wang1dc1ef52017-06-12 11:28:37 -07001222 std::unique_ptr<DIR, std::function<int(DIR*)>> dirptr(opendir(BLK_DEV_SYS_DIR), closedir);
1223
1224 if (dirptr == nullptr) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001225 MYLOGE("Failed to open %s: %s\n", BLK_DEV_SYS_DIR, strerror(errno));
1226 return;
1227 }
1228
1229 printf("------ DUMP BLOCK STAT ------\n\n");
Wei Wang1dc1ef52017-06-12 11:28:37 -07001230 while (struct dirent *d = readdir(dirptr.get())) {
Wei Wang509bb5d2017-06-09 14:42:12 -07001231 if ((d->d_name[0] == '.')
1232 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
1233 || (d->d_name[1] == '\0'))) {
1234 continue;
1235 }
1236 const std::string new_path =
1237 android::base::StringPrintf("%s/%s", BLK_DEV_SYS_DIR, d->d_name);
1238 printf("------ BLOCK STAT (%s) ------\n", new_path.c_str());
1239 dump_files("", new_path.c_str(), skip_not_stat, dump_stat_from_fd);
1240 printf("\n");
1241 }
Wei Wang1dc1ef52017-06-12 11:28:37 -07001242 return;
Wei Wang509bb5d2017-06-09 14:42:12 -07001243}
Jayachandran Ca94c7172017-06-10 15:08:12 -07001244
1245static void DumpPacketStats() {
1246 DumpFile("NETWORK DEV INFO", "/proc/net/dev");
Jayachandran Ca94c7172017-06-10 15:08:12 -07001247}
1248
1249static void DumpIpAddrAndRules() {
1250 /* The following have a tendency to get wedged when wifi drivers/fw goes belly-up. */
Ray Chencbf278a2023-11-20 07:49:45 +00001251 RunCommand("NETWORK INTERFACES", {"ip", "-s", "link"});
Jayachandran Ca94c7172017-06-10 15:08:12 -07001252 RunCommand("IPv4 ADDRESSES", {"ip", "-4", "addr", "show"});
1253 RunCommand("IPv6 ADDRESSES", {"ip", "-6", "addr", "show"});
1254 RunCommand("IP RULES", {"ip", "rule", "show"});
1255 RunCommand("IP RULES v6", {"ip", "-6", "rule", "show"});
1256}
1257
Nandana Dutt5c390032019-03-12 10:52:56 +00001258static Dumpstate::RunStatus RunDumpsysTextByPriority(const std::string& title, int priority,
1259 std::chrono::milliseconds timeout,
1260 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001261 auto start = std::chrono::steady_clock::now();
Vishnu Naire97d6122018-01-18 13:58:56 -08001262 sp<android::IServiceManager> sm = defaultServiceManager();
1263 Dumpsys dumpsys(sm.get());
Vishnu Naire97d6122018-01-18 13:58:56 -08001264 Vector<String16> args;
1265 Dumpsys::setServiceArgs(args, /* asProto = */ false, priority);
Vishnu Naire97d6122018-01-18 13:58:56 -08001266 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ false);
1267 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001268 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001269 std::string path(title);
1270 path.append(" - ").append(String8(service).c_str());
Vishnu Naire97d6122018-01-18 13:58:56 -08001271 size_t bytes_written = 0;
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001272 if (PropertiesHelper::IsDryRun()) {
1273 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1274 dumpsys.writeDumpFooter(STDOUT_FILENO, service, std::chrono::milliseconds(1));
1275 } else {
Devin Mooref492c1a2023-03-15 19:19:03 +00001276 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP | Dumpsys::TYPE_PID |
1277 Dumpsys::TYPE_CLIENTS | Dumpsys::TYPE_THREAD,
Devin Mooreae68df22023-02-24 20:59:51 +00001278 service, args);
1279 if (status == OK) {
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001280 dumpsys.writeDumpHeader(STDOUT_FILENO, service, priority);
1281 std::chrono::duration<double> elapsed_seconds;
1282 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH &&
1283 service == String16("meminfo")) {
1284 // Use a longer timeout for meminfo, since 30s is not always enough.
1285 status = dumpsys.writeDump(STDOUT_FILENO, service, 60s,
1286 /* as_proto = */ false, elapsed_seconds,
1287 bytes_written);
1288 } else {
1289 status = dumpsys.writeDump(STDOUT_FILENO, service, service_timeout,
1290 /* as_proto = */ false, elapsed_seconds,
1291 bytes_written);
1292 }
1293 dumpsys.writeDumpFooter(STDOUT_FILENO, service, elapsed_seconds);
1294 bool dump_complete = (status == OK);
1295 dumpsys.stopDumpThread(dump_complete);
Devin Moorecdfa4602023-03-16 20:49:39 +00001296 } else {
1297 MYLOGE("Failed to start dump thread for service: %s, status: %d",
1298 String8(service).c_str(), status);
Gavin Corkeryfac7e2b2021-07-08 22:39:02 +01001299 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001300 }
Vishnu Naire97d6122018-01-18 13:58:56 -08001301
1302 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1303 std::chrono::steady_clock::now() - start);
1304 if (elapsed_duration > timeout) {
1305 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1306 elapsed_duration.count());
1307 break;
1308 }
1309 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001310 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001311}
1312
Vishnu Nair64afc022018-02-01 15:29:34 -08001313static void RunDumpsysText(const std::string& title, int priority,
1314 std::chrono::milliseconds timeout,
1315 std::chrono::milliseconds service_timeout) {
1316 DurationReporter duration_reporter(title);
1317 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1318 fsync(STDOUT_FILENO);
1319 RunDumpsysTextByPriority(title, priority, timeout, service_timeout);
1320}
1321
1322/* Dump all services registered with Normal or Default priority. */
Nandana Dutt5c390032019-03-12 10:52:56 +00001323static Dumpstate::RunStatus RunDumpsysTextNormalPriority(const std::string& title,
1324 std::chrono::milliseconds timeout,
1325 std::chrono::milliseconds service_timeout) {
Vishnu Nair64afc022018-02-01 15:29:34 -08001326 DurationReporter duration_reporter(title);
1327 dprintf(STDOUT_FILENO, "------ %s (/system/bin/dumpsys) ------\n", title.c_str());
1328 fsync(STDOUT_FILENO);
1329 RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_NORMAL, timeout,
1330 service_timeout);
Nandana Dutt5c390032019-03-12 10:52:56 +00001331
1332 RETURN_IF_USER_DENIED_CONSENT();
1333
1334 return RunDumpsysTextByPriority(title, IServiceManager::DUMP_FLAG_PRIORITY_DEFAULT, timeout,
1335 service_timeout);
Vishnu Nair64afc022018-02-01 15:29:34 -08001336}
1337
Nandana Dutt5c390032019-03-12 10:52:56 +00001338static Dumpstate::RunStatus RunDumpsysProto(const std::string& title, int priority,
1339 std::chrono::milliseconds timeout,
1340 std::chrono::milliseconds service_timeout) {
Vishnu Naire97d6122018-01-18 13:58:56 -08001341 sp<android::IServiceManager> sm = defaultServiceManager();
1342 Dumpsys dumpsys(sm.get());
1343 Vector<String16> args;
1344 Dumpsys::setServiceArgs(args, /* asProto = */ true, priority);
1345 DurationReporter duration_reporter(title);
1346
1347 auto start = std::chrono::steady_clock::now();
1348 Vector<String16> services = dumpsys.listServices(priority, /* supports_proto = */ true);
1349 for (const String16& service : services) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001350 RETURN_IF_USER_DENIED_CONSENT();
Vishnu Naire97d6122018-01-18 13:58:56 -08001351 std::string path(kProtoPath);
1352 path.append(String8(service).c_str());
1353 if (priority == IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL) {
1354 path.append("_CRITICAL");
1355 } else if (priority == IServiceManager::DUMP_FLAG_PRIORITY_HIGH) {
1356 path.append("_HIGH");
1357 }
1358 path.append(kProtoExt);
Steven Morelandcbd69fc2021-07-20 20:45:43 +00001359 status_t status = dumpsys.startDumpThread(Dumpsys::TYPE_DUMP, service, args);
Vishnu Naire97d6122018-01-18 13:58:56 -08001360 if (status == OK) {
1361 status = ds.AddZipEntryFromFd(path, dumpsys.getDumpFd(), service_timeout);
1362 bool dumpTerminated = (status == OK);
1363 dumpsys.stopDumpThread(dumpTerminated);
1364 }
1365 ZipWriter::FileEntry file_entry;
1366 ds.zip_writer_->GetLastEntry(&file_entry);
Vishnu Naire97d6122018-01-18 13:58:56 -08001367
1368 auto elapsed_duration = std::chrono::duration_cast<std::chrono::milliseconds>(
1369 std::chrono::steady_clock::now() - start);
1370 if (elapsed_duration > timeout) {
1371 MYLOGE("*** command '%s' timed out after %llums\n", title.c_str(),
1372 elapsed_duration.count());
1373 break;
1374 }
1375 }
Nandana Dutt5c390032019-03-12 10:52:56 +00001376 return Dumpstate::RunStatus::OK;
Vishnu Naire97d6122018-01-18 13:58:56 -08001377}
1378
Nandana Dutta7db6342018-11-21 14:53:34 +00001379// Runs dumpsys on services that must dump first and will take less than 100ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001380static Dumpstate::RunStatus RunDumpsysCritical() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001381 RunDumpsysText("DUMPSYS CRITICAL", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1382 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Nandana Dutt5c390032019-03-12 10:52:56 +00001383
1384 RETURN_IF_USER_DENIED_CONSENT();
1385
1386 return RunDumpsysProto("DUMPSYS CRITICAL PROTO", IServiceManager::DUMP_FLAG_PRIORITY_CRITICAL,
1387 /* timeout= */ 5s, /* service_timeout= */ 500ms);
Vishnu Nair780b1282017-10-10 13:57:24 -07001388}
1389
1390// Runs dumpsys on services that must dump first but can take up to 250ms to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001391static Dumpstate::RunStatus RunDumpsysHigh() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001392 // TODO meminfo takes ~10s, connectivity takes ~5sec to dump. They are both
1393 // high priority. Reduce timeout once they are able to dump in a shorter time or
1394 // moved to a parallel task.
1395 RunDumpsysText("DUMPSYS HIGH", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1396 /* timeout= */ 90s, /* service_timeout= */ 30s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001397
1398 RETURN_IF_USER_DENIED_CONSENT();
1399
1400 return RunDumpsysProto("DUMPSYS HIGH PROTO", IServiceManager::DUMP_FLAG_PRIORITY_HIGH,
1401 /* timeout= */ 5s, /* service_timeout= */ 1s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001402}
1403
1404// Runs dumpsys on services that must dump but can take up to 10s to dump.
Nandana Dutt5c390032019-03-12 10:52:56 +00001405static Dumpstate::RunStatus RunDumpsysNormal() {
Vishnu Nair64afc022018-02-01 15:29:34 -08001406 RunDumpsysTextNormalPriority("DUMPSYS", /* timeout= */ 90s, /* service_timeout= */ 10s);
Nandana Dutt5c390032019-03-12 10:52:56 +00001407
1408 RETURN_IF_USER_DENIED_CONSENT();
1409
1410 return RunDumpsysProto("DUMPSYS PROTO", IServiceManager::DUMP_FLAG_PRIORITY_NORMAL,
1411 /* timeout= */ 90s, /* service_timeout= */ 10s);
Vishnu Nair780b1282017-10-10 13:57:24 -07001412}
1413
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001414/*
1415 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1416 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1417 * if it's not running in the parallel task.
1418 */
1419static void DumpHals(int out_fd = STDOUT_FILENO) {
Yifan Hong30528a22020-08-07 18:24:06 -07001420 RunCommand("HARDWARE HALS", {"lshal", "--all", "--types=all"},
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001421 CommandOptions::WithTimeout(10).AsRootIfAvailable().Build(),
1422 false, out_fd);
Nandana Dutt6ad9a602019-03-11 16:33:24 +00001423
Steven Moreland44cd9482018-01-04 16:24:13 -08001424 using android::hidl::manager::V1_0::IServiceManager;
1425 using android::hardware::defaultServiceManager;
1426
1427 sp<IServiceManager> sm = defaultServiceManager();
1428 if (sm == nullptr) {
1429 MYLOGE("Could not retrieve hwservicemanager to dump hals.\n");
1430 return;
1431 }
1432
1433 auto ret = sm->list([&](const auto& interfaces) {
1434 for (const std::string& interface : interfaces) {
1435 std::string cleanName = interface;
Steven Morelandc6b1fc22023-07-26 23:53:58 +00001436 std::replace_if(
1437 cleanName.begin(), cleanName.end(),
1438 [](char c) {
1439 return !isalnum(c) && std::string("@-_.").find(c) == std::string::npos;
1440 },
1441 '_');
Nandana Dutt979388e2018-11-30 16:48:55 +00001442 const std::string path = ds.bugreport_internal_dir_ + "/lshal_debug_" + cleanName;
Steven Moreland44cd9482018-01-04 16:24:13 -08001443
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001444 bool empty = false;
Steven Moreland44cd9482018-01-04 16:24:13 -08001445 {
1446 auto fd = android::base::unique_fd(
1447 TEMP_FAILURE_RETRY(open(path.c_str(),
1448 O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
1449 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
1450 if (fd < 0) {
1451 MYLOGE("Could not open %s to dump additional hal information.\n", path.c_str());
1452 continue;
1453 }
1454 RunCommandToFd(fd,
1455 "",
Steven Morelandc81cd3c2018-01-18 14:36:26 -08001456 {"lshal", "debug", "-E", interface},
Steven Moreland44cd9482018-01-04 16:24:13 -08001457 CommandOptions::WithTimeout(2).AsRootIfAvailable().Build());
1458
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001459 empty = 0 == lseek(fd, 0, SEEK_END);
Steven Moreland44cd9482018-01-04 16:24:13 -08001460 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001461 if (!empty) {
1462 ds.EnqueueAddZipEntryAndCleanupIfNeeded("lshal-debug/" + cleanName + ".txt",
1463 path);
1464 } else {
1465 unlink(path.c_str());
1466 }
Steven Moreland44cd9482018-01-04 16:24:13 -08001467 }
1468 });
1469
1470 if (!ret.isOk()) {
1471 MYLOGE("Could not list hals from hwservicemanager.\n");
1472 }
1473}
1474
Devin Moore8df81bb2022-06-08 22:47:02 +00001475// Dump all of the files that make up the vendor interface.
1476// See the files listed in dumpFileList() for the latest list of files.
1477static void DumpVintf() {
Devin Moore16271d92022-09-22 18:28:48 +00001478
1479 const std::string sku = android::base::GetProperty("ro.boot.product.hardware.sku", "");
1480 const auto vintfFiles = android::vintf::details::dumpFileList(sku);
Devin Moore8df81bb2022-06-08 22:47:02 +00001481 for (const auto vintfFile : vintfFiles) {
1482 struct stat st;
1483 if (stat(vintfFile.c_str(), &st) == 0) {
1484 if (S_ISDIR(st.st_mode)) {
1485 ds.AddDir(vintfFile, true /* recursive */);
1486 } else {
1487 ds.EnqueueAddZipEntryAndCleanupIfNeeded(ZIP_ROOT_DIR + vintfFile,
1488 vintfFile);
1489 }
1490 }
1491 }
1492}
1493
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001494static void DumpExternalFragmentationInfo() {
1495 struct stat st;
1496 if (stat("/proc/buddyinfo", &st) != 0) {
1497 MYLOGE("Unable to dump external fragmentation info\n");
1498 return;
1499 }
1500
1501 printf("------ EXTERNAL FRAGMENTATION INFO ------\n");
1502 std::ifstream ifs("/proc/buddyinfo");
1503 auto unusable_index_regex = std::regex{"Node\\s+([0-9]+),\\s+zone\\s+(\\S+)\\s+(.*)"};
1504 for (std::string line; std::getline(ifs, line);) {
1505 std::smatch match_results;
1506 if (std::regex_match(line, match_results, unusable_index_regex)) {
1507 std::stringstream free_pages(std::string{match_results[3]});
1508 std::vector<int> free_pages_per_order(std::istream_iterator<int>{free_pages},
1509 std::istream_iterator<int>());
1510
1511 int total_free_pages = 0;
1512 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1513 total_free_pages += (free_pages_per_order[i] * std::pow(2, i));
1514 }
1515
1516 printf("Node %s, zone %8s", match_results[1].str().c_str(),
1517 match_results[2].str().c_str());
1518
1519 int usable_free_pages = total_free_pages;
1520 for (size_t i = 0; i < free_pages_per_order.size(); i++) {
1521 auto unusable_index = (total_free_pages - usable_free_pages) /
1522 static_cast<double>(total_free_pages);
1523 printf(" %5.3f", unusable_index);
1524 usable_free_pages -= (free_pages_per_order[i] * std::pow(2, i));
1525 }
1526
1527 printf("\n");
1528 }
1529 }
1530 printf("\n");
1531}
1532
mhasankd451a472020-05-26 18:02:39 -07001533static void DumpstateLimitedOnly() {
EdenSue8fe4522023-11-20 15:37:23 +08001534 // Trimmed-down version of dumpstate to only include a allowlisted
mhasankd451a472020-05-26 18:02:39 -07001535 // set of logs (system log, event log, and system server / system app
1536 // crashes, and networking logs). See b/136273873 and b/138459828
1537 // for context.
1538 DurationReporter duration_reporter("DUMPSTATE");
1539 unsigned long timeout_ms;
1540 // calculate timeout
1541 timeout_ms = logcat_timeout({"main", "system", "crash"});
1542 RunCommand("SYSTEM LOG",
1543 {"logcat", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1544 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1545 timeout_ms = logcat_timeout({"events"});
1546 RunCommand(
1547 "EVENT LOG",
1548 {"logcat", "-b", "events", "-v", "threadtime", "-v", "printable", "-v", "uid", "-d", "*:v"},
1549 CommandOptions::WithTimeoutInMs(timeout_ms).Build());
1550
1551 printf("========================================================\n");
1552 printf("== Networking Service\n");
1553 printf("========================================================\n");
1554
1555 RunDumpsys("DUMPSYS NETWORK_SERVICE_LIMITED", {"wifi", "-a"},
1556 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hugo Benichiaa162682020-10-30 23:28:56 +09001557 RunDumpsys("DUMPSYS CONNECTIVITY REQUESTS", {"connectivity", "requests"},
1558 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
mhasankd451a472020-05-26 18:02:39 -07001559
1560 printf("========================================================\n");
1561 printf("== Dropbox crashes\n");
1562 printf("========================================================\n");
1563
1564 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1565 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1566
Bryan Yuefb85d92024-02-02 13:37:06 +00001567
1568 printf("========================================================\n");
1569 printf("== ANR Traces\n");
1570 printf("========================================================\n");
1571
Bryan Yucf038cf2024-05-08 09:25:25 +00001572 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Bryan Yuefb85d92024-02-02 13:37:06 +00001573 AddAnrTraceFiles();
1574
mhasankd451a472020-05-26 18:02:39 -07001575 printf("========================================================\n");
1576 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1577 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1578 printf("========================================================\n");
1579 printf("== dumpstate: done (id %d)\n", ds.id_);
1580 printf("========================================================\n");
1581}
1582
Rhed Jaoe017f982020-07-21 17:58:41 +08001583/*
1584 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1585 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1586 * if it's not running in the parallel task.
1587 */
1588static void DumpCheckins(int out_fd = STDOUT_FILENO) {
1589 dprintf(out_fd, "========================================================\n");
1590 dprintf(out_fd, "== Checkins\n");
1591 dprintf(out_fd, "========================================================\n");
1592
1593 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"}, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001594 RunDumpsys("CHECKIN NETSTATS", {"netstats", "--checkin"}, out_fd);
1595 RunDumpsys("CHECKIN PROCSTATS", {"procstats", "-c"}, out_fd);
1596 RunDumpsys("CHECKIN USAGESTATS", {"usagestats", "-c"}, out_fd);
1597 RunDumpsys("CHECKIN PACKAGE", {"package", "--checkin"}, out_fd);
1598}
1599
1600/*
1601 * Runs dumpsys on activity service to dump all application activities, services
1602 * and providers in the device.
1603 *
1604 * |out_fd| A fd to support the DumpPool to output results to a temporary file.
1605 * Dumpstate can pick up later and output to the bugreport. Using STDOUT_FILENO
1606 * if it's not running in the parallel task.
1607 */
1608static void DumpAppInfos(int out_fd = STDOUT_FILENO) {
1609 dprintf(out_fd, "========================================================\n");
1610 dprintf(out_fd, "== Running Application Activities\n");
1611 dprintf(out_fd, "========================================================\n");
1612
1613 // The following dumpsys internally collects output from running apps, so it can take a long
1614 // time. So let's extend the timeout.
1615
1616 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
1617
1618 RunDumpsys("APP ACTIVITIES", {"activity", "-v", "all"}, DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1619
1620 dprintf(out_fd, "========================================================\n");
1621 dprintf(out_fd, "== Running Application Services (platform)\n");
1622 dprintf(out_fd, "========================================================\n");
1623
1624 RunDumpsys("APP SERVICES PLATFORM", {"activity", "service", "all-platform-non-critical"},
1625 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1626
1627 dprintf(out_fd, "========================================================\n");
1628 dprintf(out_fd, "== Running Application Services (non-platform)\n");
1629 dprintf(out_fd, "========================================================\n");
1630
1631 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
1632 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1633
1634 dprintf(out_fd, "========================================================\n");
1635 dprintf(out_fd, "== Running Application Providers (platform)\n");
1636 dprintf(out_fd, "========================================================\n");
1637
1638 RunDumpsys("APP PROVIDERS PLATFORM", {"activity", "provider", "all-platform"},
Rhed Jaob049f182021-01-11 21:08:43 +08001639 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
Rhed Jaoe017f982020-07-21 17:58:41 +08001640
1641 dprintf(out_fd, "========================================================\n");
1642 dprintf(out_fd, "== Running Application Providers (non-platform)\n");
1643 dprintf(out_fd, "========================================================\n");
1644
1645 RunDumpsys("APP PROVIDERS NON-PLATFORM", {"activity", "provider", "all-non-platform"},
1646 DUMPSYS_COMPONENTS_OPTIONS, 0, out_fd);
1647}
1648
Nandana Dutt5c390032019-03-12 10:52:56 +00001649// Dumps various things. Returns early with status USER_CONSENT_DENIED if user denies consent
1650// via the consent they are shown. Ignores other errors that occur while running various
1651// commands. The consent checking is currently done around long running tasks, which happen to
1652// be distributed fairly evenly throughout the function.
Kean Mariotti306633e2022-09-05 16:30:47 +00001653Dumpstate::RunStatus Dumpstate::dumpstate() {
Felipe Leme9a523ae2016-10-20 15:10:33 -07001654 DurationReporter duration_reporter("DUMPSTATE");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001655
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001656 // Enqueue slow functions into the thread pool, if the parallel run is enabled.
Aaron Huang24d215d2022-04-27 18:51:16 +08001657 std::future<std::string> dump_hals, dump_incident_report, dump_board, dump_checkins,
Kean Mariottica20f2d2023-12-15 09:34:25 +00001658 dump_netstats_report;
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001659 if (ds.dump_pool_) {
1660 // Pool was shutdown in DumpstateDefaultAfterCritical method in order to
Kean Mariotti306633e2022-09-05 16:30:47 +00001661 // drop root user. Restarts it.
1662 ds.dump_pool_->start(/* thread_counts = */3);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001663
Chris Morinbc223142022-02-04 14:17:11 -08001664 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
1665 dump_incident_report = ds.dump_pool_->enqueueTask(
1666 DUMP_INCIDENT_REPORT_TASK, &DumpIncidentReport);
Aaron Huang24d215d2022-04-27 18:51:16 +08001667 dump_netstats_report = ds.dump_pool_->enqueueTask(
1668 DUMP_NETSTATS_PROTO_TASK, &DumpNetstatsProto);
Chris Morinbc223142022-02-04 14:17:11 -08001669 dump_board = ds.dump_pool_->enqueueTaskWithFd(
1670 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
1671 dump_checkins = ds.dump_pool_->enqueueTaskWithFd(DUMP_CHECKINS_TASK, &DumpCheckins, _1);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001672 }
1673
Nandana Dutt5c390032019-03-12 10:52:56 +00001674 // Dump various things. Note that anything that takes "long" (i.e. several seconds) should
1675 // check intermittently (if it's intrerruptable like a foreach on pids) and/or should be wrapped
1676 // in a consent check (via RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK).
Arve Hjønnevåg2db0f5f2014-10-15 18:08:37 -07001677 dump_dev_files("TRUSTY VERSION", "/sys/bus/platform/drivers/trusty", "trusty_version");
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001678 RunCommand("UPTIME", {"uptime"});
Wei Wang509bb5d2017-06-09 14:42:12 -07001679 DumpBlockStatFiles();
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001680 DumpFile("MEMORY INFO", "/proc/meminfo");
1681 RunCommand("CPU INFO", {"top", "-b", "-n", "1", "-H", "-s", "6", "-o",
Felipe Leme30dbfa12016-09-02 12:43:26 -07001682 "pid,tid,user,pr,ni,%cpu,s,virt,res,pcy,cmd,name"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001683
Kevin Jeon947922b2022-09-21 00:29:18 +00001684 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunCommand, "BUGREPORT_PROCDUMP", {"bugreport_procdump"},
1685 CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001686
Sunny Goyal35949782019-11-19 15:54:36 -08001687 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpVisibleWindowViews);
1688
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001689 DumpFile("VIRTUAL MEMORY STATS", "/proc/vmstat");
1690 DumpFile("VMALLOC INFO", "/proc/vmallocinfo");
1691 DumpFile("SLAB INFO", "/proc/slabinfo");
1692 DumpFile("ZONEINFO", "/proc/zoneinfo");
1693 DumpFile("PAGETYPEINFO", "/proc/pagetypeinfo");
1694 DumpFile("BUDDYINFO", "/proc/buddyinfo");
Hridya Valsarajuac582cd2019-08-05 15:39:54 -07001695 DumpExternalFragmentationInfo();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001696
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001697 DumpFile("KERNEL CPUFREQ", "/sys/devices/system/cpu/cpu0/cpufreq/stats/time_in_state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001698
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001699 RunCommand("PROCESSES AND THREADS",
Yohei Yukawa591a72d2017-10-05 21:36:35 -07001700 {"ps", "-A", "-T", "-Z", "-O", "pri,nice,rtprio,sched,pcy,time"});
Nandana Dutt5c390032019-03-12 10:52:56 +00001701
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001702 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001703 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_hals));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001704 } else {
1705 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_HALS_TASK, DumpHals);
1706 }
Steven Moreland81b429e2017-01-31 19:50:46 -08001707
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001708 RunCommand("PRINTENV", {"printenv"});
Elliott Hughes21b7c8d2016-10-28 08:53:02 -07001709 RunCommand("NETSTAT", {"netstat", "-nW"});
Felipe Lemee4eca582016-06-10 17:48:08 -07001710 struct stat s;
1711 if (stat("/proc/modules", &s) != 0) {
1712 MYLOGD("Skipping 'lsmod' because /proc/modules does not exist\n");
1713 } else {
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001714 RunCommand("LSMOD", {"lsmod"});
Woody Linc198f252021-05-04 16:37:11 +08001715 RunCommand("MODULES INFO",
1716 {"sh", "-c", "cat /proc/modules | cut -d' ' -f1 | "
1717 " while read MOD ; do echo modinfo:$MOD ; modinfo $MOD ; "
1718 "done"}, CommandOptions::AS_ROOT);
Felipe Lemee4eca582016-06-10 17:48:08 -07001719 }
Michal Karpinski4db754f2015-12-11 18:04:32 +00001720
Tom Cherryb87dbfa2020-07-28 11:28:53 -07001721 if (android::base::GetBoolProperty("ro.logd.kernel", false)) {
Siarhei Vishniakou4a0a8772017-12-05 16:22:49 -08001722 DoKernelLogcat();
1723 } else {
1724 do_dmesg();
1725 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001726
Devin Moore8df81bb2022-06-08 22:47:02 +00001727 DumpVintf();
1728
Felipe Lemef0292972016-11-22 13:57:05 -08001729 RunCommand("LIST OF OPEN FILES", {"lsof"}, CommandOptions::AS_ROOT);
Nandana Dutt5c390032019-03-12 10:52:56 +00001730
Jeff Brown1dc94e32014-09-11 14:15:27 -07001731 for_each_tid(show_wchan, "BLOCKED PROCESS WAIT-CHANNELS");
Mark Salyzyna297c322016-02-05 15:33:17 -08001732 for_each_pid(show_showtime, "PROCESS TIMES (pid cmd user system iowait+percentage)");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001733
Jack Yu5a6b2e22020-08-14 18:13:35 +08001734 /* Dump Nfc NCI logs */
1735 ds.AddDir("/data/misc/nfc/logs", true);
Ajay Panickerd886ec42016-09-14 12:26:46 -07001736
Paul Chang0d2aad72020-02-13 20:04:03 +08001737 if (ds.options_->do_screenshot && !ds.do_early_screenshot_) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08001738 MYLOGI("taking late screenshot\n");
Felipe Lemebbaf3c12016-10-11 14:32:25 -07001739 ds.TakeScreenshot();
Jeff Sharkey5a930032013-03-19 15:05:19 -07001740 }
1741
Felipe Lemee184f662016-10-27 10:04:47 -07001742 AddAnrTraceFiles();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001743
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00001744 MaybeAddSystemTraceToZip();
1745
Narayan Kamath8f788292017-05-25 13:20:39 +01001746 // NOTE: tombstones are always added as separate entries in the zip archive
1747 // and are not interspersed with the main report.
Luis Hector Chavez5f6ee4a2018-03-14 15:12:46 -07001748 const bool tombstones_dumped = AddDumps(ds.tombstone_data_.begin(), ds.tombstone_data_.end(),
Narayan Kamathbd863722017-06-01 18:50:12 +01001749 "TOMBSTONE", true /* add_to_zip */);
Narayan Kamath8f788292017-05-25 13:20:39 +01001750 if (!tombstones_dumped) {
1751 printf("*** NO TOMBSTONES to dump in %s\n\n", TOMBSTONE_DIR.c_str());
Christopher Ferris7dc7f322014-07-22 16:08:19 -07001752 }
1753
Jayachandran Ca94c7172017-06-10 15:08:12 -07001754 DumpPacketStats();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001755
Lorenzo Colitti807f2dd2022-05-27 12:48:37 +09001756 RunDumpsys("EBPF MAP STATS", {"connectivity", "trafficcontroller"});
Chenbo Feng276a3b62018-08-07 11:44:49 -07001757
Felipe Leme6ec6ac42017-01-10 15:29:53 -08001758 DoKmsg();
Mark Salyzyn2262c162014-12-16 09:09:26 -08001759
Woody Lin20767a92022-11-29 15:50:24 +08001760 DumpShutdownCheckpoints();
1761
Jayachandran Ca94c7172017-06-10 15:08:12 -07001762 DumpIpAddrAndRules();
Sreeram Ramachandran2b3bba32014-07-08 15:40:55 -07001763
1764 dump_route_tables();
1765
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001766 RunCommand("ARP CACHE", {"ip", "-4", "neigh", "show"});
1767 RunCommand("IPv6 ND CACHE", {"ip", "-6", "neigh", "show"});
1768 RunCommand("MULTICAST ADDRESSES", {"ip", "maddr"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001769
Nandana Dutt5c390032019-03-12 10:52:56 +00001770 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysHigh);
Lorenzo Colitti6afc38c2015-09-09 22:59:25 +09001771
Chiachang Wang668ede42021-05-17 17:14:20 +08001772 // The dump mechanism in connectivity is refactored due to modularization work. Connectivity can
1773 // only register with a default priority(NORMAL priority). Dumpstate has to call connectivity
1774 // dump with priority parameters to dump high priority information.
1775 RunDumpsys("SERVICE HIGH connectivity", {"connectivity", "--dump-priority", "HIGH"},
1776 CommandOptions::WithTimeout(10).Build());
1777
Elliott Hughes23ccc622017-02-28 10:14:22 -08001778 RunCommand("SYSTEM PROPERTIES", {"getprop"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001779
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001780 DumpFile("SYSTEM BUILD-TIME RELEASE FLAGS", "/system/etc/build_flags.json");
1781 DumpFile("SYSTEM_EXT BUILD-TIME RELEASE FLAGS", "/system_ext/etc/build_flags.json");
1782 DumpFile("PRODUCT BUILD-TIME RELEASE FLAGS", "/product/etc/build_flags.json");
1783 DumpFile("VENDOR BUILD-TIME RELEASE FLAGS", "/vendor/etc/build_flags.json");
1784
MÃ¥rten Kongstad5ad813f2023-09-28 10:09:18 +02001785 RunCommand("ACONFIG FLAGS", {PRINT_FLAGS},
1786 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
Joe Onoratod38bc3a2023-06-29 15:48:28 -07001787
Jin Qianf334d662017-10-10 14:41:37 -07001788 RunCommand("STORAGED IO INFO", {"storaged", "-u", "-p"});
ynwangf649a6e2016-07-17 21:56:00 -07001789
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001790 RunCommand("FILESYSTEMS & FREE SPACE", {"df"});
Colin Crossf45fa6b2012-03-26 12:38:26 -07001791
Colin Crossf45fa6b2012-03-26 12:38:26 -07001792 /* Binder state is expensive to look at as it uses a lot of memory. */
Hridya Valsaraju920ba712020-02-09 16:27:01 -08001793 std::string binder_logs_dir = access("/dev/binderfs/binder_logs", R_OK) ?
1794 "/sys/kernel/debug/binder" : "/dev/binderfs/binder_logs";
1795
1796 DumpFile("BINDER FAILED TRANSACTION LOG", binder_logs_dir + "/failed_transaction_log");
1797 DumpFile("BINDER TRANSACTION LOG", binder_logs_dir + "/transaction_log");
1798 DumpFile("BINDER TRANSACTIONS", binder_logs_dir + "/transactions");
1799 DumpFile("BINDER STATS", binder_logs_dir + "/stats");
1800 DumpFile("BINDER STATE", binder_logs_dir + "/state");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001801
Yifan Hongd90cc652020-02-08 16:52:02 -08001802 ds.AddDir(SNAPSHOTCTL_LOG_DIR, false);
1803
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001804 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001805 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_board));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001806 } else {
1807 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
1808 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07001809
Steven Moreland7440ddb2016-12-15 16:13:39 -08001810 /* Migrate the ril_dumpstate to a device specific dumpstate? */
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001811 int rilDumpstateTimeout = android::base::GetIntProperty("ril.dumpstate.timeout", 0);
1812 if (rilDumpstateTimeout > 0) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001813 // su does not exist on user builds, so try running without it.
1814 // This way any implementations of vril-dump that do not require
1815 // root can run on user builds.
1816 CommandOptions::CommandOptionsBuilder options =
Felipe Leme96c2bbb2016-09-26 09:21:21 -07001817 CommandOptions::WithTimeout(rilDumpstateTimeout);
Felipe Lemef0292972016-11-22 13:57:05 -08001818 if (!PropertiesHelper::IsUserBuild()) {
Felipe Leme30dbfa12016-09-02 12:43:26 -07001819 options.AsRoot();
Colin Crossf45fa6b2012-03-26 12:38:26 -07001820 }
Felipe Lemeb0f669d2016-09-26 18:26:11 -07001821 RunCommand("DUMP VENDOR RIL LOGS", {"vril-dump"}, options.Build());
Colin Crossf45fa6b2012-03-26 12:38:26 -07001822 }
1823
Felipe Lemed8b94e52016-12-08 10:21:44 -08001824 printf("========================================================\n");
1825 printf("== Android Framework Services\n");
1826 printf("========================================================\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07001827
Nandana Dutt5c390032019-03-12 10:52:56 +00001828 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(RunDumpsysNormal);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001829
Jack He91ff2fe2021-02-18 18:23:43 -08001830 /* Dump Bluetooth HCI logs after getting bluetooth_manager dumpsys */
1831 ds.AddDir("/data/misc/bluetooth/logs", true);
1832
Rhed Jaoe017f982020-07-21 17:58:41 +08001833 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001834 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_checkins));
Rhed Jaoe017f982020-07-21 17:58:41 +08001835 } else {
1836 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_CHECKINS_TASK, DumpCheckins);
1837 }
Dianne Hackborn02bea972013-06-26 18:59:09 -07001838
Rhed Jaoc5f7ec32020-12-22 22:11:08 +08001839 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK(DumpAppInfos);
Colin Crossf45fa6b2012-03-26 12:38:26 -07001840
Adrian Roos8b397ab2017-04-04 16:35:44 -07001841 printf("========================================================\n");
1842 printf("== Dropbox crashes\n");
1843 printf("========================================================\n");
1844
1845 RunDumpsys("DROPBOX SYSTEM SERVER CRASHES", {"dropbox", "-p", "system_server_crash"});
1846 RunDumpsys("DROPBOX SYSTEM APP CRASHES", {"dropbox", "-p", "system_app_crash"});
1847
Felipe Lemed8b94e52016-12-08 10:21:44 -08001848 printf("========================================================\n");
1849 printf("== Final progress (pid %d): %d/%d (estimated %d)\n", ds.pid_, ds.progress_->Get(),
1850 ds.progress_->GetMax(), ds.progress_->GetInitialMax());
1851 printf("========================================================\n");
1852 printf("== dumpstate: done (id %d)\n", ds.id_);
1853 printf("========================================================\n");
Bookatz38472142018-09-28 10:20:24 -07001854
1855 printf("========================================================\n");
1856 printf("== Obtaining statsd metadata\n");
1857 printf("========================================================\n");
1858 // This differs from the usual dumpsys stats, which is the stats report data.
1859 RunDumpsys("STATSDSTATS", {"stats", "--metadata"});
Mike Ma5c267872019-08-21 11:31:34 -07001860
Kiyoung Kimc2d22ac2020-02-04 19:43:36 +09001861 // Add linker configuration directory
1862 ds.AddDir(LINKERCONFIG_DIR, true);
1863
Li Li830179f2022-01-04 12:53:29 -08001864 /* Dump frozen cgroupfs */
1865 dump_frozen_cgroupfs();
Li Li2eedd412021-06-30 15:11:53 -07001866
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001867 if (ds.dump_pool_) {
Aaron Huang24d215d2022-04-27 18:51:16 +08001868 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_netstats_report));
1869 } else {
1870 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_NETSTATS_PROTO_TASK,
1871 DumpNetstatsProto);
1872 }
1873
1874 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08001875 WAIT_TASK_WITH_CONSENT_CHECK(std::move(dump_incident_report));
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08001876 } else {
1877 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_INCIDENT_REPORT_TASK,
1878 DumpIncidentReport);
1879 }
Mike Ma5c267872019-08-21 11:31:34 -07001880
Kean Mariotti306633e2022-09-05 16:30:47 +00001881 MaybeAddUiTracesToZip();
1882
Nandana Dutt5c390032019-03-12 10:52:56 +00001883 return Dumpstate::RunStatus::OK;
Colin Crossf45fa6b2012-03-26 12:38:26 -07001884}
1885
Nandana Dutt5c390032019-03-12 10:52:56 +00001886/*
1887 * Dumps state for the default case; drops root after it's no longer necessary.
1888 *
1889 * Returns RunStatus::OK if everything went fine.
1890 * Returns RunStatus::ERROR if there was an error.
1891 * Returns RunStatus::USER_DENIED_CONSENT if user explicitly denied consent to sharing the bugreport
1892 * with the caller.
1893 */
Jichao Lie89d9c12019-11-21 19:02:51 -08001894Dumpstate::RunStatus Dumpstate::DumpstateDefaultAfterCritical() {
Nandana Duttdb379fa2019-10-09 16:54:41 +01001895 // Capture first logcat early on; useful to take a snapshot before dumpstate logs take over the
1896 // buffer.
1897 DoLogcat();
1898 // Capture timestamp after first logcat to use in next logcat
1899 time_t logcat_ts = time(nullptr);
1900
Nandana Dutt4be45d12018-09-26 15:04:23 +01001901 /* collect stack traces from Dalvik and native processes (needs root) */
Chris Morinbc223142022-02-04 14:17:11 -08001902 std::future<std::string> dump_traces;
Rhed Jao5377d792020-07-16 17:37:39 +08001903 if (dump_pool_) {
1904 RETURN_IF_USER_DENIED_CONSENT();
1905 // One thread is enough since we only need to enqueue DumpTraces here.
1906 dump_pool_->start(/* thread_counts = */1);
1907
1908 // DumpTraces takes long time, post it to the another thread in the
1909 // pool, if pool is available
Chris Morinbc223142022-02-04 14:17:11 -08001910 dump_traces = dump_pool_->enqueueTask(
1911 DUMP_TRACES_TASK, &Dumpstate::DumpTraces, &ds, &dump_traces_path);
Rhed Jao5377d792020-07-16 17:37:39 +08001912 } else {
1913 RUN_SLOW_FUNCTION_WITH_CONSENT_CHECK_AND_LOG(DUMP_TRACES_TASK, ds.DumpTraces,
1914 &dump_traces_path);
1915 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001916
1917 /* Run some operations that require root. */
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001918 if (!PropertiesHelper::IsDryRun()) {
Chris Morinc2cba7a2022-02-01 17:06:50 -08001919 ds.tombstone_data_ = GetDumpFds(TOMBSTONE_DIR, TOMBSTONE_FILE_PREFIX);
1920 ds.anr_data_ = GetDumpFds(ANR_DIR, ANR_FILE_PREFIX);
Andy Hungd62f7e62024-01-11 15:47:52 -08001921 ds.anr_trace_data_ = GetDumpFds(ANR_DIR, ANR_TRACE_FILE_PREFIX);
Woody Lin20767a92022-11-29 15:50:24 +08001922 ds.shutdown_checkpoints_ = GetDumpFds(
1923 SHUTDOWN_CHECKPOINTS_DIR, SHUTDOWN_CHECKPOINTS_FILE_PREFIX);
Gavin Corkeryf18d1832021-08-25 17:23:40 +01001924 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001925
1926 ds.AddDir(RECOVERY_DIR, true);
1927 ds.AddDir(RECOVERY_DATA_DIR, true);
1928 ds.AddDir(UPDATE_ENGINE_LOG_DIR, true);
Kelvin Zhang6eaa0f92022-09-12 09:29:19 -07001929 ds.AddDir(UPDATE_ENGINE_PREF_DIR, true);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001930 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1931 if (!PropertiesHelper::IsUserBuild()) {
1932 ds.AddDir(PROFILE_DATA_DIR_CUR, true);
1933 ds.AddDir(PROFILE_DATA_DIR_REF, true);
Calin Juravlef84d3692020-04-28 15:31:12 -07001934 ds.AddZipEntry(ZIP_ROOT_DIR + PACKAGE_DEX_USE_LIST, PACKAGE_DEX_USE_LIST);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001935 }
Jerry Changa1df8a92020-01-02 16:03:39 +08001936 ds.AddDir(PREREBOOT_DATA_DIR, false);
Nandana Dutt4be45d12018-09-26 15:04:23 +01001937 add_mountinfo();
Peter Collingbourne78aa2942023-02-15 14:50:31 -08001938 for (const char* path : {"/proc/cpuinfo", "/proc/meminfo"}) {
1939 ds.AddZipEntry(ZIP_ROOT_DIR + path, path);
1940 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001941 DumpIpTablesAsRoot();
David Andersond9ba4752018-12-11 18:26:59 -08001942 DumpDynamicPartitionInfo();
Yifan Hong3945e1b2019-10-29 12:59:23 -07001943 ds.AddDir(OTA_METADATA_DIR, true);
Jeff Sharkey9df29d52023-02-06 14:26:30 -07001944 if (!PropertiesHelper::IsUserBuild()) {
1945 // Include dropbox entry files inside ZIP, but exclude
1946 // noisy WTF and StrictMode entries
1947 dump_files("", DROPBOX_DIR, skip_wtf_strictmode, _add_file_from_fd);
1948 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001949
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001950 // Capture any IPSec policies in play. No keys are exposed here.
Nandana Dutt4be45d12018-09-26 15:04:23 +01001951 RunCommand("IP XFRM POLICY", {"ip", "xfrm", "policy"}, CommandOptions::WithTimeout(10).Build());
1952
Benedict Wong8f9d8a42019-01-03 16:19:38 -08001953 // Dump IPsec stats. No keys are exposed here.
1954 DumpFile("XFRM STATS", XFRM_STAT_PROC_FILE);
1955
Nandana Dutt4be45d12018-09-26 15:04:23 +01001956 // Run ss as root so we can see socket marks.
1957 RunCommand("DETAILED SOCKET STATE", {"ss", "-eionptu"}, CommandOptions::WithTimeout(10).Build());
1958
1959 // Run iotop as root to show top 100 IO threads
1960 RunCommand("IOTOP", {"iotop", "-n", "1", "-m", "100"});
1961
Erick Reyese68df822019-02-11 14:46:36 -08001962 // Gather shared memory buffer info if the product implements it
Hridya Valsaraju1da80c52021-01-09 22:10:11 -08001963 RunCommand("Dmabuf dump", {"dmabuf_dump"});
1964 RunCommand("Dmabuf per-buffer/per-exporter/per-device stats", {"dmabuf_dump", "-b"});
Erick Reyese68df822019-02-11 14:46:36 -08001965
Minchan Kim22c6a1e2019-09-30 15:58:10 -07001966 DumpFile("PSI cpu", "/proc/pressure/cpu");
1967 DumpFile("PSI memory", "/proc/pressure/memory");
1968 DumpFile("PSI io", "/proc/pressure/io");
1969
Steven Moreland9379c462023-12-21 02:04:27 +00001970 ds.AddZipEntry(ZIP_ROOT_DIR + KERNEL_CONFIG, KERNEL_CONFIG);
1971
MÃ¥rten Kongstad60195a72022-09-20 14:14:20 +02001972 RunCommand("SDK EXTENSIONS", {SDK_EXT_INFO, "--dump"},
1973 CommandOptions::WithTimeout(10).Always().DropRoot().Build());
1974
Rhed Jao5377d792020-07-16 17:37:39 +08001975 if (dump_pool_) {
1976 RETURN_IF_USER_DENIED_CONSENT();
Chris Morinbc223142022-02-04 14:17:11 -08001977 WaitForTask(std::move(dump_traces));
Rhed Jao5377d792020-07-16 17:37:39 +08001978
Chris Morinbc223142022-02-04 14:17:11 -08001979 // Current running thread in the pool is the root user also. Delete
1980 // the pool and make a new one later to ensure none of threads in the pool are root.
1981 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao5377d792020-07-16 17:37:39 +08001982 }
Nandana Dutt4be45d12018-09-26 15:04:23 +01001983 if (!DropRootUser()) {
Nandana Dutt5c390032019-03-12 10:52:56 +00001984 return Dumpstate::RunStatus::ERROR;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001985 }
1986
Nandana Dutt5c390032019-03-12 10:52:56 +00001987 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttdb379fa2019-10-09 16:54:41 +01001988 Dumpstate::RunStatus status = dumpstate();
1989 // Capture logcat since the last time we did it.
1990 DoSystemLogcat(logcat_ts);
1991 return status;
Nandana Dutt4be45d12018-09-26 15:04:23 +01001992}
1993
Rhed Jaob5685b32020-08-14 17:19:17 +08001994// Common states for telephony and wifi which are needed to be collected before
1995// dumpstate drop the root user.
1996static void DumpstateRadioAsRoot() {
1997 DumpIpTablesAsRoot();
1998 ds.AddDir(LOGPERSIST_DATA_DIR, false);
1999}
2000
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002001// This method collects common dumpsys for telephony and wifi. Typically, wifi
2002// reports are fine to include all information, but telephony reports on user
2003// builds need to strip some content (see DumpstateTelephonyOnly).
2004static void DumpstateRadioCommon(bool include_sensitive_info = true) {
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002005 // We need to be picky about some stuff for telephony reports on user builds.
2006 if (!include_sensitive_info) {
2007 // Only dump the radio log buffer (other buffers and dumps contain too much unrelated info).
2008 DoRadioLogcat();
2009 } else {
Rhed Jaob5685b32020-08-14 17:19:17 +08002010 // DumpHals takes long time, post it to the another thread in the pool,
2011 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002012 std::future<std::string> dump_hals;
Rhed Jaob5685b32020-08-14 17:19:17 +08002013 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002014 dump_hals = ds.dump_pool_->enqueueTaskWithFd(DUMP_HALS_TASK, &DumpHals, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002015 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002016 // Contains various system properties and process startup info.
2017 do_dmesg();
2018 // Logs other than the radio buffer may contain package/component names and potential PII.
2019 DoLogcat();
2020 // Too broad for connectivity problems.
2021 DoKmsg();
Rhed Jaob5685b32020-08-14 17:19:17 +08002022 // DumpHals contains unrelated hardware info (camera, NFC, biometrics, ...).
2023 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002024 WaitForTask(std::move(dump_hals));
Rhed Jaob5685b32020-08-14 17:19:17 +08002025 } else {
2026 RUN_SLOW_FUNCTION_AND_LOG(DUMP_HALS_TASK, DumpHals);
2027 }
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002028 }
2029
Jayachandran Ca94c7172017-06-10 15:08:12 -07002030 DumpPacketStats();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002031 DumpIpAddrAndRules();
2032 dump_route_tables();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002033 RunDumpsys("NETWORK DIAGNOSTICS", {"connectivity", "--diag"},
2034 CommandOptions::WithTimeout(10).Build());
mukesh agrawal253dad42018-01-23 21:59:59 -08002035}
2036
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002037// We use "telephony" here for legacy reasons, though this now really means "connectivity" (cellular
2038// + wifi + networking). This method collects dumpsys for connectivity debugging only. General rules
2039// for what can be included on user builds: all reported information MUST directly relate to
2040// connectivity debugging or customer support and MUST NOT contain unrelated personally identifiable
2041// information. This information MUST NOT identify user-installed packages (UIDs are OK, package
2042// names are not), and MUST NOT contain logs of user application traffic.
2043// TODO(b/148168577) rename this and other related fields/methods to "connectivity" instead.
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002044static void DumpstateTelephonyOnly(const std::string& calling_package) {
mukesh agrawal253dad42018-01-23 21:59:59 -08002045 DurationReporter duration_reporter("DUMPSTATE");
Jichao Lie89d9c12019-11-21 19:02:51 -08002046
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002047 const CommandOptions DUMPSYS_COMPONENTS_OPTIONS = CommandOptions::WithTimeout(60).Build();
mukesh agrawal253dad42018-01-23 21:59:59 -08002048
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002049 const bool include_sensitive_info = !PropertiesHelper::IsUserBuild();
Jayachandran Ca94c7172017-06-10 15:08:12 -07002050
Rhed Jaob5685b32020-08-14 17:19:17 +08002051 DumpstateRadioAsRoot();
2052 if (!DropRootUser()) {
2053 return;
2054 }
2055
2056 // Starts thread pool after the root user is dropped, and two additional threads
2057 // are created for DumpHals in the DumpstateRadioCommon and DumpstateBoard.
Chris Morinbc223142022-02-04 14:17:11 -08002058 std::future<std::string> dump_board;
Rhed Jaob5685b32020-08-14 17:19:17 +08002059 if (ds.dump_pool_) {
2060 ds.dump_pool_->start(/*thread_counts =*/2);
2061
2062 // DumpstateBoard takes long time, post it to the another thread in the pool,
2063 // if pool is available.
Chris Morinbc223142022-02-04 14:17:11 -08002064 dump_board = ds.dump_pool_->enqueueTaskWithFd(
2065 DUMP_BOARD_TASK, &Dumpstate::DumpstateBoard, &ds, _1);
Rhed Jaob5685b32020-08-14 17:19:17 +08002066 }
2067
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002068 DumpstateRadioCommon(include_sensitive_info);
2069
2070 if (include_sensitive_info) {
2071 // Contains too much unrelated PII, and given the unstructured nature of sysprops, we can't
2072 // really cherrypick all of the connectivity-related ones. Apps generally have no business
2073 // reading these anyway, and there should be APIs to supply the info in a more app-friendly
2074 // way.
2075 RunCommand("SYSTEM PROPERTIES", {"getprop"});
2076 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002077
2078 printf("========================================================\n");
2079 printf("== Android Framework Services\n");
2080 printf("========================================================\n");
2081
Vishnu Nair652cc802017-11-30 15:18:30 -08002082 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2083 SEC_TO_MSEC(10));
Hunter Knepshield31cbae12021-05-11 16:23:24 -07002084 RunDumpsys("DUMPSYS", {"vcn_management"}, CommandOptions::WithTimeout(90).Build(),
2085 SEC_TO_MSEC(10));
Hunter Knepshield0cc6c212020-01-07 16:57:10 -08002086 if (include_sensitive_info) {
2087 // Carrier apps' services will be dumped below in dumpsys activity service all-non-platform.
2088 RunDumpsys("DUMPSYS", {"carrier_config"}, CommandOptions::WithTimeout(90).Build(),
2089 SEC_TO_MSEC(10));
2090 } else {
2091 // If the caller is a carrier app and has a carrier service, dump it here since we aren't
2092 // running dumpsys activity service all-non-platform below. Due to the increased output, we
2093 // give a higher timeout as well.
2094 RunDumpsys("DUMPSYS", {"carrier_config", "--requesting-package", calling_package},
2095 CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(30));
2096 }
2097 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002098 RunDumpsys("DUMPSYS", {"netpolicy"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2099 RunDumpsys("DUMPSYS", {"network_management"}, CommandOptions::WithTimeout(90).Build(),
Sooraj Sasindrane8d98912018-04-20 11:31:55 -07002100 SEC_TO_MSEC(10));
Hunter Knepshield0fe51b12020-03-05 16:58:20 -08002101 RunDumpsys("DUMPSYS", {"telephony.registry"}, CommandOptions::WithTimeout(90).Build(),
2102 SEC_TO_MSEC(10));
Jack Yu773cc032023-03-16 22:43:39 -07002103 RunDumpsys("DUMPSYS", {"isub"}, CommandOptions::WithTimeout(90).Build(),
2104 SEC_TO_MSEC(10));
Grant Menke56698972023-02-24 13:11:07 -08002105 RunDumpsys("DUMPSYS", {"telecom"}, CommandOptions::WithTimeout(90).Build(),
2106 SEC_TO_MSEC(10));
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002107 if (include_sensitive_info) {
2108 // Contains raw IP addresses, omit from reports on user builds.
2109 RunDumpsys("DUMPSYS", {"netd"}, CommandOptions::WithTimeout(90).Build(), SEC_TO_MSEC(10));
2110 // Contains raw destination IP/MAC addresses, omit from reports on user builds.
2111 RunDumpsys("DUMPSYS", {"connmetrics"}, CommandOptions::WithTimeout(90).Build(),
2112 SEC_TO_MSEC(10));
2113 // Contains package/component names, omit from reports on user builds.
2114 RunDumpsys("BATTERYSTATS", {"batterystats"}, CommandOptions::WithTimeout(90).Build(),
2115 SEC_TO_MSEC(10));
2116 // Contains package names, but should be relatively simple to remove them (also contains
2117 // UIDs already), omit from reports on user builds.
2118 RunDumpsys("BATTERYSTATS", {"deviceidle"}, CommandOptions::WithTimeout(90).Build(),
2119 SEC_TO_MSEC(10));
2120 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002121
2122 printf("========================================================\n");
2123 printf("== Running Application Services\n");
2124 printf("========================================================\n");
2125
2126 RunDumpsys("TELEPHONY SERVICES", {"activity", "service", "TelephonyDebugService"});
2127
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002128 if (include_sensitive_info) {
2129 printf("========================================================\n");
2130 printf("== Running Application Services (non-platform)\n");
2131 printf("========================================================\n");
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002132
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002133 // Contains package/component names and potential PII, omit from reports on user builds.
2134 // To get dumps of the active CarrierService(s) on user builds, we supply an argument to the
2135 // carrier_config dumpsys instead.
2136 RunDumpsys("APP SERVICES NON-PLATFORM", {"activity", "service", "all-non-platform"},
2137 DUMPSYS_COMPONENTS_OPTIONS);
Sooraj Sasindrana0829e72018-05-19 15:52:17 -07002138
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002139 printf("========================================================\n");
2140 printf("== Checkins\n");
2141 printf("========================================================\n");
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002142
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002143 // Contains package/component names, omit from reports on user builds.
2144 RunDumpsys("CHECKIN BATTERYSTATS", {"batterystats", "-c"});
2145 }
Kelly Rossmoyer769babb2018-08-21 18:06:38 -07002146
2147 printf("========================================================\n");
Jayachandran Ca94c7172017-06-10 15:08:12 -07002148 printf("== dumpstate: done (id %d)\n", ds.id_);
2149 printf("========================================================\n");
Rhed Jaob5685b32020-08-14 17:19:17 +08002150
2151 if (ds.dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08002152 WaitForTask(std::move(dump_board));
Rhed Jaob5685b32020-08-14 17:19:17 +08002153 } else {
2154 RUN_SLOW_FUNCTION_AND_LOG(DUMP_BOARD_TASK, ds.DumpstateBoard);
2155 }
Jayachandran Ca94c7172017-06-10 15:08:12 -07002156}
2157
mukesh agrawal253dad42018-01-23 21:59:59 -08002158// This method collects dumpsys for wifi debugging only
2159static void DumpstateWifiOnly() {
2160 DurationReporter duration_reporter("DUMPSTATE");
2161
Rhed Jaob5685b32020-08-14 17:19:17 +08002162 DumpstateRadioAsRoot();
2163 if (!DropRootUser()) {
2164 return;
2165 }
2166
2167 // Starts thread pool after the root user is dropped. Only one additional
2168 // thread is needed for DumpHals in the DumpstateRadioCommon.
2169 if (ds.dump_pool_) {
2170 ds.dump_pool_->start(/*thread_counts =*/1);
2171 }
2172
mukesh agrawal253dad42018-01-23 21:59:59 -08002173 DumpstateRadioCommon();
2174
2175 printf("========================================================\n");
2176 printf("== Android Framework Services\n");
2177 printf("========================================================\n");
2178
2179 RunDumpsys("DUMPSYS", {"connectivity"}, CommandOptions::WithTimeout(90).Build(),
2180 SEC_TO_MSEC(10));
2181 RunDumpsys("DUMPSYS", {"wifi"}, CommandOptions::WithTimeout(90).Build(),
2182 SEC_TO_MSEC(10));
2183
2184 printf("========================================================\n");
2185 printf("== dumpstate: done (id %d)\n", ds.id_);
2186 printf("========================================================\n");
2187}
2188
Elis Elliott8e401ad2023-08-08 11:18:59 +00002189// Collects a lightweight dumpstate to be used for debugging onboarding related flows.
2190static void DumpstateOnboardingOnly() {
2191 ds.AddDir(LOGPERSIST_DATA_DIR, false);
2192}
2193
Nandana Duttcf419a72019-03-14 10:40:17 +00002194Dumpstate::RunStatus Dumpstate::DumpTraces(const char** path) {
Gavin Corkery789d7a52021-02-24 23:52:35 +00002195 const std::string temp_file_pattern = ds.bugreport_internal_dir_ + "/dumptrace_XXXXXX";
Nandana Duttfaafd522019-03-11 09:23:09 +00002196 const size_t buf_size = temp_file_pattern.length() + 1;
2197 std::unique_ptr<char[]> file_name_buf(new char[buf_size]);
2198 memcpy(file_name_buf.get(), temp_file_pattern.c_str(), buf_size);
2199
2200 // Create a new, empty file to receive all trace dumps.
2201 //
2202 // TODO: This can be simplified once we remove support for the old style
2203 // dumps. We can have a file descriptor passed in to dump_traces instead
2204 // of creating a file, closing it and then reopening it again.
2205 android::base::unique_fd fd(mkostemp(file_name_buf.get(), O_APPEND | O_CLOEXEC));
2206 if (fd < 0) {
2207 MYLOGE("mkostemp on pattern %s: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002208 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002209 }
2210
2211 // Nobody should have access to this temporary file except dumpstate, but we
2212 // temporarily grant 'read' to 'others' here because this file is created
2213 // when tombstoned is still running as root, but dumped after dropping. This
2214 // can go away once support for old style dumping has.
2215 const int chmod_ret = fchmod(fd, 0666);
2216 if (chmod_ret < 0) {
2217 MYLOGE("fchmod on %s failed: %s\n", file_name_buf.get(), strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002218 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002219 }
2220
2221 std::unique_ptr<DIR, decltype(&closedir)> proc(opendir("/proc"), closedir);
2222 if (proc.get() == nullptr) {
2223 MYLOGE("opendir /proc failed: %s\n", strerror(errno));
Nandana Duttcf419a72019-03-14 10:40:17 +00002224 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002225 }
2226
2227 // Number of times process dumping has timed out. If we encounter too many
2228 // failures, we'll give up.
2229 int timeout_failures = 0;
2230 bool dalvik_found = false;
2231
Jayant Chowdharya0a8eb22022-05-20 03:30:09 +00002232 const std::set<int> hal_pids = get_interesting_pids();
Nandana Duttfaafd522019-03-11 09:23:09 +00002233
2234 struct dirent* d;
2235 while ((d = readdir(proc.get()))) {
Nandana Duttcf419a72019-03-14 10:40:17 +00002236 RETURN_IF_USER_DENIED_CONSENT();
Nandana Duttfaafd522019-03-11 09:23:09 +00002237 int pid = atoi(d->d_name);
2238 if (pid <= 0) {
2239 continue;
2240 }
2241
Kevin Jeond0f8a982023-04-07 14:27:11 -04002242 // Skip cached processes.
2243 if (IsCached(pid)) {
2244 // For consistency, the header and footer to this message match those
2245 // dumped by debuggerd in the success case.
2246 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2247 dprintf(fd, "Dump skipped for cached process.\n");
2248 dprintf(fd, "---- end %d ----", pid);
2249 continue;
2250 }
2251
Nandana Duttfaafd522019-03-11 09:23:09 +00002252 const std::string link_name = android::base::StringPrintf("/proc/%d/exe", pid);
2253 std::string exe;
2254 if (!android::base::Readlink(link_name, &exe)) {
2255 continue;
2256 }
2257
2258 bool is_java_process;
2259 if (exe == "/system/bin/app_process32" || exe == "/system/bin/app_process64") {
2260 // Don't bother dumping backtraces for the zygote.
2261 if (IsZygote(pid)) {
2262 continue;
2263 }
2264
2265 dalvik_found = true;
2266 is_java_process = true;
2267 } else if (should_dump_native_traces(exe.c_str()) || hal_pids.find(pid) != hal_pids.end()) {
2268 is_java_process = false;
2269 } else {
2270 // Probably a native process we don't care about, continue.
2271 continue;
2272 }
2273
2274 // If 3 backtrace dumps fail in a row, consider debuggerd dead.
2275 if (timeout_failures == 3) {
2276 dprintf(fd, "ERROR: Too many stack dump failures, exiting.\n");
2277 break;
2278 }
2279
2280 const uint64_t start = Nanotime();
2281 const int ret = dump_backtrace_to_file_timeout(
Kevin Jeonb8a39362023-04-04 15:00:34 -04002282 pid, is_java_process ? kDebuggerdJavaBacktrace : kDebuggerdNativeBacktrace, 3, fd);
Nandana Duttfaafd522019-03-11 09:23:09 +00002283
2284 if (ret == -1) {
2285 // For consistency, the header and footer to this message match those
2286 // dumped by debuggerd in the success case.
2287 dprintf(fd, "\n---- pid %d at [unknown] ----\n", pid);
2288 dprintf(fd, "Dump failed, likely due to a timeout.\n");
2289 dprintf(fd, "---- end %d ----", pid);
2290 timeout_failures++;
2291 continue;
2292 }
2293
2294 // We've successfully dumped stack traces, reset the failure count
2295 // and write a summary of the elapsed time to the file and continue with the
2296 // next process.
2297 timeout_failures = 0;
2298
2299 dprintf(fd, "[dump %s stack %d: %.3fs elapsed]\n", is_java_process ? "dalvik" : "native",
2300 pid, (float)(Nanotime() - start) / NANOS_PER_SEC);
2301 }
2302
2303 if (!dalvik_found) {
2304 MYLOGE("Warning: no Dalvik processes found to dump stacks\n");
2305 }
2306
Nandana Duttcf419a72019-03-14 10:40:17 +00002307 *path = file_name_buf.release();
2308 return RunStatus::OK;
Nandana Duttfaafd522019-03-11 09:23:09 +00002309}
2310
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002311static dumpstate_hal_hidl::DumpstateMode GetDumpstateHalModeHidl(
2312 const Dumpstate::BugreportMode bugreport_mode) {
2313 switch (bugreport_mode) {
2314 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2315 return dumpstate_hal_hidl::DumpstateMode::FULL;
2316 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2317 return dumpstate_hal_hidl::DumpstateMode::INTERACTIVE;
2318 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2319 return dumpstate_hal_hidl::DumpstateMode::REMOTE;
2320 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2321 return dumpstate_hal_hidl::DumpstateMode::WEAR;
2322 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2323 return dumpstate_hal_hidl::DumpstateMode::CONNECTIVITY;
2324 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2325 return dumpstate_hal_hidl::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002326 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002327 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2328 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2329 }
2330 return dumpstate_hal_hidl::DumpstateMode::DEFAULT;
2331}
2332
2333static dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode GetDumpstateHalModeAidl(
2334 const Dumpstate::BugreportMode bugreport_mode) {
2335 switch (bugreport_mode) {
2336 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2337 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::FULL;
2338 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2339 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::INTERACTIVE;
2340 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2341 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::REMOTE;
2342 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2343 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WEAR;
2344 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2345 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::CONNECTIVITY;
2346 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2347 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::WIFI;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002348 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002349 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2350 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2351 }
2352 return dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode::DEFAULT;
2353}
2354
2355static void DoDumpstateBoardHidl(
2356 const sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_1_0,
2357 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2358 const Dumpstate::BugreportMode bugreport_mode,
2359 const size_t timeout_sec) {
2360
2361 using ScopedNativeHandle =
2362 std::unique_ptr<native_handle_t, std::function<void(native_handle_t*)>>;
2363 ScopedNativeHandle handle(native_handle_create(static_cast<int>(dumpstate_fds.size()), 0),
2364 [](native_handle_t* handle) {
2365 // we don't close file handle's here
2366 // via native_handle_close(handle)
2367 // instead we let dumpstate_fds close the file handles when
2368 // dumpstate_fds gets destroyed
2369 native_handle_delete(handle);
2370 });
2371 if (handle == nullptr) {
2372 MYLOGE("Could not create native_handle for dumpstate HAL\n");
2373 return;
2374 }
2375
2376 for (size_t i = 0; i < dumpstate_fds.size(); i++) {
2377 handle.get()->data[i] = dumpstate_fds[i].get();
2378 }
2379
2380 // Prefer version 1.1 if available. New devices launching with R are no longer allowed to
2381 // implement just 1.0.
2382 const char* descriptor_to_kill;
2383 using DumpstateBoardTask = std::packaged_task<bool()>;
2384 DumpstateBoardTask dumpstate_board_task;
2385 sp<dumpstate_hal_hidl::IDumpstateDevice> dumpstate_hal(
2386 dumpstate_hal_hidl::IDumpstateDevice::castFrom(dumpstate_hal_1_0));
2387 if (dumpstate_hal != nullptr) {
2388 MYLOGI("Using IDumpstateDevice v1.1 HIDL HAL");
2389
2390 dumpstate_hal_hidl::DumpstateMode dumpstate_hal_mode =
2391 GetDumpstateHalModeHidl(bugreport_mode);
2392
2393 descriptor_to_kill = dumpstate_hal_hidl::IDumpstateDevice::descriptor;
2394 dumpstate_board_task =
2395 DumpstateBoardTask([timeout_sec, dumpstate_hal_mode, dumpstate_hal, &handle]() -> bool {
2396 ::android::hardware::Return<dumpstate_hal_hidl::DumpstateStatus> status =
2397 dumpstate_hal->dumpstateBoard_1_1(handle.get(), dumpstate_hal_mode,
2398 SEC_TO_MSEC(timeout_sec));
2399 if (!status.isOk()) {
2400 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2401 return false;
2402 } else if (status != dumpstate_hal_hidl::DumpstateStatus::OK) {
2403 MYLOGE("dumpstateBoard failed with DumpstateStatus::%s\n",
2404 dumpstate_hal_hidl::toString(status).c_str());
2405 return false;
2406 }
2407 return true;
2408 });
2409 } else {
2410 MYLOGI("Using IDumpstateDevice v1.0 HIDL HAL");
2411
2412 descriptor_to_kill = dumpstate_hal_hidl_1_0::IDumpstateDevice::descriptor;
2413 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal_1_0, &handle]() -> bool {
2414 ::android::hardware::Return<void> status =
2415 dumpstate_hal_1_0->dumpstateBoard(handle.get());
2416 if (!status.isOk()) {
2417 MYLOGE("dumpstateBoard failed: %s\n", status.description().c_str());
2418 return false;
2419 }
2420 return true;
2421 });
2422 }
2423 auto result = dumpstate_board_task.get_future();
2424 std::thread(std::move(dumpstate_board_task)).detach();
2425
2426 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2427 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2428 if (!android::base::SetProperty(
2429 "ctl.interface_restart",
2430 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2431 MYLOGE("Couldn't restart dumpstate HAL\n");
2432 }
2433 }
2434 // Wait some time for init to kill dumpstate vendor HAL
2435 constexpr size_t killing_timeout_sec = 10;
2436 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2437 MYLOGE(
2438 "killing dumpstateBoard timed out after %zus, continue and "
2439 "there might be racing in content\n",
2440 killing_timeout_sec);
2441 }
2442}
2443
2444static void DoDumpstateBoardAidl(
2445 const std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal,
2446 const std::vector<::ndk::ScopedFileDescriptor>& dumpstate_fds,
2447 const Dumpstate::BugreportMode bugreport_mode, const size_t timeout_sec) {
2448 MYLOGI("Using IDumpstateDevice AIDL HAL");
2449
2450 const char* descriptor_to_kill;
2451 using DumpstateBoardTask = std::packaged_task<bool()>;
2452 DumpstateBoardTask dumpstate_board_task;
2453 dumpstate_hal_aidl::IDumpstateDevice::DumpstateMode dumpstate_hal_mode =
2454 GetDumpstateHalModeAidl(bugreport_mode);
2455
2456 descriptor_to_kill = dumpstate_hal_aidl::IDumpstateDevice::descriptor;
2457 dumpstate_board_task = DumpstateBoardTask([dumpstate_hal, &dumpstate_fds, dumpstate_hal_mode,
2458 timeout_sec]() -> bool {
2459 auto status = dumpstate_hal->dumpstateBoard(dumpstate_fds, dumpstate_hal_mode, timeout_sec);
2460
2461 if (!status.isOk()) {
2462 MYLOGE("dumpstateBoard failed: %s\n", status.getDescription().c_str());
2463 return false;
2464 }
2465 return true;
2466 });
2467 auto result = dumpstate_board_task.get_future();
2468 std::thread(std::move(dumpstate_board_task)).detach();
2469
2470 if (result.wait_for(std::chrono::seconds(timeout_sec)) != std::future_status::ready) {
2471 MYLOGE("dumpstateBoard timed out after %zus, killing dumpstate HAL\n", timeout_sec);
2472 if (!android::base::SetProperty(
2473 "ctl.interface_restart",
2474 android::base::StringPrintf("%s/default", descriptor_to_kill))) {
2475 MYLOGE("Couldn't restart dumpstate HAL\n");
2476 }
2477 }
2478 // Wait some time for init to kill dumpstate vendor HAL
2479 constexpr size_t killing_timeout_sec = 10;
2480 if (result.wait_for(std::chrono::seconds(killing_timeout_sec)) != std::future_status::ready) {
2481 MYLOGE(
2482 "killing dumpstateBoard timed out after %zus, continue and "
2483 "there might be racing in content\n",
2484 killing_timeout_sec);
2485 }
2486}
2487
2488static std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> GetDumpstateBoardAidlService() {
2489 const std::string aidl_instance_name =
2490 std::string(dumpstate_hal_aidl::IDumpstateDevice::descriptor) + "/default";
2491
2492 if (!AServiceManager_isDeclared(aidl_instance_name.c_str())) {
2493 return nullptr;
2494 }
2495
2496 ndk::SpAIBinder dumpstateBinder(AServiceManager_waitForService(aidl_instance_name.c_str()));
2497
2498 return dumpstate_hal_aidl::IDumpstateDevice::fromBinder(dumpstateBinder);
2499}
2500
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002501void Dumpstate::DumpstateBoard(int out_fd) {
2502 dprintf(out_fd, "========================================================\n");
2503 dprintf(out_fd, "== Board\n");
2504 dprintf(out_fd, "========================================================\n");
Felipe Leme6f674ae2016-11-18 17:10:33 -08002505
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002506 /*
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002507 * mount debugfs for non-user builds with ro.product.debugfs_restrictions.enabled
Hridya Valsaraju51101602021-04-02 14:32:46 -07002508 * set to true and unmount it after invoking dumpstateBoard_* methods.
2509 * This is to enable debug builds to not have debugfs mounted during runtime.
2510 * It will also ensure that debugfs is only accessed by the dumpstate HAL.
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002511 */
Hridya Valsaraju51101602021-04-02 14:32:46 -07002512 auto mount_debugfs =
Hridya Valsarajud09460c2021-04-15 22:11:18 -07002513 android::base::GetBoolProperty("ro.product.debugfs_restrictions.enabled", false);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002514 if (mount_debugfs) {
2515 RunCommand("mount debugfs", {"mount", "-t", "debugfs", "debugfs", "/sys/kernel/debug"},
2516 AS_ROOT_20);
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002517 RunCommand("chmod debugfs", {"chmod", "0755", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002518 }
2519
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002520 std::vector<std::string> paths;
2521 std::vector<android::base::ScopeGuard<std::function<void()>>> remover;
Jie Song9fbfad02017-06-20 16:29:42 -07002522 for (int i = 0; i < NUM_OF_DUMPS; i++) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002523 paths.emplace_back(StringPrintf("%s/%s", ds.bugreport_internal_dir_.c_str(),
2524 kDumpstateBoardFiles[i].c_str()));
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002525 remover.emplace_back(android::base::make_scope_guard(
2526 std::bind([](std::string path) { android::os::UnlinkAndLogOnError(path); }, paths[i])));
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002527 }
Jie Song9fbfad02017-06-20 16:29:42 -07002528
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002529 // get dumpstate HAL AIDL implementation
2530 std::shared_ptr<dumpstate_hal_aidl::IDumpstateDevice> dumpstate_hal_handle_aidl(
2531 GetDumpstateBoardAidlService());
2532 if (dumpstate_hal_handle_aidl == nullptr) {
2533 MYLOGI("No IDumpstateDevice AIDL implementation\n");
2534 }
2535
2536 // get dumpstate HAL HIDL implementation, only if AIDL HAL implementation not found
2537 sp<dumpstate_hal_hidl_1_0::IDumpstateDevice> dumpstate_hal_handle_hidl_1_0 = nullptr;
2538 if (dumpstate_hal_handle_aidl == nullptr) {
2539 dumpstate_hal_handle_hidl_1_0 = dumpstate_hal_hidl_1_0::IDumpstateDevice::getService();
2540 if (dumpstate_hal_handle_hidl_1_0 == nullptr) {
2541 MYLOGI("No IDumpstateDevice HIDL implementation\n");
2542 }
2543 }
2544
2545 // if neither HIDL nor AIDL implementation found, then return
2546 if (dumpstate_hal_handle_hidl_1_0 == nullptr && dumpstate_hal_handle_aidl == nullptr) {
2547 MYLOGE("Could not find IDumpstateDevice implementation\n");
Wei Wang587eac92018-04-05 12:17:20 -07002548 return;
2549 }
2550
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002551 // this is used to hold the file descriptors and when this variable goes out of scope
2552 // the file descriptors are closed
2553 std::vector<::ndk::ScopedFileDescriptor> dumpstate_fds;
Wei Wang587eac92018-04-05 12:17:20 -07002554
Nandana Dutt5c390032019-03-12 10:52:56 +00002555 // TODO(128270426): Check for consent in between?
Wei Wang587eac92018-04-05 12:17:20 -07002556 for (size_t i = 0; i < paths.size(); i++) {
2557 MYLOGI("Calling IDumpstateDevice implementation using path %s\n", paths[i].c_str());
2558
2559 android::base::unique_fd fd(TEMP_FAILURE_RETRY(
2560 open(paths[i].c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
2561 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
2562 if (fd < 0) {
2563 MYLOGE("Could not open file %s: %s\n", paths[i].c_str(), strerror(errno));
2564 return;
2565 }
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002566
2567 dumpstate_fds.emplace_back(fd.release());
2568 // we call fd.release() here to make sure "fd" does not get closed
2569 // after "fd" goes out of scope after this block.
2570 // "fd" will be closed when "dumpstate_fds" goes out of scope
2571 // i.e. when we exit this function
Wei Wang587eac92018-04-05 12:17:20 -07002572 }
2573
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002574 // Given that bugreport is required to diagnose failures, it's better to set an arbitrary amount
2575 // of timeout for IDumpstateDevice than to block the rest of bugreport. In the timeout case, we
2576 // will kill the HAL and grab whatever it dumped in time.
Michael Eastwood8523ea02022-03-10 16:33:08 -08002577 constexpr size_t timeout_sec = 45;
Wei Wang587eac92018-04-05 12:17:20 -07002578
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002579 if (dumpstate_hal_handle_aidl != nullptr) {
2580 DoDumpstateBoardAidl(dumpstate_hal_handle_aidl, dumpstate_fds, options_->bugreport_mode,
2581 timeout_sec);
2582 } else if (dumpstate_hal_handle_hidl_1_0 != nullptr) {
2583 // run HIDL HAL only if AIDL HAL not found
2584 DoDumpstateBoardHidl(dumpstate_hal_handle_hidl_1_0, dumpstate_fds, options_->bugreport_mode,
2585 timeout_sec);
Wei Wang587eac92018-04-05 12:17:20 -07002586 }
2587
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002588 if (mount_debugfs) {
Hridya Valsaraju51101602021-04-02 14:32:46 -07002589 auto keep_debugfs_mounted =
2590 android::base::GetProperty("persist.dbg.keep_debugfs_mounted", "");
2591 if (keep_debugfs_mounted.empty())
2592 RunCommand("unmount debugfs", {"umount", "/sys/kernel/debug"}, AS_ROOT_20);
Hridya Valsaraju9376bfa2020-10-21 15:48:48 -07002593 }
2594
Wei Wang587eac92018-04-05 12:17:20 -07002595 auto file_sizes = std::make_unique<ssize_t[]>(paths.size());
2596 for (size_t i = 0; i < paths.size(); i++) {
2597 struct stat s;
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002598 if (fstat(dumpstate_fds[i].get(), &s) == -1) {
2599 MYLOGE("Failed to fstat %s: %s\n", kDumpstateBoardFiles[i].c_str(), strerror(errno));
Wei Wang587eac92018-04-05 12:17:20 -07002600 file_sizes[i] = -1;
2601 continue;
2602 }
2603 file_sizes[i] = s.st_size;
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002604 }
2605
2606 for (size_t i = 0; i < paths.size(); i++) {
2607 if (file_sizes[i] == -1) {
2608 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002609 }
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002610 if (file_sizes[i] == 0) {
Jie Song9fbfad02017-06-20 16:29:42 -07002611 MYLOGE("Ignoring empty %s\n", kDumpstateBoardFiles[i].c_str());
Luis Hector Chavez7aecd382018-03-19 11:16:59 -07002612 continue;
Jie Song9fbfad02017-06-20 16:29:42 -07002613 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002614 remover[i].Disable();
2615 EnqueueAddZipEntryAndCleanupIfNeeded(kDumpstateBoardFiles[i], paths[i]);
2616 dprintf(out_fd, "*** See %s entry ***\n", kDumpstateBoardFiles[i].c_str());
Jie Song9fbfad02017-06-20 16:29:42 -07002617 }
Felipe Leme6f674ae2016-11-18 17:10:33 -08002618}
2619
Nandana Dutt12ae14a2019-01-09 10:35:53 +00002620static void ShowUsage() {
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002621 fprintf(stderr,
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002622 "usage: dumpstate [-h] [-b soundfile] [-e soundfile] [-o directory] [-p] "
2623 "[-s] [-S] [-q] [-P] [-R] [-L] [-V version]\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002624 " -h: display this help message\n"
2625 " -b: play sound file instead of vibrate, at beginning of job\n"
2626 " -e: play sound file instead of vibrate, at end of job\n"
mhasank2d75c442020-06-11 15:05:25 -07002627 " -o: write to custom directory (only in limited mode)\n"
Abhijeet Kaurbb55a3b2019-06-13 18:07:25 +01002628 " -p: capture screenshot to filename.png\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002629 " -s: write zipped file to control socket (for init)\n"
2630 " -S: write file location to control socket (for init)\n"
Felipe Leme4a0db9f2016-09-28 09:35:01 -07002631 " -q: disable vibrate\n"
Abhijeet Kaure370d682019-10-01 16:49:30 +01002632 " -P: send broadcast when started and do progress updates\n"
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002633 " -R: take bugreport in remote mode (shouldn't be used with -P)\n"
Nandana Dutt235864b2019-01-22 12:10:16 +00002634 " -w: start binder service and make it wait for a call to startBugreport\n"
mhasankd451a472020-05-26 18:02:39 -07002635 " -L: output limited information that is safe for submission in feedback reports\n"
Felipe Lemed071c682016-10-20 16:48:00 -07002636 " -v: prints the dumpstate header and exit\n");
Colin Crossf45fa6b2012-03-26 12:38:26 -07002637}
2638
Wei Liuf87959e2016-08-26 14:51:42 -07002639static void register_sig_handler() {
Luis Hector Chavez558e1ef2018-03-22 15:39:17 -07002640 signal(SIGPIPE, SIG_IGN);
Wei Liuf87959e2016-08-26 14:51:42 -07002641}
2642
Felipe Leme1d486fe2016-10-14 18:06:47 -07002643bool Dumpstate::FinishZipFile() {
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08002644 // Runs all enqueued adding zip entry and cleanup tasks before finishing the zip file.
2645 if (zip_entry_tasks_) {
2646 zip_entry_tasks_->run(/* do_cancel = */false);
2647 }
2648
Felipe Leme9a523ae2016-10-20 15:10:33 -07002649 std::string entry_name = base_name_ + "-" + name_ + ".txt";
Felipe Leme1d486fe2016-10-14 18:06:47 -07002650 MYLOGD("Adding main entry (%s) from %s to .zip bugreport\n", entry_name.c_str(),
Felipe Leme9a523ae2016-10-20 15:10:33 -07002651 tmp_path_.c_str());
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002652 // Final timestamp
2653 char date[80];
2654 time_t the_real_now_please_stand_up = time(nullptr);
2655 strftime(date, sizeof(date), "%Y/%m/%d %H:%M:%S", localtime(&the_real_now_please_stand_up));
Felipe Leme7447d7c2016-11-03 18:12:22 -07002656 MYLOGD("dumpstate id %d finished around %s (%ld s)\n", ds.id_, date,
Felipe Lemebbaf3c12016-10-11 14:32:25 -07002657 the_real_now_please_stand_up - ds.now_);
Felipe Leme5b9d3bf2016-08-16 17:20:21 -07002658
Felipe Leme9a523ae2016-10-20 15:10:33 -07002659 if (!ds.AddZipEntry(entry_name, tmp_path_)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002660 MYLOGE("Failed to add text entry to .zip file\n");
Felipe Leme1e9edc62015-12-21 16:02:13 -08002661 return false;
2662 }
Felipe Leme1d486fe2016-10-14 18:06:47 -07002663 if (!AddTextZipEntry("main_entry.txt", entry_name)) {
Felipe Lemecbce55d2016-02-08 09:53:18 -08002664 MYLOGE("Failed to add main_entry.txt to .zip file\n");
Felipe Leme111b9d02016-02-03 09:28:24 -08002665 return false;
Felipe Leme809d74e2016-02-02 12:57:00 -08002666 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08002667
Felipe Leme0f3fb202016-06-10 17:10:53 -07002668 // Add log file (which contains stderr output) to zip...
2669 fprintf(stderr, "dumpstate_log.txt entry on zip file logged up to here\n");
Felipe Leme9a523ae2016-10-20 15:10:33 -07002670 if (!ds.AddZipEntry("dumpstate_log.txt", ds.log_path_.c_str())) {
Felipe Leme0f3fb202016-06-10 17:10:53 -07002671 MYLOGE("Failed to add dumpstate log to .zip file\n");
2672 return false;
2673 }
Nandana Dutt979388e2018-11-30 16:48:55 +00002674 // TODO: Should truncate the existing file.
2675 // ... and re-open it for further logging.
Nandana Dutta344cb62019-02-22 15:12:35 +00002676 if (!redirect_to_existing_file(stderr, const_cast<char*>(ds.log_path_.c_str()))) {
2677 return false;
2678 }
Felipe Leme0f3fb202016-06-10 17:10:53 -07002679 fprintf(stderr, "\n");
2680
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002681 int32_t err = zip_writer_->Finish();
Felipe Leme1d486fe2016-10-14 18:06:47 -07002682 if (err != 0) {
Felipe Lemec6bc8bc2016-10-27 15:58:27 -07002683 MYLOGE("zip_writer_->Finish(): %s\n", ZipWriter::ErrorCodeString(err));
Felipe Leme1e9edc62015-12-21 16:02:13 -08002684 return false;
2685 }
2686
Felipe Leme1d486fe2016-10-14 18:06:47 -07002687 // TODO: remove once FinishZipFile() is automatically handled by Dumpstate's destructor.
2688 ds.zip_file.reset(nullptr);
2689
Felipe Lemee9d2c542016-11-15 11:48:26 -08002690 MYLOGD("Removing temporary file %s\n", tmp_path_.c_str())
Nandana Dutt16d1aee2019-02-15 16:13:53 +00002691 android::os::UnlinkAndLogOnError(tmp_path_);
Felipe Lemec4eee562016-04-21 15:42:55 -07002692
Felipe Leme1e9edc62015-12-21 16:02:13 -08002693 return true;
2694}
Felipe Leme6e01fa62015-11-11 19:35:14 -08002695
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002696static void SendBroadcast(const std::string& action,
2697 const std::vector<std::string>& args,
2698 int32_t user_id) {
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002699 // clang-format off
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00002700 std::vector<std::string> am = {"/system/bin/cmd", "activity", "broadcast", "--user",
2701 std::to_string(user_id), "--receiver-foreground",
2702 "--receiver-include-background", "-a", action};
Felipe Lemea4ef1f02017-02-15 17:27:40 -08002703 // clang-format on
Felipe Leme8d2410e2017-02-08 09:46:08 -08002704
2705 am.insert(am.end(), args.begin(), args.end());
2706
Felipe Leme8d2410e2017-02-08 09:46:08 -08002707 RunCommand("", am,
2708 CommandOptions::WithTimeout(20)
2709 .Log("Sending broadcast: '%s'\n")
2710 .Always()
2711 .DropRoot()
2712 .RedirectStderr()
2713 .Build());
2714}
2715
Felipe Leme35b8cf12017-02-10 15:47:29 -08002716static void Vibrate(int duration_ms) {
2717 // clang-format off
Lais Andrade51156962021-02-22 19:21:35 +00002718 std::vector<std::string> args = {"cmd", "vibrator_manager", "synced", "-f", "-d", "dumpstate",
2719 "oneshot", std::to_string(duration_ms)};
2720 RunCommand("", args,
Felipe Leme35b8cf12017-02-10 15:47:29 -08002721 CommandOptions::WithTimeout(10)
2722 .Log("Vibrate: '%s'\n")
2723 .Always()
2724 .Build());
2725 // clang-format on
2726}
2727
Nandana Dutt979388e2018-11-30 16:48:55 +00002728static void MaybeResolveSymlink(std::string* path) {
2729 std::string resolved_path;
2730 if (android::base::Readlink(*path, &resolved_path)) {
2731 *path = resolved_path;
2732 }
2733}
2734
Nandana Dutt4be45d12018-09-26 15:04:23 +01002735/*
2736 * Prepares state like filename, screenshot path, etc in Dumpstate. Also initializes ZipWriter
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002737 * and adds the version file. Return false if zip_file could not be open to write.
Nandana Dutt4be45d12018-09-26 15:04:23 +01002738 */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002739static bool PrepareToWriteToFile() {
Nandana Dutt979388e2018-11-30 16:48:55 +00002740 MaybeResolveSymlink(&ds.bugreport_internal_dir_);
2741
Nandana Dutt4be45d12018-09-26 15:04:23 +01002742 std::string build_id = android::base::GetProperty("ro.build.id", "UNKNOWN_BUILD");
2743 std::string device_name = android::base::GetProperty("ro.product.name", "UNKNOWN_DEVICE");
Nandana Dutt9a76d202019-01-21 15:56:48 +00002744 ds.base_name_ = StringPrintf("bugreport-%s-%s", device_name.c_str(), build_id.c_str());
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002745 char date[80];
2746 strftime(date, sizeof(date), "%Y-%m-%d-%H-%M-%S", localtime(&ds.now_));
2747 ds.name_ = date;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002748
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002749 if (ds.options_->telephony_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002750 ds.base_name_ += "-telephony";
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002751 } else if (ds.options_->wifi_only) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002752 ds.base_name_ += "-wifi";
2753 }
2754
Paul Chang0d2aad72020-02-13 20:04:03 +08002755 if (ds.options_->do_screenshot) {
Nandana Dutt9d17b942020-03-26 10:02:59 +00002756 ds.screenshot_path_ = ds.GetPath(ds.CalledByApi() ? "-png.tmp" : ".png");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002757 }
2758 ds.tmp_path_ = ds.GetPath(".tmp");
2759 ds.log_path_ = ds.GetPath("-dumpstate_log-" + std::to_string(ds.pid_) + ".txt");
2760
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01002761 std::string destination = ds.CalledByApi()
Nandana Dutt54dbd672019-01-11 12:58:05 +00002762 ? StringPrintf("[fd:%d]", ds.options_->bugreport_fd.get())
Nandana Dutt9a76d202019-01-21 15:56:48 +00002763 : ds.bugreport_internal_dir_.c_str();
Nandana Dutt4be45d12018-09-26 15:04:23 +01002764 MYLOGD(
Nandana Dutt235c6672019-11-14 15:22:32 +00002765 "Bugreport dir: [%s] "
2766 "Base name: [%s] "
2767 "Suffix: [%s] "
2768 "Log path: [%s] "
2769 "Temporary path: [%s] "
2770 "Screenshot path: [%s]\n",
Nandana Dutt9a76d202019-01-21 15:56:48 +00002771 destination.c_str(), ds.base_name_.c_str(), ds.name_.c_str(), ds.log_path_.c_str(),
2772 ds.tmp_path_.c_str(), ds.screenshot_path_.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002773
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002774 ds.path_ = ds.GetPath(ds.CalledByApi() ? "-zip.tmp" : ".zip");
2775 MYLOGD("Creating initial .zip file (%s)\n", ds.path_.c_str());
2776 create_parent_dirs(ds.path_.c_str());
2777 ds.zip_file.reset(fopen(ds.path_.c_str(), "wb"));
2778 if (ds.zip_file == nullptr) {
2779 MYLOGE("fopen(%s, 'wb'): %s\n", ds.path_.c_str(), strerror(errno));
2780 return false;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002781 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002782 ds.zip_writer_.reset(new ZipWriter(ds.zip_file.get()));
2783 ds.AddTextZipEntry("version.txt", ds.version_);
2784 return true;
Nandana Dutt4be45d12018-09-26 15:04:23 +01002785}
2786
2787/*
Abhijeet Kaure370d682019-10-01 16:49:30 +01002788 * Finalizes writing to the file by zipping the tmp file to the final location,
Nandana Dutt4be45d12018-09-26 15:04:23 +01002789 * printing zipped file status, etc.
2790 */
2791static void FinalizeFile() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002792 bool do_text_file = !ds.FinishZipFile();
2793 if (do_text_file) {
2794 MYLOGE("Failed to finish zip file; sending text bugreport instead\n");
Nandana Dutt4be45d12018-09-26 15:04:23 +01002795 }
mhasank2d75c442020-06-11 15:05:25 -07002796
2797 std::string final_path = ds.path_;
2798 if (ds.options_->OutputToCustomFile()) {
mhasank3a4cfb42020-06-15 18:06:43 -07002799 final_path = ds.GetPath(ds.options_->out_dir, ".zip");
mhasank2d75c442020-06-11 15:05:25 -07002800 android::os::CopyFileToFile(ds.path_, final_path);
2801 }
2802
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002803 if (ds.options_->stream_to_socket) {
2804 android::os::CopyFileToFd(ds.path_, ds.control_socket_fd_);
2805 } else if (ds.options_->progress_updates_to_socket) {
Nandana Dutt4be45d12018-09-26 15:04:23 +01002806 if (do_text_file) {
2807 dprintf(ds.control_socket_fd_,
2808 "FAIL:could not create zip file, check %s "
2809 "for more details\n",
2810 ds.log_path_.c_str());
2811 } else {
mhasank2d75c442020-06-11 15:05:25 -07002812 dprintf(ds.control_socket_fd_, "OK:%s\n", final_path.c_str());
Nandana Dutt4be45d12018-09-26 15:04:23 +01002813 }
2814 }
2815}
2816
Nandana Dutt4be45d12018-09-26 15:04:23 +01002817
Nandana Dutt58d72e22018-11-16 10:30:48 +00002818static inline const char* ModeToString(Dumpstate::BugreportMode mode) {
2819 switch (mode) {
2820 case Dumpstate::BugreportMode::BUGREPORT_FULL:
2821 return "BUGREPORT_FULL";
2822 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
2823 return "BUGREPORT_INTERACTIVE";
2824 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
2825 return "BUGREPORT_REMOTE";
2826 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
2827 return "BUGREPORT_WEAR";
2828 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
2829 return "BUGREPORT_TELEPHONY";
2830 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
2831 return "BUGREPORT_WIFI";
Elis Elliott8e401ad2023-08-08 11:18:59 +00002832 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2833 return "BUGREPORT_ONBOARDING";
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002834 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2835 return "BUGREPORT_DEFAULT";
Nandana Dutt58d72e22018-11-16 10:30:48 +00002836 }
2837}
2838
Steven Leeb573eb82022-11-29 22:31:35 +08002839static bool IsConsentlessBugreportAllowed(const Dumpstate::DumpOptions& options) {
2840 // only BUGREPORT_TELEPHONY does not allow using consentless bugreport
2841 return !options.telephony_only;
2842}
2843
Paul Changf59c2b72020-03-10 02:08:55 +08002844static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options,
2845 bool is_screenshot_requested) {
Paul Chang0d2aad72020-02-13 20:04:03 +08002846 // Modify com.android.shell.BugreportProgressService#isDefaultScreenshotRequired as well for
2847 // default system screenshots.
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002848 options->bugreport_mode = mode;
2849 options->bugreport_mode_string = ModeToString(mode);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002850 switch (mode) {
2851 case Dumpstate::BugreportMode::BUGREPORT_FULL:
Paul Changf59c2b72020-03-10 02:08:55 +08002852 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002853 break;
2854 case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002855 // Currently, the dumpstate binder is only used by Shell to update progress.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002856 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002857 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002858 break;
2859 case Dumpstate::BugreportMode::BUGREPORT_REMOTE:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002860 options->do_vibrate = false;
2861 options->is_remote_mode = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002862 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002863 break;
2864 case Dumpstate::BugreportMode::BUGREPORT_WEAR:
Robert Ginda55ecebd2023-04-03 22:53:13 +00002865 options->do_vibrate = false;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002866 options->do_progress_updates = true;
Paul Changf59c2b72020-03-10 02:08:55 +08002867 options->do_screenshot = is_screenshot_requested;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002868 break;
Hunter Knepshield8540faf2020-02-04 19:47:20 -08002869 // TODO(b/148168577) rename TELEPHONY everywhere to CONNECTIVITY.
Nandana Dutt58d72e22018-11-16 10:30:48 +00002870 case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002871 options->telephony_only = true;
Hunter Knepshield820f9bc2020-02-05 20:10:53 -08002872 options->do_progress_updates = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002873 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002874 break;
2875 case Dumpstate::BugreportMode::BUGREPORT_WIFI:
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002876 options->wifi_only = true;
Paul Chang0d2aad72020-02-13 20:04:03 +08002877 options->do_screenshot = false;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002878 break;
Elis Elliott8e401ad2023-08-08 11:18:59 +00002879 case Dumpstate::BugreportMode::BUGREPORT_ONBOARDING:
2880 options->onboarding_only = true;
2881 options->do_screenshot = false;
2882 break;
Abhijeet Kaur904e0e02018-12-05 14:03:01 +00002883 case Dumpstate::BugreportMode::BUGREPORT_DEFAULT:
2884 break;
Nandana Dutt58d72e22018-11-16 10:30:48 +00002885 }
2886}
2887
Nandana Dutt58d72e22018-11-16 10:30:48 +00002888static void LogDumpOptions(const Dumpstate::DumpOptions& options) {
Nandana Dutt235c6672019-11-14 15:22:32 +00002889 MYLOGI(
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002890 "do_vibrate: %d stream_to_socket: %d progress_updates_to_socket: %d do_screenshot: %d "
Rhed Jao25f50e02020-08-20 00:10:32 +08002891 "is_remote_mode: %d show_header_only: %d telephony_only: %d "
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002892 "wifi_only: %d do_progress_updates: %d fd: %d bugreport_mode: %s "
mhasankd451a472020-05-26 18:02:39 -07002893 "limited_only: %d args: %s\n",
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002894 options.do_vibrate, options.stream_to_socket, options.progress_updates_to_socket,
Paul Chang0d2aad72020-02-13 20:04:03 +08002895 options.do_screenshot, options.is_remote_mode, options.show_header_only,
Rhed Jao25f50e02020-08-20 00:10:32 +08002896 options.telephony_only, options.wifi_only,
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00002897 options.do_progress_updates, options.bugreport_fd.get(),
2898 options.bugreport_mode_string.c_str(),
2899 options.limited_only, options.args.c_str());
Nandana Dutt58d72e22018-11-16 10:30:48 +00002900}
2901
Nandana Dutt54dbd672019-01-11 12:58:05 +00002902void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode,
Kean Mariotti306633e2022-09-05 16:30:47 +00002903 int bugreport_flags,
Nandana Dutt54dbd672019-01-11 12:58:05 +00002904 const android::base::unique_fd& bugreport_fd_in,
Paul Changf59c2b72020-03-10 02:08:55 +08002905 const android::base::unique_fd& screenshot_fd_in,
2906 bool is_screenshot_requested) {
Kean Mariotti306633e2022-09-05 16:30:47 +00002907 this->use_predumped_ui_data = bugreport_flags & BugreportFlag::BUGREPORT_USE_PREDUMPED_UI_DATA;
Gavin Corkerya44686c2022-11-23 18:16:51 +00002908 this->is_consent_deferred = bugreport_flags & BugreportFlag::BUGREPORT_FLAG_DEFER_CONSENT;
Nandana Dutt54dbd672019-01-11 12:58:05 +00002909 // Duplicate the fds because the passed in fds don't outlive the binder transaction.
Todd Frederick621533f2022-03-26 02:54:17 +00002910 bugreport_fd.reset(fcntl(bugreport_fd_in.get(), F_DUPFD_CLOEXEC, 0));
2911 screenshot_fd.reset(fcntl(screenshot_fd_in.get(), F_DUPFD_CLOEXEC, 0));
Nandana Dutt58d72e22018-11-16 10:30:48 +00002912
Paul Changf59c2b72020-03-10 02:08:55 +08002913 SetOptionsFromMode(bugreport_mode, this, is_screenshot_requested);
Nandana Dutt58d72e22018-11-16 10:30:48 +00002914}
2915
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002916Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {
2917 RunStatus status = RunStatus::OK;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002918 int c;
mhasankd451a472020-05-26 18:02:39 -07002919 while ((c = getopt(argc, argv, "dho:svqzpLPBRSV:w")) != -1) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002920 switch (c) {
2921 // clang-format off
mhasank3a4cfb42020-06-15 18:06:43 -07002922 case 'o': out_dir = optarg; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002923 case 's': stream_to_socket = true; break;
2924 case 'S': progress_updates_to_socket = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002925 case 'v': show_header_only = true; break;
2926 case 'q': do_vibrate = false; break;
Paul Chang0d2aad72020-02-13 20:04:03 +08002927 case 'p': do_screenshot = true; break;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002928 case 'P': do_progress_updates = true; break;
2929 case 'R': is_remote_mode = true; break;
mhasankd451a472020-05-26 18:02:39 -07002930 case 'L': limited_only = true; break;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002931 case 'V':
2932 case 'd':
2933 case 'z':
2934 // compatibility no-op
2935 break;
Nandana Dutt235864b2019-01-22 12:10:16 +00002936 case 'w':
2937 // This was already processed
2938 break;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002939 case 'h':
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002940 status = RunStatus::HELP;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002941 break;
2942 default:
2943 fprintf(stderr, "Invalid option: %c\n", c);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002944 status = RunStatus::INVALID_INPUT;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002945 break;
2946 // clang-format on
2947 }
2948 }
Felipe Leme8fecfdd2016-02-09 10:40:07 -08002949
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002950 for (int i = 0; i < argc; i++) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002951 args += argv[i];
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002952 if (i < argc - 1) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002953 args += " ";
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002954 }
2955 }
2956
2957 // Reset next index used by getopt so this can be called multiple times, for eg, in tests.
2958 optind = 1;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002959
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002960 return status;
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002961}
2962
Nandana Dutt5fb117b2018-09-27 09:23:36 +01002963bool Dumpstate::DumpOptions::ValidateOptions() const {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002964 if (bugreport_fd.get() != -1 && stream_to_socket) {
Nandana Dutt979388e2018-11-30 16:48:55 +00002965 return false;
2966 }
2967
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002968 if ((progress_updates_to_socket || do_progress_updates) && stream_to_socket) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002969 return false;
2970 }
2971
Dieter Hsu105ad0c2020-09-29 15:23:33 +08002972 if (is_remote_mode && (do_progress_updates || stream_to_socket)) {
Nandana Dutt3f8c7172018-09-25 12:01:54 +01002973 return false;
2974 }
2975 return true;
2976}
2977
Nandana Dutt197661d2018-11-16 16:40:21 +00002978void Dumpstate::SetOptions(std::unique_ptr<DumpOptions> options) {
2979 options_ = std::move(options);
2980}
2981
Abhijeet Kaura407fb82020-03-27 12:51:12 +00002982void Dumpstate::Initialize() {
2983 /* gets the sequential id */
2984 uint32_t last_id = android::base::GetIntProperty(PROPERTY_LAST_ID, 0);
2985 id_ = ++last_id;
2986 android::base::SetProperty(PROPERTY_LAST_ID, std::to_string(last_id));
2987}
2988
Nandana Duttd2f5f082019-01-18 17:13:52 +00002989Dumpstate::RunStatus Dumpstate::Run(int32_t calling_uid, const std::string& calling_package) {
2990 Dumpstate::RunStatus status = RunInternal(calling_uid, calling_package);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002991 HandleRunStatus(status);
2992 return status;
2993}
2994
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00002995Dumpstate::RunStatus Dumpstate::Retrieve(int32_t calling_uid, const std::string& calling_package,
2996 const bool keep_bugreport_on_retrieval) {
2997 Dumpstate::RunStatus status = RetrieveInternal(calling_uid, calling_package,
2998 keep_bugreport_on_retrieval);
Gavin Corkerya44686c2022-11-23 18:16:51 +00002999 HandleRunStatus(status);
3000 return status;
3001}
3002
3003Dumpstate::RunStatus Dumpstate::RetrieveInternal(int32_t calling_uid,
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003004 const std::string& calling_package,
3005 const bool keep_bugreport_on_retrieval) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003006 consent_callback_ = new ConsentCallback();
3007 const String16 incidentcompanion("incidentcompanion");
3008 sp<android::IBinder> ics(
3009 defaultServiceManager()->checkService(incidentcompanion));
3010 android::String16 package(calling_package.c_str());
3011 if (ics != nullptr) {
3012 MYLOGD("Checking user consent via incidentcompanion service\n");
3013 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
3014 calling_uid, package, String16(), String16(),
3015 0x1 /* FLAG_CONFIRMATION_DIALOG */, consent_callback_.get());
3016 } else {
3017 MYLOGD(
3018 "Unable to check user consent; incidentcompanion service unavailable\n");
3019 return RunStatus::USER_CONSENT_TIMED_OUT;
3020 }
3021 UserConsentResult consent_result = consent_callback_->getResult();
3022 int timeout_ms = 30 * 1000;
3023 while (consent_result == UserConsentResult::UNAVAILABLE &&
3024 consent_callback_->getElapsedTimeMs() < timeout_ms) {
3025 sleep(1);
3026 consent_result = consent_callback_->getResult();
3027 }
3028 if (consent_result == UserConsentResult::DENIED) {
3029 return RunStatus::USER_CONSENT_DENIED;
3030 }
3031 if (consent_result == UserConsentResult::UNAVAILABLE) {
3032 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3033 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3034 consent_callback_.get());
3035 return RunStatus::USER_CONSENT_TIMED_OUT;
3036 }
3037
3038 bool copy_succeeded =
3039 android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003040
3041 if (copy_succeeded && (!android::app::admin::flags::onboarding_bugreport_v2_enabled()
3042 || !keep_bugreport_on_retrieval)) {
3043 android::os::UnlinkAndLogOnError(path_);
Gavin Corkerya44686c2022-11-23 18:16:51 +00003044 }
Kholoud Mohamed7c3fb7c2023-10-18 12:56:22 +00003045
Gavin Corkerya44686c2022-11-23 18:16:51 +00003046 return copy_succeeded ? Dumpstate::RunStatus::OK
3047 : Dumpstate::RunStatus::ERROR;
3048}
3049
3050void Dumpstate::HandleRunStatus(Dumpstate::RunStatus status) {
3051 if (listener_ != nullptr) {
Nandana Duttbabf6c72019-01-15 14:11:12 +00003052 switch (status) {
3053 case Dumpstate::RunStatus::OK:
Gavin Corkerya44686c2022-11-23 18:16:51 +00003054 listener_->onFinished(path_.c_str());
Nandana Duttbabf6c72019-01-15 14:11:12 +00003055 break;
3056 case Dumpstate::RunStatus::HELP:
3057 break;
3058 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003059 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_INVALID_INPUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003060 break;
3061 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003062 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_RUNTIME_ERROR);
3063 break;
3064 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3065 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_DENIED_CONSENT);
3066 break;
3067 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
3068 listener_->onError(IDumpstateListener::BUGREPORT_ERROR_USER_CONSENT_TIMED_OUT);
Nandana Duttbabf6c72019-01-15 14:11:12 +00003069 break;
3070 }
3071 }
Nandana Duttbabf6c72019-01-15 14:11:12 +00003072}
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003073void Dumpstate::Cancel() {
3074 CleanupTmpFiles();
3075 android::os::UnlinkAndLogOnError(log_path_);
3076 for (int i = 0; i < NUM_OF_DUMPS; i++) {
3077 android::os::UnlinkAndLogOnError(ds.bugreport_internal_dir_ + "/" +
3078 kDumpstateBoardFiles[i]);
3079 }
3080 tombstone_data_.clear();
3081 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003082 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003083 shutdown_checkpoints_.clear();
Rhed Jao0daac912020-08-21 14:48:20 +08003084
3085 // Instead of shutdown the pool, we delete temporary files directly since
3086 // shutdown blocking the call.
3087 if (dump_pool_) {
3088 dump_pool_->deleteTempFiles();
3089 }
3090 if (zip_entry_tasks_) {
3091 zip_entry_tasks_->run(/*do_cancel =*/ true);
3092 }
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003093}
3094
Kean Mariotti306633e2022-09-05 16:30:47 +00003095void Dumpstate::PreDumpUiData() {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003096 auto snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Kean Mariotti306633e2022-09-05 16:30:47 +00003097 MaybeSnapshotUiTraces();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003098 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Kean Mariotti306633e2022-09-05 16:30:47 +00003099}
3100
Nandana Dutt979388e2018-11-30 16:48:55 +00003101/*
3102 * Dumps relevant information to a bugreport based on the given options.
3103 *
3104 * The bugreport can be dumped to a file or streamed to a socket.
3105 *
3106 * How dumping to file works:
3107 * stdout is redirected to a temporary file. This will later become the main bugreport entry.
3108 * stderr is redirected a log file.
3109 *
3110 * The temporary bugreport is then populated via printfs, dumping contents of files and
3111 * output of commands to stdout.
3112 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003113 * A bunch of other files and dumps are added to the zip archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003114 *
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003115 * The temporary bugreport file and the log file also get added to the archive.
Nandana Dutt979388e2018-11-30 16:48:55 +00003116 *
mhasank2d75c442020-06-11 15:05:25 -07003117 * Bugreports are first generated in a local directory and later copied to the caller's fd
3118 * or directory if supplied.
Nandana Dutt979388e2018-11-30 16:48:55 +00003119 */
Nandana Duttd2f5f082019-01-18 17:13:52 +00003120Dumpstate::RunStatus Dumpstate::RunInternal(int32_t calling_uid,
3121 const std::string& calling_package) {
Rhed Jao5377d792020-07-16 17:37:39 +08003122 DurationReporter duration_reporter("RUN INTERNAL", /* logcat_only = */true);
Nandana Dutt979388e2018-11-30 16:48:55 +00003123 LogDumpOptions(*options_);
Nandana Dutt197661d2018-11-16 16:40:21 +00003124 if (!options_->ValidateOptions()) {
Nandana Dutt58d72e22018-11-16 10:30:48 +00003125 MYLOGE("Invalid options specified\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003126 return RunStatus::INVALID_INPUT;
3127 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003128 /* set as high priority, and protect from OOM killer */
3129 setpriority(PRIO_PROCESS, 0, -20);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003130
Felipe Lemed071c682016-10-20 16:48:00 -07003131 FILE* oom_adj = fopen("/proc/self/oom_score_adj", "we");
Colin Crossf45fa6b2012-03-26 12:38:26 -07003132 if (oom_adj) {
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003133 fputs("-1000", oom_adj);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003134 fclose(oom_adj);
Wei Wang9c1f9bb2016-06-28 14:32:35 -07003135 } else {
3136 /* fallback to kernels <= 2.6.35 */
3137 oom_adj = fopen("/proc/self/oom_adj", "we");
3138 if (oom_adj) {
3139 fputs("-17", oom_adj);
3140 fclose(oom_adj);
3141 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003142 }
3143
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003144 if (version_ == VERSION_DEFAULT) {
3145 version_ = VERSION_CURRENT;
Michal Karpinski4db754f2015-12-11 18:04:32 +00003146 }
3147
Chris Morin5a50d482022-02-01 17:41:18 -08003148 if (version_ != VERSION_CURRENT) {
3149 MYLOGE("invalid version requested ('%s'); supported values are: ('%s', '%s')\n",
3150 version_.c_str(), VERSION_DEFAULT.c_str(), VERSION_CURRENT.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003151 return RunStatus::INVALID_INPUT;
Felipe Lemed071c682016-10-20 16:48:00 -07003152 }
3153
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003154 if (options_->show_header_only) {
3155 PrintHeader();
3156 return RunStatus::OK;
Felipe Lemed071c682016-10-20 16:48:00 -07003157 }
3158
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003159 MYLOGD("dumpstate calling_uid = %d ; calling package = %s \n",
3160 calling_uid, calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003161
Felipe Leme7447d7c2016-11-03 18:12:22 -07003162 // TODO: temporarily set progress until it's part of the Dumpstate constructor
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003163 std::string stats_path =
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003164 android::base::StringPrintf("%s/dumpstate-stats.txt", bugreport_internal_dir_.c_str());
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003165 progress_.reset(new Progress(stats_path));
Felipe Leme7447d7c2016-11-03 18:12:22 -07003166
Sahana Raof35ed432019-07-12 10:47:52 +01003167 if (acquire_wake_lock(PARTIAL_WAKE_LOCK, WAKE_LOCK_NAME) < 0) {
3168 MYLOGE("Failed to acquire wake lock: %s\n", strerror(errno));
3169 } else {
3170 // Wake lock will be released automatically on process death
3171 MYLOGD("Wake lock acquired.\n");
3172 }
3173
Felipe Leme6ae5c4f2017-01-10 14:13:22 -08003174 register_sig_handler();
Felipe Lemed071c682016-10-20 16:48:00 -07003175
Felipe Lemef0292972016-11-22 13:57:05 -08003176 if (PropertiesHelper::IsDryRun()) {
Felipe Lemed071c682016-10-20 16:48:00 -07003177 MYLOGI("Running on dry-run mode (to disable it, call 'setprop dumpstate.dry_run false')\n");
3178 }
3179
Kevin Jeonfa64e642023-07-27 11:36:41 -04003180 if (PropertiesHelper::IsStrictRun()) {
3181 MYLOGI(
3182 "Running on strict-run mode, which has shorter timeouts "
3183 "(to disable, call 'setprop dumpstate.strict_run false')\n");
3184 }
3185
Nandana Dutt235c6672019-11-14 15:22:32 +00003186 MYLOGI("dumpstate info: id=%d, args='%s', bugreport_mode= %s bugreport format version: %s\n",
Kedar Chitnis9fd8c052021-11-16 09:09:22 +00003187 id_, options_->args.c_str(), options_->bugreport_mode_string.c_str(), version_.c_str());
Felipe Leme809d74e2016-02-02 12:57:00 -08003188
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003189 do_early_screenshot_ = options_->do_progress_updates;
Felipe Lemee338bf62015-12-07 14:03:50 -08003190
Christopher Ferrised9354f2014-10-01 17:35:01 -07003191 // If we are going to use a socket, do it as early as possible
3192 // to avoid timeouts from bugreport.
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003193 if (options_->stream_to_socket || options_->progress_updates_to_socket) {
Felipe Leme2628e9e2016-04-12 16:36:51 -07003194 MYLOGD("Opening control socket\n");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003195 control_socket_fd_ = open_socket_fn_("dumpstate");
Nandana Dutta344cb62019-02-22 15:12:35 +00003196 if (control_socket_fd_ == -1) {
3197 return ERROR;
3198 }
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003199 if (options_->progress_updates_to_socket) {
3200 options_->do_progress_updates = 1;
3201 }
Felipe Leme2628e9e2016-04-12 16:36:51 -07003202 }
3203
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003204 if (!PrepareToWriteToFile()) {
3205 return ERROR;
3206 }
Felipe Leme1e9edc62015-12-21 16:02:13 -08003207
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003208 // Interactive, wear & telephony modes are default to true.
3209 // and may enable from cli option or when using control socket
3210 if (options_->do_progress_updates) {
3211 // clang-format off
3212 std::vector<std::string> am_args = {
3213 "--receiver-permission", "android.permission.DUMP",
3214 };
3215 // clang-format on
3216 // Send STARTED broadcast for apps that listen to bugreport generation events
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003217 SendBroadcast("com.android.internal.intent.action.BUGREPORT_STARTED",
3218 am_args, multiuser_get_user_id(calling_uid));
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003219 if (options_->progress_updates_to_socket) {
3220 dprintf(control_socket_fd_, "BEGIN:%s\n", path_.c_str());
Felipe Leme71bbfc52015-11-23 14:14:51 -08003221 }
3222 }
3223
Nick Kralevichf3599b32016-01-25 15:05:16 -08003224 /* read /proc/cmdline before dropping root */
3225 FILE *cmdline = fopen("/proc/cmdline", "re");
3226 if (cmdline) {
3227 fgets(cmdline_buf, sizeof(cmdline_buf), cmdline);
3228 fclose(cmdline);
3229 }
3230
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003231 if (options_->do_vibrate) {
Felipe Leme35b8cf12017-02-10 15:47:29 -08003232 Vibrate(150);
John Michelau1f794c42012-09-17 11:20:19 -05003233 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003234
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003235 if (zip_file != nullptr) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003236 if (chown(path_.c_str(), AID_SHELL, AID_SHELL)) {
3237 MYLOGE("Unable to change ownership of zip file %s: %s\n", path_.c_str(),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003238 strerror(errno));
Felipe Leme1e9edc62015-12-21 16:02:13 -08003239 }
3240 }
3241
Nandana Dutt3f8c7172018-09-25 12:01:54 +01003242 int dup_stdout_fd;
3243 int dup_stderr_fd;
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003244 // Redirect stderr to log_path_ for debugging.
3245 TEMP_FAILURE_RETRY(dup_stderr_fd = dup(fileno(stderr)));
3246 if (!redirect_to_file(stderr, const_cast<char*>(log_path_.c_str()))) {
3247 return ERROR;
3248 }
3249 if (chown(log_path_.c_str(), AID_SHELL, AID_SHELL)) {
3250 MYLOGE("Unable to change ownership of dumpstate log file %s: %s\n", log_path_.c_str(),
3251 strerror(errno));
3252 }
Nandana Dutt979388e2018-11-30 16:48:55 +00003253
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003254 // Redirect stdout to tmp_path_. This is the main bugreport entry and will be
3255 // moved into zip file later, if zipping.
3256 TEMP_FAILURE_RETRY(dup_stdout_fd = dup(fileno(stdout)));
3257 // TODO: why not write to a file instead of stdout to overcome this problem?
3258 /* TODO: rather than generating a text file now and zipping it later,
3259 it would be more efficient to redirect stdout to the zip entry
3260 directly, but the libziparchive doesn't support that option yet. */
3261 if (!redirect_to_file(stdout, const_cast<char*>(tmp_path_.c_str()))) {
3262 return ERROR;
3263 }
3264 if (chown(tmp_path_.c_str(), AID_SHELL, AID_SHELL)) {
3265 MYLOGE("Unable to change ownership of temporary bugreport file %s: %s\n",
3266 tmp_path_.c_str(), strerror(errno));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003267 }
Felipe Lemed8b94e52016-12-08 10:21:44 -08003268
3269 // Don't buffer stdout
3270 setvbuf(stdout, nullptr, _IONBF, 0);
3271
Rhed Jao5377d792020-07-16 17:37:39 +08003272 // Enable the parallel run if the client requests to output to a file.
3273 EnableParallelRunIfNeeded();
3274 // Using scope guard to make sure the dump pool can be shut down correctly.
3275 auto scope_guard_to_shutdown_pool = android::base::make_scope_guard([=]() {
3276 ShutdownDumpPool();
3277 });
3278
Felipe Leme608385d2016-02-01 10:35:38 -08003279 // NOTE: there should be no stdout output until now, otherwise it would break the header.
3280 // In particular, DurationReport objects should be created passing 'title, NULL', so their
Felipe Lemecbce55d2016-02-08 09:53:18 -08003281 // duration is logged into MYLOG instead.
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003282 PrintHeader();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003283
Kean Mariottic14cebc2024-03-04 10:55:28 +00003284 bool system_trace_exists = access(SYSTEM_TRACE_SNAPSHOT, F_OK) == 0;
3285 if (options_->use_predumped_ui_data && !system_trace_exists) {
3286 MYLOGW("Ignoring 'use predumped data' flag because no predumped data is available");
3287 options_->use_predumped_ui_data = false;
3288 }
3289
Kean Mariottica20f2d2023-12-15 09:34:25 +00003290 std::future<std::string> snapshot_system_trace;
3291
Kean Mariotti853b73a2023-07-27 12:40:30 +00003292 bool is_dumpstate_restricted =
3293 options_->telephony_only || options_->wifi_only || options_->limited_only;
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003294 if (!is_dumpstate_restricted) {
3295 // Snapshot the system trace now (if running) to avoid that dumpstate's
3296 // own activity pushes out interesting data from the trace ring buffer.
3297 // The trace file is added to the zip by MaybeAddSystemTraceToZip().
Kean Mariottica20f2d2023-12-15 09:34:25 +00003298 snapshot_system_trace = MaybeSnapshotSystemTraceAsync();
Yohei Yukawa95305b32021-03-09 07:54:27 -08003299
Kean Mariotti853b73a2023-07-27 12:40:30 +00003300 // Invoke critical dumpsys to preserve system state, before doing anything else.
3301 RunDumpsysCritical();
3302
Kean Mariotti306633e2022-09-05 16:30:47 +00003303 // Snapshot the UI traces now (if running).
3304 // The trace files will be added to bugreport later.
3305 MaybeSnapshotUiTraces();
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003306 }
Kean Mariotti853b73a2023-07-27 12:40:30 +00003307
3308 MaybeTakeEarlyScreenshot();
Kean Mariottica20f2d2023-12-15 09:34:25 +00003309 MaybeWaitForSnapshotSystemTrace(std::move(snapshot_system_trace));
Gavin Corkery6968f552020-11-22 18:09:05 +00003310 onUiIntensiveBugreportDumpsFinished(calling_uid);
3311 MaybeCheckUserConsent(calling_uid, calling_package);
3312 if (options_->telephony_only) {
3313 DumpstateTelephonyOnly(calling_package);
3314 } else if (options_->wifi_only) {
3315 DumpstateWifiOnly();
3316 } else if (options_->limited_only) {
3317 DumpstateLimitedOnly();
Elis Elliott8e401ad2023-08-08 11:18:59 +00003318 } else if (options_->onboarding_only) {
3319 DumpstateOnboardingOnly();
Gavin Corkery6968f552020-11-22 18:09:05 +00003320 } else {
Nandana Dutt4be45d12018-09-26 15:04:23 +01003321 // Dump state for the default case. This also drops root.
Jichao Lie89d9c12019-11-21 19:02:51 -08003322 RunStatus s = DumpstateDefaultAfterCritical();
Nandana Dutt5c390032019-03-12 10:52:56 +00003323 if (s != RunStatus::OK) {
Nandana Duttaac6f582019-07-26 14:32:47 +01003324 if (s == RunStatus::USER_CONSENT_DENIED) {
Nandana Dutt5c390032019-03-12 10:52:56 +00003325 HandleUserConsentDenied();
3326 }
3327 return s;
Felipe Leme6ec6ac42017-01-10 15:29:53 -08003328 }
Zhengyin Qian068ecc72016-08-10 16:48:14 -07003329 }
Felipe Leme71a74ac2016-03-17 15:43:25 -07003330
Felipe Leme55b42a62015-11-10 17:39:08 -08003331 /* close output if needed */
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003332 TEMP_FAILURE_RETRY(dup2(dup_stdout_fd, fileno(stdout)));
Colin Crossf45fa6b2012-03-26 12:38:26 -07003333
Abhijeet Kaure370d682019-10-01 16:49:30 +01003334 // Zip the (now complete) .tmp file within the internal directory.
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003335 ATRACE_BEGIN("FinalizeFile");
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003336 FinalizeFile();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003337 ATRACE_END();
Colin Crossf45fa6b2012-03-26 12:38:26 -07003338
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003339 // Share the final file with the caller if the user has consented or Shell is the caller.
Nandana Duttd2f5f082019-01-18 17:13:52 +00003340 Dumpstate::RunStatus status = Dumpstate::RunStatus::OK;
Gavin Corkerya44686c2022-11-23 18:16:51 +00003341 if (CalledByApi() && !options_->is_consent_deferred) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003342 status = CopyBugreportIfUserConsented(calling_uid);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003343 if (status != Dumpstate::RunStatus::OK &&
3344 status != Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3345 // Do an early return if there were errors. We make an exception for consent
3346 // timing out because it's possible the user got distracted. In this case the
3347 // bugreport is not shared but made available for manual retrieval.
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003348 MYLOGI("User denied consent. Returning\n");
Nandana Duttd2f5f082019-01-18 17:13:52 +00003349 return status;
3350 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003351 if (status == Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT) {
3352 MYLOGI(
3353 "Did not receive user consent yet."
3354 " Will not copy the bugreport artifacts to caller.\n");
Abhijeet Kaur57627412019-04-17 16:00:09 +01003355 const String16 incidentcompanion("incidentcompanion");
3356 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
3357 if (ics != nullptr) {
3358 MYLOGD("Canceling user consent request via incidentcompanion service\n");
3359 android::interface_cast<android::os::IIncidentCompanion>(ics)->cancelAuthorization(
3360 consent_callback_.get());
3361 } else {
3362 MYLOGD("Unable to cancel user consent; incidentcompanion service unavailable\n");
3363 }
Nandana Dutt16d1aee2019-02-15 16:13:53 +00003364 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003365 }
3366
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003367 /* vibrate a few but shortly times to let user know it's finished */
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003368 if (options_->do_vibrate) {
Takuya Ogawa47f644e2017-12-20 18:09:09 +09003369 for (int i = 0; i < 3; i++) {
3370 Vibrate(75);
3371 usleep((75 + 50) * 1000);
3372 }
Felipe Lemecc2a2fa2016-02-25 14:02:44 -08003373 }
3374
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003375 MYLOGD("Final progress: %d/%d (estimated %d)\n", progress_->Get(), progress_->GetMax(),
3376 progress_->GetInitialMax());
3377 progress_->Save();
3378 MYLOGI("done (id %d)\n", id_);
Colin Crossf45fa6b2012-03-26 12:38:26 -07003379
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003380 TEMP_FAILURE_RETRY(dup2(dup_stderr_fd, fileno(stderr)));
Felipe Leme107a05f2016-03-08 15:11:15 -08003381
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003382 if (control_socket_fd_ != -1) {
Felipe Lemee844a9d2016-09-21 15:01:39 -07003383 MYLOGD("Closing control socket\n");
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003384 close(control_socket_fd_);
Felipe Leme2628e9e2016-04-12 16:36:51 -07003385 }
3386
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003387 tombstone_data_.clear();
3388 anr_data_.clear();
Andy Hungd62f7e62024-01-11 15:47:52 -08003389 anr_trace_data_.clear();
Woody Lin20767a92022-11-29 15:50:24 +08003390 shutdown_checkpoints_.clear();
Narayan Kamath6b9516c2017-10-27 11:15:51 +01003391
Nandana Duttd2f5f082019-01-18 17:13:52 +00003392 return (consent_callback_ != nullptr &&
3393 consent_callback_->getResult() == UserConsentResult::UNAVAILABLE)
3394 ? USER_CONSENT_TIMED_OUT
3395 : RunStatus::OK;
3396}
3397
Paul Chang0d2aad72020-02-13 20:04:03 +08003398void Dumpstate::MaybeTakeEarlyScreenshot() {
3399 if (!options_->do_screenshot || !do_early_screenshot_) {
3400 return;
3401 }
3402
3403 TakeScreenshot();
3404}
3405
Kean Mariottica20f2d2023-12-15 09:34:25 +00003406std::future<std::string> Dumpstate::MaybeSnapshotSystemTraceAsync() {
Kean Mariotti853b73a2023-07-27 12:40:30 +00003407 // When capturing traces via bugreport handler (BH), this function will be invoked twice:
3408 // 1) When BH invokes IDumpstate::PreDumpUiData()
3409 // 2) When BH invokes IDumpstate::startBugreport(flags = BUGREPORT_USE_PREDUMPED_UI_DATA)
3410 // In this case we don't want to re-invoke perfetto in step 2.
3411 // In all other standard invocation states, this function is invoked once
3412 // without the flag BUGREPORT_USE_PREDUMPED_UI_DATA.
Kean Mariottica20f2d2023-12-15 09:34:25 +00003413 // This function must run asynchronously to avoid delaying MaybeTakeEarlyScreenshot() in the
3414 // standard invocation states (b/316110955).
Kean Mariotti853b73a2023-07-27 12:40:30 +00003415 if (options_->use_predumped_ui_data) {
Kean Mariottica20f2d2023-12-15 09:34:25 +00003416 return {};
3417 }
3418
3419 // Create temporary file for the command's output
3420 std::string outPath = ds.bugreport_internal_dir_ + "/tmp_serialize_perfetto_trace";
3421 auto outFd = android::base::unique_fd(TEMP_FAILURE_RETRY(
3422 open(outPath.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_NOFOLLOW,
3423 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)));
3424 if (outFd < 0) {
3425 MYLOGE("Could not open %s to serialize perfetto trace.\n", outPath.c_str());
3426 return {};
Kean Mariotti853b73a2023-07-27 12:40:30 +00003427 }
3428
3429 // If a stale file exists already, remove it.
3430 unlink(SYSTEM_TRACE_SNAPSHOT);
3431
Kean Mariottica20f2d2023-12-15 09:34:25 +00003432 MYLOGI("Launching async '%s'", SERIALIZE_PERFETTO_TRACE_TASK.c_str())
3433 return std::async(
3434 std::launch::async, [this, outPath = std::move(outPath), outFd = std::move(outFd)] {
3435 // If a background system trace is happening and is marked as "suitable for
3436 // bugreport" (i.e. bugreport_score > 0 in the trace config), this command
3437 // will stop it and serialize into SYSTEM_TRACE_SNAPSHOT. In the (likely)
3438 // case that no trace is ongoing, this command is a no-op.
3439 // Note: this should not be enqueued as we need to freeze the trace before
3440 // dumpstate starts. Otherwise the trace ring buffers will contain mostly
3441 // the dumpstate's own activity which is irrelevant.
3442 RunCommand(
3443 SERIALIZE_PERFETTO_TRACE_TASK, {"perfetto", "--save-for-bugreport"},
3444 CommandOptions::WithTimeout(10).DropRoot().CloseAllFileDescriptorsOnExec().Build(),
3445 false, outFd);
3446 // MaybeAddSystemTraceToZip() will take care of copying the trace in the zip
3447 // file in the later stages.
3448
3449 return outPath;
3450 });
3451}
3452
3453void Dumpstate::MaybeWaitForSnapshotSystemTrace(std::future<std::string> task) {
3454 if (!task.valid()) {
3455 return;
3456 }
3457
3458 WaitForTask(std::move(task), SERIALIZE_PERFETTO_TRACE_TASK, STDOUT_FILENO);
Primiano Tuccifaaaafb2021-01-14 12:26:29 +00003459}
3460
Kean Mariotti306633e2022-09-05 16:30:47 +00003461void Dumpstate::MaybeSnapshotUiTraces() {
3462 if (PropertiesHelper::IsUserBuild() || options_->use_predumped_ui_data) {
3463 return;
3464 }
3465
Pablo Gamito654831c2024-02-16 16:47:48 +00003466 std::vector<std::vector<std::string>> dumpTracesForBugReportCommands = {
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003467 {"cmd", "input_method", "tracing", "save-for-bugreport"},
3468 {"cmd", "window", "tracing", "save-for-bugreport"},
3469 {"cmd", "window", "shell", "tracing", "save-for-bugreport"},
3470 };
Hongwei Wang39229132023-01-24 15:09:59 -08003471
Pablo Gamito654831c2024-02-16 16:47:48 +00003472 if (!android_tracing_perfetto_transition_tracing()) {
3473 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3474 "SystemUIService", "WMShell", "transitions",
3475 "tracing", "save-for-bugreport"});
3476 }
3477
Pablo Gamito6929a0e2024-02-26 23:29:47 +00003478 if (!android_tracing_perfetto_protolog_tracing()) {
Pablo Gamito654831c2024-02-16 16:47:48 +00003479 dumpTracesForBugReportCommands.push_back({"dumpsys", "activity", "service",
3480 "SystemUIService", "WMShell", "protolog",
3481 "save-for-bugreport"});
3482 }
3483
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003484 for (const auto& command : dumpTracesForBugReportCommands) {
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003485 RunCommand(
3486 // Empty name because it's not intended to be classified as a bugreport section.
3487 // Actual tracing files can be found in "/data/misc/wmtrace/" in the bugreport.
Pablo Gamitoefdc5922023-04-19 09:44:47 +00003488 "", command,
Yohei Yukawa02b1d2c2021-03-16 09:20:30 -07003489 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
3490 }
Kean Mariotti306633e2022-09-05 16:30:47 +00003491}
3492
3493void Dumpstate::MaybeAddUiTracesToZip() {
3494 if (PropertiesHelper::IsUserBuild()) {
3495 return;
3496 }
3497
3498 ds.AddDir(WMTRACE_DATA_DIR, false);
Yohei Yukawa95305b32021-03-09 07:54:27 -08003499}
3500
Paul Changeb4b4642020-05-28 22:05:47 +08003501void Dumpstate::onUiIntensiveBugreportDumpsFinished(int32_t calling_uid) {
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003502 if (multiuser_get_app_id(calling_uid) == AID_SHELL || !CalledByApi()) {
Paul Changc490e662020-04-11 18:14:09 +08003503 return;
3504 }
3505 if (listener_ != nullptr) {
3506 // Let listener know ui intensive bugreport dumps are finished, then it can do event
3507 // handling if required.
Paul Changeb4b4642020-05-28 22:05:47 +08003508 listener_->onUiIntensiveBugreportDumpsFinished();
Paul Changc490e662020-04-11 18:14:09 +08003509 }
3510}
3511
Jichao Lie89d9c12019-11-21 19:02:51 -08003512void Dumpstate::MaybeCheckUserConsent(int32_t calling_uid, const std::string& calling_package) {
Gavin Corkerya44686c2022-11-23 18:16:51 +00003513 if (multiuser_get_app_id(calling_uid) == AID_SHELL ||
3514 !CalledByApi() || options_->is_consent_deferred) {
3515 // No need to get consent for shell triggered dumpstates, or not
3516 // through bugreporting API (i.e. no fd to copy back), or when consent
3517 // is deferred.
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003518 return;
3519 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003520 consent_callback_ = new ConsentCallback();
3521 const String16 incidentcompanion("incidentcompanion");
3522 sp<android::IBinder> ics(defaultServiceManager()->getService(incidentcompanion));
Jichao Lie89d9c12019-11-21 19:02:51 -08003523 android::String16 package(calling_package.c_str());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003524 if (ics != nullptr) {
3525 MYLOGD("Checking user consent via incidentcompanion service\n");
Steven Leeb573eb82022-11-29 22:31:35 +08003526 int flags = 0x1; // IncidentManager.FLAG_CONFIRMATION_DIALOG
3527 if (IsConsentlessBugreportAllowed(*options_)) {
3528 flags |= 0x2; // IncidentManager.FLAG_ALLOW_CONSENTLESS_BUGREPORT
3529 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003530 android::interface_cast<android::os::IIncidentCompanion>(ics)->authorizeReport(
Steven Leeb573eb82022-11-29 22:31:35 +08003531 calling_uid, package, String16(), String16(), flags, consent_callback_.get());
Nandana Duttd2f5f082019-01-18 17:13:52 +00003532 } else {
3533 MYLOGD("Unable to check user consent; incidentcompanion service unavailable\n");
3534 }
3535}
3536
Nandana Dutt5c390032019-03-12 10:52:56 +00003537bool Dumpstate::IsUserConsentDenied() const {
3538 return ds.consent_callback_ != nullptr &&
3539 ds.consent_callback_->getResult() == UserConsentResult::DENIED;
3540}
3541
Abhijeet Kaur359b1ff2019-07-26 16:01:36 +01003542bool Dumpstate::CalledByApi() const {
3543 return ds.options_->bugreport_fd.get() != -1 ? true : false;
3544}
3545
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003546void Dumpstate::CleanupTmpFiles() {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003547 android::os::UnlinkAndLogOnError(tmp_path_);
3548 android::os::UnlinkAndLogOnError(screenshot_path_);
3549 android::os::UnlinkAndLogOnError(path_);
Gavin Corkery789d7a52021-02-24 23:52:35 +00003550 if (dump_traces_path != nullptr) {
3551 android::os::UnlinkAndLogOnError(dump_traces_path);
3552 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003553}
3554
Rhed Jao5377d792020-07-16 17:37:39 +08003555void Dumpstate::EnableParallelRunIfNeeded() {
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003556 if (!PropertiesHelper::IsParallelRun()) {
Rhed Jao5377d792020-07-16 17:37:39 +08003557 return;
3558 }
3559 dump_pool_ = std::make_unique<DumpPool>(bugreport_internal_dir_);
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003560 zip_entry_tasks_ = std::make_unique<TaskQueue>();
Rhed Jao5377d792020-07-16 17:37:39 +08003561}
3562
3563void Dumpstate::ShutdownDumpPool() {
3564 if (dump_pool_) {
Chris Morinbc223142022-02-04 14:17:11 -08003565 dump_pool_.reset();
Rhed Jao5377d792020-07-16 17:37:39 +08003566 }
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08003567 if (zip_entry_tasks_) {
3568 zip_entry_tasks_->run(/* do_cancel = */true);
3569 zip_entry_tasks_ = nullptr;
3570 }
3571}
3572
3573void Dumpstate::EnqueueAddZipEntryAndCleanupIfNeeded(const std::string& entry_name,
3574 const std::string& entry_path) {
3575 auto func_add_zip_entry_and_cleanup = [=](bool task_cancelled) {
3576 if (!task_cancelled) {
3577 AddZipEntry(entry_name, entry_path);
3578 }
3579 android::os::UnlinkAndLogOnError(entry_path);
3580 };
3581 if (zip_entry_tasks_) {
3582 // Enqueues AddZipEntryAndCleanup function if the parallel run is enabled.
3583 zip_entry_tasks_->add(func_add_zip_entry_and_cleanup, _1);
3584 } else {
3585 // Invokes AddZipEntryAndCleanup immediately
3586 std::invoke(func_add_zip_entry_and_cleanup, /* task_cancelled = */false);
3587 }
Rhed Jao5377d792020-07-16 17:37:39 +08003588}
3589
Nandana Duttd2f5f082019-01-18 17:13:52 +00003590Dumpstate::RunStatus Dumpstate::HandleUserConsentDenied() {
3591 MYLOGD("User denied consent; deleting files and returning\n");
Nandana Dutt8ae16e62020-03-27 10:20:22 +00003592 CleanupTmpFiles();
Nandana Duttd2f5f082019-01-18 17:13:52 +00003593 return USER_CONSENT_DENIED;
3594}
3595
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003596Dumpstate::RunStatus Dumpstate::CopyBugreportIfUserConsented(int32_t calling_uid) {
Nandana Duttd2f5f082019-01-18 17:13:52 +00003597 // If the caller has asked to copy the bugreport over to their directory, we need explicit
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003598 // user consent (unless the caller is Shell).
3599 UserConsentResult consent_result;
Nikhil Kumar28ce35e2023-01-10 14:32:44 +00003600 if (multiuser_get_app_id(calling_uid) == AID_SHELL) {
Abhijeet Kaur3172b532019-10-15 15:07:03 +01003601 consent_result = UserConsentResult::APPROVED;
3602 } else {
3603 consent_result = consent_callback_->getResult();
3604 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003605 if (consent_result == UserConsentResult::UNAVAILABLE) {
3606 // User has not responded yet.
3607 uint64_t elapsed_ms = consent_callback_->getElapsedTimeMs();
Hunter Knepshield70610fa2020-01-03 15:27:33 -08003608 // Telephony is a fast report type, particularly on user builds where information may be
3609 // more aggressively limited. To give the user time to read the consent dialog, increase the
3610 // timeout.
3611 uint64_t timeout_ms = options_->telephony_only ? TELEPHONY_REPORT_USER_CONSENT_TIMEOUT_MS
3612 : USER_CONSENT_TIMEOUT_MS;
3613 if (elapsed_ms < timeout_ms) {
3614 uint delay_seconds = (timeout_ms - elapsed_ms) / 1000;
Nandana Duttd2f5f082019-01-18 17:13:52 +00003615 MYLOGD("Did not receive user consent yet; going to wait for %d seconds", delay_seconds);
3616 sleep(delay_seconds);
3617 }
3618 consent_result = consent_callback_->getResult();
3619 }
3620 if (consent_result == UserConsentResult::DENIED) {
3621 // User has explicitly denied sharing with the app. To be safe delete the
3622 // internal bugreport & tmp files.
3623 return HandleUserConsentDenied();
3624 }
3625 if (consent_result == UserConsentResult::APPROVED) {
Nandana Dutte78c3d72019-01-29 16:10:45 +00003626 bool copy_succeeded = android::os::CopyFileToFd(path_, options_->bugreport_fd.get());
3627 if (copy_succeeded) {
3628 android::os::UnlinkAndLogOnError(path_);
Abhijeet Kaur9ce94672020-04-01 17:22:36 +01003629 if (options_->do_screenshot &&
3630 options_->screenshot_fd.get() != -1 &&
3631 !options_->is_screenshot_copied) {
3632 copy_succeeded = android::os::CopyFileToFd(screenshot_path_,
3633 options_->screenshot_fd.get());
3634 options_->is_screenshot_copied = copy_succeeded;
3635 if (copy_succeeded) {
3636 android::os::UnlinkAndLogOnError(screenshot_path_);
3637 }
3638 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003639 }
3640 return copy_succeeded ? Dumpstate::RunStatus::OK : Dumpstate::RunStatus::ERROR;
3641 } else if (consent_result == UserConsentResult::UNAVAILABLE) {
3642 // consent_result is still UNAVAILABLE. The user has likely not responded yet.
3643 // Since we do not have user consent to share the bugreport it does not get
3644 // copied over to the calling app but remains in the internal directory from
3645 // where the user can manually pull it.
Paul Changce644212021-05-11 16:06:45 +08003646 std::string final_path = GetPath(".zip");
3647 bool copy_succeeded = android::os::CopyFileToFile(path_, final_path);
3648 if (copy_succeeded) {
3649 android::os::UnlinkAndLogOnError(path_);
3650 }
Nandana Duttd2f5f082019-01-18 17:13:52 +00003651 return Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT;
3652 }
3653 // Unknown result; must be a programming error.
3654 MYLOGE("Unknown user consent result:%d\n", consent_result);
3655 return Dumpstate::RunStatus::ERROR;
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003656}
3657
Nandana Duttf02564e2019-02-15 15:24:24 +00003658Dumpstate::RunStatus Dumpstate::ParseCommandlineAndRun(int argc, char* argv[]) {
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003659 std::unique_ptr<Dumpstate::DumpOptions> options = std::make_unique<Dumpstate::DumpOptions>();
3660 Dumpstate::RunStatus status = options->Initialize(argc, argv);
3661 if (status == Dumpstate::RunStatus::OK) {
Nandana Duttf02564e2019-02-15 15:24:24 +00003662 SetOptions(std::move(options));
Nandana Duttd2f5f082019-01-18 17:13:52 +00003663 // When directly running dumpstate binary, the output is not expected to be written
3664 // to any external file descriptor.
Nandana Duttf02564e2019-02-15 15:24:24 +00003665 assert(options_->bugreport_fd.get() == -1);
Nandana Duttd2f5f082019-01-18 17:13:52 +00003666
3667 // calling_uid and calling_package are for user consent to share the bugreport with
Abhijeet Kaura407fb82020-03-27 12:51:12 +00003668 // an app; they are irrelevant here because bugreport is triggered via command line.
3669 // Update Last ID before calling Run().
3670 Initialize();
Nikhil Kumarb70622a2023-06-15 15:37:19 +01003671 status = Run(0 /* calling_uid */, "" /* calling_package */);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003672 }
Nandana Duttf02564e2019-02-15 15:24:24 +00003673 return status;
3674}
3675
3676/* Main entry point for dumpstate binary. */
3677int run_main(int argc, char* argv[]) {
3678 Dumpstate::RunStatus status = ds.ParseCommandlineAndRun(argc, argv);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003679
3680 switch (status) {
3681 case Dumpstate::RunStatus::OK:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003682 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003683 case Dumpstate::RunStatus::HELP:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003684 ShowUsage();
3685 exit(0);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003686 case Dumpstate::RunStatus::INVALID_INPUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003687 fprintf(stderr, "Invalid combination of args\n");
3688 ShowUsage();
3689 exit(1);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003690 case Dumpstate::RunStatus::ERROR:
Nandana Duttd2f5f082019-01-18 17:13:52 +00003691 FALLTHROUGH_INTENDED;
3692 case Dumpstate::RunStatus::USER_CONSENT_DENIED:
3693 FALLTHROUGH_INTENDED;
3694 case Dumpstate::RunStatus::USER_CONSENT_TIMED_OUT:
Nandana Dutt12ae14a2019-01-09 10:35:53 +00003695 exit(2);
Nandana Dutt5fb117b2018-09-27 09:23:36 +01003696 }
Colin Crossf45fa6b2012-03-26 12:38:26 -07003697}
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003698
3699// TODO(111441001): Default DumpOptions to sensible values.
3700Dumpstate::Dumpstate(const std::string& version)
3701 : pid_(getpid()),
3702 options_(new Dumpstate::DumpOptions()),
Nandana Dutt402a8392019-06-14 14:25:13 +01003703 last_reported_percent_progress_(0),
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003704 version_(version),
Dieter Hsu105ad0c2020-09-29 15:23:33 +08003705 now_(time(nullptr)),
3706 open_socket_fn_(open_socket) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003707}
3708
3709Dumpstate& Dumpstate::GetInstance() {
3710 static Dumpstate singleton_(android::base::GetProperty("dumpstate.version", VERSION_CURRENT));
3711 return singleton_;
3712}
3713
Rhed Jao5377d792020-07-16 17:37:39 +08003714DurationReporter::DurationReporter(const std::string& title, bool logcat_only, bool verbose,
3715 int duration_fd) : title_(title), logcat_only_(logcat_only), verbose_(verbose),
3716 duration_fd_(duration_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003717 if (!title_.empty()) {
3718 started_ = Nanotime();
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003719 if (title_.find("SHOW MAP") == std::string::npos) {
3720 ATRACE_ASYNC_BEGIN(title_.c_str(), 0);
3721 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003722 }
3723}
3724
3725DurationReporter::~DurationReporter() {
3726 if (!title_.empty()) {
3727 float elapsed = (float)(Nanotime() - started_) / NANOS_PER_SEC;
chenqiwuaf8b2d92019-12-12 18:53:51 +08003728 if (elapsed >= .5f || verbose_) {
3729 MYLOGD("Duration of '%s': %.2fs\n", title_.c_str(), elapsed);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003730 }
chenqiwuaf8b2d92019-12-12 18:53:51 +08003731 if (!logcat_only_) {
3732 // Use "Yoda grammar" to make it easier to grep|sort sections.
Rhed Jao5377d792020-07-16 17:37:39 +08003733 dprintf(duration_fd_, "------ %.3fs was the duration of '%s' ------\n",
3734 elapsed, title_.c_str());
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003735 }
Kevin Jeon2c02e8e2022-07-07 21:45:17 +00003736 if (title_.find("SHOW MAP") == std::string::npos) {
3737 ATRACE_ASYNC_END(title_.c_str(), 0);
3738 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003739 }
3740}
3741
3742const int32_t Progress::kDefaultMax = 5000;
3743
3744Progress::Progress(const std::string& path) : Progress(Progress::kDefaultMax, 1.1, path) {
3745}
3746
3747Progress::Progress(int32_t initial_max, int32_t progress, float growth_factor)
3748 : Progress(initial_max, growth_factor, "") {
3749 progress_ = progress;
3750}
3751
3752Progress::Progress(int32_t initial_max, float growth_factor, const std::string& path)
3753 : initial_max_(initial_max),
3754 progress_(0),
3755 max_(initial_max),
3756 growth_factor_(growth_factor),
3757 n_runs_(0),
3758 average_max_(0),
3759 path_(path) {
3760 if (!path_.empty()) {
3761 Load();
3762 }
3763}
3764
3765void Progress::Load() {
3766 MYLOGD("Loading stats from %s\n", path_.c_str());
3767 std::string content;
3768 if (!android::base::ReadFileToString(path_, &content)) {
3769 MYLOGI("Could not read stats from %s; using max of %d\n", path_.c_str(), max_);
3770 return;
3771 }
3772 if (content.empty()) {
3773 MYLOGE("No stats (empty file) on %s; using max of %d\n", path_.c_str(), max_);
3774 return;
3775 }
3776 std::vector<std::string> lines = android::base::Split(content, "\n");
3777
3778 if (lines.size() < 1) {
3779 MYLOGE("Invalid stats on file %s: not enough lines (%d). Using max of %d\n", path_.c_str(),
3780 (int)lines.size(), max_);
3781 return;
3782 }
3783 char* ptr;
3784 n_runs_ = strtol(lines[0].c_str(), &ptr, 10);
3785 average_max_ = strtol(ptr, nullptr, 10);
3786 if (n_runs_ <= 0 || average_max_ <= 0 || n_runs_ > STATS_MAX_N_RUNS ||
3787 average_max_ > STATS_MAX_AVERAGE) {
3788 MYLOGE("Invalid stats line on file %s: %s\n", path_.c_str(), lines[0].c_str());
3789 initial_max_ = Progress::kDefaultMax;
3790 } else {
3791 initial_max_ = average_max_;
3792 }
3793 max_ = initial_max_;
3794
3795 MYLOGI("Average max progress: %d in %d runs; estimated max: %d\n", average_max_, n_runs_, max_);
3796}
3797
3798void Progress::Save() {
3799 int32_t total = n_runs_ * average_max_ + progress_;
3800 int32_t runs = n_runs_ + 1;
3801 int32_t average = floor(((float)total) / runs);
3802 MYLOGI("Saving stats (total=%d, runs=%d, average=%d) on %s\n", total, runs, average,
3803 path_.c_str());
3804 if (path_.empty()) {
3805 return;
3806 }
3807
3808 std::string content = android::base::StringPrintf("%d %d\n", runs, average);
3809 if (!android::base::WriteStringToFile(content, path_)) {
3810 MYLOGE("Could not save stats on %s\n", path_.c_str());
3811 }
3812}
3813
3814int32_t Progress::Get() const {
3815 return progress_;
3816}
3817
3818bool Progress::Inc(int32_t delta_sec) {
3819 bool changed = false;
3820 if (delta_sec >= 0) {
3821 progress_ += delta_sec;
3822 if (progress_ > max_) {
3823 int32_t old_max = max_;
3824 max_ = floor((float)progress_ * growth_factor_);
3825 MYLOGD("Adjusting max progress from %d to %d\n", old_max, max_);
3826 changed = true;
3827 }
3828 }
3829 return changed;
3830}
3831
3832int32_t Progress::GetMax() const {
3833 return max_;
3834}
3835
3836int32_t Progress::GetInitialMax() const {
3837 return initial_max_;
3838}
3839
3840void Progress::Dump(int fd, const std::string& prefix) const {
3841 const char* pr = prefix.c_str();
3842 dprintf(fd, "%sprogress: %d\n", pr, progress_);
3843 dprintf(fd, "%smax: %d\n", pr, max_);
3844 dprintf(fd, "%sinitial_max: %d\n", pr, initial_max_);
3845 dprintf(fd, "%sgrowth_factor: %0.2f\n", pr, growth_factor_);
3846 dprintf(fd, "%spath: %s\n", pr, path_.c_str());
3847 dprintf(fd, "%sn_runs: %d\n", pr, n_runs_);
3848 dprintf(fd, "%saverage_max: %d\n", pr, average_max_);
3849}
3850
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01003851std::string Dumpstate::GetPath(const std::string& suffix) const {
3852 return GetPath(bugreport_internal_dir_, suffix);
3853}
3854
3855std::string Dumpstate::GetPath(const std::string& directory, const std::string& suffix) const {
3856 return android::base::StringPrintf("%s/%s-%s%s", directory.c_str(), base_name_.c_str(),
3857 name_.c_str(), suffix.c_str());
3858}
3859
3860void Dumpstate::SetProgress(std::unique_ptr<Progress> progress) {
3861 progress_ = std::move(progress);
3862}
3863
3864void for_each_userid(void (*func)(int), const char *header) {
3865 std::string title = header == nullptr ? "for_each_userid" : android::base::StringPrintf(
3866 "for_each_userid(%s)", header);
3867 DurationReporter duration_reporter(title);
3868 if (PropertiesHelper::IsDryRun()) return;
3869
3870 DIR *d;
3871 struct dirent *de;
3872
3873 if (header) printf("\n------ %s ------\n", header);
3874 func(0);
3875
3876 if (!(d = opendir("/data/system/users"))) {
3877 printf("Failed to open /data/system/users (%s)\n", strerror(errno));
3878 return;
3879 }
3880
3881 while ((de = readdir(d))) {
3882 int userid;
3883 if (de->d_type != DT_DIR || !(userid = atoi(de->d_name))) {
3884 continue;
3885 }
3886 func(userid);
3887 }
3888
3889 closedir(d);
3890}
3891
3892static void __for_each_pid(void (*helper)(int, const char *, void *), const char *header, void *arg) {
3893 DIR *d;
3894 struct dirent *de;
3895
3896 if (!(d = opendir("/proc"))) {
3897 printf("Failed to open /proc (%s)\n", strerror(errno));
3898 return;
3899 }
3900
3901 if (header) printf("\n------ %s ------\n", header);
3902 while ((de = readdir(d))) {
3903 if (ds.IsUserConsentDenied()) {
3904 MYLOGE(
3905 "Returning early because user denied consent to share bugreport with calling app.");
3906 closedir(d);
3907 return;
3908 }
3909 int pid;
3910 int fd;
3911 char cmdpath[255];
3912 char cmdline[255];
3913
3914 if (!(pid = atoi(de->d_name))) {
3915 continue;
3916 }
3917
3918 memset(cmdline, 0, sizeof(cmdline));
3919
3920 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/cmdline", pid);
3921 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3922 TEMP_FAILURE_RETRY(read(fd, cmdline, sizeof(cmdline) - 2));
3923 close(fd);
3924 if (cmdline[0]) {
3925 helper(pid, cmdline, arg);
3926 continue;
3927 }
3928 }
3929
3930 // if no cmdline, a kernel thread has comm
3931 snprintf(cmdpath, sizeof(cmdpath), "/proc/%d/comm", pid);
3932 if ((fd = TEMP_FAILURE_RETRY(open(cmdpath, O_RDONLY | O_CLOEXEC))) >= 0) {
3933 TEMP_FAILURE_RETRY(read(fd, cmdline + 1, sizeof(cmdline) - 4));
3934 close(fd);
3935 if (cmdline[1]) {
3936 cmdline[0] = '[';
3937 size_t len = strcspn(cmdline, "\f\b\r\n");
3938 cmdline[len] = ']';
3939 cmdline[len+1] = '\0';
3940 }
3941 }
3942 if (!cmdline[0]) {
3943 strcpy(cmdline, "N/A");
3944 }
3945 helper(pid, cmdline, arg);
3946 }
3947
3948 closedir(d);
3949}
3950
3951static void for_each_pid_helper(int pid, const char *cmdline, void *arg) {
3952 for_each_pid_func *func = (for_each_pid_func*) arg;
3953 func(pid, cmdline);
3954}
3955
3956void for_each_pid(for_each_pid_func func, const char *header) {
3957 std::string title = header == nullptr ? "for_each_pid"
3958 : android::base::StringPrintf("for_each_pid(%s)", header);
3959 DurationReporter duration_reporter(title);
3960 if (PropertiesHelper::IsDryRun()) return;
3961
3962 __for_each_pid(for_each_pid_helper, header, (void *) func);
3963}
3964
3965static void for_each_tid_helper(int pid, const char *cmdline, void *arg) {
3966 DIR *d;
3967 struct dirent *de;
3968 char taskpath[255];
3969 for_each_tid_func *func = (for_each_tid_func *) arg;
3970
3971 snprintf(taskpath, sizeof(taskpath), "/proc/%d/task", pid);
3972
3973 if (!(d = opendir(taskpath))) {
3974 printf("Failed to open %s (%s)\n", taskpath, strerror(errno));
3975 return;
3976 }
3977
3978 func(pid, pid, cmdline);
3979
3980 while ((de = readdir(d))) {
3981 if (ds.IsUserConsentDenied()) {
3982 MYLOGE(
3983 "Returning early because user denied consent to share bugreport with calling app.");
3984 closedir(d);
3985 return;
3986 }
3987 int tid;
3988 int fd;
3989 char commpath[255];
3990 char comm[255];
3991
3992 if (!(tid = atoi(de->d_name))) {
3993 continue;
3994 }
3995
3996 if (tid == pid)
3997 continue;
3998
3999 snprintf(commpath, sizeof(commpath), "/proc/%d/comm", tid);
4000 memset(comm, 0, sizeof(comm));
4001 if ((fd = TEMP_FAILURE_RETRY(open(commpath, O_RDONLY | O_CLOEXEC))) < 0) {
4002 strcpy(comm, "N/A");
4003 } else {
4004 char *c;
4005 TEMP_FAILURE_RETRY(read(fd, comm, sizeof(comm) - 2));
4006 close(fd);
4007
4008 c = strrchr(comm, '\n');
4009 if (c) {
4010 *c = '\0';
4011 }
4012 }
4013 func(pid, tid, comm);
4014 }
4015
4016 closedir(d);
4017}
4018
4019void for_each_tid(for_each_tid_func func, const char *header) {
4020 std::string title = header == nullptr ? "for_each_tid"
4021 : android::base::StringPrintf("for_each_tid(%s)", header);
4022 DurationReporter duration_reporter(title);
4023
4024 if (PropertiesHelper::IsDryRun()) return;
4025
4026 __for_each_pid(for_each_tid_helper, header, (void *) func);
4027}
4028
4029void show_wchan(int pid, int tid, const char *name) {
4030 if (PropertiesHelper::IsDryRun()) return;
4031
4032 char path[255];
4033 char buffer[255];
4034 int fd, ret, save_errno;
4035 char name_buffer[255];
4036
4037 memset(buffer, 0, sizeof(buffer));
4038
4039 snprintf(path, sizeof(path), "/proc/%d/wchan", tid);
4040 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4041 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4042 return;
4043 }
4044
4045 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4046 save_errno = errno;
4047 close(fd);
4048
4049 if (ret < 0) {
4050 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4051 return;
4052 }
4053
4054 snprintf(name_buffer, sizeof(name_buffer), "%*s%s",
4055 pid == tid ? 0 : 3, "", name);
4056
4057 printf("%-7d %-32s %s\n", tid, name_buffer, buffer);
4058
4059 return;
4060}
4061
4062// print time in centiseconds
4063static void snprcent(char *buffer, size_t len, size_t spc,
4064 unsigned long long time) {
4065 static long hz; // cache discovered hz
4066
4067 if (hz <= 0) {
4068 hz = sysconf(_SC_CLK_TCK);
4069 if (hz <= 0) {
4070 hz = 1000;
4071 }
4072 }
4073
4074 // convert to centiseconds
4075 time = (time * 100 + (hz / 2)) / hz;
4076
4077 char str[16];
4078
4079 snprintf(str, sizeof(str), " %llu.%02u",
4080 time / 100, (unsigned)(time % 100));
4081 size_t offset = strlen(buffer);
4082 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4083 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4084}
4085
4086// print permille as a percent
4087static void snprdec(char *buffer, size_t len, size_t spc, unsigned permille) {
4088 char str[16];
4089
4090 snprintf(str, sizeof(str), " %u.%u%%", permille / 10, permille % 10);
4091 size_t offset = strlen(buffer);
4092 snprintf(buffer + offset, (len > offset) ? len - offset : 0,
4093 "%*s", (spc > offset) ? (int)(spc - offset) : 0, str);
4094}
4095
4096void show_showtime(int pid, const char *name) {
4097 if (PropertiesHelper::IsDryRun()) return;
4098
4099 char path[255];
4100 char buffer[1023];
4101 int fd, ret, save_errno;
4102
4103 memset(buffer, 0, sizeof(buffer));
4104
4105 snprintf(path, sizeof(path), "/proc/%d/stat", pid);
4106 if ((fd = TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_CLOEXEC))) < 0) {
4107 printf("Failed to open '%s' (%s)\n", path, strerror(errno));
4108 return;
4109 }
4110
4111 ret = TEMP_FAILURE_RETRY(read(fd, buffer, sizeof(buffer)));
4112 save_errno = errno;
4113 close(fd);
4114
4115 if (ret < 0) {
4116 printf("Failed to read '%s' (%s)\n", path, strerror(save_errno));
4117 return;
4118 }
4119
4120 // field 14 is utime
4121 // field 15 is stime
4122 // field 42 is iotime
4123 unsigned long long utime = 0, stime = 0, iotime = 0;
4124 if (sscanf(buffer,
4125 "%*u %*s %*s %*d %*d %*d %*d %*d %*d %*d %*d "
4126 "%*d %*d %llu %llu %*d %*d %*d %*d %*d %*d "
4127 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %*d "
4128 "%*d %*d %*d %*d %*d %*d %*d %*d %*d %llu ",
4129 &utime, &stime, &iotime) != 3) {
4130 return;
4131 }
4132
4133 unsigned long long total = utime + stime;
4134 if (!total) {
4135 return;
4136 }
4137
4138 unsigned permille = (iotime * 1000 + (total / 2)) / total;
4139 if (permille > 1000) {
4140 permille = 1000;
4141 }
4142
4143 // try to beautify and stabilize columns at <80 characters
4144 snprintf(buffer, sizeof(buffer), "%-6d%s", pid, name);
4145 if ((name[0] != '[') || utime) {
4146 snprcent(buffer, sizeof(buffer), 57, utime);
4147 }
4148 snprcent(buffer, sizeof(buffer), 65, stime);
4149 if ((name[0] != '[') || iotime) {
4150 snprcent(buffer, sizeof(buffer), 73, iotime);
4151 }
4152 if (iotime) {
4153 snprdec(buffer, sizeof(buffer), 79, permille);
4154 }
4155 puts(buffer); // adds a trailing newline
4156
4157 return;
4158}
4159
4160void do_dmesg() {
4161 const char *title = "KERNEL LOG (dmesg)";
4162 DurationReporter duration_reporter(title);
4163 printf("------ %s ------\n", title);
4164
4165 if (PropertiesHelper::IsDryRun()) return;
4166
4167 /* Get size of kernel buffer */
4168 int size = klogctl(KLOG_SIZE_BUFFER, nullptr, 0);
4169 if (size <= 0) {
4170 printf("Unexpected klogctl return value: %d\n\n", size);
4171 return;
4172 }
4173 char *buf = (char *) malloc(size + 1);
4174 if (buf == nullptr) {
4175 printf("memory allocation failed\n\n");
4176 return;
4177 }
4178 int retval = klogctl(KLOG_READ_ALL, buf, size);
4179 if (retval < 0) {
4180 printf("klogctl failure\n\n");
4181 free(buf);
4182 return;
4183 }
4184 buf[retval] = '\0';
4185 printf("%s\n\n", buf);
4186 free(buf);
4187 return;
4188}
4189
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004190int Dumpstate::DumpFile(const std::string& title, const std::string& path) {
4191 DurationReporter duration_reporter(title);
4192
4193 int status = DumpFileToFd(STDOUT_FILENO, title, path);
4194
4195 UpdateProgress(WEIGHT_FILE);
4196
4197 return status;
4198}
4199
4200int read_file_as_long(const char *path, long int *output) {
luoqiangwei15fcf2022024-03-07 15:29:20 +08004201 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4202 if (fd.get() < 0) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004203 int err = errno;
4204 MYLOGE("Error opening file descriptor for %s: %s\n", path, strerror(err));
4205 return -1;
4206 }
4207 char buffer[50];
luoqiangwei15fcf2022024-03-07 15:29:20 +08004208 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd.get(), buffer, sizeof(buffer)));
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004209 if (bytes_read == -1) {
4210 MYLOGE("Error reading file %s: %s\n", path, strerror(errno));
4211 return -2;
4212 }
4213 if (bytes_read == 0) {
4214 MYLOGE("File %s is empty\n", path);
4215 return -3;
4216 }
4217 *output = atoi(buffer);
4218 return 0;
4219}
4220
4221/* calls skip to gate calling dump_from_fd recursively
4222 * in the specified directory. dump_from_fd defaults to
4223 * dump_file_from_fd above when set to NULL. skip defaults
4224 * to false when set to NULL. dump_from_fd will always be
4225 * called with title NULL.
4226 */
4227int dump_files(const std::string& title, const char* dir, bool (*skip)(const char* path),
4228 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4229 DurationReporter duration_reporter(title);
4230 DIR *dirp;
4231 struct dirent *d;
4232 char *newpath = nullptr;
4233 const char *slash = "/";
4234 int retval = 0;
4235
4236 if (!title.empty()) {
4237 printf("------ %s (%s) ------\n", title.c_str(), dir);
4238 }
4239 if (PropertiesHelper::IsDryRun()) return 0;
4240
4241 if (dir[strlen(dir) - 1] == '/') {
4242 ++slash;
4243 }
4244 dirp = opendir(dir);
4245 if (dirp == nullptr) {
4246 retval = -errno;
4247 MYLOGE("%s: %s\n", dir, strerror(errno));
4248 return retval;
4249 }
4250
4251 if (!dump_from_fd) {
4252 dump_from_fd = dump_file_from_fd;
4253 }
4254 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4255 if ((d->d_name[0] == '.')
4256 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4257 || (d->d_name[1] == '\0'))) {
4258 continue;
4259 }
4260 asprintf(&newpath, "%s%s%s%s", dir, slash, d->d_name,
4261 (d->d_type == DT_DIR) ? "/" : "");
4262 if (!newpath) {
4263 retval = -errno;
4264 continue;
4265 }
4266 if (skip && (*skip)(newpath)) {
4267 continue;
4268 }
4269 if (d->d_type == DT_DIR) {
4270 int ret = dump_files("", newpath, skip, dump_from_fd);
4271 if (ret < 0) {
4272 retval = ret;
4273 }
4274 continue;
4275 }
4276 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(newpath, O_RDONLY | O_NONBLOCK | O_CLOEXEC)));
4277 if (fd.get() < 0) {
4278 retval = -1;
4279 printf("*** %s: %s\n", newpath, strerror(errno));
4280 continue;
4281 }
4282 (*dump_from_fd)(nullptr, newpath, fd.get());
4283 }
4284 closedir(dirp);
4285 if (!title.empty()) {
4286 printf("\n");
4287 }
4288 return retval;
4289}
4290
4291/* fd must have been opened with the flag O_NONBLOCK. With this flag set,
4292 * it's possible to avoid issues where opening the file itself can get
4293 * stuck.
4294 */
4295int dump_file_from_fd(const char *title, const char *path, int fd) {
4296 if (PropertiesHelper::IsDryRun()) return 0;
4297
4298 int flags = fcntl(fd, F_GETFL);
4299 if (flags == -1) {
4300 printf("*** %s: failed to get flags on fd %d: %s\n", path, fd, strerror(errno));
4301 return -1;
4302 } else if (!(flags & O_NONBLOCK)) {
4303 printf("*** %s: fd must have O_NONBLOCK set.\n", path);
4304 return -1;
4305 }
4306 return DumpFileFromFdToFd(title, path, fd, STDOUT_FILENO, PropertiesHelper::IsDryRun());
4307}
4308
4309int Dumpstate::RunCommand(const std::string& title, const std::vector<std::string>& full_command,
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004310 const CommandOptions& options, bool verbose_duration, int out_fd) {
4311 DurationReporter duration_reporter(title, false /* logcat_only */,
4312 verbose_duration, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004313
Rhed Jao3c2fdbd2020-07-20 17:46:29 +08004314 int status = RunCommandToFd(out_fd, title, full_command, options);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004315
4316 /* TODO: for now we're simplifying the progress calculation by using the
4317 * timeout as the weight. It's a good approximation for most cases, except when calling dumpsys,
4318 * where its weight should be much higher proportionally to its timeout.
4319 * Ideally, it should use a options.EstimatedDuration() instead...*/
4320 UpdateProgress(options.Timeout());
4321
4322 return status;
4323}
4324
4325void Dumpstate::RunDumpsys(const std::string& title, const std::vector<std::string>& dumpsys_args,
Rhed Jaoe017f982020-07-21 17:58:41 +08004326 const CommandOptions& options, long dumpsysTimeoutMs, int out_fd) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004327 long timeout_ms = dumpsysTimeoutMs > 0 ? dumpsysTimeoutMs : options.TimeoutInMs();
4328 std::vector<std::string> dumpsys = {"/system/bin/dumpsys", "-T", std::to_string(timeout_ms)};
4329 dumpsys.insert(dumpsys.end(), dumpsys_args.begin(), dumpsys_args.end());
Rhed Jaoe017f982020-07-21 17:58:41 +08004330 RunCommand(title, dumpsys, options, false, out_fd);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004331}
4332
Dieter Hsu105ad0c2020-09-29 15:23:33 +08004333static int open_socket(const char* service) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004334 int s = android_get_control_socket(service);
4335 if (s < 0) {
4336 MYLOGE("android_get_control_socket(%s): %s\n", service, strerror(errno));
4337 return -1;
4338 }
4339 fcntl(s, F_SETFD, FD_CLOEXEC);
4340
4341 // Set backlog to 0 to make sure that queue size will be minimum.
4342 // In Linux, because the minimum queue will be 1, connect() will be blocked
4343 // if the other clients already called connect() and the connection request was not accepted.
4344 if (listen(s, 0) < 0) {
4345 MYLOGE("listen(control socket): %s\n", strerror(errno));
4346 return -1;
4347 }
4348
4349 struct sockaddr addr;
4350 socklen_t alen = sizeof(addr);
Abhijeet Kaur2113cae2019-09-13 09:24:15 +01004351 int fd = accept4(s, &addr, &alen, SOCK_CLOEXEC);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004352
4353 // Close socket just after accept(), to make sure that connect() by client will get error
4354 // when the socket is used by the other services.
4355 // There is still a race condition possibility between accept and close, but there is no way
4356 // to close-on-accept atomically.
4357 // See detail; b/123306389#comment25
4358 close(s);
4359
4360 if (fd < 0) {
4361 MYLOGE("accept(control socket): %s\n", strerror(errno));
4362 return -1;
4363 }
4364
4365 return fd;
4366}
4367
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004368// TODO: should call is_valid_output_file and/or be merged into it.
4369void create_parent_dirs(const char *path) {
4370 char *chp = const_cast<char *> (path);
4371
4372 /* skip initial slash */
4373 if (chp[0] == '/')
4374 chp++;
4375
4376 /* create leading directories, if necessary */
4377 struct stat dir_stat;
4378 while (chp && chp[0]) {
4379 chp = strchr(chp, '/');
4380 if (chp) {
4381 *chp = 0;
4382 if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
4383 MYLOGI("Creating directory %s\n", path);
4384 if (mkdir(path, 0770)) { /* drwxrwx--- */
4385 MYLOGE("Unable to create directory %s: %s\n", path, strerror(errno));
4386 } else if (chown(path, AID_SHELL, AID_SHELL)) {
4387 MYLOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
4388 }
4389 }
4390 *chp++ = '/';
4391 }
4392 }
4393}
4394
4395bool _redirect_to_file(FILE* redirect, char* path, int truncate_flag) {
4396 create_parent_dirs(path);
4397
4398 int fd = TEMP_FAILURE_RETRY(open(path,
4399 O_WRONLY | O_CREAT | truncate_flag | O_CLOEXEC | O_NOFOLLOW,
4400 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH));
4401 if (fd < 0) {
4402 MYLOGE("%s: %s\n", path, strerror(errno));
4403 return false;
4404 }
4405
4406 TEMP_FAILURE_RETRY(dup2(fd, fileno(redirect)));
4407 close(fd);
4408 return true;
4409}
4410
4411bool redirect_to_file(FILE* redirect, char* path) {
4412 return _redirect_to_file(redirect, path, O_TRUNC);
4413}
4414
4415bool redirect_to_existing_file(FILE* redirect, char* path) {
4416 return _redirect_to_file(redirect, path, O_APPEND);
4417}
4418
4419void dump_route_tables() {
4420 DurationReporter duration_reporter("DUMP ROUTE TABLES");
4421 if (PropertiesHelper::IsDryRun()) return;
4422 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
4423 ds.DumpFile("RT_TABLES", RT_TABLES_PATH);
4424 FILE* fp = fopen(RT_TABLES_PATH, "re");
4425 if (!fp) {
4426 printf("*** %s: %s\n", RT_TABLES_PATH, strerror(errno));
4427 return;
4428 }
4429 char table[16];
4430 // Each line has an integer (the table number), a space, and a string (the table name). We only
4431 // need the table number. It's a 32-bit unsigned number, so max 10 chars. Skip the table name.
4432 // Add a fixed max limit so this doesn't go awry.
4433 for (int i = 0; i < 64 && fscanf(fp, " %10s %*s", table) == 1; ++i) {
4434 RunCommand("ROUTE TABLE IPv4", {"ip", "-4", "route", "show", "table", table});
4435 RunCommand("ROUTE TABLE IPv6", {"ip", "-6", "route", "show", "table", table});
4436 }
4437 fclose(fp);
4438}
4439
Li Li830179f2022-01-04 12:53:29 -08004440void dump_frozen_cgroupfs(const char *dir, int level,
4441 int (*dump_from_fd)(const char* title, const char* path, int fd)) {
4442 DIR *dirp;
4443 struct dirent *d;
4444 char *newpath = nullptr;
4445
4446 dirp = opendir(dir);
4447 if (dirp == nullptr) {
4448 MYLOGE("%s: %s\n", dir, strerror(errno));
4449 return;
4450 }
4451
4452 for (; ((d = readdir(dirp))); free(newpath), newpath = nullptr) {
4453 if ((d->d_name[0] == '.')
4454 && (((d->d_name[1] == '.') && (d->d_name[2] == '\0'))
4455 || (d->d_name[1] == '\0'))) {
4456 continue;
4457 }
4458 if (d->d_type == DT_DIR) {
4459 asprintf(&newpath, "%s/%s/", dir, d->d_name);
4460 if (!newpath) {
4461 continue;
4462 }
4463 if (level == 0 && !strncmp(d->d_name, "uid_", 4)) {
4464 dump_frozen_cgroupfs(newpath, 1, dump_from_fd);
4465 } else if (level == 1 && !strncmp(d->d_name, "pid_", 4)) {
4466 char *freezer = nullptr;
4467 asprintf(&freezer, "%s/%s", newpath, "cgroup.freeze");
4468 if (freezer) {
4469 FILE* fp = fopen(freezer, "r");
4470 if (fp != NULL) {
4471 int frozen;
4472 fscanf(fp, "%d", &frozen);
4473 if (frozen > 0) {
4474 dump_files("", newpath, skip_none, dump_from_fd);
4475 }
4476 fclose(fp);
4477 }
4478 free(freezer);
4479 }
4480 }
4481 }
4482 }
4483 closedir(dirp);
4484}
4485
4486void dump_frozen_cgroupfs() {
Li Li830179f2022-01-04 12:53:29 -08004487 MYLOGD("Adding frozen processes from %s\n", CGROUPFS_DIR);
4488 DurationReporter duration_reporter("FROZEN CGROUPFS");
4489 if (PropertiesHelper::IsDryRun()) return;
4490 dump_frozen_cgroupfs(CGROUPFS_DIR, 0, _add_file_from_fd);
4491}
4492
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004493void Dumpstate::UpdateProgress(int32_t delta_sec) {
4494 if (progress_ == nullptr) {
4495 MYLOGE("UpdateProgress: progress_ not set\n");
4496 return;
4497 }
Rhed Jaobf63d8a2020-07-21 15:42:55 +08004498 // This function updates progress related members of the dumpstate and reports
4499 // progress percentage to the bugreport client. Since it could be called by
4500 // different dump tasks at the same time if the parallel run is enabled, a
4501 // mutex lock is necessary here to synchronize the call.
4502 std::lock_guard<std::recursive_mutex> lock(mutex_);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004503
4504 // Always update progess so stats can be tuned...
Nandana Dutt402a8392019-06-14 14:25:13 +01004505 progress_->Inc(delta_sec);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004506
4507 // ...but only notifiy listeners when necessary.
4508 if (!options_->do_progress_updates) return;
4509
4510 int progress = progress_->Get();
4511 int max = progress_->GetMax();
Nandana Dutt402a8392019-06-14 14:25:13 +01004512 int percent = 100 * progress / max;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004513
Nandana Dutt402a8392019-06-14 14:25:13 +01004514 if (last_reported_percent_progress_ > 0 && percent <= last_reported_percent_progress_) {
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004515 return;
4516 }
Nandana Dutt402a8392019-06-14 14:25:13 +01004517 last_reported_percent_progress_ = percent;
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004518
4519 if (control_socket_fd_ >= 0) {
4520 dprintf(control_socket_fd_, "PROGRESS:%d/%d\n", progress, max);
4521 fsync(control_socket_fd_);
4522 }
4523
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004524 if (listener_ != nullptr) {
Nandana Dutt235c6672019-11-14 15:22:32 +00004525 if (percent % 10 == 0) {
4526 // We don't want to spam logcat, so only log multiples of 10.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004527 MYLOGD("Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004528 } else {
4529 // stderr is ignored on normal invocations, but useful when calling
4530 // /system/bin/dumpstate directly for debuggging.
Abhijeet Kaured5d6a62019-10-07 15:02:05 +01004531 fprintf(stderr, "Setting progress: %d/%d (%d%%)\n", progress, max, percent);
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004532 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004533
4534 listener_->onProgress(percent);
4535 }
4536}
4537
4538void Dumpstate::TakeScreenshot(const std::string& path) {
4539 const std::string& real_path = path.empty() ? screenshot_path_ : path;
4540 int status =
4541 RunCommand("", {"/system/bin/screencap", "-p", real_path},
4542 CommandOptions::WithTimeout(10).Always().DropRoot().RedirectStderr().Build());
4543 if (status == 0) {
4544 MYLOGD("Screenshot saved on %s\n", real_path.c_str());
4545 } else {
4546 MYLOGE("Failed to take screenshot on %s\n", real_path.c_str());
4547 }
Paul Chang0d2aad72020-02-13 20:04:03 +08004548 if (listener_ != nullptr) {
4549 // Show a visual indication to indicate screenshot is taken via
4550 // IDumpstateListener.onScreenshotTaken()
4551 listener_->onScreenshotTaken(status == 0);
4552 }
Abhijeet Kaurcf234e82019-07-01 14:53:55 +01004553}
4554
4555bool is_dir(const char* pathname) {
4556 struct stat info;
4557 if (stat(pathname, &info) == -1) {
4558 return false;
4559 }
4560 return S_ISDIR(info.st_mode);
4561}
4562
4563time_t get_mtime(int fd, time_t default_mtime) {
4564 struct stat info;
4565 if (fstat(fd, &info) == -1) {
4566 return default_mtime;
4567 }
4568 return info.st_mtime;
4569}